scala.util.parsing.combinator.PackratParsers

PackratParser

class PackratParser [+T] extends Parser[T]

The root class of packrat parsers.

attributes: abstract
linear super types: Parser[T], (Input) ⇒ ParseResult[T], AnyRef, Any
source: PackratParsers.scala
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. PackratParser
  2. Parser
  3. Function1
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new PackratParser ()

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def * [U >: T] (sep: ⇒ Parser[(U, U) ⇒ U]) : Parser[U]

    Returns a parser that repeatedly parses what this parser parses, interleaved with the sep' parser. The sep' parser specifies how the results parsed by this parser should be combined.

    Returns a parser that repeatedly parses what this parser parses, interleaved with the sep' parser. The sep' parser specifies how the results parsed by this parser should be combined.

    returns

    chainl1(this, sep)

    definition classes: Parser
  7. def * : Parser[List[T]]

    Returns a parser that repeatedly parses what this parser parses

    Returns a parser that repeatedly parses what this parser parses

    returns

    rep(this)

    definition classes: Parser
  8. def + : Parser[List[T]]

    Returns a parser that repeatedly (at least once) parses what this parser parses.

    Returns a parser that repeatedly (at least once) parses what this parser parses.

    returns

    rep1(this)

    definition classes: Parser
  9. def <~ [U] (p: ⇒ Parser[U]) : Parser[T]

    A parser combinator for sequential composition which keeps only the left result

    A parser combinator for sequential composition which keeps only the left result

    p &lt;~ q' succeeds if p' succeeds and q' succeeds on the input left over by p'.

    Note: &lt;~ has lower operator precedence than ~ or ~>.

    returns

    a Parser' that -- on success -- returns the result of p'.

    definition classes: Parser
  10. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  11. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  12. def >> [U] (fq: (T) ⇒ Parser[U]) : Parser[U]

    Returns into(fq)

    Returns into(fq)

    definition classes: Parser
  13. def ? : Parser[Option[T]]

    Returns a parser that optionally parses what this parser parses.

    Returns a parser that optionally parses what this parser parses.

    returns

    opt(this)

    definition classes: Parser
  14. def ^? [U] (f: PartialFunction[T, U]) : Parser[U]

    A parser combinator for partial function application

    A parser combinator for partial function application

    p ^? 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 (see mapPartial' in ParseResult').

    returns

    a parser that succeeds if the current parser succeeds and f' is applicable to the result. If so, the result will be transformed by f'.

    definition classes: Parser
  15. def ^? [U] (f: PartialFunction[T, U], error: (T) ⇒ String) : Parser[U]

    A parser combinator for partial function application

    A parser combinator for partial function application

    p ^? (f, error)' 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'. If f' is not applicable, error(the result of p') should explain why.

    f

    a partial function that will be applied to this parser's result (see mapPartial' in ParseResult').

    error

    a function that takes the same argument as f' and produces an error message to explain why f' wasn't applicable

    returns

    a parser that succeeds if the current parser succeeds and f' is applicable to the result. If so, the result will be transformed by f'.

    definition classes: Parser
  16. def ^^ [U] (f: (T) ⇒ U) : Parser[U]

    A parser combinator for function application

    A parser combinator for function application

    p ^^ f' succeeds if p' succeeds; it returns f' applied to the result of p'.

    f

    a function that will be applied to this parser's result (see map' in ParseResult').

    returns

    a parser that has the same behaviour as the current parser, but whose result is transformed by f'.

    definition classes: Parser
  17. def ^^^ [U] (r: U) : Parser[U]

    definition classes: Parser
  18. def andThen [A] (g: (ParseResult[T]) ⇒ A) : (Input) ⇒ A

    (f andThen g)(x) == g(f(x))

    (f andThen g)(x) == g(f(x))

    definition classes: Function1
  19. def append [U >: T] (p: ⇒ Parser[U]) : Parser[U]

    definition classes: Parser
  20. def apply (in: Input) : ParseResult[T]

    An unspecified method that defines the behaviour of this parser.

    An unspecified method that defines the behaviour of this parser.

    attributes: abstract
    definition classes: ParserFunction1
  21. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  22. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected[lang]
    definition classes: AnyRef
  23. def compose [A] (g: (A) ⇒ Input) : (A) ⇒ ParseResult[T]

    (f compose g)(x) == f(g(x))

    (f compose g)(x) == f(g(x))

    definition classes: Function1
  24. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  25. def equals (arg0: Any) : Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef → Any
  26. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected[lang]
    definition classes: AnyRef
  27. def flatMap [U] (f: (T) ⇒ Parser[U]) : Parser[U]

    definition classes: Parser
  28. def getClass () : java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  29. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: AnyRef → Any
  30. def into [U] (fq: (T) ⇒ Parser[U]) : Parser[U]

    A parser combinator that parameterizes a subsequent parser with the result of this one

    A parser combinator that parameterizes a subsequent parser with the result of this one

    Use this combinator when a parser depends on the result of a previous parser. p' should be a function that takes the result from the first parser and returns the second parser. p into fq' (with fq' typically {x => q}') first applies p', and then, if p' successfully returned result r', applies fq(r)' to the rest of the input.

    From: G. Hutton. Higher-order functions for parsing. J. Funct. Program., 2(3):323--343, 1992.

    fq

    a function that, given the result from this parser, returns the second parser to be applied

    returns

    a parser that succeeds if this parser succeeds (with result x') and if then fq(x)' succeeds

    definition classes: Parser
  31. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  32. def map [U] (f: (T) ⇒ U) : Parser[U]

    definition classes: Parser
  33. def named (n: String) : PackratParser.this.type

    definition classes: Parser
  34. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  35. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  36. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  37. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  38. def toString () : String

    Returns a string representation of the object.

    Returns a string representation of the object.

    The default representation is platform dependent.

    returns

    a string representation of the object.

    definition classes: ParserFunction1 → AnyRef → Any
  39. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  40. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  41. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  42. def | [U >: T] (q: ⇒ Parser[U]) : Parser[U]

    A parser combinator for alternative composition

    A parser combinator for alternative composition

    p | q' succeeds if p' succeeds or q' succeeds Note that q' is only tried if p's failure is non-fatal (i.e., back-tracking is allowed).

    q

    a parser that will be executed if p' (this parser) fails (and allows back-tracking)

    returns

    a Parser' that returns the result of the first parser to succeed (out of p' and q') The resulting parser succeeds if (and only if) - p' succeeds, or

    • if p' fails allowing back-tracking and q' succeeds.
    definition classes: Parser
  43. def ||| [U >: T] (q: ⇒ Parser[U]) : Parser[U]

    A parser combinator for alternative with longest match composition

    A parser combinator for alternative with longest match composition

    p ||| q' succeeds if p' succeeds or q' succeeds If p' and q' both succeed, the parser that consumed the most characters accepts.

    q

    a parser that accepts if p consumes less characters.

    returns

    a Parser' that returns the result of the parser consuming the most characters (out of p' and q').

    definition classes: Parser
  44. def ~ [U] (p: ⇒ Parser[U]) : Parser[~[T, U]]

    A parser combinator for sequential composition

    A parser combinator for sequential composition

    p ~ q' succeeds if p' succeeds and q' succeeds on the input left over by p'.

    returns

    a Parser' that -- on success -- returns a ~' (like a Pair, but easier to pattern match on) that contains the result of p' and that of q'. The resulting parser fails if either p' or q' fails.

    definition classes: Parser
  45. def ~! [U] (p: ⇒ Parser[U]) : Parser[~[T, U]]

    A parser combinator for non-back-tracking sequential composition

    A parser combinator for non-back-tracking sequential composition

    p ~! q' succeeds if p' succeeds and q' succeeds on the input left over by p'. In case of failure, no back-tracking is performed (in an earlier parser produced by the | combinator).

    returns

    a Parser' that -- on success -- returns a ~' (like a Pair, but easier to pattern match on) that contains the result of p' and that of q'. The resulting parser fails if either p' or q' fails, this failure is fatal.

    definition classes: Parser
  46. def ~> [U] (p: ⇒ Parser[U]) : Parser[U]

    A parser combinator for sequential composition which keeps only the right result

    A parser combinator for sequential composition which keeps only the right result

    p ~> q' succeeds if p' succeeds and q' succeeds on the input left over by p'.

    returns

    a Parser' that -- on success -- returns the result of q'.

    definition classes: Parser

Inherited from Parser[T]

Inherited from (Input) ⇒ ParseResult[T]

Inherited from AnyRef

Inherited from Any