parsley.debug.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of parsley_3.0.0-RC2 Show documentation

parsley

The newest version!

package parsley

import parsley.internal.deepembedding

import scala.language.implicitConversions

/** This module contains the very useful debugging combinator, as well as breakpoints. */
// $COVERAGE-OFF$
object debug {
    trait Breakpoint
    case object NoBreak extends Breakpoint
    case object EntryBreak extends Breakpoint
    case object ExitBreak extends Breakpoint
    case object FullBreak extends Breakpoint

    private [parsley] var renderAscii = false
    /** This method can be used to disable the coloured debug output for terminals that don't support it*/
    def disableColourRendering(): Unit = renderAscii = true

    /** This class enables the `debug` combinator on parsers */
    implicit class DebugCombinators[P, A](val p: P)(implicit val con: P => Parsley[A]) {
        /**
          * Using this method enables debugging functionality for this parser. When it is entered a snapshot is taken and
          * presented on exit. It will signify when a parser is entered and exited as well. Use the break parameter to halt
          * execution on either entry, exit, both or neither.
          * @param name The name to be assigned to this parser
          * @param break The breakpoint properties of this parser, defaults to NoBreak
          * @param coloured Whether to render with colour (default true: render colours)
          */
        def debug(name: String, break: Breakpoint = NoBreak, coloured: Boolean = true): Parsley[A] = {
            new Parsley(new deepembedding.Debug[A](con(p).internal, name, !coloured, break))
        }
    }
}
// $COVERAGE-ON$