package syntax
This package contains various functionality that involve Scala's implicits mechanism.
This includes conversions from scala literals into parsers, as well as enabling new syntax
on regular Scala values (such as Parsley's lift or zipped syntax).
Automatic conversion to Parsley[Unit] is also supported within this package.
- Source
- package.scala
- Alphabetic
- By Inheritance
- syntax
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final class HaskellStyleMap[-A, +B] extends AnyVal
This class exposes the
<#>combinator on functions.This class exposes the
<#>combinator on functions.This extension class operates on functions. It enables the use of the
<#>combinator, which is an alias formapdesigned to more closely mimic Haskell's style. - final class LazyChooseParsley[+A] extends AnyRef
This class exposes an if combinator on pairs of parsers.
This class exposes an if combinator on pairs of parsers.
This extension class operators on pairs of values that are convertible to parsers. It enables the use of the
?:combinator, which is an alias forifP. - final class Lift0[R] extends AnyVal
This class implements the
liftsyntax on any value, which functions aspureas a postfix method. - final class Lift1[T1, R] extends AnyVal
This class enables the
liftsyntax on functions of arity one: a flippedmap. - final class Lift10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, R] extends AnyVal
This class enables the
liftsyntax on functions of arity ten. - final class Lift11[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, R] extends AnyVal
This class enables the
liftsyntax on functions of arity eleven. - final class Lift12[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, R] extends AnyVal
This class enables the
liftsyntax on functions of arity twelve. - final class Lift13[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, R] extends AnyVal
This class enables the
liftsyntax on functions of arity thirteen. - final class Lift14[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, R] extends AnyVal
This class enables the
liftsyntax on functions of arity fourteen. - final class Lift15[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, R] extends AnyVal
This class enables the
liftsyntax on functions of arity fifteen. - final class Lift16[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, R] extends AnyVal
This class enables the
liftsyntax on functions of arity sixteen. - final class Lift17[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, R] extends AnyVal
This class enables the
liftsyntax on functions of arity seventeen. - final class Lift18[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, R] extends AnyVal
This class enables the
liftsyntax on functions of arity eighteen. - final class Lift19[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, R] extends AnyVal
This class enables the
liftsyntax on functions of arity nineteen. - final class Lift2[T1, T2, R] extends AnyVal
This class enables the
liftsyntax on functions of arity two. - final class Lift20[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, R] extends AnyVal
This class enables the
liftsyntax on functions of arity twenty. - final class Lift21[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, R] extends AnyVal
This class enables the
liftsyntax on functions of arity twenty-one. - final class Lift22[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22, R] extends AnyVal
This class enables the
liftsyntax on functions of arity twenty-two. - final class Lift3[T1, T2, T3, R] extends AnyVal
This class enables the
liftsyntax on functions of arity three. - final class Lift4[T1, T2, T3, T4, R] extends AnyVal
This class enables the
liftsyntax on functions of arity four. - final class Lift5[T1, T2, T3, T4, T5, R] extends AnyVal
This class enables the
liftsyntax on functions of arity five. - final class Lift6[T1, T2, T3, T4, T5, T6, R] extends AnyVal
This class enables the
liftsyntax on functions of arity six. - final class Lift7[T1, T2, T3, T4, T5, T6, T7, R] extends AnyVal
This class enables the
liftsyntax on functions of arity seven. - final class Lift8[T1, T2, T3, T4, T5, T6, T7, T8, R] extends AnyVal
This class enables the
liftsyntax on functions of arity eight. - final class Lift9[T1, T2, T3, T4, T5, T6, T7, T8, T9, R] extends AnyVal
This class enables the
liftsyntax on functions of arity nine. - final class OperatorSugar[+A] extends AnyRef
This class enables "operator-style" alternative combinators on parsers.
This class enables "operator-style" alternative combinators on parsers.
This extension class exposes a collection of "operator-style" combinators on values that are convertible to parsers that are plain syntactic sugar for other functionality in the library; they are potentially less readable than the combinators they replace, so should be used sparingly.
- Since
4.0.0
- final class Zipped10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] extends AnyVal
This class enables the
zippedsyntax on tuples of ten parsers. - final class Zipped11[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11] extends AnyVal
This class enables the
zippedsyntax on tuples of eleven parsers. - final class Zipped12[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12] extends AnyVal
This class enables the
zippedsyntax on tuples of twelve parsers. - final class Zipped13[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13] extends AnyVal
This class enables the
zippedsyntax on tuples of thirteen parsers. - final class Zipped14[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14] extends AnyVal
This class enables the
zippedsyntax on tuples of fourteen parsers. - final class Zipped15[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15] extends AnyVal
This class enables the
zippedsyntax on tuples of fifteen parsers. - final class Zipped16[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16] extends AnyVal
This class enables the
zippedsyntax on tuples of sixteen parsers. - final class Zipped17[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17] extends AnyVal
This class enables the
zippedsyntax on tuples of seventeen parsers. - final class Zipped18[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18] extends AnyVal
This class enables the
zippedsyntax on tuples of eighteen parsers. - final class Zipped19[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19] extends AnyVal
This class enables the
zippedsyntax on tuples of nineteen parsers. - final class Zipped2[T1, T2] extends AnyVal
This class enables the
zippedsyntax on pairs of two parsers. - final class Zipped20[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20] extends AnyVal
This class enables the
zippedsyntax on tuples of twenty parsers. - final class Zipped21[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21] extends AnyVal
This class enables the
zippedsyntax on tuples of twenty-one parsers. - final class Zipped22[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22] extends AnyVal
This class enables the
zippedsyntax on tuples of twenty-two parsers. - final class Zipped3[T1, T2, T3] extends AnyVal
This class enables the
zippedsyntax on tuples of three parsers. - final class Zipped4[T1, T2, T3, T4] extends AnyVal
This class enables the
zippedsyntax on tuples of four parsers. - final class Zipped5[T1, T2, T3, T4, T5] extends AnyVal
This class enables the
zippedsyntax on tuples of five parsers. - final class Zipped6[T1, T2, T3, T4, T5, T6] extends AnyVal
This class enables the
zippedsyntax on tuples of six parsers. - final class Zipped7[T1, T2, T3, T4, T5, T6, T7] extends AnyVal
This class enables the
zippedsyntax on tuples of seven parsers. - final class Zipped8[T1, T2, T3, T4, T5, T6, T7, T8] extends AnyVal
This class enables the
zippedsyntax on tuples of eight parsers. - final class Zipped9[T1, T2, T3, T4, T5, T6, T7, T8, T9] extends AnyVal
This class enables the
zippedsyntax on tuples of nine parsers.
Value Members
- object all extends lift with zipped with extension
- object character
Provides implicit conversions for characters and strings into parsers.
Provides implicit conversions for characters and strings into parsers.
The use of
charandstringcan be distracting to the overall structure of the parser with respect to the grammar. This module exposes combinators that can implicitly convert Scala's string and character literals so that they represent parsers. These will not be whitespace sensitive.- Since
4.5.0
- object extension extends extension
These implicit classes can be used to extend the core combinator set of Parsley.
These implicit classes can be used to extend the core combinator set of Parsley.
This may mean that importing them enables combinators that can be used on non-
Parsleytypes, or might enable some syntactic sugar that is not part of the core combinator "style".- Since
4.5.0
- object lift extends lift
This module provides the "
liftsyntax", which enables aliftcombinator on functions of arities up to 22, applying the function across the results of several parsers.This module provides the "
liftsyntax", which enables aliftcombinator on functions of arities up to 22, applying the function across the results of several parsers.scala> import parsley.character.char scala> import parsley.syntax.lift.{liftSyntax2, liftSyntax3} scala> case class Add(x: Int, y: Int) scala> val p = Add.lift(char('a').as(4), char('b').as(5)) scala> p.parse("ab") val res0 = Success(Add(4, 5)) scala> val f = (x: Int, y: Int, z: Int) => x * y + z scala> val q = f.lift(char('a').as(3), char('b').as(2), char('c').as(5)) scala> q.parse("abc") val res1 = Success(11) scala> q.parse("ab") val res2 = Failure(..)
- Since
4.5.0
- Note
a limitation of this syntax is that it requires the function's type to be fully known. For a version of this syntax that behaves better with type inference, see
zipped.
Example: - object zipped extends zipped
This module provides alternatives to the
f.lift(x, y)syntax,(x, y).zipped(f), which works better with type inference.This module provides alternatives to the
f.lift(x, y)syntax,(x, y).zipped(f), which works better with type inference.Also enables a parameterless
zippedmethod, to pair an arbitrary number of parsers such that(p, q).zipped = p.zip(q).Thanks to Andrei Gramescu and George Stacey for ensuring that these combinators even exist in the first place.
scala> import parsley.character.char scala> import parsley.syntax.zipped._ scala> case class Add(x: Int, y: Int) scala> val p = (char('a').as(4), char('b').as(5)).zipped(Add) scala> p.parse("ab") val res0 = Success(Add(4, 5)) scala> val q = (char('a').as(3), char('b').as(2), char('c').as(5)).zipped((x, y, z) => x * y + z) scala> q.parse("abc") val res1 = Success(11) scala> q.parse("ab") val res2 = Failure(..)
- Since
4.5.0
- Note
these methods are not lazy like the
liftsyntax orliftNfunctions! Use the prefix~combinator to make arguments lazy where necessary.
Example:
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.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.syntaxcontains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:parsley.syntax.charactercontains implicits to allow you to use character and string literals as parsers.parsley.syntax.liftenables postfix application of the lift combinator onto a function (or value).parsley.syntax.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.syntax.extensioncontains syntactic sugar combinators exposed as implicit classes.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.statecontains combinators that interact with the context-sensitive functionality in the form of state.parsley.tokencontains theLexerclass that provides a host of helpful lexing combinators when provided with the description of a language.parsley.positioncontains parsers for extracting position information.parsley.genericcontains 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.