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 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.
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.
The success case of ParseResult: contains the result and the remaining input.
o != arg0 is the same as !(o == (arg0)).
o != arg0 is the same as !(o == (arg0)).
the object to compare against this object for dis-equality.
false if the receiver object is equivalent to the argument; true otherwise.
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
o == arg0 is the same as o.equals(arg0).
o == arg0 is the same as o.equals(arg0).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
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'
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 <code>accept("name", {case Identifier(n) => Name(n)})</code>
accepts an <code>Identifier(n)</code> and returns a <code>Name(n)</code>.
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 <code>accept("name", {case Identifier(n) => Name(n)})</code>
accepts an <code>Identifier(n)</code> and returns a <code>Name(n)</code>.
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'
accept(es) succeeds if the input subsequently provides the elements in the list 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'
The method is implicit so that elements can automatically be lifted to their parsers.
For example, when parsing Token's, Identifier("new") (which is a Token') can be used directly,
instead of first creating a Parser' using accept(Identifier("new")).
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 Token's, 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.
This method is used to cast the receiver object to be of type T0.
This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(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 typed.
the receiver object.
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.
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 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. 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 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
This method creates and returns a copy of the receiver object.
This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
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 parser that matches only the given element e'
elem(e) succeeds if the input starts with an 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. @return
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
This method is used to test whether the argument (arg0) is a reference to the
receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on
non-null instances of AnyRef:
* It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true.
* It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and
only if y.eq(x) returns true.
* It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties.
* It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.
* For any non-null instance 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).
the object to compare against this object for reference equality.
true if the argument is a reference to the receiver object; false otherwise.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence
relation]:
* It is reflexive: for any instance x of type Any, x.equals(x) should return true.
* It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and
only if y.equals(x) returns true.
* It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and
y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation.
Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects
that are "equal" (o1.equals(o2) returns true) hash to the same
scala.Int
(o1.hashCode.equals(o2.hashCode)).
the object to compare against this object for equality.
true if the receiver object is equivalent to the argument; false otherwise.
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.
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.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
Returns a representation that corresponds to the dynamic class of the receiver object.
Returns 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.
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
Returns a hash code value for the object.
Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet
not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0.
However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have
identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure
to verify that the behavior is consistent with the equals method.
the hash code value for the object.
This method is used to test whether the dynamic type of the receiver object is T0.
This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.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 requested typed.
true if the receiver object is an instance of erasure of type T0; false otherwise.
A parser that matches a literal string
A parser that matches a literal string
o.ne(arg0) is the same as !(o.eq(arg0)).
o.ne(arg0) is the same as !(o.eq(arg0)).
the object to compare against this object for reference dis-equality.
false if the argument is not a reference to the receiver object; true otherwise.
Wrap a parser so that its failures&errors become success and vice versa -- it never consumes any input
Wrap a parser so that its failures&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.
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.
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
Parse some prefix of reader in' with parser p'
Parse some prefix of reader in' with parser p'
Parse some prefix of character sequence in' with parser p'
Parse some prefix of character sequence in' with parser p'
Parse some prefix of reader in' with parser p'
Parse some prefix of reader in' with parser p'
Parse all of character sequence in' with parser p'
Parse all of character sequence in' with parser p'
Parse all of reader in' with parser p'
Parse all of reader in' with parser p'
Parse all of reader in' with parser p'
Parse all of reader in' with parser p'
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 <code>p</code> consumed all the input.
positioned' decorates a parser's result with the start position of the input it consumed.
If whitespace is being skipped, then it is skipped before the start position is recorded.
positioned' decorates a parser's result with the start position of the input it consumed.
If whitespace is being skipped, then it is skipped before the start position is recorded.
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 after whitespace has been skipped, if it
didn't already have a position.
A parser that matches a regex string
A parser that matches a regex string
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)
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).
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')
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: <code>repsep(term, ",")</code> 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'
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
a string representation of the object.