mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-08 13:39:58 +00:00
Fix some more documentation generator bugs.
Add detailed docos to the file.
This commit is contained in:
Michael R Sweet
parent
0cc4b9e665
commit
bcc99b153a
@ -11,23 +11,19 @@
|
||||
<body>
|
||||
<h1>Contents</h1>
|
||||
<ul>
|
||||
<li><a href="#_classes">Classes</a></li>
|
||||
<li><a href="#_enumerations">Enumeration</a></li>
|
||||
<li><a href="#_functions">Functions</a></li>
|
||||
<li><a href="#_structures">Structures</a></li>
|
||||
<li><a href="#_types">Types</a></li>
|
||||
<li><a href="#_unions">Unions</a></li>
|
||||
</ul>
|
||||
<h1><a name="_classes">Classes</a></h1>
|
||||
<ul>
|
||||
</ul>
|
||||
<h1><a name="_enumerations">Enumerations</a></h1>
|
||||
<ul>
|
||||
<li><a href="#mxml_type_e"><tt>mxml_type_e</tt></a></li>
|
||||
</ul>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_type_e">mxml_type_e</a></h2>
|
||||
<p>Node Type</p>
|
||||
<p>The XML node type.</p>
|
||||
<h3>Values</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
@ -58,52 +54,65 @@
|
||||
</ul>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlAdd">mxmlAdd()</a></h2>
|
||||
<p>Add a node to a tree.</p>
|
||||
<p>Add a node to a tree.
|
||||
|
||||
Adds the specified node to the parent. If the child argument is not
|
||||
NULL, puts the new node before or after the specified child depending
|
||||
on the value of the where argument. If the child argument is NULL,
|
||||
puts the new node at the beginning of the child list (MXML_ADD_BEFORE)
|
||||
or at the end of the child list (MXML_ADD_AFTER). The constant
|
||||
MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
void
|
||||
mxmlAdd(
|
||||
mxml_node_t * parent,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * parent,
|
||||
int where,
|
||||
mxml_node_t * child,
|
||||
mxml_node_t * node);
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * child,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node</td></tr>
|
||||
<tr><td><tt>where</tt></td><td>Where to add</td></tr>
|
||||
<tr><td><tt>child</tt></td><td>Child node for where</td></tr>
|
||||
<tr><td><tt>where</tt></td><td>Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER</td></tr>
|
||||
<tr><td><tt>child</tt></td><td>Child node for where or MXML_ADD_TO_PARENT</td></tr>
|
||||
<tr><td><tt>node</tt></td><td>Node to add</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>Nothing.</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlDelete">mxmlDelete()</a></h2>
|
||||
<p>Delete a node and all of its children.</p>
|
||||
<p>Delete a node and all of its children.
|
||||
|
||||
If the specified node has a parent, this function first removes the
|
||||
node from its parent using the mxmlRemove() function.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
void
|
||||
mxmlDelete(
|
||||
mxml_node_t * node);
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><tt>node</tt></td><td>Node</td></tr>
|
||||
<tr><td><tt>node</tt></td><td>Node to delete</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>Nothing.</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlElementGetAttr">mxmlElementGetAttr()</a></h2>
|
||||
<p>Get an attribute.</p>
|
||||
<p>Get an attribute.
|
||||
|
||||
This function returns NULL if the node is not an element or the
|
||||
named attribute does not exist.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
const char *
|
||||
mxmlElementGetAttr(
|
||||
mxml_node_t * node,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node,
|
||||
const char * name);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
@ -117,12 +126,17 @@ mxmlElementGetAttr(
|
||||
<p>Attribute value or NULL</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlElementSetAttr">mxmlElementSetAttr()</a></h2>
|
||||
<p>Set an attribute.</p>
|
||||
<p>Set an attribute.
|
||||
|
||||
If the named attribute already exists, the value of the attribute
|
||||
is replaced by the new string value. The string value is copied
|
||||
into the element node. This function does nothing if the node is
|
||||
not an element.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
void
|
||||
mxmlElementSetAttr(
|
||||
mxml_node_t * node,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node,
|
||||
const char * name,
|
||||
const char * value);
|
||||
</pre>
|
||||
@ -138,13 +152,22 @@ mxmlElementSetAttr(
|
||||
<p>Nothing.</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlFindElement">mxmlFindElement()</a></h2>
|
||||
<p>Find the named element.</p>
|
||||
<p>Find the named element.
|
||||
|
||||
The search is constrained by the name, attribute name, and value; any
|
||||
NULL names or values are treated as wildcards, so different kinds of
|
||||
searches can be implemented by looking for all elements of a given name
|
||||
or all elements with a specific attribute. The descend argument determines
|
||||
whether the search descends into child nodes; normally you will use
|
||||
MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find
|
||||
additional direct descendents of the node. The top node argument
|
||||
constrains the search to a particular node's children.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlFindElement(
|
||||
mxml_node_t * node,
|
||||
mxml_node_t * top,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * top,
|
||||
const char * name,
|
||||
const char * attr,
|
||||
const char * value,
|
||||
@ -159,20 +182,27 @@ mxmlFindElement(
|
||||
<tr><td><tt>name</tt></td><td>Element name or NULL for any</td></tr>
|
||||
<tr><td><tt>attr</tt></td><td>Attribute name, or NULL for none</td></tr>
|
||||
<tr><td><tt>value</tt></td><td>Attribute value, or NULL for any</td></tr>
|
||||
<tr><td><tt>descend</tt></td><td>Descend into tree?</td></tr>
|
||||
<tr><td><tt>descend</tt></td><td>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>Element node or NULL</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlLoadFile">mxmlLoadFile()</a></h2>
|
||||
<p>Load a file into an XML node tree.</p>
|
||||
<p>Load a file into an XML node tree.
|
||||
|
||||
The nodes in the specified file are added to the specified top node.
|
||||
If no top node is provided, the XML file MUST be well-formed with a
|
||||
single parent node like <?xml> for the entire file. The callback
|
||||
function returns the value type that should be used for child nodes.
|
||||
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
||||
MXML_ELEMENT or MXML_TEXT nodes.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlLoadFile(
|
||||
mxml_node_t * top,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * top,
|
||||
FILE * fp,
|
||||
mxml_type_t (*cb)(mxml_node_t *));
|
||||
<a href="#mxml_type_t">mxml_type_t</a> (*cb)(mxml_node_t *));
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
@ -180,94 +210,117 @@ mxmlLoadFile(
|
||||
<tbody>
|
||||
<tr><td><tt>top</tt></td><td>Top node</td></tr>
|
||||
<tr><td><tt>fp</tt></td><td>File to read from</td></tr>
|
||||
<tr><td><tt>(*cb)(mxml_node_t *)</tt></td><td>Callback function</td></tr>
|
||||
<tr><td><tt>(*cb)(mxml_node_t *)</tt></td><td>Callback function or MXML_NO_CALLBACK</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>First node</p>
|
||||
<p>First node or NULL if the file could not be read.</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlNewElement">mxmlNewElement()</a></h2>
|
||||
<p>Create a new element node.</p>
|
||||
<p>Create a new element node.
|
||||
|
||||
The new element node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
element node has no parent.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlNewElement(
|
||||
mxml_node_t * parent,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * parent,
|
||||
const char * name);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node</td></tr>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node or MXML_NO_PARENT</td></tr>
|
||||
<tr><td><tt>name</tt></td><td>Name of element</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>New node</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlNewInteger">mxmlNewInteger()</a></h2>
|
||||
<p>Create a new integer node.</p>
|
||||
<p>Create a new integer node.
|
||||
|
||||
The new integer node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
integer node has no parent.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlNewInteger(
|
||||
mxml_node_t * parent,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * parent,
|
||||
int integer);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node</td></tr>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node or MXML_NO_PARENT</td></tr>
|
||||
<tr><td><tt>integer</tt></td><td>Integer value</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>New node</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlNewOpaque">mxmlNewOpaque()</a></h2>
|
||||
<p>Create a new opaque string.</p>
|
||||
<p>Create a new opaque string.
|
||||
|
||||
The new opaque node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
opaque node has no parent. The opaque string must be nul-terminated and
|
||||
is copied into the new node.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlNewOpaque(
|
||||
mxml_node_t * parent,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * parent,
|
||||
const char * opaque);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node</td></tr>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node or MXML_NO_PARENT</td></tr>
|
||||
<tr><td><tt>opaque</tt></td><td>Opaque string</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>New node</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlNewReal">mxmlNewReal()</a></h2>
|
||||
<p>Create a new real number node.</p>
|
||||
<p>Create a new real number node.
|
||||
|
||||
The new real number node is added to the end of the specified parent's
|
||||
child list. The constant MXML_NO_PARENT can be used to specify that
|
||||
the new real number node has no parent.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlNewReal(
|
||||
mxml_node_t * parent,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * parent,
|
||||
double real);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node</td></tr>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node or MXML_NO_PARENT</td></tr>
|
||||
<tr><td><tt>real</tt></td><td>Real number value</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>New node</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlNewText">mxmlNewText()</a></h2>
|
||||
<p>Create a new text fragment node.</p>
|
||||
<p>Create a new text fragment node.
|
||||
|
||||
The new text node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
text node has no parent. The whitespace parameter is used to specify
|
||||
whether leading whitespace is present before the node. The text
|
||||
string must be nul-terminated and is copied into the new node.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlNewText(
|
||||
mxml_node_t * parent,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * parent,
|
||||
int whitespace,
|
||||
const char * string);
|
||||
</pre>
|
||||
@ -275,20 +328,23 @@ mxmlNewText(
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
<thead><tr><th>Name</th><th>Description</th></tr></thead>
|
||||
<tbody>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node</td></tr>
|
||||
<tr><td><tt>whitespace</tt></td><td>Leading whitespace?</td></tr>
|
||||
<tr><td><tt>parent</tt></td><td>Parent node or MXML_NO_PARENT</td></tr>
|
||||
<tr><td><tt>whitespace</tt></td><td>1 = leading whitespace, 0 = no whitespace</td></tr>
|
||||
<tr><td><tt>string</tt></td><td>String</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>New node</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlRemove">mxmlRemove()</a></h2>
|
||||
<p>Remove a node from its parent.</p>
|
||||
<p>Remove a node from its parent.
|
||||
|
||||
Does not free memory used by the node - use mxmlDelete() for that.
|
||||
This function does nothing if the node has no parent.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
void
|
||||
mxmlRemove(
|
||||
mxml_node_t * node);
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
<p class="table"><table align="center" border="1" width="80%">
|
||||
@ -300,12 +356,18 @@ mxmlRemove(
|
||||
<p>Nothing.</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlSaveFile">mxmlSaveFile()</a></h2>
|
||||
<p>Save an XML tree to a file.</p>
|
||||
<p>Save an XML tree to a file.
|
||||
|
||||
The callback argument specifies a function that returns a whitespace
|
||||
character or nul (0) before and after each element. If MXML_NO_CALLBACK
|
||||
is specified, whitespace will only be added before MXML_TEXT nodes
|
||||
with leading whitespace and before attribute names inside opening
|
||||
element tags.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
int
|
||||
mxmlSaveFile(
|
||||
mxml_node_t * node,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node,
|
||||
FILE * fp,
|
||||
int (*cb)(mxml_node_t *int));
|
||||
</pre>
|
||||
@ -315,19 +377,23 @@ mxmlSaveFile(
|
||||
<tbody>
|
||||
<tr><td><tt>node</tt></td><td>Node to write</td></tr>
|
||||
<tr><td><tt>fp</tt></td><td>File to write to</td></tr>
|
||||
<tr><td><tt>(*cb)(mxml_node_t *int)</tt></td><td>Whitespace callback</td></tr>
|
||||
<tr><td><tt>(*cb)(mxml_node_t *int)</tt></td><td>Whitespace callback or MXML_NO_CALLBACK</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>0 on success, -1 on error</p>
|
||||
<p>0 on success, -1 on error.</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlWalkNext">mxmlWalkNext()</a></h2>
|
||||
<p>Walk to the next logical node in the tree.</p>
|
||||
<p>Walk to the next logical node in the tree.
|
||||
|
||||
The descend argument controls whether the first child is considered
|
||||
to be the next node. The top node argument constrains the walk to
|
||||
the node's children.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlWalkNext(
|
||||
mxml_node_t * node,
|
||||
mxml_node_t * top,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * top,
|
||||
int descend);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
@ -336,19 +402,23 @@ mxmlWalkNext(
|
||||
<tbody>
|
||||
<tr><td><tt>node</tt></td><td>Current node</td></tr>
|
||||
<tr><td><tt>top</tt></td><td>Top node</td></tr>
|
||||
<tr><td><tt>descend</tt></td><td>Descend into tree?</td></tr>
|
||||
<tr><td><tt>descend</tt></td><td>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>Next node or NULL</p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxmlWalkPrev">mxmlWalkPrev()</a></h2>
|
||||
<p>Walk to the previous logical node in the tree.</p>
|
||||
<p>Walk to the previous logical node in the tree.
|
||||
|
||||
The descend argument controls whether the previous node's last child
|
||||
is considered to be the previous node. The top node argument constrains
|
||||
the walk to the node's children.</p>
|
||||
<h3>Syntax</h3>
|
||||
<pre>
|
||||
mxml_node_t *
|
||||
<a href="#mxml_node_t">mxml_node_t</a> *
|
||||
mxmlWalkPrev(
|
||||
mxml_node_t * node,
|
||||
mxml_node_t * top,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * node,
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * top,
|
||||
int descend);
|
||||
</pre>
|
||||
<h3>Arguments</h3>
|
||||
@ -357,7 +427,7 @@ mxmlWalkPrev(
|
||||
<tbody>
|
||||
<tr><td><tt>node</tt></td><td>Current node</td></tr>
|
||||
<tr><td><tt>top</tt></td><td>Top node</td></tr>
|
||||
<tr><td><tt>descend</tt></td><td>Descend into tree?</td></tr>
|
||||
<tr><td><tt>descend</tt></td><td>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</td></tr>
|
||||
</tbody></table></p>
|
||||
<h3>Returns</h3>
|
||||
<p>Previous node or NULL</p>
|
||||
@ -370,7 +440,7 @@ mxmlWalkPrev(
|
||||
</ul>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_attr_s">mxml_attr_s</a></h2>
|
||||
<p>Attribute Value</p>
|
||||
<p>An XML element attribute value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
struct mxml_attr_s
|
||||
@ -388,18 +458,18 @@ struct mxml_attr_s
|
||||
</tbody></table></p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_node_s">mxml_node_s</a></h2>
|
||||
<p>Node</p>
|
||||
<p>Data types...</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
struct mxml_node_s
|
||||
{
|
||||
mxml_node_t * child;
|
||||
mxml_node_t * last_child;
|
||||
mxml_node_t * next;
|
||||
mxml_node_t * parent;
|
||||
mxml_node_t * prev;
|
||||
mxml_type_t type;
|
||||
mxml_value_t value;
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * child;
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * last_child;
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * next;
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * parent;
|
||||
<a href="#mxml_node_t">mxml_node_t</a> * prev;
|
||||
<a href="#mxml_type_t">mxml_type_t</a> type;
|
||||
<a href="#mxml_value_t">mxml_value_t</a> value;
|
||||
};
|
||||
</pre>
|
||||
<h3>Members</h3>
|
||||
@ -416,7 +486,7 @@ struct mxml_node_s
|
||||
</tbody></table></p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_text_s">mxml_text_s</a></h2>
|
||||
<p>Text Value</p>
|
||||
<p>An XML text value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
struct mxml_text_s
|
||||
@ -434,12 +504,12 @@ struct mxml_text_s
|
||||
</tbody></table></p>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_value_s">mxml_value_s</a></h2>
|
||||
<p>Element Value</p>
|
||||
<p>An XML element value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
struct mxml_value_s
|
||||
{
|
||||
mxml_attr_t * attrs;
|
||||
<a href="#mxml_attr_t">mxml_attr_t</a> * attrs;
|
||||
char * name;
|
||||
int num_attrs;
|
||||
};
|
||||
@ -456,44 +526,52 @@ struct mxml_value_s
|
||||
<ul>
|
||||
<li><a href="#mxml_attr_t"><tt>mxml_attr_t</tt></a></li>
|
||||
<li><a href="#mxml_element_t"><tt>mxml_element_t</tt></a></li>
|
||||
<li><a href="#mxml_node_t"><tt>mxml_node_t</tt></a></li>
|
||||
<li><a href="#mxml_text_t"><tt>mxml_text_t</tt></a></li>
|
||||
<li><a href="#mxml_type_t"><tt>mxml_type_t</tt></a></li>
|
||||
<li><a href="#mxml_value_t"><tt>mxml_value_t</tt></a></li>
|
||||
</ul>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_attr_t">mxml_attr_t</a></h2>
|
||||
<p>Attribute Value</p>
|
||||
<p>An XML element attribute value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
typedef struct mxml_attr_s mxml_attr_t;
|
||||
typedef struct <a href="#mxml_attr_s">mxml_attr_s</a> mxml_attr_t;
|
||||
</pre>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_element_t">mxml_element_t</a></h2>
|
||||
<p>Element Value</p>
|
||||
<p>An XML element value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
typedef struct mxml_value_s mxml_element_t;
|
||||
typedef struct <a href="#mxml_value_s">mxml_value_s</a> mxml_element_t;
|
||||
</pre>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_node_t">mxml_node_t</a></h2>
|
||||
<p>An XML node.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
typedef struct <a href="#mxml_node_s">mxml_node_s</a> mxml_node_t;
|
||||
</pre>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_text_t">mxml_text_t</a></h2>
|
||||
<p>Text Value</p>
|
||||
<p>An XML text value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
typedef struct mxml_text_s mxml_text_t;
|
||||
typedef struct <a href="#mxml_text_s">mxml_text_s</a> mxml_text_t;
|
||||
</pre>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_type_t">mxml_type_t</a></h2>
|
||||
<p>Node Type</p>
|
||||
<p>The XML node type.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
typedef enum mxml_type_e mxml_type_t;
|
||||
typedef enum <a href="#mxml_type_e">mxml_type_e</a> mxml_type_t;
|
||||
</pre>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_value_t">mxml_value_t</a></h2>
|
||||
<p>Node Value</p>
|
||||
<p>An XML node value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
typedef union mxml_value_u mxml_value_t;
|
||||
typedef union <a href="#mxml_value_u">mxml_value_u</a> mxml_value_t;
|
||||
</pre>
|
||||
<h1><a name="_unions">Unions</a></h1>
|
||||
<ul>
|
||||
@ -501,16 +579,16 @@ typedef union mxml_value_u mxml_value_t;
|
||||
</ul>
|
||||
<hr noshade/>
|
||||
<h2><a name="mxml_value_u">mxml_value_u</a></h2>
|
||||
<p>Node Value</p>
|
||||
<p>An XML node value.</p>
|
||||
<h3>Definition</h3>
|
||||
<pre>
|
||||
struct mxml_value_u
|
||||
{
|
||||
mxml_element_t element;
|
||||
<a href="#mxml_element_t">mxml_element_t</a> element;
|
||||
int integer;
|
||||
char * opaque;
|
||||
double real;
|
||||
mxml_text_t text;
|
||||
<a href="#mxml_text_t">mxml_text_t</a> text;
|
||||
};
|
||||
</pre>
|
||||
<h3>Members</h3>
|
||||
|
||||
12
mxml-attr.c
12
mxml-attr.c
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* "$Id: mxml-attr.c,v 1.1 2003/06/03 19:46:30 mike Exp $"
|
||||
* "$Id: mxml-attr.c,v 1.2 2003/06/14 23:56:47 mike Exp $"
|
||||
*
|
||||
* Attribute support code for mini-XML, a small XML-like file parsing library.
|
||||
*
|
||||
@ -30,6 +30,9 @@
|
||||
|
||||
/*
|
||||
* 'mxmlElementGetAttr()' - Get an attribute.
|
||||
*
|
||||
* This function returns NULL if the node is not an element or the
|
||||
* named attribute does not exist.
|
||||
*/
|
||||
|
||||
const char * /* O - Attribute value or NULL */
|
||||
@ -67,6 +70,11 @@ mxmlElementGetAttr(mxml_node_t *node, /* I - Element node */
|
||||
|
||||
/*
|
||||
* 'mxmlElementSetAttr()' - Set an attribute.
|
||||
*
|
||||
* If the named attribute already exists, the value of the attribute
|
||||
* is replaced by the new string value. The string value is copied
|
||||
* into the element node. This function does nothing if the node is
|
||||
* not an element.
|
||||
*/
|
||||
|
||||
void
|
||||
@ -147,5 +155,5 @@ mxmlElementSetAttr(mxml_node_t *node, /* I - Element node */
|
||||
|
||||
|
||||
/*
|
||||
* End of "$Id: mxml-attr.c,v 1.1 2003/06/03 19:46:30 mike Exp $".
|
||||
* End of "$Id: mxml-attr.c,v 1.2 2003/06/14 23:56:47 mike Exp $".
|
||||
*/
|
||||
|
||||
25
mxml-file.c
25
mxml-file.c
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* "$Id: mxml-file.c,v 1.9 2003/06/04 23:20:31 mike Exp $"
|
||||
* "$Id: mxml-file.c,v 1.10 2003/06/14 23:56:47 mike Exp $"
|
||||
*
|
||||
* File loading code for mini-XML, a small XML-like file parsing library.
|
||||
*
|
||||
@ -46,13 +46,20 @@ static int mxml_write_ws(mxml_node_t *node, FILE *fp,
|
||||
|
||||
/*
|
||||
* 'mxmlLoadFile()' - Load a file into an XML node tree.
|
||||
*
|
||||
* The nodes in the specified file are added to the specified top node.
|
||||
* If no top node is provided, the XML file MUST be well-formed with a
|
||||
* single parent node like <?xml> for the entire file. The callback
|
||||
* function returns the value type that should be used for child nodes.
|
||||
* If MXML_NO_CALLBACK is specified then all child nodes will be either
|
||||
* MXML_ELEMENT or MXML_TEXT nodes.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - First node */
|
||||
mxml_node_t * /* O - First node or NULL if the file could not be read. */
|
||||
mxmlLoadFile(mxml_node_t *top, /* I - Top node */
|
||||
FILE *fp, /* I - File to read from */
|
||||
mxml_type_t (*cb)(mxml_node_t *))
|
||||
/* I - Callback function */
|
||||
/* I - Callback function or MXML_NO_CALLBACK */
|
||||
{
|
||||
mxml_node_t *node, /* Current node */
|
||||
*parent; /* Current parent node */
|
||||
@ -509,13 +516,19 @@ mxmlLoadFile(mxml_node_t *top, /* I - Top node */
|
||||
|
||||
/*
|
||||
* 'mxmlSaveFile()' - Save an XML tree to a file.
|
||||
*
|
||||
* The callback argument specifies a function that returns a whitespace
|
||||
* character or nul (0) before and after each element. If MXML_NO_CALLBACK
|
||||
* is specified, whitespace will only be added before MXML_TEXT nodes
|
||||
* with leading whitespace and before attribute names inside opening
|
||||
* element tags.
|
||||
*/
|
||||
|
||||
int /* O - 0 on success, -1 on error */
|
||||
int /* O - 0 on success, -1 on error. */
|
||||
mxmlSaveFile(mxml_node_t *node, /* I - Node to write */
|
||||
FILE *fp, /* I - File to write to */
|
||||
int (*cb)(mxml_node_t *, int))
|
||||
/* I - Whitespace callback */
|
||||
/* I - Whitespace callback or MXML_NO_CALLBACK */
|
||||
{
|
||||
int col; /* Final column */
|
||||
|
||||
@ -999,5 +1012,5 @@ mxml_write_ws(mxml_node_t *node, /* I - Current node */
|
||||
|
||||
|
||||
/*
|
||||
* End of "$Id: mxml-file.c,v 1.9 2003/06/04 23:20:31 mike Exp $".
|
||||
* End of "$Id: mxml-file.c,v 1.10 2003/06/14 23:56:47 mike Exp $".
|
||||
*/
|
||||
|
||||
58
mxml-node.c
58
mxml-node.c
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* "$Id: mxml-node.c,v 1.4 2003/06/05 03:06:20 mike Exp $"
|
||||
* "$Id: mxml-node.c,v 1.5 2003/06/14 23:56:47 mike Exp $"
|
||||
*
|
||||
* Node support code for mini-XML, a small XML-like file parsing library.
|
||||
*
|
||||
@ -44,12 +44,19 @@ static mxml_node_t *mxml_new(mxml_node_t *parent, mxml_type_t type);
|
||||
|
||||
/*
|
||||
* 'mxmlAdd()' - Add a node to a tree.
|
||||
*
|
||||
* Adds the specified node to the parent. If the child argument is not
|
||||
* NULL, puts the new node before or after the specified child depending
|
||||
* on the value of the where argument. If the child argument is NULL,
|
||||
* puts the new node at the beginning of the child list (MXML_ADD_BEFORE)
|
||||
* or at the end of the child list (MXML_ADD_AFTER). The constant
|
||||
* MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.
|
||||
*/
|
||||
|
||||
void
|
||||
mxmlAdd(mxml_node_t *parent, /* I - Parent node */
|
||||
int where, /* I - Where to add */
|
||||
mxml_node_t *child, /* I - Child node for where */
|
||||
int where, /* I - Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER */
|
||||
mxml_node_t *child, /* I - Child node for where or MXML_ADD_TO_PARENT */
|
||||
mxml_node_t *node) /* I - Node to add */
|
||||
{
|
||||
/* fprintf(stderr, "mxmlAdd(parent=%p, where=%d, child=%p, node=%p)\n", parent,
|
||||
@ -151,10 +158,13 @@ mxmlAdd(mxml_node_t *parent, /* I - Parent node */
|
||||
|
||||
/*
|
||||
* 'mxmlDelete()' - Delete a node and all of its children.
|
||||
*
|
||||
* If the specified node has a parent, this function first removes the
|
||||
* node from its parent using the mxmlRemove() function.
|
||||
*/
|
||||
|
||||
void
|
||||
mxmlDelete(mxml_node_t *node) /* I - Node */
|
||||
mxmlDelete(mxml_node_t *node) /* I - Node to delete */
|
||||
{
|
||||
int i; /* Looping var */
|
||||
|
||||
@ -230,10 +240,14 @@ mxmlDelete(mxml_node_t *node) /* I - Node */
|
||||
|
||||
/*
|
||||
* 'mxmlNewElement()' - Create a new element node.
|
||||
*
|
||||
* The new element node is added to the end of the specified parent's child
|
||||
* list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
* element node has no parent.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - New node */
|
||||
mxmlNewElement(mxml_node_t *parent, /* I - Parent node */
|
||||
mxmlNewElement(mxml_node_t *parent, /* I - Parent node or MXML_NO_PARENT */
|
||||
const char *name) /* I - Name of element */
|
||||
{
|
||||
mxml_node_t *node; /* New node */
|
||||
@ -259,10 +273,14 @@ mxmlNewElement(mxml_node_t *parent, /* I - Parent node */
|
||||
|
||||
/*
|
||||
* 'mxmlNewInteger()' - Create a new integer node.
|
||||
*
|
||||
* The new integer node is added to the end of the specified parent's child
|
||||
* list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
* integer node has no parent.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - New node */
|
||||
mxmlNewInteger(mxml_node_t *parent, /* I - Parent node */
|
||||
mxmlNewInteger(mxml_node_t *parent, /* I - Parent node or MXML_NO_PARENT */
|
||||
int integer) /* I - Integer value */
|
||||
{
|
||||
mxml_node_t *node; /* New node */
|
||||
@ -288,10 +306,15 @@ mxmlNewInteger(mxml_node_t *parent, /* I - Parent node */
|
||||
|
||||
/*
|
||||
* 'mxmlNewOpaque()' - Create a new opaque string.
|
||||
*
|
||||
* The new opaque node is added to the end of the specified parent's child
|
||||
* list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
* opaque node has no parent. The opaque string must be nul-terminated and
|
||||
* is copied into the new node.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - New node */
|
||||
mxmlNewOpaque(mxml_node_t *parent, /* I - Parent node */
|
||||
mxmlNewOpaque(mxml_node_t *parent, /* I - Parent node or MXML_NO_PARENT */
|
||||
const char *opaque) /* I - Opaque string */
|
||||
{
|
||||
mxml_node_t *node; /* New node */
|
||||
@ -317,10 +340,14 @@ mxmlNewOpaque(mxml_node_t *parent, /* I - Parent node */
|
||||
|
||||
/*
|
||||
* 'mxmlNewReal()' - Create a new real number node.
|
||||
*
|
||||
* The new real number node is added to the end of the specified parent's
|
||||
* child list. The constant MXML_NO_PARENT can be used to specify that
|
||||
* the new real number node has no parent.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - New node */
|
||||
mxmlNewReal(mxml_node_t *parent, /* I - Parent node */
|
||||
mxmlNewReal(mxml_node_t *parent, /* I - Parent node or MXML_NO_PARENT */
|
||||
double real) /* I - Real number value */
|
||||
{
|
||||
mxml_node_t *node; /* New node */
|
||||
@ -346,11 +373,17 @@ mxmlNewReal(mxml_node_t *parent, /* I - Parent node */
|
||||
|
||||
/*
|
||||
* 'mxmlNewText()' - Create a new text fragment node.
|
||||
*
|
||||
* The new text node is added to the end of the specified parent's child
|
||||
* list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
* text node has no parent. The whitespace parameter is used to specify
|
||||
* whether leading whitespace is present before the node. The text
|
||||
* string must be nul-terminated and is copied into the new node.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - New node */
|
||||
mxmlNewText(mxml_node_t *parent, /* I - Parent node */
|
||||
int whitespace, /* I - Leading whitespace? */
|
||||
mxmlNewText(mxml_node_t *parent, /* I - Parent node or MXML_NO_PARENT */
|
||||
int whitespace, /* I - 1 = leading whitespace, 0 = no whitespace */
|
||||
const char *string) /* I - String */
|
||||
{
|
||||
mxml_node_t *node; /* New node */
|
||||
@ -379,6 +412,9 @@ mxmlNewText(mxml_node_t *parent, /* I - Parent node */
|
||||
|
||||
/*
|
||||
* 'mxmlRemove()' - Remove a node from its parent.
|
||||
*
|
||||
* Does not free memory used by the node - use mxmlDelete() for that.
|
||||
* This function does nothing if the node has no parent.
|
||||
*/
|
||||
|
||||
void
|
||||
@ -453,5 +489,5 @@ mxml_new(mxml_node_t *parent, /* I - Parent node */
|
||||
|
||||
|
||||
/*
|
||||
* End of "$Id: mxml-node.c,v 1.4 2003/06/05 03:06:20 mike Exp $".
|
||||
* End of "$Id: mxml-node.c,v 1.5 2003/06/14 23:56:47 mike Exp $".
|
||||
*/
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* "$Id: mxml-search.c,v 1.5 2003/06/06 03:09:31 mike Exp $"
|
||||
* "$Id: mxml-search.c,v 1.6 2003/06/14 23:56:47 mike Exp $"
|
||||
*
|
||||
* Search/navigation functions for mini-XML, a small XML-like file
|
||||
* parsing library.
|
||||
@ -32,6 +32,15 @@
|
||||
|
||||
/*
|
||||
* 'mxmlFindElement()' - Find the named element.
|
||||
*
|
||||
* The search is constrained by the name, attribute name, and value; any
|
||||
* NULL names or values are treated as wildcards, so different kinds of
|
||||
* searches can be implemented by looking for all elements of a given name
|
||||
* or all elements with a specific attribute. The descend argument determines
|
||||
* whether the search descends into child nodes; normally you will use
|
||||
* MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find
|
||||
* additional direct descendents of the node. The top node argument
|
||||
* constrains the search to a particular node's children.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - Element node or NULL */
|
||||
@ -40,7 +49,7 @@ mxmlFindElement(mxml_node_t *node, /* I - Current node */
|
||||
const char *name, /* I - Element name or NULL for any */
|
||||
const char *attr, /* I - Attribute name, or NULL for none */
|
||||
const char *value, /* I - Attribute value, or NULL for any */
|
||||
int descend) /* I - Descend into tree? */
|
||||
int descend) /* I - Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST */
|
||||
{
|
||||
const char *temp; /* Current attribute value */
|
||||
|
||||
@ -110,12 +119,16 @@ mxmlFindElement(mxml_node_t *node, /* I - Current node */
|
||||
|
||||
/*
|
||||
* 'mxmlWalkNext()' - Walk to the next logical node in the tree.
|
||||
*
|
||||
* The descend argument controls whether the first child is considered
|
||||
* to be the next node. The top node argument constrains the walk to
|
||||
* the node's children.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - Next node or NULL */
|
||||
mxmlWalkNext(mxml_node_t *node, /* I - Current node */
|
||||
mxml_node_t *top, /* I - Top node */
|
||||
int descend) /* I - Descend into tree? */
|
||||
int descend) /* I - Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST */
|
||||
{
|
||||
if (!node)
|
||||
return (NULL);
|
||||
@ -142,12 +155,16 @@ mxmlWalkNext(mxml_node_t *node, /* I - Current node */
|
||||
|
||||
/*
|
||||
* 'mxmlWalkPrev()' - Walk to the previous logical node in the tree.
|
||||
*
|
||||
* The descend argument controls whether the previous node's last child
|
||||
* is considered to be the previous node. The top node argument constrains
|
||||
* the walk to the node's children.
|
||||
*/
|
||||
|
||||
mxml_node_t * /* O - Previous node or NULL */
|
||||
mxmlWalkPrev(mxml_node_t *node, /* I - Current node */
|
||||
mxml_node_t *top, /* I - Top node */
|
||||
int descend) /* I - Descend into tree? */
|
||||
int descend) /* I - Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST */
|
||||
{
|
||||
if (!node)
|
||||
return (NULL);
|
||||
@ -177,5 +194,5 @@ mxmlWalkPrev(mxml_node_t *node, /* I - Current node */
|
||||
|
||||
|
||||
/*
|
||||
* End of "$Id: mxml-search.c,v 1.5 2003/06/06 03:09:31 mike Exp $".
|
||||
* End of "$Id: mxml-search.c,v 1.6 2003/06/14 23:56:47 mike Exp $".
|
||||
*/
|
||||
|
||||
18
mxml.h
18
mxml.h
@ -1,5 +1,5 @@
|
||||
/*
|
||||
* "$Id: mxml.h,v 1.8 2003/06/07 21:27:05 mike Exp $"
|
||||
* "$Id: mxml.h,v 1.9 2003/06/14 23:56:47 mike Exp $"
|
||||
*
|
||||
* Header file for mini-XML, a small XML-like file parsing library.
|
||||
*
|
||||
@ -62,7 +62,7 @@
|
||||
* Data types...
|
||||
*/
|
||||
|
||||
typedef enum mxml_type_e /**** Node Type ****/
|
||||
typedef enum mxml_type_e /**** The XML node type. ****/
|
||||
{
|
||||
MXML_ELEMENT, /* XML element with attributes */
|
||||
MXML_INTEGER, /* Integer value */
|
||||
@ -71,26 +71,26 @@ typedef enum mxml_type_e /**** Node Type ****/
|
||||
MXML_TEXT /* Text fragment */
|
||||
} mxml_type_t;
|
||||
|
||||
typedef struct mxml_attr_s /**** Attribute Value ****/
|
||||
typedef struct mxml_attr_s /**** An XML element attribute value. ****/
|
||||
{
|
||||
char *name; /* Attribute name */
|
||||
char *value; /* Attribute value */
|
||||
} mxml_attr_t;
|
||||
|
||||
typedef struct mxml_value_s /**** Element Value ****/
|
||||
typedef struct mxml_value_s /**** An XML element value. ****/
|
||||
{
|
||||
char *name; /* Name of element */
|
||||
int num_attrs; /* Number of attributes */
|
||||
mxml_attr_t *attrs; /* Attributes */
|
||||
} mxml_element_t;
|
||||
|
||||
typedef struct mxml_text_s /**** Text Value ****/
|
||||
typedef struct mxml_text_s /**** An XML text value. ****/
|
||||
{
|
||||
int whitespace; /* Leading whitespace? */
|
||||
char *string; /* Fragment string */
|
||||
} mxml_text_t;
|
||||
|
||||
typedef union mxml_value_u /**** Node Value ****/
|
||||
typedef union mxml_value_u /**** An XML node value. ****/
|
||||
{
|
||||
mxml_element_t element; /* Element */
|
||||
int integer; /* Integer number */
|
||||
@ -99,9 +99,9 @@ typedef union mxml_value_u /**** Node Value ****/
|
||||
mxml_text_t text; /* Text fragment */
|
||||
} mxml_value_t;
|
||||
|
||||
typedef struct mxml_node_s mxml_node_t;
|
||||
typedef struct mxml_node_s mxml_node_t; /**** An XML node. ****/
|
||||
|
||||
struct mxml_node_s /**** Node ****/
|
||||
struct mxml_node_s /**** An XML node. ****/
|
||||
{
|
||||
mxml_type_t type; /* Node type */
|
||||
mxml_node_t *next; /* Next node under same parent */
|
||||
@ -162,5 +162,5 @@ extern mxml_node_t *mxmlWalkPrev(mxml_node_t *node, mxml_node_t *top,
|
||||
|
||||
|
||||
/*
|
||||
* End of "$Id: mxml.h,v 1.8 2003/06/07 21:27:05 mike Exp $".
|
||||
* End of "$Id: mxml.h,v 1.9 2003/06/14 23:56:47 mike Exp $".
|
||||
*/
|
||||
|
||||
163
mxml.xml
163
mxml.xml
@ -1,104 +1,178 @@
|
||||
<?xml version="1.0"?>
|
||||
<function name="mxmlAdd"><description>Add a node to a tree.</description><argument
|
||||
<function name="mxmlAdd"><description>Add a node to a tree.
|
||||
|
||||
Adds the specified node to the parent. If the child argument is not
|
||||
NULL, puts the new node before or after the specified child depending
|
||||
on the value of the where argument. If the child argument is NULL,
|
||||
puts the new node at the beginning of the child list (MXML_ADD_BEFORE)
|
||||
or at the end of the child list (MXML_ADD_AFTER). The constant
|
||||
MXML_ADD_TO_PARENT can be used to specify a NULL child pointer.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node</description></argument>
|
||||
<argument name="where" direction="I"><type>int</type><description>Where to add</description></argument>
|
||||
<argument name="child" direction="I"><type>mxml_node_t *</type><description>Child node for where</description></argument>
|
||||
<argument name="where" direction="I"><type>int</type><description>Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER</description></argument>
|
||||
<argument name="child" direction="I"><type>mxml_node_t *</type><description>Child node for where or MXML_ADD_TO_PARENT</description></argument>
|
||||
<argument name="node" direction="I"><type>mxml_node_t *</type><description>Node to add</description></argument>
|
||||
</function>
|
||||
<function name="mxmlDelete"><description>Delete a node and all of its children.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Node</description></argument>
|
||||
<function name="mxmlDelete"><description>Delete a node and all of its children.
|
||||
|
||||
If the specified node has a parent, this function first removes the
|
||||
node from its parent using the mxmlRemove() function.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Node to delete</description></argument>
|
||||
</function>
|
||||
<function name="mxmlElementGetAttr"><returnvalue><description>Attribute value or NULL</description><type>const
|
||||
char *</type></returnvalue>
|
||||
<description>Get an attribute.</description><argument name="node"
|
||||
direction="I"><type>mxml_node_t *</type><description>Element node</description></argument>
|
||||
<description>Get an attribute.
|
||||
|
||||
This function returns NULL if the node is not an element or the
|
||||
named attribute does not exist.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Element node</description></argument>
|
||||
<argument name="name" direction="I"><type>const char *</type><description>Name of attribute</description></argument>
|
||||
</function>
|
||||
<function name="mxmlElementSetAttr"><description>Set an attribute.</description><argument
|
||||
<function name="mxmlElementSetAttr"><description>Set an attribute.
|
||||
|
||||
If the named attribute already exists, the value of the attribute
|
||||
is replaced by the new string value. The string value is copied
|
||||
into the element node. This function does nothing if the node is
|
||||
not an element.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Element node</description></argument>
|
||||
<argument name="name" direction="I"><type>const char *</type><description>Name of attribute</description></argument>
|
||||
<argument name="value" direction="I"><type>const char *</type><description>Attribute value</description></argument>
|
||||
</function>
|
||||
<function name="mxmlFindElement"><returnvalue><description>Element node or NULL</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Find the named element.</description><argument name="node"
|
||||
direction="I"><type>mxml_node_t *</type><description>Current node</description></argument>
|
||||
<description>Find the named element.
|
||||
|
||||
The search is constrained by the name, attribute name, and value; any
|
||||
NULL names or values are treated as wildcards, so different kinds of
|
||||
searches can be implemented by looking for all elements of a given name
|
||||
or all elements with a specific attribute. The descend argument determines
|
||||
whether the search descends into child nodes; normally you will use
|
||||
MXML_DESCEND_FIRST for the initial search and MXML_NO_DESCEND to find
|
||||
additional direct descendents of the node. The top node argument
|
||||
constrains the search to a particular node's children.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Current node</description></argument>
|
||||
<argument name="top" direction="I"><type>mxml_node_t *</type><description>Top node</description></argument>
|
||||
<argument name="name" direction="I"><type>const char *</type><description>Element name or NULL for any</description></argument>
|
||||
<argument name="attr" direction="I"><type>const char *</type><description>Attribute name, or NULL for none</description></argument>
|
||||
<argument name="value" direction="I"><type>const char *</type><description>Attribute value, or NULL for any</description></argument>
|
||||
<argument name="descend" direction="I"><type>int</type><description>Descend into tree?</description></argument>
|
||||
<argument name="descend" direction="I"><type>int</type><description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description></argument>
|
||||
</function>
|
||||
<function name="mxmlLoadFile"><returnvalue><description>First node</description><type>mxml_node_t
|
||||
<function name="mxmlLoadFile"><returnvalue><description>First node or NULL if the file could not be read.</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Load a file into an XML node tree.</description><argument
|
||||
<description>Load a file into an XML node tree.
|
||||
|
||||
The nodes in the specified file are added to the specified top node.
|
||||
If no top node is provided, the XML file MUST be well-formed with a
|
||||
single parent node like <?xml> for the entire file. The callback
|
||||
function returns the value type that should be used for child nodes.
|
||||
If MXML_NO_CALLBACK is specified then all child nodes will be either
|
||||
MXML_ELEMENT or MXML_TEXT nodes.</description><argument
|
||||
name="top" direction="I"><type>mxml_node_t *</type><description>Top node</description></argument>
|
||||
<argument name="fp" direction="I"><type>FILE *</type><description>File to read from</description></argument>
|
||||
<argument name="(*cb)(mxml_node_t *)" direction="I"><type>mxml_type_t</type><description>Callback function</description></argument>
|
||||
<argument name="(*cb)(mxml_node_t *)" direction="I"><type>mxml_type_t</type><description>Callback function or MXML_NO_CALLBACK</description></argument>
|
||||
</function>
|
||||
<function name="mxmlNewElement"><returnvalue><description>New node</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Create a new element node.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node</description></argument>
|
||||
<description>Create a new element node.
|
||||
|
||||
The new element node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
element node has no parent.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node or MXML_NO_PARENT</description></argument>
|
||||
<argument name="name" direction="I"><type>const char *</type><description>Name of element</description></argument>
|
||||
</function>
|
||||
<function name="mxmlNewInteger"><returnvalue><description>New node</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Create a new integer node.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node</description></argument>
|
||||
<description>Create a new integer node.
|
||||
|
||||
The new integer node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
integer node has no parent.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node or MXML_NO_PARENT</description></argument>
|
||||
<argument name="integer" direction="I"><type>int</type><description>Integer value</description></argument>
|
||||
</function>
|
||||
<function name="mxmlNewOpaque"><returnvalue><description>New node</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Create a new opaque string.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node</description></argument>
|
||||
<description>Create a new opaque string.
|
||||
|
||||
The new opaque node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
opaque node has no parent. The opaque string must be nul-terminated and
|
||||
is copied into the new node.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node or MXML_NO_PARENT</description></argument>
|
||||
<argument name="opaque" direction="I"><type>const char *</type><description>Opaque string</description></argument>
|
||||
</function>
|
||||
<function name="mxmlNewReal"><returnvalue><description>New node</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Create a new real number node.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node</description></argument>
|
||||
<description>Create a new real number node.
|
||||
|
||||
The new real number node is added to the end of the specified parent's
|
||||
child list. The constant MXML_NO_PARENT can be used to specify that
|
||||
the new real number node has no parent.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node or MXML_NO_PARENT</description></argument>
|
||||
<argument name="real" direction="I"><type>double</type><description>Real number value</description></argument>
|
||||
</function>
|
||||
<function name="mxmlNewText"><returnvalue><description>New node</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Create a new text fragment node.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node</description></argument>
|
||||
<argument name="whitespace" direction="I"><type>int</type><description>Leading whitespace?</description></argument>
|
||||
<description>Create a new text fragment node.
|
||||
|
||||
The new text node is added to the end of the specified parent's child
|
||||
list. The constant MXML_NO_PARENT can be used to specify that the new
|
||||
text node has no parent. The whitespace parameter is used to specify
|
||||
whether leading whitespace is present before the node. The text
|
||||
string must be nul-terminated and is copied into the new node.</description><argument
|
||||
name="parent" direction="I"><type>mxml_node_t *</type><description>Parent node or MXML_NO_PARENT</description></argument>
|
||||
<argument name="whitespace" direction="I"><type>int</type><description>1 = leading whitespace, 0 = no whitespace</description></argument>
|
||||
<argument name="string" direction="I"><type>const char *</type><description>String</description></argument>
|
||||
</function>
|
||||
<function name="mxmlRemove"><description>Remove a node from its parent.</description><argument
|
||||
<function name="mxmlRemove"><description>Remove a node from its parent.
|
||||
|
||||
Does not free memory used by the node - use mxmlDelete() for that.
|
||||
This function does nothing if the node has no parent.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Node to remove</description></argument>
|
||||
</function>
|
||||
<function name="mxmlSaveFile"><returnvalue><description>0 on success, -1 on error</description><type>int</type></returnvalue>
|
||||
<description>Save an XML tree to a file.</description><argument
|
||||
<function name="mxmlSaveFile"><returnvalue><description>0 on success, -1 on error.</description><type>int</type></returnvalue>
|
||||
<description>Save an XML tree to a file.
|
||||
|
||||
The callback argument specifies a function that returns a whitespace
|
||||
character or nul (0) before and after each element. If MXML_NO_CALLBACK
|
||||
is specified, whitespace will only be added before MXML_TEXT nodes
|
||||
with leading whitespace and before attribute names inside opening
|
||||
element tags.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Node to write</description></argument>
|
||||
<argument name="fp" direction="I"><type>FILE *</type><description>File to write to</description></argument>
|
||||
<argument name="(*cb)(mxml_node_t *int)" direction="I"><type>int</type><description>Whitespace callback</description></argument>
|
||||
<argument name="(*cb)(mxml_node_t *int)" direction="I"><type>int</type><description>Whitespace callback or MXML_NO_CALLBACK</description></argument>
|
||||
</function>
|
||||
<function name="mxmlWalkNext"><returnvalue><description>Next node or NULL</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Walk to the next logical node in the tree.</description><argument
|
||||
<description>Walk to the next logical node in the tree.
|
||||
|
||||
The descend argument controls whether the first child is considered
|
||||
to be the next node. The top node argument constrains the walk to
|
||||
the node's children.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Current node</description></argument>
|
||||
<argument name="top" direction="I"><type>mxml_node_t *</type><description>Top node</description></argument>
|
||||
<argument name="descend" direction="I"><type>int</type><description>Descend into tree?</description></argument>
|
||||
<argument name="descend" direction="I"><type>int</type><description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description></argument>
|
||||
</function>
|
||||
<function name="mxmlWalkPrev"><returnvalue><description>Previous node or NULL</description><type>mxml_node_t
|
||||
*</type></returnvalue>
|
||||
<description>Walk to the previous logical node in the tree.</description><argument
|
||||
<description>Walk to the previous logical node in the tree.
|
||||
|
||||
The descend argument controls whether the previous node's last child
|
||||
is considered to be the previous node. The top node argument constrains
|
||||
the walk to the node's children.</description><argument
|
||||
name="node" direction="I"><type>mxml_node_t *</type><description>Current node</description></argument>
|
||||
<argument name="top" direction="I"><type>mxml_node_t *</type><description>Top node</description></argument>
|
||||
<argument name="descend" direction="I"><type>int</type><description>Descend into tree?</description></argument>
|
||||
<argument name="descend" direction="I"><type>int</type><description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description></argument>
|
||||
</function>
|
||||
<struct name="mxml_attr_s"><description>Attribute Value</description><variable
|
||||
<struct name="mxml_attr_s"><description>An XML element attribute value.</description><variable
|
||||
name="name"><type>char *</type><description>Attribute name</description></variable>
|
||||
<variable name="value"><type>char *</type><description>Attribute value</description></variable>
|
||||
</struct>
|
||||
<typedef name="mxml_attr_t"><description>Attribute Value</description><type>struct
|
||||
<typedef name="mxml_attr_t"><description>An XML element attribute value.</description><type>struct
|
||||
mxml_attr_s</type></typedef>
|
||||
<typedef name="mxml_element_t"><description>Element Value</description><type>struct
|
||||
<typedef name="mxml_element_t"><description>An XML element value.</description><type>struct
|
||||
mxml_value_s</type></typedef>
|
||||
<struct name="mxml_node_s"><description>Node</description><variable
|
||||
<struct name="mxml_node_s"><description>Data types...</description><variable
|
||||
name="child"><type>mxml_node_t *</type><description>First child node</description></variable>
|
||||
<variable name="last_child"><type>mxml_node_t *</type><description>Last child node</description></variable>
|
||||
<variable name="next"><type>mxml_node_t *</type><description>Next node under same parent</description></variable>
|
||||
@ -107,29 +181,30 @@ name="child"><type>mxml_node_t *</type><description>First child node</descriptio
|
||||
<variable name="type"><type>mxml_type_t</type><description>Node type</description></variable>
|
||||
<variable name="value"><type>mxml_value_t</type><description>Node value</description></variable>
|
||||
</struct>
|
||||
<struct name="mxml_text_s"><description>Text Value</description><variable
|
||||
<typedef name="mxml_node_t"><type>struct mxml_node_s</type><description>An XML node.</description><description>An XML node.</description></typedef>
|
||||
<struct name="mxml_text_s"><description>An XML text value.</description><variable
|
||||
name="string"><type>char *</type><description>Fragment string</description></variable>
|
||||
<variable name="whitespace"><type>int</type><description>Leading whitespace?</description></variable>
|
||||
</struct>
|
||||
<typedef name="mxml_text_t"><description>Text Value</description><type>struct
|
||||
<typedef name="mxml_text_t"><description>An XML text value.</description><type>struct
|
||||
mxml_text_s</type></typedef>
|
||||
<enumeration name="mxml_type_e"><description>Node Type</description><constant
|
||||
<enumeration name="mxml_type_e"><description>The XML node type.</description><constant
|
||||
name="MXML_ELEMENT"><description>XML element with attributes</description></constant>
|
||||
<constant name="MXML_INTEGER"><description>Integer value</description></constant>
|
||||
<constant name="MXML_OPAQUE"><description>Opaque string</description></constant>
|
||||
<constant name="MXML_REAL"><description>Real value</description></constant>
|
||||
<constant name="MXML_TEXT"><description>Text fragment</description></constant>
|
||||
</enumeration>
|
||||
<typedef name="mxml_type_t"><description>Node Type</description><type>enum
|
||||
<typedef name="mxml_type_t"><description>The XML node type.</description><type>enum
|
||||
mxml_type_e</type></typedef>
|
||||
<struct name="mxml_value_s"><description>Element Value</description><variable
|
||||
<struct name="mxml_value_s"><description>An XML element value.</description><variable
|
||||
name="attrs"><type>mxml_attr_t *</type><description>Attributes</description></variable>
|
||||
<variable name="name"><type>char *</type><description>Name of element</description></variable>
|
||||
<variable name="num_attrs"><type>int</type><description>Number of attributes</description></variable>
|
||||
</struct>
|
||||
<typedef name="mxml_value_t"><description>Node Value</description><type>union
|
||||
<typedef name="mxml_value_t"><description>An XML node value.</description><type>union
|
||||
mxml_value_u</type></typedef>
|
||||
<union name="mxml_value_u"><description>Node Value</description><variable
|
||||
<union name="mxml_value_u"><description>An XML node value.</description><variable
|
||||
name="element"><type>mxml_element_t</type><description>Element</description></variable>
|
||||
<variable name="integer"><type>int</type><description>Integer number</description></variable>
|
||||
<variable name="opaque"><type>char *</type><description>Opaque string</description></variable>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user