void mxmlAdd (
mxml_node_t *parent,
int where,
mxml_node_t *child,
mxml_node_t *node
);
MXML_ADD_BEFORE
or MXML_ADD_AFTER
MXML_ADD_TO_PARENT
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.
Insert node after this child...
void mxmlDelete (
mxml_node_t *node
);
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 mxmlElementDeleteAttr (
mxml_node_t *node,
const char *name
);
Delete an attribute.
Get an attribute.
const char *mxmlElementGetAttr (
mxml_node_t *node,
const char *name
);
Attribute value or NULL
This function returns NULL
if the node is not an element or the
named attribute does not exist.
Get an element attribute by index.
const char *mxmlElementGetAttrByIndex (
mxml_node_t *node,
int idx,
const char **name
);
Attribute value
The index ("idx") is 0-based. NULL
is returned if the specified index
is out of range.
Get the number of element attributes.
int mxmlElementGetAttrCount (
mxml_node_t *node
);
Number of attributes
Node
void mxmlElementSetAttr (
mxml_node_t *node,
const char *name,
const char *value
);
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.
Range check input...
void mxmlElementSetAttrf (
mxml_node_t *node,
const char *name,
const char *format,
...
);
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.
Add a callback to convert entities to Unicode.
int mxmlEntityAddCallback (
mxml_entity_cb_t cb
);
0 on success, -1 on failure
Get the name that corresponds to the character value.
const char *mxmlEntityGetName (
int val
);
Entity name or NULL
If val does not need to be represented by a named entity, NULL
is returned.
Get the character corresponding to a named entity.
int mxmlEntityGetValue (
const char *name
);
Character value or -1 on error
The entity name can also be a numeric constant. -1 is returned if the name is not known.
Global data
void mxmlEntityRemoveCallback (
mxml_entity_cb_t cb
);
Remove a callback.
Find the named element.
mxml_node_t *mxmlFindElement (
mxml_node_t *node,
mxml_node_t *top,
const char *element,
const char *attr,
const char *value,
int descend
);
NULL
for anyNULL
for noneNULL
for anyMXML_DESCEND
, MXML_NO_DESCEND
, or MXML_DESCEND_FIRST
Element node or NULL
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.
Find a node with the given path.
mxml_node_t *mxmlFindPath (
mxml_node_t *top,
const char *path
);
Found node or NULL
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.
Get the value for a CDATA node.
const char *mxmlGetCDATA (
mxml_node_t *node
);
CDATA value or NULL
NULL
is returned if the node is not a CDATA element.
Get the value for a custom node.
const void *mxmlGetCustom (
mxml_node_t *node
);
Custom value or NULL
NULL
is returned if the node (or its first child) is not a custom
value node.
Get the name for an element node.
const char *mxmlGetElement (
mxml_node_t *node
);
Element name or NULL
NULL
is returned if the node is not an element node.
Get the first child of an element node.
mxml_node_t *mxmlGetFirstChild (
mxml_node_t *node
);
First child or NULL
NULL
is returned if the node is not an element node or if the node
has no children.
Get the integer value from the specified node or its first child.
int mxmlGetInteger (
mxml_node_t *node
);
Integer value or 0
0 is returned if the node (or its first child) is not an integer value node.
Get the last child of an element node.
mxml_node_t *mxmlGetLastChild (
mxml_node_t *node
);
Last child or NULL
NULL
is returned if the node is not an element node or if the node
has no children.
Return the node type...
mxml_node_t *mxmlGetNextSibling (
mxml_node_t *node
);
Get the next node for the current parent.
NULL
is returned if this is the last child for the current parent.
Get an opaque string value for a node or its first child.
const char *mxmlGetOpaque (
mxml_node_t *node
);
Opaque string or NULL
NULL
is returned if the node (or its first child) is not an opaque
value node.
Get the parent node.
mxml_node_t *mxmlGetParent (
mxml_node_t *node
);
Parent node or NULL
NULL
is returned for a root node.
Get the previous node for the current parent.
mxml_node_t *mxmlGetPrevSibling (
mxml_node_t *node
);
Previous node or NULL
NULL
is returned if this is the first child for the current parent.
Get the real value for a node or its first child.
double mxmlGetReal (
mxml_node_t *node
);
Real value or 0.0
0.0 is returned if the node (or its first child) is not a real value node.
Get the current reference (use) count for a node.
int mxmlGetRefCount (
mxml_node_t *node
);
Reference count
The initial reference count of new nodes is 1. Use the mxmlRetain
and mxmlRelease
functions to increment and decrement a node's
reference count.
.
Get the text value for a node or its first child.
const char *mxmlGetText (
mxml_node_t *node,
int *whitespace
);
Text string or NULL
NULL
is returned if the node (or its first child) is not a text node.
The "whitespace" argument can be NULL
.
Get the node type.
mxml_type_t mxmlGetType (
mxml_node_t *node
);
Type of node
MXML_IGNORE
is returned if "node" is NULL
.
Get the user data pointer for a node.
void *mxmlGetUserData (
mxml_node_t *node
);
User data pointer
void mxmlIndexDelete (
mxml_index_t *ind
);
Delete an index.
Return the next node in the index.
mxml_node_t *mxmlIndexEnum (
mxml_index_t *ind
);
Next node or NULL
if there is none
You should call mxmlIndexReset
prior to using this function to get
the first node in the index. Nodes are returned in the sorted order of the
index.
Find the next matching node.
mxml_node_t *mxmlIndexFind (
mxml_index_t *ind,
const char *element,
const char *value
);
Node or NULL
if none found
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
.
Get the number of nodes in an index.
int mxmlIndexGetCount (
mxml_index_t *ind
);
Number of nodes in index
Create a new index.
mxml_index_t *mxmlIndexNew (
mxml_node_t *node,
const char *element,
const char *attr
);
NULL
for allNULL
for noneNew 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.
Reset the enumeration/find pointer in the index and return the first node in the index.
mxml_node_t *mxmlIndexReset (
mxml_index_t *ind
);
First node or NULL
if there is none
This function should be called prior to using mxmlIndexEnum
or
mxmlIndexFind
for the first time.
Load a file descriptor into an XML node tree.
mxml_node_t *mxmlLoadFd (
mxml_node_t *top,
int fd,
mxml_load_cb_t cb
);
First node or NULL
if the file could not be read.
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.
The constants MXML_INTEGER_CALLBACK
, MXML_OPAQUE_CALLBACK
,
MXML_REAL_CALLBACK
, and MXML_TEXT_CALLBACK
are defined for
loading child (data) nodes of the specified type.
Load a file into an XML node tree.
mxml_node_t *mxmlLoadFile (
mxml_node_t *top,
FILE *fp,
mxml_load_cb_t cb
);
First node or NULL
if the file could not be read.
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.
The constants MXML_INTEGER_CALLBACK
, MXML_OPAQUE_CALLBACK
,
MXML_REAL_CALLBACK
, and MXML_TEXT_CALLBACK
are defined for
loading child (data) nodes of the specified type.
Load a string into an XML node tree.
mxml_node_t *mxmlLoadString (
mxml_node_t *top,
const char *s,
mxml_load_cb_t cb
);
First node or NULL
if the string has errors.
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.
The constants MXML_INTEGER_CALLBACK
, MXML_OPAQUE_CALLBACK
,
MXML_REAL_CALLBACK
, and MXML_TEXT_CALLBACK
are defined for
loading child (data) nodes of the specified type.
Create a new CDATA node.
mxml_node_t *mxmlNewCDATA (
mxml_node_t *parent,
const char *data
);
MXML_NO_PARENT
New 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 currently use the
MXML_ELEMENT
type.
Create a new custom data node.
mxml_node_t *mxmlNewCustom (
mxml_node_t *parent,
void *data,
mxml_custom_destroy_cb_t destroy
);
MXML_NO_PARENT
New 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.
Create a new element node.
mxml_node_t *mxmlNewElement (
mxml_node_t *parent,
const char *name
);
MXML_NO_PARENT
New 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.
Create a new integer node.
mxml_node_t *mxmlNewInteger (
mxml_node_t *parent,
int integer
);
MXML_NO_PARENT
New 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.
Create a new opaque string.
mxml_node_t *mxmlNewOpaque (
mxml_node_t *parent,
const char *opaque
);
MXML_NO_PARENT
New node
The new opaque string 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 string node has no parent. The opaque string must be nul-
terminated and is copied into the new node.
Create a new formatted opaque string node.
mxml_node_t *mxmlNewOpaquef (
mxml_node_t *parent,
const char *format,
...
);
MXML_NO_PARENT
New node
The new opaque string 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 string node has no parent. The format string must be
nul-terminated and is formatted into the new node.
Create a new real number node.
mxml_node_t *mxmlNewReal (
mxml_node_t *parent,
double real
);
MXML_NO_PARENT
New 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.
Create a new text fragment node.
mxml_node_t *mxmlNewText (
mxml_node_t *parent,
int whitespace,
const char *string
);
MXML_NO_PARENT
New 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.
Create a new formatted text fragment node.
mxml_node_t *mxmlNewTextf (
mxml_node_t *parent,
int whitespace,
const char *format,
...
);
MXML_NO_PARENT
New 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.
Create a new XML document tree.
mxml_node_t *mxmlNewXML (
const char *version
);
New ?xml node
The "version" argument specifies the version number to put in the
?xml element node. If NULL
, version "1.0" is assumed.
Release a node.
int mxmlRelease (
mxml_node_t *node
);
New reference count
When the reference count reaches zero, the node (and any children)
is deleted via mxmlDelete
.
Create the node and set the text value...
void mxmlRemove (
mxml_node_t *node
);
Remove a node from its parent.
This function does not free memory used by the node - use mxmlDelete
for that. This function does nothing if the node has no parent.
Retain a node.
int mxmlRetain (
mxml_node_t *node
);
New reference count
Load a file descriptor into an XML node tree using a SAX callback.
mxml_node_t *mxmlSAXLoadFd (
mxml_node_t *top,
int fd,
mxml_load_cb_t cb,
mxml_sax_cb_t sax_cb,
void *sax_data
);
MXML_NO_CALLBACK
First node or NULL
if the file could not be read.
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.
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.
Load a file into an XML node tree using a SAX callback.
mxml_node_t *mxmlSAXLoadFile (
mxml_node_t *top,
FILE *fp,
mxml_load_cb_t cb,
mxml_sax_cb_t sax_cb,
void *sax_data
);
MXML_NO_CALLBACK
First node or NULL
if the file could not be read.
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.
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.
Load a string into an XML node tree using a SAX callback.
mxml_node_t *mxmlSAXLoadString (
mxml_node_t *top,
const char *s,
mxml_load_cb_t cb,
mxml_sax_cb_t sax_cb,
void *sax_data
);
MXML_NO_CALLBACK
First node or NULL
if the string has errors.
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.
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.
Save an XML tree to an allocated string.
char *mxmlSaveAllocString (
mxml_node_t *node,
mxml_save_cb_t cb
);
MXML_NO_CALLBACK
Allocated string or NULL
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.
Save an XML tree to a file descriptor.
int mxmlSaveFd (
mxml_node_t *node,
int fd,
mxml_save_cb_t cb
);
MXML_NO_CALLBACK
0 on success, -1 on error.
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.
Save an XML tree to a file.
int mxmlSaveFile (
mxml_node_t *node,
FILE *fp,
mxml_save_cb_t cb
);
MXML_NO_CALLBACK
0 on success, -1 on error.
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.
Save an XML node tree to a string.
int mxmlSaveString (
mxml_node_t *node,
char *buffer,
int bufsize,
mxml_save_cb_t cb
);
MXML_NO_CALLBACK
Size of 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.
Set the element name of a CDATA node.
int mxmlSetCDATA (
mxml_node_t *node,
const char *data
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not a CDATA element node.
Set the data and destructor of a custom data node.
int mxmlSetCustom (
mxml_node_t *node,
void *data,
mxml_custom_destroy_cb_t destroy
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not a custom node.
Read the XML data...
void mxmlSetCustomHandlers (
mxml_custom_load_cb_t load,
mxml_custom_save_cb_t save
);
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.
Set the name of an element node.
int mxmlSetElement (
mxml_node_t *node,
const char *name
);
0 on success, -1 on failure
The node is not changed if it is not an element node.
Global data
void mxmlSetErrorCallback (
mxml_error_cb_t cb
);
Set the error message callback.
Set the value of an integer node.
int mxmlSetInteger (
mxml_node_t *node,
int integer
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not an integer node.
Set the value of an opaque node.
int mxmlSetOpaque (
mxml_node_t *node,
const char *opaque
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not an opaque node.
Set the value of an opaque string node to a formatted string.
int mxmlSetOpaquef (
mxml_node_t *node,
const char *format,
...
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not an opaque node.
Set the value of a real number node.
int mxmlSetReal (
mxml_node_t *node,
double real
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not a real number node.
Set the value of a text node.
int mxmlSetText (
mxml_node_t *node,
int whitespace,
const char *string
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not a text node.
Set the value of a text node to a formatted string.
int mxmlSetTextf (
mxml_node_t *node,
int whitespace,
const char *format,
...
);
0 on success, -1 on failure
The node is not changed if it (or its first child) is not a text node.
Set the user data pointer for a node.
int mxmlSetUserData (
mxml_node_t *node,
void *data
);
0 on success, -1 on failure
Global data
void mxmlSetWrapMargin (
int column
);
Set the wrap margin when saving XML data.
Wrapping is disabled when "column" is 0.
Walk to the next logical node in the tree.
mxml_node_t *mxmlWalkNext (
mxml_node_t *node,
mxml_node_t *top,
int descend
);
MXML_DESCEND
, MXML_NO_DESCEND
, or MXML_DESCEND_FIRST
Next node or NULL
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.
Walk to the previous logical node in the tree.
mxml_node_t *mxmlWalkPrev (
mxml_node_t *node,
mxml_node_t *top,
int descend
);
MXML_DESCEND
, MXML_NO_DESCEND
, or MXML_DESCEND_FIRST
Previous node or NULL
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.
Custom data destructor
typedef void (*mxml_custom_destroy_cb_t)(void *);
Custom data load callback function
typedef int (*mxml_custom_load_cb_t)(mxml_node_t *, const char *);
Custom data save callback function
typedef char *(*mxml_custom_save_cb_t)(mxml_node_t *);
Entity callback function
typedef int (*mxml_entity_cb_t)(const char *);
Error callback function
typedef void (*mxml_error_cb_t)(const char *);
An XML node index.
typedef struct mxml_index_s mxml_index_t;
Load callback function
typedef mxml_type_t (*mxml_load_cb_t)(mxml_node_t *);
An XML node.
typedef struct mxml_node_s mxml_node_t;
Save callback function
typedef const char *(*mxml_save_cb_t)(mxml_node_t *, int);
SAX callback function
typedef void (*mxml_sax_cb_t)(mxml_node_t *, mxml_sax_event_t, void *);
SAX event type.
typedef enum mxml_sax_event_e mxml_sax_event_t;
The XML node type.
typedef enum mxml_type_e mxml_type_t;
SAX event type.
The XML node type.