Trait

net.liftweb.markdown

BaseParsers

Related Doc: package markdown

Permalink

trait BaseParsers extends RegexParsers

Basic parsers for Markdown Source. Provides general, small parsers that are used by other parsers. Also contains parsers for XML elements.

Linear Supertypes
RegexParsers, Parsers, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BaseParsers
  2. RegexParsers
  3. Parsers
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. type Elem = Char

    Permalink
    Definition Classes
    RegexParsers → Parsers
  2. case class Error extends NoSuccess with Product with Serializable

    Permalink
    Definition Classes
    Parsers
  3. case class Failure extends NoSuccess with Product with Serializable

    Permalink
    Definition Classes
    Parsers
  4. type Input = Reader[Elem]

    Permalink
    Definition Classes
    Parsers
  5. sealed abstract class NoSuccess extends ParseResult[Nothing]

    Permalink
    Definition Classes
    Parsers
  6. trait OnceParser[+T] extends Parser[T]

    Permalink
    Definition Classes
    Parsers
  7. sealed abstract class ParseResult[+T] extends AnyRef

    Permalink
    Definition Classes
    Parsers
  8. abstract class Parser[+T] extends (Input) ⇒ ParseResult[T]

    Permalink
    Definition Classes
    Parsers
  9. case class Success[+T] extends ParseResult[T] with Product with Serializable

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

    Permalink
    Definition Classes
    Parsers

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. def OnceParser[T](f: (Input) ⇒ ParseResult[T]): Parser[T] with OnceParser[T]

    Permalink
    Definition Classes
    Parsers
  5. def Parser[T](f: (Input) ⇒ ParseResult[T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  6. def aChar: Parser[String]

    Permalink
  7. def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

    Permalink
    Definition Classes
    Parsers
  8. def accept[ES](es: ES)(implicit arg0: (ES) ⇒ List[Elem]): Parser[List[Elem]]

    Permalink
    Definition Classes
    Parsers
  9. implicit def accept(e: Elem): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  10. def acceptIf(p: (Elem) ⇒ Boolean)(err: (Elem) ⇒ String): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  11. def acceptMatch[S, T](f: PartialFunction[S, T])(p: Parser[S]): Parser[T]

    Permalink

    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.

  12. def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

    Permalink
    Definition Classes
    Parsers
  13. def acceptSeq[ES](es: ES)(implicit arg0: (ES) ⇒ Iterable[Elem]): Parser[List[Elem]]

    Permalink
    Definition Classes
    Parsers
  14. def any: Parser[String]

    Permalink

    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.

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

    Permalink

    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.

  16. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  17. def chainl1[T, U](first: ⇒ Parser[T], p: ⇒ Parser[U], q: ⇒ Parser[(T, U) ⇒ T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  18. def chainl1[T](p: ⇒ Parser[T], q: ⇒ Parser[(T, T) ⇒ T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  19. def chainr1[T, U](p: ⇒ Parser[T], q: ⇒ Parser[(T, U) ⇒ U], combine: (T, U) ⇒ U, first: U): Parser[U]

    Permalink
    Definition Classes
    Parsers
  20. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. def commit[T](p: ⇒ Parser[T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  22. def elem(e: Elem): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  23. def elem(kind: String, p: (Elem) ⇒ Boolean): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  24. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. def err(msg: String): Parser[Nothing]

    Permalink
    Definition Classes
    Parsers
  27. def escapeFastForXml(c: Char): String

    Permalink

    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.

  28. def escapeForXml(c: Char): String

    Permalink

    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.

  29. def failure(msg: String): Parser[Nothing]

    Permalink
    Definition Classes
    Parsers
  30. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  32. def guard[T](p: ⇒ Parser[T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  33. def handleWhiteSpace(source: CharSequence, offset: Int): Int

    Permalink
    Attributes
    protected
    Definition Classes
    RegexParsers
  34. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  35. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  36. implicit def literal(s: String): Parser[String]

    Permalink
    Definition Classes
    RegexParsers
  37. def log[T](p: ⇒ Parser[T])(name: String): Parser[T]

    Permalink
    Definition Classes
    Parsers
  38. def lookbehind(cs: Set[Char]): Parser[Unit]

    Permalink

    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.

  39. def mkList[T]: (~[T, List[T]]) ⇒ List[T]

    Permalink
    Definition Classes
    Parsers
  40. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  41. def nl: Parser[String]

    Permalink

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

  42. def not[T](p: ⇒ Parser[T]): Parser[Unit]

    Permalink
    Definition Classes
    Parsers
  43. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  45. def oneOf(lookup: Map[Char, String]): Parser[String]

    Permalink

    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.

  46. def oneOf(lookup: Set[Char]): Parser[String]

    Permalink

    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.

  47. def opt[T](p: ⇒ Parser[T]): Parser[Option[T]]

    Permalink
    Definition Classes
    Parsers
  48. def ows: Parser[String]

    Permalink

    accepts zero or more spaces or tabs returns the matched whitespace

  49. def parse[T](p: Parser[T], in: Reader): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  50. def parse[T](p: Parser[T], in: CharSequence): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  51. def parse[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  52. def parseAll[T](p: Parser[T], in: CharSequence): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  53. def parseAll[T](p: Parser[T], in: Reader): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  54. def parseAll[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  55. def phrase[T](p: Parser[T]): Parser[T]

    Permalink
    Definition Classes
    RegexParsers → Parsers
  56. def positioned[T <: Positional](p: ⇒ Parser[T]): Parser[T]

    Permalink
    Definition Classes
    RegexParsers → Parsers
  57. def range(begin: Char, end: Char): Parser[Char]

    Permalink

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

  58. def ranges(rs: SortedMap[Char, Char]): Parser[Char]

    Permalink
  59. implicit def regex(r: Regex): Parser[String]

    Permalink
    Definition Classes
    RegexParsers
  60. def rep[T](p: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  61. def rep1[T](first: ⇒ Parser[T], p0: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    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.

  62. def rep1[T](p: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  63. def rep1sep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  64. def repN[T](num: Int, p: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  65. def repsep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  66. def rest: Parser[String]

    Permalink

    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.

  67. def skipWhitespace: Boolean

    Permalink

    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
  68. def success[T](v: T): Parser[T]

    Permalink
    Definition Classes
    Parsers
  69. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Permalink
    Definition Classes
    AnyRef → Any
  71. def verboseString(c: Char): String

    Permalink

    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.

  72. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. val whiteSpace: Regex

    Permalink
    Attributes
    protected
    Definition Classes
    RegexParsers
  76. def ws: Parser[String]

    Permalink

    accepts one or more spaces or tabs returns the matched whitespace

  77. def xmlAttr: Parser[String]

    Permalink

    Parses an XML Attribute with simplified value handling like xmlAttrVal.

  78. def xmlAttrVal: Parser[String]

    Permalink

    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.

  79. def xmlEndTag: Parser[String]

    Permalink

    Parses closing xml tags.

  80. def xmlName: Parser[String]

    Permalink

    Parses an XML name (tag or attribute name)

  81. def xmlNameChar: Parser[Char]

    Permalink

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

  82. val xmlNameCharRanges: SortedMap[Char, Char]

    Permalink
  83. def xmlNameStartChar: Parser[Char]

    Permalink

    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)

  84. val xmlNameStartCharRanges: SortedMap[Char, Char]

    Permalink
  85. def xmlStartOrEmptyTag: Parser[String]

    Permalink

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

Inherited from RegexParsers

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped