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.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.syntax contains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:
    • parsley.syntax.character contains implicits to allow you to use character and string literals as parsers.
    • parsley.syntax.lift enables postfix application of the lift combinator onto a function (or value).
    • parsley.syntax.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.syntax.extension contains syntactic sugar combinators exposed as implicit classes.
  • 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.errors.tokenextractors provides mixins for common token extraction strategies during error message generation: these can be used to avoid implementing unexpectedToken in the ErrorBuilder.
  • 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.generic 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 errors

  This package contains various functionality relating to the generation and formatting of error messages.

  This package contains various functionality relating to the generation and formatting of error messages.

  In particular, it includes a collection of combinators for improving error messages within the parser, including labelling and providing additional information. It also contains combinators that can be used to valid data produced by a parser, to ensure it conforms to expected invariances, producing good quality error messages if this is not the case. Finally, this package contains ways of changing the formatting of error messages: this can either be changing how the default String-based errors are formatted, or by injectiing Parsley's errors into a custom error object.

  Definition Classes

  parsley

•  package tokenextractors

  This package contains implementations of token extractors that can be mixed into ErrorBuilder to decide how to extract unexpected tokens from the residual input left over from a parse error.

  This package contains implementations of token extractors that can be mixed into ErrorBuilder to decide how to extract unexpected tokens from the residual input left over from a parse error.

  These are common strategies, and something here is likely to be what is needed. They are all careful to handle unprintable characters and whitespace in a sensible way, and account for unicode codepoints that are wider than a single 16-bit character.

  Definition Classes

  errors

  Since

  4.0.0

• DefaultErrorBuilder
• ErrorBuilder
• ErrorGen
• SpecialisedGen
• Token
• TokenSpan
• VanillaGen
• combinator
• patterns

parsley.errors

VanillaGen

Companion object VanillaGen