Backslash character.
Backslash character.
Parses the lower-case values true
and false
into their respesct Boolean values.
Parses the lower-case values true
and false
into their respesct Boolean values.
Double quote character.
Double quote character.
Matches a single double quote.
Matches a single double quote.
Parses any single digit and provides that digit as a Char as the result.
Parses any single digit and provides that digit as a Char as the result.
Set that contains each digit in a String representation.
Set that contains each digit in a String representation.
Matches the end of input, providing no useful result on success.
Matches the end of input, providing no useful result on success.
Parses a single escape sequence into the represented Char.
Parses a single escape sequence into the represented Char.
Escapes start with a backslash and are followed by u
for a UnicodeEscape or by b
, t
, n
, f
, r
, "
, '
, \
for standard escapes.
Parses a single hexadecimal digit (0-9, a-f, A-F).
Parses a single hexadecimal digit (0-9, a-f, A-F).
Set containing Chars for hexadecimal digits 0-9 and A-F (but not a-f).
Set containing Chars for hexadecimal digits 0-9 and A-F (but not a-f).
Parses an identifier String, which must start with IDStart and contain zero or more IDChars after that.
Parses an identifier Char other than the first character.
Parses an identifier Char other than the first character. This includes letters, digits, dash -
, and underscore _
.
Parses the first Char in an sbt identifier, which must be a Letter.
Parses a signed integer.
Parses a signed integer.
Parses a single letter, according to Char.
Parses a single letter, according to Char.isLetter, into a Char.
Parses an unsigned integer.
Parses an unsigned integer.
Matches any character except a double quote or backslash.
Matches any character except a double quote or backslash.
Matches any character except a double quote or whitespace.
Matches any character except a double quote or whitespace.
Parses an unquoted, non-empty String value that cannot start with a double quote and cannot contain whitespace.
Parses an unquoted, non-empty String value that cannot start with a double quote and cannot contain whitespace.
Matches a non-empty String consisting of non-whitespace characters.
Matches a non-empty String consisting of non-whitespace characters.
Matches a single character that is not a whitespace character.
Matches a single character that is not a whitespace character.
Parses a non-empty operator String, which consists only of characters allowed by OpChar.
Parses a single operator Char, as allowed by isOpChar.
Parses either an operator String defined by Op or a non-symbolic identifier defined by ID.
Matches a possibly empty String consisting of non-whitespace characters.
Matches a possibly empty String consisting of non-whitespace characters.
Matches a possibly empty String consisting of whitespace characters.
Matches a possibly empty String consisting of whitespace characters. The suggested tab completion is a single, constant space character.
Parses a port number.
Parses a port number. Currently, this accepts any integer and presents a tab completion suggestion of <port>
.
Parses a non-symbolic Scala-like identifier.
Parses a non-symbolic Scala-like identifier. The identifier must start with IDStart and contain zero or more ScalaIDChars after that.
Parses a single, non-symbolic Scala identifier Char.
Parses a single, non-symbolic Scala identifier Char. Valid characters are letters, digits, and the underscore character _
.
Matches a non-empty String consisting of whitespace characters.
Matches a non-empty String consisting of whitespace characters. The suggested tab completion is a single, constant space character.
Matches a single whitespace character, as determined by Char.
Matches a single whitespace character, as determined by Char.isWhitespace.
Parses a potentially quoted String value.
Parses a potentially quoted String value. The value may be verbatim quoted (StringVerbatim), quoted with interpreted escapes (StringEscapable), or unquoted (NotQuoted).
Parses a string value, interpreting escapes and discarding the surrounding quotes in the result.
Parses a string value, interpreting escapes and discarding the surrounding quotes in the result. See EscapeSequence for supported escapes.
Parses a verbatim quoted String value, discarding the quotes in the result.
Parses a verbatim quoted String value, discarding the quotes in the result. This kind of quoted text starts with triple quotes """
and ends at the next triple quotes and may contain any character in between.
Matches a single character that is valid somewhere in a URI.
Matches a single character that is valid somewhere in a URI.
Parses a non-empty String that contains only valid URI characters, as defined by URIChar.
Parses a single unicode escape sequence into the represented Char.
Parses a single unicode escape sequence into the represented Char.
A unicode escape begins with a backslash, followed by a u
and 4 hexadecimal digits representing the unicode value.
Parses a URI that is valid according to the single argument java.
Parses a URI that is valid according to the single argument java.net.URI constructor, using ex
as tab completion examples.
Triple-quotes, as used for verbatim quoting.
Triple-quotes, as used for verbatim quoting.
Returns true if c
is an ASCII letter or digit.
Returns true if c
is an ASCII letter or digit.
Parses any single character and provides that character as the result.
Parses any single character and provides that character as the result.
Applies parser p
to input s
.
Applies parser p
to input s
.
Parses a URI that is valid according to the single argument java.
Parses a URI that is valid according to the single argument java.net.URI constructor.
Defines a Parser that parses a single character only if the predicate f
returns true for that character.
Defines a Parser that parses a single character only if the predicate f
returns true for that character.
If this parser fails, label
is used as the failure message.
Defines a Parser that parses a single character only if it is contained in legal
.
Defines a Parser that parses a single character only if it is contained in legal
.
Applies parser p
to input s
and returns the completions at verbosity level
.
Applies parser p
to input s
and returns the completions at verbosity level
.
The interpretation of level
is up to parser definitions, but 0 is the default by convention,
with increasing positive numbers corresponding to increasing verbosity. Typically no more than
a few levels are defined.
Applies parser p
to a single character of input.
Applies parser p
to a single character of input.
the type of values that are returned by the parser.
the parser to decorate with a source of examples. All validation and parsing is delegated to this parser, only Parser.completions is modified.
the source of examples when displaying completions to the user.
limits the number of examples that the source of examples should return. This can prevent lengthy pauses and avoids bad interactive user experience.
indicates whether completion examples should be checked for validity (against the given parser). An exception is thrown if the example source contains no valid completion suggestions.
Defines a parser that always fails on any input with message msg
.
Defines a parser that always fails on any input with message msg
.
If definitive
is true
, any failures by later alternatives are discarded.
the directory used for completion proposals (when the user presses the TAB key). Only paths under this directory will be proposed.
the file that was parsed from the input string. The returned path may or may not exist.
Applies p
and uses true
as the result if it succeeds and turns failure into a result of false
.
Applies p
and uses true
as the result if it succeeds and turns failure into a result of false
.
Parses a String that starts with start
and is followed by zero or more characters parsed by rep
.
Parses a String that starts with start
and is followed by zero or more characters parsed by rep
.
Defines a parser that always fails on any input with messages msgs
.
Defines a parser that always fails on any input with messages msgs
.
If definitive
is true
, any failures by later alternatives are discarded.
Returns true if c
is a dash -
, a letter, digit, or an underscore _
.
Returns true if c
is a dash -
, a letter, digit, or an underscore _
.
Returns true if c
an operator character.
Returns true if c
an operator character.
Returns true if c
is a letter, digit, or an underscore _
.
Returns true if c
is a letter, digit, or an underscore _
.
Presents a literal String s
as a Parser that only parses that exact text and provides it as the result.
Presents a literal String s
as a Parser that only parses that exact text and provides it as the result.
Presents a single Char ch
as a Parser that only parses that exact character.
Presents a single Char ch
as a Parser that only parses that exact character.
Applies f
to the result of p
, transforming any exception when evaluating
f
into a parse failure with the exception toString
as the message.
Applies f
to the result of p
, transforming any exception when evaluating
f
into a parse failure with the exception toString
as the message.
Applies parser p
to input s
and returns true
if the parse was successful.
Parses input str
using parser
.
Parses input str
using parser
. If successful, the result is provided wrapped in Right
. If unsuccessful, an error message is provided in Left
.
Presents a Char range as a Parser.
Presents a Char range as a Parser. A single Char is parsed only if it is in the given range.
Applies rep
one or more times, separated by sep
.
Applies rep
one or more times, separated by sep
.
The result is the non-empty sequence of results from the multiple rep
applications. The sep
results are discarded.
Defines a sequence parser where the parser used for each part depends on the previously parsed values.
Defines a sequence parser where the parser used for each part depends on the previously parsed values.
p
is applied to the (possibly empty) sequence of already parsed values to obtain the next parser to use.
The parsers obtained in this way are separated by sep
, whose result is discarded and only the sequence
of values from the parsers returned by p
is used for the result.
Applies rep
zero or more times, separated by sep
.
Applies rep
zero or more times, separated by sep
.
The result is the (possibly empty) sequence of results from the multiple rep
applications. The sep
results are discarded.
Provides combinators for Parsers.
Provides combinators for Parsers.
Convenience method to use when developing a parser.
Convenience method to use when developing a parser.
parser
is applied to the input str
.
If completions
is true, the available completions for the input are displayed.
Otherwise, the result of parsing is printed using the result's toString
method.
If parsing fails, the error message is displayed.
See also sampleParse and sampleCompletions.
Convenience method to use when developing a parser.
Convenience method to use when developing a parser.
parser
is applied to the input str
and the available completions are displayed on separate lines.
If parsing fails, the error message is displayed.
Convenience method to use when developing a parser.
Convenience method to use when developing a parser.
parser
is applied to the input str
and the result of parsing is printed using the result's toString
method.
If parsing fails, the error message is displayed.
Wraps the result of p
in Some
.
Wraps the result of p
in Some
.
Parses a space-delimited, possibly empty sequence of arguments.
Parses a space-delimited, possibly empty sequence of arguments. The arguments may use quotes and escapes according to StringBasic.
Defines a parser that always succeeds on empty input with the result value
.
Defines a parser that always succeeds on empty input with the result value
.
Establishes delegate parser t
as a single token of tab completion.
Establishes delegate parser t
as a single token of tab completion.
When tab completion of part of this token is requested, description
is displayed for suggestions and no completions are ever performed.
Establishes delegate parser t
as a single token of tab completion.
Establishes delegate parser t
as a single token of tab completion.
When tab completion of part of this token is requested, no completions are returned if hide
returns true for the current tab completion level.
Otherwise, the completions provided by the delegate t
or a later derivative are appended to the prefix String already seen by this parser.
Establishes delegate parser t
as a single token of tab completion.
Establishes delegate parser t
as a single token of tab completion.
When tab completion of part of this token is requested, the completions provided by the delegate t
or a later derivative are appended to
the prefix String already seen by this parser.
Establishes delegate parser t
as a single token of tab completion.
Establishes delegate parser t
as a single token of tab completion.
When tab completion of part of this token is requested, display
is used as the printed suggestion, but the completions from the delegate
parser t
are used to complete if unambiguous.
Applies String.
Applies String.trim to the result of p
.
Returns true
if s
parses successfully according to ID.
See unapply.
(Since version 0.12.2) Explicitly specify the failure message.
(Since version 0.12.1) Use a different token
overload.
Provides common Parser implementations and helper methods.