org.parboiled.scala.parserunners.TracingParseRunner.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of parboiled-scala_2.11 Show documentation
Elegant parsing in Java and Scala - lightweight, easy-to-use, powerful
The newest version!
/*
 * Copyright (C) 2009-2011 Mathias Doenitz
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.parboiled.scala
package parserunners

import org.parboiled.parserunners.{TracingParseRunner => PTracingParseRunner}
import org.parboiled.Context
import utils.Predicate
import org.parboiled.support.MatcherPath
import org.parboiled.common.{Sink, Predicate => PPredicate, Tuple2 => T2}

/**
 * A wrapper for org.parboiled.parserunners.TracingParseRunner which returns a scala ParsingResult.
 * It provides for the ability to attach filter expressions for limiting the tracing printout to certain input and/or
 * grammar areas.
 * Note that the ParseRunner only accepts rules with zero or one value type parameter, as parsers leaving more
 * than one value on the value stack are considered to be bad style.
 */
object TracingParseRunner {
  def apply(rule: Rule0) = new TracingParseRunner[Nothing](new PTracingParseRunner[Nothing](rule))

  def apply[V](rule: Rule1[V]) = new TracingParseRunner[V](new PTracingParseRunner[V](rule))
}

class TracingParseRunner[V](val inner: PTracingParseRunner[V]) extends ParseRunner[V] {
  def run(input: Input): ParsingResult[V] = ParsingResult(inner.run(input.inputBuffer))

  /**
   * Attaches the given filter predicate limiting the tracing printout.
   * You can supply an expression consisting of either the predefined Predicates (see the Lines, Rules, Matched and
   * Mismatched objects) or custom functions with one of the following signatures as TracingPredicates:
   * Context[Any] => Boolean
   * (Context[Any], Boolean) => Boolean
   *
   * For example: "Lines(10 until 20) && Rules.below(parser.Factor)".
   */
  def filter(filter: TracingPredicate) = {
    inner.withFilter(new PPredicate[T2[Context[Any], Boolean]] {
      def apply(t: T2[Context[Any], Boolean]) = filter((t.a, t.b))
    })
    this
  }

  /**
   * Attaches the given log sink to this TracingParseRunner instance.
   */
  def log(log: Sink[String]) = {
    inner.withLog(log)
    this
  }
}

abstract class TracingPredicate extends Predicate[(Context[Any], Boolean)]

object TracingPredicate {
  implicit def fromRawPredicate(p: Predicate[(Context[Any], Boolean)]): TracingPredicate = new TracingPredicate {
    def apply(t: (Context[Any], Boolean)) = p(t)
  }

  implicit def fromContextPredicate(f: Context[Any] => Boolean): TracingPredicate = new TracingPredicate {
    def apply(t: (Context[Any], Boolean)) = f(t._1)
  }
}

object Lines {
  /**
   *  Creates a TracingPredicate which selects all lines with a number greater or equal to the given one. 
   */
  def from(firstLine: Int): TracingPredicate = toPredicate(_ >= firstLine)

  /**
   * Creates a TracingPredicate which selects all lines with a number smaller or equal to the given one.
   */
  def until(lastLine: Int): TracingPredicate = toPredicate(_ <= lastLine)

  /**
   * Creates a TracingPredicate which selects all lines in the given range of line numbers.
   */
  def apply(lineRange: Range): TracingPredicate = {
    require(lineRange.step == 1, "Ranges with step != 1 are not supported here")
    toPredicate(line => { lineRange.start <= line && line < lineRange.end })
  }

  private def toPredicate(f: Int => Boolean): TracingPredicate =
    (c: Context[Any]) => f(c.getInputBuffer.getPosition(c.getCurrentIndex).line)
}

object Rules {
  /**
   * Creates a TracingPredicate which selects only the given rules.
   */
  def only(rules: Rule*): TracingPredicate = {
    val matchers = rules.map(_.matcher)
    (c:Context[Any]) => matchers.contains(c.getMatcher)
  }

  /**
   * Creates a TracingPredicate which selects only rules on levels below the given rules.
   */
  def below(rules: Rule*): TracingPredicate = {
    val matchers = rules.map(_.matcher)
    toPredicate(path => { matchers.exists(m => (path.element.matcher ne m) && path.contains(m)) })
  }

  /**
   * Creates a TracingPredicate which selects all the given rules and their sub rules.
   */
  def apply(rules: Rule*): TracingPredicate = {
    val matchers = rules.map(_.matcher)
    toPredicate(path => { matchers.exists(path.contains) })
  }

  private def toPredicate(f: MatcherPath => Boolean): TracingPredicate = (c: Context[Any]) => f(c.getPath)
}

/**
 * A TracingPredicate selecting only rules that have matched.
 */
object Matched extends TracingPredicate {
  def apply(t: (Context[Any], Boolean)) = t._2
}

/**
 * A TracingPredicate selecting only rules that have not matched.
 */
object Mismatched extends TracingPredicate {
  def apply(t: (Context[Any], Boolean)) = !t._2
}