final class OperatorSugar[+A] extends AnyRef
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.
- Source
- extension.scala
- Since
4.0.0
- Alphabetic
- By Inheritance
- OperatorSugar
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def *: Parsley[List[A]]
This combinator, pronounced "star", will parse this parser zero or more times returning a list of the parsed results.
This combinator, pronounced "star", will parse this parser zero or more times returning a list of the parsed results.
Equivalent to
many, but as a postfix operator:many(p)is the same asp.*.- Note
an alias for
many.- See also
manyfor more details.
- def +: Parsley[List[A]]
This combinator, pronounced "plus", will parse this parser one or more times returning a list of the parsed results.
This combinator, pronounced "plus", will parse this parser one or more times returning a list of the parsed results.
Equivalent to
some, but as a postfix operator:some(p)is the same asp.+.- Note
an alias for
some.- See also
somefor more details.
- def -(q: Parsley[_]): Parsley[A]
This combinator, pronounced "and not", first parses its argument
q, and if it fails, it will parse this parser, returning its result.This combinator, pronounced "and not", first parses its argument
q, and if it fails, it will parse this parser, returning its result.First
qis parsed, which will never consume input regardless of failure or success. If it failed, then this parser is executed and its result is returned. If eitherqsucceeds or this parser fails, the combinator fails.- q
the parser to quotient this parser by.
- returns
a parser that only parses this parser if
qcannot parse.
// a less efficient version of a keyword: it's more efficient to not have to read the entire keyword twice def keyword(kw: String): Parsley[Unit] = { string(kw).void - identifier }
Example: - final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def ?: Parsley[Option[A]]
This combinator, pronounced "option", will try parsing this parser wrapping its result in
Some, and returnNoneif it fails.This combinator, pronounced "option", will try parsing this parser wrapping its result in
Some, and returnNoneif it fails.Equivalent to
option, but as a postfix operator:option(p)is the same asp.?.- Note
an alias for
option.- See also
optionfor more details.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unary_!: Parsley[Unit]
This combinator, pronounced "not", will succeed when this parser fails, and vice-versa, never consuming input.
This combinator, pronounced "not", will succeed when this parser fails, and vice-versa, never consuming input.
Equivalent to
notFollowedBy, but as a prefix operator:notFollowedBy(p)is the same as!p.- Note
an alias for
notFollowedBy.- See also
notFollowedByfor more details.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
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.