More Mini-XML
+Programming TechniquesMore Mini-XML
+Programming TechniquesThis chapter shows additional ways to use the Mini-XML library in your programs.
@@ -567,7 +568,7 @@ directives like <?xml ... ?> and <!DOCTYPE ... > * Retain headings and titles... */ - const char *name = node->value.element.name; + char *name = node->value.element.name; if (!strcmp(name, "html") || !strcmp(name, "head") || diff --git a/doc/basics.html b/doc/basics.html index 126c06f..3dce7b4 100644 --- a/doc/basics.html +++ b/doc/basics.html @@ -1,11 +1,41 @@ -
Getting Started
+with Mini-XMLThis chapter describes how to write programs that use Mini-XML to +access data in an XML file. Mini-XML provides the following +functionality:
+ +Mini-XML doesn't do validation or other types of processing +on the data based upon schema files or other sources of +definition information, nor does it support character entities +other than those required by the XML specification.
-This chapter describes how to write programs that use -Mini-XML to access data in an XML file.
New nodes can be created using the mxmlNewElement(), mxmlNewInteger(), mxmlNewOpaque(), mxmlNewReal(), mxmlNewText() mxmlNewTextf() mxmlNewXML() functions. Only -elements can have child nodes, and the top node must be an -element, usually <?xml version="1.0"?>.
- -Each node has a user_data member which allows you to -associate application-specific data with each node as needed.
- -Node also have pointers for the node above (parent), -below (child), to the left (prev), and to the -right (next) of the current node. If you have an XML -file like the following:
+ +| 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 mxmlNewXML functions. Only +elements can have child nodes, and the top node must be an element, +usually the <?xml version="1.0"?> 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:
<?xml version="1.0"?>
@@ -99,9 +169,9 @@ memory:
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:
+href='#mxmlDelete'>mxmlDelete function to recursively
+free the memory that is used for a particular node or the entire
+tree:
mxmlDelete(tree);
@@ -184,7 +254,7 @@ processed just like one loaded from disk or a string.
Loading XML
You load an XML file using the mxmlLoadFile()
+href='#mxmlLoadFile'>mxmlLoadFile
function:
@@ -221,7 +291,7 @@ values. Other standard callbacks include
MXML_OPAQUE_CALLBACK, and
MXML_REAL_CALLBACK.
-The mxmlLoadString()
+
The mxmlLoadString
function loads XML node trees from a string:
@@ -245,7 +315,7 @@ is NULL.
Saving XML
You save an XML file using the mxmlSaveFile() function:
+href='#mxmlSaveFile'>mxmlSaveFile function:
FILE *fp;
@@ -272,8 +342,8 @@ uses the MXML_NO_CALLBACK constant to specify that no
special whitespace handling is required.
The mxmlSaveAllocString(),
-and mxmlSaveString()
+href='#mxmlSaveAllocString'>mxmlSaveAllocString,
+and mxmlSaveString
functions save XML node trees to strings:
@@ -290,7 +360,7 @@ functions save XML node trees to strings:
The first and last arguments are the same as used for
-mxmlSaveFile(). The mxmlSaveString() function
+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
@@ -317,9 +387,9 @@ overrides the default wrap margin:
Finding and Iterating Nodes
The mxmlWalkPrev()
+href='#mxmlWalkPrev'>mxmlWalkPrev
and mxmlWalkNext()functions
+href='#mxmlWalkNext'>mxmlWalkNextfunctions
can be used to iterate through the XML node tree:
@@ -333,7 +403,7 @@ can be used to iterate through the XML node tree:
In addition, you can find a named element/node using the mxmlFindElement()
+href='#mxmlFindElement'>mxmlFindElement
function:
diff --git a/doc/chapters.xcf.gz b/doc/chapters.xcf.gz
new file mode 100644
index 0000000..e12a942
Binary files /dev/null and b/doc/chapters.xcf.gz differ
diff --git a/doc/hires/0.gif b/doc/hires/0.gif
new file mode 100644
index 0000000..6b47203
Binary files /dev/null and b/doc/hires/0.gif differ
diff --git a/doc/hires/1.gif b/doc/hires/1.gif
new file mode 100644
index 0000000..f96a166
Binary files /dev/null and b/doc/hires/1.gif differ
diff --git a/doc/hires/2.gif b/doc/hires/2.gif
new file mode 100644
index 0000000..4db284a
Binary files /dev/null and b/doc/hires/2.gif differ
diff --git a/doc/hires/3.gif b/doc/hires/3.gif
new file mode 100644
index 0000000..49ade8c
Binary files /dev/null and b/doc/hires/3.gif differ
diff --git a/doc/hires/4.gif b/doc/hires/4.gif
new file mode 100644
index 0000000..cb2b811
Binary files /dev/null and b/doc/hires/4.gif differ
diff --git a/doc/hires/5.gif b/doc/hires/5.gif
new file mode 100644
index 0000000..95bbc68
Binary files /dev/null and b/doc/hires/5.gif differ
diff --git a/doc/hires/6.gif b/doc/hires/6.gif
new file mode 100644
index 0000000..1bab481
Binary files /dev/null and b/doc/hires/6.gif differ
diff --git a/doc/hires/7.gif b/doc/hires/7.gif
new file mode 100644
index 0000000..dc66892
Binary files /dev/null and b/doc/hires/7.gif differ
diff --git a/doc/hires/8.gif b/doc/hires/8.gif
new file mode 100644
index 0000000..6231d1a
Binary files /dev/null and b/doc/hires/8.gif differ
diff --git a/doc/hires/9.gif b/doc/hires/9.gif
new file mode 100644
index 0000000..a40ce87
Binary files /dev/null and b/doc/hires/9.gif differ
diff --git a/doc/hires/A.gif b/doc/hires/A.gif
new file mode 100644
index 0000000..8fcc8d3
Binary files /dev/null and b/doc/hires/A.gif differ
diff --git a/doc/hires/B.gif b/doc/hires/B.gif
new file mode 100644
index 0000000..eac747e
Binary files /dev/null and b/doc/hires/B.gif differ
diff --git a/doc/hires/C.gif b/doc/hires/C.gif
new file mode 100644
index 0000000..c45f960
Binary files /dev/null and b/doc/hires/C.gif differ
diff --git a/doc/hires/D.gif b/doc/hires/D.gif
new file mode 100644
index 0000000..0be8510
Binary files /dev/null and b/doc/hires/D.gif differ
diff --git a/doc/hires/E.gif b/doc/hires/E.gif
new file mode 100644
index 0000000..4de1f96
Binary files /dev/null and b/doc/hires/E.gif differ
diff --git a/doc/hires/F.gif b/doc/hires/F.gif
new file mode 100644
index 0000000..80d92bb
Binary files /dev/null and b/doc/hires/F.gif differ
diff --git a/doc/hires/logo.gif b/doc/hires/logo.gif
new file mode 100644
index 0000000..2ef02d2
Binary files /dev/null and b/doc/hires/logo.gif differ
diff --git a/doc/install.html b/doc/install.html
index 68bea3b..2a76973 100644
--- a/doc/install.html
+++ b/doc/install.html
@@ -1,8 +1,9 @@
-1 - Building, Installing,
-and Packaging Mini-XML
+
Building,
+Installing, and Packaging Mini-XML
This chapter describes how to build, install, and package
Mini-XML on your system from the source archive. You will need an
diff --git a/doc/intro.html b/doc/intro.html
index 876620d..d3c1977 100644
--- a/doc/intro.html
+++ b/doc/intro.html
@@ -7,85 +7,29 @@
-Introduction
+
Introduction
-This programmers manual describes Mini-XML version 2.3, a
-small XML parsing library that you can use to read and write XML
-and XML-like data files in your application without requiring
-large non-standard libraries. Mini-XML only requires an ANSI C
-compatible compiler (GCC works, as do most vendors' ANSI C
-compilers) and a "make" program.
-
-Mini-XML provides the following functionality:
-
-
Mini-XML doesn't do validation or other types of processing -on the data based upon schema files or other sources of -definition information, nor does it support character entities -other than those required by the XML specification.
- - -The Mini-XML library is copyright 2003-2007 by Michael -Sweet.
- -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Library General Public -License as published by the Free Software Foundation; either -version 2 of the License, or (at your option) any later -version.
- -This library is distributed in the hope that it will be -useful, but WITHOUT ANY WARRANTY; without even the implied -warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR -PURPOSE. See the GNU Library General Public License for -more details.
- - -This programmers manual describes Mini-XML version 2.3, a small +XML parsing library that you can use to read and write XML data +files in your C and C++ applications.
Mini-XML was initially developed for the Gutenprint project to -replace the rather large and unwieldy libxml2 library -with something substantially smaller and easier-to-use. It all -began one morning in June of 2003 when Robert posted the -following sentence to the developer's list:
+href='http://gutenprint.sf.net/'>Gutenprint project to replace +the rather large and unwieldy libxml2 library with +something substantially smaller and easier-to-use. It all began one +morning in June of 2003 when Robert posted the following sentence to +the developer's list: -It's bad enough that we require libxml2, but rolling +It's bad enough that we require libxml2, but rolling our own XML parser is a bit more than we can -handle.+handle.
I then replied with:
-Given the limited scope of what you use in XML, it -should be trivial to code a mini-XML API in a few hundred lines -of code.+
Given the limited scope of what you use in XML, it +should be trivial to code a mini-XML API in a few hundred lines of +code.
I took my own challenge and coded furiously for two days to produced the initial public release of Mini-XML, total lines of @@ -122,7 +66,6 @@ project added or removed from this list, or if you have any comments/quotes you would like me to publish about your experiences with Mini-XML.
-This manual is organized into the following chapters and @@ -159,6 +102,10 @@ appendices:
Reference", contains a complete reference for Mini-XML, generated by mxmldoc. +The Mini-XML library is copyright 2003-2007 by Michael +Sweet.
+ +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Library General Public +License as published by the Free Software Foundation; either +version 2 of the License, or (at your option) any later +version.
+ +This library is distributed in the hope that it will be +useful, but WITHOUT ANY WARRANTY; without even the implied +warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +PURPOSE. See the GNU Library General Public License for +more details.
+ diff --git a/doc/license.html b/doc/license.html index a41ee7f..5486df6 100644 --- a/doc/license.html +++ b/doc/license.html @@ -1,7 +1,9 @@ -
Mini-XML
+LicenseThe Mini-XML library and included programs are provided under the terms of the GNU Library General Public License (LGPL) with diff --git a/doc/logo.gif b/doc/logo.gif new file mode 100644 index 0000000..28731f0 Binary files /dev/null and b/doc/logo.gif differ diff --git a/doc/logo.png b/doc/logo.png deleted file mode 100644 index aee1f51..0000000 Binary files a/doc/logo.png and /dev/null differ diff --git a/doc/logo.xcf.gz b/doc/logo.xcf.gz new file mode 100644 index 0000000..456540c Binary files /dev/null and b/doc/logo.xcf.gz differ diff --git a/doc/makedocs.sh b/doc/makedocs.sh index f558650..a0f0079 100755 --- a/doc/makedocs.sh +++ b/doc/makedocs.sh @@ -4,7 +4,7 @@ # # Script to make documentation... # -# Copyright 2003-2005 by Michael Sweet. +# Copyright 2003-2007 by Michael Sweet. # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU Library General Public @@ -17,17 +17,13 @@ # GNU General Public License for more details. # -htmldoc --verbose --batch mxml.book --no-embedfonts -f mxml.pdf +htmldoc --verbose --path hires:. --batch mxml.book -f mxml.pdf -htmldoc --verbose --batch mxml.book -f mxml.html - -htmldoc --verbose --batch mxml.book --gray --no-embedfonts -f mxml.ps -rm -f mxml.ps.gz -gzip -v9 mxml.ps +htmldoc --verbose --batch mxml.book --no-title -f mxml.html rm -rf mxml.d mkdir mxml.d -htmldoc --verbose --batch mxml.book -t htmlsep -d mxml.d +htmldoc --verbose --batch mxml.book --no-title -t htmlsep -d mxml.d # # End of "$Id$". diff --git a/doc/mxml-pocket.book b/doc/mxml-pocket.book deleted file mode 100644 index af9afdc..0000000 --- a/doc/mxml-pocket.book +++ /dev/null @@ -1,10 +0,0 @@ -#HTMLDOC 1.8.27.1 --t pdf14 -f "mxml-pocket.pdf" --book --toclevels 3 --no-numbered --toctitle "Table of Contents" --title --titleimage "title.html" --linkstyle plain --size 4.25x6.875in --left 0.750in --right 0.50in --top 0.50in --bottom 0.50in --header .t. --header1 ... --footer h.1 --nup 1 --tocheader .t. --tocfooter ..i --duplex --portrait --color --no-pscommands --no-xrxcomments --compression=9 --jpeg=95 --fontsize 9.0 --fontspacing 1.2 --headingfont Helvetica --bodyfont Helvetica --headfootsize 8.0 --headfootfont Helvetica-Oblique --charset iso-8859-1 --links --no-embedfonts --pagemode outline --pagelayout single --firstpage c1 --pageeffect none --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password "" --user-password "" --browserwidth 680 --no-strict --no-overflow -intro.html -install.html -basics.html -advanced.html -mxmldoc.html -license.html -relnotes.html -refapp.html diff --git a/doc/mxml.book b/doc/mxml.book index 71da689..4bf22d7 100644 --- a/doc/mxml.book +++ b/doc/mxml.book @@ -1,5 +1,5 @@ -#HTMLDOC 1.8.25 Commercial --t pdf12 -f mxml.pdf --book --toclevels 3 --no-numbered --toctitle "Table of Contents" --title --titleimage logo.png --linkstyle underline --size Universal --left 1.00in --right 0.50in --top 0.50in --bottom 0.50in --header .t. --header1 ... --footer h.1 --nup 1 --tocheader .t. --tocfooter ..i --duplex --portrait --color --no-pscommands --no-xrxcomments --compression=9 --jpeg=95 --fontsize 11.0 --fontspacing 1.2 --headingfont Helvetica --bodyfont Times --headfootsize 11.0 --headfootfont Helvetica --charset iso-8859-1 --links --no-embedfonts --pagemode outline --pagelayout single --firstpage c1 --pageeffect none --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password "" --user-password "" --browserwidth 680 --no-strict --no-overflow +#HTMLDOC 1.8.27.1 +-t pdf14 -f "mxml.pdf" --book --toclevels 3 --no-numbered --toctitle "Table of Contents" --title --titleimage "title.html" --linkstyle plain --size 4.25x6.875in --left 0.750in --right 0.50in --top 0.50in --bottom 0.50in --header .t. --header1 ... --footer h.1 --nup 1 --tocheader .t. --tocfooter ..i --duplex --portrait --color --no-pscommands --no-xrxcomments --compression=9 --jpeg=95 --fontsize 9.0 --fontspacing 1.2 --headingfont Helvetica --bodyfont Helvetica --headfootsize 8.0 --headfootfont Helvetica-Oblique --charset iso-8859-1 --links --embedfonts --pagemode outline --pagelayout single --firstpage c1 --pageeffect none --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password "" --user-password "" --browserwidth 300 --no-strict --no-overflow intro.html install.html basics.html @@ -8,3 +8,4 @@ mxmldoc.html license.html relnotes.html refapp.html +schema.html diff --git a/doc/mxml.html b/doc/mxml.html index f7cd1e8..90a2579 100644 --- a/doc/mxml.html +++ b/doc/mxml.html @@ -2,11 +2,11 @@
IntroductionThis programmers manual describes Mini-XML version 2.3, a small XML - parsing library that you can use to read and write XML and XML-like - data files in your application without requiring large non-standard - libraries. Mini-XML only requires an ANSI C compatible compiler (GCC - works, as do most vendors' ANSI C compilers) and a "make" program.
-Mini-XML provides the following functionality:
-Mini-XML doesn't do validation or other types of processing on the - data based upon schema files or other sources of definition - information, nor does it support character entities other than those - required by the XML specification.
- - -The Mini-XML library is copyright 2003-2005 by Michael Sweet.
-This library is free software; you can redistribute it and/or modify - it under the terms of the GNU Library General Public - License as published by the Free Software Foundation; either - version 2 of the License, or (at your option) any later version.
-This library is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details.
- - -Mini-XML was initially developed for the -Gimp-Print project to replace the rather large and unwieldy + parsing library that you can use to read and write XML data files in + your C and C++ applications.
+Mini-XML was initially developed for the +Gutenprint project to replace the rather large and unwieldy libxml2 library with something substantially smaller and easier-to-use. It all began one morning in June of 2003 when Robert posted the following sentence to the developer's list:
-It's bad enough that we require libxml2, but rolling our own - XML parser is a bit more than we can handle.+
It's bad enough that we require libxml2, but rolling our + own XML parser is a bit more than we can handle.
I then replied with:
-Given the limited scope of what you use in XML, it should be - trivial to code a mini-XML API in a few hundred lines of code.+
Given the limited scope of what you use in XML, it + should be trivial to code a mini-XML API in a few hundred lines of + code.
I took my own challenge and coded furiously for two days to produced the initial public release of Mini-XML, total lines of code: 696. - Robert promptly integrated Mini-XML into Gimp-Print and removed + Robert promptly integrated Mini-XML into Gutenprint 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 2,974 lines of code, - compared to 103,893 lines of code for libxml2 version 2.6.9. Aside from - Gimp-Print, Mini-XML is used for the following projects/software - applications:
+ implementation and now stands at a whopping 3,441 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:
Please email me (mxml @ easysw . com) if you would like your project added or removed from this list, or if you have any comments/quotes you would like me to publish about your experiences with Mini-XML.
- - -This manual is organized into the following chapters and appendices:
Various font and syntax conventions are used in this guide. Examples and their meanings and uses are explained below:
-| Example | Description | |
|---|---|---|
lpstat
-lpstat(1) | The names of commands; - the first mention of a command or function in a chapter is followed by - a manual page section number. | |
| /var
- /usr/share/cups/data/testprint.ps | -File and directory names. | |
| Request ID is Printer-123 | - | Screen output. |
| lp -d printer filename ENTER | - | Literal user input; special keys like ENTER are - in ALL CAPS. |
| 12.3 | Numbers in the text are - written using the period (.) to indicate the decimal point. | |
lpstat
+lpstat(1)The following abbreviations are used throughout this manual:
---
- Gb
- Gigabytes, or 1073741824 bytes -
+
+
- kb
- Kilobytes, or 1024 bytes -
+
+
- Mb
- Megabytes, or 1048576 bytes -
+
+
- UTF-8, UTF-16
- Unicode Transformation Format, 8-bit or 16-bit -
+
+
- W3C
- World Wide Web Consortium -
+
+
- XML
- Extensible Markup Language -
+
+
+ + +Other References
-
- The Unicode Standard, Version 4.0, Addison-Wesley, ISBN 0-321-18578-1
- The definition of the Unicode character set which is used for XML. -
+
+
- Extensible Markup Language (XML) 1.0 (Third Edition)
- The XML specification from the World Wide Web Consortium (W3C) -
+
+
The Mini-XML library is copyright 2003-2007 by Michael Sweet.
+This library is free software; you can redistribute it and/or modify + it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version.
+This library is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details.
+Building, Installing, and
+ Packaging Mini-XMLThis chapter describes how to build, install, and package Mini-XML on - your system.
+ your system from the source archive. You will need an ANSI/ISO-C + compatible compiler to build Mini-XML - GCC works, as do most vendors' + C compilers. If you are building Mini-XML on Windows, we recommend + using the Visual C++ environment with the supplied solution file. For + other operating systems, you'll need a POSIX-compatible shell and +make program in addition to the C compiler.Mini-XML comes with an autoconf-based configure script; just type the - following command to get things going:
+Mini-XML comes with both an autoconf-based configure script and a + Visual C++ solution that can be used to compile the library and + associated tools.
+Open the mxml.sln solution in the vcnet folder. + Choose the desired build configuration, "Debug" (the default) or + "Release", and then choose Build Solution from the + Build menu.
+Type the following command to configure the Mini-XML source code for + your system:
./configure ENTER
@@ -361,14 +362,14 @@ File and directory names.
make ENTER
Use the make command with the install target to - install Mini-XML in the configured directories:
+If you are using Visual C++, copy the mxml.lib and and + mxml.h files to the Visual C++ lib and include + directories, respectively.
+Otherwise, use the make command with the install + target to install Mini-XML in the configured directories:
make install ENTER
-If you are using Mini-XML under Microsoft Windows with Visual C++, - use the included project files in the vcnet subdirectory to - build the library instead.
Mini-XML includes two files that can be used to create binary packages. The first file is mxml.spec which is used by the @@ -392,17 +393,33 @@ epm(1) program to create software packages in a variety of formats.
The packages are stored in a subdirectory named dist for your convenience. The portable packages utilize scripts and tar files - to install the software on the target system; this is especially useful - when installing on systems with different Linux distributions. Use the - mxml.install script to install the software and mxml.remove - script to remove the software.
+ to install the software on the target system. After extracting the + package archive, use the mxml.install script to install the + software.The native packages will be in the local OS's native format: RPM for Red Hat Linux, DPKG for Debian Linux, PKG for Solaris, and so forth. Use the corresponding commands to install the native packages.
Getting Started with Mini-XMLThis chapter describes how to write programs that use Mini-XML to - access data in an XML file.
+ access data in an XML file. Mini-XML provides the following + functionality: +Mini-XML doesn't do validation or other types of processing on the + data based upon schema files or other sources of definition + information, nor does it support character entities other than those + required by the XML specification.
Mini-XML provides a single header file which you include:
@@ -427,15 +444,40 @@ epm(1) program to create software packages in a variety of formats. member defines the node type (element, integer, opaque, real, or text) which determines which value you want to look at in the value union. -New nodes can be created using the -mxmlNewElement(), -mxmlNewInteger(), mxmlNewOpaque() -, mxmlNewReal(), and -mxmlNewText() functions. Only elements can have child - nodes, and the top node must be an element, usually "?xml".
-Each node has pointers for the node above (parent), below ( -child), to the left (prev), and to the right (next -) of the current node. If you have an XML file like the following:
+ + ++ ++
Table 2-1: Mini-XML Node Value + Members ++ 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 +mxmlNewXML functions. Only elements can have child nodes, + and the top node must be an element, usually the <?xml + version="1.0"?> 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:
<?xml version="1.0"?> <data> @@ -449,19 +491,17 @@ child), to the left (prev), and to the right (next </group> <node>val7</node> <node>val8</node> - <node>val9</node> </data>-the node tree returned by mxmlLoadFile() would look like the - following in memory:
+the node tree for the file would look like the following in memory:
?xml | data | - node - node - node - group - node - node - node - | | | | | | | - val1 val2 val3 | val7 val8 val9 + node - node - node - group - node - node + | | | | | | + val1 val2 val3 | val7 val8 | node - node - node | | | @@ -470,20 +510,85 @@ child), to the left (prev), and to the right (nextwhere "-" 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 function to recursively free the memory that is used + for a particular node or the entire tree:mxmlDelete(tree);-Loading XML
+ + +Creating XML Documents
+You can create and update XML documents in memory using the various +mxmlNew functions. The following code will create the XML document + described in the previous section:
++ mxml_node_t *xml; /* <?xml ... ?> */ + mxml_node_t *data; /* <data> */ + mxml_node_t *node; /* <node> */ + mxml_node_t *group; /* <group> */ + + xml = mxmlNewXML("1.0"); + + data = mxmlNewElement(xml, "data"); + + node = mxmlNewElement(data, "node"); + mxmlNewText(node, 0, "val1"); + node = mxmlNewElement(data, "node"); + mxmlNewText(node, 0, "val2"); + node = mxmlNewElement(data, "node"); + mxmlNewText(node, 0, "val3"); + + group = mxmlNewElement(data, "group"); + + node = mxmlNewElement(group, "node"); + mxmlNewText(node, 0, "val4"); + node = mxmlNewElement(group, "node"); + mxmlNewText(node, 0, "val5"); + node = mxmlNewElement(group, "node"); + mxmlNewText(node, 0, "val6"); + + node = mxmlNewElement(data, "node"); + mxmlNewText(node, 0, "val7"); + node = mxmlNewElement(data, "node"); + mxmlNewText(node, 0, "val8"); ++We start by creating the <?xml version="1.0"?> 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):
++ 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:
++ 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.
+ + +Loading XML
You load an XML file using the -mxmlLoadFile() function:
+mxmlLoadFile function:FILE *fp; - mxml_node_t *tree; + mxml_node_t *tree; fp = fopen("filename.xml", "r"); - tree = mxmlLoadFile(NULL, fp, MXML_NO_CALLBACK); + tree = mxmlLoadFile(NULL, fp, + MXML_TEXT_CALLBACK); fclose(fp);The first argument specifies an existing XML parent node, if any. @@ -496,33 +601,41 @@ NULL.
if you are implementing an XML filter program.The third argument specifies a callback function which returns the value type of the immediate children for a new element node: -MXML_INTEGER, MXML_OPAQUE, MXML_REAL, or -MXML_TEXT. Load callbacks are described in detail in -Chapter 3. The example code uses the MXML_NO_CALLBACK - constant which specifies that all data nodes in the document contain - whitespace-separated text values.
-The mxmlLoadString() function +MXML_CUSTOM, MXML_IGNORE, MXML_INTEGER, +MXML_OPAQUE, MXML_REAL, or MXML_TEXT. Load + callbacks are described in detail in Chapter + 3. The example code uses the MXML_TEXT_CALLBACK constant + which specifies that all data nodes in the document contain + whitespace-separated text values. Other standard callbacks include +MXML_IGNORE_CALLBACK, MXML_INTEGER_CALLBACK, +MXML_OPAQUE_CALLBACK, and MXML_REAL_CALLBACK.
+The mxmlLoadString function loads XML node trees from a string:
+ +char buffer[8192]; - mxml_node_t *tree; + mxml_node_t *tree; ... - tree = mxmlLoadString(NULL, buffer, MXML_NO_CALLBACK); + tree = mxmlLoadString(NULL, buffer, + MXML_TEXT_CALLBACK);The first and third arguments are the same as used for 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.
-Saving XML
+ + +Saving XML
You save an XML file using the -mxmlSaveFile() function:
+mxmlSaveFile function:FILE *fp; - mxml_node_t *tree; + mxml_node_t *tree; fp = fopen("filename.xml", "w"); - mxmlSaveFile(tree, fp, MXML_NO_CALLBACK); + mxmlSaveFile(tree, fp, MXML_NO_CALLBACK); fclose(fp);The first argument is the XML node tree to save. It should normally @@ -532,122 +645,168 @@ fopen() or popen(). You can also use stdout if you are implementing an XML filter program.
The third argument is the whitespace callback to use when saving the file. Whitespace callbacks are covered in detail in -Chapter 3. The example code above uses the MXML_NO_CALLBACK +Chapter 3. The previous example code uses the MXML_NO_CALLBACK constant to specify that no special whitespace handling is required.
-The mxmlSaveAllocString() -, and mxmlSaveString() functions +
The mxmlSaveAllocString, + and mxmlSaveString functions save XML node trees to strings:
char buffer[8192]; char *ptr; - mxml_node_t *tree; + mxml_node_t *tree; ... - mxmlSaveString(tree, buffer, sizeof(buffer), MXML_NO_CALLBACK); + mxmlSaveString(tree, buffer, sizeof(buffer), + MXML_NO_CALLBACK); ... - ptr = mxmlSaveAllocString(tree, MXML_NO_CALLBACK); + ptr = mxmlSaveAllocString(tree, MXML_NO_CALLBACK);The first and last arguments are the same as used for -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().
-Finding and Iterating Nodes
-The mxmlWalkPrev() and -mxmlWalkNext()functions can be used to iterate through the +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().
+Controlling Line Wrapping
+When saving XML documents, Mini-XML normally wraps output lines at + column 75 so that the text is readable in terminal windows. The +mxmlSetWrapMargin function overrides the default wrap + margin:
++ /* Set the margin to 132 columns */ + mxmlSetWrapMargin(132); + + /* Disable wrapping */ + mxmlSetWrapMargin(0); ++ + +Finding and Iterating Nodes
+The mxmlWalkPrev and +mxmlWalkNextfunctions can be used to iterate through the XML node tree:
- mxml_node_t *node = mxmlWalkPrev(current, tree, MXML_DESCEND); + mxml_node_t *node; + + node = mxmlWalkPrev(current, tree, + MXML_DESCEND); - mxml_node_t *node = mxmlWalkNext(current, tree, MXML_DESCEND); + node = mxmlWalkNext(current, tree, + MXML_DESCEND);In addition, you can find a named element/node using the -mxmlFindElement() function:
+mxmlFindElement function:- mxml_node_t *node = mxmlFindElement(tree, tree, "name", "attr", - "value", MXML_DESCEND); + mxml_node_t *node; + + node = mxmlFindElement(tree, tree, "name", + "attr", "value", + MXML_DESCEND);The name, attr, and value arguments can be passed as NULL to act as wildcards, e.g.:
+ +/* Find the first "a" element */ - node = mxmlFindElement(tree, tree, "a", NULL, NULL, MXML_DESCEND); + node = mxmlFindElement(tree, tree, "a", + NULL, NULL, + MXML_DESCEND); +- /* Find the first "a" element with "href" attribute */ - node = mxmlFindElement(tree, tree, "a", "href", NULL, MXML_DESCEND); + ++ /* Find the first "a" element with "href" + attribute */ + node = mxmlFindElement(tree, tree, "a", + "href", NULL, + MXML_DESCEND); +- /* Find the first "a" element with "href" to a URL */ - node = mxmlFindElement(tree, tree, "a", "href", - "http://www.easysw.com/~mike/mxml/", MXML_DESCEND); + ++ /* Find the first "a" element with "href" + to a URL */ + node = mxmlFindElement(tree, tree, "a", + "href", + "http://www.easysw.com/", + MXML_DESCEND); +- /* Find the first element with a "src" attribute*/ - node = mxmlFindElement(tree, tree, NULL, "src", NULL, MXML_DESCEND); + ++ /* Find the first element with a "src" + attribute */ + node = mxmlFindElement(tree, tree, NULL, + "src", NULL, + MXML_DESCEND); +- /* Find the first element with a "src" = "foo.jpg" */ - node = mxmlFindElement(tree, tree, NULL, "src", "foo.jpg", MXML_DESCEND); + ++ /* Find the first element with a "src" + = "foo.jpg" */ + node = mxmlFindElement(tree, tree, NULL, + "src", "foo.jpg", + MXML_DESCEND);You can also iterate with the same function:
- mxml_node_t *node; + mxml_node_t *node; - for (node = mxmlFindElement(tree, tree, "name", NULL, NULL, MXML_DESCEND); + for (node = mxmlFindElement(tree, tree, + "name", + NULL, NULL, + MXML_DESCEND); node != NULL; - node = mxmlFindElement(node, tree, "name", NULL, NULL, MXML_DESCEND)) + node = mxmlFindElement(node, tree, + "name", + NULL, NULL, + MXML_DESCEND)) { ... do something ... }+ +The MXML_DESCEND argument can actually be one of three constants:
The previous node from "group" would be the "node" element to the
+ left, while the next node from "group" would be the "node" element to
+ the right.
+
+
This mode is only applicable to the search function; the walk
+ functions treat this as MXML_DESCEND since every call is a
+ first time.
+
+
- ?xml - data - node - val1 - node - val2 - node - val3 - group - node - val4 - node - val5 - node - val6 - node - val7 - node - val8 - node - val9 --
If you started at "val9" and walked using mxmlWalkPrev(), +
If you were to walk from the root node "?xml" to the end of the tree + with mxmlWalkNext(), the order would be:
+?xml data node val1 node val2 node val3 group node val4 node val5 + node val6 node val7 node val8
+If you started at "val8" and walked using mxmlWalkPrev(), the order would be reversed, ending at "?xml".
More Mini-XML Programming
+ TechniquesThis chapter shows additional ways to use the Mini-XML library in your programs.
The following callback function looks for an attribute named "type" or the element name to determine the value type for its child nodes:
- /*
- * 'type_cb()' - XML data type callback for mxmlLoadFile()...
- */
-
- mxml_type_t /* O - Data type */
- type_cb(mxml_node_t *node) /* I - Element node */
+ mxml_type_t
+ type_cb(mxml_node_t *node)
{
- const char *type; /* Type string */
-
+ const char *type;
/*
- * You can lookup attributes and/or use the element name, hierarchy, etc...
+ * You can lookup attributes and/or use the
+ * element name, hierarchy, etc...
*/
- if ((type = mxmlElementGetAttr(node, "type")) == NULL)
+ type = mxmlElementGetAttr(node, "type");
+ if (type == NULL)
type = node->value.element.name;
if (!strcmp(type, "integer"))
@@ -712,10 +868,10 @@ MXML_REAL, or MXML_TEXT. The function is called after
of the load functions:
FILE *fp;
- mxml_node_t *tree;
+ mxml_node_t *tree;
fp = fopen("filename.xml", "r");
- tree = mxmlLoadFile(NULL, fp, type_cb);
+ tree = mxmlLoadFile(NULL, fp, type_cb);
fclose(fp);
Save Callbacks
@@ -731,54 +887,63 @@ MXML_WS_BEFORE_OPEN, MXML_WS_AFTER_OPEN,
MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
function should return NULL if no whitespace should be added
and the string to insert (spaces, tabs, carriage returns, and newlines)
- otherwise. The following whitespace callback can be used to add
- whitespace to XHTML output to make it more readable in a standard text
- editor:
-
-
+ otherwise.
+The following whitespace callback can be used to add whitespace to
+ XHTML output to make it more readable in a standard text editor:
- /*
- * 'whitespace_cb()' - Let the mxmlSaveFile() function know when to insert
- * newlines and tabs...
- */
-
- const char * /* O - Whitespace string or NULL */
- whitespace_cb(mxml_node_t *node, /* I - Element node */
- int where) /* I - Open or close tag? */
+ const char *
+ whitespace_cb(mxml_node_t *node,
+ int where)
{
- const char *name; /* Name of element */
+ const char *name;
/*
- * We can conditionally break to a new line before or after any element.
- * These are just common HTML elements...
+ * We can conditionally break to a new line
+ * before or after any element. These are
+ * just common HTML elements...
*/
name = node->value.element.name;
- if (!strcmp(name, "html") || !strcmp(name, "head") || !strcmp(name, "body") ||
- !strcmp(name, "pre") || !strcmp(name, "p") ||
- !strcmp(name, "h1") || !strcmp(name, "h2") || !strcmp(name, "h3") ||
- !strcmp(name, "h4") || !strcmp(name, "h5") || !strcmp(name, "h6"))
+ if (!strcmp(name, "html") ||
+ !strcmp(name, "head") ||
+ !strcmp(name, "body") ||
+ !strcmp(name, "pre") ||
+ !strcmp(name, "p") ||
+ !strcmp(name, "h1") ||
+ !strcmp(name, "h2") ||
+ !strcmp(name, "h3") ||
+ !strcmp(name, "h4") ||
+ !strcmp(name, "h5") ||
+ !strcmp(name, "h6"))
{
/*
- * Newlines before open and after close...
+ * Newlines before open and after
+ * close...
*/
- if (where == MXML_WS_BEFORE_OPEN || where == MXML_WS_AFTER_CLOSE)
+ if (where == MXML_WS_BEFORE_OPEN ||
+ where == MXML_WS_AFTER_CLOSE)
return ("\n");
}
- else if (!strcmp(name, "dl") || !strcmp(name, "ol") || !strcmp(name, "ul"))
+ else if (!strcmp(name, "dl") ||
+ !strcmp(name, "ol") ||
+ !strcmp(name, "ul"))
{
/*
- * Put a newline before and after list elements...
+ * Put a newline before and after list
+ * elements...
*/
return ("\n");
}
- else if (!strcmp(name, "dd") || !strcmp(name, "dt") || !strcmp(name, "li"))
+ else if (!strcmp(name, "dd") ||
+ !strcmp(name, "dt") ||
+ !strcmp(name, "li"))
{
/*
- * Put a tab before <li>'s, <dd>'s, and <dt>'s, and a newline after them...
+ * Put a tab before <li>'s, * <dd>'s,
+ * and <dt>'s, and a newline after them...
*/
if (where == MXML_WS_BEFORE_OPEN)
@@ -794,18 +959,18 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
return (NULL);
}
-
-
To use this callback function, simply use the name when you call any
of the save functions:
FILE *fp;
- mxml_node_t *tree;
+ mxml_node_t *tree;
fp = fopen("filename.xml", "w");
- mxmlSaveFile(tree, fp, whitespace_cb);
+ mxmlSaveFile(tree, fp, whitespace_cb);
fclose(fp);
+
+
Custom Data Types
Mini-XML supports custom data types via global load and save
callbacks. Only a single set of callbacks can be active at any time,
@@ -821,22 +986,21 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
typedef struct
{
- unsigned year, /* Year */
- month, /* Month */
- day, /* Day */
- hour, /* Hour */
- minute, /* Minute */
- second; /* Second */
- time_t unix; /* UNIX time value */
+ unsigned year, /* Year */
+ month, /* Month */
+ day, /* Day */
+ hour, /* Hour */
+ minute, /* Minute */
+ second; /* Second */
+ time_t unix; /* UNIX time */
} iso_date_time_t;
- int /* I - 0 on success, -1 on error */
- load_custom(mxml_node_t *node, /* I - Node */
- const char *data) /* I - Value */
+ int
+ load_custom(mxml_node_t *node,
+ const char *data)
{
- iso_date_time_t *dt; /* Date/time value */
- struct tm tmdata; /* UNIX time data */
-
+ iso_date_time_t *dt;
+ struct tm tmdata;
/*
* Allocate data structure...
@@ -845,16 +1009,19 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
dt = calloc(1, sizeof(iso_date_time_t));
/*
- * Try reading 6 unsigned integers from the data string...
+ * Try reading 6 unsigned integers from the
+ * data string...
*/
if (sscanf(data, "%u-%u-%uT%u:%u:%uZ",
- &(dt->year), &(dt->month), &(dt->day),
- &(dt->hour), &(dt->minute), &(dt->second)) != 6)
+ &(dt->year), &(dt->month),
+ &(dt->day), &(dt->hour),
+ &(dt->minute),
+ &(dt->second)) != 6)
{
/*
- * Unable to read numbers, free the data structure and return an
- * error...
+ * Unable to read numbers, free the data
+ * structure and return an error...
*/
free(dt);
@@ -882,7 +1049,8 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
}
/*
- * Convert ISO time to UNIX time in seconds...
+ * Convert ISO time to UNIX time in
+ * seconds...
*/
tmdata.tm_year = dt->year - 1900;
@@ -895,7 +1063,8 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
dt->unix = gmtime(&tmdata);
/*
- * Assign custom node data and destroy function pointers...
+ * Assign custom node data and destroy
+ * function pointers...
*/
node->value.custom.data = dt;
@@ -913,24 +1082,23 @@ 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:
- char * /* I - Allocated string */
- save_custom(mxml_node_t *node) /* I - Node */
+ char *
+ save_custom(mxml_node_t *node)
{
- char data[255]; /* Data string */
- iso_date_time_t *dt; /* ISO date/time pointer */
+ char data[255];
+ iso_date_time_t *dt;
dt = (iso_date_time_t *)node->custom.data;
- snprintf(data, sizeof(data), "%04u-%02u-%02uT%02u:%02u:%02uZ",
- dt->year, dt->month, dt->day, dt->hour,
- dt->minute, dt->second);
+ snprintf(data, sizeof(data),
+ "%04u-%02u-%02uT%02u:%02u:%02uZ",
+ dt->year, dt->month, dt->day,
+ dt->hour, dt->minute, dt->second);
return (strdup(data));
}
@@ -938,8 +1106,11 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
You register the callback functions using the
mxmlSetCustomHandlers() function:
- mxmlSetCustomHandlers(load_custom, save_custom);
+ mxmlSetCustomHandlers(load_custom,
+ save_custom);
+
+
Changing Node Values
All of the examples so far have concentrated on creating and loading
new XML data nodes. Many applications, however, need to manipulate or
@@ -948,29 +1119,31 @@ MXML_WS_BEFORE_CLOSE, or MXML_WS_AFTER_CLOSE. The callback
Existing nodes can be changed using the
mxmlSetElement(),
mxmlSetInteger(), mxmlSetOpaque()
-, mxmlSetReal(), and
-mxmlSetText() functions. For example, use the following
+, mxmlSetReal(),
+mxmlSetText(), and
+mxmlSetTextf() functions. For example, use the following
function call to change a text node to contain the text "new" with
leading whitespace:
- mxml_node_t *node;
+ mxml_node_t *node;
- mxmlSetText(node, 1, "new");
+ mxmlSetText(node, 1, "new");
Formatted Text
The mxmlNewTextf() and
mxmlSetTextf() functions create and change text nodes,
respectively, using printf-style format strings and arguments.
- For example, use the following function call to create a new text node:
+ For example, use the following function call to create a new text node
+ containing a constructed filename:
- mxml_node_t *node;
+ mxml_node_t *node;
- node = mxmlNewTextf(node, 1, "%s/%s",
+ node = mxmlNewTextf(node, 1, "%s/%s",
path, filename);
Indexing
Mini-XML provides functions for managing indices of nodes. The
- current implementation provides the same functionality as the
+ current implementation provides the same functionality as
mxmlFindElement(). The advantage of using an index is that
searching and enumeration of elements is significantly faster. The only
disadvantage is that each index is a static snapshot of the XML
@@ -982,10 +1155,11 @@ mxmlSetInteger(), mxmlSetOpaque()
structures. The mxmlIndexNew()
function creates a new index:
- mxml_node_t *tree;
- mxml_index_t *ind;
+ mxml_node_t *tree;
+ mxml_index_t *ind;
- ind = mxmlIndexNew(tree, "element", "attribute");
+ ind = mxmlIndexNew(tree, "element",
+ "attribute");
The first argument is the XML node tree to index. Normally this will
be a pointer to the ?xml element.
@@ -1006,8 +1180,7 @@ mxmlIndexEnum(), mxmlIndexFind()
enumerates each of the nodes in the index and can be used in a loop as
follows:
- mxml_node_t *node;
- mxml_index_t *ind;
+ mxml_node_t *node;
mxmlIndexReset(ind);
@@ -1021,12 +1194,13 @@ mxmlIndexEnum()
, mxmlIndexFind()
the index. It can be used to find all matching elements in an index, as
follows:
- mxml_node_t *node;
- mxml_index_t *ind;
+ mxml_node_t *node;
mxmlIndexReset(ind);
- while ((node = mxmlIndexFind(ind, "element", "attr-value")) != NULL)
+ while ((node = mxmlIndexFind(ind, "element",
+ "attr-value"))
+ != NULL)
{
// do something with node
}
@@ -1036,54 +1210,166 @@ mxmlIndexEnum()
, mxmlIndexFind()
return all elements or attributes in the index. Passing NULL
for both the element name and attribute value is equivalent to calling
mxmlIndexEnum.
-
-
When you are done using the index, delete it using the
mxmlIndexDelete() function:
- mxml_index_t *ind;
-
mxmlIndexDelete(ind);
-
+SAX (Stream) Loading of Documents
+Mini-XML supports an implementation of the Simple API for XML (SAX)
+ which allows you to load and process an XML document as a stream of
+ nodes. Aside from allowing you to process XML documents of any size,
+ the Mini-XML implementation also allows you to retain portions of the
+ document in memory for later processing.
+The mxmlSAXLoadFd,
+mxmlSAXLoadFile, and
+mxmlSAXLoadString functions provide the SAX loading APIs. Each
+ function works like the corresponding mxmlLoad function but
+ uses a callback to process each node as it is read.
+The callback function receives the node, an event code, and a user
+ data pointer you supply:
+
+ void
+ sax_cb(mxml_node_t *node,
+ mxml_sax_event_t event,
+ void *data)
+ {
+ ... do something ...
+ }
+
+The event will be one of the following:
+
+- MXML_SAX_CDATA - CDATA was just read
+- MXML_SAX_COMMENT - A comment was just read
+- MXML_SAX_DATA - Data (custom, integer, opaque, real, or
+ text) was just read
+- MXML_SAX_DIRECTIVE - A processing directive was just read
+- MXML_SAX_ELEMENT_CLOSE - An open element was just read (
+<element>)
+- MXML_SAX_ELEMENT_OPEN - A close element was just read (
+</element>)
+
+Elements are released after the close element is processed.
+ All other nodes are released after they are processed. The SAX callback
+ can retain the node using the
+mxmlRetain function. For example, the following SAX callback
+ will retain all nodes, effectively simulating a normal in-memory load:
+
+ void
+ sax_cb(mxml_node_t *node,
+ mxml_sax_event_t event,
+ void *data)
+ {
+ if (event != MXML_SAX_ELEMENT_CLOSE)
+ mxmlRetain(node);
+ }
+
+More typically the SAX callback will only retain a small portion of
+ the document that is needed for post-processing. For example, the
+ following SAX callback will retain the title and headings in an XHTML
+ file. It also retains the (parent) elements like <html>,
+<head>, and <body>, and processing directives like
+<?xml ... ?> and <!DOCTYPE ... >:
-
+
+
+ void
+ sax_cb(mxml_node_t *node,
+ mxml_sax_event_t event,
+ void *data)
+ {
+ if (event == MXML_SAX_ELEMENT_OPEN)
+ {
+ /*
+ * Retain headings and titles...
+ */
-
-mxmldoc(1)
-Name
- mxmldoc - mini-xml documentation generator
-Synopsis
- mxmldoc [ --intro introfile.html ] [ --section section
- ] [ --title title ] [ filename.xml ] [ source file(s)
- ] > filename.html
-Description
- mxmldoc scans the specified C and C++ source files to produce an
- XML representation of globally accessible classes, constants,
+ char *name = node->value.element.name;
+
+ if (!strcmp(name, "html") ||
+ !strcmp(name, "head") ||
+ !strcmp(name, "title") ||
+ !strcmp(name, "body") ||
+ !strcmp(name, "h1") ||
+ !strcmp(name, "h2") ||
+ !strcmp(name, "h3") ||
+ !strcmp(name, "h4") ||
+ !strcmp(name, "h5") ||
+ !strcmp(name, "h6"))
+ mxmlRetain(node);
+ }
+ else if (event == MXML_SAX_DIRECTIVE)
+ mxmlRetain(node);
+ else if (event == MXML_SAX_DATA &&
+ node->parent->ref_count > 1)
+ {
+ /*
+ * If the parent was retained, then retain
+ * this data node as well.
+ */
+
+ mxmlRetain(node);
+ }
+ }
+
+The resulting skeleton document tree can then be searched just like
+ one loaded using the mxmlLoad functions. For example, a filter
+ that reads an XHTML document from stdin and then shows the title and
+ headings in the document would look like:
+
+ mxml_node_t *doc, *title, *body, *heading;
+
+ doc = mxmlSAXLoadFd(NULL, 0,
+ MXML_TEXT_CALLBACK,
+ sax_cb, NULL);
+
+ title = mxmlFindElement(doc, doc, "title",
+ NULL, NULL,
+ MXML_DESCEND);
+
+ if (title)
+ print_children(title);
+
+ body = mxmlFindElement(doc, doc, "body",
+ NULL, NULL,
+ MXML_DESCEND);
+
+ if (body)
+ {
+ for (heading = body->child;
+ heading;
+ heading = heading->next)
+ print_children(heading);
+ }
+
+
+
Using the mxmldoc Utility
+The Basics
+Originally developed to generate the Mini-XML and CUPS API
+ documentation, the mxmldoc(1) program converts C and C++
+ source files into an intermediate XML format and uses in-line comments
+ rather than comment headers to annotate functions, types, and
+ constants.
+
+Commenting Your Code
+Creating HTML Documentation
+Creating Man Pages
+The XML Schema
+mxmldoc scans the specified C and C++ source files to produce
+ an XML representation of globally accessible classes, constants,
enumerations, functions, structures, typedefs, unions, and variables.
The XML file is updated as necessary and a HTML representation of the
XML file is written to the standard output. If no source files are
specified then the current XML file is converted to HTML on the
- standard output.
+ standard output.
In general, any C or C++ source code is handled by mxmldoc,
however it was specifically written to handle code with documentation
that is formatted according to the CUPS Configuration Management Plan
which is available at "http://www.cups.org/documentation.php".
-Options
-
-- --intro introfile.html
-- Inserts the specified file at the top of the output documentation.
-- --section section
-- Sets the section/keywords in the output documentation.
-- --title title
-- Sets the title of the output documentation.
-
-See Also
- mxml(3), Mini-XML Programmers Manual, http://www.easysw.com/~mike/mxml/
-Copyright
- Copyright 2003-2005 by Michael Sweet.
-A - Mini-XML License
-October 18, 2005
+
+Mini-XML License
The Mini-XML library and included programs are provided under the
terms of the GNU Library General Public License (LGPL) with the
following exceptions:
@@ -1101,8 +1387,7 @@ mxmlIndexEnum.
identify the Mini-XML license in your program or documentation as
required by section 6 of the LGPL.
-
-GNU LIBRARY GENERAL PUBLIC LICENSE
+GNU LIBRARY GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1991 Free Software Foundation, Inc.
59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
@@ -1110,7 +1395,7 @@ mxmlIndexEnum.
this license document, but changing it is not allowed.
[This is the first released version of the library GPL. It is
numbered 2 because it goes with version 2 of the ordinary GPL.]
-Preamble
+Preamble
The licenses for most software are designed to take away your freedom
to share and change it. By contrast, the GNU General Public Licenses
are intended to guarantee your freedom to share and change free
@@ -1185,8 +1470,8 @@ mxmlIndexEnum.
works together with the library.
Note that it is possible for a library to be covered by the ordinary
General Public License rather than by this special one.
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION
- AND MODIFICATION
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
+ MODIFICATION
0. This License Agreement applies to any software
library which contains a notice placed by the copyright holder or other
authorized party saying it may be distributed under the terms of this
@@ -1226,7 +1511,7 @@ mxmlIndexEnum.
or any portion of it, thus forming a work based on the Library, and
copy and distribute such modifications or work under the terms of
Section 1 above, provided that you also meet all of these conditions:
-
+
a) The modified work must itself be a software
library.
b) You must cause the files modified to carry
@@ -1248,7 +1533,7 @@ mxmlIndexEnum.
function or table used by this function must be optional: if the
application does not supply it, the square root function must still
compute square roots.)
-
+
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
@@ -1330,7 +1615,7 @@ mxmlIndexEnum.
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
- a) Accompany the work with the complete
+ a) Accompany the work with the complete
corresponding machine-readable source code for the Library including
whatever changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked with
@@ -1350,7 +1635,7 @@ mxmlIndexEnum.
the above specified materials from the same place.
d) Verify that the user has already received a copy
of these materials or that you have already sent this user a copy.
-
+
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
@@ -1370,15 +1655,15 @@ mxmlIndexEnum.
such a combined library, provided that the separate distribution of the
work based on the Library and of the other library facilities is
otherwise permitted, and provided that you do these two things:
- a) Accompany the combined library with a
- copy of the same work based on the Library, uncombined with any other
- library facilities. This must be distributed under the terms of the
- Sections above.
+ a) Accompany the combined library with a copy of
+ the same work based on the Library, uncombined with any other library
+ facilities. This must be distributed under the terms of the Sections
+ above.
b) Give prominent notice with the combined library
of the fact that part of it is a work based on the Library, and
explaining where to find the accompanying uncombined form of the same
work.
-
+
8. You may not copy, modify, sublicense, link with,
or distribute the Library except as expressly provided under this
License. Any attempt otherwise to copy, modify, sublicense, link with,
@@ -1455,7 +1740,7 @@ mxmlIndexEnum.
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
-NO WARRANTY
+NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE,
THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
@@ -1475,8 +1760,8 @@ mxmlIndexEnum.
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
-END OF TERMS AND CONDITIONS
-How to Apply These Terms to Your New Libraries
+END OF TERMS AND CONDITIONS
+How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
@@ -1487,82 +1772,81 @@ mxmlIndexEnum.
effectively convey the exclusion of warranty; and each file should have
at least the "copyright" line and a pointer to where the full notice is
found.
-
-one line to give the library's name and an idea of what it does.
-Copyright (C) year name of author
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Lesser General Public License for more details.
-
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
+
+one line to give the library's name and an idea of what it does.
+
Copyright (C) year name of author
+This library is free software; you can redistribute it and/or modify
+ it under the terms of the GNU Lesser General Public License as
+ published by the Free Software Foundation; either version 2.1 of the
+ License, or (at your option) any later version.
+This library is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
+ General Public License for more details.
+You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
Also add information on how to contact you by electronic and paper
mail.
You should also get your employer (if you work as a programmer) or
your school, if any, to sign a "copyright disclaimer" for the library,
if necessary. Here is a sample; alter the names:
-
-Yoyodyne, Inc., hereby disclaims all copyright interest in
-the library `Frob' (a library for tweaking knobs) written
-by James Random Hacker.
-
-signature of Ty Coon, 1 April 1990
-Ty Coon, President of Vice
-
+
+Yoyodyne, Inc., hereby disclaims all copyright interest in the
+ library `Frob' (a library for tweaking knobs) written by James Random
+ Hacker.
+signature of Ty Coon, 1 April 1990 Ty Coon, President of
+ Vice
+
That's all there is to it!
-B - Release Notes
-Changes in Mini-XML 2.3
+
Release Notes
+Changes in Mini-XML 2.3
- Added two exceptions to the LGPL to support static linking of
- applications against Mini-XML.
-- Added mxmlElementSetAttrf() function (STR #43)
-- Added snprintf() emulation function for test program (STR #32)
+ applications against Mini-XML
+- The mxmldoc utility can now generate man pages, too.
+- Added a mxmlNewXML() function
+- Added a mxmlElementSetAttrf() function (STR #43)
+- Added a snprintf() emulation function for the test program (STR #32)
- Added the _CRT_SECURE_NO_DEPRECATE definition when building on VC++
2005 (STR #36)
- mxmlLoad*() did not detect missing > characters in elements (STR
#41)
- mxmlLoad*() did not detect missing close tags at the end of an XML
document (STR #45)
-- Added user_data and ref_count members to mxml_node_t structure.
+- Added user_data and ref_count members to mxml_node_t structure
- Added mxmlReleaseNode() and mxmlRetainNode() APIs for
- reference-counted nodes.
-- Added mxmlSetWrapMargin() to control the wrapping of XML output.
+ reference-counted nodes
+- Added mxmlSetWrapMargin() to control the wrapping of XML output
- Added conditional check for EINTR error code for certain Windows
compilers that do not define it (STR #33)
-- The mxmldoc program now generates correct HTML 4.0 output
- (previously it generated invalid XHTML...)
+- The mxmldoc program now generates correct HTML 4.0 output -
+ previously it generated invalid XHTML
- The mxmldoc program now supports "@deprecated@, "@private@", and
- "@since version@" comments.
-- Fixed function and enumeraion type bugs in mxmldoc.
-- Fixed XML schema for mxmldoc.
+ "@since version@" comments
+- Fixed function and enumeration type bugs in mxmldoc
+- Fixed the XML schema for mxmldoc
- The mxmldoc program now supports --intro, --section, and --title
- options.
+ options
- The mxmlLoad*() functions could leak a node on an error (STR #27)
- The mxml_vsnprintf() function could get in an infinite loop on a
buffer overflow (STR #25)
- Added new mxmlNewCDATA() and mxmlSetCDATA() functions to create and
- set CDATA nodes, which are really just special element nodes.
+ set CDATA nodes, which are really just special element nodes
- Added new MXML_IGNORE type and MXML_IGNORE_CB callback to ignore
- non-element nodes (i.e. whitespace)
+ non-element nodes, e.g. whitespace
- mxmlLoad*() did not treat custom data as opaque, so whitespace
- characters would be lost.
+ characters would be lost
-Changes in Mini-XML 2.2.2
+Changes in Mini-XML 2.2.2
- mxmlLoad*() did not treat custom data as opaque, so whitespace
characters would be lost.
-Changes in Mini-XML 2.2.1
+Changes in Mini-XML 2.2.1
- mxmlLoadFd(), mxmlLoadFile(), and mxmlLoadString() now correctly
return NULL on error (STR #21)
@@ -1573,7 +1857,7 @@ Ty Coon, President of Vice
proper permissions on UNIX/Linux/OSX.
- Fixed a MingW/Cygwin compilation problem (STR #18)
-Changes in Mini-XML 2.2
+Changes in Mini-XML 2.2
- Added shared library support (STR #17)
- mxmlLoad*() now returns an error when an XML stream contains illegal
@@ -1587,7 +1871,7 @@ Ty Coon, President of Vice
- Added checking for invalid comment termination ("--->" is not
allowed)
-Changes in Mini-XML 2.1
+Changes in Mini-XML 2.1
- Added support for custom data nodes (STR #6)
- Now treat UTF-8 sequences which are longer than necessary as an
@@ -1598,7 +1882,7 @@ Ty Coon, President of Vice
- Added mxmlLoadFd() and mxmlSaveFd() functions.
- Fixed multi-word UTF-16 handling.
-Changes in Mini-XML 2.0
+Changes in Mini-XML 2.0
- New programmers manual.
- Added Visual C++ project files for Microsoft Windows users.
@@ -1631,7 +1915,7 @@ Ty Coon, President of Vice
destination path and install path. This caused problems when building
and installing with MingW.
-Changes in Mini-XML 1.3
+Changes in Mini-XML 1.3
- Fixes for mxmldoc.
- Added support for reading standard HTML entity names.
@@ -1647,7 +1931,7 @@ Ty Coon, President of Vice
- The load and save functions now properly handle quoted element and
attribute name strings properly, e.g. for !DOCTYPE declarations.
-Changes in Mini-XML 1.2
+Changes in Mini-XML 1.2
- Added new "set" methods to set the value of a node.
- Added new formatted text methods mxmlNewTextf() and mxmlSetTextf()
@@ -1660,13 +1944,13 @@ Ty Coon, President of Vice
- Added --with/without-snprintf configure option to control the
snprintf() and vsnprintf() function checks.
-Changes in Mini-XML 1.1.2
+Changes in Mini-XML 1.1.2
- The mxml(3) man page wasn't updated for the string functions.
- mxmlSaveString() returned the wrong number of characters.
- mxml_add_char() updated the buffer pointer in the wrong place.
-Changes in Mini-XML 1.1.1
+Changes in Mini-XML 1.1.1
- The private mxml_add_ch() function did not update the
start-of-buffer pointer which could cause a crash when using
@@ -1677,7 +1961,7 @@ Ty Coon, President of Vice
- Added a mxmlSaveAllocString() convenience function for saving an XML
node tree to an allocated string.
-Changes in Mini-XML 1.1
+Changes in Mini-XML 1.1
- The mxmlLoadFile() function now uses dynamically allocated string
buffers for element names, attribute names, and attribute values.
@@ -1689,7 +1973,7 @@ Ty Coon, President of Vice
- Add emulation of strdup() if the local platform does not provide the
function.
-Changes in Mini-XML 1.0
+Changes in Mini-XML 1.0
- The mxmldoc program now handles function arguments, structures,
unions, enumerations, classes, and typedefs properly.
@@ -1697,7 +1981,7 @@ Ty Coon, President of Vice
code.
- Added man pages and packaging files.
-Changes in Mini-XML 0.93
+Changes in Mini-XML 0.93
- New mxmldoc example program that is also used to create and update
code documentation using XML and produce HTML reference pages.
@@ -1722,21 +2006,22 @@ Ty Coon, President of Vice
- mxmlSaveFile() now supports a whitespace callback to provide more
human-readable XML output under program control.
-Changes in Mini-XML 0.92
+Changes in Mini-XML 0.92
- mxmlSaveFile() didn't return a value on success.
-Changes in Mini-XML 0.91
+Changes in Mini-XML 0.91
- mxmlWalkNext() would go into an infinite loop.
-Changes in Mini-XML 0.9
+Changes in Mini-XML 0.9
- Initial public release.
-C - Library Reference
-Contents
+
Library Reference
+Contents
- Enumerations
- Functions
@@ -1748,16 +2033,35 @@ Ty Coon, President of Vice
Enumerations
+
+mxml_sax_event_e
+Description
+SAX event type.
+Values
+
+
+Name Description MXML_SAX_CDATA CDATA node MXML_SAX_COMMENT Comment node MXML_SAX_DATA Data node MXML_SAX_DIRECTIVE Processing directive node
+MXML_SAX_ELEMENT_CLOSE Element closed MXML_SAX_ELEMENT_OPEN Element opened
+
mxml_type_e
Description
The XML node type.
Values
-
+
Name Description MXML_CUSTOM
@@ -1780,7 +2084,9 @@ Ty Coon, President of Vice
- mxmlDelete()
- mxmlElementGetAttr()
- mxmlElementSetAttr()
-- mxmlElementSetAttrf()
+- mxmlElementSetAttrf()
+
+ Mini-XML 2.3
- mxmlEntityAddCallback()
- mxmlEntityGetName()
@@ -1808,11 +2114,23 @@ Ty Coon, President of Vice
- mxmlNewReal()
- mxmlNewText()
- mxmlNewTextf()
+- mxmlNewXML()
+
+ Mini-XML 2.3
- mxmlRelease()
Mini-XML 2.3
- mxmlRemove()
- mxmlRetain()
+
+ Mini-XML 2.3
+- mxmlSAXLoadFd()
+
+ Mini-XML 2.3
+- mxmlSAXLoadFile()
+
+ Mini-XML 2.3
+- mxmlSAXLoadString()
Mini-XML 2.3
- mxmlSaveAllocString()
@@ -1844,26 +2162,22 @@ Ty Coon, President of Vice
mxmlAdd()
Description
-Add a node to a tree. Adds the specified node to the parent. If the
- child argument is not NULL, puts the new node before or after the
- specified child depending on the value of the where argument. If the
- child argument is NULL, puts the new node at the beginning of the child
- list (MXML_ADD_BEFORE) or at the end of the child list
- (MXML_ADD_AFTER). The constant MXML_ADD_TO_PARENT can be used to
- specify a NULL child pointer.
+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.
Syntax
-
-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);
Arguments
-
-
+
Name Description parent Parent node mxmlDelete()
Description
-Delete a node and all of its children. If the specified node has a
- parent, this function first removes the node from its parent using the
- mxmlRemove() function.
+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.
Syntax
-
-void
-mxmlDelete(
- mxml_node_t * node);
-
+ void
+
mxmlDelete( mxml_node_t * node);
Arguments
-
-
+
Name Description node Node to delete mxmlElementGetAttr()
Description
-Get an attribute. This function returns NULL if the node is not an
- element or the named attribute does not exist.
+Get an attribute.
+This function returns NULL if the node is not an element or the named
+ attribute does not exist.
Syntax
-
-const char *
-mxmlElementGetAttr(
- mxml_node_t * node,
- const char * name);
-
+ const char *
+
mxmlElementGetAttr( mxml_node_t * node,
+ const char * name);
Arguments
-
-
+
Name Description node Element node mxmlElementSetAttr()
Description
-Set an attribute. If the named attribute already exists, the value of
- the attribute is replaced by the new string value. The string value is
- copied into the element node. This function does nothing if the node is
- not an element.
+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.
Syntax
-
-void
-mxmlElementSetAttr(
- mxml_node_t * node,
- const char * name,
- const char * value);
-
+ void
+
mxmlElementSetAttr( mxml_node_t * node,
+ const char * name, const char * value);
Arguments
-
-
+
Name Description node Element node Nothing.
-mxmlElementSetAttrf()
+
+
+ Mini-XML 2.3 mxmlElementSetAttrf()
Description
-
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.
+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.
Syntax
-
-void
-mxmlElementSetAttrf(
- mxml_node_t * node,
- const char * name,
- const char * format,
- ...);
-
+ void
+
mxmlElementSetAttrf( mxml_node_t * node,
+ const char * name, const char * format, ...);
Arguments
-
-
+
Name Description node Element node Description
Add a callback to convert entities to Unicode.
Syntax
-
-int
-mxmlEntityAddCallback(void);
-
+ int
+
mxmlEntityAddCallback(void);
Arguments
None.
Returns
@@ -2005,18 +2306,16 @@ mxmlEntityAddCallback(void);
mxmlEntityGetName()
Description
-Get the name that corresponds to the character value. If val does not
- need to be represented by a named entity, NULL is returned.
+Get the name that corresponds to the character value.
+If val does not need to be represented by a named entity, NULL is
+ returned.
Syntax
-
-const char *
-mxmlEntityGetName(
- int val);
-
+ const char *
+
mxmlEntityGetName( int val);
Arguments
-
-
+
Name Description val Character value mxmlEntityGetValue()
Description
-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.
+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.
Syntax
-
-int
-mxmlEntityGetValue(
- const char * name);
-
+ int
+
mxmlEntityGetValue( const char * name);
Arguments
-
-
+
Name Description name Entity name Description
Remove a callback.
Syntax
-
-void
-mxmlEntityRemoveCallback(void);
-
+ void
+
mxmlEntityRemoveCallback(void);
Arguments
None.
Returns
@@ -2067,30 +2361,24 @@ mxmlEntityRemoveCallback(void);
mxmlFindElement()
Description
-Find the named element. The search is constrained by the name,
- attribute name, and value; any NULL names or values are treated as
- wildcards, so different kinds of searches can be implemented by looking
- for all elements of a given name or all elements with a specific
- attribute. The descend argument determines whether the search descends
- into child nodes; normally you will use MXML_DESCEND_FIRST for the
- initial search and MXML_NO_DESCEND to find additional direct
- descendents of the node. The top node argument constrains the search to
- a particular node's children.
+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.
Syntax
-
-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);
Arguments
-
-
+
Name Description node Current node Description
Delete an index.
Syntax
-
-void
-mxmlIndexDelete(
- mxml_index_t * ind);
-
+ void
+
mxmlIndexDelete( mxml_index_t * ind);
+
Arguments
-
-
+
Name Description ind Index to delete mxmlIndexEnum()
Description
-Return the next node in the index. Nodes are returned in the sorted
- order of the index.
+Return the next node in the index.
+Nodes are returned in the sorted order of the index.
Syntax
-
-mxml_node_t *
-mxmlIndexEnum(
- mxml_index_t * ind);
-
+ mxml_node_t *
+
mxmlIndexEnum( mxml_index_t * ind);
+
Arguments
-
-
+
Name Description ind Index to enumerate mxmlIndexFind()
Description
-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().
+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().
Syntax
-
-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);
Arguments
-
-
+
Name Description ind Index to search mxmlIndexNew()
Description
-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.
+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.
Syntax
-
-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);
Arguments
-
-
+
Name Description node XML node tree mxmlIndexReset()
Description
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.
+ node in the index.
+This function should be called prior to using mxmlIndexEnum() or
+ mxmlIndexFind() for the first time.
Syntax
-
-mxml_node_t *
-mxmlIndexReset(
- mxml_index_t * ind);
-
+ mxml_node_t *
+
mxmlIndexReset( mxml_index_t * ind);
+
Arguments
-
-
+
Name Description ind Index to reset mxmlLoadFd()
Description
-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,
+
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.
Syntax
-
-mxml_node_t *
-mxmlLoadFd(
- mxml_node_t * top,
- int fd);
-
+ mxml_node_t *
+
mxmlLoadFd( mxml_node_t * top, int fd, mxml_load_cb_t cb);
Arguments
-
-
+
Name Description top Top node fd File descriptor to read from cb Callback function or MXML_NO_CALLBACK
Returns
@@ -2268,30 +2544,29 @@ mxmlLoadFd(
mxmlLoadFile()
Description
-Load a file into an XML node tree. The nodes in the specified file
- are added to the specified top node. If no top node is provided, the
- XML file MUST be well-formed with a single parent node like <?xml> for
- the entire file. The callback function returns the value type that
- should be used for child nodes. If MXML_NO_CALLBACK is specified then
- all child nodes will be either MXML_ELEMENT or MXML_TEXT nodes. The
- constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
+
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.
Syntax
-
-mxml_node_t *
-mxmlLoadFile(
- mxml_node_t * top,
- FILE * fp);
-
+ mxml_node_t *
+
mxmlLoadFile( mxml_node_t * top, FILE *
+ fp, mxml_load_cb_t cb);
Arguments
-
-
+
Name Description top Top node fp File to read from cb Callback function or MXML_NO_CALLBACK
Returns
@@ -2300,56 +2575,52 @@ mxmlLoadFile(
mxmlLoadString()
Description
-Load a string into an XML node tree. The nodes in the specified
- string are added to the specified top node. If no top node is provided,
- the XML string MUST be well-formed with a single parent node like
- <?xml> for the entire string. The callback function returns the value
- type that should be used for child nodes. If MXML_NO_CALLBACK is
- specified then all child nodes will be either MXML_ELEMENT or MXML_TEXT
- nodes. The constants MXML_INTEGER_CALLBACK, MXML_OPAQUE_CALLBACK,
+
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.
Syntax
-
-mxml_node_t *
-mxmlLoadString(
- mxml_node_t * top,
- const char * s);
-
+ mxml_node_t *
+
mxmlLoadString( mxml_node_t * top, const
+ char * s, mxml_load_cb_t cb);
Arguments
-
-
+
Name Description top Top node s String to load cb Callback function or MXML_NO_CALLBACK
Returns
First node or NULL if the string has errors.
-
+
Mini-XML 2.3 mxmlNewCDATA()
Description
-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.
+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.
Syntax
-
-mxml_node_t *
-mxmlNewCDATA(
- mxml_node_t * parent,
- const char * data);
-
+ mxml_node_t *
+
mxmlNewCDATA( mxml_node_t * parent,
+ const char * data);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT New node
-
+
Mini-XML 2.1 mxmlNewCustom()
Description
-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.
+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.
Syntax
-
-mxml_node_t *
-mxmlNewCustom(
- mxml_node_t * parent,
- void * data);
-
+ mxml_node_t *
+
mxmlNewCustom( mxml_node_t * parent,
+ void * data,
+mxml_custom_destroy_cb_t destroy);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT data Pointer to data destroy Function to destroy data
Returns
@@ -2392,20 +2662,18 @@ mxmlNewCustom(
mxmlNewElement()
Description
-Create a new element node. The new element node is added to the end
- of the specified parent's child list. The constant MXML_NO_PARENT can
- be used to specify that the new element node has no parent.
+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.
Syntax
-
-mxml_node_t *
-mxmlNewElement(
- mxml_node_t * parent,
- const char * name);
-
+ mxml_node_t *
+
mxmlNewElement( mxml_node_t * parent,
+ const char * name);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT mxmlNewInteger()
Description
-Create a new integer node. The new integer node is added to the end
- of the specified parent's child list. The constant MXML_NO_PARENT can
- be used to specify that the new integer node has no parent.
+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.
Syntax
-
-mxml_node_t *
-mxmlNewInteger(
- mxml_node_t * parent,
- int integer);
-
+ mxml_node_t *
+
mxmlNewInteger( mxml_node_t * parent,
+ int integer);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT mxmlNewOpaque()
Description
-Create a new opaque string. The new opaque node is added to the end
- of the specified parent's child list. The constant MXML_NO_PARENT can
- be used to specify that the new opaque node has no parent. The opaque
- string must be nul-terminated and is copied into the new node.
+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.
Syntax
-
-mxml_node_t *
-mxmlNewOpaque(
- mxml_node_t * parent,
- const char * opaque);
-
+ mxml_node_t *
+
mxmlNewOpaque( mxml_node_t * parent,
+ const char * opaque);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT mxmlNewReal()
Description
-Create a new real number node. The new real number node is added to
- the end of the specified parent's child list. The constant
- MXML_NO_PARENT can be used to specify that the new real number node has
- no parent.
+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.
Syntax
-
-mxml_node_t *
-mxmlNewReal(
- mxml_node_t * parent,
- double real);
-
+ mxml_node_t *
+
mxmlNewReal( mxml_node_t * parent,
+ double real);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT mxmlNewText()
Description
-Create a new text fragment node. The new text node is added to the
- end of the specified parent's child list. The constant MXML_NO_PARENT
- can be used to specify that the new text node has no parent. The
- whitespace parameter is used to specify whether leading whitespace is
- present before the node. The text string must be nul-terminated and is
- copied into the new node.
+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.
Syntax
-
-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);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT mxmlNewTextf()
Description
-Create a new formatted text fragment node. The new text node is added
- to the end of the specified parent's child list. The constant
- MXML_NO_PARENT can be used to specify that the new text node has no
- parent. The whitespace parameter is used to specify whether leading
- whitespace is present before the node. The format string must be
- nul-terminated and is formatted into the new node.
+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.
Syntax
-
-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, ...);
Arguments
-
-
+
Name Description parent Parent node or MXML_NO_PARENT New node
-
+
+
+ Mini-XML 2.3 mxmlNewXML()
+Description
+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.
+Syntax
+ mxml_node_t *
+
mxmlNewXML( const char * version);
+Arguments
+
+
+Name Description version Version number to use
+
+Returns
+New ?xml node
+
+
+
Mini-XML 2.3 mxmlRelease()
Description
-Release a node. When the reference count reaches zero, the node (and
- any children) is deleted via mxmlDelete().
+Release a node.
+When the reference count reaches zero, the node (and any children) is
+ deleted via mxmlDelete().
Syntax
-
-int
-mxmlRelease(
- mxml_node_t * node);
-
+ int
+
mxmlRelease( mxml_node_t * node);
Arguments
-
-
+
Name Description node Node mxmlRemove()
Description
-Remove a node from its parent. Does not free memory used by the node
- - use mxmlDelete() for that. This function does nothing if the node has
- no parent.
+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.
Syntax
-
-void
-mxmlRemove(
- mxml_node_t * node);
-
+ void
+
mxmlRemove( mxml_node_t * node);
Arguments
-
-
+
Name Description node Node to remove Nothing.
-
+
Mini-XML 2.3 mxmlRetain()
Description
Retain a node.
Syntax
-
-int
-mxmlRetain(
- mxml_node_t * node);
-
+ int
+
mxmlRetain( mxml_node_t * node);
Arguments
-
-
+
Name Description node Node Returns
New reference count
+
+
+
+ Mini-XML 2.3 mxmlSAXLoadFd()
+Description
+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.
+Syntax
+ mxml_node_t *
+
mxmlSAXLoadFd( mxml_node_t * top, int
+ fd, mxml_load_cb_t cb,
+mxml_sax_cb_t sax_cb, void * sax_data);
+Arguments
+
+
+Name Description top Top node fd File descriptor to read from cb Callback function or MXML_NO_CALLBACK sax_cb SAX callback or MXML_NO_CALLBACK sax_data SAX user data
+
+Returns
+First node or NULL if the file could not be read.
+
+
+
+
+ Mini-XML 2.3 mxmlSAXLoadFile()
+Description
+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.
+Syntax
+ mxml_node_t *
+
mxmlSAXLoadFile( mxml_node_t * top, FILE
+ * fp, mxml_load_cb_t cb,
+mxml_sax_cb_t sax_cb, void * sax_data);
+Arguments
+
+
+Name Description top Top node fp File to read from cb Callback function or MXML_NO_CALLBACK sax_cb SAX callback or MXML_NO_CALLBACK sax_data SAX user data
+
+Returns
+First node or NULL if the file could not be read.
+
+
+
+
+ Mini-XML 2.3 mxmlSAXLoadString()
+Description
+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.
+Syntax
+ 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);
+Arguments
+
+
+Name Description top Top node s String to load cb Callback function or MXML_NO_CALLBACK sax_cb SAX callback or MXML_NO_CALLBACK sax_data SAX user data
+
+Returns
+First node or NULL if the string has errors.
+
mxmlSaveAllocString()
Description
-Save an XML node tree to an allocated string. This function returns a
- pointer to a string containing the textual representation of the XML
- node tree. The string should be freed using the free() function when
- you are done with it. NULL is returned if the node would produce an
- empty string or if the string cannot be allocated. 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 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.
Syntax
-
-char *
-mxmlSaveAllocString(
- mxml_node_t * node);
-
+ char *
+
mxmlSaveAllocString( mxml_node_t * node,
+ mxml_save_cb_t cb);
Arguments
-
-
+
Name Description node Node to write cb Whitespace callback or MXML_NO_CALLBACK
Returns
@@ -2668,26 +3053,25 @@ mxmlSaveAllocString(
mxmlSaveFd()
Description
-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.
+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.
Syntax
-
-int
-mxmlSaveFd(
- mxml_node_t * node,
- int fd);
-
+ int
+
mxmlSaveFd( mxml_node_t * node, int fd, mxml_save_cb_t cb);
Arguments
-
-
+
Name Description node Node to write fd File descriptor to write to cb Whitespace callback or MXML_NO_CALLBACK
Returns
@@ -2696,26 +3080,25 @@ mxmlSaveFd(
mxmlSaveFile()
Description
-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.
+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.
Syntax
-
-int
-mxmlSaveFile(
- mxml_node_t * node,
- FILE * fp);
-
+ int
+
mxmlSaveFile( mxml_node_t * node, FILE *
+ fp, mxml_save_cb_t cb);
Arguments
-
-
+
Name Description node Node to write fp File to write to cb Whitespace callback or MXML_NO_CALLBACK
Returns
@@ -2724,53 +3107,50 @@ mxmlSaveFile(
mxmlSaveString()
Description
-Save an XML node tree to a string. This function returns the total
- number of bytes that would be required for the string but only copies
- (bufsize - 1) characters into the specified buffer. 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.
+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.
Syntax
-
-int
-mxmlSaveString(
- mxml_node_t * node,
- char * buffer,
- int bufsize);
-
+ int
+
mxmlSaveString( mxml_node_t * node, char
+ * buffer, int bufsize, mxml_save_cb_t
+ cb);
Arguments
-
-
+
Name Description node Node to write buffer String buffer bufsize Size of string buffer cb Whitespace callback or MXML_NO_CALLBACK
Returns
Size of string
-
+
Mini-XML 2.3 mxmlSetCDATA()
Description
-Set the element name of a CDATA node. The node is not changed if it
- is not a CDATA element node.
+Set the element name of a CDATA node.
+The node is not changed if it is not a CDATA element node.
Syntax
-
-int
-mxmlSetCDATA(
- mxml_node_t * node,
- const char * data);
-
+ int
+
mxmlSetCDATA( mxml_node_t * node, const
+ char * data);
Arguments
-
-
+
Name Description node Node to set 0 on success, -1 on failure
-
+
Mini-XML 2.1 mxmlSetCustom()
Description
-Set the data and destructor of a custom data node. The node is not
- changed if it is not a custom node.
+Set the data and destructor of a custom data node.
+The node is not changed if it is not a custom node.
Syntax
-
-int
-mxmlSetCustom(
- mxml_node_t * node,
- void * data);
-
+ int
+
mxmlSetCustom( mxml_node_t * node, void
+ * data, mxml_custom_destroy_cb_t
+ destroy);
Arguments
-
-
+
Name Description node Node to set data New data pointer destroy New destructor function
Returns
@@ -2811,21 +3190,20 @@ mxmlSetCustom(
mxmlSetCustomHandlers()
Description
-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 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.
Syntax
-
-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);
Arguments
-
-
+
Name Description load Load function mxmlSetElement()
Description
-Set the name of an element node. The node is not changed if it is not
- an element node.
+Set the name of an element node.
+The node is not changed if it is not an element node.
Syntax
-
-int
-mxmlSetElement(
- mxml_node_t * node,
- const char * name);
-
+ int
+
mxmlSetElement( mxml_node_t * node,
+ const char * name);
Arguments
-
-
+
Name Description node Node to set Description
Set the error message callback.
Syntax
-
-void
-mxmlSetErrorCallback(void);
-
+ void
+
mxmlSetErrorCallback( mxml_error_cb_t
+ cb);
Arguments
-None.
+
+
+Name Description cb Error callback function
+
Returns
Nothing.
mxmlSetInteger()
Description
-Set the value of an integer node. The node is not changed if it is
- not an integer node.
+Set the value of an integer node.
+The node is not changed if it is not an integer node.
Syntax
-
-int
-mxmlSetInteger(
- mxml_node_t * node,
- int integer);
-
+ int
+
mxmlSetInteger( mxml_node_t * node, int
+ integer);
Arguments
-
-
+
Name Description node Node to set mxmlSetOpaque()
Description
-Set the value of an opaque node. The node is not changed if it is not
- an opaque node.
+Set the value of an opaque node.
+The node is not changed if it is not an opaque node.
Syntax
-
-int
-mxmlSetOpaque(
- mxml_node_t * node,
- const char * opaque);
-
+ int
+
mxmlSetOpaque( mxml_node_t * node, const
+ char * opaque);
Arguments
-
-
+
Name Description node Node to set mxmlSetReal()
Description
-Set the value of a real number node. The node is not changed if it is
- not a real number node.
+Set the value of a real number node.
+The node is not changed if it is not a real number node.
Syntax
-
-int
-mxmlSetReal(
- mxml_node_t * node,
- double real);
-
+ int
+
mxmlSetReal( mxml_node_t * node, double
+ real);
Arguments
-
-
+
Name Description node Node to set mxmlSetText()
Description
-Set the value of a text node. The node is not changed if it is not a
- text node.
+Set the value of a text node.
+The node is not changed if it is not a text node.
Syntax
-
-int
-mxmlSetText(
- mxml_node_t * node,
- int whitespace,
- const char * string);
-
+ int
+
mxmlSetText( mxml_node_t * node, int
+ whitespace, const char * string);
Arguments
-
-
+
Name Description node Node to set mxmlSetTextf()
Description
-Set the value of a text node to a formatted string. The node is not
- changed if it is not a text node.
+Set the value of a text node to a formatted string.
+The node is not changed if it is not a text node.
Syntax
-
-int
-mxmlSetTextf(
- mxml_node_t * node,
- int whitespace,
- const char * format,
- ...);
-
+ int
+
mxmlSetTextf( mxml_node_t * node, int
+ whitespace, const char * format, ...);
Arguments
-
-
+
Name Description node Node to set 0 on success, -1 on failure
-
+
Mini-XML 2.3 mxmlSetWrapMargin()
Description
-Set the the wrap margin when saving XML data. Wrapping is disabled
- when "column" is <= 0.
+Set the the wrap margin when saving XML data.
+Wrapping is disabled when "column" is <= 0.
Syntax
-
-void
-mxmlSetWrapMargin(
- int column);
-
+ void
+
mxmlSetWrapMargin( int column);
Arguments
-
-
+
Name Description column Column for wrapping mxmlWalkNext()
Description
-Walk to the next logical node in the tree. The descend argument
- controls whether the first child is considered to be the next node. The
- top node argument constrains the walk to the node's children.
+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.
Syntax
-
-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);
Arguments
-
-
+
Name Description node Current node mxmlWalkPrev()
Description
-Walk to the previous logical node in the tree. The descend argument
- controls whether the previous node's last child is considered to be the
- previous node. The top node argument constrains the walk to the node's
- children.
+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.
Syntax
-
-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);
Arguments
-
-
+
Name Description node Current node Description
Data types...
Definition
-
-struct mxml_attr_s
-{
- char * name;
- char * value;
-};
-
+ struct mxml_attr_s
+
{
+
char * name;
+
char * value;
+
};
Members
-
+
Name Description name Attribute name
-
+
Mini-XML 2.1 mxml_custom_s
Description
An XML custom value.
Definition
-
-struct mxml_custom_s
-{
- void * data;
-};
-
+ struct mxml_custom_s
+
{
+
void * data;
+
mxml_custom_destroy_cb_t
+ destroy;
+
};
Members
-
+
Name Description data Pointer to (allocated) custom data destroy Pointer to destructor function
@@ -3152,17 +3504,15 @@ struct mxml_custom_s
Description
An XML element value.
Definition
-
-struct mxml_element_s
-{
- mxml_attr_t * attrs;
- char * name;
- int num_attrs;
-};
-
+ struct mxml_element_s
+
{
+
mxml_attr_t * attrs;
+
char * name;
+
int num_attrs;
+
};
Members
-
+
Name Description attrs Attributes Description
An XML node index.
Definition
-
-struct mxml_index_s
-{
- int alloc_nodes;
- char * attr;
- int cur_node;
- mxml_node_t ** nodes;
- int num_nodes;
-};
-
+ struct mxml_index_s
+
{
+
int alloc_nodes;
+
char * attr;
+
int cur_node;
+
mxml_node_t ** nodes;
+
int num_nodes;
+
};
Members
-
+
Name Description alloc_nodes Allocated nodes in index Description
An XML node.
Definition
-
-struct mxml_node_s
-{
- struct mxml_node_s * child;
- struct mxml_node_s * last_child;
- struct mxml_node_s * next;
- struct mxml_node_s * parent;
- struct mxml_node_s * prev;
- int ref_count;
- mxml_type_t type;
- void * user_data;
- mxml_value_t value;
-};
-
+ struct mxml_node_s
+
{
+
struct mxml_node_s * child;
+
struct mxml_node_s * last_child;
+
struct mxml_node_s * next;
+
struct mxml_node_s * parent;
+
struct mxml_node_s * prev;
+
int ref_count;
+
mxml_type_t type;
+
void * user_data;
+
mxml_value_t value;
+
};
Members
-
+
Name Description child First child node Description
An XML text value.
Definition
-
-struct mxml_text_s
-{
- char * string;
- int whitespace;
-};
-
+ struct mxml_text_s
+
{
+
char * string;
+
int whitespace;
+
};
Members
-
+
Name Description string Fragment string Types
- mxml_attr_t
+- mxml_custom_destroy_cb_t
+
- mxml_custom_load_cb_t
- mxml_custom_save_cb_t
- mxml_custom_t
Mini-XML 2.1
- mxml_element_t
+- mxml_error_cb_t
- mxml_index_t
+- mxml_load_cb_t
- mxml_node_t
+- mxml_save_cb_t
+- mxml_sax_cb_t
+- mxml_sax_event_t
- mxml_text_t
- mxml_value_t
@@ -3274,9 +3625,16 @@ struct mxml_text_s
Description
Data types...
Definition
-
-typedef struct mxml_attr_s mxml_attr_t;
-
+ typedef struct mxml_attr_s
+ mxml_attr_t;
+
+
+
+mxml_custom_destroy_cb_t
+Description
+Custom data destructor
+Definition
+ typedef void (*mxml_custom_destroy_cb_t)(void *);
mxml_custom_load_cb_t
@@ -3284,9 +3642,8 @@ typedef struct mxml_attr_s mxml_attr_t;
Description
Custom data load callback function
Definition
-
-typedef int (*mxml_custom_load_cb_t)(mxml_node_t *, const char *);
-
+ typedef int (*mxml_custom_load_cb_t)(
+mxml_node_t *, const char *);
mxml_custom_save_cb_t
@@ -3294,65 +3651,97 @@ typedef int (*mxml_custom_load_cb_t)(mxml_node_t *, c
Description
Custom data save callback function
Definition
-
-typedef char * (*mxml_custom_save_cb_t)(mxml_node_t *);
-
+ typedef char * (*mxml_custom_save_cb_t)(
+mxml_node_t *);
-
+
Mini-XML 2.1 mxml_custom_t
Description
An XML custom value.
Definition
-
-typedef struct mxml_custom_s mxml_custom_t;
-
+ typedef struct mxml_custom_s
+ mxml_custom_t;
mxml_element_t
Description
An XML element value.
Definition
-
-typedef struct mxml_element_s mxml_element_t;
-
+ typedef struct mxml_element_s
+ mxml_element_t;
+
+
+mxml_error_cb_t
+Description
+Error callback function
+Definition
+ typedef void (*mxml_error_cb_t)(const char *);
mxml_index_t
Description
An XML node index.
Definition
-
-typedef struct mxml_index_s mxml_index_t;
-
+ typedef struct mxml_index_s
+ mxml_index_t;
+
+
+mxml_load_cb_t
+Description
+Load callback function
+Definition
+ typedef mxml_type_t (*mxml_load_cb_t)(
+mxml_node_t *);
mxml_node_t
Description
An XML node.
Definition
-
-typedef struct mxml_node_s mxml_node_t;
-
+ typedef struct mxml_node_s
+ mxml_node_t;
+
+
+mxml_save_cb_t
+Description
+Save callback function
+Definition
+ typedef const char * (*mxml_save_cb_t)(
+mxml_node_t *, int);
+
+
+mxml_sax_cb_t
+Description
+SAX callback function
+Definition
+ typedef void (*mxml_sax_cb_t)(mxml_node_t
+ *, mxml_sax_event_t, void *);
+
+
+mxml_sax_event_t
+Description
+SAX event type.
+Definition
+ typedef enum mxml_sax_event_e
+ mxml_sax_event_t;
mxml_text_t
Description
An XML text value.
Definition
-
-typedef struct mxml_text_s mxml_text_t;
-
+ typedef struct mxml_text_s
+ mxml_text_t;
mxml_value_t
Description
An XML node value.
Definition
-
-typedef union mxml_value_u mxml_value_t;
-
+ typedef union mxml_value_u
+ mxml_value_t;
Unions
@@ -3365,20 +3754,18 @@ typedef union mxml_value_u mxml_value_t;
Description
An XML node value.
Definition
-
-union mxml_value_u
-{
- mxml_custom_t custom;
- mxml_element_t element;
- int integer;
- char * opaque;
- double real;
- mxml_text_t text;
-};
-
+ union mxml_value_u
+
{
+
mxml_custom_t custom;
+
mxml_element_t element;
+
int integer;
+
char * opaque;
+
double real;
+
mxml_text_t text;
+
};
Members
-
+
Name Description custom
diff --git a/doc/mxmldoc.html b/doc/mxmldoc.html
index 4bb3ad9..a7b686d 100644
--- a/doc/mxmldoc.html
+++ b/doc/mxmldoc.html
@@ -1,43 +1,192 @@
-4 - Using the mxmldoc
-Utility
+Using the mxmldoc
+Utility
+
+This chapter describes how to use mxmldoc(1) program to
+automatically generate documentation from C and C++ source
+files.
+
The Basics
Originally developed to generate the Mini-XML and CUPS API
-documentation, the mxmldoc(1) program converts C and C++
-source files into an intermediate XML format and uses in-line
-comments rather than comment headers to annotate functions, types,
-and constants.
+documentation, mxmldoc is now a general-purpose utility
+which scans C and C++ source files to produce HTML and man page
+documentation along with an XML file representing the functions,
+types, and definitions in those source files. Unlike popular
+documentation generators like Doxygen or Javadoc, mxmldoc
+uses in-line comments rather than comment headers, allowing for more
+"natural" code documentation.
+
+By default, mxmldoc produces HTML documentation. For
+example, the following command will scan all of the C source and
+header files in the current directory and produce a HTML
+documentation file called filename.html:
+
+
+ mxmldoc *.h *.c >filename.html ENTER
+
+
+You can also specify an XML file to create which contains all of
+the information from the source files. For example, the following
+command creates an XML file called filename.xml in
+addition to the HTML file:
+
+
+ mxmldoc filename.xml *.h *.c >filename.html ENTER
+
+
+The --no-output option disables the normal HTML
+output:
+
+
+ mxmldoc --no-output filename.xml *.h *.c ENTER
+
+
+You can then run mxmldoc again with the XML file alone
+to generate the HTML documentation:
-
+
+ mxmldoc filename.xml >filename.html ENTER
+
+The --man filename option tells mxmldoc to
+create a man page instead of HTML documentation, for example:
+
+ mxmldoc --man filename filename.xml \
+ >filename.man ENTER
+
+ mxmldoc --man filename *.h *.c \
+ >filename.man ENTER
+
+ mxmldoc --man filename filename.xml *.h *.c \
+ >filename.man ENTER
+
Commenting Your Code
-Creating HTML Documentation
+As noted previously, mxmldoc looks for in-line comments
+to describe the functions, types, and constants in your code.
+Mxmldoc 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.
+
+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 document that argument, definition, return type, or variable. For
+example, the following code excerpt defines a key/value structure
+and a function that creates a new instance of that structure:
+
+
+ /* A key/value pair. This is used with the
+ dictionary structure. */
+
+ struct keyval
+ {
+ char *key; /* Key string */
+ char *val; /* Value string */
+ };
+
+ /* Create a new key/value pair. */
+
+ struct keyval * /* New key/value pair */
+ new_keyval(
+ const char *key, /* Key string */
+ const char *val) /* Value string */
+ {
+ ...
+ }
+
+
+Mxmldoc also knows to remove extra asterisks (*) from
+the comment string, so the comment string:
+
+
+ /*
+ * Compute the value of PI.
+ *
+ * The function connects to an Internet server
+ * that streams audio of mathematical monks
+ * chanting the first 100 digits of PI.
+ */
+
+
+will be shown as:
+
+
+ Compute the value of PI.
+
+ The function connects to an Internet server
+ that streams audio of mathematical monks
+ chanting the first 100 digits of PI.
+
+
+Comments can also include the
+following special @name ...@ directive strings:
+
+
+
+ - @deprecated@ - flags the item as deprecated to
+ discourage its use
+
+ - @private@ - flags the item as private so it
+ will not be included in the documentation
+
+ - @since ...@ - flags the item as new since a
+ particular release. The text following the @since
+ up to the closing @ is highlighted in the generated
+ documentation, e.g. @since CUPS 1.3@.
+
+
+
+
+
+Titles, Sections, and Introductions
+
+Mxmldoc also provides options to set the title, section,
+and introduction text for the generated documentation. The
+--title text option specifies the title for the
+documentation. The title string is usually put in quotes:
+
+
+ mxmldoc filename.xml \
+ --title "My Famous Documentation" \
+ >filename.html ENTER
+
+
+The --section name option specifies the section for
+the documentation. For HTML documentation, the name is placed in
+a HTML comment such as:
+
+
+ <!-- SECTION: name -->
+
-Creating Man Pages
+For man pages, the section name is usually just a number ("3"),
+or a number followed by a vendor name ("3acme"). The section name is
+used in the .TH directive in the man page:
-The XML Schema
+
+ .TH mylibrary 3acme "My Title" ...
+
-mxmldoc scans the specified C and C++ source files to
-produce an XML representation of globally accessible classes,
-constants, enumerations, functions, structures, typedefs,
-unions, and variables. The XML file is updated as necessary and
-a HTML representation of the XML file is written to the standard
-output. If no source files are specified then the current XML
-file is converted to HTML on the standard output.
-
In general, any C or C++ source code is handled by
-mxmldoc, however it was specifically written to handle
-code with documentation that is formatted according to the CUPS
-Configuration Management Plan which is available at
-"http://www.cups.org/documentation.php".
+
The default section name for man page output is "3". There is no
+default section name for HTML output.
+Finally, the --intro filename option specifies a file to
+embed after the title and section but before the generated
+documentation. For HTML documentation, the file must consist of
+valid HTML without the usual DOCTYPE, html, and
+body elements. For man page documentation, the file must
+consist of valid nroff(1) text.
diff --git a/doc/refapp.html b/doc/refapp.html
index df478c8..111e99d 100644
--- a/doc/refapp.html
+++ b/doc/refapp.html
@@ -1,9 +1,11 @@
-C - Library Reference
+Library
+Reference
-
+ \n");
}