Packages

sealed abstract class MarkdownBlock extends InlineParsers

A markdown block element.

Linear Supertypes
InlineParsers, BaseParsers, RegexParsers, Parsers, AnyRef, Any
Known Subclasses
Blockquote, CodeBlock, FencedCodeBlock, Header, ListBlock, OList, Paragraph, Ruler, UList, VerbatimXml
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MarkdownBlock
  2. InlineParsers
  3. BaseParsers
  4. RegexParsers
  5. Parsers
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Elem = Char
    Definition Classes
    RegexParsers → Parsers
  2. case class Error extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  3. case class Failure extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  4. type Input = Reader[Elem]
    Definition Classes
    Parsers
  5. type LinkMap = Map[String, LinkDefinition]

    Defines a lookup map for link definitions.

    Defines a lookup map for link definitions.

    Definition Classes
    InlineParsers
  6. sealed abstract class NoSuccess extends ParseResult[Nothing]
    Definition Classes
    Parsers
  7. trait OnceParser[+T] extends Parser[T]
    Definition Classes
    Parsers
  8. sealed abstract class ParseResult[+T] extends AnyRef
    Definition Classes
    Parsers
  9. abstract class Parser[+T] extends (Input) => ParseResult[T]
    Definition Classes
    Parsers
  10. case class Success[+T] extends ParseResult[T] with Product with Serializable
    Definition Classes
    Parsers
  11. type VisitedTags = Set[String]

    A set of tags we have already created.

    A set of tags we have already created. Used to prevent nesting a link in a link or an emphasis in an emphasis.

    Definition Classes
    InlineParsers
  12. case class ~[+a, +b] extends Product with Serializable
    Definition Classes
    Parsers
  13. case class InlineContext(map: LinkMap, tags: VisitedTags) extends Product with Serializable

    Keeps track of visited tags and provides a lookup for link ids.

    Keeps track of visited tags and provides a lookup for link ids.

    Definition Classes
    InlineParsers

Abstract Value Members

  1. abstract def addResult(level: Int, out: StringBuilder): Unit

    adds the resulting xhtml snippet to the given string builder

Concrete 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. def OnceParser[T](f: (Input) => ParseResult[T]): Parser[T] with OnceParser[T]
    Definition Classes
    Parsers
  5. def Parser[T](f: (Input) => ParseResult[T]): Parser[T]
    Definition Classes
    Parsers
  6. def aChar: Parser[String]
    Definition Classes
    BaseParsers
  7. def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]
    Definition Classes
    Parsers
  8. def accept[ES](es: ES)(implicit f: (ES) => List[Elem]): Parser[List[Elem]]
    Definition Classes
    Parsers
  9. implicit def accept(e: Elem): Parser[Elem]
    Definition Classes
    Parsers
  10. def acceptIf(p: (Elem) => Boolean)(err: (Elem) => String): Parser[Elem]
    Definition Classes
    Parsers
  11. def acceptMatch[S, T](f: PartialFunction[S, T])(p: Parser[S]): Parser[T]

    Succeeds if the given parsers succeeds and the given function is defined at the parse result.

    Succeeds if the given parsers succeeds and the given function is defined at the parse result. Returns the result of the method applied to the given parsers result.

    Definition Classes
    BaseParsers
  12. def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]
    Definition Classes
    Parsers
  13. def acceptSeq[ES](es: ES)(implicit f: (ES) => Iterable[Elem]): Parser[List[Elem]]
    Definition Classes
    Parsers
  14. def any: Parser[String]

    Matches exactly one char, no matter which.

    Matches exactly one char, no matter which. This differs from "elem" as it returns a string consisting of that char.

    Definition Classes
    BaseParsers
  15. def apply[T](p: Parser[T], in: String): T

    Runs the given parser on the given input.

    Runs the given parser on the given input. Expects the parser to succeed and consume all input. Throws an IllegalArgumentException if parsing failed.

    Definition Classes
    BaseParsers
  16. def applyInline(s: String, m: LinkMap): String

    Runs the inline parser on the given input and returns the result

    Runs the inline parser on the given input and returns the result

    Definition Classes
    InlineParsers
  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. val br: Parser[String]

    Parses two spaces at the end of a line to a manual break (
    )

    Parses two spaces at the end of a line to a manual break (
    )

    Definition Classes
    InlineParsers
  19. def chainl1[T, U](first: => Parser[T], p: => Parser[U], q: => Parser[(T, U) => T]): Parser[T]
    Definition Classes
    Parsers
  20. def chainl1[T](p: => Parser[T], q: => Parser[(T, T) => T]): Parser[T]
    Definition Classes
    Parsers
  21. def chainr1[T, U](p: => Parser[T], q: => Parser[(T, U) => U], combine: (T, U) => U, first: U): Parser[U]
    Definition Classes
    Parsers
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  23. val code: Parser[String]

    Parses an inline code element.

    Parses an inline code element. An inline code element is surrounded by single backticks ("") or double backticks ("").

    Definition Classes
    InlineParsers
  24. def commit[T](p: => Parser[T]): Parser[T]
    Definition Classes
    Parsers
  25. def deco(): Decorator

    Defines how the output is formatted and whether inline xml elements are allowed.

    Defines how the output is formatted and whether inline xml elements are allowed.

    Definition Classes
    MarkdownBlock → InlineParsers
  26. val directImg: Parser[String]

    An image with an explicit path.

    An image with an explicit path.

    Definition Classes
    InlineParsers
  27. def elem(e: Elem): Parser[Elem]
    Definition Classes
    Parsers
  28. def elem(kind: String, p: (Elem) => Boolean): Parser[Elem]
    Definition Classes
    Parsers
  29. def elementParsers(ctx: InlineContext): Parser[String]

    Hand rolled parser that parses a chunk of special inline markdown (like links or emphasis) based on a one char lookahead.

    Hand rolled parser that parses a chunk of special inline markdown (like links or emphasis) based on a one char lookahead.

    Definition Classes
    InlineParsers
  30. def emAsterisk(ctx: InlineContext): Parser[String]

    Parses emphasized text wrapped in asterisks: *foo*

    Parses emphasized text wrapped in asterisks: *foo*

    Definition Classes
    InlineParsers
  31. def emUnderscore(ctx: InlineContext): Parser[String]

    Parses emphasized text wrapped in underscores: _foo_

    Parses emphasized text wrapped in underscores: _foo_

    Definition Classes
    InlineParsers
  32. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  34. def err(msg: String): Parser[Nothing]
    Definition Classes
    Parsers
  35. def escapeFastForXml(c: Char): String

    Either returns the XML escape sequence for the given char or null.

    Either returns the XML escape sequence for the given char or null. This does not return Option[String] on purpose. While Option[String] would be a much cleaner solution, this is actually called so often that it is a noticeable difference if we use Option here.

    Definition Classes
    BaseParsers
  36. def escapeForXml(c: Char): String

    Escapes the given char for XML.

    Escapes the given char for XML. Returns Either the necessary XML escape Sequence or the same char in a String.

    Definition Classes
    BaseParsers
  37. def escapeXml(s: String): String

    Escapes the given string so it it can be embedded in xml.

    Escapes the given string so it it can be embedded in xml. Markdown escapes are not processed.

    Definition Classes
    InlineParsers
  38. def failure(msg: String): Parser[Nothing]
    Definition Classes
    Parsers
  39. def fastLink(ctx: InlineContext): Parser[String]

    A shortcut markdown link of the form <http://example.com>

    A shortcut markdown link of the form <http://example.com>

    Definition Classes
    InlineParsers
  40. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  41. def fullLink(ctx: InlineContext): Parser[String]

    A markdown link with the full url given.

    A markdown link with the full url given.

    Definition Classes
    InlineParsers
  42. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  43. def guard[T](p: => Parser[T]): Parser[T]
    Definition Classes
    Parsers
  44. def handleWhiteSpace(source: CharSequence, offset: Int): Int
    Attributes
    protected
    Definition Classes
    RegexParsers
  45. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  46. def idReference(ctx: InlineContext): Parser[(String, LinkDefinition)]

    Parses an id reference.

    Parses an id reference. (Any text that is not a square bracket) Succeeds only if the parsed id is found in the given lookup. Returns the found link definition and the matched text.

    Definition Classes
    InlineParsers
  47. def img(ctx: InlineContext): Parser[String]

    Parses either a referenced or a directly defined image.

    Parses either a referenced or a directly defined image.

    Definition Classes
    InlineParsers
  48. def inline(m: LinkMap): Parser[String]

    Parser for inline markdown, always consumes all input, returns the resulting HTML.

    Parser for inline markdown, always consumes all input, returns the resulting HTML.

    Definition Classes
    InlineParsers
  49. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  50. def link(ctx: InlineContext): Parser[String]

    A link started by square brackets, either a reference or a a link with the full URL.

    A link started by square brackets, either a reference or a a link with the full URL.

    Definition Classes
    InlineParsers
  51. def linkInline(ctx: InlineContext): Parser[String]

    Inline markdown in a link.

    Inline markdown in a link. Like normal inline stuff but stops when it reaches a closing square bracket.

    Definition Classes
    InlineParsers
  52. implicit def literal(s: String): Parser[String]
    Definition Classes
    RegexParsers
  53. def log[T](p: => Parser[T])(name: String): Parser[T]
    Definition Classes
    Parsers
  54. def lookbehind(cs: Set[Char]): Parser[Unit]

    Looks if the preceding char was one of the given chars.

    Looks if the preceding char was one of the given chars. Never consumes any input.

    Definition Classes
    BaseParsers
  55. def markdownText(special: Set[Char], markdownEscapes: Boolean): Parser[String]

    Parses markdown text up to any of the chars defined in the given map.

    Parses markdown text up to any of the chars defined in the given map. used to quickly escape any text between special inline markdown like emphasis.

    Definition Classes
    InlineParsers
  56. def mkList[T]: (~[T, List[T]]) => List[T]
    Definition Classes
    Parsers
  57. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. def nl: Parser[String]

    Accepts a unix newline and returns a string containing a single newline.

    Accepts a unix newline and returns a string containing a single newline.

    Definition Classes
    BaseParsers
  59. def not[T](p: => Parser[T]): Parser[Unit]
    Definition Classes
    Parsers
  60. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  62. def oneInline(ctx: InlineContext): Parser[String]

    Parses a single inline token.

    Parses a single inline token. Either a span element or a chunk of text.

    Definition Classes
    InlineParsers
  63. def oneOf(lookup: Map[Char, String]): Parser[String]

    Matches one of the given char keys in the map.

    Matches one of the given char keys in the map. Returns the string value for the matched char in the given map.

    Definition Classes
    BaseParsers
  64. def oneOf(lookup: Set[Char]): Parser[String]

    Matches one of the chars in the given set.

    Matches one of the chars in the given set. Returns a string with the matched char.

    Definition Classes
    BaseParsers
  65. def opt[T](p: => Parser[T]): Parser[Option[T]]
    Definition Classes
    Parsers
  66. def ows: Parser[String]

    accepts zero or more spaces or tabs returns the matched whitespace

    accepts zero or more spaces or tabs returns the matched whitespace

    Definition Classes
    BaseParsers
  67. def parse[T](p: Parser[T], in: Reader): ParseResult[T]
    Definition Classes
    RegexParsers
  68. def parse[T](p: Parser[T], in: CharSequence): ParseResult[T]
    Definition Classes
    RegexParsers
  69. def parse[T](p: Parser[T], in: Reader[Char]): ParseResult[T]
    Definition Classes
    RegexParsers
  70. def parseAll[T](p: Parser[T], in: CharSequence): ParseResult[T]
    Definition Classes
    RegexParsers
  71. def parseAll[T](p: Parser[T], in: Reader): ParseResult[T]
    Definition Classes
    RegexParsers
  72. def parseAll[T](p: Parser[T], in: Reader[Char]): ParseResult[T]
    Definition Classes
    RegexParsers
  73. def phrase[T](p: Parser[T]): Parser[T]
    Definition Classes
    RegexParsers → Parsers
  74. def positioned[T <: Positional](p: => Parser[T]): Parser[T]
    Definition Classes
    RegexParsers → Parsers
  75. def range(begin: Char, end: Char): Parser[Char]

    Matches one char in the given range, returns the matched char.

    Matches one char in the given range, returns the matched char.

    Definition Classes
    BaseParsers
  76. def ranges(rs: SortedMap[Char, Char]): Parser[Char]
    Definition Classes
    BaseParsers
  77. def ref(ctx: InlineContext): Parser[(LinkDefinition, String)]

    A markdown reference of the form [text][id], [idText][] or [idText] Parser returns a tuple with the link definition first and the text to display second.

    A markdown reference of the form [text][id], [idText][] or [idText] Parser returns a tuple with the link definition first and the text to display second.

    Definition Classes
    InlineParsers
  78. def refImg(ctx: InlineContext): Parser[String]

    Parses a referenced image.

    Parses a referenced image.

    Definition Classes
    InlineParsers
  79. val refText: Parser[String]

    Plaintext variant to refInline.

    Plaintext variant to refInline. Escapable text until a square bracket is hit.

    Definition Classes
    InlineParsers
  80. def referenceLink(ctx: InlineContext): Parser[String]

    A markdown link which references an url by id.

    A markdown link which references an url by id.

    Definition Classes
    InlineParsers
  81. implicit def regex(r: Regex): Parser[String]
    Definition Classes
    RegexParsers
  82. def rep[T](p: => Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  83. def rep1[T](first: => Parser[T], p0: => Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The p0 call-by-name arguments is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.

  84. def rep1[T](p: => Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  85. def rep1sep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]
    Definition Classes
    Parsers
  86. def repN[T](num: Int, p: => Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  87. def repsep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]
    Definition Classes
    Parsers
  88. def rest: Parser[String]

    Matches everything in the parsed string up to the end.

    Matches everything in the parsed string up to the end. Also matches the empty String. Returns the matched String.

    Definition Classes
    BaseParsers
  89. def result(): String

    returns the resulting xhtml snippet as a string

  90. def skipWhitespace: Boolean

    Whitespace is sometimes important in markdown parsing, we handle it manually.

    Whitespace is sometimes important in markdown parsing, we handle it manually. So this returns false.

    Definition Classes
    BaseParsers → RegexParsers
  91. def span(limiter: String, ctx: InlineContext): Parser[String]

    Parses a span element like foo or *bar*

    Parses a span element like foo or *bar*

    Definition Classes
    InlineParsers
  92. def spanAsterisk(ctx: InlineContext): Parser[String]

    Either an emphasis or a strong text wrapped in asterisks.

    Either an emphasis or a strong text wrapped in asterisks.

    Definition Classes
    InlineParsers
  93. def spanInline(end: Parser[Any], ctx: InlineContext): Parser[String]

    Parses inline in a span element like bold or emphasis or link up until the given end marker

    Parses inline in a span element like bold or emphasis or link up until the given end marker

    Definition Classes
    InlineParsers
  94. def spanUnderscore(ctx: InlineContext): Parser[String]

    Either an emphasis or strong text wrapped in underscores.

    Either an emphasis or strong text wrapped in underscores.

    Definition Classes
    InlineParsers
  95. val specialInlineChars: Set[Char]

    Chars that may indicate the start of a special Markdown inline sequence.

    Chars that may indicate the start of a special Markdown inline sequence.

    Definition Classes
    InlineParsers
  96. val specialLinkInlineChars: Set[Char]

    Chars that may indicate the start of a special markdown inline sequence or the end of a link text.

    Chars that may indicate the start of a special markdown inline sequence or the end of a link text.

    Definition Classes
    InlineParsers
  97. def strongAsterisk(ctx: InlineContext): Parser[String]

    Parses strong text in asterisks: **foo**

    Parses strong text in asterisks: **foo**

    Definition Classes
    InlineParsers
  98. def strongUnderscore(ctx: InlineContext): Parser[String]

    Parses strong text in underscores: foo

    Parses strong text in underscores: foo

    Definition Classes
    InlineParsers
  99. def success[T](v: T): Parser[T]
    Definition Classes
    Parsers
  100. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  101. val title: Parser[Option[String]]

    A title is everything in quotation marks.

    A title is everything in quotation marks. We allow even quotation marks in quotation marks. We look ahead if we hit the closing brace after the quotation marks to detect if the title ends or not.

    Definition Classes
    InlineParsers
  102. def toString(): String
    Definition Classes
    AnyRef → Any
  103. val url: Parser[String]

    We parse everything as a link/img url until we hit whitespace or a closing brace.

    We parse everything as a link/img url until we hit whitespace or a closing brace.

    Definition Classes
    InlineParsers
  104. def verboseString(c: Char): String

    Returns a verbose description of a char (printed char & hex code).

    Returns a verbose description of a char (printed char & hex code). Used for debugging.

    Definition Classes
    BaseParsers
  105. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  106. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  107. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  108. val whiteSpace: Regex
    Attributes
    protected
    Definition Classes
    RegexParsers
  109. def ws: Parser[String]

    accepts one or more spaces or tabs returns the matched whitespace

    accepts one or more spaces or tabs returns the matched whitespace

    Definition Classes
    BaseParsers
  110. def xmlAttr: Parser[String]

    Parses an XML Attribute with simplified value handling like xmlAttrVal.

    Parses an XML Attribute with simplified value handling like xmlAttrVal.

    Definition Classes
    BaseParsers
  111. def xmlAttrVal: Parser[String]

    Parses a Simplified xml attribute: everything between quotes ("foo") everything between the quotes is run through the escape handling That way you can omit xml escaping when writing inline XML in markdown.

    Parses a Simplified xml attribute: everything between quotes ("foo") everything between the quotes is run through the escape handling That way you can omit xml escaping when writing inline XML in markdown.

    Definition Classes
    BaseParsers
  112. def xmlEndTag: Parser[String]

    Parses closing xml tags.

    Parses closing xml tags.

    Definition Classes
    BaseParsers
  113. def xmlName: Parser[String]

    Parses an XML name (tag or attribute name)

    Parses an XML name (tag or attribute name)

    Definition Classes
    BaseParsers
  114. def xmlNameChar: Parser[Char]

    Parses an XML name char according to W3C spec except that range #x10000 to #xEFFFF is excluded

    Parses an XML name char according to W3C spec except that range #x10000 to #xEFFFF is excluded

    Definition Classes
    BaseParsers
  115. val xmlNameCharRanges: SortedMap[Char, Char]
    Definition Classes
    BaseParsers
  116. def xmlNameStartChar: Parser[Char]

    Parser for one char that starts an XML name.

    Parser for one char that starts an XML name. According to W3C specs except that range #x10000 to #xEFFFF is excluded (cannot be expressed by char literals)

    Definition Classes
    BaseParsers
  117. val xmlNameStartCharRanges: SortedMap[Char, Char]
    Definition Classes
    BaseParsers
  118. def xmlStartOrEmptyTag: Parser[String]

    Parses an xml start or empty tag, attribute values are escaped.

    Parses an xml start or empty tag, attribute values are escaped.

    Definition Classes
    BaseParsers
  119. val xmlTag: Parser[String]

    Parses any xml tag and escapes attribute values.

    Parses any xml tag and escapes attribute values.

    Definition Classes
    InlineParsers

Inherited from InlineParsers

Inherited from BaseParsers

Inherited from RegexParsers

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped