implicit class DebugCombinators[P, A] extends AnyRef
This class enables the debug combinator on parsers.
This extension class operates on values that are convertible to parsers. It enables the use of
the debug combinator, which can be used to trace the execution through a parser.
- P
the type of base value that this class is used on (the conversion to
Parsley) is summoned automatically.
- Source
- debug.scala
- Alphabetic
- By Inheritance
- DebugCombinators
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DebugCombinators(p: P)(implicit con: (P) => Parsley[A])
This constructor should not be called manually, it is designed to be used via Scala's implicit resolution.
This constructor should not be called manually, it is designed to be used via Scala's implicit resolution.
- p
the value that this class is enabling methods on.
- con
a conversion that allows values convertible to parsers to be used.
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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def debug(name: String, watchedRefs: (Ref[_], String)*): Parsley[A]
This combinator allows this parser to be debugged by providing a trace through the execution.
This combinator allows this parser to be debugged by providing a trace through the execution.
When this combinator is entered, it will print the name assigned to the parser, as well as the current input context for a few characters on either side. This parser is then executed. If it succeeded, this combinator again reports the name along with "
Good" and the input context. If it failed, it reports the name along with "Bad" and the input context.When breakpoints are used, the execution of the combinator will pause on either entry, exit, or both. The parse is resumed by entering a newline on standard input. Breakpoints will cause additional information about the internal state of the parser to be reported.
- name
The name to be assigned to this parser
- watchedRefs
Which references to also track the values of and their names, if any
scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt") scala> val abd = string("abd").debug("string abd") scala> val p = (abc <|> abd).debug("or") scala> p.parse("abd") >or> (1, 1): abd• ^ >attempt> (1, 1): abd• ^ >string abc> (1, 1): abd• ^ <string abc< (1, 3): abd• Fail ^ <attempt< (1, 1): abd• Fail ^ >string abd> (1, 1): abd• ^ <string abd< (1, 4): abd• Good ^ <or< (1, 4): abd• Good ^ val res0 = Success("abd")
Renders in colour with no break-point.
Example: - def debug(name: String, colored: Boolean, watchedRefs: (Ref[_], String)*): Parsley[A]
This combinator allows this parser to be debugged by providing a trace through the execution.
This combinator allows this parser to be debugged by providing a trace through the execution.
When this combinator is entered, it will print the name assigned to the parser, as well as the current input context for a few characters on either side. This parser is then executed. If it succeeded, this combinator again reports the name along with "
Good" and the input context. If it failed, it reports the name along with "Bad" and the input context.When breakpoints are used, the execution of the combinator will pause on either entry, exit, or both. The parse is resumed by entering a newline on standard input. Breakpoints will cause additional information about the internal state of the parser to be reported.
- name
The name to be assigned to this parser
- colored
Whether to render with colour
- watchedRefs
Which references to also track the values of and their names, if any
scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt") scala> val abd = string("abd").debug("string abd") scala> val p = (abc <|> abd).debug("or") scala> p.parse("abd") >or> (1, 1): abd• ^ >attempt> (1, 1): abd• ^ >string abc> (1, 1): abd• ^ <string abc< (1, 3): abd• Fail ^ <attempt< (1, 1): abd• Fail ^ >string abd> (1, 1): abd• ^ <string abd< (1, 4): abd• Good ^ <or< (1, 4): abd• Good ^ val res0 = Success("abd")
No break-points.
Example: - def debug(name: String, break: Breakpoint, watchedRefs: (Ref[_], String)*): Parsley[A]
This combinator allows this parser to be debugged by providing a trace through the execution.
This combinator allows this parser to be debugged by providing a trace through the execution.
When this combinator is entered, it will print the name assigned to the parser, as well as the current input context for a few characters on either side. This parser is then executed. If it succeeded, this combinator again reports the name along with "
Good" and the input context. If it failed, it reports the name along with "Bad" and the input context.When breakpoints are used, the execution of the combinator will pause on either entry, exit, or both. The parse is resumed by entering a newline on standard input. Breakpoints will cause additional information about the internal state of the parser to be reported.
- name
The name to be assigned to this parser
- break
The breakpoint properties of this parser, defaults to NoBreak
- watchedRefs
Which references to also track the values of and their names, if any
scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt") scala> val abd = string("abd").debug("string abd") scala> val p = (abc <|> abd).debug("or") scala> p.parse("abd") >or> (1, 1): abd• ^ >attempt> (1, 1): abd• ^ >string abc> (1, 1): abd• ^ <string abc< (1, 3): abd• Fail ^ <attempt< (1, 1): abd• Fail ^ >string abd> (1, 1): abd• ^ <string abd< (1, 4): abd• Good ^ <or< (1, 4): abd• Good ^ val res0 = Success("abd")
Renders in colour.
Example: - def debug(name: String, break: Breakpoint, colored: Boolean, watchedRefs: (Ref[_], String)*): Parsley[A]
This combinator allows this parser to be debugged by providing a trace through the execution.
This combinator allows this parser to be debugged by providing a trace through the execution.
When this combinator is entered, it will print the name assigned to the parser, as well as the current input context for a few characters on either side. This parser is then executed. If it succeeded, this combinator again reports the name along with "
Good" and the input context. If it failed, it reports the name along with "Bad" and the input context.When breakpoints are used, the execution of the combinator will pause on either entry, exit, or both. The parse is resumed by entering a newline on standard input. Breakpoints will cause additional information about the internal state of the parser to be reported.
- name
The name to be assigned to this parser
- break
The breakpoint properties of this parser, defaults to NoBreak
- colored
Whether to render with (default true: render colours)
- watchedRefs
Which references to also track the values of and their names, if any
scala> import parsley.debug.DebugCombinators, parsley.character.string, parsley.Parsley.attempt scala> val abc = attempt(string("abc").debug("string abc")).debug("attempt") scala> val abd = string("abd").debug("string abd") scala> val p = (abc <|> abd).debug("or") scala> p.parse("abd") >or> (1, 1): abd• ^ >attempt> (1, 1): abd• ^ >string abc> (1, 1): abd• ^ <string abc< (1, 3): abd• Fail ^ <attempt< (1, 1): abd• Fail ^ >string abd> (1, 1): abd• ^ <string abd< (1, 4): abd• Good ^ <or< (1, 4): abd• Good ^ val res0 = Success("abd")
Example: - def debugError(name: String)(implicit errBuilder: ErrorBuilder[_]): Parsley[A]
Display information about the error messages generated by this parser.
Display information about the error messages generated by this parser.
This is an experimental debugger that provides internal information about error messages. This provides more detail than one might normally see inside a regular error message, but may help isolate the root cause of an error message not being as expected: this can form the bulk of a specific question on the discussion board.
- name
The name to be assigned to this parser
- errBuilder
The error builder used for formatting messages in the "real parser", which is used to help format information in the debugger.
- Since
4.0.0
- def debugError(name: String, colored: Boolean)(implicit errBuilder: ErrorBuilder[_]): Parsley[A]
Display information about the error messages generated by this parser.
Display information about the error messages generated by this parser.
This is an experimental debugger that provides internal information about error messages. This provides more detail than one might normally see inside a regular error message, but may help isolate the root cause of an error message not being as expected: this can form the bulk of a specific question on the discussion board.
- name
The name to be assigned to this parser
- colored
Whether the output should be colourful
- errBuilder
The error builder used for formatting messages in the "real parser", which is used to help format information in the debugger.
- Since
4.0.0
- 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()
- def profile(name: String)(implicit profiler: Profiler): Parsley[A]
This combinator allows for the runtime of this parser to be measured.
This combinator allows for the runtime of this parser to be measured.
When this parser executes, its start and end times will be logged using
System.nanoTime(), which has a resolution of 100ns. These will be logged into the givenProfilerobject.- name
the unique name of this parser, which will represent it in the table
- profiler
the profiling object that will collect and process the data
- Since
4.4.0
- Note
usual disclaimers about profiling apply: results are just data; use your judgement
- See also
- 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(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.