Parsers

sbt.internal.util.complete.Parsers
See theParsers companion object
trait Parsers

Provides standard implementations of commonly useful Parsers.

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DefaultParsers.type
object Parsers.type

Members list

Value members

Concrete methods

def IDStart: Parser[Char]

Parses the first Char in an sbt identifier, which must be a Letter.

Parses the first Char in an sbt identifier, which must be a Letter.

Attributes

def Uri(ex: Set[URI]): Parser[URI]

Parses a URI that is valid according to the single argument java.net.URI constructor, using ex as tab completion examples.

Parses a URI that is valid according to the single argument java.net.URI constructor, using ex as tab completion examples.

Attributes

def alphanum(c: Char): Boolean

Returns true if c is an ASCII letter or digit.

Returns true if c is an ASCII letter or digit.

Attributes

def fileParser(base: File): Parser[File]

Value parameters

base

the directory used for completion proposals (when the user presses the TAB key). Only paths under this directory will be proposed.

Attributes

Returns

the file that was parsed from the input string. The returned path may or may not exist.

def flag[T](p: Parser[T]): Parser[Boolean]

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.

Attributes

def identifier(start: Parser[Char], rep: Parser[Char]): Parser[String]

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.

Attributes

def isDelimiter(c: Char): Boolean
def isIDChar(c: Char): Boolean

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 _.

Attributes

def isOpChar(c: Char): Boolean

Returns true if c an operator character.

Returns true if c an operator character.

Attributes

def isOpType(cat: Int): Boolean
def isScalaIDChar(c: Char): Boolean

Returns true if c is a letter, digit, or an underscore _.

Returns true if c is a letter, digit, or an underscore _.

Attributes

def mapOrFail[S, T](p: Parser[S])(f: S => T): Parser[T]

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.

Attributes

def opOrIDSpaced(s: String): Parser[Char]
def rep1sep[T](rep: Parser[T], sep: Parser[_]): Parser[Seq[T]]

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.

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.

Attributes

def repeatDep[A](p: Seq[A] => Parser[A], sep: Parser[Any]): Parser[Seq[A]]

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.

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.

Attributes

def repsep[T](rep: Parser[T], sep: Parser[_]): Parser[Seq[T]]

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.

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.

Attributes

def some[T](p: Parser[T]): Parser[Option[T]]

Wraps the result of p in Some.

Wraps the result of p in Some.

Attributes

def spaceDelimited(display: String): Parser[Seq[String]]

Parses a space-delimited, possibly empty sequence of arguments. The arguments may use quotes and escapes according to StringBasic.

Parses a space-delimited, possibly empty sequence of arguments. The arguments may use quotes and escapes according to StringBasic.

Attributes

def trimmed(p: Parser[String]): Parser[String]

Applies String.trim to the result of p.

Applies String.trim to the result of p.

Attributes

Concrete fields

lazy val BackslashChar: Char

Backslash character.

Backslash character.

Attributes

lazy val Bool: Parser[Boolean]

Parses the lower-case values true and false into their corresponding Boolean values.

Parses the lower-case values true and false into their corresponding Boolean values.

Attributes

lazy val CapitalizedID: Parser[String]

Parses a non-symbolic Scala-like identifier. The identifier must start with Upper and contain zero or more ScalaIDChars after that.

Parses a non-symbolic Scala-like identifier. The identifier must start with Upper and contain zero or more ScalaIDChars after that.

Attributes

lazy val DQuoteChar: Char

Double quote character.

Double quote character.

Attributes

lazy val DQuoteClass: Parser[Char]

Matches a single double quote.

Matches a single double quote.

Attributes

lazy val Digit: Parser[Char]

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.

Attributes

lazy val DigitSet: Set[String]

Set that contains each digit in a String representation.

Set that contains each digit in a String representation.

Attributes

lazy val EOF: Parser[Unit]

Matches the end of input, providing no useful result on success.

Matches the end of input, providing no useful result on success.

Attributes

lazy val EscapeSequence: Parser[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 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.

Attributes

lazy val HexDigit: Parser[Char]

Parses a single hexadecimal digit (0-9, a-f, A-F).

Parses a single hexadecimal digit (0-9, a-f, A-F).

Attributes

lazy val HexDigitSet: Set[Char]

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).

Attributes

lazy val ID: Parser[String]

Parses an identifier String, which must start with IDStart and contain zero or more IDChars after that.

Parses an identifier String, which must start with IDStart and contain zero or more IDChars after that.

Attributes

lazy val IDChar: Parser[Char]

Parses an identifier Char other than the first character. This includes letters, digits, dash -, and underscore _.

Parses an identifier Char other than the first character. This includes letters, digits, dash -, and underscore _.

Attributes

lazy val IntBasic: Parser[Int]

Parses a signed integer.

Parses a signed integer.

Attributes

lazy val Letter: Parser[Char]

Parses a single letter, according to Char.isLetter, into a Char.

Parses a single letter, according to Char.isLetter, into a Char.

Attributes

lazy val Lower: Parser[Char]

Parses a single letter, according to Char.isLower, into a Char.

Parses a single letter, according to Char.isLower, into a Char.

Attributes

lazy val NatBasic: Parser[Int]

Parses an unsigned integer.

Parses an unsigned integer.

Attributes

Matches any character except a double quote or backslash.

Matches any character except a double quote or backslash.

Attributes

lazy val NotDQuoteSpaceClass: Parser[Char]

Matches any character except a double quote or whitespace.

Matches any character except a double quote or whitespace.

Attributes

lazy val NotQuoted: Parser[String]

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.

Attributes

lazy val NotQuotedThenQuoted: Parser[String]

Parses a non-empty String value that cannot start with a double quote, but includes double quotes.

Parses a non-empty String value that cannot start with a double quote, but includes double quotes.

Attributes

lazy val NotSpace: Parser[String]

Matches a non-empty String consisting of non-whitespace characters.

Matches a non-empty String consisting of non-whitespace characters.

Attributes

lazy val NotSpaceClass: Parser[Char]

Matches a single character that is not a whitespace character.

Matches a single character that is not a whitespace character.

Attributes

lazy val Op: Parser[String]

Parses a non-empty operator String, which consists only of characters allowed by OpChar.

Parses a non-empty operator String, which consists only of characters allowed by OpChar.

Attributes

lazy val OpChar: Parser[Char]

Parses a single operator Char, as allowed by isOpChar.

Parses a single operator Char, as allowed by isOpChar.

Attributes

lazy val OpOrID: Parser[String]

Parses either an operator String defined by Op or a non-symbolic identifier defined by ID.

Parses either an operator String defined by Op or a non-symbolic identifier defined by ID.

Attributes

lazy val OptNotSpace: Parser[String]

Matches a possibly empty String consisting of non-whitespace characters.

Matches a possibly empty String consisting of non-whitespace characters.

Attributes

lazy val OptSpace: Parser[Seq[Char]]

Matches a possibly empty String consisting of whitespace characters. The suggested tab completion is a single, constant space character.

Matches a possibly empty String consisting of whitespace characters. The suggested tab completion is a single, constant space character.

Attributes

lazy val Port: Parser[Int]

Parses a port number. Currently, this accepts any integer and presents a tab completion suggestion of <port>.

Parses a port number. Currently, this accepts any integer and presents a tab completion suggestion of <port>.

Attributes

lazy val ScalaID: Parser[String]

Parses a non-symbolic Scala-like identifier. The identifier must start with IDStart and contain zero or more ScalaIDChars after that.

Parses a non-symbolic Scala-like identifier. The identifier must start with IDStart and contain zero or more ScalaIDChars after that.

Attributes

lazy val ScalaIDChar: Parser[Char]

Parses a single, non-symbolic Scala identifier Char. Valid characters are letters, digits, and the underscore character _.

Parses a single, non-symbolic Scala identifier Char. Valid characters are letters, digits, and the underscore character _.

Attributes

lazy val Size: Parser[Long]

Parses a size unit string. For example, 128K parsers to 128L * 1024, and 1.25g parses to 1024L * 1024 * 1024 * 5 / 4.

Parses a size unit string. For example, 128K parsers to 128L * 1024, and 1.25g parses to 1024L * 1024 * 1024 * 5 / 4.

Attributes

lazy val Space: Parser[Seq[Char]]

Matches a non-empty String consisting of whitespace characters. The suggested tab completion is a single, constant space character.

Matches a non-empty String consisting of whitespace characters. The suggested tab completion is a single, constant space character.

Attributes

lazy val SpaceClass: Parser[Char]

Matches a single whitespace character, as determined by Char.isWhitespace.

Matches a single whitespace character, as determined by Char.isWhitespace.

Attributes

lazy val StringBasic: Parser[String]

Parses a potentially quoted String value. The value may be verbatim quoted (StringVerbatim), quoted with interpreted escapes (StringEscapable), or unquoted (NotQuoted).

Parses a potentially quoted String value. The value may be verbatim quoted (StringVerbatim), quoted with interpreted escapes (StringEscapable), or unquoted (NotQuoted).

Attributes

lazy val StringEscapable: Parser[String]

Parses a string value, interpreting escapes and discarding the surrounding quotes in the result. See EscapeSequence for supported escapes.

Parses a string value, interpreting escapes and discarding the surrounding quotes in the result. See EscapeSequence for supported escapes.

Attributes

lazy val StringVerbatim: Parser[String]

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.

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.

Attributes

lazy val URIChar: Parser[Char]

Matches a single character that is valid somewhere in a URI.

Matches a single character that is valid somewhere in a URI.

Attributes

lazy val URIClass: Parser[String]

Parses a non-empty String that contains only valid URI characters, as defined by URIChar.

Parses a non-empty String that contains only valid URI characters, as defined by URIChar.

Attributes

lazy val UnicodeEscape: Parser[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 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.

Attributes

lazy val Upper: Parser[Char]

Parses a single letter, according to Char.isUpper, into a Char.

Parses a single letter, according to Char.isUpper, into a Char.

Attributes

lazy val VerbatimDQuotes: String

Triple-quotes, as used for verbatim quoting.

Triple-quotes, as used for verbatim quoting.

Attributes

lazy val any: Parser[Char]

Parses any single character and provides that character as the result.

Parses any single character and provides that character as the result.

Attributes

lazy val basicUri: Parser[URI]

Parses a URI that is valid according to the single argument java.net.URI constructor.

Parses a URI that is valid according to the single argument java.net.URI constructor.

Attributes