case class LanguageDef(commentStart: String, commentEnd: String, commentLine: String, nestedComments: Boolean, identStart: Impl, identLetter: Impl, opStart: Impl, opLetter: Impl, keywords: Set[String], operators: Set[String], caseSensitive: Boolean, space: Impl) extends Product with Serializable
This class is required to construct a TokenParser. It defines the various characteristics of the language to be
tokenised. Where a parameter can be either a Set[Char] or a Parsley object, prefer the Set where possible.
It will unlock a variety of faster intrinsic versions of the parsers, which will greatly improve tokenisation
performance! In addition, the Sets are one time converted to heavily optimised BitSets, though that has up to 8KB
memory usage associated but at least doubles the execution speed for that instruction. See parsley.Impl.
- commentStart
For multi-line comments; how does the comment start? (If this or
commentEndis the empty string, multi-line comments are disabled)- commentEnd
For multi-line comments; how does the comment end? (If this or
commentEndis the empty string, multi-line comments are disabled)- commentLine
For single-line comments; how does the comment start? (This this is the empty string, single-line comments are disabled)
- nestedComments
Are multi-line comments allowed to be nested inside each other? E.g. If
{-and-}are opening and closing comments, is the following valid syntax:{-{-hello -}-}? Note in C this is not the case.- identStart
What characters can an identifier in the language start with?
- identLetter
What characters can an identifier in the language consist of after the starting character?
- opStart
What characters can an operator in the language start with?
- opLetter
What characters can an operator in the language consist of after the starting character?
- keywords
What keywords does the language contain?
- operators
What operators does the language contain?
- caseSensitive
Is the language case-sensitive. I.e. is IF equivalent to if?
- space
What characters count as whitespace in the language?
- Since
2.2.0
- Alphabetic
- By Inheritance
- LanguageDef
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
LanguageDef(commentStart: String, commentEnd: String, commentLine: String, nestedComments: Boolean, identStart: Impl, identLetter: Impl, opStart: Impl, opLetter: Impl, keywords: Set[String], operators: Set[String], caseSensitive: Boolean, space: Impl)
- commentStart
For multi-line comments; how does the comment start? (If this or
commentEndis the empty string, multi-line comments are disabled)- commentEnd
For multi-line comments; how does the comment end? (If this or
commentEndis the empty string, multi-line comments are disabled)- commentLine
For single-line comments; how does the comment start? (This this is the empty string, single-line comments are disabled)
- nestedComments
Are multi-line comments allowed to be nested inside each other? E.g. If
{-and-}are opening and closing comments, is the following valid syntax:{-{-hello -}-}? Note in C this is not the case.- identStart
What characters can an identifier in the language start with?
- identLetter
What characters can an identifier in the language consist of after the starting character?
- opStart
What characters can an operator in the language start with?
- opLetter
What characters can an operator in the language consist of after the starting character?
- keywords
What keywords does the language contain?
- operators
What operators does the language contain?
- caseSensitive
Is the language case-sensitive. I.e. is IF equivalent to if?
- space
What characters count as whitespace in the language?
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val caseSensitive: Boolean
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val commentEnd: String
- val commentLine: String
- val commentStart: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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()
- val identLetter: Impl
- val identStart: Impl
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val keywords: Set[String]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nestedComments: Boolean
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val opLetter: Impl
- val opStart: Impl
- val operators: Set[String]
- val space: Impl
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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()
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, as well as the implicit classes which enable the "method-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.iocontains extension methods to run parsers with input sourced from IO sources.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.implicitscontains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:parsley.implicits.charactercontains implicits to allow you to use character and string literals as parsers.parsley.implicits.combinatorcontains implicits related to combinators, such as the ability to make any parser into aParsley[Unit]automatically.parsley.implicits.liftenables postfix application of the lift combinator onto a function (or value).parsley.implicits.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.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.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.registerscontains combinators that interact with the context-sensitive functionality in the form of registers.parsley.tokencontains theLexerclass that provides a host of helpful lexing combinators when provided with the description of a language.parsley.unsafecontains unsafe (and not thread-safe) ways of speeding up the execution of a parser.