mirror of
https://github.com/michaelrsweet/mxml.git
synced 2024-11-08 13:39:58 +00:00
337baeddb5
Prep for new "standard" opaque, integer, etc. callbacks. Add new vsnprintf check. Drop old string function checks for functions we don't actually use.
293 lines
18 KiB
XML
293 lines
18 KiB
XML
<?xml version="1.0"?>
|
|
<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="node" direction="I"><type>mxml_node_t *parent, int where, mxml_node_t
|
|
*child, mxml_node_t *</type><description>Node to add</description></argument>
|
|
</function>
|
|
<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.
|
|
|
|
This function returns NULL if the node is not an element or the
|
|
named attribute does not exist.</description><argument
|
|
name="name" direction="I"><type>mxml_node_t *node, const char *</type><description>Name of attribute</description></argument>
|
|
</function>
|
|
<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="value" direction="I"><type>mxml_node_t *node, const char *name, 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.
|
|
|
|
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="descend" direction="I"><type>mxml_node_t *node, mxml_node_t *top, const
|
|
char *name, const char *attr, const char *value, 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 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.
|
|
|
|
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="(*cb)(mxml_node_t *node)" direction="I"><type>mxml_node_t *top, FILE
|
|
*fp, mxml_type_t</type><description>Callback function or MXML_NO_CALLBACK</description></argument>
|
|
</function>
|
|
<function name="mxmlLoadString"><returnvalue><description>First node or NULL if the string has errors.</description><type>mxml_node_t
|
|
*</type></returnvalue>
|
|
<description>Load a string into an XML node tree.
|
|
|
|
The nodes in the specified string are added to the specified top node.
|
|
If no top node is provided, the XML string MUST be well-formed with a
|
|
single parent node like <?xml> for the entire string. 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="(*cb)(mxml_node_t *node)" direction="I"><type>mxml_node_t *top, const
|
|
char *s, 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.
|
|
|
|
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="name" direction="I"><type>mxml_node_t *parent, 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.
|
|
|
|
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="integer" direction="I"><type>mxml_node_t *parent, 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.
|
|
|
|
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="opaque" direction="I"><type>mxml_node_t *parent, 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.
|
|
|
|
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="real" direction="I"><type>mxml_node_t *parent, 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.
|
|
|
|
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="string" direction="I"><type>mxml_node_t *parent, int whitespace, const
|
|
char *</type><description>String</description></argument>
|
|
</function>
|
|
<function name="mxmlNewTextf"><returnvalue><description>New node</description><type>mxml_node_t
|
|
*</type></returnvalue>
|
|
<description>Create a new formatted 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 format
|
|
string must be nul-terminated and is formatted into the new node.</description><argument
|
|
name="format," direction="I"><type>mxml_node_t *parent, int whitespace, const
|
|
char *</type><description>Additional args as needed</description></argument>
|
|
</function>
|
|
<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="mxmlSaveAllocString"><returnvalue><description>Allocated string or NULL</description><type>char
|
|
*</type></returnvalue>
|
|
<description>Save an XML node tree to an allocated string.
|
|
|
|
This function returns a pointer to a string containing the textual
|
|
representation of the XML node tree. The string should be freed
|
|
using the free() function when you are done with it. NULL is returned
|
|
if the node would produce an empty string or if the string cannot be
|
|
allocated.</description><argument
|
|
name="(*cb)(mxml_node_t *node, int ws)" direction="I"><type>mxml_node_t *node,
|
|
int</type><description>Whitespace callback or MXML_NO_CALLBACK</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.
|
|
|
|
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="(*cb)(mxml_node_t *node, int ws)" direction="I"><type>mxml_node_t *node,
|
|
FILE *fp, int</type><description>Whitespace callback or MXML_NO_CALLBACK</description></argument>
|
|
</function>
|
|
<function name="mxmlSaveString"><returnvalue><description>Size of string</description><type>int</type></returnvalue>
|
|
<description>Save an XML node tree to a string.
|
|
|
|
This function returns the total number of bytes that would be
|
|
required for the string but only copies (bufsize - 1) characters
|
|
into the specified buffer.</description><argument
|
|
name="(*cb)(mxml_node_t *node, int ws)" direction="I"><type>mxml_node_t *node,
|
|
char *buffer, int bufsize, int</type><description>Whitespace callback or MXML_NO_CALLBACK</description></argument>
|
|
</function>
|
|
<function name="mxmlSetElement"><returnvalue><description>0 on success, -1 on failure</description><type>int</type></returnvalue>
|
|
<description>Set the name of an element node.
|
|
|
|
If the node is not changed if it is not an element node.</description><argument
|
|
name="name" direction="I"><type>mxml_node_t *node, const char *</type><description>New name string</description></argument>
|
|
</function>
|
|
<function name="mxmlSetInteger"><returnvalue><description>0 on success, -1 on failure</description><type>int</type></returnvalue>
|
|
<description>Set the value of an integer node.
|
|
|
|
If the node is not changed if it is not an integer node.</description><argument
|
|
name="integer" direction="I"><type>mxml_node_t *node, int</type><description>Integer value</description></argument>
|
|
</function>
|
|
<function name="mxmlSetOpaque"><returnvalue><description>0 on success, -1 on failure</description><type>int</type></returnvalue>
|
|
<description>Set the value of an opaque node.
|
|
|
|
If the node is not changed if it is not an opaque node.</description><argument
|
|
name="opaque" direction="I"><type>mxml_node_t *node, const char *</type><description>Opaque string</description></argument>
|
|
</function>
|
|
<function name="mxmlSetReal"><returnvalue><description>0 on success, -1 on failure</description><type>int</type></returnvalue>
|
|
<description>Set the value of a real number node.
|
|
|
|
If the node is not changed if it is not a real number node.</description><argument
|
|
name="real" direction="I"><type>mxml_node_t *node, double</type><description>Real number value</description></argument>
|
|
</function>
|
|
<function name="mxmlSetText"><returnvalue><description>0 on success, -1 on failure</description><type>int</type></returnvalue>
|
|
<description>Set the value of a text node.
|
|
|
|
If the node is not changed if it is not a text node.</description><argument
|
|
name="string" direction="I"><type>mxml_node_t *node, int whitespace, const
|
|
char *</type><description>String</description></argument>
|
|
</function>
|
|
<function name="mxmlSetTextf"><returnvalue><description>0 on success, -1 on failure</description><type>int</type></returnvalue>
|
|
<description>Set the value of a text node to a formatted string.
|
|
|
|
If the node is not changed if it is not a text node.</description><argument
|
|
name="format," direction="I"><type>mxml_node_t *node, int whitespace, const
|
|
char *</type><description>Additional arguments as needed</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.
|
|
|
|
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="descend" direction="I"><type>mxml_node_t *node, mxml_node_t *top, 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.
|
|
|
|
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="descend" direction="I"><type>mxml_node_t *node, mxml_node_t *top, int</type><description>Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST</description></argument>
|
|
</function>
|
|
<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>An XML element attribute value.</description><type>struct
|
|
mxml_attr_s</type></typedef>
|
|
<typedef name="mxml_element_t"><description>An XML element value.</description><type>struct
|
|
mxml_value_s</type></typedef>
|
|
<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>
|
|
<variable name="parent"><type>mxml_node_t *</type><description>Parent node</description></variable>
|
|
<variable name="prev"><type>mxml_node_t *</type><description>Previous node under same parent</description></variable>
|
|
<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>
|
|
<typedef name="mxml_node_t"><type>struct mxml_node_s</type><description>An XML node.</description><description>An XML node.</description></typedef>
|
|
<function name="mxml_strdup"><returnvalue><description>New string pointer</description><type>char
|
|
*</type></returnvalue>
|
|
<description>Duplicate a string.</description><argument name="s"
|
|
direction="I"><type>const char *</type><description>String to duplicate</description></argument>
|
|
</function>
|
|
<function name="mxml_strdupf"><returnvalue><description>New string pointer</description><type>char
|
|
*</type></returnvalue>
|
|
<description>Format and duplicate a string.</description><argument
|
|
name="ap" direction="I"><type>const char *format, va_list</type><description>Pointer to additional arguments</description></argument>
|
|
</function>
|
|
<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>An XML text value.</description><type>struct
|
|
mxml_text_s</type></typedef>
|
|
<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>The XML node type.</description><type>enum
|
|
mxml_type_e</type></typedef>
|
|
<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>An XML node value.</description><type>union
|
|
mxml_value_u</type></typedef>
|
|
<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>
|
|
<variable name="real"><type>double</type><description>Real number</description></variable>
|
|
<variable name="text"><type>mxml_text_t</type><description>Text fragment</description></variable>
|
|
</union><function name="mxml_vsnprintf"><returnvalue><description>Number of bytes formatted</description><type>int</type></returnvalue>
|
|
<description>Format a string into a fixed size buffer.</description><argument
|
|
name="ap" direction="I"><type>char *buffer, size_t bufsize, const char *format,
|
|
va_list</type><description>Pointer to additional arguments</description></argument>
|
|
</function>
|