Packages

c

parsley.debug

DebugCombinators

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
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DebugCombinators
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def debug(name: 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 currenting 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

    Example:

    1. 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.

  7. def debug(name: String, coloured: Boolean): 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 currenting 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

    coloured

    Whether to render with colour

    Example:

    1. 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.

  8. def debug(name: String, break: Breakpoint): 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 currenting 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

    Example:

    1. 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.

  9. def debug(name: String, break: Breakpoint, coloured: Boolean): 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 currenting 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

    coloured

    Whether to render with colour (default true: render colours)

    Example:

    1. 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")
  10. def debugError(name: String)(implicit errBuilder: ErrorBuilder[_]): Parsley[A]
  11. def debugError(name: String, coloured: Boolean)(implicit errBuilder: ErrorBuilder[_]): Parsley[A]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped