package predicate
This module contains functionality to describe character predicates, which can be used to determine what characters are valid for different tokens.
- Source
- token-package.scala
- Since
4.0.0
- Alphabetic
- By Inheritance
- predicate
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final case class Basic(predicate: (Char) => Boolean) extends CharPredicate with Product with Serializable
Basic character predicate, which reads regular Scala 16-bit characters.
Basic character predicate, which reads regular Scala 16-bit characters.
This predicate is only capable of recognising characters within the Basic Multilingual Plane.
- Since
4.0.0
- sealed abstract class CharPredicate extends AnyRef
Base class for character predicates.
Base class for character predicates.
- Since
4.0.0
- final case class Unicode(predicate: (Int) => Boolean) extends CharPredicate with Product with Serializable
More generic character predicate, which reads any unicode codepoint.
More generic character predicate, which reads any unicode codepoint.
Full unicode characters can be up to 24-bits, which is handled by a 32-bit number on the JVM. This predicate can be used, therefore, to handle any single unicode codepoint: this excludes multi-codepoint characters like flags, or modified emojis.
In Scala, characters can be upcast to integers, so still can be used in the description of this predicate.
- Since
4.0.0
Value Members
- case object NotRequired extends CharPredicate with Product with Serializable
Character predicate that never succeeds.
Character predicate that never succeeds.
- Since
4.0.0
- object implicits
This object provides implicit functionality for constructing
CharPredicate
values.This object provides implicit functionality for constructing
CharPredicate
values.- Since
4.1.0
This is the documentation for Parsley.
Package structure
The parsley package contains the
Parsley
class, as well as theResult
,Success
, andFailure
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 parsingparsley.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 inchain
.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 implementingunexpectedToken
in theErrorBuilder
.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.state
contains combinators that interact with the context-sensitive functionality in the form of state.parsley.token
contains theLexer
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.