The save callback receives the node pointer and returns an allocated string containing the custom data value. The following save callback could be used for our ISO date/time type:
@@ -326,7 +326,7 @@ save callback could be used for our ISO date/time type: iso_date_time_t *dt; - dt = (iso_date_time_t *)node->custom.data; + dt = (iso_date_time_t *)mxmlGetCustom(node); snprintf(data, sizeof(data), "%04u-%02u-%02uT%02u:%02u:%02uZ", @@ -404,9 +404,8 @@ an index is approximately equal to walking the XML document tree. Nodes in the index are sorted by element name and attribute value. -Indices are stored in mxml_index_t structures. The -mxmlIndexNew() function +
Indices are stored in mxml_index_t +structures. The mxmlIndexNew() function creates a new index:
@@ -568,7 +567,7 @@ directives like <?xml ... ?> and <!DOCTYPE ... >
* Retain headings and titles...
*/
- char *name = node->value.element.name;
+ char *name = mxmlGetElement(node);
if (!strcmp(name, "html") ||
!strcmp(name, "head") ||
@@ -584,15 +583,17 @@ directives like <?xml ... ?> and <!DOCTYPE ... >
}
else if (event == MXML_SAX_DIRECTIVE)
mxmlRetain(node);
- else if (event == MXML_SAX_DATA &&
- node->parent->ref_count > 1)
+ else if (event == MXML_SAX_DATA)
{
- /*
- * If the parent was retained, then retain
- * this data node as well.
- */
+ if (mxmlGetRefCount(mxmlGetParent(node)) > 1)
+ {
+ /*
+ * If the parent was retained, then retain
+ * this data node as well.
+ */
- mxmlRetain(node);
+ mxmlRetain(node);
+ }
}
}
@@ -622,9 +623,9 @@ title and headings in the document would look like:
if (body)
{
- for (heading = body->child;
+ for (heading = mxmlGetFirstChild(body);
heading;
- heading = heading->next)
+ heading = mxmlGetNextSibling(heading))
print_children(heading);
}
diff --git a/doc/basics.html b/doc/basics.html
index 9ca0838..7823fa6 100644
--- a/doc/basics.html
+++ b/doc/basics.html
@@ -23,7 +23,7 @@ functionality:
attribute values with no preset limits, just available
memory.
- Every piece of information in an XML file (elements, text, -numbers) is stored in memory in "nodes". Nodes are defined by -the mxml_node_t -structure. The type member -defines the node type (element, integer, opaque, real, or text) -which determines which value you want to look at in the value union.
+Every piece of information in an XML file is stored in memory in "nodes". +Nodes are defined by the mxml_node_t +structure. Each node has a typed value, optional user data, a parent node, +sibling nodes (previous and next), and potentially child nodes.
- -| Value | -Type | -Node member | -
|---|---|---|
| Custom | -void * | -node->value.custom.data | -
| Element | -char * | -node->value.element.name | -
| Integer | -int | -node->value.integer | -
| Opaque (string) | -char * | -node->value.opaque | -
| Real | -double | -node->value.real | -
| Text | -char * | -node->value.text.string | -
Each node also has a user_data member which allows you -to associate application-specific data with each node as needed.
- -New nodes are created using the mxmlNewElement, mxmlNewInteger, mxmlNewOpaque, mxmlNewReal, mxmlNewText, mxmlNewTextf, and mxmlNewXML functions. Only -elements can have child nodes, and the top node must be an element, usually the -<?xml version="1.0" encoding="utf-8"?> node created by -mxmlNewXML().
- -Nodes have pointers to the node above (parent), below -(child), left (prev), and right (next) -of the current node. If you have an XML file like the following:
+For example, if you have an XML file like the following:
<?xml version="1.0" encoding="utf-8"?>
@@ -148,8 +86,7 @@ of the current node. If you have an XML file like the following:
</data>
-the node tree for the file would look like the following in -memory:
+the node tree for the file would look like the following in memory:
?xml version="1.0" encoding="utf-8"?
@@ -165,17 +102,127 @@ memory:
val4 val5 val6
-where "-" is a pointer to the next node and "|" is a pointer -to the first child node.
+where "-" is a pointer to the sibling node and "|" is a pointer +to the first child or parent node.
-Once you are done with the XML data, use the mxmlDelete function to recursively -free the memory that is used for a particular node or the entire -tree:
+The mxmlGetType function gets the type of +a node, one of MXML_CUSTOM, MXML_ELEMENT, +MXML_INTEGER, MXML_OPAQUE, MXML_REAL, or +MXML_TEXT. The parent and sibling nodes are accessed using the +mxmlGetParent, +mxmlGetNext, and +mxmlGetPrevious functions. The +mxmlGetUserData function gets any user +data associated with the node.
+ +CDATA (MXML_ELEMENT) nodes are created using the +mxmlNewCDATA function. The +mxmlGetCDATA function retrieves the +CDATA string pointer for a node.
+ +Note: + ++ +CDATA nodes are currently stored in memory as special elements. This will +be changed in a future major release of Mini-XML.
+
Custom (MXML_CUSTOM) nodes are created using the +mxmlNewCustom function or using a custom +load callback specified using the +mxmlSetCustomHandlers function. +The mxmlGetCustom function retrieves the +custom value pointer for a node.
+ +Comment (MXML_ELEMENT) nodes are created using the +mxmlNewElement function. The +mxmlGetElement function retrieves the +comment string pointer for a node, including the surrounding "!--" and "--" +characters.
+ +Note: + ++ +Comment nodes are currently stored in memory as special elements. This will +be changed in a future major release of Mini-XML.
+
Element (MXML_ELEMENT) nodes are created using the +mxmlNewElement function. The +mxmlGetElement function retrieves the +element name, the +mxmlElementGetAttr function retrieves +the value string for a named attribute associated with the element, and the +mxmlGetFirstChild and +mxmlGetLastChild functions retrieve the +first and last child nodes for the element, respectively.
+ +Integer (MXML_INTEGER) nodes are created using the +mxmlNewInteger function. The +mxmlGetInteger function retrieves the +integer value for a node.
+ +Opaque (MXML_OPAQUE) nodes are created using the +mxmlNewOpaque function. The +mxmlGetOpaque function retrieves the +opaque string pointer for a node. Opaque nodes are like string nodes but +preserve all whitespace between nodes.
+ +Text (MXML_TEXT) nodes are created using the +mxmlNewText and +mxmlNewTextf functions. Each text node +consists of a text string and (leading) whitespace value - the +mxmlGetText function retrieves the +text string pointer and whitespace value for a node.
+ + +Processing instruction (MXML_ELEMENT) nodes are created using the +mxmlNewElement function. The +mxmlGetElement function retrieves the +processing instruction string for a node, including the surrounding "?" +characters.
+ +Note: + ++ +Processing instruction nodes are currently stored in memory as special +elements. This will be changed in a future major release of Mini-XML.
+
Real number (MXML_REAL) nodes are created using the +mxmlNewReal function. The +mxmlGetReal function retrieves the +CDATA string pointer for a node.
+ + +XML declaration (MXML_ELEMENT) nodes are created using the +mxmlNewXML function. The +mxmlGetElement function retrieves the +XML declaration string for a node, including the surrounding "?" characters.
+ +Note: + +-XML declaration nodes are currently stored in memory as special elements. +This will be changed in a future major release of Mini-XML.
+
- mxmlDelete(tree); -
We start by creating the <?xml version="1.0" encoding="utf-8"?> -node common to all XML files using the mxmlNewXML function:
+ +We start by creating the declaration node common to all XML files using the +mxmlNewXML function:
xml = mxmlNewXML("1.0");
-We then create the <data> node used for this -document using the mxmlNewElement function. The -first argument specifies the parent node (xml) while the -second specifies the element name (data):
+We then create the <data> node used for this document using +the mxmlNewElement function. The first +argument specifies the parent node (xml) while the second specifies the +element name (data):
data = mxmlNewElement(xml, "data");
-Each <node>...</node> in the file is -created using the mxmlNewElement and mxmlNewText functions. The first -argument of mxmlNewText specifies the parent node -(node). The second argument specifies whether whitespace -appears before the text - 0 or false in this case. The last -argument specifies the actual text to add:
+Each <node>...</node> in the file is created using the +mxmlNewElement and mxmlNewText +functions. The first argument of mxmlNewText specifies the parent node +(node). The second argument specifies whether whitespace appears before +the text - 0 or false in this case. The last argument specifies the actual text +to add:
node = mxmlNewElement(data, "node");
mxmlNewText(node, 0, "val1");
-The resulting in-memory XML document can then be saved or -processed just like one loaded from disk or a string.
+The resulting in-memory XML document can then be saved or processed just like +one loaded from disk or a string.
- +You load an XML file using the ?xml element if the parent node is NULL.
- +You save an XML file using the mxmlSaveAllocString() returns a string buffer that was allocated using malloc().
+When saving XML documents, Mini-XML normally wraps output @@ -382,6 +428,25 @@ overrides the default wrap margin:
mxmlSetWrapMargin(0); +Once you are done with the XML data, use the mxmlDelete function to recursively +free the memory that is used for a particular node or the entire +tree:
+ ++ mxmlDelete(tree); ++ +
You can also use reference counting to manage memory usage. The +mxmlRetain and +mxmlRelease functions increment and +decrement a node's use count, respectively. When the use count goes to 0, +mxmlRelease will automatically call mxmlDelete to actually +free the memory used by the node tree. New nodes automatically start with a +use count of 1.
+You can find the value of a specific node in the tree using the mxmlFindValue, for example: +
You can find specific nodes in the tree using the mxmlFindPath, for example:
- mxml_node_t *value = mxmlFindValue(tree, "path/to/*/foo/bar"); + mxml_node_t *value; + + value = mxmlFindPath(tree, "path/to/*/foo/bar");
The second argument is a "path" to the parent node. Each component of the diff --git a/doc/docset.intro b/doc/docset.intro index a900653..a179ddd 100644 --- a/doc/docset.intro +++ b/doc/docset.intro @@ -18,7 +18,7 @@ as do most vendors' ANSI C compilers) and a "make" program.
The "mxmlFindPath()" function finds the (first) value node under a specific +element using a "path":
+ ++mxml_node_t *value = mxmlFindPath(tree, "path/to/*/foo/bar"); ++ +
The "mxmlGetInteger()", "mxmlGetOpaque()", "mxmlGetReal()", and +"mxmlGetText()" functions retrieve the value from a node:
+ ++mxml_node_t *node; + +int intvalue = mxmlGetInteger(node); + +const char *opaquevalue = mxmlGetOpaque(node); + +double realvalue = mxmlGetReal(node); + +int whitespacevalue; +const char *textvalue = mxmlGetText(node, &whitespacevalue); ++
Finally, once you are done with the XML data, use the "mxmlDelete()" function to recursively free the memory that is used for a particular node or the entire tree:
diff --git a/doc/footer.man b/doc/footer.man index 62efb92..db38303 100644 --- a/doc/footer.man +++ b/doc/footer.man @@ -1,4 +1,4 @@ .SH SEE ALSO mxmldoc(1), Mini-XML Programmers Manual, http://www.minixml.org/ .SH COPYRIGHT -Copyright 2003-2008 by Michael Sweet. +Copyright 2003-2011 by Michael Sweet. diff --git a/doc/hires/logo.png b/doc/hires/logo.png deleted file mode 100644 index c966856..0000000 Binary files a/doc/hires/logo.png and /dev/null differ diff --git a/doc/install.html b/doc/install.html index 2a76973..5884501 100644 --- a/doc/install.html +++ b/doc/install.html @@ -94,7 +94,7 @@ of formats. The epm program is available from the following URL:- http://www.easysw.com/epm/ + http://www.epmhome.org/
Use the make command with the epm target diff --git a/doc/intro.html b/doc/intro.html index 7ad8fe0..53e93e3 100644 --- a/doc/intro.html +++ b/doc/intro.html @@ -37,7 +37,7 @@ and removed libxml2.
Thanks to lots of feedback and support from various developers, Mini-XML has evolved since then to provide a more -complete XML implementation and now stands at a whopping 3,747 +complete XML implementation and now stands at a whopping 3,965 lines of code, compared to 103,893 lines of code for libxml2 version 2.6.9.
diff --git a/doc/intro.man b/doc/intro.man index 7d05617..55bf45a 100644 --- a/doc/intro.man +++ b/doc/intro.man @@ -19,7 +19,7 @@ preserving the XML data hierarchy. Supports arbitrary element names, attributes, and attribute values with no preset limits, just available memory. .IP \(bu 4 -Supports integer, real, opaque ("cdata"), and text data types in +Supports integer, real, opaque ("CDATA"), and text data types in "leaf" nodes. .IP \(bu 4 Functions for creating, indexing, and managing trees of data. @@ -141,11 +141,27 @@ You can also iterate with the same function: } .fi .PP -To find the value of a specific node in the tree, use the "mxmlFindValue()" +To find the value of a specific node in the tree, use the "mxmlFindPath()" function: .nf - mxml_node_t *value = mxmlFindValue(tree, "path/to/*/foo/bar"); + mxml_node_t *value = mxmlFindPath(tree, "path/to/*/foo/bar"); +.fi +.PP +The "mxmlGetInteger()", "mxmlGetOpaque()", "mxmlGetReal()", and "mxmlGetText()" +functions retrieve the value from a node: +.nf + + mxml_node_t *node; + + int intvalue = mxmlGetInteger(node); + + const char *opaquevalue = mxmlGetOpaque(node); + + double realvalue = mxmlGetReal(node); + + int whitespacevalue; + const char *textvalue = mxmlGetText(node, &whitespacevalue); .fi .PP Finally, once you are done with the XML data, use the diff --git a/doc/license.html b/doc/license.html index da6f593..5a8ed3e 100644 --- a/doc/license.html +++ b/doc/license.html @@ -9,30 +9,26 @@ License the terms of the GNU Library General Public License version 2 (LGPL2) with the following exceptions: -If you link the application to a modified version - of Mini-XML, then the changes to Mini-XML must be - provided under the terms of the LGPL2 in sections 1, 2, - and 4.
-1. Static linking of applications to the Mini-XML +library does not constitute a derivative work and does +not require the author to provide source code for the +application, use the shared Mini-XML libraries, or link +their applications against a user-supplied version of +Mini-XML.
+ +If you link the application to a modified version +of Mini-XML, then the changes to Mini-XML must be +provided under the terms of the LGPL2 in sections 1, 2, +and 4.
+ +2. You do not have to provide a copy of the Mini-XML +license with programs that are linked to the Mini-XML +library, nor do you have to identify the Mini-XML license +in your program or documentation as required by section 6 +of the LGPL2.
+ ++
GNU LIBRARY GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1991 Free Software Foundation, Inc.
diff --git a/doc/logo.opacity b/doc/logo.opacity
deleted file mode 100644
index f27a031..0000000
Binary files a/doc/logo.opacity and /dev/null differ
diff --git a/doc/logo.png b/doc/logo.png
deleted file mode 100644
index 836d655..0000000
Binary files a/doc/logo.png and /dev/null differ
diff --git a/doc/mxml.html b/doc/mxml.html
index 7dba598..d66adda 100644
--- a/doc/mxml.html
+++ b/doc/mxml.html
@@ -44,7 +44,20 @@ A { text-decoration: none }
Getting Started with Mini-XML
Thanks to lots of feedback and support from various developers, Mini-XML has evolved since then to provide a more complete XML - implementation and now stands at a whopping 3,747 lines of code, + implementation and now stands at a whopping 3,965 lines of code, compared to 103,893 lines of code for libxml2 version 2.6.9.
Aside from Gutenprint, Mini-XML is used for the following projects/software applications:
@@ -386,7 +401,7 @@ rpmbuild(8) software to create Red Hat Package Manager ("RPM") epm(1) program to create software packages in a variety of formats. The epm program is available from the following URL:- http://www.easysw.com/epm/ + http://www.epmhome.org/
Use the make command with the epm target to create portable and native packages for your system:
@@ -413,7 +428,7 @@ hspace="10" src="2.gif" width="100">Getting Started with Mini-XMLEvery piece of information in an XML file (elements, text, numbers) - is stored in memory in "nodes". Nodes are defined by the -mxml_node_t structure. The type - member defines the node type (element, integer, opaque, real, or - text) which determines which value you want to look at in the -value union.
- - -| Value | Type | Node member |
|---|---|---|
| Custom | void * | -node->value.custom.data |
| Element | char * | -node->value.element.name |
| Integer | int | node->value.integer - |
| Opaque (string) | char * | -node->value.opaque |
| Real | double | node->value.real | -
| Text | char * | node->value.text.string - |
Each node also has a user_data member which allows you to - associate application-specific data with each node as needed.
-New nodes are created using the -mxmlNewElement, mxmlNewInteger -, mxmlNewOpaque, -mxmlNewReal, mxmlNewText -, mxmlNewTextf, and -mxmlNewXML functions. Only elements can have child nodes, - and the top node must be an element, usually the <?xml - version="1.0" encoding="utf-8"?> node created by mxmlNewXML() -.
-Nodes have pointers to the node above (parent), below ( -child), left (prev), and right (next) of the - current node. If you have an XML file like the following:
+Every piece of information in an XML file is stored in memory in + "nodes". Nodes are defined by the +mxml_node_t structure. Each node has a typed value, optional + user data, a parent node, sibling nodes (previous and next), and + potentially child nodes.
+For example, if you have an XML file like the following:
<?xml version="1.0" encoding="utf-8"?>
<data>
@@ -510,15 +490,96 @@ child), left (prev), and right (next) of the
| | |
val4 val5 val6
-where "-" is a pointer to the next node and "|" is a pointer to the - first child node.
-Once you are done with the XML data, use the -mxmlDelete function to recursively free the memory that is used - for a particular node or the entire tree:
-- mxmlDelete(tree); -+
where "-" is a pointer to the sibling node and "|" is a pointer to + the first child or parent node.
+The mxmlGetType function gets the + type of a node, one of MXML_CUSTOM, MXML_ELEMENT, +MXML_INTEGER, MXML_OPAQUE, MXML_REAL, or +MXML_TEXT. The parent and sibling nodes are accessed using the +mxmlGetParent, mxmlGetNext +, and mxmlGetPrevious functions. + The mxmlGetUserData function + gets any user data associated with the node.
+CDATA (MXML_ELEMENT) nodes are created using the +mxmlNewCDATA function. The +mxmlGetCDATA function retrieves the CDATA string pointer for a + node.
+Note: ++CDATA nodes are currently stored in memory as special elements. This + will be changed in a future major release of Mini-XML.
+
Custom (MXML_CUSTOM) nodes are created using the +mxmlNewCustom function or using a custom load callback + specified using the +mxmlSetCustomHandlers function. The +mxmlGetCustom function retrieves the custom value pointer for a + node.
+Comment (MXML_ELEMENT) nodes are created using the +mxmlNewElement function. The +mxmlGetElement function retrieves the comment string pointer + for a node, including the surrounding "!--" and "--" characters.
+Note: ++Comment nodes are currently stored in memory as special elements. + This will be changed in a future major release of Mini-XML.
+
Element (MXML_ELEMENT) nodes are created using the +mxmlNewElement function. The +mxmlGetElement function retrieves the element name, the +mxmlElementGetAttr function retrieves the value string for + a named attribute associated with the element, and the +mxmlGetFirstChild and +mxmlGetLastChild functions retrieve the first and last child + nodes for the element, respectively.
+Integer (MXML_INTEGER) nodes are created using the +mxmlNewInteger function. The +mxmlGetInteger function retrieves the integer value for a node.
+Opaque (MXML_OPAQUE) nodes are created using the +mxmlNewOpaque function. The +mxmlGetOpaque function retrieves the opaque string pointer for + a node. Opaque nodes are like string nodes but preserve all whitespace + between nodes.
+Text (MXML_TEXT) nodes are created using the +mxmlNewText and mxmlNewTextf + functions. Each text node consists of a text string and (leading) + whitespace value - the mxmlGetText + function retrieves the text string pointer and whitespace value for a + node.
+ + +Processing instruction (MXML_ELEMENT) nodes are created + using the mxmlNewElement + function. The mxmlGetElement + function retrieves the processing instruction string for a node, + including the surrounding "?" characters.
+Note: ++Processing instruction nodes are currently stored in memory as + special elements. This will be changed in a future major release of + Mini-XML.
+
Real number (MXML_REAL) nodes are created using the +mxmlNewReal function. The +mxmlGetReal function retrieves the CDATA string pointer for a + node.
+ +XML declaration (MXML_ELEMENT) nodes are created using the mxmlNewXML function. The +mxmlGetElement function retrieves the XML declaration + string for a node, including the surrounding "?" characters.
+Note: +XML declaration nodes are currently stored in memory as special + elements. This will be changed in a future major release of Mini-XML.
+
You can create and update XML documents in memory using the various @@ -555,9 +616,10 @@ mxmlNew functions. The following code will create the XML document node = mxmlNewElement(data, "node"); mxmlNewText(node, 0, "val8"); -
We start by creating the <?xml version="1.0" encoding="utf-8"?> - node common to all XML files using the -mxmlNewXML function:
+ + +We start by creating the declaration node common to all XML files + using the mxmlNewXML function:
xml = mxmlNewXML("1.0");
@@ -581,7 +643,7 @@ mxmlNewElement and mxmlNewText
The resulting in-memory XML document can then be saved or processed just like one loaded from disk or a string.
- +You load an XML file using the mxmlLoadFile function:
@@ -629,7 +691,7 @@ mxmlLoadFile(). The second argument specifies the string or character buffer to load and must be a complete XML document including the ?xml element if the parent node is NULL. - +You save an XML file using the mxmlSaveFile function:
@@ -670,6 +732,8 @@ mxmlSaveFile(). The mxmlSaveString function takes pointer and size arguments for saving the XML document to a fixed-size buffer, while mxmlSaveAllocString() returns a string buffer that was allocated using malloc(). + +When saving XML documents, Mini-XML normally wraps output lines at
column 75 so that the text is readable in terminal windows. The
@@ -682,9 +746,22 @@ mxmlSaveFile(). The mxmlSaveString function takes pointer
/* Disable wrapping */
mxmlSetWrapMargin(0);
+ Once you are done with the XML data, use the
+mxmlDelete function to recursively free the memory that is used
+ for a particular node or the entire tree: You can also use reference counting to manage memory usage. The
+mxmlRetain and mxmlRelease
+ functions increment and decrement a node's use count, respectively.
+ When the use count goes to 0, mxmlRelease will automatically
+ call mxmlDelete to actually free the memory used by the node
+ tree. New nodes automatically start with a use count of 1. The mxmlWalkPrev and
mxmlWalkNextfunctions can be used to iterate through the
XML node tree:Memory Management
+
+ mxmlDelete(tree);
+
+Finding and Iterating Nodes
+Finding and Iterating Nodes
You can find the value of a specific node in the tree using the -mxmlFindValue, for example:
+You can find specific nodes in the tree using the +mxmlFindPath, for example:
- mxml_node_t *value = mxmlFindValue(tree, "path/to/*/foo/bar"); + mxml_node_t *value; + + value = mxmlFindPath(tree, "path/to/*/foo/bar");
The second argument is a "path" to the parent node. Each component of the path is separated by a slash (/) and represents a named element in @@ -865,7 +944,7 @@ MXML_REAL, or MXML_TEXT. The function is called after type = mxmlElementGetAttr(node, "type"); if (type == NULL) - type = node->value.element.name; + type = mxmlGetElement(node); if (!strcmp(type, "integer")) return (MXML_INTEGER); @@ -916,7 +995,7 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback * just common HTML elements... */ - name = node->value.element.name; + name = mxmlGetElement(node); if (!strcmp(name, "html") || !strcmp(name, "head") || @@ -1080,8 +1159,7 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback * function pointers... */ - node->value.custom.data = dt; - node->value.custom.destroy = free; + mxmlSetCustom(node, data, destroy); /* * Return with no errors... @@ -1095,6 +1173,8 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback contain a void pointer to the allocated custom data for the node and a pointer to a destructor function which will free the custom data when the node is deleted.
+ +The save callback receives the node pointer and returns an allocated string containing the custom data value. The following save callback could be used for our ISO date/time type:
@@ -1106,7 +1186,7 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback iso_date_time_t *dt; - dt = (iso_date_time_t *)node->custom.data; + dt = (iso_date_time_t *)mxmlGetCustom(node); snprintf(data, sizeof(data), "%04u-%02u-%02uT%02u:%02u:%02uZ", @@ -1297,7 +1377,7 @@ mxmlRetain function. For example, the following SAX callback * Retain headings and titles... */ - char *name = node->value.element.name; + char *name = mxmlGetElement(node); if (!strcmp(name, "html") || !strcmp(name, "head") || @@ -1313,15 +1393,17 @@ mxmlRetain function. For example, the following SAX callback } else if (event == MXML_SAX_DIRECTIVE) mxmlRetain(node); - else if (event == MXML_SAX_DATA && - node->parent->ref_count > 1) + else if (event == MXML_SAX_DATA) { - /* - * If the parent was retained, then retain - * this data node as well. - */ + if (mxmlGetRefCount(mxmlGetParent(node)) > 1) + { + /* + * If the parent was retained, then retain + * this data node as well. + */ - mxmlRetain(node); + mxmlRetain(node); + } } } @@ -1349,9 +1431,9 @@ mxmlRetain function. For example, the following SAX callback if (body) { - for (heading = body->child; + for (heading = mxmlGetFirstChild(body); heading; - heading = heading->next) + heading = mxmlGetNextSibling(heading)) print_children(heading); } @@ -1417,7 +1499,7 @@ hspace="10" src="4.gif" width="100">Using the mxmldoc Utility will document all public names it finds in your source files - any names starting with the underscore character (_) or names that are documented with the @private@ directive are - treated as private and are undocumented. + treated as private and are not documented.Comments appearing directly before a function or type definition are used to document that function or type. Comments appearing after argument, definition, return type, or variable declarations are used to @@ -1472,8 +1554,8 @@ hspace="10" src="4.gif" width="100">Using the mxmldoc Utility included in the documentation
The Mini-XML library and included programs are provided under the terms of the GNU Library General Public License version 2 (LGPL2) with the following exceptions:
-1. Static linking of applications to the Mini-XML library does + not constitute a derivative work and does not require the author to + provide source code for the application, use the shared Mini-XML + libraries, or link their applications against a user-supplied version + of Mini-XML.
If you link the application to a modified version of Mini-XML, then the changes to Mini-XML must be provided under the terms of the LGPL2 in sections 1, 2, and 4.
-2. You do not have to provide a copy of the Mini-XML license + with programs that are linked to the Mini-XML library, nor do you have + to identify the Mini-XML license in your program or documentation as + required by section 6 of the LGPL2.
+
GNU LIBRARY GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1991 Free Software Foundation, Inc.
@@ -1947,9 +2026,12 @@ hspace="10" src="A.gif" width="100">Mini-XML License
hspace="10" src="B.gif" width="100">Release Notes
Find a value with the given path.
-mxml_node_t *mxmlFindValue ( + Mini-XML 2.7 mxmlFindPath +
Find a node with the given path.
+ mxml_node_t *mxmlFindPath (
mxml_node_t *top,
const char *path
);
First value node or NULL
+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.
+ forth. +Get the value for a CDATA node.
-char *mxmlGetCDATA ( +
const char *mxmlGetCDATA (
mxml_node_t *node
);
Get the value for a custom node.
-void *mxmlGetCustom ( +
const void *mxmlGetCustom (
mxml_node_t *node
);
Get the name for an element node.
-char *mxmlGetElement ( +
const char *mxmlGetElement (
mxml_node_t *node
);
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 *mxmlGetNext ( +
mxml_node_t
+ *mxmlGetNextSibling (
mxml_node_t *node
);
Get an opaque string value for a node or its first child.
-char *mxmlGetOpaque ( +
const char *mxmlGetOpaque (
mxml_node_t *node
);
NULL is returned for a root node.
Get the previous node for the current parent.
-mxml_node_t *mxmlGetPrevious - ( +
mxml_node_t
+ *mxmlGetPrevSibling (
mxml_node_t *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.
-char *mxmlGetText ( +
const char *mxmlGetText (
mxml_node_t *node,
int *whitespace
);
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.
@@ -2870,7 +2977,7 @@ mxmlEntityRemoveCallbackMXML_IGNORE is returned if "node" is
NULL.
Get the user data pointer for a node.
@@ -2932,7 +3039,7 @@ NULL. 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.
@@ -3076,7 +3183,7 @@ NULL.Create a new CDATA node.
@@ -3099,7 +3206,7 @@ NULL. 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. -Create a new custom data node.
@@ -3258,7 +3365,7 @@ NULL. 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.
@@ -3276,7 +3383,7 @@ NULL.The "version" argument specifies the version number to put in the ?xml element node. If NULL, version 1.0 is assumed.
-Release a node.
@@ -3307,7 +3414,7 @@ NULL.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.
@@ -3321,7 +3428,7 @@ NULL.New reference count
-Load a file descriptor into an XML node tree @@ -3363,7 +3470,7 @@ NULL.
Load a file into an XML node tree using a SAX @@ -3406,7 +3513,7 @@ NULL.
Load a string into an XML node tree using a SAX @@ -3556,7 +3663,7 @@ NULL.
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.
@@ -3576,7 +3683,7 @@ NULL.The node is not changed if it is not a CDATA element node.
-Set the data and destructor of a custom data @@ -3749,7 +3856,7 @@ mxmlSetCustomHandlers
0 on success, -1 on failure
The node is not changed if it is not a text node.
-Set the user data pointer for a node.
@@ -3766,7 +3873,7 @@ mxmlSetCustomHandlers0 on success, -1 on failure
-Set the wrap margin when saving XML data.
@@ -3923,7 +4030,7 @@ hspace="10" src="D.gif" width="100">XML SchemaThis appendix provides the XML schema that is used for the XML files produced by mxmldoc. This schema is available on-line at:
- http://www.easysw.com/~mike/mxmldoc.xsd + http://www.minixml.org/mxmldoc.xsd
@@ -3931,8 +4038,8 @@ hspace="10" src="D.gif" width="100">XML Schema
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:annotation>
<xsd:documentation xml:lang="en">
- Mini-XML 2.3 documentation schema for mxmldoc output.
- Copyright 2003-2007 by Michael Sweet.
+ Mini-XML 2.7 documentation schema for mxmldoc output.
+ Copyright 2003-2011 by Michael Sweet.
</xsd:documentation>
</xsd:annotation>
diff --git a/doc/mxmldoc.html b/doc/mxmldoc.html
index bf1eda4..89e1cf3 100644
--- a/doc/mxmldoc.html
+++ b/doc/mxmldoc.html
@@ -88,7 +88,7 @@ to describe the functions, types, and constants in your code.
source files - any names starting with the underscore character (_)
or names that are documented with the @private@ directive are treated as private
-and are undocumented.
+and are not documented.
Comments appearing directly before a function or type definition
are used to document that function or type. Comments appearing after
@@ -155,7 +155,7 @@ following special @name ...@ directive strings:
Find a value with the given path.
+Find a node with the given path.
-mxml_node_t *mxmlFindValue (
+mxml_node_t *mxmlFindPath (
mxml_node_t *top,
const char *path
);
First value node or NULL
+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.
+"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.
-char *mxmlGetCDATA (
+const char *mxmlGetCDATA (
mxml_node_t *node
);
Get the value for a custom node.
-void *mxmlGetCustom (
+const void *mxmlGetCustom (
mxml_node_t *node
);
Get the name for an element node.
-char *mxmlGetElement (
+const char *mxmlGetElement (
mxml_node_t *node
);
Return the node type...
-mxml_node_t *mxmlGetNext (
+mxml_node_t *mxmlGetNextSibling (
mxml_node_t *node
);
Get an opaque string value for a node or its first child.
-char *mxmlGetOpaque (
+const char *mxmlGetOpaque (
mxml_node_t *node
);
NULL is returned for a root node.
Get the previous node for the current parent.
-mxml_node_t *mxmlGetPrevious (
+mxml_node_t *mxmlGetPrevSibling (
mxml_node_t *node
);
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.
-char *mxmlGetText (
+const char *mxmlGetText (
mxml_node_t *node,
int *whitespace
);
- http://www.easysw.com/~mike/mxmldoc.xsd + http://www.minixml.org/mxmldoc.xsd