t

net.liftweb.markdown

BlockParsers

trait BlockParsers extends Parsers

A parser for the markdown language. Works on pre-parsed lines that can be created by a LineParser.

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

Type Members

  1. class Blockquote extends MarkdownBlock

    Represents a quoted text block.

    Represents a quoted text block. Text in the block is recursively evaluated.

  2. class CodeBlock extends MarkdownBlock

    Represents a block of verbatim qouted code

  3. type Elem = MarkdownLine
    Definition Classes
    BlockParsers → Parsers
  4. case class Error extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  5. case class Failure extends NoSuccess with Product with Serializable
    Definition Classes
    Parsers
  6. class FencedCodeBlock extends MarkdownBlock
  7. case class Header(content: String, headerLevel: Int, lookup: Map[String, LinkDefinition]) extends MarkdownBlock with Product with Serializable

    Represents a header

  8. type Input = Reader[Elem]
    Definition Classes
    Parsers
  9. abstract class ListBlock extends MarkdownBlock

    Base class for ordered and unordered lists, allows for correct handling of paragraphs in lists.

  10. class ListItem extends LineParsers

    Helper class to build lists.

    Helper class to build lists. Allows easy checking if an item ends with empty lines and recursively builds the content of an item.

  11. sealed abstract class MarkdownBlock extends InlineParsers

    A markdown block element.

  12. sealed abstract class NoSuccess extends ParseResult[Nothing]
    Definition Classes
    Parsers
  13. class OList extends ListBlock

    An ordered (i.e.

    An ordered (i.e. numbered) list of items.

  14. trait OnceParser[+T] extends Parser[T]
    Definition Classes
    Parsers
  15. class Paragraph extends MarkdownBlock

    Represents a paragraph of text

  16. sealed abstract class ParseResult[+T] extends AnyRef
    Definition Classes
    Parsers
  17. abstract class Parser[+T] extends (Input) => ParseResult[T]
    Definition Classes
    Parsers
  18. case class Success[+T] extends ParseResult[T] with Product with Serializable
    Definition Classes
    Parsers
  19. class UList extends ListBlock

    An unordered list of items.

  20. class VerbatimXml extends MarkdownBlock

    :? Represents a block of verbatim xml

  21. case class ~[+a, +b] extends Product with Serializable
    Definition Classes
    Parsers

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 accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]
    Definition Classes
    Parsers
  7. def accept[ES](es: ES)(implicit f: (ES) => List[Elem]): Parser[List[Elem]]
    Definition Classes
    Parsers
  8. implicit def accept(e: Elem): Parser[Elem]
    Definition Classes
    Parsers
  9. def acceptIf(p: (Elem) => Boolean)(err: (Elem) => String): Parser[Elem]
    Definition Classes
    Parsers
  10. def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]
    Definition Classes
    Parsers
  11. def acceptSeq[ES](es: ES)(implicit f: (ES) => Iterable[Elem]): Parser[List[Elem]]
    Definition Classes
    Parsers
  12. def anyLine: Parser[MarkdownLine]

    Parses any line.

  13. def apply(in: MarkdownLineReader): String

    Parses the given input as a markdown document and returns the string result

  14. def apply[T](p: Parser[T], list: List[MarkdownLine]): T

    Generic apply method to test a single parser

  15. def apply[T](p: Parser[T], in: MarkdownLineReader): T

    Generic apply method to run one of our pasers on the given input.

  16. def applyBlocks(in: MarkdownLineReader): List[MarkdownBlock]

    parses all blocks from the given reader

  17. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  18. def atxHeader: Parser[Header]
  19. def blockquote: Parser[Blockquote]

    Parses a quoted block.

    Parses a quoted block. A quoted block starts with a line starting with "> " followed by more blockquote lines, paragraph lines following blockqoute lines and may be interspersed with empty lines

  20. def blockquoteFragment: Parser[List[MarkdownLine]]

    Parses a blockquote fragment: a block starting with a blockquote line followed by more blockquote or paragraph lines, ends optionally with empty lines

  21. def chainl1[T, U](first: => Parser[T], p: => Parser[U], q: => Parser[(T, U) => T]): Parser[T]
    Definition Classes
    Parsers
  22. def chainl1[T](p: => Parser[T], q: => Parser[(T, T) => T]): Parser[T]
    Definition Classes
    Parsers
  23. def chainr1[T, U](p: => Parser[T], q: => Parser[(T, U) => U], combine: (T, U) => U, first: U): Parser[U]
    Definition Classes
    Parsers
  24. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  25. def codeBlock: Parser[CodeBlock]

    parses a code block

  26. def commit[T](p: => Parser[T]): Parser[T]
    Definition Classes
    Parsers
  27. def deco(): Decorator

    Used to define the output format of parsed blocks and whether verbatim xml blocks are allowed.

  28. def elem(e: Elem): Parser[Elem]
    Definition Classes
    Parsers
  29. def elem(kind: String, p: (Elem) => Boolean): Parser[Elem]
    Definition Classes
    Parsers
  30. def emptyLine: Parser[EmptyLine]
  31. def emptyLines: Parser[List[MarkdownLine]]

    accepts one or more empty lines

  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 failure(msg: String): Parser[Nothing]
    Definition Classes
    Parsers
  36. def fastBlock: Parser[MarkdownBlock]

    speed up block processing by looking ahead

  37. def fencedCodeBlock: Parser[FencedCodeBlock]

    Parses a fenced code block: a line starting a fenced code block with "", followed by any lines that do not stop it, optionally followed by the ending line. Optionally parsing the stopping line causes the code block to extend to the end of the document. (This is the github behavior, where omitting the line closing the code block causes the block to extend to the end of the document as well)

  38. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  39. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def guard[T](p: => Parser[T]): Parser[T]
    Definition Classes
    Parsers
  41. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  42. def indent(level: Int): String

    returns the current indentation string repeated the given number of levels

  43. def innerBlock: Parser[MarkdownBlock]

    parses inner blocks (everything excluding xml)

  44. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  45. def itemContinuation: Parser[List[MarkdownLine]]

    The continuation of a list item: A line indented by four spaces or a tab (a continuation line), followed by more continuation or paragraph lines followed by empty lines

  46. def itemLines: Parser[List[MarkdownLine]]

    parses a list of lines that may make up the body of a list item

  47. def line[T](c: Class[T]): Parser[T]

    Parses a line of the given type T

  48. def log[T](p: => Parser[T])(name: String): Parser[T]
    Definition Classes
    Parsers
  49. def lookup: Parser[Map[String, LinkDefinition]]

    returns the current link lookup from the reader always succeeds, never consumes input

  50. def markdown: Parser[List[MarkdownBlock]]

    a markdown parser

  51. def mkList[T]: (~[T, List[T]]) => List[T]
    Definition Classes
    Parsers
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. def not[T](p: => Parser[T]): Parser[Unit]
    Definition Classes
    Parsers
  54. def notLine[T](c: Class[T]): Parser[MarkdownLine]

    Parses a line of any type *but* T

  55. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  57. def oItem: Parser[ListItem]

    parses an item in a sorted list

  58. def oList: Parser[OList]

    parses an ordered list

  59. def opt[T](p: => Parser[T]): Parser[Option[T]]
    Definition Classes
    Parsers
  60. def optEmptyLines: Parser[List[MarkdownLine]]

    accepts zero or more empty lines

  61. def outerBlock: Parser[MarkdownBlock]

    parses first level blocks (all blocks, including xml)

  62. def paragraph: Parser[Paragraph]

    a consecutive block of paragraph lines returns the content of the matched block wrapped in

    a consecutive block of paragraph lines returns the content of the matched block wrapped in

    tags

  63. def phrase[T](p: Parser[T]): Parser[T]
    Definition Classes
    Parsers
  64. def positioned[T <: Positional](p: => Parser[T]): Parser[T]
    Definition Classes
    Parsers
  65. def rep[T](p: => Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  66. 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.

  67. def rep1[T](p: => Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  68. def rep1sep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]
    Definition Classes
    Parsers
  69. def repN[T](num: Int, p: => Parser[T]): Parser[List[T]]
    Definition Classes
    Parsers
  70. def repsep[T](p: => Parser[T], q: => Parser[Any]): Parser[List[T]]
    Definition Classes
    Parsers
  71. def ruler: Parser[MarkdownBlock]

    parses a horizontal ruler

  72. def setExtHeader: Parser[Header]
  73. def success[T](v: T): Parser[T]
    Definition Classes
    Parsers
  74. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  75. def toString(): String
    Definition Classes
    AnyRef → Any
  76. def uItem: Parser[ListItem]

    parses an item in an unsorted list

  77. def uList: Parser[UList]

    parses an unordered list

  78. def verbatimXml: Parser[VerbatimXml]

    parses a verbatim xml block

  79. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  80. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  81. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  82. object Ruler extends MarkdownBlock

    Represents a horizontal ruler

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped