Object

laika.markdown

BlockParsers

Related Doc: package markdown

Permalink

object BlockParsers

Provides all block parsers for Markdown text except for for lists which are factored out into a separate parser object and those blocks dealing with verbatim HTML markup which this library treats as an optional feature that has to be explicitly mixed in.

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

    Permalink

    Parses an ATX header, a line that starts with 1 to 6 '#' characters, with the number of hash characters corresponding to the level of the header.

    Parses an ATX header, a line that starts with 1 to 6 '#' characters, with the number of hash characters corresponding to the level of the header. Markdown also allows to decorate the line with trailing '#' characters which this parser will remove.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def decoratedBlock(firstLinePrefix: Parser[Any], linePrefix: Parser[Any], nextBlockPrefix: Parser[Any]): Parser[String]

    Permalink

    Parses a single Markdown block.

    Parses a single Markdown block. In contrast to the mdBlock parser this method also verifies that the second line is not a setext header decoration.

    firstLinePrefix

    parser that recognizes the start of the first line of this block

    linePrefix

    parser that recognizes the start of subsequent lines that still belong to the same block

    nextBlockPrefix

    parser that recognizes whether a line after one or more blank lines still belongs to the same block

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. val fallbackParagraph: BlockParserBuilder

    Permalink

    Parses just a plain paragraph after the maximum nest level has been reached.

    Parses just a plain paragraph after the maximum nest level has been reached. This is necessary as a separate parser as the default markdown paragraph parser is combined with potentially nested lists which makes that parser recursive.

  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. val insignificantSpaces: Parser[Unit]

    Permalink

    Parses up to 3 space characters.

    Parses up to 3 space characters. In Markdown an indentation of up to 3 spaces is optional and does not have any influence on the parsing logic.

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. val linkTarget: BlockParserBuilder

    Permalink

    Parses a link definition in the form [id]: <url> "title".

    Parses a link definition in the form [id]: <url> "title". The title is optional as well as the quotes around it and the angle brackets around the url.

  17. val literalBlocks: Seq[BlockParserBuilder]

    Permalink

    Parses a literal block, text indented by a tab or 4 spaces.

  18. def mdBlock(firstLinePrefix: Parser[Any], linePrefix: Parser[Any], nextBlockPrefix: Parser[Any]): Parser[String]

    Permalink

    Parses a single Markdown block.

    Parses a single Markdown block. In contrast to the generic block parser of the generic block parsers this method also consumes and ignores up to three optional space characters at the start of each line.

    firstLinePrefix

    parser that recognizes the start of the first line of this block

    linePrefix

    parser that recognizes the start of subsequent lines that still belong to the same block

    nextBlockPrefix

    parser that recognizes whether a line after one or more blank lines still belongs to the same block

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

    Permalink
    Definition Classes
    AnyRef
  20. lazy val nestedHeaderOrParagraph: BlockParserBuilder

    Permalink

    Parses either a setext header, or a plain paragraph if the second line of the block is not a setext header decoration.

    Parses either a setext header, or a plain paragraph if the second line of the block is not a setext header decoration. Only used for nested blocks where lists starting in the middle of a paragraph are allowed.

  21. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  23. val quotedBlock: BlockParserBuilder

    Permalink

    Parses a quoted block, a paragraph starting with a '>' character, with subsequent lines optionally starting with a '>', too.

  24. lazy val rootHeaderOrParagraph: BlockParserBuilder

    Permalink

    Parses either a setext header, or a plain paragraph if the second line of the block is not a setext header decoration.

    Parses either a setext header, or a plain paragraph if the second line of the block is not a setext header decoration. Only used for root level blocks where lists starting in the middle of a paragraph are not allowed.

  25. val rules: Seq[BlockParserBuilder]

    Permalink

    Parses a horizontal rule, a line only decorated with three or more '*', '-' or '_' characters with optional spaces between them

  26. val setextDecoration: Parser[String]

    Permalink

    Parses the decoration (underline) of a setext header.

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

    Permalink
    Definition Classes
    AnyRef
  28. val tabOrSpace: Parser[Unit]

    Permalink

    Parses a single tab or space character.

  29. def toString(): String

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped