Trait

laika.parse.markup

RecursiveParsers

Related Doc: package markup

Permalink

trait RecursiveParsers extends RecursiveSpanParsers

Provides parsers for nested blocks, custom block parser implementations can use these without knowing the available span types of the host markup language.

Includes the support for nested spans and escaped text.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecursiveParsers
  2. RecursiveSpanParsers
  3. EscapedTextParsers
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def delimitedRecursiveSpans(textParser: DelimitedText[String], additionalSpanParsers: ⇒ Map[Char, Parser[Span]]): Parser[List[Span]]

    Permalink

    Lifts the specified text parser to parse the string result as a sequence of spans.

    Lifts the specified text parser to parse the string result as a sequence of spans. Adds the specified additional parsers to the span parsers of the host markup language.

    This type of span parser is usually used in inline parsers, that need to process inline markup for a span with a delimiter while supporting nested spans.

    Definition Classes
    RecursiveSpanParsers
  2. abstract def delimitedRecursiveSpans(textParser: DelimitedText[String]): Parser[List[Span]]

    Permalink

    Lifts the specified text parser to parse the string result as a sequence of spans.

    Lifts the specified text parser to parse the string result as a sequence of spans.

    This type of span parser is usually used in inline parsers, that need to process inline markup for a span with a delimiter while supporting nested spans.

    Definition Classes
    RecursiveSpanParsers
  3. abstract def escapedChar: Parser[String]

    Permalink

    Parses the character after the one that started the escape sequence (usually a backslash).

    Parses the character after the one that started the escape sequence (usually a backslash).

    Definition Classes
    EscapedTextParsers
  4. abstract def escapedText(p: DelimitedText[String]): Parser[String]

    Permalink

    Adds support for escape sequences to the specified text parser.

    Adds support for escape sequences to the specified text parser.

    Definition Classes
    EscapedTextParsers
  5. abstract def escapedUntil(char: Char*): Parser[String]

    Permalink

    Parses a span of text until one of the specified characters is seen (unless it is escaped), while also processing escaped characters, but no other nested spans.

    Parses a span of text until one of the specified characters is seen (unless it is escaped), while also processing escaped characters, but no other nested spans. The final character is not included in the result.

    char

    the character(s) that signals the end of the text span

    returns

    a parser for a text span that supports escape sequences

    Definition Classes
    EscapedTextParsers
  6. abstract def recursiveBlocks(p: Parser[String]): Parser[Seq[Block]]

    Permalink

    Lifts the specified text parser to parse the string result as a sequence of blocks.

    Lifts the specified text parser to parse the string result as a sequence of blocks.

    This type of span parser is usually used in block parsers, that support the nesting of other blocks.

  7. abstract def recursiveSpans: Parser[List[Span]]

    Permalink

    Parses the input into a sequence of spans based on the available span types of the host markup language.

    Parses the input into a sequence of spans based on the available span types of the host markup language.

    This parser always parses to the end of the input, therefore is usually applied to the string result of a previous parser invocation.

    Definition Classes
    RecursiveSpanParsers
  8. abstract def recursiveSpans(parser: Parser[String], additionalParsers: ⇒ Map[Char, Parser[Span]] = Map.empty): Parser[List[Span]]

    Permalink

    Lifts the specified text parser to parse the string result as a sequence of spans.

    Lifts the specified text parser to parse the string result as a sequence of spans. Adds the specified additional parsers to the span parsers of the host markup language.

    This type of span parser is usually used in block parsers, that need to process inline markup after the text for the block has been parsed from the input string.

    Definition Classes
    RecursiveSpanParsers
  9. abstract def recursiveSpans(parser: Parser[String]): Parser[List[Span]]

    Permalink

    Lifts the specified text parser to parse the string result as a sequence of spans.

    Lifts the specified text parser to parse the string result as a sequence of spans.

    This type of span parser is usually used in block parsers, that need to process inline markup after the text for the block has been parsed from the input string.

    Definition Classes
    RecursiveSpanParsers
  10. abstract def withRecursiveBlockParser[T](p: Parser[T]): Parser[((String) ⇒ Seq[Block], T)]

    Permalink

    Adds a block parser function to the result of the specified parser.

    Adds a block parser function to the result of the specified parser. The function can be used for any kind of custom block parsing of portions of the result produced by the base parser.

    The parser function never fails, but instead inserts blocks of type InvalidBlock into the result in case of errors.

  11. abstract def withRecursiveSpanParser[T](p: Parser[T]): Parser[((String) ⇒ List[Span], T)]

    Permalink

    Adds a span parser function to the result of the specified parser.

    Adds a span parser function to the result of the specified parser. The function can be used for any kind of custom span parsing of portions of the result produced by the base parser.

    The parser function never fails, but instead inserts spans of type InvalidSpan into the result in case of errors.

    Definition Classes
    RecursiveSpanParsers

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from RecursiveSpanParsers

Inherited from EscapedTextParsers

Inherited from AnyRef

Inherited from Any

Ungrouped