diff --git a/doc/mxml.man b/doc/mxml.man index 8b0a900..9c7bb25 100644 --- a/doc/mxml.man +++ b/doc/mxml.man @@ -1,4 +1,4 @@ -.TH mxml 3 "Mini-XML API" "04/06/17" "Mini-XML API" +.TH mxml 3 "Mini-XML API" "04/07/17" "Mini-XML API" .SH NAME mxml \- Mini-XML API .SH INCLUDE FILE diff --git a/doc/reference.html b/doc/reference.html index dbdd38e..1a77e31 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -239,11 +239,11 @@ h3.title {
Add a node to a tree.
-void mxmlAdd (
- mxml_node_t *parent,
- int where,
- mxml_node_t *child,
- mxml_node_t *node
+void mxmlAdd (
+ mxml_node_t *parent,
+ int where,
+ mxml_node_t *child,
+ mxml_node_t *node
);
Delete a node and all of its children.
-void mxmlDelete (
- mxml_node_t *node
+void mxmlDelete (
+ mxml_node_t *node
);
Delete an attribute.
-void mxmlElementDeleteAttr (
- mxml_node_t *node,
- const char *name
+void mxmlElementDeleteAttr (
+ mxml_node_t *node,
+ const char *name
);
Get an attribute.
-const char *mxmlElementGetAttr (
- mxml_node_t *node,
- const char *name
+const char *mxmlElementGetAttr (
+ mxml_node_t *node,
+ const char *name
);
Set an attribute.
-void mxmlElementSetAttr (
- mxml_node_t *node,
- const char *name,
- const char *value
+void mxmlElementSetAttr (
+ mxml_node_t *node,
+ const char *name,
+ const char *value
);
Set an attribute with a formatted value.
-void mxmlElementSetAttrf (
- mxml_node_t *node,
- const char *name,
- const char *format,
- ...
+void mxmlElementSetAttrf (
+ mxml_node_t *node,
+ const char *name,
+ const char *format,
+ ...
);
Add a callback to convert entities to Unicode.
-int mxmlEntityAddCallback (
- mxml_entity_cb_t cb
+int mxmlEntityAddCallback (
+ mxml_entity_cb_t cb
);
Get the name that corresponds to the character value.
-const char *mxmlEntityGetName (
- int val
+const char *mxmlEntityGetName (
+ int val
);
Get the character corresponding to a named entity.
-int mxmlEntityGetValue (
- const char *name
+int mxmlEntityGetValue (
+ const char *name
);
Remove a callback.
-void mxmlEntityRemoveCallback (
- mxml_entity_cb_t cb
+void mxmlEntityRemoveCallback (
+ mxml_entity_cb_t cb
);
Find the named element.
-mxml_node_t *mxmlFindElement (
- mxml_node_t *node,
- mxml_node_t *top,
- const char *name,
- const char *attr,
- const char *value,
- int descend
+mxml_node_t *mxmlFindElement (
+ mxml_node_t *node,
+ mxml_node_t *top,
+ const char *name,
+ const char *attr,
+ const char *value,
+ int descend
);
Find a node with the given path.
-mxml_node_t *mxmlFindPath (
- mxml_node_t *top,
- const char *path
+mxml_node_t *mxmlFindPath (
+ mxml_node_t *top,
+ const char *path
);
Get the value for a CDATA node.
-const char *mxmlGetCDATA (
- mxml_node_t *node
+const char *mxmlGetCDATA (
+ mxml_node_t *node
);
Get the value for a custom node.
-const void *mxmlGetCustom (
- mxml_node_t *node
+const void *mxmlGetCustom (
+ mxml_node_t *node
);
Get the name for an element node.
-const char *mxmlGetElement (
- mxml_node_t *node
+const char *mxmlGetElement (
+ mxml_node_t *node
);
Get the first child of an element node.
-mxml_node_t *mxmlGetFirstChild (
- mxml_node_t *node
+mxml_node_t *mxmlGetFirstChild (
+ mxml_node_t *node
);
Get the integer value from the specified node or its first child.
-int mxmlGetInteger (
- mxml_node_t *node
+int mxmlGetInteger (
+ mxml_node_t *node
);
Get the last child of an element node.
-mxml_node_t *mxmlGetLastChild (
- mxml_node_t *node
+mxml_node_t *mxmlGetLastChild (
+ mxml_node_t *node
);
Return the node type...
-mxml_node_t *mxmlGetNextSibling (
- mxml_node_t *node
+mxml_node_t *mxmlGetNextSibling (
+ mxml_node_t *node
);
Get an opaque string value for a node or its first child.
-const char *mxmlGetOpaque (
- mxml_node_t *node
+const char *mxmlGetOpaque (
+ mxml_node_t *node
);
Get the parent node.
-mxml_node_t *mxmlGetParent (
- mxml_node_t *node
+mxml_node_t *mxmlGetParent (
+ mxml_node_t *node
);
Get the previous node for the current parent.
-mxml_node_t *mxmlGetPrevSibling (
- mxml_node_t *node
+mxml_node_t *mxmlGetPrevSibling (
+ mxml_node_t *node
);
Get the real value for a node or its first child.
-double mxmlGetReal (
- mxml_node_t *node
+double mxmlGetReal (
+ mxml_node_t *node
);
Get the current reference (use) count for a node.
-int mxmlGetRefCount (
- mxml_node_t *node
+int mxmlGetRefCount (
+ mxml_node_t *node
);
Get the text value for a node or its first child.
-const char *mxmlGetText (
- mxml_node_t *node,
- int *whitespace
+const char *mxmlGetText (
+ mxml_node_t *node,
+ int *whitespace
);
Get the node type.
-mxml_type_t mxmlGetType (
- mxml_node_t *node
+mxml_type_t mxmlGetType (
+ mxml_node_t *node
);
Get the user data pointer for a node.
-void *mxmlGetUserData (
- mxml_node_t *node
+void *mxmlGetUserData (
+ mxml_node_t *node
);
Delete an index.
-void mxmlIndexDelete (
- mxml_index_t *ind
+void mxmlIndexDelete (
+ mxml_index_t *ind
);
Return the next node in the index.
-mxml_node_t *mxmlIndexEnum (
- mxml_index_t *ind
+mxml_node_t *mxmlIndexEnum (
+ mxml_index_t *ind
);
Find the next matching node.
-mxml_node_t *mxmlIndexFind (
- mxml_index_t *ind,
- const char *element,
- const char *value
+mxml_node_t *mxmlIndexFind (
+ mxml_index_t *ind,
+ const char *element,
+ const char *value
);
Get the number of nodes in an index.
-int mxmlIndexGetCount (
- mxml_index_t *ind
+int mxmlIndexGetCount (
+ mxml_index_t *ind
);
Create a new index.
-mxml_index_t *mxmlIndexNew (
- mxml_node_t *node,
- const char *element,
- const char *attr
+mxml_index_t *mxmlIndexNew (
+ mxml_node_t *node,
+ const char *element,
+ const char *attr
);
Reset the enumeration/find pointer in the index and return the first node in the index.
-mxml_node_t *mxmlIndexReset (
- mxml_index_t *ind
+mxml_node_t *mxmlIndexReset (
+ mxml_index_t *ind
);
Load a file descriptor into an XML node tree.
-mxml_node_t *mxmlLoadFd (
- mxml_node_t *top,
- int fd,
- mxml_load_cb_t cb
+mxml_node_t *mxmlLoadFd (
+ mxml_node_t *top,
+ int fd,
+ mxml_load_cb_t cb
);
Load a file into an XML node tree.
-mxml_node_t *mxmlLoadFile (
- mxml_node_t *top,
- FILE *fp,
- mxml_load_cb_t cb
+mxml_node_t *mxmlLoadFile (
+ mxml_node_t *top,
+ FILE *fp,
+ mxml_load_cb_t cb
);
Load a string into an XML node tree.
-mxml_node_t *mxmlLoadString (
- mxml_node_t *top,
- const char *s,
- mxml_load_cb_t cb
+mxml_node_t *mxmlLoadString (
+ mxml_node_t *top,
+ const char *s,
+ mxml_load_cb_t cb
);
Create a new CDATA node.
-mxml_node_t *mxmlNewCDATA (
- mxml_node_t *parent,
- const char *data
+mxml_node_t *mxmlNewCDATA (
+ mxml_node_t *parent,
+ const char *data
);
Create a new custom data node.
-mxml_node_t *mxmlNewCustom (
- mxml_node_t *parent,
- void *data,
- mxml_custom_destroy_cb_t destroy
+mxml_node_t *mxmlNewCustom (
+ mxml_node_t *parent,
+ void *data,
+ mxml_custom_destroy_cb_t destroy
);
Create a new element node.
-mxml_node_t *mxmlNewElement (
- mxml_node_t *parent,
- const char *name
+mxml_node_t *mxmlNewElement (
+ mxml_node_t *parent,
+ const char *name
);
Create a new integer node.
-mxml_node_t *mxmlNewInteger (
- mxml_node_t *parent,
- int integer
+mxml_node_t *mxmlNewInteger (
+ mxml_node_t *parent,
+ int integer
);
Create a new opaque string.
-mxml_node_t *mxmlNewOpaque (
- mxml_node_t *parent,
- const char *opaque
+mxml_node_t *mxmlNewOpaque (
+ mxml_node_t *parent,
+ const char *opaque
);
Create a new real number node.
-mxml_node_t *mxmlNewReal (
- mxml_node_t *parent,
- double real
+mxml_node_t *mxmlNewReal (
+ mxml_node_t *parent,
+ double real
);
Create a new text fragment node.
-mxml_node_t *mxmlNewText (
- mxml_node_t *parent,
- int whitespace,
- const char *string
+mxml_node_t *mxmlNewText (
+ mxml_node_t *parent,
+ int whitespace,
+ const char *string
);
Create a new formatted text fragment node.
-mxml_node_t *mxmlNewTextf (
- mxml_node_t *parent,
- int whitespace,
- const char *format,
- ...
+mxml_node_t *mxmlNewTextf (
+ mxml_node_t *parent,
+ int whitespace,
+ const char *format,
+ ...
);
Create a new XML document tree.
-mxml_node_t *mxmlNewXML (
- const char *version
+mxml_node_t *mxmlNewXML (
+ const char *version
);
Release a node.
-int mxmlRelease (
- mxml_node_t *node
+int mxmlRelease (
+ mxml_node_t *node
);
Remove a node from its parent.
-void mxmlRemove (
- mxml_node_t *node
+void mxmlRemove (
+ mxml_node_t *node
);
Retain a node.
-int mxmlRetain (
- mxml_node_t *node
+int mxmlRetain (
+ mxml_node_t *node
);
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_node_t *mxmlSAXLoadFd (
+ mxml_node_t *top,
+ int fd,
+ mxml_load_cb_t cb,
+ mxml_sax_cb_t sax_cb,
+ void *sax_data
);
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_node_t *mxmlSAXLoadFile (
+ mxml_node_t *top,
+ FILE *fp,
+ mxml_load_cb_t cb,
+ mxml_sax_cb_t sax_cb,
+ void *sax_data
);
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_node_t *mxmlSAXLoadString (
+ mxml_node_t *top,
+ const char *s,
+ mxml_load_cb_t cb,
+ mxml_sax_cb_t sax_cb,
+ void *sax_data
);
Save an XML tree to an allocated string.
-char *mxmlSaveAllocString (
- mxml_node_t *node,
- mxml_save_cb_t cb
+char *mxmlSaveAllocString (
+ mxml_node_t *node,
+ mxml_save_cb_t cb
);
Save an XML tree to a file descriptor.
-int mxmlSaveFd (
- mxml_node_t *node,
- int fd,
- mxml_save_cb_t cb
+int mxmlSaveFd (
+ mxml_node_t *node,
+ int fd,
+ mxml_save_cb_t cb
);
Save an XML tree to a file.
-int mxmlSaveFile (
- mxml_node_t *node,
- FILE *fp,
- mxml_save_cb_t cb
+int mxmlSaveFile (
+ mxml_node_t *node,
+ FILE *fp,
+ mxml_save_cb_t cb
);
Save an XML node tree to a string.
-int mxmlSaveString (
- mxml_node_t *node,
- char *buffer,
- int bufsize,
- mxml_save_cb_t cb
+int mxmlSaveString (
+ mxml_node_t *node,
+ char *buffer,
+ int bufsize,
+ mxml_save_cb_t cb
);
Set the element name of a CDATA node.
-int mxmlSetCDATA (
- mxml_node_t *node,
- const char *data
+int mxmlSetCDATA (
+ mxml_node_t *node,
+ const char *data
);
Set the data and destructor of a custom data node.
-int mxmlSetCustom (
- mxml_node_t *node,
- void *data,
- mxml_custom_destroy_cb_t destroy
+int mxmlSetCustom (
+ mxml_node_t *node,
+ void *data,
+ mxml_custom_destroy_cb_t destroy
);
Set the handling functions for custom data.
-void mxmlSetCustomHandlers (
- mxml_custom_load_cb_t load,
- mxml_custom_save_cb_t save
+void mxmlSetCustomHandlers (
+ mxml_custom_load_cb_t load,
+ mxml_custom_save_cb_t save
);
Set the name of an element node.
-int mxmlSetElement (
- mxml_node_t *node,
- const char *name
+int mxmlSetElement (
+ mxml_node_t *node,
+ const char *name
);
Set the error message callback.
-void mxmlSetErrorCallback (
- mxml_error_cb_t cb
+void mxmlSetErrorCallback (
+ mxml_error_cb_t cb
);
Set the value of an integer node.
-int mxmlSetInteger (
- mxml_node_t *node,
- int integer
+int mxmlSetInteger (
+ mxml_node_t *node,
+ int integer
);
Set the value of an opaque node.
-int mxmlSetOpaque (
- mxml_node_t *node,
- const char *opaque
+int mxmlSetOpaque (
+ mxml_node_t *node,
+ const char *opaque
);
Set the value of a real number node.
-int mxmlSetReal (
- mxml_node_t *node,
- double real
+int mxmlSetReal (
+ mxml_node_t *node,
+ double real
);
Set the value of a text node.
-int mxmlSetText (
- mxml_node_t *node,
- int whitespace,
- const char *string
+int mxmlSetText (
+ mxml_node_t *node,
+ int whitespace,
+ const char *string
);
Set the value of a text node to a formatted string.
-int mxmlSetTextf (
- mxml_node_t *node,
- int whitespace,
- const char *format,
- ...
+int mxmlSetTextf (
+ mxml_node_t *node,
+ int whitespace,
+ const char *format,
+ ...
);
Set the user data pointer for a node.
-int mxmlSetUserData (
- mxml_node_t *node,
- void *data
+int mxmlSetUserData (
+ mxml_node_t *node,
+ void *data
);
Set the wrap margin when saving XML data.
-void mxmlSetWrapMargin (
- int column
+void mxmlSetWrapMargin (
+ int column
);
Walk to the next logical node in the tree.
-mxml_node_t *mxmlWalkNext (
- mxml_node_t *node,
- mxml_node_t *top,
- int descend
+mxml_node_t *mxmlWalkNext (
+ mxml_node_t *node,
+ mxml_node_t *top,
+ int descend
);
Walk to the previous logical node in the tree.
-mxml_node_t *mxmlWalkPrev (
- mxml_node_t *node,
- mxml_node_t *top,
- int descend
+mxml_node_t *mxmlWalkPrev (
+ mxml_node_t *node,
+ mxml_node_t *top,
+ int descend
);