object space
This object is concerned with special treatment of whitespace.
For the vast majority of cases, the functionality within this
object shouldn't be needed, as whitespace is consistently handled
by lexeme
and fully
. However, for grammars where whitespace
is significant (like indentation-sensitive languages), this object
provides some more fine-grained control over how whitespace is
consumed by the parsers within lexeme
.
- Source
- Lexer.scala
- Since
4.0.0
- Alphabetic
- By Inheritance
- space
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
alter[A](newSpace: CharPredicate)(within: ⇒ Parsley[A]): Parsley[A]
This combinator changes how whitespace is parsed by lexemes for the duration of a given parser.
This combinator changes how whitespace is parsed by lexemes for the duration of a given parser.
So long as
spaceDesc.whiteSpaceIsContextDependent
is set totrue
, this combinator will be able to locally change the definition of whitespace during the given parser.- newSpace
the new implementation of whitespace to be used during the execution of
within
.- within
the parser that should be parsed using the updated whitespace.
In indentation sensitive languages, the indentation sensitivity is often ignored within parentheses or braces. In these cases
lexeme.enclosing.parens(space.alter(withNewline)(p))
would allow unrestricted newlines within parentheses.- Since
4.0.0
- Note
the whitespace will not be restored to its original implementation if the given parser fails having consumed input.
Example: -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
init: Parsley[Unit]
This parser initialises the whitespace used by the lexer when
spaceDesc.whiteSpaceIsContextDependent
is set totrue
.This parser initialises the whitespace used by the lexer when
spaceDesc.whiteSpaceIsContextDependent
is set totrue
.The whitespace is set to the implementation given by the lexical description. This parser must be used, by
fully
or otherwise, as the first thing the global parser does or anUnfilledRegisterException
will occur. -
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()
-
lazy val
skipComments: Parsley[Unit]
This parser skips zero or more comments.
This parser skips zero or more comments.
The implementation of this combinator does not vary with
whitespaceIsContextDependent
. It will use thehide
combinator as to not appear as a valid alternative in an error message: adding a comment is often legal, but not a useful solution for how to make the input syntactically valid.- Since
4.0.0
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
val
whiteSpace: Parsley[Unit]
This parser skips zero or more (insignificant) whitespace characters as well as comments.
This parser skips zero or more (insignificant) whitespace characters as well as comments.
The implementation of this parser depends on whether
whitespaceIsContextDependent
is set: when it is, this parser may change based on the use of thealter
combinator. This parser will always use thehide
combinator as to not appear as a valid alternative in an error message: it's likely always the case whitespace can be added at any given time, but that doesn't make it a useful suggestion unless it is significant.- 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.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.