scala.xml.parsing

ConstructingParser

class ConstructingParser extends ConstructingHandler with ExternalSources with MarkupParser

An xml parser. parses XML and invokes callback methods of a MarkupHandler. Don't forget to call next.ch on a freshly instantiated parser in order to initialize it. If you get the parser from the object method, initialization is already done for you.

object parseFromURL {
def main(args: Array[String]) {
  val url = args(0)
  val src = scala.io.Source.fromURL(url)
  val cpa = scala.xml.parsing.ConstructingParser.fromSource(src, false) // fromSource initializes automatically
  val doc = cpa.document()

  // let's see what it is
  val ppr = new scala.xml.PrettyPrinter(80, 5)
  val ele = doc.docElem
  println("finished parsing")
  val out = ppr.format(ele)
  println(out)
}
}
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ConstructingParser
  2. MarkupParser
  3. MarkupParserCommon
  4. TokenTests
  5. ExternalSources
  6. ConstructingHandler
  7. MarkupHandler
  8. AnyRef
  9. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ConstructingParser(input: Source, preserveWS: Boolean)

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

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def appendText(pos: Int, ts: NodeBuffer, txt: String): Unit

    Definition Classes
    MarkupParser
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def attListDecl(name: String, attList: List[AttrDecl]): Unit

    Definition Classes
    MarkupHandler
  9. def attrDecl(): Unit

    <! attlist := ATTLIST
    Definition Classes
    MarkupParser
  10. val cbuf: collection.mutable.StringBuilder

    character buffer, for names

    character buffer, for names

    Attributes
    protected
    Definition Classes
    MarkupParser
  11. 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.

    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
  12. def ch_returning_nextch: Char

    Attributes
    protected
    Definition Classes
    MarkupParser → MarkupParserCommon
  13. def checkPubID(s: String): Boolean

    Definition Classes
    TokenTests
  14. def checkSysID(s: String): Boolean

    Definition Classes
    TokenTests
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def comment(pos: Int, txt: String): Comment

    callback method invoked by MarkupParser after parsing comment.

    callback method invoked by MarkupParser after parsing comment.

    Definition Classes
    ConstructingHandlerMarkupHandler
  17. def content(pscope: NamespaceBinding): NodeSeq

    content1 ::=  '<' content1 | '&' charref ...
    Definition Classes
    MarkupParser
  18. def content1(pscope: NamespaceBinding, ts: NodeBuffer): Unit

    '<' content1 ::=  ...
    Definition Classes
    MarkupParser
  19. var curInput: Source

    Attributes
    protected
    Definition Classes
    MarkupParser
  20. var decls: List[Decl]

    Definition Classes
    MarkupHandler
  21. var doc: Document

    Attributes
    protected
    Definition Classes
    MarkupParser
  22. 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
    Definition Classes
    MarkupParser
  23. var dtd: DTD

    Definition Classes
    MarkupParser
  24. def elem(pos: Int, pre: String, label: String, attrs: MetaData, pscope: NamespaceBinding, empty: Boolean, nodes: NodeSeq): NodeSeq

    callback method invoked by MarkupParser after parsing an element, between the elemStart and elemEnd callbacks

    callback method invoked by MarkupParser after parsing an element, between the elemStart and elemEnd callbacks

    pos

    the position in the source file

    pre

    the prefix

    label

    the local name

    attrs

    the attributes (metadata)

    empty

    true if the element was previously empty; false otherwise.

    Definition Classes
    ConstructingHandlerMarkupHandler
  25. def elemDecl(n: String, cmstr: String): Unit

    Definition Classes
    MarkupHandler
  26. def elemEnd(pos: Int, pre: String, label: String): Unit

    callback method invoked by MarkupParser after end-tag of element.

    callback method invoked by MarkupParser after end-tag of element.

    pos

    the position in the source file

    pre

    the prefix

    label

    the local name

    Definition Classes
    MarkupHandler
  27. def elemStart(pos: Int, pre: String, label: String, attrs: MetaData, scope: NamespaceBinding): Unit

    callback method invoked by MarkupParser after start-tag of element.

    callback method invoked by MarkupParser after start-tag of element.

    pos

    the position in the sourcefile

    pre

    the prefix

    label

    the local name

    attrs

    the attributes (metadata)

    Definition Classes
    MarkupHandler
  28. def element(pscope: NamespaceBinding): NodeSeq

    Definition Classes
    MarkupParser
  29. def element1(pscope: NamespaceBinding): NodeSeq

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

    <! element := ELEMENT

    <! element := ELEMENT

    Definition Classes
    MarkupParser
  31. def endDTD(n: String): Unit

    Definition Classes
    MarkupHandler
  32. var ent: Map[String, EntityDecl]

    Definition Classes
    MarkupHandler
  33. def entityDecl(): Unit

    <! element := ELEMENT
    Definition Classes
    MarkupParser
  34. def entityRef(pos: Int, n: String): EntityRef

    callback method invoked by MarkupParser after parsing entity ref.

    callback method invoked by MarkupParser after parsing entity ref.

    Definition Classes
    ConstructingHandlerMarkupHandler
    To do

    expanding entity references

  35. def eof: Boolean

    Definition Classes
    MarkupParser → MarkupParserCommon
  36. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  38. def errorAndResult[T](msg: String, x: T): T

    Attributes
    protected
    Definition Classes
    MarkupParserCommon
  39. def errorNoEnd(tag: String): Nothing

    Definition Classes
    MarkupParser → MarkupParserCommon
  40. var extIndex: Int

    Definition Classes
    MarkupParser
  41. def extSubset(): Unit

    Definition Classes
    MarkupParser
  42. def externalID(): ExternalID

    externalID ::= SYSTEM S syslit
    PUBLIC S pubid S syslit
    Definition Classes
    MarkupParser
  43. def externalSource(systemId: String): Source

    Definition Classes
    ExternalSources
  44. def finalize(): Unit

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

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

    Definition Classes
    AnyRef → Any
  47. def initialize: ConstructingParser.this.type

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

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

    Definition Classes
    MarkupParser
  48. var inpStack: List[Source]

    stack of inputs

    stack of inputs

    Definition Classes
    MarkupParser
  49. val input: Source

    Definition Classes
    ConstructingParserMarkupParser
  50. def intSubset(): Unit

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

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

    Definition Classes
    MarkupParser
  51. 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
  52. def isAlphaDigit(c: Char): Boolean

    Definition Classes
    TokenTests
  53. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  54. def isName(s: String): Boolean

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

    See [5] of XML 1.0 specification.

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

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

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

    Definition Classes
    TokenTests
  56. 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
  57. def isPubIDChar(ch: Char): Boolean

    Definition Classes
    TokenTests
  58. final def isSpace(cs: Seq[Char]): Boolean

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

    (#x20 | #x9 | #xD | #xA)
    Definition Classes
    TokenTests
  60. 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
  61. val isValidating: Boolean

    returns true is this markup handler is validating

    returns true is this markup handler is validating

    Definition Classes
    MarkupHandler
  62. var lastChRead: Char

    Definition Classes
    MarkupParser
  63. 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
  64. def lookupElemDecl(Label: String): ElemDecl

    Definition Classes
    MarkupHandler
  65. def markupDecl(): Unit

    Definition Classes
    MarkupParser
  66. def markupDecl1(): Any

    Definition Classes
    MarkupParser
  67. def mkAttributes(name: String, pscope: NamespaceBinding): AttributesType

    Definition Classes
    MarkupParser → MarkupParserCommon
  68. def mkProcInstr(position: Int, name: String, text: String): ElementType

    Definition Classes
    MarkupParser → MarkupParserCommon
  69. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  70. var nextChNeeded: Boolean

    holds the next character

    holds the next character

    Definition Classes
    MarkupParser
  71. 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
  72. def notationDecl(): Unit

    'N' notationDecl ::= "OTATION"
    Definition Classes
    MarkupParser
  73. def notationDecl(notat: String, extID: ExternalID): Unit

    Definition Classes
    MarkupHandler
  74. final def notify(): Unit

    Definition Classes
    AnyRef
  75. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  76. def parameterEntityDecl(name: String, edef: EntityDef): Unit

    Definition Classes
    MarkupHandler
  77. 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 ... >
    Definition Classes
    MarkupParser
  78. def parsedEntityDecl(name: String, edef: EntityDef): Unit

    Definition Classes
    MarkupHandler
  79. def peReference(name: String): Unit

    Definition Classes
    MarkupHandler
  80. def pop(): Unit

    Definition Classes
    MarkupParser
  81. var pos: Int

    holds the position in the source file

    holds the position in the source file

    Definition Classes
    MarkupParser
  82. val preserveWS: Boolean

    if true, does not remove surplus whitespace

    if true, does not remove surplus whitespace

    Definition Classes
    ConstructingParserMarkupParserConstructingHandler
  83. def procInstr(pos: Int, target: String, txt: String): ProcInstr

    callback method invoked by MarkupParser after parsing PI.

    callback method invoked by MarkupParser after parsing PI.

    Definition Classes
    ConstructingHandlerMarkupHandler
  84. def prolog(): (Option[String], Option[String], Option[Boolean])

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

    [12]       PubidLiteral ::=        '"' PubidChar* '"' | "'" (PubidChar - "'")* "'"
    Definition Classes
    MarkupParser
  86. def push(entityName: String): Unit

    Definition Classes
    MarkupParser
  87. def pushExternal(systemId: String): Unit

    Definition Classes
    MarkupParser
  88. def putChar(c: Char): collection.mutable.StringBuilder

    append Unicode character to name buffer

    append Unicode character to name buffer

    Attributes
    protected
    Definition Classes
    MarkupParser
  89. var reachedEof: Boolean

    Definition Classes
    MarkupParser
  90. def replacementText(entityName: String): Source

    Definition Classes
    MarkupHandler
  91. def reportSyntaxError(str: String): Unit

    Definition Classes
    MarkupParser → MarkupParserCommon
  92. def reportSyntaxError(pos: Int, str: String): Unit

    Definition Classes
    MarkupParser → MarkupParserCommon
  93. def reportValidationError(pos: Int, str: String): Unit

    Definition Classes
    MarkupParser
  94. 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
  95. 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
  96. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  97. def systemLiteral(): String

    attribute value, terminated by either ' or ".

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

    AttValue     ::= `'` { _ } `'`
    | `"` { _ } `"`
    Definition Classes
    MarkupParser
  98. def text(pos: Int, txt: String): Text

    callback method invoked by MarkupParser after parsing text.

    callback method invoked by MarkupParser after parsing text.

    Definition Classes
    ConstructingHandlerMarkupHandler
  99. def textDecl(): (Option[String], Option[String])

    prolog, but without standalone

    prolog, but without standalone

    Definition Classes
    MarkupParser
  100. var tmppos: Int

    holds temporary values of pos

    holds temporary values of pos

    Definition Classes
    MarkupParser → MarkupParserCommon
  101. def toString(): String

    Definition Classes
    AnyRef → Any
  102. def truncatedError(msg: String): Nothing

    Definition Classes
    MarkupParser → MarkupParserCommon
  103. def unparsedEntityDecl(name: String, extID: ExternalID, notat: String): Unit

    Definition Classes
    MarkupHandler
  104. def unreachable: Nothing

    Attributes
    protected
    Definition Classes
    MarkupParserCommon
  105. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. def xAttributeValue(): String

    Definition Classes
    MarkupParserCommon
  109. 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
  110. 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 }
    Definition Classes
    MarkupParser
  111. def xCharData: NodeSeq

    '<! CharData ::= [CDATA[ ( {char} - {char}"]]>"{char} ) ']]>'
    
    see [15]
    Definition Classes
    MarkupParser
  112. def xCharRef: String

    Definition Classes
    MarkupParserCommon
  113. def xCharRef(it: Iterator[Char]): String

    Definition Classes
    MarkupParserCommon
  114. def xCharRef(ch: () ⇒ Char, nextch: () ⇒ Unit): String

    CharRef ::= "&#" '0'.

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

    see [66]

    Definition Classes
    MarkupParserCommon
  115. def xComment: NodeSeq

    Comment ::= ''
    
    see [15]
    Definition Classes
    MarkupParser
  116. def xEQ(): Unit

    scan [S] '=' [S]

    scan [S] '=' [S]

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

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

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

    Definition Classes
    MarkupParserCommon
  118. def xEntityValue(): String

    entity value, terminated by either ' or ".

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

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

    Definition Classes
    MarkupParser → MarkupParserCommon
  120. 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
  121. def xProcInstr: ElementType

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

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

    see [15]

    Definition Classes
    MarkupParserCommon
  122. def xSpace(): Unit

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

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

    Definition Classes
    MarkupParserCommon
  123. def xSpaceOpt(): Unit

    skip optional space S?

    skip optional space S?

    Definition Classes
    MarkupParserCommon
  124. def xTag(pscope: NamespaceType): (String, 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
  125. def xTakeUntil[T](handler: (PositionType, String) ⇒ T, positioner: () ⇒ 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
  126. def xToken(that: Seq[Char]): Unit

    Definition Classes
    MarkupParserCommon
  127. def xToken(that: Char): Unit

    Definition Classes
    MarkupParserCommon
  128. def xmlProcInstr(): MetaData

    <? prolog ::= xml S ... ?>
    Definition Classes
    MarkupParser

Deprecated Value Members

  1. def log(msg: String): Unit

    Definition Classes
    MarkupHandler
    Annotations
    @deprecated
    Deprecated

    (Since version 2.11) This method and its usages will be removed. Use a debugger to debug code.

Inherited from MarkupParser

Inherited from MarkupParserCommon

Inherited from TokenTests

Inherited from ExternalSources

Inherited from ConstructingHandler

Inherited from MarkupHandler

Inherited from AnyRef

Inherited from Any

Ungrouped