c

laika.parse.markup

RootParser

class RootParser extends DefaultRecursiveParsers

Responsible of assembling all the block, inline, text and configuration parsers supported by a text markup language.

Linear Supertypes
DefaultRecursiveParsers, DefaultRecursiveSpanParsers, DefaultEscapedTextParsers, RecursiveParsers, RecursiveSpanParsers, EscapedTextParsers, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RootParser
  2. DefaultRecursiveParsers
  3. DefaultRecursiveSpanParsers
  4. DefaultEscapedTextParsers
  5. RecursiveParsers
  6. RecursiveSpanParsers
  7. EscapedTextParsers
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RootParser(markupParser: MarkupFormat, markupExtensions: MarkupExtensions)

Type Members

  1. class RecursiveSpanParserDelegate extends RecursiveSpanParser
    Attributes
    protected
    Definition Classes
    DefaultRecursiveSpanParsers

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def blockList(p: ⇒ Parser[Block]): Parser[Seq[Block]]

    Builds a parser for a list of blocks based on the parser for a single block.

    Builds a parser for a list of blocks based on the parser for a single block.

    Definition Classes
    RootParser → DefaultRecursiveParsers
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. lazy val defaultSpanParser: InlineParser[Span, List[Span]]
    Attributes
    protected
    Definition Classes
    DefaultRecursiveSpanParsers
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. lazy val escapeSequence: PrefixedParser[String]

    Parses an escape sequence (usually a backslash followed by a single char).

    Parses an escape sequence (usually a backslash followed by a single char). The characters allowed in an escape sequence might differ between markup languages, therefore custom parser implementations should use this parser as it is always configured correctly for the current host language.

    Definition Classes
    DefaultEscapedTextParsers → EscapedTextParsers
  11. lazy val escapedChar: Parser[String]

    Parses a single escape character.

    Parses a single escape character. In the default implementation any character can be escaped. Sub-traits may override this parser to restrict the number of escapable characters.

    Definition Classes
    RootParser → DefaultEscapedTextParsers
  12. def escapedText(p: DelimitedText): Parser[String]

    Adds support for escape sequences to the specified text parser.

    Adds support for escape sequences to the specified text parser.

    p

    the parser to add support for escape sequences to

    returns

    a parser for a text span that supports escape sequences

    Definition Classes
    DefaultEscapedTextParsers → EscapedTextParsers
  13. def escapedUntil(char: Char, chars: Char*): Parser[String]

    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.

    Definition Classes
    DefaultEscapedTextParsers → EscapedTextParsers
  14. lazy val fallbackBlock: Parser[Block]

    Parses blocks, excluding blocks that allow nesting.

    Parses blocks, excluding blocks that allow nesting. Only used in rare cases when the maximum nest level allowed had been reached

    Attributes
    protected
    Definition Classes
    RootParser → DefaultRecursiveParsers
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def getSyntaxHighlighter(language: String): Option[RecursiveSpanParser]

    Provides the syntax highlighter for the specified language if present.

    Provides the syntax highlighter for the specified language if present.

    Definition Classes
    RootParser → RecursiveSpanParsers
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val maxNestLevel: Int

    The maximum level of block nesting.

    The maximum level of block nesting. Some block types like lists and blockquotes contain nested blocks. To protect against malicious input or accidentally broken markup, the level of nesting is restricted.

    Definition Classes
    DefaultRecursiveParsers
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. lazy val nestedBlock: Parser[Block]

    Parses any kind of nested block supported by a concrete markup language.

    Parses any kind of nested block supported by a concrete markup language.

    Attributes
    protected
    Definition Classes
    RootParser → DefaultRecursiveParsers
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def paragraphInterruptions(position: BlockPosition = BlockPosition.Any): Parser[Block]

    Provides a test for the start of each line in plain paragraphs that indicates whether the line might be the start of a block that is allowed to interrupt paragraphs.

    Provides a test for the start of each line in plain paragraphs that indicates whether the line might be the start of a block that is allowed to interrupt paragraphs.

    Usually this is only supposed to be used by implementations of a base paragraph parser for a markup language, not by custom extensions.

    If the parser returned by this function succeeds the result is the block that interrupts the paragraph, if it fails normal paragraph parsing should resume.

    Definition Classes
    RootParser → RecursiveParsers
  25. def recursiveBlocks: RecursiveBlockParser

    Parses the input into a sequence of blocks based on the available block types of the host markup language.

    Parses the input into a sequence of blocks based on the available block types of the host markup language.

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

    Definition Classes
    DefaultRecursiveParsers → RecursiveParsers
  26. def recursiveBlocks(p: Parser[BlockSource]): Parser[Seq[Block]]

    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.

    Definition Classes
    DefaultRecursiveParsers → RecursiveParsers
  27. def recursiveSpans: RecursiveSpanParser

    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 it is usually applied to the result of a previous parser invocation.

    Definition Classes
    DefaultRecursiveSpanParsers → RecursiveSpanParsers
  28. def recursiveSpans(parser: Parser[SourceFragment]): InlineParser[Span, List[Span]]

    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 either used in block parsers, that need to process inline markup after the text for the block has been parsed from the input string or for inline parsers, that need to process inline markup for a span with a delimiter while supporting nested spans.

    In the latter case the passed parser is usually of type DelimitedText which is an optimized parser that parses text and recursive spans in one pass. For other kinds of parsers the resulting parser will be a two-pass parser.

    The returned parser allows to register parsers for child spans with its embed method for parsing types of child spans in addition to the available span types of the host markup language

    Definition Classes
    DefaultRecursiveSpanParsers → RecursiveSpanParsers
  29. def recursiveSpans(p: DelimitedText): InlineParser[Span, List[Span]]

    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 either used in block parsers, that need to process inline markup after the text for the block has been parsed from the input string or for inline parsers, that need to process inline markup for a span with a delimiter while supporting nested spans.

    In the latter case the passed parser is usually of type DelimitedText which is an optimized parser that parses text and recursive spans in one pass. For other kinds of parsers the resulting parser will be a two-pass parser.

    The returned parser allows to register parsers for child spans with its embed method for parsing types of child spans in addition to the available span types of the host markup language

    Definition Classes
    DefaultRecursiveSpanParsers → RecursiveSpanParsers
  30. lazy val rootBlock: Parser[Block]

    Parses any kind of top-level block supported by a concrete markup language.

    Parses any kind of top-level block supported by a concrete markup language.

    Attributes
    protected
    Definition Classes
    RootParser → DefaultRecursiveParsers
  31. lazy val rootElement: Parser[RootElement]

    Parses a full document, delegating most of the work to the topLevelBlock parser.

  32. lazy val spanParsers: Seq[PrefixedParser[Span]]

    All default span parsers registered for a host markup language.

    All default span parsers registered for a host markup language.

    Attributes
    protected
    Definition Classes
    RootParser → DefaultRecursiveSpanParsers
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    AnyRef → Any
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from DefaultRecursiveParsers

Inherited from DefaultRecursiveSpanParsers

Inherited from DefaultEscapedTextParsers

Inherited from RecursiveParsers

Inherited from RecursiveSpanParsers

Inherited from EscapedTextParsers

Inherited from AnyRef

Inherited from Any

Ungrouped