t

scala.xml.parsing

MarkupParser

trait MarkupParser extends MarkupParserCommon with TokenTests

An XML parser.

Parses XML 1.0, invokes callback methods of a MarkupHandler and returns whatever the markup handler returns. Use ConstructingParser if you just want to parse XML to construct instances of scala.xml.Node.

While XML elements are returned, DTD declarations - if handled - are collected using side-effects.

Self Type
MarkupParser with MarkupHandler
Version

1.0

Linear Supertypes
MarkupParserCommon, TokenTests, AnyRef, Any
Known Subclasses
ConstructingParser, XhtmlParser
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MarkupParser
  2. MarkupParserCommon
  3. TokenTests
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AttributesType = (MetaData, NamespaceBinding)
    Definition Classes
    MarkupParser → MarkupParserCommon
  2. type ElementType = NodeSeq
    Definition Classes
    MarkupParser → MarkupParserCommon
  3. type InputType = Source
    Definition Classes
    MarkupParser → MarkupParserCommon
  4. type NamespaceType = NamespaceBinding
    Definition Classes
    MarkupParser → MarkupParserCommon
  5. type PositionType = Int
    Definition Classes
    MarkupParser → MarkupParserCommon

Abstract Value Members

  1. abstract def externalSource(systemLiteral: String): Source
  2. abstract val input: Source
  3. abstract val preserveWS: Boolean

    if true, does not remove surplus whitespace

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 appendText(pos: Int, ts: NodeBuffer, txt: String): Unit
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def attrDecl(): Unit 

    <! attlist := ATTLIST
  7. val cbuf: collection.mutable.StringBuilder

    character buffer, for names

    character buffer, for names

    Attributes
    protected
  8. def ch: Char

    The library and compiler parsers had the interesting distinction of different behavior for nextch (a function for which there are a total of two plausible behaviors, so we know the design space was fully explored.) One of them returned the value of nextch before the increment and one of them the new value.

    The library and compiler parsers had the interesting distinction of different behavior for nextch (a function for which there are a total of two plausible behaviors, so we know the design space was fully explored.) One of them returned the value of nextch before the increment and one of them the new value. So to unify code we have to at least temporarily abstract over the nextchs.

    Definition Classes
    MarkupParser → MarkupParserCommon
  9. def ch_returning_nextch: Char
    Attributes
    protected
    Definition Classes
    MarkupParser → MarkupParserCommon
  10. def checkPubID(s: String): Boolean
    Definition Classes
    TokenTests
  11. def checkSysID(s: String): Boolean
    Definition Classes
    TokenTests
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  13. def content(pscope: NamespaceBinding): NodeSeq 

    content1 ::=  '<' content1 | '&' charref ...
  14. def content1(pscope: NamespaceBinding, ts: NodeBuffer): Unit 

    '<' content1 ::=  ...
  15. val curInput: Source
    Attributes
    protected
  16. val doc: Document
    Attributes
    protected
  17. def document(): Document 

    [22]     prolog      ::= XMLDecl? Misc* (doctypedecl Misc*)?
[23]     XMLDecl     ::= ' VersionInfo EncodingDecl? SDDecl? S? '?>'
[24]     VersionInfo ::= S 'version' Eq ("'" VersionNum "'" | '"' VersionNum '"')
[25]     Eq          ::= S? '=' S?
[26]     VersionNum  ::= '1.0'
[27]     Misc        ::= Comment | PI | S
  18. val dtd: DTD
  19. def element(pscope: NamespaceBinding): NodeSeq
  20. def element1(pscope: NamespaceBinding): NodeSeq 

    '<' element ::= xmlTag1 '>'  { xmlExpr | '{' simpleExpr '}' } ETag
             | xmlTag1 '/' '>'
  21. def elementDecl(): Unit

    <! element := ELEMENT

  22. def entityDecl(): Unit 

    <! element := ELEMENT
  23. def eof: Boolean
    Definition Classes
    MarkupParser → MarkupParserCommon
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  26. def errorAndResult[T](msg: String, x: T): T
    Attributes
    protected
    Definition Classes
    MarkupParserCommon
  27. def errorNoEnd(tag: String): Nothing
    Definition Classes
    MarkupParser → MarkupParserCommon
  28. val extIndex: Int
  29. def extSubset(): Unit
  30. def externalID(): ExternalID 

    externalID ::= SYSTEM S syslit
               PUBLIC S pubid S syslit
  31. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. def initialize: MarkupParser.this

    As the current code requires you to call nextch once manually after construction, this method formalizes that suboptimal reality.

  35. val inpStack: List[Source]

    stack of inputs

  36. def intSubset(): Unit

    "rec-xml/#ExtSubset" pe references may not occur within markup declarations

  37. def isAlpha(c: Char): Boolean

    These are 99% sure to be redundant but refactoring on the safe side.

    These are 99% sure to be redundant but refactoring on the safe side.

    Definition Classes
    TokenTests
  38. def isAlphaDigit(c: Char): Boolean
    Definition Classes
    TokenTests
  39. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  40. def isName(s: String): Boolean 

    Name ::= ( Letter | '_' ) (NameChar)*

    See [5] of XML 1.0 specification.

    Definition Classes
    TokenTests
  41. def isNameChar(ch: Char): Boolean 

    NameChar ::= Letter | Digit | '.' | '-' | '_' | ':'
           | CombiningChar | Extender

    See [4] and Appendix B of XML 1.0 specification.

    Definition Classes
    TokenTests
  42. def isNameStart(ch: Char): Boolean 

    NameStart ::= ( Letter | '_' )

    where Letter means in one of the Unicode general categories { Ll, Lu, Lo, Lt, Nl }.

    We do not allow a name to start with :. See [3] and Appendix B of XML 1.0 specification

    Definition Classes
    TokenTests
  43. def isPubIDChar(ch: Char): Boolean
    Definition Classes
    TokenTests
  44. final def isSpace(cs: Seq[Char]): Boolean 

    (#x20 | #x9 | #xD | #xA)+
    Definition Classes
    TokenTests
  45. final def isSpace(ch: Char): Boolean 

    (#x20 | #x9 | #xD | #xA)
    Definition Classes
    TokenTests
  46. def isValidIANAEncoding(ianaEncoding: Seq[Char]): Boolean

    Returns true if the encoding name is a valid IANA encoding.

    Returns true if the encoding name is a valid IANA encoding. This method does not verify that there is a decoder available for this encoding, only that the characters are valid for an IANA encoding name.

    ianaEncoding

    The IANA encoding name.

    Definition Classes
    TokenTests
  47. val lastChRead: Char
  48. def lookahead(): BufferedIterator[Char]

    Create a lookahead reader which does not influence the input

    Create a lookahead reader which does not influence the input

    Definition Classes
    MarkupParser → MarkupParserCommon
  49. def markupDecl(): Unit
  50. def markupDecl1(): Any
  51. def mkAttributes(name: String, pscope: NamespaceBinding): (MarkupParser.this)#AttributesType
    Definition Classes
    MarkupParser → MarkupParserCommon
  52. def mkProcInstr(position: Int, name: String, text: String): (MarkupParser.this)#ElementType
    Definition Classes
    MarkupParser → MarkupParserCommon
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. val nextChNeeded: Boolean

    holds the next character

  55. def nextch(): Unit

    this method tells ch to get the next character when next called

    this method tells ch to get the next character when next called

    Definition Classes
    MarkupParser → MarkupParserCommon
  56. def notationDecl(): Unit 

    'N' notationDecl ::= "OTATION"
  57. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  58. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  59. def parseDTD(): Unit

    parses document type declaration and assigns it to instance variable dtd.

    parses document type declaration and assigns it to instance variable dtd.

    <! parseDTD ::= DOCTYPE name ... >
  60. def pop(): Unit
  61. val pos: Int

    holds the position in the source file

  62. def prolog(): (Option[String], Option[String], Option[Boolean]) 

    <? prolog ::= xml S?
// this is a bit more lenient than necessary...
  63. def pubidLiteral(): String 

    [12]       PubidLiteral ::=        '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"
  64. def push(entityName: String): Unit
  65. def pushExternal(systemId: String): Unit
  66. def putChar(c: Char): collection.mutable.StringBuilder

    append Unicode character to name buffer

    append Unicode character to name buffer

    Attributes
    protected
  67. val reachedEof: Boolean
  68. def reportSyntaxError(str: String): Unit
    Definition Classes
    MarkupParser → MarkupParserCommon
  69. def reportSyntaxError(pos: Int, str: String): Unit
    Definition Classes
    MarkupParser → MarkupParserCommon
  70. def reportValidationError(pos: Int, str: String): Unit
  71. def returning[T](x: T)(f: (T) ⇒ Unit): T

    Apply a function and return the passed value

    Apply a function and return the passed value

    Definition Classes
    MarkupParserCommon
  72. def saving[A, B](getter: A, setter: (A) ⇒ Unit)(body: ⇒ B): B

    Execute body with a variable saved and restored after execution

    Execute body with a variable saved and restored after execution

    Definition Classes
    MarkupParserCommon
  73. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  74. def systemLiteral(): String

    attribute value, terminated by either ' or ".

    attribute value, terminated by either ' or ". value may not contain <.

    AttValue     ::= `'` { _ } `'`
               | `"` { _ } `"`
  75. def textDecl(): (Option[String], Option[String])

    prolog, but without standalone

  76. val tmppos: Int

    holds temporary values of pos

    holds temporary values of pos

    Definition Classes
    MarkupParser → MarkupParserCommon
  77. def toString(): String
    Definition Classes
    AnyRef → Any
  78. def truncatedError(msg: String): Nothing
    Definition Classes
    MarkupParser → MarkupParserCommon
  79. def unreachable: Nothing
    Attributes
    protected
    Definition Classes
    MarkupParserCommon
  80. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  83. def xAttributeValue(): String
    Definition Classes
    MarkupParserCommon
  84. def xAttributeValue(endCh: Char): String

    attribute value, terminated by either ' or ".

    attribute value, terminated by either ' or ". value may not contain <.

    endCh

    either ' or "

    Definition Classes
    MarkupParserCommon
  85. def xAttributes(pscope: NamespaceBinding): (MetaData, NamespaceBinding)

    parse attribute and create namespace scope, metadata

    parse attribute and create namespace scope, metadata

    [41] Attributes    ::= { S Name Eq AttValue }
  86. def xCharData: NodeSeq 

    '<! CharData ::= [CDATA[ ( {char} - {char}"]]>"{char} ) ']]>'

see [15]
  87. def xCharRef: String
    Definition Classes
    MarkupParserCommon
  88. def xCharRef(it: Iterator[Char]): String
    Definition Classes
    MarkupParserCommon
  89. def xCharRef(ch: () ⇒ Char, nextch: () ⇒ Unit): String

    CharRef ::= "&#" '0'..'9' {'0'..'9'} ";" | "&#x" '0'..'9'|'A'..'F'|'a'..'f' { hexdigit } ";"

    CharRef ::= "&#" '0'..'9' {'0'..'9'} ";" | "&#x" '0'..'9'|'A'..'F'|'a'..'f' { hexdigit } ";"

    see [66]

    Definition Classes
    MarkupParserCommon
  90. def xComment: NodeSeq 

     Comment ::= ''

see [15]
  91. def xEQ(): Unit

    scan [S] '=' [S]

    scan [S] '=' [S]

    Definition Classes
    MarkupParserCommon
  92. def xEndTag(startName: String): Unit

    [42] '<' xmlEndTag ::= '<' '/' Name S? '>'

    [42] '<' xmlEndTag ::= '<' '/' Name S? '>'

    Definition Classes
    MarkupParserCommon
  93. def xEntityValue(): String

    entity value, terminated by either ' or ".

    entity value, terminated by either ' or ". value may not contain <.

    AttValue     ::= `'` { _  } `'`
               | `"` { _ } `"`
  94. def xHandleError(that: Char, msg: String): Unit
    Definition Classes
    MarkupParser → MarkupParserCommon
  95. def xName: String

    actually, Name ::= (Letter | '_' | ':') (NameChar)* but starting with ':' cannot happen Name ::= (Letter | '_') (NameChar)*

    actually, Name ::= (Letter | '_' | ':') (NameChar)* but starting with ':' cannot happen Name ::= (Letter | '_') (NameChar)*

    see [5] of XML 1.0 specification

    pre-condition: ch != ':' // assured by definition of XMLSTART token post-condition: name does neither start, nor end in ':'

    Definition Classes
    MarkupParserCommon
  96. def xProcInstr: (MarkupParser.this)#ElementType

    '<?' ProcInstr ::= Name [S ({Char} - ({Char}'>?' {Char})]'?>'

    '<?' ProcInstr ::= Name [S ({Char} - ({Char}'>?' {Char})]'?>'

    see [15]

    Definition Classes
    MarkupParserCommon
  97. def xSpace(): Unit

    scan [3] S ::= (#x20 | #x9 | #xD | #xA)+

    scan [3] S ::= (#x20 | #x9 | #xD | #xA)+

    Definition Classes
    MarkupParserCommon
  98. def xSpaceOpt(): Unit

    skip optional space S?

    skip optional space S?

    Definition Classes
    MarkupParserCommon
  99. def xTag(pscope: (MarkupParser.this)#NamespaceType): (String, (MarkupParser.this)#AttributesType)

    parse a start or empty tag.

    parse a start or empty tag. [40] STag ::= '<' Name { S Attribute } [S] [44] EmptyElemTag ::= '<' Name { S Attribute } [S]

    Attributes
    protected
    Definition Classes
    MarkupParserCommon
  100. def xTakeUntil[T](handler: ((MarkupParser.this)#PositionType, String) ⇒ T, positioner: () ⇒ (MarkupParser.this)#PositionType, until: String): T

    Take characters from input stream until given String "until" is seen.

    Take characters from input stream until given String "until" is seen. Once seen, the accumulated characters are passed along with the current Position to the supplied handler function.

    Attributes
    protected
    Definition Classes
    MarkupParserCommon
  101. def xToken(that: Seq[Char]): Unit
    Definition Classes
    MarkupParserCommon
  102. def xToken(that: Char): Unit
    Definition Classes
    MarkupParserCommon
  103. def xmlProcInstr(): MetaData 

    <? prolog ::= xml S ... ?>

Inherited from MarkupParserCommon

Inherited from TokenTests

Inherited from AnyRef

Inherited from Any

Ungrouped