Packages

  • package root

    This is the documentation for Parsley.

    This is the documentation for Parsley.

    Package structure

    The parsley package contains the Parsley class, as well as the Result, Success, and Failure types. In addition to these, it also contains the following packages and "modules" (a module is defined as being an object which mocks a package):

    • parsley.Parsley contains the bulk of the core "function-style" combinators.
    • parsley.combinator contains many helpful combinators that simplify some common parser patterns.
    • parsley.character contains the combinators needed to read characters and strings, as well as combinators to match specific sub-sets of characters.
    • parsley.debug contains debugging combinators, helpful for identifying faults in parsers.
    • parsley.extension contains syntactic sugar combinators exposed as implicit classes.
    • parsley.io contains extension methods to run parsers with input sourced from IO sources.
    • parsley.expr contains the following sub modules:
      • parsley.expr.chain contains combinators used in expression parsing
      • parsley.expr.precedence is a builder for expression parsers built on a precedence table.
      • parsley.expr.infix contains combinators used in expression parsing, but with more permissive types than their equivalents in chain.
      • parsley.expr.mixed contains combinators that can be used for expression parsing, but where different fixities may be mixed on the same level: this is rare in practice.
    • parsley.implicits contains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:
      • parsley.implicits.character contains implicits to allow you to use character and string literals as parsers.
      • parsley.implicits.combinator contains implicits related to combinators, such as the ability to make any parser into a Parsley[Unit] automatically.
      • parsley.implicits.lift enables postfix application of the lift combinator onto a function (or value).
      • parsley.implicits.zipped enables boths a reversed form of lift where the function appears on the right and is applied on a tuple (useful when type inference has failed) as well as a .zipped method for building tuples out of several combinators.
    • parsley.errors contains modules to deal with error messages, their refinement and generation.
    • parsley.lift contains functions which lift functions that work on regular types to those which now combine the results of parsers returning those same types. these are ubiquitous.
    • parsley.ap contains functions which allow for the application of a parser returning a function to several parsers returning each of the argument types.
    • parsley.registers contains combinators that interact with the context-sensitive functionality in the form of registers.
    • parsley.token contains the Lexer class that provides a host of helpful lexing combinators when provided with the description of a language.
    • parsley.position contains parsers for extracting position information.
    • parsley.genericbridges contains some basic implementations of the Parser Bridge pattern (see Design Patterns for Parser Combinators in Scala, or the parsley wiki): these can be used before more specialised generic bridge traits can be constructed.
    Definition Classes
    root
  • package parsley
    Definition Classes
    root
  • package token

    This package provides a wealth of functionality for performing common lexing tasks.

    This package provides a wealth of functionality for performing common lexing tasks.

    It is organised as follows:

    • the main parsing functionality is accessed via Lexer, which provides implementations for the combinators found in the sub-packages given a LexicalDesc.
    • the descriptions sub-package is how a lexical structure can be described, providing the configuration that alters the behaviour of the parsers produced by the Lexer.
    • the other sub-packages contain the high-level interfaces that the Lexer exposes, which can be used to pass whitespace-aware and non-whitespace-aware combinators around in a uniform way.
    • the predicate module contains functionality to help define boolean predicates on characters or unicode codepoints.
    Definition Classes
    parsley
  • package numeric

    This package contains the abstract parsers for parsing numeric literals, like integers and reals.

    This package contains the abstract parsers for parsing numeric literals, like integers and reals.

    Definition Classes
    token
    Since

    4.0.0

  • CanHold
  • Combined
  • Integer
  • LowPriorityImplicits
  • Real

abstract class Integer extends AnyRef

This class defines a uniform interface for defining parsers for integer literals, independent of how whitespace should be handled after the literal or whether the literal should allow for negative numbers.

Source
Integer.scala
Since

4.0.0

Note

implementations of this class found within Lexer may employ sharing and refine the non-final defs in this class into val or lazy val when overriding.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Integer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def binary: Parsley[BigInt]

    This parser will parse a single integer literal, which is in binary form (base 2).

    This parser will parse a single integer literal, which is in binary form (base 2).

    Example:

    1. // using signed integers and standard numeric prefixes
scala> binary.parse("0b1011")
val res0 = Success(BigInt(11))
scala> binary.parse("10")
val res2 = Failure(..) // no binary prefix
scala> binary.parse("0b22")
val res3 = Failure(..) // no other digits
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  2. abstract def bounded[T](number: Parsley[BigInt], bits: Bits, radix: Int, label: (ErrorConfig, Boolean) => LabelWithExplainConfig)(implicit ev: CanHold[self, T]): Parsley[T]
    Attributes
    protected[numeric]
  3. abstract def decimal: Parsley[BigInt]

    This parser will parse a single integer literal, which is in decimal form (base 10).

    This parser will parse a single integer literal, which is in decimal form (base 10).

    Example:

    1. // using signed integers and standard numeric prefixes
scala> decimal.parse("103")
val res0 = Success(BigInt(103))
scala> decimal.parse("9999999999999999999999999999999999")
val res1 = Success(BigInt(9999999999999999999999999999999999))
scala> decimal.parse("1f")
val res2 = Failure(..) // no hexadecimal digits supported
scala> decimal.parse("0xff")
val res3 = Failure(..) // no hexadecimal literals either
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  4. abstract def hexadecimal: Parsley[BigInt]

    This parser will parse a single integer literal, which is in hexadecimal form (base 16).

    This parser will parse a single integer literal, which is in hexadecimal form (base 16).

    Example:

    1. // using signed integers and standard numeric prefixes
scala> hexadecimal.parse("0x103")
val res0 = Success(BigInt(259))
scala> hexadecimal.parse("0x9999999999999999999999999999999999")
val res1 = Success(BigInt(0x9999999999999999999999999999999999))
scala> hexadecimal.parse("1f")
val res2 = Failure(..) // no hexadecimal prefix
scala> hexadecimal.parse("0xff")
val res3 = Success(BigInt(0xff))
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  5. abstract def number: Parsley[BigInt]

    This parser will parse a single integer literal, which can be in many forms and bases depending on the configuration.

    This parser will parse a single integer literal, which can be in many forms and bases depending on the configuration.

    Example:

    1. // using signed integers and standard numeric prefixes (and octal, binary, and decimal on)
scala> number.parse("0b1011")
val res0 = Success(BigInt(11))
scala> number.parse("0o103")
val res1 = Success(BigInt(43))
scala> number.parse("10")
val res2 = Success(10)
scala> number.parse("0xff")
val res1 = Failure(..) // configuration specified above does not support hex
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  6. abstract def octal: Parsley[BigInt]

    This parser will parse a single integer literal, which is in octal form (base 8).

    This parser will parse a single integer literal, which is in octal form (base 8).

    Example:

    1. // using signed integers and standard numeric prefixes
scala> octal.parse("0o103")
val res0 = Success(BigInt(43))
scala> octal.parse("1f")
val res2 = Failure(..) // no hexadecimal digits supported
scala> octal.parse("0xff")
val res3 = Failure(..) // no hexadecimal literals either
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def _binary: Parsley[BigInt]
    Attributes
    protected[numeric]
  5. def _decimal: Parsley[BigInt]
    Attributes
    protected[numeric]
  6. def _hexadecimal: Parsley[BigInt]
    Attributes
    protected[numeric]
  7. def _number: Parsley[BigInt]
    Attributes
    protected[numeric]
  8. def _octal: Parsley[BigInt]
    Attributes
    protected[numeric]
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. final def binary16[T](implicit arg0: can_hold_16_bits[T]): Parsley[T]

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 16-bit number.

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 16-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Short

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  11. final def binary32[T](implicit arg0: can_hold_32_bits[T]): Parsley[T]

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 32-bit number.

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 32-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Int

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  12. final def binary64[T](implicit arg0: can_hold_64_bits[T]): Parsley[T]

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 64-bit number.

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 64-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Long

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  13. final def binary8[T](implicit arg0: can_hold_8_bits[T]): Parsley[T]

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 8-bit number.

    This parser will behave the same as binary except it will ensure that the resulting BigInt is a valid 8-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Byte

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  15. final def decimal16[T](implicit arg0: can_hold_16_bits[T]): Parsley[T]

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 16-bit number.

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 16-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Short

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  16. final def decimal32[T](implicit arg0: can_hold_32_bits[T]): Parsley[T]

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 32-bit number.

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 32-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Int

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  17. final def decimal64[T](implicit arg0: can_hold_64_bits[T]): Parsley[T]

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 64-bit number.

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 64-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Long

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  18. final def decimal8[T](implicit arg0: can_hold_8_bits[T]): Parsley[T]

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 8-bit number.

    This parser will behave the same as decimal except it will ensure that the resulting BigInt is a valid 8-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Byte

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def hexadecimal16[T](implicit arg0: can_hold_16_bits[T]): Parsley[T]

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 16-bit number.

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 16-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Short

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  25. final def hexadecimal32[T](implicit arg0: can_hold_32_bits[T]): Parsley[T]

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 32-bit number.

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 32-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Int

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  26. final def hexadecimal64[T](implicit arg0: can_hold_64_bits[T]): Parsley[T]

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 64-bit number.

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 64-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Long

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  27. final def hexadecimal8[T](implicit arg0: can_hold_8_bits[T]): Parsley[T]

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 8-bit number.

    This parser will behave the same as hexadecimal except it will ensure that the resulting BigInt is a valid 8-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Byte

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def number16[T](implicit arg0: can_hold_16_bits[T]): Parsley[T]

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 16-bit number.

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 16-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Short

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  33. final def number32[T](implicit arg0: can_hold_32_bits[T]): Parsley[T]

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 32-bit number.

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 32-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Int

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  34. final def number64[T](implicit arg0: can_hold_64_bits[T]): Parsley[T]

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 64-bit number.

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 64-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Long

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  35. final def number8[T](implicit arg0: can_hold_8_bits[T]): Parsley[T]

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 8-bit number.

    This parser will behave the same as number except it will ensure that the resulting BigInt is a valid 8-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Byte

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  36. final def octal16[T](implicit arg0: can_hold_16_bits[T]): Parsley[T]

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 16-bit number.

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 16-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Short

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  37. final def octal32[T](implicit arg0: can_hold_32_bits[T]): Parsley[T]

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 32-bit number.

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 32-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Int

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  38. final def octal64[T](implicit arg0: can_hold_64_bits[T]): Parsley[T]

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 64-bit number.

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 64-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Long

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  39. final def octal8[T](implicit arg0: can_hold_8_bits[T]): Parsley[T]

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 8-bit number.

    This parser will behave the same as octal except it will ensure that the resulting BigInt is a valid 8-bit number. The resulting number will be converted to the given type T, which must be able to losslessly store the parsed value; this is enforced by the constraint on the type. This accounts for unsignedness when necessary.

    T

    the desired type of the result, defaulting to Byte

    Annotations
    @inline()
    Since

    4.0.0

    Note

    the exact behaviour of this parser is decided by the implementations given in Lexer, which will depend on user-defined configuration. Please see the relevant documentation of these specific objects.

  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped