Object

laika.markdown

InlineParsers

Related Doc: package markdown

Permalink

object InlineParsers

Provides all inline parsers for Markdown text except for those dealing with verbatim HTML markup which this library treats as an optional feature that has to be explicitly mixed in.

Inline parsers deal with markup within a block of text, such as a link or emphasized text. They are used in the second phase of parsing, after the block parsers have cut the document into a (potentially nested) block structure.

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

Type Members

  1. type RecParser = (String) ⇒ List[Span]

    Permalink

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. def em(char: Char)(implicit recParsers: RecursiveSpanParsers): Parser[Emphasized]

    Permalink

    Parses a span of emphasized text enclosed by one occurrence of the specified character.

  7. val enclosedByAsterisk: SpanParserBuilder

    Permalink

    Parses either strong spans enclosed in double asterisks or emphasized spans enclosed in single asterisks.

  8. def enclosedByDoubleChar(c: Char)(implicit recParsers: RecursiveSpanParsers): Parser[List[Span]]

    Permalink

    Parses a span enclosed by two consecutive occurrences of the specified character.

    Parses a span enclosed by two consecutive occurrences of the specified character. Recursively parses nested spans, too.

  9. def enclosedBySingleChar(c: Char)(implicit recParsers: RecursiveSpanParsers): Parser[List[Span]]

    Permalink

    Parses a span enclosed by a single occurrence of the specified character.

    Parses a span enclosed by a single occurrence of the specified character. Recursively parses nested spans, too.

  10. val enclosedByUnderscore: SpanParserBuilder

    Permalink

    Parses either strong spans enclosed in double underscores or emphasized spans enclosed in single underscores.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. val escapedChar: Parser[String]

    Permalink

    Parses a single escaped character, only recognizing the characters the Markdown syntax document specifies as escapable.

    Parses a single escaped character, only recognizing the characters the Markdown syntax document specifies as escapable.

    Note: escaping > is not mandated by the official syntax description, but by the official test suite.

  14. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. val image: SpanParserBuilder

    Permalink

    Parses an inline image.

    Parses an inline image. Recognizes both, an inline image ![text](url) and an image reference ![text][id].

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. val lineBreak: SpanParserBuilder

    Permalink

    Parses an explicit hard line break.

  20. lazy val link: SpanParserBuilder

    Permalink

    Parses a link, including nested spans in the link text.

    Parses a link, including nested spans in the link text. Recognizes both, an inline link [text](url) and a link reference [text][id].

  21. val literalEnclosedByDoubleChar: Parser[Literal]

    Permalink

    Parses a literal span enclosed by double backticks.

    Parses a literal span enclosed by double backticks. Does neither parse nested spans nor Markdown escapes.

  22. val literalEnclosedBySingleChar: Parser[Literal]

    Permalink

    Parses a literal span enclosed by a single backtick.

    Parses a literal span enclosed by a single backtick. Does neither parse nested spans nor Markdown escapes.

  23. val literalSpan: SpanParserBuilder

    Permalink

    Parses a literal span enclosed by double or single backticks.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  27. def resource(inline: (RecParser, String, String, Option[String]) ⇒ Span, ref: (RecParser, String, String, String) ⇒ Span, recParsers: RecursiveSpanParsers): Parser[Span]

    Permalink

    Helper function that abstracts the common parser logic of links and images.

    Helper function that abstracts the common parser logic of links and images.

    inline

    factory function for creating a new inline link or image based on the text, url and optional title parameters

    ref

    factory function for creating a new link or image reference based on the text and id parameters

  28. val simpleLink: SpanParserBuilder

    Permalink

    Parses a simple inline link in the form of <http://someURL/>

  29. def span(start: Parser[Any], endDelim: String, postCondition: Parser[Any])(implicit recParsers: RecursiveSpanParsers): Parser[List[Span]]

    Permalink

    Creates a parser for an inline span based on the specified parsers that represent the start and end condition.

    Creates a parser for an inline span based on the specified parsers that represent the start and end condition.

    start

    the parser that parses the beginning of the span, result will be discarded

    endDelim

    the end delimiter of the span

    postCondition

    the parser that checks any post conditions after the end delimiter has been read

  30. def strong(char: Char)(implicit recParsers: RecursiveSpanParsers): Parser[Strong]

    Permalink

    Parses a span of strong text enclosed by two consecutive occurrences of the specified character.

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped