Packages

trait CompletionSupport extends Parsers with CompletionTypes

CompletionSupport adds completion capability to parsers.

When mixed-in, this trait extends the scala.util.parsing.combinator.Parsers.Parser type with the abstract method com.nexthink.utils.parsing.combinator.completion.CompletionSupport.Parser#completions which returns a instance of com.nexthink.utils.parsing.combinator.completion.CompletionTypes.Completions for a certain input.

Combinators are overloaded to cover the additional completion aspect, so that no change is required in the grammar.

Note that the derived trait com.nexthink.utils.parsing.combinator.completion.RegexCompletionSupport can be mixed-in with RegexParsers to automatically obtain completion behavior for string literals.

A set of additional operators allow defining completions and specifying structural properties of completions (tag, score, meta, etc.) for a Parser.

Linear Supertypes
CompletionTypes, Parsers, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CompletionSupport
  2. CompletionTypes
  3. Parsers
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait CombinableParser[+T, P[+R] <: CombinableParser[R, P]] extends AnyRef
  2. abstract type Elem
    Definition Classes
    CompletionTypes
  3. type Elems = Seq[Elem]
    Definition Classes
    CompletionTypes
  4. case class Error extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  5. case class Failure extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  6. type Input = Reader[Elem]
    Definition Classes
    Parsers
  7. sealed abstract class NoSuccess extends ParseResult[Nothing]
    Definition Classes
    Parsers
  8. trait OnceParser[+T] extends scala.util.parsing.combinator.Parsers.Parser[T]
    Definition Classes
    Parsers
  9. sealed abstract class ParseResult[+T] extends AnyRef
    Definition Classes
    Parsers
  10. abstract class Parser[+T] extends CompletionSupport.Parser[T] with CombinableParser[T, Parser]

    The root class of completion parsers, overloading the Parser class.

    The root class of completion parsers, overloading the Parser class. Completion parsers are functions from the Input type to ParseResult, with the addition of a completions function from the Input type to an instance of Completions

  11. case class Success[+T] extends ParseResult[T] with Product with Serializable
    Definition Classes
    Parsers
  12. case class ~[+a, +b] extends Product with Serializable
    Definition Classes
    Parsers
  13. 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)

    Definition Classes
    CompletionTypes
  14. 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

    Definition Classes
    CompletionTypes
  15. 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

    Definition Classes
    CompletionTypes
  16. 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

    Definition Classes
    CompletionTypes

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DefaultCompletionScore: Int
    Definition Classes
    CompletionTypes
  5. val DefaultCompletionTag: String
    Definition Classes
    CompletionTypes
  6. def OnceParser[T](f: (Input) => ParseResult[T]): CompletionSupport.Parser[T] with OnceParser[T]
    Definition Classes
    Parsers
  7. def Parser[T](f: (Input) => ParseResult[T], c: (Input) => Completions): Parser[T]
  8. def Parser[T](f: (Input) => ParseResult[T]): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  9. def accept[U](expected: String, f: PartialFunction[Elem, U], completions: Set[Elem] = Set()): Parser[U]

    The parser that matches an element in the domain of the partial function f.

    The parser that matches an element in the domain of the partial function f.

    If f is defined on the first element in the input, f is applied to it to produce this parser's result.

    Example: The parser accept("name", {case Identifier(n) => Name(n)}) accepts an Identifier(n) and returns a Name(n)

    expected

    a description of the kind of element this parser expects (for error messages)

    f

    a partial function that determines when this parser is successful and what its output is

    completions

    Possible alternatives (for completion)

    returns

    A parser that succeeds if f is applicable to the first element of the input, applying f to it to produce the result.

  10. def accept[ES](es: ES)(implicit arg0: (ES) => List[Elem]): Parser[List[Elem]]

    A parser that matches only the given list of element es.

    A parser that matches only the given list of element es.

    accept(es) succeeds if the input subsequently provides the elements in the list es.

    es

    the list of expected elements

    returns

    a Parser that recognizes a specified list of elements

    Definition Classes
    CompletionSupport → Parsers
  11. implicit def accept(e: Elem): Parser[Elem]

    A parser that matches only the given element e.

    A parser that matches only the given element e.

    The method is implicit so that elements can automatically be lifted to their parsers. For example, when parsing Tokens, Identifier("new") (which is a Token) can be used directly, instead of first creating a Parser using accept(Identifier("new")).

    e

    the Elem that must be the next piece of input for the returned parser to succeed

    returns

    a tParser that succeeds if e is the next available input.

    Definition Classes
    CompletionSupport → Parsers
  12. def accept[U](expected: String, f: PartialFunction[Elem, U]): CompletionSupport.Parser[U]
    Definition Classes
    Parsers
  13. def acceptIf(p: (Elem) => Boolean, completions: Set[Elem])(err: (Elem) => String): Parser[Elem]

    A parser matching input elements that satisfy a given predicate.

    A parser matching input elements that satisfy a given predicate.

    acceptIf(p)(el => "Unexpected "+el) succeeds if the input starts with an element e for which p(e) is true.

    p

    A predicate that determines which elements match.

    completions

    Possible completions

    err

    A function from the received element into an error message.

    returns

    A parser for elements satisfying p(e).

  14. def acceptIf(p: (Elem) => Boolean)(err: (Elem) => String): CompletionSupport.Parser[Elem]
    Definition Classes
    Parsers
  15. def acceptMatch[U](expected: String, f: PartialFunction[Elem, U], completions: Set[Completion]): Parser[U]
  16. def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): CompletionSupport.Parser[U]
    Definition Classes
    Parsers
  17. def acceptSeq[ES](es: ES)(implicit arg0: (ES) => Iterable[Elem]): Parser[List[Elem]]

    A parser that matches only the given scala.collection.Iterable collection of elements es.

    A parser that matches only the given scala.collection.Iterable collection of elements es.

    acceptSeq(es) succeeds if the input subsequently provides the elements in the iterable es.

    es

    the list of expected elements

    returns

    a Parser that recognizes a specified list of elements

    Definition Classes
    CompletionSupport → Parsers
  18. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  19. def chainl1[T, U](first: => Parser[T], p: => Parser[U], q: => Parser[(T, U) => T]): Parser[T]

    A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

    A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

    first

    a parser that parses the first element

    p

    a parser that parses the subsequent elements

    q

    a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one

  20. def chainl1[T](p: => Parser[T], q: => Parser[(T, T) => T]): Parser[T]

    A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

    A parser generator that, roughly, generalises the rep1sep generator so that q, which parses the separator, produces a left-associative function that combines the elements it separates.

    From: J. Fokker. Functional parsers. In J. Jeuring and E. Meijer, editors, Advanced Functional Programming, volume 925 of Lecture Notes in Computer Science, pages 1--23. Springer, 1995.

    p

    a parser that parses the elements

    q

    a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one

  21. def chainl1[T, U](first: => CompletionSupport.Parser[T], p: => CompletionSupport.Parser[U], q: => CompletionSupport.Parser[(T, U) => T]): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  22. def chainl1[T](p: => CompletionSupport.Parser[T], q: => CompletionSupport.Parser[(T, T) => T]): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  23. def chainr1[T, U](p: => Parser[T], q: => Parser[(T, U) => U], combine: (T, U) => U, first: U): Parser[U]

    A parser generator that generalises the rep1sep generator so that q, which parses the separator, produces a right-associative function that combines the elements it separates.

    A parser generator that generalises the rep1sep generator so that q, which parses the separator, produces a right-associative function that combines the elements it separates. Additionally, the right-most (last) element and the left-most combining function have to be supplied.

    rep1sep(p: Parser[T], q) corresponds to chainr1(p, q ^^ cons, cons, Nil) (where val cons = (x: T, y: List[T]) => x :: y)

    p

    a parser that parses the elements

    q

    a parser that parses the token(s) separating the elements, yielding a right-associative function that combines two elements into one

    combine

    the "last" (left-most) combination function to be applied

    first

    the "first" (right-most) element to be combined

  24. def chainr1[T, U](p: => CompletionSupport.Parser[T], q: => CompletionSupport.Parser[(T, U) => U], combine: (T, U) => U, first: U): CompletionSupport.Parser[U]
    Definition Classes
    Parsers
  25. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  26. def commit[T](p: => Parser[T]): Parser[T]

    Wrap a parser so that its failures become errors (the | combinator will give up as soon as it encounters an error, on failure it simply tries the next alternative).

  27. def commit[T](p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  28. def elem(e: Elem): Parser[Elem]

    A parser that matches only the given element e.

    A parser that matches only the given element e.

    elem(e) succeeds if the input starts with an element e.

    e

    the Elem that must be the next piece of input for the returned parser to succeed

    returns

    a Parser that succeeds if e is the next available input (and returns it).

    Definition Classes
    CompletionSupport → Parsers
  29. def elem(kind: String, p: (Elem) => Boolean, completions: Set[Elem] = Set()): Parser[Elem]

    A parser matching input elements that satisfy a given predicate.

    A parser matching input elements that satisfy a given predicate.

    elem(kind, p) succeeds if the input starts with an element e for which p(e) is true.

    kind

    The element kind, used for error messages

    p

    A predicate that determines which elements match.

    completions

    Possible alternatives (for completion)

  30. def elem(kind: String, p: (Elem) => Boolean): CompletionSupport.Parser[Elem]
    Definition Classes
    Parsers
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  33. def err(msg: String): Parser[Nothing]

    A parser that results in an error.

    A parser that results in an error.

    msg

    The error message describing the failure.

    returns

    A parser that always fails with the specified error message.

    Definition Classes
    CompletionSupport → Parsers
  34. def failure(msg: String): Parser[Nothing]

    A parser that always fails.

    A parser that always fails.

    msg

    The error message describing the failure.

    returns

    A parser that always fails with the specified error message.

    Definition Classes
    CompletionSupport → Parsers
  35. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  36. def guard[T](p: => Parser[T]): Parser[T]

    A parser generator for guard expressions.

    A parser generator for guard expressions. The resulting parser will fail or succeed just like the one given as parameter but it will not consume any input.

    p

    a Parser that is to be applied to the input

    returns

    A parser that returns success if and only if p succeeds but never consumes any input

  37. def guard[T](p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  39. def inputPositionDebugString(input: Input): String
    Attributes
    protected
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def log[T](p: => Parser[T])(name: String): Parser[T]

    A helper method that turns a Parser into one that will print debugging information to stdout before and after being applied.

  42. def log[T](p: => CompletionSupport.Parser[T])(name: String): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  43. def mkList[T]: (~[T, List[T]]) => List[T]
    Definition Classes
    Parsers
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def not[T](p: => Parser[T]): Parser[Unit]

    Wrap a parser so that its failures and errors become success and vice versa -- it never consumes any input.

  46. def not[T](p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[Unit]
    Definition Classes
    Parsers
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  49. def opt[T](p: => Parser[T]): Parser[Option[T]]

    A parser generator for optional sub-phrases.

    A parser generator for optional sub-phrases.

    opt(p) is a parser that returns Some(x) if p returns x and None if p fails.

    p

    A Parser that is tried on the input

    returns

    a Parser that always succeeds: either with the result provided by p or with the empty result

  50. def opt[T](p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[Option[T]]
    Definition Classes
    Parsers
  51. def phrase[T](p: Parser[T]): Parser[T]

    A parser generator delimiting whole phrases (i.e.

    A parser generator delimiting whole phrases (i.e. programs).

    phrase(p) succeeds if p succeeds and no input is left over after p.

    p

    the parser that must consume all input for the resulting parser to succeed.

    returns

    a parser that has the same result as p, but that only succeeds if p consumed all the input.

  52. def phrase[T](p: CompletionSupport.Parser[T]): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  53. def positioned[T <: Positional](p: => Parser[T]): Parser[T]

    positioned decorates a parser's result with the start position of the input it consumed.

    positioned decorates a parser's result with the start position of the input it consumed.

    p

    a Parser whose result conforms to Positional.

    returns

    A parser that has the same behaviour as p, but which marks its result with the start position of the input it consumed, if it didn't already have a position.

  54. def positioned[T <: Positional](p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[T]
    Definition Classes
    Parsers
  55. def rep[T](p: => Parser[T]): Parser[List[T]]

    A parser generator for repetitions.

    A parser generator for repetitions.

    rep(p) repeatedly uses p to parse the input until p fails (the result is a List of the consecutive results of p).

    p

    a Parser that is to be applied successively to the input

    returns

    A parser that returns a list of results produced by repeatedly applying p to the input.

  56. def rep[T](p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[List[T]]
    Definition Classes
    Parsers
  57. def rep1[T](first: => Parser[T], p0: => Parser[T]): Parser[List[T]]

    A parser generator for non-empty repetitions.

    A parser generator for non-empty repetitions.

    rep1(f, p) first uses f (which must succeed) and then repeatedly uses p to parse the input until p fails (the result is a List of the consecutive results of f and p)

    first

    a Parser that parses the first piece of input

    p0

    a Parser that is to be applied successively to the rest of the input (if any) -- evaluated at most once, and only when necessary

    returns

    A parser that returns a list of results produced by first applying f and then repeatedly p to the input (it only succeeds if f matches).

  58. def rep1[T](p: => Parser[T]): Parser[List[T]]

    A parser generator for non-empty repetitions.

    A parser generator for non-empty repetitions.

    rep1(p) repeatedly uses p to parse the input until p fails -- p must succeed at least once (the result is a List of the consecutive results of p)

    p

    a Parser that is to be applied successively to the input

    returns

    A parser that returns a list of results produced by repeatedly applying p to the input (and that only succeeds if p matches at least once).

  59. def rep1[T](first: => CompletionSupport.Parser[T], p0: => CompletionSupport.Parser[T]): CompletionSupport.Parser[List[T]]
    Definition Classes
    Parsers
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The p0 call-by-name arguments is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.

  60. def rep1[T](p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[List[T]]
    Definition Classes
    Parsers
  61. def rep1sep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]

    A parser generator for non-empty repetitions.

    A parser generator for non-empty repetitions.

    rep1sep(p, q) repeatedly applies p interleaved with q to parse the input, until p fails. The parser p must succeed at least once.

    p

    a Parser that is to be applied successively to the input

    q

    a Parser that parses the elements that separate the elements parsed by p (interleaved with q)

    returns

    A parser that returns a list of results produced by repeatedly applying p to the input (and that only succeeds if p matches at least once). The results of p are collected in a list. The results of q are discarded.

  62. def rep1sep[T](p: => CompletionSupport.Parser[T], q: => CompletionSupport.Parser[Any]): CompletionSupport.Parser[List[T]]
    Definition Classes
    Parsers
  63. def repN[T](num: Int, p0: => Parser[T]): Parser[List[T]]

    A parser generator for a specified number of repetitions.

    A parser generator for a specified number of repetitions.

    repN(n, p) uses p exactly n time to parse the input (the result is a List of the n consecutive results of p).

    num

    the exact number of times p must succeed

    p0

    a Parser that is to be applied successively to the input

    returns

    A parser that returns a list of results produced by repeatedly applying p to the input (and that only succeeds if p matches exactly n times).

  64. def repN[T](num: Int, p: => CompletionSupport.Parser[T]): CompletionSupport.Parser[List[T]]
    Definition Classes
    Parsers
  65. def repsep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]

    A parser generator for interleaved repetitions.

    A parser generator for interleaved repetitions.

    repsep(p, q) repeatedly uses p interleaved with q to parse the input, until p fails. (The result is a List of the results of p.)

    Example: repsep(term, ",") parses a comma-separated list of term's, yielding a list of these terms.

    p

    a Parser that is to be applied successively to the input

    q

    a Parser that parses the elements that separate the elements parsed by p

    returns

    A parser that returns a list of results produced by repeatedly applying p (interleaved with q) to the input. The results of p are collected in a list. The results of q are discarded.

  66. def repsep[T](p: => CompletionSupport.Parser[T], q: => CompletionSupport.Parser[Any]): CompletionSupport.Parser[List[T]]
    Definition Classes
    Parsers
  67. def success[T](v: T): Parser[T]

    A parser that always succeeds.

    A parser that always succeeds.

    v

    The result for the parser

    returns

    A parser that always succeeds, with the given result v

    Definition Classes
    CompletionSupport → Parsers
  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. def toString(): String
    Definition Classes
    AnyRef → Any
  70. def updateCompletionsTag(completions: Completions, newTagLabel: Option[String] = None, newTagScore: Option[Int] = None, newTagDescription: Option[String] = None, newTagMeta: Option[JValue] = None): Completions
    Attributes
    protected
  71. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  72. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  73. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. object NoSuccess
    Definition Classes
    Parsers
  75. case object Completion extends Product with Serializable
    Definition Classes
    CompletionTypes
  76. case object CompletionSet extends Product with Serializable
    Definition Classes
    CompletionTypes
  77. case object CompletionTag extends Product with Serializable
    Definition Classes
    CompletionTypes
  78. case object Completions extends Product with Serializable
    Definition Classes
    CompletionTypes

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from CompletionTypes

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped