package text
- Alphabetic
- Public
- Protected
Type Members
- final case class EscapeDesc(escBegin: Char, literals: Set[Char], singleMap: Map[Char, Int], multiMap: Map[String, Int], decimalEscape: NumericEscape, hexadecimalEscape: NumericEscape, octalEscape: NumericEscape, binaryEscape: NumericEscape, emptyEscape: Option[Char], gapsSupported: Boolean) extends Product with Serializable
This class describes the valid escape sequences within character and string literals.
This class describes the valid escape sequences within character and string literals.
This allows for the definition of different escape sequences as direct literals, mapping from single or multiple characters to specific values, numeric escape sequences with different bases, as well as supporting zero-width escapes and line continuations via string gaps.
- escBegin
the character that starts an escape sequence, very often this is
'\\'
.- literals
the characters that can be directly escaped, but still represent themselves, for instance
'"'
, or'\\'
.- singleMap
the possible single-character escape sequences and the (full UTF-16) character they map to, for instance
'n' -> 0xa
.- multiMap
the possible multi-character escape sequences and the (full UTF-16) character they map to.
- decimalEscape
if allowed, the description of how numeric escape sequences work for base 10.
- hexadecimalEscape
if allowed, the description of how numeric escape sequences work for base 16.
- octalEscape
if allowed, the description of how numeric escape sequences work for base 8.
- binaryEscape
if allowed, the description of how numeric escape sequences work for base 2.
- emptyEscape
if one should exist, the character which has no effect on the string but can be used to disambiguate other escape sequences: in Haskell this would be
\&
.- gapsSupported
specifies whether or not string gaps are supported: this is where whitespace can be injected between two
escBegin
characters and this will all be ignored in the final string, such that"hello \ \world"
is"hello world"
.
- sealed abstract class NumberOfDigits extends AnyRef
This class, and its subtypes, describe how many digits a numeric escape sequence is allowed.
This class, and its subtypes, describe how many digits a numeric escape sequence is allowed.
- Since
4.0.0
- sealed abstract class NumericEscape extends AnyRef
This class, and its subtypes, describe how numeric escape sequences should work for a specific base.
This class, and its subtypes, describe how numeric escape sequences should work for a specific base.
- Since
4.0.0
- final case class TextDesc(escapeSequences: EscapeDesc, characterLiteralEnd: Char, stringEnds: Set[String], multiStringEnds: Set[String], graphicCharacter: CharPredicate) extends Product with Serializable
This class describes how textual literals like strings and characters should be processed lexically.
This class describes how textual literals like strings and characters should be processed lexically.
- escapeSequences
the description of how escape sequences in literals.
- characterLiteralEnd
what character starts and ends a character literal.
- stringEnds
what sequences may begin and end a string literal.
- multiStringEnds
what sequences may begin and end a multi-line string literal.
- graphicCharacter
what characters can be written verbatim into a character or string literal.
- Since
4.0.0
Value Members
- object EscapeDesc extends Serializable
This object contains default implementations of the
EscapeDesc
class, which align with different languages or styles.This object contains default implementations of the
EscapeDesc
class, which align with different languages or styles.- Since
4.0.0
- object NumberOfDigits
This object contains the concrete subtypes of
NumberOfDigits
.This object contains the concrete subtypes of
NumberOfDigits
.- Since
4.0.0
- object NumericEscape
This object contains the concrete subtypes of
NumericEscape
.This object contains the concrete subtypes of
NumericEscape
.- Since
4.0.0
- object TextDesc extends Serializable
This object contains any preconfigured text definitions.
This object contains any preconfigured text definitions.
- Since
4.0.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.registers
contains combinators that interact with the context-sensitive functionality in the form of registers.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.