XML -- an XML parser

Description

This experimental and tentative package provides an interface to the library libxml2 (see http://www.xmlsoft.org/), which is a parser for XML files (see http://en.wikipedia.org/wiki/XML). The package offers two ways of representing the result: as an object of class LibxmlNode, which is a pointer to the internal structure created and accessed by the library; or as a hashtable of class XMLnode (which currently represents only elements, attributes, and nodes).

This package was written to support the packages OpenMath and SCSCP.

Author

Daniel R. Grayson <[email protected]>

Version

This documentation describes version 1.1 of XML.

Citation

If you have used this package in your research, please cite it as follows:

@misc{XMLSource,
  title = {{XML: an XML parser. Version~1.1}},
  author = {Daniel R. Grayson},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/master/M2/Macaulay2/packages}}
}

Exports

Types
- LibxmlAttribute -- the class of all XML attributes created by the library libxml
- LibxmlNode -- the class of all XML nodes created by libxml2
- XMLnode -- the class of all XML trees created by the library libxml2
Functions and commands
- getAttributes -- see getAttributes(LibxmlNode) -- get the list of attributes of an XML node
- getChildren -- get the list of children of an XML node
- parse -- see parse(String) -- parse XML
- toLibxmlNode -- see toLibxmlNode(XMLnode) -- convert a hashtable of type XMLnode to an object of type LibxmlNode
- toXMLnode -- see toXMLnode(LibxmlNode) -- convert an object of type LibxmlNode to a hashtable of type XMLnode
- xmlAddAttribute -- see xmlAddAttribute(LibxmlNode,String,String) -- add an attribute to an XML node
- xmlAddElement -- see xmlAddElement(LibxmlNode,String) -- add an element to an XML node
- xmlAddText -- see xmlAddText(LibxmlNode,String) -- add text to an XML node
- xmlDocDump -- dump a document
- xmlFirstAttribute -- see xmlFirstAttribute(LibxmlNode) -- get the first attribute of an XML node
- xmlFirstChild -- get the first child of an XML node or attribute
- xmlGetContent -- see xmlGetContent(LibxmlNode) -- get the string content of an XML text node
- xmlGetName -- get the name of an XML node or attribute
- xmlGetNext -- get the next XML node or attribute
- xmlIsElement -- see xmlIsElement(LibxmlNode) -- whether an XML node is an element
- xmlIsText -- see xmlIsText(LibxmlNode) -- whether an XML node is text
- xmlNewRoot -- see xmlNewRoot(String) -- create the root node of an XML document
- xmlParse -- see xmlParse(String) -- parse a string containing XML
- xmlType -- see xmlType(LibxmlNode) -- the type code for an XML node
- xmlTypeDescription -- see xmlTypeDescription(LibxmlNode) -- the type description for an XML node
- xmlTypes -- a hash table of descriptions for XML node type codes
Methods
- getAttributes(LibxmlNode) -- get the list of attributes of an XML node
- getChildren(LibxmlAttribute) -- see getChildren -- get the list of children of an XML node
- getChildren(LibxmlNode) -- see getChildren -- get the list of children of an XML node
- parse(String) -- parse XML
- toLibxmlNode(XMLnode) -- convert a hashtable of type XMLnode to an object of type LibxmlNode
- toXMLnode(LibxmlNode) -- convert an object of type LibxmlNode to a hashtable of type XMLnode
- xmlAddAttribute(LibxmlNode,String,String) -- add an attribute to an XML node
- xmlAddElement(LibxmlNode,String) -- add an element to an XML node
- xmlAddText(LibxmlNode,String) -- add text to an XML node
- xmlFirstAttribute(LibxmlNode) -- get the first attribute of an XML node
- xmlFirstChild(LibxmlAttribute) -- see xmlFirstChild -- get the first child of an XML node or attribute
- xmlFirstChild(LibxmlNode) -- see xmlFirstChild -- get the first child of an XML node or attribute
- xmlGetContent(LibxmlNode) -- get the string content of an XML text node
- xmlGetName(LibxmlAttribute) -- see xmlGetName -- get the name of an XML node or attribute
- xmlGetName(LibxmlNode) -- see xmlGetName -- get the name of an XML node or attribute
- xmlGetNext(LibxmlAttribute) -- see xmlGetNext -- get the next XML node or attribute
- xmlGetNext(LibxmlNode) -- see xmlGetNext -- get the next XML node or attribute
- xmlIsElement(LibxmlNode) -- whether an XML node is an element
- xmlIsText(LibxmlNode) -- whether an XML node is text
- xmlNewRoot(String) -- create the root node of an XML document
- xmlParse(String) -- parse a string containing XML
- xmlType(LibxmlNode) -- the type code for an XML node
- xmlTypeDescription(LibxmlNode) -- the type description for an XML node
- xmlTypes(Sequence) -- see xmlTypes -- a hash table of descriptions for XML node type codes
Symbols
- children
- tag
- Trim
Other things
- xmlTypeIndex -- get XML type code from its description
- xmlTypeTable -- a hash table of descriptions for XML node type codes

For the programmer

The object XML is a package, defined in XML.m2.

The source of this document is in XML.m2:662:0.