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.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.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.
This is the documentation for Parsley.
Package structure
The parsley package contains the
Parsleyclass, as well as theResult,Success, andFailuretypes. 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.Parsleycontains the bulk of the core "function-style" combinators.parsley.combinatorcontains many helpful combinators that simplify some common parser patterns.parsley.charactercontains the combinators needed to read characters and strings, as well as combinators to match specific sub-sets of characters.parsley.debugcontains debugging combinators, helpful for identifying faults in parsers.parsley.extensioncontains syntactic sugar combinators exposed as implicit classes.parsley.iocontains extension methods to run parsers with input sourced from IO sources.parsley.exprcontains the following sub modules:parsley.expr.chaincontains combinators used in expression parsingparsley.expr.precedenceis a builder for expression parsers built on a precedence table.parsley.expr.infixcontains combinators used in expression parsing, but with more permissive types than their equivalents inchain.parsley.expr.mixedcontains 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.implicitscontains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:parsley.implicits.charactercontains implicits to allow you to use character and string literals as parsers.parsley.implicits.combinatorcontains implicits related to combinators, such as the ability to make any parser into aParsley[Unit]automatically.parsley.implicits.liftenables postfix application of the lift combinator onto a function (or value).parsley.implicits.zippedenables 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.zippedmethod for building tuples out of several combinators.parsley.errorscontains modules to deal with error messages, their refinement and generation.parsley.errors.combinatorprovides combinators that can be used to either produce more detailed errors as well as refine existing errors.parsley.errors.tokenextractorsprovides mixins for common token extraction strategies during error message generation: these can be used to avoid implementingunexpectedTokenin theErrorBuilder.parsley.liftcontains 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.apcontains functions which allow for the application of a parser returning a function to several parsers returning each of the argument types.parsley.registerscontains combinators that interact with the context-sensitive functionality in the form of registers.parsley.tokencontains theLexerclass that provides a host of helpful lexing combinators when provided with the description of a language.parsley.genericbridgescontains 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.