Number - Scala Mathematical Library
1.10.6
API
Generated with
Number - Scala Mathematical Library/com.phasmidsoftware.number/com.phasmidsoftware.number.core/com.phasmidsoftware.number.core.parse/MillParser

MillParser

com.phasmidsoftware.number.core.parse.MillParser
object MillParser extends BaseMillParser

Attributes

Graph
Supertypes
trait JavaTokenParsers
trait RegexParsers
trait Parsers
class Object
trait Matchable
class Any
Show all
Self type
MillParser.type

Members list

Type members

Inherited classlikes

case class AnadicTerm(t: BaseMillParser.this.Token) extends Term

AnadicTerm is a Term defined by a Token, which is either an operator (a String) or a Number.

AnadicTerm is a Term defined by a Token, which is either an operator (a String) or a Number.

Value parameters

t

the defining token.

Attributes

Inherited from:
BaseMillParser
Supertypes
trait Serializable
trait Product
trait Equals
trait BaseMillParser.this.Term
class Object
trait Matchable
class Any
Show all
case class Error(msg: String, next: Parsers.this.Input) extends NoSuccess

The fatal failure case of ParseResult: contains an error-message and the remaining input. No back-tracking is done when a parser returns an Error.

The fatal failure case of ParseResult: contains an error-message and the remaining input. No back-tracking is done when a parser returns an Error.

Value parameters

msg

An error message string describing the error.

next

The parser's unconsumed input at the point where the error occurred.

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Parsers.this.NoSuccess
class Parsers.this.ParseResult[Nothing]
class Object
trait Matchable
class Any
Show all
case class Failure(msg: String, next: Parsers.this.Input) extends NoSuccess

The failure case of ParseResult: contains an error-message and the remaining input. Parsing will back-track when a failure occurs.

The failure case of ParseResult: contains an error-message and the remaining input. Parsing will back-track when a failure occurs.

Value parameters

msg

An error message string describing the failure.

next

The parser's unconsumed input at the point where the failure occurred.

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Parsers.this.NoSuccess
class Parsers.this.ParseResult[Nothing]
class Object
trait Matchable
class Any
Show all
case class MonadicTerm(t: BaseMillParser.this.Term, os: List[String], op: String) extends Term

MonadicTerm is a Term defined by a Term t, a list of Strings, and an operator op.

MonadicTerm is a Term defined by a Term t, a list of Strings, and an operator op.

Value parameters

op

an monadic operator, represented by a String.

os

a possibly empty list of Strings, representing neutral operators such as the swap operator.

t

a Term, typically a Number or another term.

Attributes

Inherited from:
BaseMillParser
Supertypes
trait Serializable
trait Product
trait Equals
trait BaseMillParser.this.Term
class Object
trait Matchable
class Any
Show all
object NoSuccess

An extractor so case NoSuccess(msg, next) can be used in matches.

An extractor so case NoSuccess(msg, next) can be used in matches.

Note: On Scala 2.13, using this extractor leads to an exhaustivity warning:

 def m(r: ParseResult[Int]) = r match {
   case Success(i) => ...
   case NoSuccess(msg, _) => ... // "warning: match may not be exhaustive"

To eliminate this warning, use the irrefutable NoSuccess.I extractor. Due to binary compatibility, NoSuccess itself cannot be changed.

Attributes

Inherited from:
Parsers
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
case class NumberWithFuzziness(realNumber: BaseNumberParser.this.RealNumber, fuzziness: Option[String], maybeExponent: Option[String]) extends ValuableNumber, WithFuzziness

Parser class to represent a number with fuzziness.

Parser class to represent a number with fuzziness.

Value parameters

fuzziness

optional Gaussian fuzziness (as a String)--from a parenthetical number; if None, we have Box fuzziness (corresponding to "*").

maybeExponent

optional exponent (as a String).

realNumber

a representation of a real (decimal) number in String form.

Attributes

Inherited from:
BaseNumberParser
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait OnceParser[+T] extends Parser[T]

A parser whose ~ combinator disallows back-tracking.

A parser whose ~ combinator disallows back-tracking.

Attributes

Inherited from:
Parsers
Supertypes
class Parsers.this.Parser[T]
trait Parsers.this.Input => Parsers.this.ParseResult[T]
class Object
trait Matchable
class Any
implicit class ParserOps[X](p: SignificantSpaceParsers.this.Parser[X])

Implicit class ParserOps which allows us to use the method :| on a Parser[X].

Implicit class ParserOps which allows us to use the method :| on a Parser[X].

Type parameters

X

the underlying type of p.

Value parameters

p

a Parser[X].

Attributes

Inherited from:
SignificantSpaceParsers
Supertypes
class Object
trait Matchable
class Any
implicit class ParserOptionOps[X](p: SignificantSpaceParsers.this.Parser[Option[X]])

Implicit class ParserOptionOps which allows us to use the method ?| on a Parser of Option[X].

Implicit class ParserOptionOps which allows us to use the method ?| on a Parser of Option[X].

Type parameters

X

the under-underlying type of p.

Value parameters

p

a Parser of Option[X].

Attributes

Inherited from:
SignificantSpaceParsers
Supertypes
class Object
trait Matchable
class Any
case class RatioNumber(numerator: BaseRationalParser.this.WholeNumber, denominator: BaseRationalParser.this.WholeNumber) extends ValuableNumber

Attributes

Inherited from:
BaseRationalParser
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RealNumber(sign: Boolean, integerPart: String, maybeFractionalPart: Option[String], exponent: Option[String]) extends ValuableNumber

Attributes

Inherited from:
BaseRationalParser
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
implicit class RegexOps(r: Regex)

Implicit class RegexOps which allows us to use the method :| on a Regex.

Implicit class RegexOps which allows us to use the method :| on a Regex.

Value parameters

r

a Regex.

Attributes

Inherited from:
SignificantSpaceParsers
Supertypes
class Object
trait Matchable
class Any
case class Success[+T](result: T, next: Parsers.this.Input) extends ParseResult[T]

The success case of ParseResult: contains the result and the remaining input.

The success case of ParseResult: contains the result and the remaining input.

Value parameters

next

The parser's remaining input

result

The parser's output

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Parsers.this.ParseResult[T]
class Object
trait Matchable
class Any
Show all
trait Term

Trait Term which represents a dyadic, monadic, anadic term (the latter including a Number).

Trait Term which represents a dyadic, monadic, anadic term (the latter including a Number).

Attributes

Inherited from:
BaseMillParser
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class WholeNumber(sign: Boolean, digits: String) extends ValuableNumber

A "Whole" number. According to this definition all integers (Z) are whole numbers. More mathematically speaking, the "whole" numbers are the Natural numbers (N) together with zero.

A "Whole" number. According to this definition all integers (Z) are whole numbers. More mathematically speaking, the "whole" numbers are the Natural numbers (N) together with zero.

Value parameters

digits

the digits read in.

sign

whether the parser detected a minus sign.

Attributes

Inherited from:
BaseRationalParser
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WholeNumber

Attributes

Inherited from:
BaseRationalParser
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
case class ~[+a, +b](_1: a, _2: b)

A wrapper over sequence of matches.

A wrapper over sequence of matches.

Given p1: Parser[A] and p2: Parser[B], a parser composed with p1 ~ p2 will have type Parser[~[A, B]]. The successful result of the parser can be extracted from this case class.

It also enables pattern matching, so something like this is possible:

def concat(p1: Parser[String], p2: Parser[String]): Parser[String] =
  p1 ~ p2 ^^ { case a ~ b => a + b }

Attributes

Inherited from:
Parsers
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited and Abstract classlikes

sealed abstract class NoSuccess(val msg: String, val next: Parsers.this.Input) extends ParseResult[Nothing]

A common super-class for unsuccessful parse results.

A common super-class for unsuccessful parse results.

Attributes

Inherited from:
Parsers
Supertypes
class Parsers.this.ParseResult[Nothing]
class Object
trait Matchable
class Any
Known subtypes
class Parsers.this.Error
class Parsers.this.Failure
sealed abstract class ParseResult[+T]

A base class for parser results. A result is either successful or not (failure may be fatal, i.e., an Error, or not, i.e., a Failure). On success, provides a result of type T which consists of some result (and the rest of the input).

A base class for parser results. A result is either successful or not (failure may be fatal, i.e., an Error, or not, i.e., a Failure). On success, provides a result of type T which consists of some result (and the rest of the input).

Attributes

Inherited from:
Parsers
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Parsers.this.NoSuccess
class Parsers.this.Error
class Parsers.this.Failure
class Parsers.this.Success[T]
abstract class Parser[+T] extends Input => ParseResult[T]

The root class of parsers. Parsers are functions from the Input type to ParseResult.

The root class of parsers. Parsers are functions from the Input type to ParseResult.

Attributes

Inherited from:
Parsers
Supertypes
trait Parsers.this.Input => Parsers.this.ParseResult[T]
class Object
trait Matchable
class Any
Known subtypes
trait Parsers.this.OnceParser[T]

Inherited types

type Elem = Char

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

Attributes

Inherited from:
RegexParsers
type Input = Reader[Elem]

The parser input is an abstract reader of input elements, i.e. the type of input the parsers in this component expect.

The parser input is an abstract reader of input elements, i.e. the type of input the parsers in this component expect.

Attributes

Inherited from:
Parsers
type Token = Either[String, Number]

Token is something that results in a value: either a Number (itself); or a non-empty sequence of String each of which is an anadic (no operand) operator.

Token is something that results in a value: either a Number (itself); or a non-empty sequence of String each of which is an anadic (no operand) operator.

Attributes

Inherited from:
BaseMillParser

Value members

Inherited methods

def OnceParser[T](f: Input => ParseResult[T]): Parser[T] & OnceParser[T]

Attributes

Inherited from:
Parsers
def Parser[T](f: Input => ParseResult[T]): Parser[T]

Attributes

Inherited from:
Parsers
def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

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)

Value parameters

expected

a description of the kind of element this parser expects (for error messages)

f

a partial function that determines when this parser is successful and what its output is

Attributes

Returns

A parser that succeeds if f is applicable to the first element of the input, applying f to it to produce the result.

Inherited from:
Parsers
def accept[ES](es: ES)(implicit f: ES => List[Elem]): Parser[List[Elem]]

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.

Value parameters

es

the list of expected elements

Attributes

Returns

a Parser that recognizes a specified list of elements

Inherited from:
Parsers
def acceptIf(p: Elem => Boolean)(err: Elem => String): Parser[Elem]

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.

Value parameters

err

A function from the received element into an error message.

p

A predicate that determines which elements match.

Attributes

Returns

A parser for elements satisfying p(e).

Inherited from:
Parsers
def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

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)

Value parameters

expected

a description of the kind of element this parser expects (for error messages)

f

a partial function that determines when this parser is successful and what its output is

Attributes

Returns

A parser that succeeds if f is applicable to the first element of the input, applying f to it to produce the result.

Inherited from:
Parsers
def acceptSeq[ES](es: ES)(implicit f: ES => Iterable[Elem]): Parser[List[Elem]]

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.

Value parameters

es

the list of expected elements

Attributes

Returns

a Parser that recognizes a specified list of elements

Inherited from:
Parsers
def anadicOperator: Parser[String]

Attributes

Inherited from:
BaseMillParser
def anadicTerm: Parser[AnadicTerm]

anadicTerm: an operator or Number which increases depth of the stack.

anadicTerm: an operator or Number which increases depth of the stack.

Attributes

Returns

a Parser[AnadicTerm]

Inherited from:
BaseMillParser
def chainl1[T, U](first: => Parser[T], p: => Parser[U], q: => Parser[(T, U) => T]): Parser[T]

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.

Value parameters

first

a parser that parses the first element

p

a parser that parses the subsequent elements

q

a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one

Attributes

Inherited from:
Parsers
def chainl1[T](p: => Parser[T], q: => Parser[(T, T) => T]): Parser[T]

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

Value parameters

p

a parser that parses the elements

q

a parser that parses the token(s) separating the elements, yielding a left-associative function that combines two elements into one

Attributes

Inherited from:
Parsers
def chainr1[T, U](p: => Parser[T], q: => Parser[(T, U) => U], combine: (T, U) => U, first: U): Parser[U]

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.

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)

Value parameters

combine

the "last" (left-most) combination function to be applied

first

the "first" (right-most) element to be combined

p

a parser that parses the elements

q

a parser that parses the token(s) separating the elements, yielding a right-associative function that combines two elements into one

Attributes

Inherited from:
Parsers
def commit[T](p: => Parser[T]): Parser[T]

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

Attributes

Inherited from:
Parsers
protected def debug[X](x: X, w: => String)(implicit enabled: Boolean): X

Attributes

Inherited from:
SignificantSpaceParsers
def decimalNumber: Parser[String]

Number following one of these rules:

Number following one of these rules:

  • An integer. For example: 13
  • An integer followed by a decimal point. For example: 3.
  • An integer followed by a decimal point and fractional part. For example: 3.14
  • A decimal point followed by a fractional part. For example: .1

Attributes

Inherited from:
JavaTokenParsers
def dyadicOperator: Parser[String]

Attributes

Inherited from:
BaseMillParser
def dyadicTerm: Parser[Term]

Attributes

Inherited from:
BaseMillParser
def elem(e: Elem): Parser[Elem]

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.

Value parameters

e

the Elem that must be the next piece of input for the returned parser to succeed

Attributes

Returns

a Parser that succeeds if e is the next available input (and returns it).

Inherited from:
Parsers
def elem(kind: String, p: Elem => Boolean): Parser[Elem]

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.

Value parameters

kind

The element kind, used for error messages

p

A predicate that determines which elements match.

Attributes

Inherited from:
Parsers
override def err(msg: String): Parser[Nothing]

A parser that results in an error.

A parser that results in an error.

This parser additionally skips whitespace if skipWhitespace returns true.

Attributes

Definition Classes
RegexParsers -> Parsers
Inherited from:
RegexParsers
def exponent: Parser[String]

Attributes

Inherited from:
BaseNumberParser
def factor: Parser[Factor]

Parses a factor from the input. A factor can represent specific mathematical constants, symbols, or degrees. The parser attempts to match various predefined symbols such as a percentage sign, degree symbol, multiple representations of π, or Euler's number. If none of these are matched, the parser will fail with a defined error message.

Parses a factor from the input. A factor can represent specific mathematical constants, symbols, or degrees. The parser attempts to match various predefined symbols such as a percentage sign, degree symbol, multiple representations of π, or Euler's number. If none of these are matched, the parser will fail with a defined error message.

Attributes

Returns

a Parser that produces a Factor instance. The result encapsulates the matched symbol or numerical value of the factor.

Inherited from:
BaseNumberParser
def failure(msg: String): Parser[Nothing]

A parser that always fails.

A parser that always fails.

Value parameters

msg

The error message describing the failure.

Attributes

Returns

A parser that always fails with the specified error message.

Inherited from:
Parsers
def floatingPointNumber: Parser[String]

A number following the rules of decimalNumber, with the following optional additions:

A number following the rules of decimalNumber, with the following optional additions:

  • Preceded by a negative sign
  • Followed by e or E and an optionally signed integer
  • Followed by f, f, d or D (after the above rule, if both are used)

Attributes

Inherited from:
JavaTokenParsers
def fuzz: Parser[Option[String]]

Method to parse fuzz, consisting of the strings "*", "...", or one or two digits enclosed in () or [].

Method to parse fuzz, consisting of the strings "*", "...", or one or two digits enclosed in () or [].

Attributes

Returns

a Parser of an optional String. If the String is None, then it is general fuzz (* or ...) otherwise Some(digits).

Inherited from:
BaseNumberParser
def generalNumber: Parser[ValuableNumber]

Parses either a number with fuzziness or a rational number. This method combines the parsing of two distinct numeric formats:

Parses either a number with fuzziness or a rational number. This method combines the parsing of two distinct numeric formats:

  • A number with an optional degree of fuzziness.
  • A rational representation of a number. The parser attempts to parse input and tag the result as generalNumber.

Attributes

Returns

a Parser that yields a ValuableNumber. The result is determined by the successful parsing of one of the numeric formats.

Inherited from:
BaseNumberParser
def guard[T](p: => Parser[T]): Parser[T]

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

Value parameters

p

a Parser that is to be applied to the input

Attributes

Returns

A parser that returns success if and only if p succeeds but never consumes any input

Inherited from:
Parsers
protected def handleWhiteSpace(source: CharSequence, offset: Int): Int

Method called to handle whitespace before parsers.

Method called to handle whitespace before parsers.

It checks skipWhitespace and, if true, skips anything matching whiteSpace starting from the current offset.

Value parameters

offset

The offset into source from which to match.

source

The input being parsed.

Attributes

Returns

The offset to be used for the next parser.

Inherited from:
RegexParsers
def ident: Parser[String]

Anything that is a valid Java identifier, according to The Java Language Spec. Generally, this means a letter, followed by zero or more letters or numbers.

Anything that is a valid Java identifier, according to The Java Language Spec. Generally, this means a letter, followed by zero or more letters or numbers.

Attributes

Inherited from:
JavaTokenParsers
def log[T](p: => Parser[T])(name: String): Parser[T]

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.

Attributes

Inherited from:
Parsers
def logit[T](p: => Parser[T])(name: => String)(implicit ll: LogLevel): Parser[T]

(Internal) log method which expands on the capabilities of Parsers.log. If ll is LogOff, p is returned unchanged, other than that on failure of p, the parser failure(name) is invoked. If ll is LogInfo, a parser based on p, which on successful parsing logging with println will occur, is returned. If ll is LogDebug, then the value of log(p)(name) is returned.

(Internal) log method which expands on the capabilities of Parsers.log. If ll is LogOff, p is returned unchanged, other than that on failure of p, the parser failure(name) is invoked. If ll is LogInfo, a parser based on p, which on successful parsing logging with println will occur, is returned. If ll is LogDebug, then the value of log(p)(name) is returned.

Type parameters

T

the underlying type of p and the result.

Value parameters

ll

(implicit) LogLevel.

name

a String to identify this parser.

p

a parser[T].

Attributes

Returns

a Parser[T].

Inherited from:
SignificantSpaceParsers
def maybeNumber: Parser[Option[Number]]

This method defines a parser that attempts to parse an optional numerical value. The parser evaluates two optional components: a general number and a factor. It returns an optional Number, based on the combination of these parsed components. The parsing process is labeled as "maybeNumber".

This method defines a parser that attempts to parse an optional numerical value. The parser evaluates two optional components: a general number and a factor. It returns an optional Number, based on the combination of these parsed components. The parsing process is labeled as "maybeNumber".

Attributes

Returns

a Parser that yields an Option[Number]. The result is Some(Number) if either a general number or a factor is parsed, or None if neither component is present.

Inherited from:
BaseNumberParser
def mill: Parser[CoreMill]

A Parser[Mill]. This matches on a space-separated list of terms.

A Parser[Mill]. This matches on a space-separated list of terms.

Attributes

Returns

a Parser[Mill].

Inherited from:
BaseMillParser
def mkList[T]: (T ~ List[T]) => List[T]

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

Attributes

Inherited from:
Parsers
def monadicOperator: Parser[String]

Attributes

Inherited from:
BaseMillParser
def monadicTerm: Parser[MonadicTerm]

MonadicTerm: an operator or Number which maintains the depth of the stack. It matches on a monadicOperator, a list of neutral operators, followed by a term.

MonadicTerm: an operator or Number which maintains the depth of the stack. It matches on a monadicOperator, a list of neutral operators, followed by a term.

Attributes

Returns

a Parser[MonadicTerm].

Inherited from:
BaseMillParser
def neutralOperator1: Parser[String]

Attributes

Inherited from:
BaseMillParser
def neutralOperator2: Parser[String]

Attributes

Inherited from:
BaseMillParser
def not[T](p: => Parser[T]): Parser[Unit]

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.

Attributes

Inherited from:
Parsers
def number: Parser[Number]

Parses a token representing a number. The parsing process may provide a default fuzzy number if no explicit number is identified. The result is tagged for clarity to indicate the type of parser.

Parses a token representing a number. The parsing process may provide a default fuzzy number if no explicit number is identified. The result is tagged for clarity to indicate the type of parser.

Attributes

Returns

a Parser that yields a Number instance. If the parsing does not identify a concrete number, it defaults to a FuzzyNumber.

Inherited from:
BaseNumberParser
def numberWithFuzziness: Parser[NumberWithFuzziness]

Parses a representation of a number that includes an optional degree of fuzziness and an optional exponent. The parser expects a combination of a real number, fuzziness indicator, and possibly an exponent. The fuzziness can represent uncertainty or range encoded in specific formats like "*", "...", or digits in parentheses or brackets.

Parses a representation of a number that includes an optional degree of fuzziness and an optional exponent. The parser expects a combination of a real number, fuzziness indicator, and possibly an exponent. The fuzziness can represent uncertainty or range encoded in specific formats like "*", "...", or digits in parentheses or brackets.

Attributes

Returns

a Parser that yields a NumberWithFuzziness instance. The result contains the parsed real number, the optional fuzz description, and the optional exponent value.

Inherited from:
BaseNumberParser
def opt[T](p: => Parser[T]): Parser[Option[T]]

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.

Value parameters

p

A Parser that is tried on the input

Attributes

Returns

a Parser that always succeeds: either with the result provided by p or with the empty result

Inherited from:
Parsers
def parse[T](p: Parser[T], in: Reader): ParseResult[T]

Parse some prefix of reader in with parser p.

Parse some prefix of reader in with parser p.

Attributes

Inherited from:
RegexParsers
def parse[T](p: Parser[T], in: CharSequence): ParseResult[T]

Parse some prefix of character sequence in with parser p.

Parse some prefix of character sequence in with parser p.

Attributes

Inherited from:
RegexParsers
def parse[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

Parse some prefix of reader in with parser p.

Parse some prefix of reader in with parser p.

Attributes

Inherited from:
RegexParsers
def parseAll[T](p: Parser[T], in: CharSequence): ParseResult[T]

Parse all of character sequence in with parser p.

Parse all of character sequence in with parser p.

Attributes

Inherited from:
RegexParsers
def parseAll[T](p: Parser[T], in: Reader): ParseResult[T]

Parse all of reader in with parser p.

Parse all of reader in with parser p.

Attributes

Inherited from:
RegexParsers
def parseAll[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

Parse all of reader in with parser p.

Parse all of reader in with parser p.

Attributes

Inherited from:
RegexParsers
def parseMill(w: String): Try[CoreMill]

Parse the string w as a RPN expression. The elements of the input include numbers, and various operators.

Parse the string w as a RPN expression. The elements of the input include numbers, and various operators.

Value parameters

w

the String to parse.

Attributes

Returns

a Mill, wrapped in Try.

Inherited from:
BaseMillParser
def parseNumber(w: String): Try[Number]

Parse the string w as a Number. The string consists of two optional parts: the numerator and the factor. Either of these can be missing but not both.

Parse the string w as a Number. The string consists of two optional parts: the numerator and the factor. Either of these can be missing but not both.

Value parameters

w

the String to parse.

Attributes

Returns

a Number, wrapped in Try.

Inherited from:
BaseNumberParser
override def phrase[T](p: Parser[T]): Parser[T]

A parser generator delimiting whole phrases (i.e. programs).

A parser generator delimiting whole phrases (i.e. programs).

phrase(p) succeeds if p succeeds and no input is left over after p.

Value parameters

p

the parser that must consume all input for the resulting parser to succeed.

Attributes

Returns

a parser that has the same result as p, but that only succeeds if p consumed all the input.

Definition Classes
RegexParsers -> Parsers
Inherited from:
RegexParsers
override def positioned[T <: Positional](p: => Parser[T]): Parser[T]

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.

Value parameters

p

a Parser whose result conforms to Positional.

Attributes

Returns

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.

Definition Classes
RegexParsers -> Parsers
Inherited from:
RegexParsers
def ratioNumber: Parser[RatioNumber]

Attributes

Inherited from:
BaseRationalParser
def rationalNumber: Parser[ValuableNumber]

Attributes

Inherited from:
BaseRationalParser
def realNumber: Parser[RealNumber]

Attributes

Inherited from:
BaseRationalParser
def rep[T](p: => Parser[T]): Parser[List[T]]

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

Value parameters

p

a Parser that is to be applied successively to the input

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p to the input.

Inherited from:
Parsers
def rep1[T](first: => Parser[T], p0: => Parser[T]): Parser[List[T]]

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)

Value parameters

first

a Parser that parses the first piece of input

p0

a Parser that is to be applied successively to the rest of the input (if any) -- evaluated at most once, and only when necessary

Attributes

Returns

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

Inherited from:
Parsers
def rep1[T](p: => Parser[T]): Parser[List[T]]

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)

Value parameters

p

a Parser that is to be applied successively to the input

Attributes

Returns

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

Inherited from:
Parsers
def rep1sep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]

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.

Value parameters

p

a Parser that is to be applied successively to the input

q

a Parser that parses the elements that separate the elements parsed by p (interleaved with q)

Attributes

Returns

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.

Inherited from:
Parsers
def repN[T](num: Int, p: => Parser[T]): Parser[List[T]]

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

Value parameters

num

the exact number of times p must succeed

p

a Parser that is to be applied successively to the input

Attributes

Returns

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

Inherited from:
Parsers
def repNM[T](n: Int, m: Int, p: Parser[T], sep: Parser[Any] = ...): Parser[List[T]]

A parser generator for a specified range of repetitions interleaved by a separator.

A parser generator for a specified range of repetitions interleaved by a separator.

repNM(n, m, p, s) uses p at least n times and up to m times, interleaved with separator s, to parse the input (the result is a List of at least n consecutive results of p and up to m results).

Value parameters

m

maximum number of repetitions

n

minimum number of repetitions

p

a Parser that is to be applied successively to the input

sep

a Parser that interleaves with p

Attributes

Returns

A parser that returns a list of results produced by repeatedly applying p interleaved with sep to the input. The list has a size between n and up to m (and that only succeeds if p matches at least n times).

Inherited from:
Parsers
def repSepSp[T](p: Parser[T]): Parser[List[T]]

A parser which parses a list of Ts separated by white space.

A parser which parses a list of Ts separated by white space.

Type parameters

T

the underlying type of p.

Value parameters

p

a Parser[T].

Attributes

Returns

a Parser of List[T] that expects elements to be separated by white space.

Inherited from:
SignificantSpaceParsers
def repeatingDecimal: Parser[RepeatingDecimal]

Attributes

Inherited from:
BaseRationalParser
def repsep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]

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.

Value parameters

p

a Parser that is to be applied successively to the input

q

a Parser that parses the elements that separate the elements parsed by p

Attributes

Returns

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.

Inherited from:
Parsers
def simpleNumber: Parser[WholeNumber]

Attributes

Inherited from:
BaseRationalParser
override def skipWhitespace: Boolean

We do not ignore white space. It's significant.

We do not ignore white space. It's significant.

Attributes

Returns

false.

Definition Classes
SignificantSpaceParsers -> RegexParsers
Inherited from:
SignificantSpaceParsers
def stringLiteral: Parser[String]

Double quotes (") enclosing a sequence of:

Double quotes (") enclosing a sequence of:

  • Any character except double quotes, control characters or backslash (\)
  • A backslash followed by another backslash, a single or double quote, or one of the letters b, f, n, r or t
  • \ followed by u followed by four hexadecimal digits

Attributes

Inherited from:
JavaTokenParsers
def stringParser[X](p: Parser[X], w: String): Try[X]

Method to parse a given String (w) such that all of it is consumed, and return, if possible, a Success. If the parsing fails, a Failure will be returned.

Method to parse a given String (w) such that all of it is consumed, and return, if possible, a Success. If the parsing fails, a Failure will be returned.

Type parameters

X

the underlying type of the parser p and also of the result.

Value parameters

p

the parser to employ, of type Parser[X].

w

the String to parse.

Attributes

Returns

a Try[X].

Inherited from:
SignificantSpaceParsers
def success[T](v: T): Parser[T]

A parser that always succeeds.

A parser that always succeeds.

Value parameters

v

The result for the parser

Attributes

Returns

A parser that always succeeds, with the given result v

Inherited from:
Parsers
def tee[X](x: X)(f: X => Unit): X

Tee method. This method will return its input, however, a side-effect occurs which is to invoke f(x).

Tee method. This method will return its input, however, a side-effect occurs which is to invoke f(x).

Type parameters

X

the underlying type of x.

Value parameters

f

a function which takes an X and yields Unit.

x

an X value.

Attributes

Returns

x unchanged.

Inherited from:
SignificantSpaceParsers
def term: Parser[Term]

A term is either of the form: DyadicOp term term (net pop) or: MonadicOp term (not unchanged) or: AnadicOp (net push).

A term is either of the form: DyadicOp term term (net pop) or: MonadicOp term (not unchanged) or: AnadicOp (net push).

Attributes

Returns

a Parser[Term]

Inherited from:
BaseMillParser
def trim[T](p: Parser[T]): Parser[T]

A parser which allows for white space to follow what is matched by p.

A parser which allows for white space to follow what is matched by p.

Type parameters

T

the underlying type of p.

Value parameters

p

a Parser[T].

Attributes

Returns

a Parser[T] that ignores trailing white space.

Inherited from:
SignificantSpaceParsers
def unsignedWholeNumber: Parser[String]

An integer, without sign.

An integer, without sign.

Attributes

Inherited from:
BaseRationalParser
def vulgarFraction: Parser[VulgarFractionNumber]

Parser for vulgar (Unicode) fractions like ⅓, ½, ¼, etc. Matches any single Unicode character that represents a fraction.

Parser for vulgar (Unicode) fractions like ⅓, ½, ¼, etc. Matches any single Unicode character that represents a fraction.

Attributes

Inherited from:
BaseRationalParser
def wholeNumber: Parser[String]

An integer, without sign or with a negative sign.

An integer, without sign or with a negative sign.

Attributes

Inherited from:
JavaTokenParsers

Inherited fields

protected val whiteSpace: Regex

Attributes

Inherited from:
RegexParsers

Implicits

Inherited implicits

final implicit def ParserOps[X](p: Parser[X]): ParserOps[X]

Implicit class ParserOps which allows us to use the method :| on a Parser[X].

Implicit class ParserOps which allows us to use the method :| on a Parser[X].

Type parameters

X

the underlying type of p.

Value parameters

p

a Parser[X].

Attributes

Inherited from:
SignificantSpaceParsers
final implicit def ParserOptionOps[X](p: Parser[Option[X]]): ParserOptionOps[X]

Implicit class ParserOptionOps which allows us to use the method ?| on a Parser of Option[X].

Implicit class ParserOptionOps which allows us to use the method ?| on a Parser of Option[X].

Type parameters

X

the under-underlying type of p.

Value parameters

p

a Parser of Option[X].

Attributes

Inherited from:
SignificantSpaceParsers
final implicit def RegexOps(r: Regex): RegexOps

Implicit class RegexOps which allows us to use the method :| on a Regex.

Implicit class RegexOps which allows us to use the method :| on a Regex.

Value parameters

r

a Regex.

Attributes

Inherited from:
SignificantSpaceParsers
implicit def accept(e: Elem): Parser[Elem]

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

Value parameters

e

the Elem that must be the next piece of input for the returned parser to succeed

Attributes

Returns

a tParser that succeeds if e is the next available input.

Inherited from:
Parsers
implicit val enabled: Boolean

Attributes

Inherited from:
SignificantSpaceParsers
implicit def literal(s: String): Parser[String]

A parser that matches a literal string

A parser that matches a literal string

Attributes

Inherited from:
RegexParsers
implicit def regex(r: Regex): Parser[String]

A parser that matches a regex string

A parser that matches a regex string

Attributes

Inherited from:
RegexParsers
Generated with