Object

laika.rst

BlockParsers

Related Doc: package rst

Permalink

object BlockParsers

Provides the parsers for all types of block-level elements of reStructuredText. It merges the individual traits that provide implementations for list, tables, etc. and adds the remaining block level parsers that do not fit into any of the subcategories supported by the other traits.

Block parsers are only concerned with splitting the document into (potentially nested) blocks. They are used in the first phase of parsing, while delegating to inline parsers for the 2nd phase.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BlockParsers
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. lazy val blockQuote: BlockParserBuilder

    Permalink

    Parses a block quote with an optional attribution.

    Parses a block quote with an optional attribution.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#block-quotes

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def createBlockListParser(blockParser: Parser[Block]): Parser[Seq[Block]]

    Permalink

    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.

    Adds the processing required for cases where a block has influence on the parsing or processing of the subsequent block.

    This includes checking each Paragraph for a double colon ending which turns the following block into a literal block as well as processing internal link targets and section headers.

    blockParser

    the parser for a single block element

    returns

    a parser for a list of blocks

  8. val doctest: BlockParserBuilder

    Permalink

    Parses a doctest block.

    Parses a doctest block. This is a feature which is very specific to the world of Python where reStructuredText originates. Therefore the resulting DoctestBlock tree element is not part of the standard Laika AST model. When this block type is used the corresponding special renderers must be enabled (e.g. the ExtendedHTMLRenderer renderer for HTML).

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#doctest-blocks

  9. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  14. lazy val headerWithOverline: BlockParserBuilder

    Permalink

    Parses a section header with both overline and underline.

    Parses a section header with both overline and underline.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#sections.

  15. lazy val headerWithUnderline: BlockParserBuilder

    Permalink

    Parses a section header with an underline, but no overline.

    Parses a section header with an underline, but no overline.

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#sections.

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. val literalBlock: Parser[Block]

    Permalink

    Parses a literal block, either quoted or indented.

    Parses a literal block, either quoted or indented. Only used when the preceding block ends with a double colon (::).

    See http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#literal-blocks

  18. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  21. lazy val paragraph: BlockParserBuilder

    Permalink

    Parses a single paragraph.

    Parses a single paragraph. Everything between two blank lines that is not recognized as a special reStructuredText block type will be parsed as a regular paragraph.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  24. val transition: BlockParserBuilder

    Permalink

    Parses a transition (rule).

  25. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. val ws: Characters[String]

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped