An XML tree consisting of XML nodes.

Use newXmlTree proc for creating a new tree.

An alias for a string to string mapping.

Use toXmlAttributes proc to create XmlAttributes.

Creates a new XmlNode of kind xnElement with the given tag.

See also:

• newXmlTree proc
• <> macro

Example:

var a = newElement("firstTag")
a.add newElement("childTag")
assert a.kind == xnElement
assert $a == """<firstTag>
  <childTag />
</firstTag>"""

Example:

var b = newText("my text")
assert b.kind == xnText
assert $b == "my text"

Example:

var c = newComment("my comment")
assert c.kind == xnComment
assert $c == "<!-- my comment -->"

Example:

var d = newCData("my cdata")
assert d.kind == xnCData
assert $d == "<![CDATA[my cdata]]>"

Example:

var e = newEntity("my entity")
assert e.kind == xnEntity
assert $e == "&my entity;"

Creates a new XML tree with tag, children and attributes.

See also:

• newElement proc
• <> macro

var g = newElement("myTag")
g.add newText("some text")
g.add newComment("this is comment")
var h = newElement("secondTag")
h.add newEntity("some entity")
let att = {"key1": "first value", "key2": "second value"}.toXmlAttributes
let k = newXmlTree("treeTag", [g, h], att)

echo k
## <treeTag key2="second value" key1="first value">
##   <myTag>some text<!-- this is comment --></myTag>
##   <secondTag>&some entity;</secondTag>
## </treeTag>

Gets the associated text with the node n.

n can be a CDATA, Text, comment, or entity node.

See also:

• text= proc for text setter
• tag proc for tag getter
• tag= proc for tag setter
• innerText proc

Example:

var c = newComment("my comment")
assert $c == "<!-- my comment -->"
assert c.text == "my comment"

Sets the associated text with the node n.

n can be a CDATA, Text, comment, or entity node.

See also:

• text proc for text getter
• tag proc for tag getter
• tag= proc for tag setter

Example:

var e = newEntity("my entity")
assert $e == "&my entity;"
e.text = "a new entity text"
assert $e == "&a new entity text;"

Gets the tag name of n.

n has to be an xnElement node.

See also:

• text proc for text getter
• text= proc for text setter
• tag= proc for tag setter
• innerText proc

Example:

var a = newElement("firstTag")
a.add newElement("childTag")
assert $a == """<firstTag>
  <childTag />
</firstTag>"""
assert a.tag == "firstTag"

Sets the tag name of n.

n has to be an xnElement node.

See also:

• text proc for text getter
• text= proc for text setter
• tag proc for tag getter

Example:

var a = newElement("firstTag")
a.add newElement("childTag")
assert $a == """<firstTag>
  <childTag />
</firstTag>"""
a.tag = "newTag"
assert $a == """<newTag>
  <childTag />
</newTag>"""

Returns the underlying 'text' string by reference.

This is only used for speed hacks.

Returns the underlying 'tag' string by reference.

This is only used for speed hacks.

• If n is xnText or xnEntity, returns its content.
• If n is xnElement, runs recursively on each child node and concatenates the results.
• Otherwise returns an empty string.

See also:

• text proc

Example:

var f = newElement("myTag")
f.add newText("my text")
f.add newComment("my comment")
f.add newEntity("my entity")
assert $f == "<myTag>my text<!-- my comment -->&my entity;</myTag>"
assert innerText(f) == "my textmy entity"

Adds the child son to father.

See also:

• insert proc
• delete proc

Example:

var f = newElement("myTag")
f.add newText("my text")
f.add newElement("sonTag")
f.add newEntity("my entity")
assert $f == "<myTag>my text<sonTag />&my entity;</myTag>"

Insert the child son to a given position in father.

father and son must be of xnElement kind.

See also:

• add proc
• delete proc

Example:

var f = newElement("myTag")
f.add newElement("first")
f.insert(newElement("second"), 0)
assert $f == """<myTag>
  <second />
  <first />
</myTag>"""

Delete the i'th child of n.

See also:

• add proc
• insert proc

Example:

var f = newElement("myTag")
f.add newElement("first")
f.insert(newElement("second"), 0)
f.delete(0)
assert $f == """<myTag>
  <first />
</myTag>"""

Example:

var f = newElement("myTag")
f.add newElement("first")
f.insert(newElement("second"), 0)
assert len(f) == 2

Example:

var a = newElement("firstTag")
assert a.kind == xnElement
var b = newText("my text")
assert b.kind == xnText

Example:

var f = newElement("myTag")
f.add newElement("first")
f.insert(newElement("second"), 0)
assert $f[1] == "<first />"
assert $f[0] == "<second />"

var g = newElement("myTag")
g.add newText("some text")
g.add newComment("this is comment")

var h = newElement("secondTag")
h.add newEntity("some entity")

let att = {"key1": "first value", "key2": "second value"}.toXmlAttributes
var k = newXmlTree("treeTag", [g, h], att)

echo k
## <treeTag key2="second value" key1="first value">
##   <myTag>some text<!-- this is comment --></myTag>
##   <secondTag>&some entity;</secondTag>
## </treeTag>

clear(k)
echo k
## <treeTag key2="second value" key1="first value" />

let att = {"key1": "first value", "key2": "second value"}.toXmlAttributes
var j = newElement("myTag")
j.attrs = att

echo j
## <myTag key2="second value" key1="first value" />

Gets the attributes belonging to n.

Returns nil if attributes have not been initialised for this node.

See also:

• attrs= proc for XmlAttributes setter
• attrsLen proc for number of attributes
• attr proc for finding an attribute

Example:

var j = newElement("myTag")
assert j.attrs == nil
let att = {"key1": "first value", "key2": "second value"}.toXmlAttributes
j.attrs = att
assert j.attrs == att

Sets the attributes belonging to n.

See also:

• attrs proc for XmlAttributes getter
• attrsLen proc for number of attributes
• attr proc for finding an attribute

Example:

var j = newElement("myTag")
assert j.attrs == nil
let att = {"key1": "first value", "key2": "second value"}.toXmlAttributes
j.attrs = att
assert j.attrs == att

Returns the number of n's attributes.

See also:

• attrs proc for XmlAttributes getter
• attrs= proc for XmlAttributes setter
• attr proc for finding an attribute

Example:

var j = newElement("myTag")
assert j.attrsLen == 0
let att = {"key1": "first value", "key2": "second value"}.toXmlAttributes
j.attrs = att
assert j.attrsLen == 2

Finds the first attribute of n with a name of name. Returns "" on failure.

See also:

• attrs proc for XmlAttributes getter
• attrs= proc for XmlAttributes setter
• attrsLen proc for number of attributes

Example:

var j = newElement("myTag")
let att = {"key1": "first value", "key2": "second value"}.toXmlAttributes
j.attrs = att
assert j.attr("key1") == "first value"
assert j.attr("key2") == "second value"

Gets the client data of n.

The client data field is used by the HTML parser and generator.

Sets the client data of n.

The client data field is used by the HTML parser and generator.

Escapes s for inclusion into an XML document.

Escapes these characters:

You can also use addEscaped proc.

Example:

var
  a = newElement("firstTag")
  b = newText("my text")
  c = newComment("my comment")
  s = ""
s.add(c)
s.add(a)
s.add(b)
assert s == "<!-- my comment --><firstTag />my text"

Converts n into its string representation.

No <$xml ...$> declaration is produced, so that the produced XML fragments are composable.

Example:

var f = newElement("myTag")
f.add newElement("firstSon")
f.add newElement("secondSon")
f.add newElement("thirdSon")
assert $(f.child("secondSon")) == "<secondSon />"

Iterates over all the children of n returning those matching tag.

Found nodes satisfying the condition will be appended to the result sequence.

Example:

var
  b = newElement("good")
  c = newElement("bad")
  d = newElement("BAD")
  e = newElement("GOOD")
b.add newText("b text")
c.add newText("c text")
d.add newText("d text")
e.add newText("e text")
let a = newXmlTree("father", [b, c, d, e])
var s = newSeq[XmlNode]()
a.findAll("good", s)
assert $s == "@[<good>b text</good>]"
s.setLen(0)
a.findAll("good", s, caseInsensitive = true)
assert $s == "@[<good>b text</good>, <GOOD>e text</GOOD>]"
s.setLen(0)
a.findAll("BAD", s)
assert $s == "@[<BAD>d text</BAD>]"
s.setLen(0)
a.findAll("BAD", s, caseInsensitive = true)
assert $s == "@[<bad>c text</bad>, <BAD>d text</BAD>]"

Example:

var
  b = newElement("good")
  c = newElement("bad")
  d = newElement("BAD")
  e = newElement("GOOD")
b.add newText("b text")
c.add newText("c text")
d.add newText("d text")
e.add newText("e text")
let a = newXmlTree("father", [b, c, d, e])
assert $(a.findAll("good")) == "@[<good>b text</good>]"
assert $(a.findAll("BAD")) == "@[<BAD>d text</BAD>]"
assert $(a.findAll("good", caseInsensitive = true)) == "@[<good>b text</good>, <GOOD>e text</GOOD>]"
assert $(a.findAll("BAD", caseInsensitive = true)) == "@[<bad>c text</bad>, <BAD>d text</BAD>]"

Iterates over all direct children of n.

Examples:

var g = newElement("myTag")
g.add newText("some text")
g.add newComment("this is comment")

var h = newElement("secondTag")
h.add newEntity("some entity")
g.add h

assert $g == "<myTag>some text<!-- this is comment --><secondTag>&some entity;</secondTag></myTag>"
for x in g: # the same as `for x in items(g):`
  echo x

# some text
# <!-- this is comment -->
# <secondTag>&some entity;<![CDATA[some cdata]]></secondTag>

<>a(href="http://nim-lang.org", newText("Nim rules."))

Produces an XML tree for:

<a href="http://nim-lang.org">Nim rules.</a>