Packages

trait TextParsers extends Parsers

Base text parsers that provide optimized low-level parsers for typical requirements of text markup parsers. In particular they are meant as an efficient replacement for scenarios where usually regex parsers are used. In cases where different parsers need to be tried for relatively short input sequences, regex parsers tend to be less efficient. Furthermore, these base parsers may also improve readability, as it allows to combine simple low-level parsers to higher-level parsers based on the Laika combinator API, instead of producing long regexes which may be hard to read.

Linear Supertypes
Parsers, AnyRef, Any
Known Subclasses
builders, TextParsers
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextParsers
  2. Parsers
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class ParserException(result: Failure) extends RuntimeException with Product with Serializable
    Definition Classes
    Parsers
  2. implicit class TryOps[A] extends AnyRef

    Provides additional methods to Try via implicit conversion.

    Provides additional methods to Try via implicit conversion.

    Definition Classes
    Parsers

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. val anyChars: Characters[String]

    Consumes any kind of input, always succeeds.

    Consumes any kind of input, always succeeds. This parser would consume the entire input unless a max constraint is specified.

  5. def anyNot(chars: NonEmptySet[Char]): Characters[String]

    Consumes any number of consecutive occurrences that are not one of the specified characters.

    Consumes any number of consecutive occurrences that are not one of the specified characters. Always succeeds unless a minimum number of required matches is specified.

  6. def anyNot(char: Char, chars: Char*): Characters[String]

    Consumes any number of consecutive characters that are not one of the specified characters.

    Consumes any number of consecutive characters that are not one of the specified characters. Always succeeds unless a minimum number of required matches is specified.

  7. def anyOf(chars: NonEmptySet[Char]): Characters[String]

    Consumes any number of consecutive occurrences of the specified characters.

    Consumes any number of consecutive occurrences of the specified characters. Always succeeds unless a minimum number of required matches is specified.

  8. def anyOf(char: Char, chars: Char*): Characters[String]

    Consumes any number of consecutive occurrences of the specified characters.

    Consumes any number of consecutive occurrences of the specified characters. Always succeeds unless a minimum number of required matches is specified.

  9. def anyWhile(p: (Char) ⇒ Boolean): Characters[String]

    Consumes any number of consecutive characters which satisfy the specified predicate.

    Consumes any number of consecutive characters which satisfy the specified predicate. Always succeeds unless a minimum number of required matches is specified.

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. val atStart: Parser[Unit]

    Succeeds at the start of the input.

  12. val blankLine: Parser[String]

    Parses a blank line from the current input offset (which may not be at the start of the line).

    Parses a blank line from the current input offset (which may not be at the start of the line). Fails for lines that contain any non-whitespace character. Does always produce an empty string as the result, discarding any whitespace characters found in the line.

    Since it also succeeds at the end of the input it should never be used in the form of (blankLine *) or (blankLine +). Use the blankLines parser instead in these cases.

  13. val blankLines: Parser[List[String]]

    Parses one or more blank lines, producing a list of empty strings corresponding to the number of blank lines consumed.

  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  15. def consumeAll[T](p: Parser[T]): Parser[T]

    A parser that succeeds if the specified parser succeeds and all input has been consumed.

    A parser that succeeds if the specified parser succeeds and all input has been consumed.

    Definition Classes
    Parsers
  16. def delimitedBy(delimiter: PrefixedParser[String]): DelimitedText

    Consumes any number of consecutive characters until the specified delimiter parser succeeds on the input.

    Consumes any number of consecutive characters until the specified delimiter parser succeeds on the input.

    This constructor is limited to the sub-trait PrefixedParser as only those can be optimized for an assertion that needs to be performed on each character. Most parsers for non-empty text implement this trait, e.g oneOf, someOf, delimiter or the literal parsers for a character or string.

  17. def delimitedBy(str: String): DelimitedText

    Consumes any number of consecutive characters until the specified string delimiter is encountered on the input string.

  18. def delimitedBy(chars: NonEmptySet[Char]): DelimitedText

    Consumes any number of consecutive characters until one of the specified characters is encountered on the input string.

  19. def delimitedBy(char: Char, chars: Char*): DelimitedText

    Consumes any number of consecutive characters until one of the specified characters is encountered on the input string.

  20. def delimiter(parser: PrefixedParser[String]): DelimiterParser

    Creates a parser for a delimiter with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

    Creates a parser for a delimiter with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

    This specified underlying parser needs to implement the sub-trait PrefixedParser as only those can be optimized for an assertion that needs to be performed on each character. Most parsers for non-empty text implement this trait, e.g oneOf, someOf, delimiter or the literal parsers for a character or string.

  21. def delimiter(delim: String): DelimiterParser

    Creates a parser for a delimiter based on a literal string with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

  22. def delimiter(char: Char, chars: Char*): DelimiterParser

    Creates a parser for a delimiter based on the given set of delimiter characters with an API that allows to specify predicates for the characters immediately preceding or following the delimiter, a common task in markup parsing.

  23. val eof: Parser[String]

    Succeeds at the end of the input.

  24. val eol: Parser[Unit]

    Succeeds at the end of a line, including the end of the input.

    Succeeds at the end of a line, including the end of the input. Produces an empty string as a result and consumes any new line characters.

  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def failure(msg: String): Parser[Nothing]

    A parser that always fails with the specified message.

    A parser that always fails with the specified message.

    Definition Classes
    Parsers
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def lazily[T](p: ⇒ Parser[T]): Parser[T]

    Constructs a parser lazily, useful when breaking circles in recursive parsing.

    Constructs a parser lazily, useful when breaking circles in recursive parsing.

    Definition Classes
    Parsers
  33. def literal(expected: String): PrefixedParser[String]

    A parser that matches only the specified literal string.

    A parser that matches only the specified literal string.

    The method is implicit so that strings can automatically be lifted to their parsers.

  34. def lookAhead(offset: Int, value: String): Parser[String]

    Attempts to parse the specified literal value at the specified offset behind the current position.

    Attempts to parse the specified literal value at the specified offset behind the current position. Never consumes any input.

    Definition Classes
    Parsers
  35. def lookAhead[T](offset: Int, p: Parser[T]): Parser[T]

    Applies the specified parser at the specified offset behind the current position.

    Applies the specified parser at the specified offset behind the current position. Never consumes any input.

    Definition Classes
    Parsers
  36. def lookAhead(value: String): Parser[String]

    Attempts to parse the specified literal value at the current position.

    Attempts to parse the specified literal value at the current position. Never consumes any input.

    Definition Classes
    Parsers
  37. def lookAhead[T](p: Parser[T]): Parser[T]

    Applies the specified parser at the current position.

    Applies the specified parser at the current position. Never consumes any input.

    Definition Classes
    Parsers
  38. def lookBehind[T](offset: Int, parser: ⇒ Parser[T]): Parser[T]

    Applies the specified parser at the specified offset behind the current position.

    Applies the specified parser at the specified offset behind the current position. Never consumes any input.

    Definition Classes
    Parsers
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def nextIn(chars: NonEmptySet[Char]): Parser[Unit]

    Verifies that the next character is one of those specified.

    Verifies that the next character is one of those specified. Fails at the end of the input and does not consume any input or produce a result when it succeeds.

  41. def nextIn(char: Char, chars: Char*): Parser[Unit]

    Verifies that the next character is one of those specified.

    Verifies that the next character is one of those specified. Fails at the end of the input and does not consume any input or produce a result when it succeeds.

  42. def nextIs(predicate: (Char) ⇒ Boolean): Parser[Unit]

    Verifies that the next character does not satisfy the specified predicate.

    Verifies that the next character does not satisfy the specified predicate. Fails at the end of the input and does not consume any input or produce a result when it succeeds.

  43. def nextNot(predicate: (Char) ⇒ Boolean): Parser[Unit]

    Verifies that the next character does not satisfy the specified predicate.

    Verifies that the next character does not satisfy the specified predicate. Succeeds at the end of the input and does not consume any input or produce a result when it succeeds.

  44. def nextNot(chars: NonEmptySet[Char]): Parser[Unit]

    Verifies that the next character is not one of those specified.

    Verifies that the next character is not one of those specified. Succeeds at the end of the input and does not consume any input or produce a result when it succeeds.

  45. def nextNot(char: Char, chars: Char*): Parser[Unit]

    Verifies that the next character is not one of those specified.

    Verifies that the next character is not one of those specified. Succeeds at the end of the input and does not consume any input or produce a result when it succeeds.

  46. def not(value: String): Parser[Unit]

    A parser that only succeeds if the parsing the specified literal value fails and vice versa, it never consumes any input.

    A parser that only succeeds if the parsing the specified literal value fails and vice versa, it never consumes any input.

    Definition Classes
    Parsers
  47. def not[T](p: Parser[T]): Parser[Unit]

    A parser that only succeeds if the specified parser fails and vice versa, it never consumes any input.

    A parser that only succeeds if the specified parser fails and vice versa, it never consumes any input.

    Definition Classes
    Parsers
  48. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  49. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. val oneChar: Parser[String]

    Parses exactly one character from the input, fails only at the end of the input.

  51. def oneIf(p: (Char) ⇒ Boolean): Parser[String]

    Consumes one character if it satisfies the specified predicate, fails otherwise.

  52. def oneNot(chars: NonEmptySet[Char]): Parser[String]

    Consumes one character if it is not one of the specified characters.

  53. def oneNot(char: Char, chars: Char*): Parser[String]

    Consumes one character if it is not one of the specified characters.

  54. def oneOf(chars: NonEmptySet[Char]): PrefixedParser[String]

    Consumes one character if it matches one of the specified characters, fails otherwise.

  55. def oneOf(char: Char, chars: Char*): PrefixedParser[String]

    Consumes one character if it matches one of the specified characters, fails otherwise.

  56. def opt(value: String): Parser[Option[String]]

    A parser for an optional literal string that always succeeds.

    A parser for an optional literal string that always succeeds.

    If the underlying parser succeeds this parser will contain its result as a Some, if it fails this parser will succeed with a None.

    Definition Classes
    Parsers
  57. def opt[T](p: Parser[T]): Parser[Option[T]]

    A parser for an optional element that always succeeds.

    A parser for an optional element that always succeeds.

    If the underlying parser succeeds this parser will contain its result as a Some, if it fails this parser will succeed with a None.

    Definition Classes
    Parsers
  58. def prevIn(chars: NonEmptySet[Char]): Parser[Unit]

    Verifies that the previous character is one of those specified.

    Verifies that the previous character is one of those specified. Fails at the start of the input and does not consume any input or produce a result when it succeeds.

  59. def prevIn(char: Char, chars: Char*): Parser[Unit]

    Verifies that the previous character is one of those specified.

    Verifies that the previous character is one of those specified. Fails at the start of the input and does not consume any input or produce a result when it succeeds.

  60. def prevIs(predicate: (Char) ⇒ Boolean): Parser[Unit]

    Verifies that the previous character satisfies the specified predicate.

    Verifies that the previous character satisfies the specified predicate. Fails at the start of the input and does not consume any input or produce a result when it succeeds.

  61. def prevNot(predicate: (Char) ⇒ Boolean): Parser[Unit]

    Verifies that the previous character does not satisfy the specified predicate.

    Verifies that the previous character does not satisfy the specified predicate. Succeeds at the start of the input and does not consume any input or produce a result when it succeeds.

  62. def prevNot(chars: NonEmptySet[Char]): Parser[Unit]

    Verifies that the previous character is not one of those specified.

    Verifies that the previous character is not one of those specified. Succeeds at the start of the input and does not consume any input or produce a result when it succeeds.

  63. def prevNot(char: Char, chars: Char*): Parser[Unit]

    Verifies that the previous character is not one of those specified.

    Verifies that the previous character is not one of those specified. Succeeds at the start of the input and does not consume any input or produce a result when it succeeds.

  64. def range(fromChar: Char, toChar: Char): NonEmptySet[Char]

    Creates a NonEmptySet from a Character range.

    Creates a NonEmptySet from a Character range. This set can then be passed to parsers like anyOf or oneOf which expect a NonEmptySet as a parameter.

  65. val restOfLine: Parser[String]

    Parses the rest of the line from the current input offset no matter whether it consist of whitespace only or some text.

    Parses the rest of the line from the current input offset no matter whether it consist of whitespace only or some text. Does not include the eol character(s).

  66. def someNot(chars: NonEmptySet[Char]): Characters[String]

    Consumes one or more characters that are not one of the specified characters, fails for empty results.

  67. def someNot(char: Char, chars: Char*): Characters[String]

    Consumes one or more characters that are not one of the specified characters, fails for empty results.

  68. def someOf(chars: NonEmptySet[Char]): PrefixCharacters[String]

    Consumes one or more characters if they match one of the specified characters, fails if the first character does not match.

  69. def someOf(char: Char, chars: Char*): PrefixCharacters[String]

    Consumes one or more characters if they match one of the specified characters, fails if the first character does not match.

  70. def someWhile(p: (Char) ⇒ Boolean): Characters[String]

    Consumes one or more characters which satisfy the specified predicate, fails for empty results.

  71. def success[T](v: T): Parser[T]

    A parser that always succeeds with the specified value.

    A parser that always succeeds with the specified value.

    Definition Classes
    Parsers
  72. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  73. val textLine: Parser[String]

    Parses a single text line from the current input offset (which may not be at the start of the line).

    Parses a single text line from the current input offset (which may not be at the start of the line). Fails for blank lines. Does not include the eol character(s).

  74. def toString(): String
    Definition Classes
    AnyRef → Any
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  78. lazy val ws: Characters[String]

    Parses horizontal whitespace (space and tab).

    Parses horizontal whitespace (space and tab). Always succeeds, consuming all whitespace found.

  79. val wsEol: Parser[Unit]

    Parses any number of whitespace characters followed by a newline character.

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped