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.
mxml_node_t *
Parent node
int
Where to add, MXML_ADD_BEFORE or MXML_ADD_AFTER
mxml_node_t *
Child node for where or MXML_ADD_TO_PARENT
mxml_node_t *
Node to add
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.
mxml_node_t *
Node to delete
Delete an attribute.
@since Mini-XML 2.4@
mxml_node_t *
Element
const char *
Attribute name
const char *
Attribute value or NULL
Get an attribute.
This function returns NULL if the node is not an element or the
named attribute does not exist.
mxml_node_t *
Element node
const char *
Name of attribute
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.
mxml_node_t *
Element node
const char *
Name of attribute
const char *
Attribute value
Set an attribute with a formatted value.
If the named attribute already exists, the value of the attribute
is replaced by the new formatted string. The formatted string value is
copied into the element node. This function does nothing if the node
is not an element.
@since Mini-XML 2.3@
mxml_node_t *
Element node
const char *
Name of attribute
const char *
Printf-style attribute value
Additional arguments as needed
int
0 on success, -1 on failure
Add a callback to convert entities to Unicode.
mxml_entity_cb_t
Callback function to add
const char *
Entity name or NULL
Get the name that corresponds to the character value.
If val does not need to be represented by a named entity, NULL is returned.
int
Character value
int
Character value or -1 on error
Get the character corresponding to a named entity.
The entity name can also be a numeric constant. -1 is returned if the
name is not known.
const char *
Entity name
Remove a callback.
mxml_entity_cb_t
Callback function to remove
mxml_node_t *
Element node or NULL
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 *
Current node
mxml_node_t *
Top node
const char *
Element name or NULL for any
const char *
Attribute name, or NULL for none
const char *
Attribute value, or NULL for any
int
Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST
mxml_node_t *
Found node or NULL
Find a node with the given path.
The "path" is a slash-separated list of element names. The name "*" is
considered a wildcard for one or more levels of elements. For example,
"foo/one/two", "bar/two/one", "*/one", and so forth.
The first child node of the found node is returned if the given node has
children and the first child is a value node.
@since Mini-XML 2.7@
mxml_node_t *
Top node
const char *
Path to element
const char *
CDATA value or NULL
Get the value for a CDATA node.
@code NULL@ is returned if the node is not a CDATA element.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
const void *
Custom value or NULL
Get the value for a custom node.
@code NULL@ is returned if the node (or its first child) is not a custom
value node.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
const char *
Element name or NULL
Get the name for an element node.
@code NULL@ is returned if the node is not an element node.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
mxml_node_t *
First child or NULL
Get the first child of an element node.
@code NULL@ is returned if the node is not an element node or if the node
has no children.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
int
Integer value or 0
Get the integer value from the specified node or its
first child.
0 is returned if the node (or its first child) is not an integer value node.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
mxml_node_t *
Last child or NULL
Get the last child of an element node.
@code NULL@ is returned if the node is not an element node or if the node
has no children.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
mxml_node_t *
Get the next node for the current parent.
@code NULL@ is returned if this is the last child for the current parent.
@since Mini-XML 2.7@
Return the node type...
mxml_node_t *
Node to get
const char *
Opaque string or NULL
Get an opaque string value for a node or its first child.
@code NULL@ is returned if the node (or its first child) is not an opaque
value node.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
mxml_node_t *
Parent node or NULL
Get the parent node.
@code NULL@ is returned for a root node.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
mxml_node_t *
Previous node or NULL
Get the previous node for the current parent.
@code NULL@ is returned if this is the first child for the current parent.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
double
Real value or 0.0
Get the real value for a node or its first child.
0.0 is returned if the node (or its first child) is not a real value node.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
int
Reference count
Get the current reference (use) count for a node.
The initial reference count of new nodes is 1. Use the @link mxmlRetain@
and @link mxmlRelease@ functions to increment and decrement a node's
reference count.
@since Mini-XML 2.7@.
mxml_node_t *
Node
const char *
Text string or NULL
Get the text value for a node or its first child.
@code NULL@ is returned if the node (or its first child) is not a text node.
The "whitespace" argument can be NULL.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
int *
1 if string is preceded by whitespace, 0 otherwise
mxml_type_t
Type of node
Get the node type.
@code MXML_IGNORE@ is returned if "node" is @code NULL@.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
void *
User data pointer
Get the user data pointer for a node.
@since Mini-XML 2.7@
mxml_node_t *
Node to get
Delete an index.
mxml_index_t *
Index to delete
mxml_node_t *
Next node or NULL if there is none
Return the next node in the index.
Nodes are returned in the sorted order of the index.
mxml_index_t *
Index to enumerate
mxml_node_t *
Node or NULL if none found
Find the next matching node.
You should call mxmlIndexReset() prior to using this function for
the first time with a particular set of "element" and "value"
strings. Passing NULL for both "element" and "value" is equivalent
to calling mxmlIndexEnum().
mxml_index_t *
Index to search
const char *
Element name to find, if any
const char *
Attribute value, if any
int
Number of nodes in index
Get the number of nodes in an index.
@since Mini-XML 2.7@
mxml_index_t *
Index of nodes
mxml_index_t *
New index
Create a new index.
The index will contain all nodes that contain the named element and/or
attribute. If both "element" and "attr" are NULL, then the index will
contain a sorted list of the elements in the node tree. Nodes are
sorted by element name and optionally by attribute value if the "attr"
argument is not NULL.
mxml_node_t *
XML node tree
const char *
Element to index or NULL for all
const char *
Attribute to index or NULL for none
mxml_node_t *
First node or NULL if there is none
Reset the enumeration/find pointer in the index and
return the first node in the index.
This function should be called prior to using mxmlIndexEnum() or
mxmlIndexFind() for the first time.
mxml_index_t *
Index to reset
mxml_node_t *
First node or NULL if the file could not be read.
Load a file descriptor 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.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
mxml_node_t *
Top node
int
File descriptor to read from
mxml_load_cb_t
Callback function or MXML_NO_CALLBACK
mxml_node_t *
First node or NULL if the file could not be read.
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.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
mxml_node_t *
Top node
FILE *
File to read from
mxml_load_cb_t
Callback function or MXML_NO_CALLBACK
mxml_node_t *
First node or NULL if the string has errors.
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.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
mxml_node_t *
Top node
const char *
String to load
mxml_load_cb_t
Callback function or MXML_NO_CALLBACK
mxml_node_t *
New node
Create a new CDATA node.
The new CDATA 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
CDATA node has no parent. The data string must be nul-terminated and
is copied into the new node. CDATA nodes use the MXML_ELEMENT type.
@since Mini-XML 2.3@
mxml_node_t *
Parent node or MXML_NO_PARENT
const char *
Data string
mxml_node_t *
New node
Create a new custom data node.
The new custom 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. NULL can be passed when the data in the
node is not dynamically allocated or is separately managed.
@since Mini-XML 2.1@
mxml_node_t *
Parent node or MXML_NO_PARENT
void *
Pointer to data
mxml_custom_destroy_cb_t
Function to destroy data
mxml_node_t *
New node
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 *
Parent node or MXML_NO_PARENT
const char *
Name of element
mxml_node_t *
New node
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 *
Parent node or MXML_NO_PARENT
int
Integer value
mxml_node_t *
New node
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 *
Parent node or MXML_NO_PARENT
const char *
Opaque string
mxml_node_t *
New node
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 *
Parent node or MXML_NO_PARENT
double
Real number value
mxml_node_t *
New node
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 *
Parent node or MXML_NO_PARENT
int
1 = leading whitespace, 0 = no whitespace
const char *
String
mxml_node_t *
New node
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.
mxml_node_t *
Parent node or MXML_NO_PARENT
int
1 = leading whitespace, 0 = no whitespace
const char *
Printf-style frmat string
Additional args as needed
mxml_node_t *
New ?xml node
Create a new XML document tree.
The "version" argument specifies the version number to put in the
?xml element node. If NULL, version 1.0 is assumed.
@since Mini-XML 2.3@
const char *
Version number to use
int
New reference count
Release a node.
When the reference count reaches zero, the node (and any children)
is deleted via mxmlDelete().
@since Mini-XML 2.3@
mxml_node_t *
Node
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.
mxml_node_t *
Node to remove
int
New reference count
Retain a node.
@since Mini-XML 2.3@
mxml_node_t *
Node
mxml_node_t *
First node or NULL if the file could not be read.
Load a file descriptor into an XML node tree
using a SAX callback.
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.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@
mxml_node_t *
Top node
int
File descriptor to read from
mxml_load_cb_t
Callback function or MXML_NO_CALLBACK
mxml_sax_cb_t
SAX callback or MXML_NO_CALLBACK
void *
SAX user data
mxml_node_t *
First node or NULL if the file could not be read.
Load a file into an XML node tree
using a SAX callback.
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.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@
mxml_node_t *
Top node
FILE *
File to read from
mxml_load_cb_t
Callback function or MXML_NO_CALLBACK
mxml_sax_cb_t
SAX callback or MXML_NO_CALLBACK
void *
SAX user data
mxml_node_t *
First node or NULL if the string has errors.
Load a string into an XML node tree
using a SAX callback.
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.
The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
MXML_REAL_CALLBACK, and MXML_TEXT_CALLBACK are defined for loading
child nodes of the specified type.
The SAX callback must call mxmlRetain() for any nodes that need to
be kept for later use. Otherwise, nodes are deleted when the parent
node is closed or after each data, comment, CDATA, or directive node.
@since Mini-XML 2.3@
mxml_node_t *
Top node
const char *
String to load
mxml_load_cb_t
Callback function or MXML_NO_CALLBACK
mxml_sax_cb_t
SAX callback or MXML_NO_CALLBACK
void *
SAX user data
char *
Allocated string or NULL
Save an XML 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.
The callback argument specifies a function that returns a whitespace
string or NULL 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.
mxml_node_t *
Node to write
mxml_save_cb_t
Whitespace callback or MXML_NO_CALLBACK
int
0 on success, -1 on error.
Save an XML tree to a file descriptor.
The callback argument specifies a function that returns a whitespace
string or NULL 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.
mxml_node_t *
Node to write
int
File descriptor to write to
mxml_save_cb_t
Whitespace callback or MXML_NO_CALLBACK
int
0 on success, -1 on error.
Save an XML tree to a file.
The callback argument specifies a function that returns a whitespace
string or NULL 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.
mxml_node_t *
Node to write
FILE *
File to write to
mxml_save_cb_t
Whitespace callback or MXML_NO_CALLBACK
int
Size of string
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.
The callback argument specifies a function that returns a whitespace
string or NULL 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.
mxml_node_t *
Node to write
char *
String buffer
int
Size of string buffer
mxml_save_cb_t
Whitespace callback or MXML_NO_CALLBACK
int
0 on success, -1 on failure
Set the element name of a CDATA node.
The node is not changed if it (or its first child) is not a CDATA element node.
@since Mini-XML 2.3@
mxml_node_t *
Node to set
const char *
New data string
int
0 on success, -1 on failure
Set the data and destructor of a custom data node.
The node is not changed if it (or its first child) is not a custom node.
@since Mini-XML 2.1@
mxml_node_t *
Node to set
void *
New data pointer
mxml_custom_destroy_cb_t
New destructor function
Set the handling functions for custom data.
The load function accepts a node pointer and a data string and must
return 0 on success and non-zero on error.
The save function accepts a node pointer and must return a malloc'd
string on success and NULL on error.
mxml_custom_load_cb_t
Load function
mxml_custom_save_cb_t
Save function
int
0 on success, -1 on failure
Set the name of an element node.
The node is not changed if it is not an element node.
mxml_node_t *
Node to set
const char *
New name string
Set the error message callback.
mxml_error_cb_t
Error callback function
int
0 on success, -1 on failure
Set the value of an integer node.
The node is not changed if it (or its first child) is not an integer node.
mxml_node_t *
Node to set
int
Integer value
int
0 on success, -1 on failure
Set the value of an opaque node.
The node is not changed if it (or its first child) is not an opaque node.
mxml_node_t *
Node to set
const char *
Opaque string
int
0 on success, -1 on failure
Set the value of a real number node.
The node is not changed if it (or its first child) is not a real number node.
mxml_node_t *
Node to set
double
Real number value
int
0 on success, -1 on failure
Set the value of a text node.
The node is not changed if it (or its first child) is not a text node.
mxml_node_t *
Node to set
int
1 = leading whitespace, 0 = no whitespace
const char *
String
int
0 on success, -1 on failure
Set the value of a text node to a formatted string.
The node is not changed if it (or its first child) is not a text node.
mxml_node_t *
Node to set
int
1 = leading whitespace, 0 = no whitespace
const char *
Printf-style format string
Additional arguments as needed
int
0 on success, -1 on failure
Set the user data pointer for a node.
@since Mini-XML 2.7@
mxml_node_t *
Node to set
void *
User data pointer
Set the wrap margin when saving XML data.
Wrapping is disabled when "column" is 0.
@since Mini-XML 2.3@
int
Column for wrapping, 0 to disable wrapping
mxml_node_t *
Next node or NULL
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 *
Current node
mxml_node_t *
Top node
int
Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST
mxml_node_t *
Previous node or NULL
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 *
Current node
mxml_node_t *
Top node
int
Descend into tree - MXML_DESCEND, MXML_NO_DESCEND, or MXML_DESCEND_FIRST
An XML element attribute value. @private@
char *
Attribute name
char *
Attribute value
struct mxml_attr_s
An XML element attribute value. @private@
void(*)(void *)
Custom data destructor
int(*)(mxml_node_t *, const char *)
Custom data load callback function
An XML custom value. @private@
void *
Pointer to (allocated) custom data
mxml_custom_destroy_cb_t
Pointer to destructor function
char *(*)(mxml_node_t *)
Custom data save callback function
struct mxml_custom_s
An XML custom value. @private@
An XML element value. @private@
mxml_attr_t *
Attributes
char *
Name of element
int
Number of attributes
struct mxml_element_s
An XML element value. @private@
int(*)(const char *)
Entity callback function
void(*)(const char *)
Error callback function
An XML node index. @private@
int
Allocated nodes in index
char *
Attribute used for indexing or NULL
int
Current node
mxml_node_t **
Node array
int
Number of nodes in index
struct mxml_index_s
An XML node index.
mxml_type_t(*)(mxml_node_t *)
Load callback function
An XML node. @private@
struct mxml_node_s *
First child node
struct mxml_node_s *
Last child node
struct mxml_node_s *
Next node under same parent
struct mxml_node_s *
Parent node
struct mxml_node_s *
Previous node under same parent
int
Use count
mxml_type_t
Node type
void *
User data
mxml_value_t
Node value
struct mxml_node_s
An XML node.
const char *(*)(mxml_node_t *, int)
Save callback function
void(*)(mxml_node_t *, mxml_sax_event_t, void *)
SAX callback function
SAX event type.
CDATA node
Comment node
Data node
Processing directive node
Element closed
Element opened
enum mxml_sax_event_e
SAX event type.
An XML text value. @private@
char *
Fragment string
int
Leading whitespace?
struct mxml_text_s
An XML text value. @private@
The XML node type.
Custom data @since Mini-XML 2.1@
XML element with attributes
Ignore/throw away node @since Mini-XML 2.3@
Integer value
Opaque string
Real value
Text fragment
The XML node type.
enum mxml_type_e
union mxml_value_u
An XML node value. @private@
An XML node value. @private@
mxml_custom_t
Custom data @since Mini-XML 2.1@
mxml_element_t
Element
int
Integer number
char *
Opaque string
double
Real number
mxml_text_t
Text fragment