kxml.xml

KXML contains functions and classes for reading, parsing, and writing XML documents.

Members

Aliases

string
alias string = char[]
Undocumented in source.

Classes

CData
class CData

A class specialization for CData nodes.

UCData
class UCData

A specialization of CData for <![CDATA[]]> nodes

XPathError
class XPathError

An exception thrown on an XPath parsing error.

XmlComment
class XmlComment

A class specialization for XML comments.

XmlDocument
class XmlDocument
Undocumented in source.
XmlError
class XmlError

An exception thrown on an xml parsing error.

XmlNode
class XmlNode

* XmlNode represents a single xml node and has methods for modifying * attributes and adding children. All methods that make changes modify this * XmlNode rather than making a copy, unless otherwise noted. Many methods * return a self reference to allow cascaded calls. * Example: * -------------------------------- * // Create an XmlNode tree with attributes and cdata, and write it to a file. * node.addChild(new XmlNode("mynode").setAttribute("x", 50). * addChild(new XmlNode("Waldo").addCData("Hello!"))).write("myfile.xml"); * --------------------------------

XmlPI
class XmlPI

A class specialization for XML instructions.

Functions

atof
real atof(string data)
Undocumented in source. Be warned that the author may not have intended to support it.
atoi
int atoi(string data)
Undocumented in source. Be warned that the author may not have intended to support it.
isNumeric
bool isNumeric(string input)
Undocumented in source. Be warned that the author may not have intended to support it.
main
void main()
Undocumented in source. Be warned that the author may not have intended to support it.
readDocument
XmlNode readDocument(string src, bool preserveWS)

Read an entire string into a tree of XmlNodes. This defaults to stripping all whitespace for a speed gain (less objects created), but can be forced to preserve whitespace using the second parameter.

regrep
string regrep(string input, string pattern, string delegate(string) translator)
Undocumented in source. Be warned that the author may not have intended to support it.
regrep
string regrep(string input, string pattern, string delegate(string) translator)
Undocumented in source. Be warned that the author may not have intended to support it.
regrep
string regrep(string input, string pattern, string delegate(string) translator)
Undocumented in source. Be warned that the author may not have intended to support it.
tostring
string tostring(T data)
Undocumented in source. Be warned that the author may not have intended to support it.
xmlDecode
string xmlDecode(string src)

Convert xml-encoded special characters such as &amp;amp; back to &amp;.

xmlEncode
string xmlEncode(string src)

Encode characters such as &, <, >, etc. as their xml/html equivalents

Variables

prealloc
int prealloc;

This is the encapsulating class for xml documents that allows reuse of nodes so as to not allocate ALL THE TIME if you find it convenient to reuse the structure

Meta

Authors

William K. Moore, III

Standards

Attempts to conform to XML 1.0 Specification

License

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization obtaining a copy of the software and accompanying documentation covered by this license (the "Software") to use, reproduce, display, distribute, execute, and transmit the Software, and to prepare derivative works of the Software, and to permit third-parties to whom the Software is furnished to do so, all subject to the following:

The copyright notices in the Software and this entire statement, including the above license grant, this restriction and the following disclaimer, must be included in all copies of the Software, in whole or in part, and all derivative works of the Software, unless such copies or derivative works are solely in the form of machine-executable object code generated by a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.