org.parboiled.scala.package.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

import common.FileUtils
import matchers._
import scala._
import rules.Rule._
import support.Chars
import io.{Codec, Source}
import java.io.InputStream
import util.DynamicVariable

package object scala {

  // type aliases
  type Rule = rules.Rule
  type PopRule1[-Z] = rules.PopRule1[Z]
  type PopRule2[-Y, -Z] = rules.PopRule2[Y, Z]
  type PopRule3[-X, -Y, -Z] = rules.PopRule3[X, Y, Z]
  type ReductionRule1[-Z, +A] = rules.ReductionRule1[Z, A]
  type ReductionRule1_1[-Z, +A] = rules.ReductionRule1[Z, A]
  type ReductionRule1_2[-Z, +A, +B] = rules.ReductionRule1_2[Z, A, B]
  type ReductionRule1_3[-Z, +A, +B, +C] = rules.ReductionRule1_3[Z, A, B, C]
  type ReductionRule1_4[-Z, +A, +B, +C, +D] = rules.ReductionRule1_4[Z, A, B, C, D]
  type ReductionRule1_5[-Z, +A, +B, +C, +D, +E] = rules.ReductionRule1_5[Z, A, B, C, D, E]
  type ReductionRule1_6[-Z, +A, +B, +C, +D, +E, +F] = rules.ReductionRule1_6[Z, A, B, C, D, E, F]
  type ReductionRule1_7[-Z, +A, +B, +C, +D, +E, +F, +G] = rules.ReductionRule1_7[Z, A, B, C, D, E, F, G]
  type ReductionRule2[-Y, -Z, +A] = rules.ReductionRule2[Y, Z, A]
  type ReductionRule2_1[-Y, -Z, +A] = rules.ReductionRule2[Y, Z, A]
  type ReductionRule2_2[-Y, -Z, +A, +B] = rules.ReductionRule2_2[Y, Z, A, B]
  type ReductionRule2_3[-Y, -Z, +A, +B, +C] = rules.ReductionRule2_3[Y, Z, A, B, C]
  type ReductionRule2_4[-Y, -Z, +A, +B, +C, +D] = rules.ReductionRule2_4[Y, Z, A, B, C, D]
  type ReductionRule2_5[-Y, -Z, +A, +B, +C, +D, +E] = rules.ReductionRule2_5[Y, Z, A, B, C, D, E]
  type ReductionRule2_6[-Y, -Z, +A, +B, +C, +D, +E, +F] = rules.ReductionRule2_6[Y, Z, A, B, C, D, E, F]
  type ReductionRule2_7[-Y, -Z, +A, +B, +C, +D, +E, +F, +G] = rules.ReductionRule2_7[Y, Z, A, B, C, D, E, F, G]
  type ReductionRule3[-X, -Y, -Z, +A] = rules.ReductionRule3[X, Y, Z, A]
  type ReductionRule3_1[-X, -Y, -Z, +A] = rules.ReductionRule3[X, Y, Z, A]
  type ReductionRule3_2[-X, -Y, -Z, +A, +B] = rules.ReductionRule3_2[X, Y, Z, A, B]
  type ReductionRule3_3[-X, -Y, -Z, +A, +B, +C] = rules.ReductionRule3_3[X, Y, Z, A, B, C]
  type ReductionRule3_4[-X, -Y, -Z, +A, +B, +C, +D] = rules.ReductionRule3_4[X, Y, Z, A, B, C, D]
  type ReductionRule3_5[-X, -Y, -Z, +A, +B, +C, +D, +E] = rules.ReductionRule3_5[X, Y, Z, A, B, C, D, E]
  type ReductionRule3_6[-X, -Y, -Z, +A, +B, +C, +D, +E, +F] = rules.ReductionRule3_6[X, Y, Z, A, B, C, D, E, F]
  type ReductionRule3_7[-X, -Y, -Z, +A, +B, +C, +D, +E, +F, +G] = rules.ReductionRule3_7[X, Y, Z, A, B, C, D, E, F, G]
  type Rule0 = rules.Rule0
  type Rule1[+A] = rules.Rule1[A]
  type Rule2[+A, +B] = rules.Rule2[A, B]
  type Rule3[+A, +B, +C] = rules.Rule3[A, B, C]
  type Rule4[+A, +B, +C, +D] = rules.Rule4[A, B, C, D]
  type Rule5[+A, +B, +C, +D, +E] = rules.Rule5[A, B, C, D, E]
  type Rule6[+A, +B, +C, +D, +E, +F] = rules.Rule6[A, B, C, D, E, F]
  type Rule7[+A, +B, +C, +D, +E, +F, +G] = rules.Rule7[A, B, C, D, E, F, G]
  type CharRule = rules.CharRule
  
  type ParseRunner[V] = scala.parserunners.ParseRunner[V]
  type BasicParseRunner[V] = scala.parserunners.BasicParseRunner[V]
  val BasicParseRunner = scala.parserunners.BasicParseRunner
  type RecoveringParseRunner[V] = scala.parserunners.RecoveringParseRunner[V]
  val RecoveringParseRunner = scala.parserunners.RecoveringParseRunner
  type ReportingParseRunner[V] = scala.parserunners.ReportingParseRunner[V]
  val ReportingParseRunner = scala.parserunners.ReportingParseRunner
  type TracingParseRunner[V] = scala.parserunners.TracingParseRunner[V]
  val TracingParseRunner = scala.parserunners.TracingParseRunner

  /**
   * Creates an "AND" syntactic predicate according to the PEG formalism.
   */
  def &(sub: scala.Rule): Rule0 = new TestMatcher(sub.matcher).label("Test")

  /**
   * Groups the given sub rule into one entity so that a following ~> operator receives the text matched by the whole
   * group rather than only the immediately preceding sub rule.
   */
  def group[T <: scala.Rule](rule: T): T = rule.matcher match {
    case x: SequenceMatcher => { x.defaultLabel(""); rule }
    case x: FirstOfMatcher => { x.defaultLabel(""); rule }
    case _ => throw new IllegalArgumentException("group(...) can only be applied to sequences (~) or choices (|)")
  }

  /**
   * A rule that always matches but consumes no input.
   */
  lazy val EMPTY: Rule0 = new EmptyMatcher()

  /**
   * A rule that matches any single character except EOI.
   */
  lazy val ANY: Rule0 = new AnyMatcher()

  /**
   * A rule that matches the End-Of-Input non-character.
   */
  lazy val EOI: Rule0 = new CharMatcher(Chars.EOI)

  /**
   * A rule that matches the "INDENT" non-character as produced by the IndentDedentInputBuffer.
   */
  lazy val INDENT: Rule0 = new CharMatcher(Chars.INDENT)

  /**
   * A rule that matches the "DEDENT" non-character as produced by the IndentDedentInputBuffer.
   */
  lazy val DEDENT: Rule0 = new CharMatcher(Chars.DEDENT)

  /**
   * A rule that never matches anything (i.e. that always fails).
   */
  lazy val NOTHING: Rule0 = new NothingMatcher()

  /**
   * A parser action removing the top element from the value stack.
   */
  lazy val DROP: PopRule1[Any] = new ActionMatcher(action(ok(stack1[Any](Pop)))).label(nameAction("Drop"))

  /**
   * A parser action removing the top two elements from the value stack.
   */
  lazy val DROP2: PopRule2[Any, Any] = new ActionMatcher(action(ok(stack2[Any, Any](Pop)))).label(nameAction("Drop2"))

  /**
   * A parser action removing the top three elements from the value stack.
   */
  lazy val DROP3: PopRule3[Any, Any, Any] =
    new ActionMatcher(action(ok(stack3[Any, Any, Any](Pop)))).label(nameAction("Drop3"))

  type RuleMethod = StackTraceElement
  
  def make[A, U](a: A)(f: A => U): A = { f(a); a }

  private[scala] def getCurrentRuleMethod: StackTraceElement = {
    val trace = Thread.currentThread().getStackTrace
    val ix = trace.indexWhere(m => m.getMethodName != "rule" && m.getMethodName != "rule$", from = 2)
    trace(ix)
  }

  implicit def toTestAction(f: Context[Any] => Boolean): Rule0 = new ActionMatcher(new Action[Any] {
    def run(context: Context[Any]): Boolean = f(context)
  }).label("TestAction")

  implicit def toRunAction(f: Context[Any] => Unit): Rule0 = new ActionMatcher(new Action[Any] {
    def run(context: Context[Any]): Boolean = {f(context); true}
  }).label("RunAction")

  implicit def creator4PopRule1[Z](m: Matcher): PopRule1[Z] = new PopRule1[Z](m)
  implicit def creator4PopRule2[Y, Z](m: Matcher): PopRule2[Y, Z] = new PopRule2[Y, Z](m)
  implicit def creator4PopRule3[X, Y, Z](m: Matcher): PopRule3[X, Y, Z] = new PopRule3[X, Y, Z](m)
  implicit def creator4ReductionRule1[Z, R](m: Matcher): ReductionRule1[Z, R] = new ReductionRule1[Z, R](m)
  implicit def creator4ReductionRule2[Y, Z, R](m: Matcher): ReductionRule2[Y, Z, R] = new ReductionRule2[Y, Z, R](m)
  implicit def creator4ReductionRule3[X, Y, Z, R](m: Matcher): ReductionRule3[X, Y, Z, R] = new ReductionRule3[X, Y, Z, R](m)
  implicit def creator4Rule0(m: Matcher): Rule0 = new Rule0(m)
  implicit def creator4Rule1[A](m: Matcher): Rule1[A] = new Rule1[A](m)
  implicit def creator4Rule2[A, B](m: Matcher): Rule2[A, B] = new Rule2[A, B](m)
  implicit def creator4Rule3[A, B, C](m: Matcher): Rule3[A, B, C] = new Rule3[A, B, C](m)
  implicit def creator4Rule4[A, B, C, D](m: Matcher): Rule4[A, B, C, D] = new Rule4[A, B, C, D](m)
  implicit def creator4Rule5[A, B, C, D, E](m: Matcher): Rule5[A, B, C, D, E] = new Rule5[A, B, C, D, E](m)
  implicit def creator4Rule6[A, B, C, D, E, F](m: Matcher): Rule6[A, B, C, D, E, F] = new Rule6[A, B, C, D, E, F](m)
  implicit def creator4Rule7[A, B, C, D, E, F, G](m: Matcher): Rule7[A, B, C, D, E, F, G] = new Rule7[A, B, C, D, E, F, G](m)

  implicit def charArray2Input(input: Array[Char]): Input = new Input(input)
  implicit def string2Input(input: String): Input = new Input(input.toCharArray)
  implicit def source2Input(input: Source): Input = new Input(input.toArray[Char])
  implicit def inputStream2Input(input: InputStream)(implicit codec: Codec): Input =
    new Input(FileUtils.readAllChars(input, codec.charSet))

  // helper methods

  private val currentRuleLabel = new DynamicVariable[String](null)
  private val currentActionIndex = new DynamicVariable[Int](0)

  private[scala] def withCurrentRuleLabel[A](s: String)(f: => A): A =
    currentRuleLabel.withValue(s) {
      currentActionIndex.withValue(0) {
        f
      }
    }

  private[scala] def nameAction(coreLabel: String) = {
    currentActionIndex.value += 1
    currentRuleLabel.value + coreLabel + "Action" + currentActionIndex.value
  }

}