scala.util.parsing.combinator.lexical
the type of input elements the provided parsers consume (When consuming invidual characters, a parser is typically called a scanner, which produces tokens that are consumed by what is normally called a parser.
the type of input elements the provided parsers consume (When consuming invidual characters, a parser is typically called a scanner, which produces tokens that are consumed by what is normally called a parser. Nonetheless, the same principles apply, regardless of the input type.)
The fatal failure case of ParseResult: contains an error-message and the remaining input.
A class of error tokens.
The failure case of ParseResult: contains an error-message and the remaining input.
The parser input is an abstract reader of input elements, i.
The parser input is an abstract reader of input elements, i.e. the type of input the parsers in this component expect.
A common super-class for unsuccessful parse results.
A parser whose ~ combinator disallows back-tracking.
A base class for parser results.
The root class of parsers.
Scanner is essentially¹ a parser that produces Tokens
from a stream of characters.
The success case of ParseResult: contains the result and the remaining input.
Objects of this type are produced by a lexical parser or scanner, and consumed by a parser.
A wrapper over sequence of matches.
A parser that produces a token (from a stream of characters).
A parser that produces a token (from a stream of characters).
A parser for white-space -- its result will be discarded.
A parser for white-space -- its result will be discarded.
Test two objects for inequality.
Test two objects for inequality.
true if !(this == that), false otherwise.
Equivalent to x.hashCode except for boxed numeric types and null.
Equivalent to x.hashCode except for boxed numeric types and null.
For numerics, it returns a hash value which is consistent
with value equality: if two value type instances compare
as true, then ## will produce the same hash value for each
of them.
For null returns a hashcode where null.hashCode throws a
NullPointerException.
a hash value consistent with ==
Test two objects for equality.
Test two objects for equality.
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
true if the receiver object is equivalent to the argument; false otherwise.
A class for end-of-file tokens
An extractor so NoSuccess(msg, next) can be used in matches.
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)
a description of the kind of element this parser expects (for error messages)
a partial function that determines when this parser is successful and what its output is
A parser that succeeds if f is applicable to the first element of the input,
applying f to it to produce the result.
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.
the list of expected elements
a Parser that recognizes a specified list of elements
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")).
the Elem that must be the next piece of input for the returned parser to succeed
a tParser that succeeds if e is the next available input.
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.
A predicate that determines which elements match.
A function from the received element into an error message.
A parser for elements satisfying p(e).
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 acceptMatch("name", {case Identifier(n) => Name(n)})
accepts an Identifier(n) and returns a Name(n)
a description of the kind of element this parser expects (for error messages)
a partial function that determines when this parser is successful and what its output is
A parser that succeeds if f is applicable to the first element of the input,
applying f to it to produce the result.
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.
the list of expected elements
a Parser that recognizes a specified list of elements
Cast the receiver object to be of type T0.
Cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics.
Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at
runtime, while the expression List(1).asInstanceOf[List[String]] will not.
In the latter example, because the type argument is erased as part of compilation it is
not possible to check whether the contents of the list are of the requested type.
the receiver object.
if the receiver object is not an instance of the erasure of type T0.
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.
a parser that parses the first element
a parser that parses the subsequent elements
a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one
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.
a parser that parses the elements
a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one
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)
a parser that parses the elements
a parser that parses the token(s) separating the elements, yielding a right-associative function that combines two elements into one
the "last" (left-most) combination function to be applied
the "first" (right-most) element to be combined
A character-parser that matches any character except the ones given in cs (and returns it).
Create a copy of the receiver object.
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).
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).
A character-parser that matches a digit (and returns it).
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.
the Elem that must be the next piece of input for the returned parser to succeed
a Parser that succeeds if e is the next available input (and returns it).
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.
The element kind, used for error messages
A predicate that determines which elements match.
Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an equivalence relation on
non-null instances of AnyRef, and has three additional properties:
x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.x of type AnyRef, x.eq(null) and null.eq(x) returns false.null.eq(null) returns true. When overriding the equals or hashCode methods, it is important to ensure that their behavior is
consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they
should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
true if the argument is a reference to the receiver object; false otherwise.
The equality method for reference types.
A parser that results in an error.
A parser that results in an error.
The error message describing the failure.
A parser that always fails with the specified error message.
This token is produced by a scanner Scanner when scanning failed.
This token is produced by a scanner Scanner when scanning failed.
A parser that always fails.
A parser that always fails.
The error message describing the failure.
A parser that always fails with the specified error message.
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize method is invoked, as
well as the interaction between finalize and non-local returns
and exceptions, are all platform dependent.
Returns string formatted according to given format string.
Returns string formatted according to given format string.
Format strings are as for String.format
(@see java.lang.String.format).
A representation that corresponds to the dynamic class of the receiver object.
A representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
a representation that corresponds to the dynamic class of the receiver object.
not specified by SLS as a member of AnyRef
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.
a Parser that is to be applied to the input
A parser that returns success if and only if p succeeds but
never consumes any input
The hashCode method for reference types.
Test whether the dynamic type of the receiver object is T0.
Test whether the dynamic type of the receiver object is T0.
Note that the result of the test is modulo Scala's erasure semantics.
Therefore the expression 1.isInstanceOf[String] will return false, while the
expression List(1).isInstanceOf[List[String]] will return true.
In the latter example, because the type argument is erased as part of compilation it is
not possible to check whether the contents of the list are of the specified type.
true if the receiver object is an instance of erasure of type T0; false otherwise.
A character-parser that matches a letter (and returns it).
A helper method that turns a Parser into one that will
print debugging information to stdout before and after
being applied.
A helper method that turns a Parser into one that will
print debugging information to stdout before and after
being applied.
Given a concatenation with a repetition (list), move the concatenated element into the list
Given a concatenation with a repetition (list), move the concatenated element into the list
Equivalent to !(this eq that).
Equivalent to !(this eq that).
true if the argument is not a reference to the receiver object; false otherwise.
Wrap a parser so that its failures and errors become success and vice versa -- it never consumes any input.
Wrap a parser so that its failures and errors become success and vice versa -- it never consumes any input.
Wakes up a single thread that is waiting on the receiver object's monitor.
Wakes up a single thread that is waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
Wakes up all threads that are waiting on the receiver object's monitor.
Wakes up all threads that are waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
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.
A Parser that is tried on the input
a Parser that always succeeds: either with the result provided by p or
with the empty result
A parser generator delimiting whole phrases (i.
A parser generator delimiting whole phrases (i.e. programs).
phrase(p) succeeds if p succeeds and no input is left over after p.
the parser that must consume all input for the resulting parser to succeed.
a parser that has the same result as p, but that only succeeds
if p consumed all the input.
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.
a Parser whose result conforms to Positional.
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.
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).
a Parser that is to be applied successively to the input
A parser that returns a list of results produced by repeatedly applying p to the input.
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)
a Parser that parses the first piece of input
a Parser that is to be applied successively to the rest of the input (if any) -- evaluated at most once, and only when necessary
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).
(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.
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)
a Parser that is to be applied successively to the input
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).
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.
a Parser that is to be applied successively to the input
a Parser that parses the elements that separate the elements parsed by p
(interleaved with q)
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.
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).
the exact number of times p must succeed
a Parser that is to be applied successively to the input
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).
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.
a Parser that is to be applied successively to the input
a Parser that parses the elements that separate the elements parsed by p
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.
A parser that always succeeds.
A parser that always succeeds.
The result for the parser
A parser that always succeeds, with the given result v
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
a String representation of the object.
A character-parser that matches a white-space character (and returns it).
(lexical: StringAdd).self
(lexical: StringFormat).self
(Since version 2.10.0) lastNoSuccess was not thread-safe and will be removed in 2.11.0
(Since version 2.10.0) lastNoSuccess was not thread-safe and will be removed in 2.11.0
(lexical: ArrowAssoc[Lexical]).x
(Since version 2.10.0) Use leftOfArrow instead
(lexical: Ensuring[Lexical]).x
(Since version 2.10.0) Use resultOfEnsuring instead
This component complements the
Scannerscomponent with common operations for lexical parsers.Refer to scala.util.parsing.combinator.lexical.StdLexical for a concrete implementation for a simple, Scala-like language.