NumericParser

case class NumericParser(digits: NonEmptySet[Char], prefix: Option[PrefixedParser[String]] = None, underscores: Boolean = false, exponent: Option[Parser[String]] = None, suffix: Option[Parser[String]] = None, allowFollowingLetter: Boolean = false) extends Parser[Seq[CodeSpan]] with CodeParserBase with Product with Serializable

Linear Supertypes

Serializable, Serializable, Product, Equals, CodeParserBase, CodeSpanParser, PrefixedParser[Seq[CodeSpan]], Parser[Seq[CodeSpan]], AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

NumericParser
Serializable
Serializable
Product
Equals
CodeParserBase
CodeSpanParser
PrefixedParser
Parser
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new NumericParser(digits: NonEmptySet[Char], prefix: Option[PrefixedParser[String]] = None, underscores: Boolean = false, exponent: Option[Parser[String]] = None, suffix: Option[Parser[String]] = None, allowFollowingLetter: Boolean = false)

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def *: Repeat[Seq[CodeSpan]]
Returns a parser that repeatedly applies this parser.
Returns a parser that repeatedly applies this parser. It will always succeed, potentially with an empty list as the result.

Definition Classes
Parser
def +: Repeat[Seq[CodeSpan]]
Returns a parser that repeatedly applies this parser (at least once).
Returns a parser that repeatedly applies this parser (at least once).

Definition Classes
Parser
def ++(other: CodeSpanParser): CodeSpanParser
Merges the parsers of this collection with those of the specified other collection.
Merges the parsers of this collection with those of the specified other collection. The order of parsers is relevant, since they will be applied in the specified order. If any parser successfully produces a result, the subsequent parsers will not be invoked

Definition Classes
CodeSpanParser
def <~(value: String): PrefixedParser[Seq[CodeSpan]]
Attempts to parse the specified literal string from the input left over by this parser, but only keeps the left result.
Attempts to parse the specified literal string from the input left over by this parser, but only keeps the left result.
a <~ b only succeeds if both parsers succeed.

Definition Classes
PrefixedParser → Parser
def <~[U](p: Parser[U]): PrefixedParser[Seq[CodeSpan]]
Applies the specified parser to the input left over by this parser, but only keeps the left result.
Applies the specified parser to the input left over by this parser, but only keeps the left result.
a <~ b only succeeds if both parsers succeed.

Definition Classes
PrefixedParser → Parser
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def >>[U](fq: (Seq[CodeSpan]) ⇒ Parser[U]): PrefixedParser[U]
Operator synonym for flatMap.
Operator synonym for flatMap.

Definition Classes
PrefixedParser → Parser
def ?: Parser[Option[Seq[CodeSpan]]]
Returns a parser that optionally parses what this parser parses.
Returns a parser that optionally parses what this parser parses.

Definition Classes
Parser
def ^^[U](f: (Seq[CodeSpan]) ⇒ U): PrefixedParser[U]
A synonym for map, allowing the grammar to be declared in a concise way.
A synonym for map, allowing the grammar to be declared in a concise way.

Definition Classes
PrefixedParser → Parser
val allowFollowingLetter: Boolean
def as[U](v: ⇒ U): PrefixedParser[U]
Returns a parser that ignores the result of this parser (if it succeeds) and returns the specified result instead.
Returns a parser that ignores the result of this parser (if it succeeds) and returns the specified result instead.
Subclasses may override this method to avoid any expensive result processing.

Definition Classes
PrefixedParser → Parser
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def collect[U, V >: Seq[CodeSpan]](f: PartialFunction[Seq[CodeSpan], U], error: (V) ⇒ String = ...): PrefixedParser[U]
Returns a parser that applies a partial function to the result of this parser.
Returns a parser that applies a partial function to the result of this parser.
p.collect(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.
error
an optional function that takes the same argument as f and produces an error message.

Definition Classes
PrefixedParser → Parser
def count: Parser[Int]
Returns a parser that produces the number of characters consumed by this parser while discarding the original result.
Returns a parser that produces the number of characters consumed by this parser while discarding the original result.

Definition Classes
Parser
def cursor: PrefixedParser[SourceFragment]
Provides a cursor over the input consumed by this parser while discarding the actual result.
Provides a cursor over the input consumed by this parser while discarding the actual result. Use withCursor if you also need access to the result.
This is required for parsers that create AST nodes that need to be resolved in a rewrite step and need to report the source location in case of failure. It is also required when passing a result of a first-pass parser to a recursive parser to preserve line positions.

Definition Classes
PrefixedParser → Parser
val digits: NonEmptySet[Char]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def evalMap[U](f: (Seq[CodeSpan]) ⇒ Either[String, U]): PrefixedParser[U]
Returns a parser that applies a function to the result of this parser producing an Either where Left is interpreted as failure.
Returns a parser that applies a function to the result of this parser producing an Either where Left is interpreted as failure. It is an alternative to ^? for scenarios where the conditional check cannot be easily performed in a pattern match.
p.evalMap(f) succeeds if p succeeds and f returns a Right when applied to the result of p.

Definition Classes
PrefixedParser → Parser
val exponent: Option[Parser[String]]
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flatMap[U](f: (Seq[CodeSpan]) ⇒ Parser[U]): PrefixedParser[U]
Builds a new parser by applying the specified function to the result of this parser and subsequently applying the parser returned by that function to the input left over by this parser.
Builds a new parser by applying the specified function to the result of this parser and subsequently applying the parser returned by that function to the input left over by this parser.

Definition Classes
PrefixedParser → Parser
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def handleErrorWith[U >: Seq[CodeSpan]](f: (Failure) ⇒ Parser[U]): Parser[U]
Handle any error, potentially recovering from it, by mapping it to a new parser that will be applied at the same starting position than the failing parser.
Handle any error, potentially recovering from it, by mapping it to a new parser that will be applied at the same starting position than the failing parser.
This is similar to the orElse or | method, but allows the alternative parser to inspect the error of the preceding one.

Definition Classes
Parser
See also
recoverWith to recover from only certain errors.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def map[U](f: (Seq[CodeSpan]) ⇒ U): PrefixedParser[U]
Builds a new parser by applying the specified function to the result of this parser.
Builds a new parser by applying the specified function to the result of this parser.

Definition Classes
PrefixedParser → Parser
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
def orElse[U >: Seq[CodeSpan]](p: ⇒ PrefixedParser[U]): PrefixedParser[U]
Applies the specified parser when this parser fails.
Applies the specified parser when this parser fails.
a.orElse(b) succeeds if either of the parsers succeeds.
This is a specialized variant of the orElse method of the base trait that preserves the nature of the PrefixedParser if both original parsers implement this trait.

Definition Classes
PrefixedParser
def orElse[U >: Seq[CodeSpan]](p0: ⇒ Parser[U]): Parser[U]
Applies the specified parser when this parser fails.
Applies the specified parser when this parser fails.
a orElse b succeeds if either of the parsers succeeds.
In case both parsers fail, the Failure instance will be from the parser with the most successfully read characters. In the case of multiple failures having the same number of characters, the one with the highest precedence (this parser) will be chosen.
Implementation note: The parameter is by-name to allow the definition of recursive parsers. In contrast to the former SDK parser combinators this is the only place where a parser with a by-name parameter is used whereas in all other places the additional cost is avoided.

Definition Classes
Parser
def parse(in: SourceCursor): Parsed[Seq[CodeSpan]]
Parses the string content in the specified context and returns the result.
Parses the string content in the specified context and returns the result.
This is the only abstract method in Parser that concrete implementations need to implement.

Definition Classes
PrefixedParser → Parser
def parse(in: String): Parsed[Seq[CodeSpan]]
Parses the specified string and returns the result.
Parses the specified string and returns the result.

Definition Classes
Parser
def parsers: Seq[PrefixedParser[CategorizedCode]]
The collection of parsers provided by this instance.
The collection of parsers provided by this instance. The order of parsers is relevant, since they will be applied in the specified order. If any parser successfully produces a result, the subsequent parsers will not be invoked.

Definition Classes
CodeParserBase → CodeSpanParser
val prefix: Option[PrefixedParser[String]]
def recoverWith[U >: Seq[CodeSpan]](pf: PartialFunction[Failure, Parser[U]]): Parser[U]
Handle certain errors, potentially recovering from it, by mapping them to a new parser that will be applied at the same starting position than the failing parser.
Handle certain errors, potentially recovering from it, by mapping them to a new parser that will be applied at the same starting position than the failing parser.

Definition Classes
Parser
See also
handleErrorWith to handle any/all errors.
def rep(separator: String): Repeat[Seq[CodeSpan]]
Returns a parser that repeatedly applies this parser with the specified separator string between those invocations.
Returns a parser that repeatedly applies this parser with the specified separator string between those invocations.
p.rep(sep).min(1) is equivalent to (p ~ (sep ~> p).rep).concat.
The returned parser offers an API to specify further constraints like min or max.

Definition Classes
Parser
def rep(separator: Parser[Unit]): Repeat[Seq[CodeSpan]]
Returns a parser that repeatedly applies this parser with the specified separator parser between those invocations.
Returns a parser that repeatedly applies this parser with the specified separator parser between those invocations.
p.rep(sep).min(1) is equivalent to (p ~ (sep ~> p).rep).concat.
The returned parser offers an API to specify further constraints like min or max.

Definition Classes
Parser
def rep: Repeat[Seq[CodeSpan]]
Returns a parser that repeatedly applies this parser.
Returns a parser that repeatedly applies this parser. The returned parser offers an API to specify further constraints like min or max.

Definition Classes
Parser
def repUntil[U](endCondition: Parser[U]): Parser[(List[Seq[CodeSpan]], Option[U])]
Returns a parser that repeatedly applies this parser until either this parser fails or the specified end condition is met.
Returns a parser that repeatedly applies this parser until either this parser fails or the specified end condition is met. The end condition will be applied after each successful invocation of this parser.
The result of the returned parser is a tuple consisting of the list containing the result of the invocations of this parser plus the result of the end condition. The latter is returned as an Option as it might be empty when the parsing finished because of this parser failing.
Note that it is more convenient to include the end condition in the repeating parser itself and use the simpler rep method. This combinator is an alternative if you need to know the result of the end condition.

Definition Classes
Parser
def repWith[U >: Seq[CodeSpan]](next: (U) ⇒ Parser[U]): Parser[List[U]]
Returns a parser that invokes the specified function repeatedly, passing the result of this parser if it succeeds, to produce new parsers that get applied until one of them fails.
Returns a parser that invokes the specified function repeatedly, passing the result of this parser if it succeeds, to produce new parsers that get applied until one of them fails.
The result of the returned parser is a list containing the result of this parser (if it succeeds) plus the results of successful invocations of the parsers returned by the specified function.

Definition Classes
Parser
def source: PrefixedParser[String]
Retrieves the part of the input consumed by this parser while discarding the result.
Retrieves the part of the input consumed by this parser while discarding the result.
This is useful in scenarios where many string-based parsers are combined and produce a deeply nested result like String ~ Option[String] ~ List[String] where it would require some boilerplate to concatenate the results. Using the source method, the entire text consumed by this combination of parsers will be returned.
If you also need the position within the input or need to pass the result to a recursive parser manually, use the cursor method instead.

Definition Classes
PrefixedParser → Parser
def startChars: NonEmptySet[Char]
The set of trigger characters that can start this parser.
The set of trigger characters that can start this parser.

Definition Classes
CodeParserBase → PrefixedParser
val suffix: Option[Parser[String]]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
lazy val underlying: PrefixedParser[Seq[CodeSpan]]
The underlying parser that may be optimized based on the specified start characters.
The underlying parser that may be optimized based on the specified start characters.

Definition Classes
NumericParser → CodeParserBase → PrefixedParser
val underscores: Boolean
def void: Parser[Unit]
Discards the result of a successful parser.
Discards the result of a successful parser.

Definition Classes
Parser
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def withCursor: PrefixedParser[(Seq[CodeSpan], SourceFragment)]
Provides the result of this parser together with a cursor over the input, capturing the consumed source string and its position within the root input.
Provides the result of this parser together with a cursor over the input, capturing the consumed source string and its position within the root input. Use cursor if you do not need access to the actual result.
This is required for parsers that create AST nodes that need to be resolved in a rewrite step and need to report the source location in case of failure. It is also required when passing a result of a first-pass parser to a recursive parser to preserve line positions.

Definition Classes
PrefixedParser → Parser
def withFailureMessage(msg: String): Parser[Seq[CodeSpan]]
Changes the failure message produced by a parser.
Changes the failure message produced by a parser.

Definition Classes
Parser
def withSuffix(parser: Parser[String]): NumericParser
Accepts a suffix after a number literal, usually to denote a concrete number type as in 123L.
def withUnderscores: NumericParser
Accepts underscores as visual separators in a number literal, as in 12_045.
def |(value: String)(implicit ev: <:<[Seq[CodeSpan], String]): PrefixedParser[String]
Attempts to parse the specified literal string when this parser fails.
Attempts to parse the specified literal string when this parser fails.
a | b succeeds if either of the parsers succeeds.

Definition Classes
PrefixedParser → Parser
def |[U >: Seq[CodeSpan]](p: ⇒ PrefixedParser[U]): PrefixedParser[U]
Applies the specified parser when this parser fails.
Applies the specified parser when this parser fails.
a | b succeeds if either of the parsers succeeds.
This is a specialized variant of the | method of the base trait that preserves the nature of the PrefixedParser if both original parsers implement this trait.

Definition Classes
PrefixedParser
def |[U >: Seq[CodeSpan]](p: ⇒ Parser[U]): Parser[U]
Applies the specified parser when this parser fails.
Applies the specified parser when this parser fails.
a | b succeeds if either of the parsers succeeds.
Implementation note: The parameter is by-name to allow the definition of recursive parsers. In contrast to the former SDK parser combinators this is the only place where a parser with a by-name parameter is used whereas in all other places the additional cost is avoided.

Definition Classes
Parser
def ~(value: String): PrefixedParser[~[Seq[CodeSpan], String]]
Attempts to parse the specified literal string from the input left over by this parser and combines the two results.
Attempts to parse the specified literal string from the input left over by this parser and combines the two results.
a ~ b only succeeds if both parsers succeed, with the results in a wrapper class named ~ for convenient pattern matching:
```
a ~ b ~ c ^^ {
  case a ~ b ~ c => processResult(a, b, c)
}
```
Definition Classes
PrefixedParser → Parser
def ~[U](p: Parser[U]): PrefixedParser[~[Seq[CodeSpan], U]]
Applies the specified parser to the input left over by this parser and combines the two results.
Applies the specified parser to the input left over by this parser and combines the two results.
a ~ b only succeeds if both parsers succeed, with the results in a wrapper class named ~ for convenient pattern matching:
```
a ~ b ~ c ^^ {
  case a ~ b ~ c => processResult(a, b, c)
}
```
Definition Classes
PrefixedParser → Parser
def ~>(value: String): PrefixedParser[String]
Attempts to parse the specified literal string from the input left over by this parser, but only keeps the right result.
Attempts to parse the specified literal string from the input left over by this parser, but only keeps the right result.
a ~> b only succeeds if both parsers succeed.

Definition Classes
PrefixedParser → Parser
def ~>[U](p: Parser[U]): PrefixedParser[U]
Applies the specified parser to the input left over by this parser, but only keeps the right result.
Applies the specified parser to the input left over by this parser, but only keeps the right result.
a ~> b only succeeds if both parsers succeed.

Definition Classes
PrefixedParser → Parser

Packages

NumericParser

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CodeParserBase

Inherited from CodeSpanParser

Inherited from PrefixedParser[Seq[CodeSpan]]

Inherited from Parser[Seq[CodeSpan]]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

NumericParser 

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CodeParserBase

Inherited from CodeSpanParser

Inherited from PrefixedParser[Seq[CodeSpan]]

Inherited from Parser[Seq[CodeSpan]]

Inherited from AnyRef

Inherited from Any

Ungrouped

NumericParser