Number - Scala Mathematical Library
1.10.6
API
Generated with
Number - Scala Mathematical Library/com.phasmidsoftware.number/com.phasmidsoftware.number.expression/com.phasmidsoftware.number.expression.parse/IntArithmeticParser

IntArithmeticParser

com.phasmidsoftware.number.expression.parse.IntArithmeticParser
object IntArithmeticParser extends ArithmeticParserNumeric[Int]

Attributes

Graph
Supertypes
class ArithmeticParser[Int]
trait String => Try[Int]
trait JavaTokenParsers
trait RegexParsers
trait Parsers
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited classlikes

case class BadFactor(x: ArithmeticParser.this.Expression) extends Factor

Represents a "bad factor" in an expression.

Represents a "bad factor" in an expression.

This class is used to indicate an invalid or erroneous factor within an expression. A "bad factor" effectively serves as a placeholder for scenarios where parsing or constructing a valid factor is not possible. It extends the Factor class, providing specific behavior for error handling and formatted display of the associated expression.

Value parameters

x

the associated expression that led to the creation of this "bad factor".

Attributes

Inherited from:
ArithmeticParser
Supertypes
trait Serializable
trait Product
trait Equals
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 Expr(t: ArithmeticParser.this.Term, ts: List[String ArithmeticParser.this.~ ArithmeticParser.this.Term]) extends Expression

Represents an expression consisting of a single term and a sequence of additional terms combined with operators, allowing for binary operations such as addition or subtraction.

Represents an expression consisting of a single term and a sequence of additional terms combined with operators, allowing for binary operations such as addition or subtraction.

Value parameters

t

the initial Term of the expression

ts

a list of pairs consisting of an operator and a subsequent Term

Attributes

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

Represents an abstract mathematical or logical expression.

Represents an abstract mathematical or logical expression.

The Expression trait provides a contract for evaluating and displaying expressions. It is designed to handle expressions that return a result of type T wrapped in a Try, allowing for both successful evaluations and error reporting.

Attributes

Inherited from:
ArithmeticParser
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ArithmeticParser.this.Expr
class ArithmeticParser.this.Term
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 FloatingPoint(x: String) extends Factor

The FloatingPoint case class extends the Factor abstraction and represents a factor that holds a floating-point value in string representation.

The FloatingPoint case class extends the Factor abstraction and represents a factor that holds a floating-point value in string representation.

Value parameters

x

the string value representing a floating-point number to be parsed and utilized.

Attributes

Inherited from:
ArithmeticParser
Supertypes
trait Serializable
trait Product
trait Equals
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
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
case class Parentheses(e: ArithmeticParser.this.Expr) extends Factor

Encapsulates an expression within parentheses. This class is used to enforce precedence in mathematical or logical expressions by ensuring that the enclosed expression is evaluated as a single unit.

Encapsulates an expression within parentheses. This class is used to enforce precedence in mathematical or logical expressions by ensuring that the enclosed expression is evaluated as a single unit.

The Parentheses class extends Factor and wraps an Expr instance, delegating evaluation and rendering tasks to the underlying expression.

Value parameters

e

the expression encapsulated within the parentheses

Attributes

Inherited from:
ArithmeticParser
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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
case class Term(f: ArithmeticParser.this.Factor, fs: List[String ArithmeticParser.this.~ ArithmeticParser.this.Factor]) extends Expression

Represents a Term as part of an expression, consisting of a leading Factor followed by a list of pairs containing an operator (String) and a subsequent Factor.

Represents a Term as part of an expression, consisting of a leading Factor followed by a list of pairs containing an operator (String) and a subsequent Factor.

Value parameters

f

The leading Factor in the term.

fs

A list of operator-factor pairs, where each pair contains a string operator and a Factor.

Attributes

Constructor

Creates a Term with a leading Factor and a sequence of operator-factor pairs.

Inherited from:
ArithmeticParser
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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

abstract class Factor extends Expression

Represents a factor in an expression.

Represents a factor in an expression.

The Factor class is an abstraction used to build the components of mathematical or logical expressions. It serves as a fundamental unit which can be combined with other components to form more complex expressions.

This class extends the Expression trait, inheriting capabilities for evaluation and display. Instances of Factor must provide concrete implementations for the abstract methods defined in Expression.

Attributes

Inherited from:
ArithmeticParser
Supertypes
class Object
trait Matchable
class Any
Known subtypes
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

Value members

Concrete methods

def apply(s: String): Try[Int]

Applies the provided string to the parser and attempts to parse it into a result of type T.

Applies the provided string to the parser and attempts to parse it into a result of type T.

Value parameters

s

the input string to be parsed

Attributes

Returns

a Try[T] containing the parsed result if successful, or a failure if parsing fails

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 andThen[A](g: Try[Int] => A): String => A

Composes two instances of Function1 in a new Function1, with this function applied first.

Composes two instances of Function1 in a new Function1, with this function applied first.

Type parameters

A

the result type of function g

Value parameters

g

a function R => A

Attributes

Returns

a new function f such that f(x) == g(apply(x))

Inherited from:
Function1
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
def compose[A](g: A => String): A => Try[Int]

Composes two instances of Function1 in a new Function1, with this function applied last.

Composes two instances of Function1 in a new Function1, with this function applied last.

Type parameters

A

the type to which function g can be applied

Value parameters

g

a function A => T1

Attributes

Returns

a new function f such that f(x) == apply(g(x))

Inherited from:
Function1
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 div: (Int, Int) => Int

Method representing the division operation. This method is a higher-order function that accepts two parameters of type T and returns a result of type T. It encapsulates the logic for dividing one value of type T by another.

Method representing the division operation. This method is a higher-order function that accepts two parameters of type T and returns a result of type T. It encapsulates the logic for dividing one value of type T by another.

Attributes

Returns

a function of type (T, T) => T which performs division on two inputs of type T and produces a result of type T.

Inherited from:
ArithmeticParserNumeric
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 expr: Parser[Expr]

Parses an arithmetic expression composed of terms and allows for binary operations, such as addition (+) and subtraction (-), to produce an Expr structure.

Parses an arithmetic expression composed of terms and allows for binary operations, such as addition (+) and subtraction (-), to produce an Expr structure.

This parser combines a single term with a sequence of terms prefixed by operators. The resulting expression can then be evaluated or further processed as needed.

Attributes

Returns

a Parser[Expr] that processes input into an Expr representation, encapsulating the parsed terms and their associated operators.

Inherited from:
ArithmeticParser
def factor: Parser[Factor]

Parses a factor in an expression. A factor can be a number, a parenthesized expression, or a failure indicating that no valid factor was present.

Parses a factor in an expression. A factor can be a number, a parenthesized expression, or a failure indicating that no valid factor was present.

Attributes

Returns

a Parser[Factor] that attempts to parse and construct a valid Factor.

Inherited from:
ArithmeticParser
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 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 lift(t: Try[Int])(f: Int => Int): Try[Int]

Transforms the value inside the provided Try[T] instance using the given function.

Transforms the value inside the provided Try[T] instance using the given function.

Value parameters

f

a function that takes a value of type T and returns a transformed value of type T

t

a Try[T] containing either a successful value of type T or a failure

Attributes

Returns

a Try[T] containing the transformed value if t is successful, or the original failure if t is a failure

Inherited from:
ArithmeticParser
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 map2(t1: Try[Int], t2: Try[Int])(f: (Int, Int) => Int): Try[Int]

Combines the results of two Try instances using a provided binary function. If both Try instances are successful, their values are passed to the function, and the result is wrapped in a Success. If either Try is a Failure, the resulting Try will also be a Failure.

Combines the results of two Try instances using a provided binary function. If both Try instances are successful, their values are passed to the function, and the result is wrapped in a Success. If either Try is a Failure, the resulting Try will also be a Failure.

Value parameters

f

a binary function that takes the successful values of t1 and t2 and returns a new value

t1

the first Try instance

t2

the second Try instance

Attributes

Returns

a Try containing the result of applying f to the values of t1 and t2 if both are successful, or a Failure if either t1 or t2 is a Failure

Inherited from:
ArithmeticParser
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 negate: Int => Int

Represents a unary operation that negates a given value.

Represents a unary operation that negates a given value.

Attributes

Returns

a function that takes a value of type T and returns its negation.

Inherited from:
ArithmeticParserNumeric
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[Factor]

Parses a floating-point number string and converts it to a FloatingPoint object.

Parses a floating-point number string and converts it to a FloatingPoint object.

Attributes

Returns

a Parser that processes a floating-point number and returns a Factor in the form of a FloatingPoint instance.

Inherited from:
ArithmeticParser
def one: Int

Retrieves an instance of type T.

Retrieves an instance of type T.

Attributes

Returns

an instance of type T

Inherited from:
ArithmeticParserNumeric
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 parentheses: Parser[Parentheses]

Parses an expression enclosed in parentheses. Ensures that the inner expression is evaluated as a single unit by encapsulating it within a Parentheses instance.

Parses an expression enclosed in parentheses. Ensures that the inner expression is evaluated as a single unit by encapsulating it within a Parentheses instance.

The parser expects an opening parenthesis (, followed by an expression, and concludes with a closing parenthesis ).

Attributes

Returns

a parser that produces a Parentheses instance wrapping the parsed expression.

Inherited from:
ArithmeticParser
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
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
def plus: (Int, Int) => Int

Combines two values of the same type and produces a new value of the same type using the defined operation.

Combines two values of the same type and produces a new value of the same type using the defined operation.

Attributes

Returns

A function that takes two arguments of type T and returns a result of type T.

Inherited from:
ArithmeticParserNumeric
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 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 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 skipWhitespace: Boolean

Attributes

Inherited from:
RegexParsers
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 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 term: Parser[Term]

Parses a term, which consists of a factor followed by zero or more occurrences of either multiplication or division operations, each followed by another factor.

Parses a term, which consists of a factor followed by zero or more occurrences of either multiplication or division operations, each followed by another factor.

Attributes

Returns

a Parser[Term] that parses a term and constructs a Term instance combining the initial factor and a list of operator-factor pairs.

Inherited from:
ArithmeticParser
def times: (Int, Int) => Int

A function representing the multiplication operation.

A function representing the multiplication operation.

Attributes

Returns

a binary function that takes two arguments of type T and returns their product of type T.

Inherited from:
ArithmeticParserNumeric
override def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Function1 -> Any
Inherited from:
Function1
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
def zero: Int

Returns the zero value for the type T. The zero value is typically defined as the additive identity in a mathematical context.

Returns the zero value for the type T. The zero value is typically defined as the additive identity in a mathematical context.

Attributes

Returns

The zero value of type T.

Inherited from:
ArithmeticParserNumeric

Inherited fields

val num: Numeric[Int]

Attributes

Inherited from:
ArithmeticParserNumeric
protected val whiteSpace: Regex

Attributes

Inherited from:
RegexParsers

Implicits

Inherited implicits

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