com.nexthink.utils.parsing.combinator.completion.CompletionSupport

Parser

abstract class Parser[+T] extends CompletionSupport.Parser[T] with CombinableParser[T, Parser]

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

Linear Supertypes

CombinableParser[T, Parser], CompletionSupport.Parser[T], (CompletionSupport.Input) => CompletionSupport.ParseResult[T], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Parser
CombinableParser
Parser
Function1
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new Parser()

Abstract Value Members

abstract def apply(in: CompletionSupport.Input): CompletionSupport.ParseResult[T]
Definition Classes
Parser → Function1
abstract def completions(in: CompletionSupport.Input): CompletionSupport.Completions
An unspecified method that defines the possible completions for this parser
An unspecified method that defines the possible completions for this parser
in
the input
returns
an instance of com.nexthink.utils.parsing.combinator.completion.CompletionTypes.Completions

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def %(tag: CompletionSupport.CompletionTag): Parser[T]
An operator to specify the completion tag
An operator to specify the completion tag
tag
the completion tag
returns
wrapper Parser instance specifying completion tag
Definition Classes
Parser → CombinableParser
def %(tag: String, tagScore: Int, tagDescription: String, tagMeta: JValue): Parser[T]
An operator to specify the completion tag, score, description and meta of a parser
An operator to specify the completion tag, score, description and meta of a parser
tag
the completion tag
tagScore
the completion tag score
tagDescription
the completion tag description
tagMeta
the completion tag meta
returns
wrapper Parser instance specifying completion tag
Definition Classes
Parser → CombinableParser
def %(tag: String, tagScore: Int, tagDescription: String): Parser[T]
An operator to specify the completion tag, score and description of a parser
An operator to specify the completion tag, score and description of a parser
tag
the completion tag
tagScore
the completion tag score
tagDescription
the completion tag description
returns
wrapper Parser instance specifying completion tag
Definition Classes
Parser → CombinableParser
def %(tag: String, tagScore: Int): Parser[T]
An operator to specify the completion tag and score of a parser
An operator to specify the completion tag and score of a parser
tag
the completion tag
tagScore
the completion tag score
returns
wrapper Parser instance specifying the completion tag
Definition Classes
Parser → CombinableParser
def %(tagScore: Int): Parser[T]
An operator to specify the completions tag score of a parser (0 by default)
An operator to specify the completions tag score of a parser (0 by default)
tagScore
the completion tag score (to be used e.g. to order sections in a completion menu)
returns
wrapper Parser instance specifying the completion tag score
Definition Classes
Parser → CombinableParser
def %(tag: String): Parser[T]
An operator to specify the completion tag of a parser (empty tag by default)
An operator to specify the completion tag of a parser (empty tag by default)
tag
the completion tag (to be used e.g. to structure a completion menu)
returns
wrapper Parser instance specifying the completion tag
Definition Classes
Parser → CombinableParser
def %%(tagMeta: JValue): Parser[T]
An operator to specify the completion tag meta-data of a parser in JSON format (empty by default).
An operator to specify the completion tag meta-data of a parser in JSON format (empty by default). JSON meta-data is automatically merged when combining two equivalent tags (i.e. bearing the same label, but with a different payload). This allows for more flexibility when defining the grammar: various parsers can return the same completion tags with an additive effect on the meta-data (and the entries).
tagMeta
the JValue for completion tag meta-data (to be used e.g. to specify the visual style for a completion tag in the menu)
returns
wrapper Parser instance specifying the completion tag meta-data
Definition Classes
Parser → CombinableParser
def %%%(globalMeta: JValue): Parser[T]
An operator to specify the meta-data for the whole set of completions (empty by default) Note that if the meta-data is encoded in JSON, it is automatically merged when combining multiple completion sets.
An operator to specify the meta-data for the whole set of completions (empty by default) Note that if the meta-data is encoded in JSON, it is automatically merged when combining multiple completion sets. This allows for more flexibility when defining the grammar: various parsers can define the global completion meta-data with an additive effect.
globalMeta
the JValue for completions meta-data (to be used e.g. to specify the visual style for the completion menu)
returns
wrapper Parser instance specifying the completions meta-data
Definition Classes
Parser → CombinableParser
def %-%(meta: JValue): Parser[T]
An operator to specify the meta-data for completions of a parser (empty by default).
An operator to specify the meta-data for completions of a parser (empty by default). Note that meta-data is merged with comma separations when combining two equivalent entries.
meta
the completion meta-data (to be used e.g. to specify the visual style for a completion entry in the menu)
returns
wrapper Parser instance specifying the completion meta-data
Definition Classes
Parser → CombinableParser
def %>(completioner: (CompletionSupport.Input) => CompletionSupport.Completions): Parser[T]
An operator to specify completions of a parser
An operator to specify completions of a parser
completioner
function of input to completions
returns
a Parser that upon invocation of the completions method will invoke the passed function
def %>(completions: CompletionSupport.CompletionSet): Parser[T]
An operator to specify completions of a parser
An operator to specify completions of a parser
completions
possible completions for this parser
returns
a Parser that upon invocation of the completions method returns the passed completions
Definition Classes
Parser → CombinableParser
def %>(completion: CompletionSupport.Completion): Parser[T]
An operator to specify completion of a parser
An operator to specify completion of a parser
completion
completion for this parser
returns
a Parser that upon invocation of the completions method returns the passed completion
Definition Classes
Parser → CombinableParser
def %>(completions: CompletionSupport.Elems*): Parser[T]
An operator to specify completions of a parser
An operator to specify completions of a parser
completions
possible completions for this parser
returns
a Parser that upon invocation of the completions method returns the passed completions
Definition Classes
Parser → CombinableParser
def %?(tagDescription: String): Parser[T]
An operator to specify the completion tag description of a parser (empty by default)
An operator to specify the completion tag description of a parser (empty by default)
tagDescription
the completion description (to be used e.g. to add information to a completion entry)
returns
wrapper Parser instance specifying the completion description
Definition Classes
Parser → CombinableParser
def *[U >: T](sep: => Parser[(U, U) => U]): Parser[U]
Returns a parser that repeatedly parses what this parser parses, interleaved with the sep parser.
Returns a parser that repeatedly parses what this parser parses, interleaved with the sep parser. The sep parser specifies how the results parsed by this parser should be combined.
returns
chainl1(this, sep)
Definition Classes
Parser → CombinableParser
def *(): Parser[List[T]]
Returns a parser that repeatedly parses what this parser parses.
Returns a parser that repeatedly parses what this parser parses.
returns
rep(this)
Definition Classes
Parser → CombinableParser → Parser
def *[U >: T](sep: => CompletionSupport.Parser[(U, U) => U]): CompletionSupport.Parser[U]
Definition Classes
Parser
def +(): Parser[List[T]]
Returns a parser that repeatedly (at least once) parses what this parser parses.
Returns a parser that repeatedly (at least once) parses what this parser parses.
returns
rep1(this)
Definition Classes
Parser → CombinableParser → Parser
def -[U](q: CompletionSupport.Parser[U]): CompletionSupport.Parser[T]
Definition Classes
Parser
def <~[U](q: => Parser[U]): Parser[T]
A parser combinator for sequential composition which keeps only the left result.
A parser combinator for sequential composition which keeps only the left result.
p <~ q succeeds if p succeeds and q succeeds on the input left over by p.
q
a parser that will be executed after p (this parser) succeeds -- evaluated at most once, and only when necessary
returns
a Parser that -- on success -- returns the result of p.
Definition Classes
Parser → CombinableParser
Note
<~ has lower operator precedence than ~ or ~>.
def <~[U](q: => CompletionSupport.Parser[U]): CompletionSupport.Parser[T]
Definition Classes
Parser
Annotations
@migration
Migration
(Changed in version 2.9.0) The call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
def <~![U](q: => Parser[U]): Parser[T]
A parser combinator for non-back-tracking sequential composition which only keeps the left result.
A parser combinator for non-back-tracking sequential composition which only keeps the left result.
p <~! q succeeds if p succeds and q succeds on the input left over by p. In case of failure, no back-tracking is performed (in an earlier parser produced by the | combinator).
q
a parser that will be executed after p (this parser) succeeds -- evaluated at most once, and only when necessary
returns
a Parser that -- on success -- reutrns the result of p. The resulting parser fails if either p or q fails, this failure is fatal.
Definition Classes
Parser → CombinableParser
def <~![U](q: => CompletionSupport.Parser[U]): CompletionSupport.Parser[T]
Definition Classes
Parser
Annotations
@migration
Migration
(Changed in version 2.9.0) The call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def >>[U](fq: (T) => Parser[U]): Parser[U]
Returns into(fq).
Returns into(fq).
Definition Classes
Parser → CombinableParser
def >>[U](fq: (T) => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
def ?(): Parser[Option[T]]
Returns a parser that optionally parses what this parser parses.
Returns a parser that optionally parses what this parser parses.
returns
opt(this)
Definition Classes
Parser → CombinableParser → Parser
def ^?[U](f: PartialFunction[T, U]): Parser[U]
A parser combinator for partial function application.
A parser combinator for partial function application.
p ^? f succeeds if p succeeds AND f is defined at the result of p; in that case, it returns f applied to the result of p.
f
a partial function that will be applied to this parser's result (see mapPartial in ParseResult).
returns
a parser that succeeds if the current parser succeeds and f is applicable to the result. If so, the result will be transformed by f.
Definition Classes
Parser → CombinableParser → Parser
def ^?[U](f: PartialFunction[T, U], error: (T) => String): Parser[U]
A parser combinator for partial function application.
A parser combinator for partial function application.
p ^? (f, error) succeeds if p succeeds AND f is defined at the result of p; in that case, it returns f applied to the result of p. If f is not applicable, error(the result of p) should explain why.
f
a partial function that will be applied to this parser's result (see mapPartial in ParseResult).
error
a function that takes the same argument as f and produces an error message to explain why f wasn't applicable
returns
a parser that succeeds if the current parser succeeds and f is applicable to the result. If so, the result will be transformed by f.
Definition Classes
Parser → CombinableParser → Parser
def ^^[U](f: (T) => U): Parser[U]
A parser combinator for function application.
A parser combinator for function application.
p ^^ f succeeds if p succeeds; it returns f applied to the result of p.
f
a function that will be applied to this parser's result (see map in ParseResult).
returns
a parser that has the same behaviour as the current parser, but whose result is transformed by f.
Definition Classes
Parser → CombinableParser → Parser
def ^^^[U](v: => U): Parser[U]
A parser combinator that changes a successful result into the specified value.
A parser combinator that changes a successful result into the specified value.
p ^^^ v succeeds if p succeeds; discards its result, and returns v instead.
v
The new result for the parser, evaluated at most once (if p succeeds), not evaluated at all if p fails.
returns
a parser that has the same behaviour as the current parser, but whose successful result is v
Definition Classes
Parser → CombinableParser → Parser
def andThen[A](g: (CompletionSupport.ParseResult[T]) => A): (CompletionSupport.Input) => A
Definition Classes
Function1
Annotations
@unspecialized()
def append[U >: T](p0: => Parser[U]): Parser[U]
def append[U >: T](p0: => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
Annotations
@migration
Migration
(Changed in version 2.9.0) The call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
def compose[A](g: (A) => CompletionSupport.Input): (A) => CompletionSupport.ParseResult[T]
Definition Classes
Function1
Annotations
@unspecialized()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def filter(p: (T) => Boolean): Parser[T]
Definition Classes
Parser → CombinableParser → Parser
def flatMap[U](f: (T) => Parser[U]): Parser[U]
Definition Classes
Parser → CombinableParser
def flatMap[U](f: (T) => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def into[U](fq: (T) => Parser[U]): Parser[U]
A parser combinator that parameterizes a subsequent parser with the result of this one.
A parser combinator that parameterizes a subsequent parser with the result of this one.
Use this combinator when a parser depends on the result of a previous parser. p should be a function that takes the result from the first parser and returns the second parser.
p into fq (with fq typically {x => q}) first applies p, and then, if p successfully returned result r, applies fq(r) to the rest of the input.
From: G. Hutton. Higher-order functions for parsing. J. Funct. Program., 2(3):323--343, 1992.
fq
a function that, given the result from this parser, returns the second parser to be applied
returns
a parser that succeeds if this parser succeeds (with result x) and if then fq(x) succeeds
Definition Classes
Parser → CombinableParser
Example:
1. def perlRE = "m" ~> (".".r into (separator => """[^%s]*""".format(separator).r <~ separator))
def into[U](fq: (T) => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def map[U](f: (T) => U, fc: (CompletionSupport.Completions) => CompletionSupport.Completions): Parser[U]
Definition Classes
Parser → CombinableParser
def map[U](f: (T) => U): Parser[U]
Definition Classes
Parser → CombinableParser → Parser
def mapCompletions(fc: (CompletionSupport.Completions) => CompletionSupport.Completions): Parser[T]
Definition Classes
Parser → CombinableParser
def named(n: String): Parser.this.type
Definition Classes
Parser
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
Parser → Function1 → AnyRef → Any
def topCompletions(n: Int): Parser[T]
Limits completions to the top n completions ordered by their score
Limits completions to the top n completions ordered by their score
n
the limit
returns
wrapper Parser instance limiting the number of completions
Definition Classes
Parser → CombinableParser
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
def withErrorMessage(msg: String): Parser[T]
Changes the failure message produced by a parser.
Changes the failure message produced by a parser.
This doesn't change the behavior of a parser on neither success nor error, just on failure. The semantics are slightly different than those obtained by doing | failure(msg), in that the message produced by this method will always replace the message produced, which is not guaranteed by that idiom.
For example, parser p below will always produce the designated failure message, while q will not produce it if sign is parsed but number is not.
```
def p = sign.? ~ number withFailureMessage  "Number expected!"
def q = sign.? ~ number | failure("Number expected!")
```
msg
The message that will replace the default failure message.
returns
A parser with the same properties and different failure message.
Definition Classes
Parser → CombinableParser → Parser
def withFailureMessage(msg: String): Parser[T]
Changes the failure message produced by a parser.
Changes the failure message produced by a parser.
This doesn't change the behavior of a parser on neither success nor error, just on failure. The semantics are slightly different than those obtained by doing | failure(msg), in that the message produced by this method will always replace the message produced, which is not guaranteed by that idiom.
For example, parser p below will always produce the designated failure message, while q will not produce it if sign is parsed but number is not.
```
def p = sign.? ~ number withFailureMessage  "Number expected!"
def q = sign.? ~ number | failure("Number expected!")
```
msg
The message that will replace the default failure message.
returns
A parser with the same properties and different failure message.
Definition Classes
Parser → CombinableParser → Parser
def withFilter(p: (T) => Boolean): Parser[T]
Definition Classes
Parser → CombinableParser → Parser
def |[U >: T](q: => Parser[U]): Parser[U]
A parser combinator for alternative composition.
A parser combinator for alternative composition.
p | q succeeds if p succeeds or q succeeds. Note that q is only tried if ps failure is non-fatal (i.e., back-tracking is allowed).
q
a parser that will be executed if p (this parser) fails (and allows back-tracking)
returns
a Parser that returns the result of the first parser to succeed (out of p and q) The resulting parser succeeds if (and only if)
- p succeeds, or
- if p fails allowing back-tracking and q succeeds.
Definition Classes
Parser → CombinableParser
def |[U >: T](q: => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
def |||[U >: T](q: => Parser[U]): Parser[U]
A parser combinator for alternative with longest match composition.
A parser combinator for alternative with longest match composition.
p ||| q succeeds if p succeeds or q succeeds. If p and q both succeed, the parser that consumed the most characters accepts.
q
a parser that accepts if p consumes less characters. -- evaluated at most once, and only when necessary
returns
a Parser that returns the result of the parser consuming the most characters (out of p and q).
Definition Classes
Parser → CombinableParser
def |||[U >: T](q0: => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
Annotations
@migration
Migration
(Changed in version 2.9.0) The call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
def ~[U](q: => Parser[U]): Parser[CompletionSupport.~[T, U]]
A parser combinator for sequential composition.
A parser combinator for sequential composition.
p ~ q succeeds if p succeeds and q succeeds on the input left over by p.
q
a parser that will be executed after p (this parser) succeeds -- evaluated at most once, and only when necessary.
returns
a Parser that -- on success -- returns a ~ (like a Pair, but easier to pattern match on) that contains the result of p and that of q. The resulting parser fails if either p or q fails.
Definition Classes
Parser → CombinableParser
def ~[U](q: => CompletionSupport.Parser[U]): CompletionSupport.Parser[CompletionSupport.~[T, U]]
Definition Classes
Parser
Annotations
@migration
Migration
(Changed in version 2.9.0) The call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
def ~![U](q: => Parser[U]): Parser[CompletionSupport.~[T, U]]
A parser combinator for non-back-tracking sequential composition.
A parser combinator for non-back-tracking sequential composition.
p ~! q succeeds if p succeeds and q succeeds on the input left over by p. In case of failure, no back-tracking is performed (in an earlier parser produced by the | combinator).
q
a parser that will be executed after p (this parser) succeeds
returns
a Parser that -- on success -- returns a ~ (like a Pair, but easier to pattern match on) that contains the result of p and that of q. The resulting parser fails if either p or q fails, this failure is fatal.
Definition Classes
Parser → CombinableParser
def ~![U](p: => CompletionSupport.Parser[U]): CompletionSupport.Parser[CompletionSupport.~[T, U]]
Definition Classes
Parser
def ~>[U](q: => Parser[U]): Parser[U]
A parser combinator for sequential composition which keeps only the right result.
A parser combinator for sequential composition which keeps only the right result.
p ~> q succeeds if p succeeds and q succeeds on the input left over by p.
q
a parser that will be executed after p (this parser) succeeds -- evaluated at most once, and only when necessary.
returns
a Parser that -- on success -- returns the result of q.
Definition Classes
Parser → CombinableParser
def ~>[U](q: => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
Annotations
@migration
Migration
(Changed in version 2.9.0) The call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.
def ~>![U](q: => Parser[U]): Parser[U]
A parser combinator for non-back-tracking sequential composition which only keeps the right result.
A parser combinator for non-back-tracking sequential composition which only keeps the right result.
p ~>! q succeeds if p succeds and q succeds on the input left over by p. In case of failure, no back-tracking is performed (in an earlier parser produced by the | combinator).
q
a parser that will be executed after p (this parser) succeeds -- evaluated at most once, and only when necessary
returns
a Parser that -- on success -- reutrns the result of q. The resulting parser fails if either p or q fails, this failure is fatal.
Definition Classes
Parser → CombinableParser
def ~>![U](q: => CompletionSupport.Parser[U]): CompletionSupport.Parser[U]
Definition Classes
Parser
Annotations
@migration
Migration
(Changed in version 2.9.0) The call-by-name argument is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.

Deprecated Value Members

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

Packages

Parser

abstract class Parser[+T] extends CompletionSupport.Parser[T] with CombinableParser[T, Parser]

Instance Constructors

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from CombinableParser[T, Parser]

Inherited from CompletionSupport.Parser[T]

Inherited from (CompletionSupport.Input) => CompletionSupport.ParseResult[T]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Parser

abstract class Parser[+T] extends CompletionSupport.Parser[T] with CombinableParser[T, Parser]

Instance Constructors

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from CombinableParser[T, Parser]

Inherited from CompletionSupport.Parser[T]

Inherited from (CompletionSupport.Input) => CompletionSupport.ParseResult[T]

Inherited from AnyRef

Inherited from Any

Ungrouped

Parser