CompletionTypes

Collection of data types allowing definition of structured parser completions. A Completions instance can contain multiple CompletionSets instances. A CompletionSet provides a set of Completion entries and is tagged with a CompletionTag.

Sets allow structuring the completion entries into groups, each group tagged with a label (plus optional description and meta, the latter allowing e.g. encoding visual attributes for the set). Sets also feature a score, which defines the order between sets within the Completions instance.

Each Completion entry within a set has a value, a score and a meta: the score allows ordering the entries within a set, and the meta can e.g. be used to assign a representation style for a particular completion entry.

Note that specifying tags and sets is optional: if no tag is specified upon creation, Completions instances create a unique default set with an empty tag.

Linear Supertypes

AnyRef, Any

Known Subclasses

AlphabeticalSortingSupport, CompletionExpansionSupport, CompletionSupport, RegexCompletionSupport, TermsParsers, TermsParsers

Type Members

case class Completion(value: Elems, score: Int = DefaultCompletionScore, meta: Option[JValue] = None) extends Product with Serializable

Completion entry
Completion entry
value
entry value (e.g. string literal)
score
entry score (defines the order of entries within a set, the higher the better)
meta
entry meta (e.g. visual style)
case class CompletionSet(tag: CompletionTag, completions: HashMap[Elems, Completion]) extends Product with Serializable

Set of related completion entries
Set of related completion entries
tag
set tag
completions
set of unique completion entries
case class CompletionTag(label: String, score: Int, description: Option[String], meta: Option[JValue]) extends Product with Serializable

Tag defining identification and attributes of a set of completion entries
Tag defining identification and attributes of a set of completion entries
label
tag label
score
tag score (the higher the better, 0 by default)
description
tag description (optional) - can be used for additional information e.g. for a tooltip
meta
tag meta (optional) - can be used e.g. to define visual style
case class Completions(position: Position, meta: Option[JValue], sets: HashMap[String, CompletionSet]) extends Product with Serializable

Result of parser completion, listing the possible entry alternatives at a certain input position
Result of parser completion, listing the possible entry alternatives at a certain input position
position
position in the input where completion entries apply
sets
completion entries, grouped per tag
abstract type Elem
type Elems = Seq[Elem]

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object Completion extends Product with Serializable
object CompletionSet extends Product with Serializable
object CompletionTag extends Product with Serializable
object Completions extends Product with Serializable
val DefaultCompletionScore: Int
val DefaultCompletionTag: String
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package completion

trait CompletionTypes extends AnyRef

Type Members

case class Completion(value: Elems, score: Int = DefaultCompletionScore, meta: Option[JValue] = None) extends Product with Serializable

case class CompletionSet(tag: CompletionTag, completions: HashMap[Elems, Completion]) extends Product with Serializable

case class CompletionTag(label: String, score: Int, description: Option[String], meta: Option[JValue]) extends Product with Serializable

case class Completions(position: Position, meta: Option[JValue], sets: HashMap[String, CompletionSet]) extends Product with Serializable

abstract type Elem

type Elems = Seq[Elem]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Completion extends Product with Serializable

object CompletionSet extends Product with Serializable

object CompletionTag extends Product with Serializable

object Completions extends Product with Serializable

val DefaultCompletionScore: Int

val DefaultCompletionTag: String

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped