Packages

t

org.kiama.util

WhitespaceParser

trait WhitespaceParser extends ParserUtilities

Support for defining the form of whitespace using a parser, rather than a regular expression. This version is useful particularly in cases where the form of comments requires more power than a regular expression can provide (e.g., for nested comments).

Source
ParserUtilities.scala
Linear Supertypes
ParserUtilities, PackratParsers, RegexParsers, Parsers, AnyRef, Any
Known Subclasses
WhitespacePositionedParserUtilities
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WhitespaceParser
  2. ParserUtilities
  3. PackratParsers
  4. RegexParsers
  5. Parsers
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Elem = Char
    Definition Classes
    RegexParsers → Parsers
  2. case class Error extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  3. case class Failure extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  4. type Input = Reader[Elem]
    Definition Classes
    Parsers
  5. sealed abstract class NoSuccess extends ParseResult[Nothing]
    Definition Classes
    Parsers
  6. trait OnceParser[+T] extends Parser[T]
    Definition Classes
    Parsers
  7. abstract class PackratParser[+T] extends scala.util.parsing.combinator.PackratParsers.Parser[T]
    Definition Classes
    PackratParsers
  8. class PackratReader[+T] extends Reader[T]
    Definition Classes
    PackratParsers
  9. sealed abstract class ParseResult[+T] extends AnyRef
    Definition Classes
    Parsers
  10. abstract class Parser[+T] extends (Input) ⇒ ParseResult[T]
    Definition Classes
    Parsers
  11. case class Success[+T] extends ParseResult[T] with Product with Serializable
    Definition Classes
    Parsers
  12. case class ~[+a, +b] extends Product with Serializable
    Definition Classes
    Parsers

Abstract Value Members

  1. abstract val whitespaceParser: PackratParser[Any]

    A parser that recognises whitespace.

    A parser that recognises whitespace. Normal whitespace handling is turned off while this parser is applied, since we need to avoid an infinite recursion if the form of whitespace is defined using literal or regex.

    Attributes
    protected

Concrete 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. def OnceParser[T](f: (Input) ⇒ ParseResult[T]): Parser[T] with OnceParser[T]
    Definition Classes
    Parsers
  5. def Parser[T](f: (Input) ⇒ ParseResult[T]): Parser[T]
    Definition Classes
    Parsers
  6. def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]
    Definition Classes
    Parsers
  7. def accept[ES](es: ES)(implicit arg0: (ES) ⇒ List[Elem]): Parser[List[Elem]]
    Definition Classes
    Parsers
  8. implicit def accept(e: Elem): Parser[Elem]
    Definition Classes
    Parsers
  9. def acceptIf(p: (Elem) ⇒ Boolean)(err: (Elem) ⇒ String): Parser[Elem]
    Definition Classes
    Parsers
  10. def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]
    Definition Classes
    Parsers
  11. def acceptSeq[ES](es: ES)(implicit arg0: (ES) ⇒ Iterable[Elem]): Parser[List[Elem]]
    Definition Classes
    Parsers
  12. def any: PackratParser[Char]

    A parser that matches any element, failing if the end of input is reached.

    A parser that matches any element, failing if the end of input is reached.

    Definition Classes
    ParserUtilities
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def chainl1[T, U](first: ⇒ Parser[T], p: ⇒ Parser[U], q: ⇒ Parser[(T, U) ⇒ T]): Parser[T]
    Definition Classes
    Parsers
  15. def chainl1[T](p: ⇒ Parser[T], q: ⇒ Parser[(T, T) ⇒ T]): Parser[T]
    Definition Classes
    Parsers
  16. def chainr1[T, U](p: ⇒ Parser[T], q: ⇒ Parser[(T, U) ⇒ U], combine: (T, U) ⇒ U, first: U): Parser[U]
    Definition Classes
    Parsers
  17. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def commit[T](p: ⇒ Parser[T]): Parser[T]
    Definition Classes
    Parsers
  19. implicit def constToTupleFunction2[A, B, R](r: (A, B) ⇒ R): (~[A, B]) ⇒ R

    Convenience conversion to allow arity two functions to be used directly in tree construction actions.

    Convenience conversion to allow arity two functions to be used directly in tree construction actions.

    Definition Classes
    ParserUtilities
  20. implicit def constToTupleFunction3[A, B, C, R](r: (A, B, C) ⇒ R): (~[~[A, B], C]) ⇒ R

    Convenience conversion to allow arity three functions to be used directly in tree construction actions.

    Convenience conversion to allow arity three functions to be used directly in tree construction actions.

    Definition Classes
    ParserUtilities
  21. implicit def constToTupleFunction4[A, B, C, D, R](r: (A, B, C, D) ⇒ R): (~[~[~[A, B], C], D]) ⇒ R

    Convenience conversion to allow arity four functions to be used directly in tree construction actions.

    Convenience conversion to allow arity four functions to be used directly in tree construction actions.

    Definition Classes
    ParserUtilities
  22. implicit def constToTupleFunction5[A, B, C, D, E, R](r: (A, B, C, D, E) ⇒ R): (~[~[~[~[A, B], C], D], E]) ⇒ R

    Convenience conversion to allow arity five functions to be used directly in tree construction actions.

    Convenience conversion to allow arity five functions to be used directly in tree construction actions.

    Definition Classes
    ParserUtilities
  23. implicit def constToTupleFunction6[A, B, C, D, E, F, R](r: (A, B, C, D, E, F) ⇒ R): (~[~[~[~[~[A, B], C], D], E], F]) ⇒ R

    Convenience conversion to allow arity six functions to be used directly in tree construction actions.

    Convenience conversion to allow arity six functions to be used directly in tree construction actions.

    Definition Classes
    ParserUtilities
  24. lazy val constrainedInt: PackratParser[Int]

    Parse digit strings that are constrained to fit into an Int value.

    Parse digit strings that are constrained to fit into an Int value. If the digit string is too big, a parse error results.

    Definition Classes
    ParserUtilities
  25. def elem(e: Elem): Parser[Elem]
    Definition Classes
    Parsers
  26. def elem(kind: String, p: (Elem) ⇒ Boolean): Parser[Elem]
    Definition Classes
    Parsers
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def err(msg: String): Parser[Nothing]

    Return an error after skipping white space.

    Return an error after skipping white space.

    Definition Classes
    ParserUtilities → Parsers
  30. def failure(msg: String): Parser[Nothing]

    Return a failure after skipping white space.

    Return a failure after skipping white space.

    Definition Classes
    ParserUtilities → Parsers
  31. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  33. def guard[T](p: ⇒ Parser[T]): Parser[T]
    Definition Classes
    Parsers
  34. def handleWhiteSpace(in: Input): Int

    Version of handleWhiteSpace that accepts an Input value rather than separate source and offset.

    Version of handleWhiteSpace that accepts an Input value rather than separate source and offset. By default, just delegates to the handleWhiteSpace of RegexParsers.

    Definition Classes
    ParserUtilities
  35. def handleWhiteSpace(source: CharSequence, offset: Int): Int
    Attributes
    protected
    Definition Classes
    RegexParsers
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def keywords(ext: Regex, kws: Seq[String]): Parser[String]

    Parser for keywords.

    Parser for keywords. The list of string arguments gives the text of the keywords in a language. The regular expression gives the possible extension of the keyword to stop the keyword being seen as an identifier instead. For example, the keyword list might contain "begin" and "end" and the extension regular expression might be [^a-zA-Z0-9]. Thus, begin followed by something other than a letter or digit is a keyword, but beginfoo8 is an identifier. This parser succeeds if any of the keywords is present, provided that it's not immediately followed by something that extends it.

    Definition Classes
    ParserUtilities
  39. implicit def literal(s: String): Parser[String]

    A parser that matches a literal string after skipping any whitespace that is parsed by whitespaceParser.

    A parser that matches a literal string after skipping any whitespace that is parsed by whitespaceParser.

    Definition Classes
    WhitespaceParser → RegexParsers
  40. def log[T](p: ⇒ Parser[T])(name: String): Parser[T]
    Definition Classes
    Parsers
  41. def memo[T](p: Parser[T]): PackratParser[T]
    Definition Classes
    PackratParsers
  42. def mkList[T]: (~[T, List[T]]) ⇒ List[T]
    Definition Classes
    Parsers
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. def not[T](p: ⇒ Parser[T]): Parser[Unit]
    Definition Classes
    Parsers
  45. final def notify(): Unit
    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  47. def opt[T](p: ⇒ Parser[T]): Parser[Option[T]]
    Definition Classes
    Parsers
  48. def parse[T](p: Parser[T], in: Reader): ParseResult[T]
    Definition Classes
    RegexParsers
  49. def parse[T](p: Parser[T], in: CharSequence): ParseResult[T]
    Definition Classes
    RegexParsers
  50. def parse[T](p: Parser[T], in: Reader[Char]): ParseResult[T]
    Definition Classes
    RegexParsers
  51. def parseAll[T](p: Parser[T], in: CharSequence): ParseResult[T]
    Definition Classes
    RegexParsers
  52. def parseAll[T](p: Parser[T], in: Reader): ParseResult[T]
    Definition Classes
    RegexParsers
  53. def parseAll[T](p: Parser[T], in: Reader[Char]): ParseResult[T]
    Definition Classes
    RegexParsers
  54. implicit def parseResultToTuple2[A, B](p: Parser[~[A, B]]): PackratParser[(A, B)]

    Convenience conversion to lift parsers that return 2-tilde-tuples to parsers that return regular 2-tuples.

    Convenience conversion to lift parsers that return 2-tilde-tuples to parsers that return regular 2-tuples.

    Definition Classes
    ParserUtilities
  55. implicit def parseResultToTuple3[A, B, C](p: Parser[~[~[A, B], C]]): PackratParser[(A, B, C)]

    Convenience conversion to lift parsers that return 3-tilde-tuples to parsers that return regular 3-tuples.

    Convenience conversion to lift parsers that return 3-tilde-tuples to parsers that return regular 3-tuples.

    Definition Classes
    ParserUtilities
  56. implicit def parseResultToTuple4[A, B, C, D](p: Parser[~[~[~[A, B], C], D]]): PackratParser[(A, B, C, D)]

    Convenience conversion to lift parsers that return 4-tilde-tuples to parsers that return regular 4-tuples.

    Convenience conversion to lift parsers that return 4-tilde-tuples to parsers that return regular 4-tuples.

    Definition Classes
    ParserUtilities
  57. implicit def parseResultToTuple5[A, B, C, D, E](p: Parser[~[~[~[~[A, B], C], D], E]]): PackratParser[(A, B, C, D, E)]

    Convenience conversion to lift parsers that return 5-tilde-tuples to parsers that return regular 5-tuples.

    Convenience conversion to lift parsers that return 5-tilde-tuples to parsers that return regular 5-tuples.

    Definition Classes
    ParserUtilities
  58. implicit def parseResultToTuple6[A, B, C, D, E, F](p: Parser[~[~[~[~[~[A, B], C], D], E], F]]): PackratParser[(A, B, C, D, E, F)]

    Convenience conversion to lift parsers that return 6-tilde-tuples to parsers that return regular 6-tuples.

    Convenience conversion to lift parsers that return 6-tilde-tuples to parsers that return regular 6-tuples.

    Definition Classes
    ParserUtilities
  59. def parseString[T](parser: Parser[T], str: String): Either[T, String]

    Use parser to parse the string str.

    Use parser to parse the string str. If the parse is sucessful and produces the value t, return Left (t). Otherwise, return Right (msg) where msg is the mesage produced by the parser.

    Definition Classes
    ParserUtilities
  60. def parseWhitespace(in: Input): ParseResult[Any]

    If we are parsing whitespace already, fail if we are the end of the input, otherwise succeed with no progress.

    If we are parsing whitespace already, fail if we are the end of the input, otherwise succeed with no progress. If we are not already parsing whitespace, then apply the whitespace parser, swallowing any errors from it unless they occur at the end of the input. In other words, an error not at the end is treated as the absence of whitespace.

    Attributes
    protected
  61. implicit def parser2packrat[T](p: ⇒ Parser[T]): PackratParser[T]
    Definition Classes
    PackratParsers
  62. val parsingWhitespace: Boolean

    Are we currently parsing whitespace?

    Are we currently parsing whitespace?

    Attributes
    protected
  63. def phrase[T](p: Parser[T]): PackratParser[T]
    Definition Classes
    PackratParsers → Parsers
  64. def positioned[T <: Positional](p: ⇒ Parser[T]): Parser[T]

    As for positioned in RegexParsers, but uses parseWhitespace to skip whitespace.

    As for positioned in RegexParsers, but uses parseWhitespace to skip whitespace.

    Definition Classes
    WhitespaceParser → RegexParsers → Parsers
  65. implicit def regex(r: Regex): Parser[String]

    A parser that matches a regex string after skipping any whitespace that is parsed by whitespaceParser.

    A parser that matches a regex string after skipping any whitespace that is parsed by whitespaceParser.

    Definition Classes
    WhitespaceParser → RegexParsers
  66. def rep[T](p: ⇒ Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  67. def rep1[T](first: ⇒ Parser[T], p0: ⇒ Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The p0 call-by-name arguments is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.

  68. def rep1[T](p: ⇒ Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  69. def rep1sep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]
    Definition Classes
    Parsers
  70. def repN[T](num: Int, p: ⇒ Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  71. def repsep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]
    Definition Classes
    Parsers
  72. def result[T](v: ⇒ T): Parser[T]

    Construct a parser that always succeeds and returns value v.

    Construct a parser that always succeeds and returns value v. See also the success combinator in the Scala library that does something similar but always returns the same value each time since the parameter is not passed by name.

    Definition Classes
    ParserUtilities
  73. def skipWhitespace: Boolean
    Definition Classes
    WhitespaceParser → RegexParsers
  74. def stringToInt(s: String): Either[Int, String]

    Convert the digit string s to an Int if it's in range, but return an error message if it's too big.

    Convert the digit string s to an Int if it's in range, but return an error message if it's too big.

    Definition Classes
    ParserUtilities
  75. def success[T](v: T): Parser[T]
    Definition Classes
    Parsers
  76. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  77. def toString(): String
    Definition Classes
    AnyRef → Any
  78. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. val whiteSpace: Regex
    Attributes
    protected
    Definition Classes
    RegexParsers
  82. def wrap[T, U](p: ⇒ Parser[T], f: (T) ⇒ Either[U, String]): Parser[U]

    Wrap a parser p that produces a value of type T to produce a parser returning values of type U.

    Wrap a parser p that produces a value of type T to produce a parser returning values of type U. Whitespace is skipped (if we are skipping white space) before p is applied, so that we have access to the first non-whitespace position.

    The function f is responsible for converting the T value into either a U value or a string that indicates what went wrong. In the latter case, the resulting parser will error at the original position with the message, ignoring any other errors at that position. Failures or errors of p will be lifted to the returned type.

    Definition Classes
    ParserUtilities
  83. object NoSuccess
    Definition Classes
    Parsers

Inherited from ParserUtilities

Inherited from PackratParsers

Inherited from RegexParsers

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped