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, as well as the implicit classes which enable the "method-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.io contains extension methods to run parsers with input sourced from IO sources.
    • parsley.expr contains the following sub modules:
    • 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.errors.combinator provides combinators that can be used to either produce more detailed errors as well as refine existing errors.
    • 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.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.unsafe contains unsafe (and not thread-safe) ways of speeding up the execution of a parser.
    Definition Classes
    root
  • package parsley
    Definition Classes
    root
  • package errors
    Definition Classes
    parsley
  • package expr
    Definition Classes
    parsley
  • package implicits
    Definition Classes
    parsley
  • package token
    Definition Classes
    parsley
  • Failure
  • Parsley
  • Result
  • Success
  • character
  • combinator
  • debug
  • io
  • lift
  • registers
  • unsafe
o

parsley

combinator

object combinator

This module contains a huge number of pre-made combinators that are very useful for a variety of purposes.

Since

2.2.0

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

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def attemptChoice[A](ps: Parsley[A]*): Parsley[A]

    attemptChoice(ps) tries to apply the parsers in the list ps in order, until one of them succeeds.

    attemptChoice(ps) tries to apply the parsers in the list ps in order, until one of them succeeds. Returns the value of the succeeding parser. Utilises attempt p <|> q vs choice's p <|> q.

  6. def between[A](open: => Parsley[_], close: => Parsley[_], p: => Parsley[A]): Parsley[A]

    between(open, close, p) parses open, followed by p and close.

    between(open, close, p) parses open, followed by p and close. Returns the value returned by p.

  7. def choice[A](ps: Parsley[A]*): Parsley[A]

    choice(ps) tries to apply the parsers in the list ps in order, until one of them succeeds.

    choice(ps) tries to apply the parsers in the list ps in order, until one of them succeeds. Returns the value of the succeeding parser.

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def decide[A](p: => Parsley[Option[A]], q: => Parsley[A]): Parsley[A]

    decide(p, q) removes the option from inside parser p, if it returned None then q is executed.

  10. def decide[A](p: => Parsley[Option[A]]): Parsley[A]

    decide(p) removes the option from inside parser p, and if it returned None will fail.

  11. def endBy[A, B](p: => Parsley[A], sep: => Parsley[B]): Parsley[List[A]]

    endBy(p, sep) parses *zero* or more occurrences of p, separated and ended by sep.

    endBy(p, sep) parses *zero* or more occurrences of p, separated and ended by sep. Returns a list of values returned by p.

  12. def endBy1[A, B](p: => Parsley[A], sep: => Parsley[B]): Parsley[List[A]]

    endBy1(p, sep) parses *one* or more occurrences of p, separated and ended by sep.

    endBy1(p, sep) parses *one* or more occurrences of p, separated and ended by sep. Returns a list of values returned by p.

  13. val eof: Parsley[Unit]

    This parser only succeeds at the end of the input.

    This parser only succeeds at the end of the input. This is a primitive parser.

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def many[A](p: => Parsley[A]): Parsley[List[A]]

    many(p) executes the parser p zero or more times.

    many(p) executes the parser p zero or more times. Returns a list of the returned values of p.

    Since

    2.2.0

  21. def manyN[A](n: Int, p: => Parsley[A]): Parsley[List[A]]

    manyN(n, p) applies the parser p *n* or more times.

    manyN(n, p) applies the parser p *n* or more times. Returns a list of the returned values of p.

  22. def manyUntil[A, B](p: => Parsley[A], end: => Parsley[B]): Parsley[List[A]]

    manyUntil(p, end) applies parser p zero or more times until the parser end succeeds.

    manyUntil(p, end) applies parser p zero or more times until the parser end succeeds. Returns a list of values returned by p. This parser can be used to scan comments.

  23. val more: Parsley[Unit]

    This parser only succeeds if there is still more input.

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def option[A](p: => Parsley[A]): Parsley[Option[A]]

    option(p) tries to apply parser p.

    option(p) tries to apply parser p. If p fails without consuming input, it returns None, otherwise it returns Some of the value returned by p.

  28. def optional(p: => Parsley[_]): Parsley[Unit]

    optional(p) tries to apply parser p.

    optional(p) tries to apply parser p. It will parse p or nothing. It only fails if p fails after consuming input. It discards the result of p.

  29. def optionally[A](p: => Parsley[_], x: => A): Parsley[A]

    optionally(p, x) tries to apply parser p.

    optionally(p, x) tries to apply parser p. It will always result in x regardless of whether or not p succeeded or p failed without consuming input.

  30. def repeat[A](n: Int, p: => Parsley[A]): Parsley[List[A]]

    repeat(n, p) parses n occurrences of p.

    repeat(n, p) parses n occurrences of p. If n is smaller or equal to zero, the parser is pure(Nil). Returns a list of n values returned by p.

  31. def sepBy[A, B](p: => Parsley[A], sep: => Parsley[B]): Parsley[List[A]]

    sepBy(p, sep) parses *zero* or more occurrences of p, separated by sep.

    sepBy(p, sep) parses *zero* or more occurrences of p, separated by sep. Returns a list of values returned by p.

  32. def sepBy1[A, B](p: => Parsley[A], sep: => Parsley[B]): Parsley[List[A]]

    sepBy1(p, sep) parses *one* or more occurrences of p, separated by sep.

    sepBy1(p, sep) parses *one* or more occurrences of p, separated by sep. Returns a list of values returned by p.

  33. def sepEndBy[A, B](p: => Parsley[A], sep: => Parsley[B]): Parsley[List[A]]

    sepEndBy(p, sep) parses *zero* or more occurrences of p, separated and optionally ended by sep.

    sepEndBy(p, sep) parses *zero* or more occurrences of p, separated and optionally ended by sep. Returns a list of values returned by p.

  34. def sepEndBy1[A, B](p: => Parsley[A], sep: => Parsley[B]): Parsley[List[A]]

    sepEndBy1(p, sep) parses *one* or more occurrences of p, separated and optionally ended by sep.

    sepEndBy1(p, sep) parses *one* or more occurrences of p, separated and optionally ended by sep. Returns a list of values returned by p.

  35. def skipMany[A](p: => Parsley[A]): Parsley[Unit]

    skipMany(p) executes the parser p zero or more times and ignores the results.

    skipMany(p) executes the parser p zero or more times and ignores the results. Returns ()

    Since

    2.2.0

  36. def skipManyN[A](n: Int, p: => Parsley[A]): Parsley[Unit]

    skipManyN(n, p) applies the parser p *n* or more times, skipping its result.

  37. def skipSome[A](p: => Parsley[A]): Parsley[Unit]

    skipSome(p) applies the parser p *one* or more times, skipping its result.

  38. def some[A](p: => Parsley[A]): Parsley[List[A]]

    some(p) applies the parser p *one* or more times.

    some(p) applies the parser p *one* or more times. Returns a list of the returned values of p.

  39. def someUntil[A, B](p: => Parsley[A], end: => Parsley[B]): Parsley[List[A]]

    someUntil(p, end) applies parser p one or more times until the parser end succeeds.

    someUntil(p, end) applies parser p one or more times until the parser end succeeds. Returns a list of values returned by p.

  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()
  45. def when(p: => Parsley[Boolean], q: => Parsley[Unit]): Parsley[Unit]

    when(p, q) will first perform p, and if the result is true will then execute q or else return unit.

    when(p, q) will first perform p, and if the result is true will then execute q or else return unit.

    p

    The first parser to parse

    q

    If p returns true then this parser is executed

    returns

    ()

  46. def whileP(p: => Parsley[Boolean]): Parsley[Unit]

    whileP(p) will continue to run p until it returns false.

    whileP(p) will continue to run p until it returns false. This is often useful in conjunction with stateful parsers.

    p

    The parser to continuously execute

    returns

    ()

Inherited from AnyRef

Inherited from Any

Ungrouped