blob: cfcc402bf6e78b103a8f4a244ff4942f3445b22a [file] [log] [blame]
Daniel Veillard7b06bcb2001-06-22 16:03:51 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
Daniel Veillardccb09631998-10-27 06:21:04 +00003<html>
4<head>
Daniel Veillardec78c0f2000-08-25 10:25:23 +00005 <title>The XML C library for Gnome</title>
Daniel Veillard82687162001-01-22 15:32:01 +00006 <meta name="GENERATOR" content="amaya V4.1">
Daniel Veillardb24054a1999-12-18 15:32:46 +00007 <meta http-equiv="Content-Type" content="text/html">
Daniel Veillardccb09631998-10-27 06:21:04 +00008</head>
Daniel Veillardccb09631998-10-27 06:21:04 +00009
Daniel Veillardb05deb71999-08-10 19:04:08 +000010<body bgcolor="#ffffff">
Daniel Veillard60979bd2000-07-10 12:17:33 +000011<p><a href="http://www.gnome.org/"><img src="smallfootonly.gif"
12alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png"
Daniel Veillardb370a742001-06-09 16:58:47 +000013alt="W3C Logo"></a><a href="http://www.redhat.com"><img src="redhat.gif"
14alt="Red Hat Logo"></a></p>
Daniel Veillardec303412000-03-24 13:41:54 +000015
Daniel Veillardec78c0f2000-08-25 10:25:23 +000016<h1 align="center">The XML C library for Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +000017
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000018<h2 style="text-align: center">libxml, a.k.a. gnome-xml</h2>
19
20<p></p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000021<ul>
22 <li><a href="#Introducti">Introduction</a></li>
23 <li><a href="#Documentat">Documentation</a></li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +000024 <li><a href="#Reporting">Reporting bugs and getting help</a></li>
25 <li><a href="#help">how to help</a></li>
Daniel Veillard10a2c651999-12-12 13:03:50 +000026 <li><a href="#Downloads">Downloads</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000027 <li><a href="#News">News</a></li>
28 <li><a href="#XML">XML</a></li>
Daniel Veillard82687162001-01-22 15:32:01 +000029 <li><a href="#XSLT">XSLT</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000030 <li><a href="#tree">The tree output</a></li>
31 <li><a href="#interface">The SAX interface</a></li>
32 <li><a href="#library">The XML library interfaces</a>
33 <ul>
Daniel Veillard0142b842000-01-14 14:45:24 +000034 <li><a href="#Invoking">Invoking the parser: the pull way</a></li>
35 <li><a href="#Invoking">Invoking the parser: the push way</a></li>
36 <li><a href="#Invoking2">Invoking the parser: the SAX interface</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000037 <li><a href="#Building">Building a tree from scratch</a></li>
38 <li><a href="#Traversing">Traversing the tree</a></li>
39 <li><a href="#Modifying">Modifying the tree</a></li>
40 <li><a href="#Saving">Saving the tree</a></li>
41 <li><a href="#Compressio">Compression</a></li>
42 </ul>
43 </li>
44 <li><a href="#Entities">Entities or no entities</a></li>
45 <li><a href="#Namespaces">Namespaces</a></li>
46 <li><a href="#Validation">Validation</a></li>
47 <li><a href="#Principles">DOM principles</a></li>
48 <li><a href="#real">A real example</a></li>
Daniel Veillard96984452000-08-31 13:50:12 +000049 <li><a href="#Contributi">Contributions</a></li>
50</ul>
51
52<p>Separate documents:</p>
53<ul>
54 <li><a href="upgrade.html">upgrade instructions for migrating to
55 libxml2</a></li>
56 <li><a href="encoding.html">libxml Internationalization support</a></li>
57 <li><a href="xmlio.html">libxml Input/Output interfaces</a></li>
Daniel Veillard189446d2000-10-13 10:23:06 +000058 <li><a href="xmlmem.html">libxml Memory interfaces</a></li>
Daniel Veillard300f7d62000-11-24 13:04:04 +000059 <li><a href="xmldtd.html">a short introduction about DTDs and
60 libxml</a></li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +000061 <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a></li>
Daniel Veillard7b06bcb2001-06-22 16:03:51 +000062 <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page: a
63 standard DOM interface for libxml2</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000064</ul>
65
66<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000067
Daniel Veillardf13e1ed2000-03-06 07:41:49 +000068<p>This document describes libxml, the <a
Daniel Veillardec78c0f2000-08-25 10:25:23 +000069href="http://www.w3.org/XML/">XML</a> C library developped for the <a
70href="http://www.gnome.org/">Gnome</a> project. <a
71href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
72structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +000073
Daniel Veillard0142b842000-01-14 14:45:24 +000074<p>Here are some key points about libxml:</p>
75<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +000076 <li>Libxml exports Push and Pull type parser interfaces for both XML and
77 HTML.</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +000078 <li>Libxml can do DTD validation at parse time, using a parsed document
79 instance, or with an arbitrary DTD.</li>
80 <li>Libxml now includes nearly complete <a
Daniel Veillard189446d2000-10-13 10:23:06 +000081 href="http://www.w3.org/TR/xpath">XPath</a> and <a
Daniel Veillard0c069222000-10-21 09:25:52 +000082 href="http://www.w3.org/TR/xptr">XPointer</a> implementations.</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +000083 <li>It is written in plain C, making as few assumptions as possible, and
Daniel Veillard189446d2000-10-13 10:23:06 +000084 sticking closely to ANSI C/POSIX for easy embedding. Works on
Daniel Veillardab8500d2000-10-15 21:06:19 +000085 Linux/Unix/Windows, ported to a number of other platforms.</li>
Daniel Veillardec70e912001-02-26 20:10:45 +000086 <li>Basic support for HTTP and FTP client allowing aplications to fetch
87 remote resources</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +000088 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +000089 <li>The internal document repesentation is as close as possible to the <a
90 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
91 <li>Libxml also has a <a href="http://www.megginson.com/SAX/index.html">SAX
Daniel Veillard402e8c82000-02-29 22:57:47 +000092 like interface</a>; the interface is designed to be compatible with <a
93 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardec303412000-03-24 13:41:54 +000094 <li>This library is released both under the <a
95 href="http://www.w3.org/Consortium/Legal/copyright-software-19980720.html">W3C
Daniel Veillard189446d2000-10-13 10:23:06 +000096 IPR</a> and the <a href="http://www.gnu.org/copyleft/lesser.html">GNU
97 LGPL</a>. Use either at your convenience, basically this should make
98 everybody happy, if not, drop me a mail.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +000099</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000100
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000101<p>Warning: unless you are forced to because your application links with a
102Gnome library requiring it, <strong><span
103style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
104libxml2</p>
105
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000106<h2><a name="Documentat">Documentation</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000107
Daniel Veillard402e8c82000-02-29 22:57:47 +0000108<p>There are some on-line resources about using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000109<ol>
Daniel Veillard365e13b2000-07-02 07:56:37 +0000110 <li>Check the <a href="FAQ.html">FAQ</a></li>
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000111 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000112 documentation</a> automatically extracted from code comments (using <a
113 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gtk-doc">gtk
114 doc</a>).</li>
Daniel Veillard8d869642000-07-14 12:12:59 +0000115 <li>Look at the documentation about <a href="encoding.html">libxml
116 internationalization support</a></li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000117 <li>This page provides a global overview and <a href="#real">some
Daniel Veillard402e8c82000-02-29 22:57:47 +0000118 examples</a> on how to use libxml.</li>
119 <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
120 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
121 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000122 <li>George Lebl wrote <a
123 href="http://www-4.ibm.com/software/developer/library/gnome3/">an article
Daniel Veillard402e8c82000-02-29 22:57:47 +0000124 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000125 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
126 file</a></li>
127 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are
128 starting a new project using libxml you should really use the 2.x
129 version.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000130 <li>And don't forget to look at the <a href="/messages/">mailing-list
Daniel Veillardc310d562000-06-23 18:32:15 +0000131 archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000132</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000133
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000134<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000135
Daniel Veillard402e8c82000-02-29 22:57:47 +0000136<p>Well, bugs or missing features are always possible, and I will make a point
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000137of fixing them in a timely fashion. The best way to report a bug is to use the
Daniel Veillard81781102001-03-07 09:31:47 +0000138<a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome bug
139tracking database</a> (make sure to use the "libxml" module name). I look at
140reports there regularly and it's good to have a reminder when a bug is still
Daniel Veillarda41123c2001-04-22 19:31:20 +0000141open. Check the <a
142href="http://bugzilla.gnome.org/bugwritinghelp.html">instructions on reporting
143bugs</a> and be sure to specify that the bug is for the package libxml.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000144
Daniel Veillard0142b842000-01-14 14:45:24 +0000145<p>There is also a mailing-list <a
Daniel Veillard3197f162001-04-04 00:40:08 +0000146href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
147href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
148href="http://xmlsoft.org/messages">old</a>). To subscribe to this list, please
149visit the <a href="http://mail.gnome.org/mailman/listinfo/xml">associated
150Web</a> page and follow the instructions.</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000151
Daniel Veillard402e8c82000-02-29 22:57:47 +0000152<p>Alternatively, you can just send the bug to the <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000153href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
Daniel Veillard6e93c4a2001-06-05 20:57:42 +0000154related I will approve it.. Please do not send me mail directly especially for
155portability problem, it makes things really harder to track and in some cases
156I'm not the best person to answer a given question, ask the list instead.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000157
Daniel Veillard91e9d582001-02-26 07:31:12 +0000158<p>Of course, bugs reported with a suggested patch for fixing them will
Daniel Veillardec303412000-03-24 13:41:54 +0000159probably be processed faster.</p>
160
161<p>If you're looking for help, a quick look at <a
162href="http://xmlsoft.org/messages/#407">the list archive</a> may actually
163provide the answer, I usually send source samples when answering libxml usage
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000164questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated
Daniel Veillardec303412000-03-24 13:41:54 +0000165documentantion</a> is not as polished as I would like (i need to learn more
166about Docbook), but it's a good starting point.</p>
167
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000168<h2><a name="help">How to help</a></h2>
169
170<p>You can help the project in various ways, the best thing to do first is to
171subscribe to the mailing-list as explained before, check the <a
172href="http://xmlsoft.org/messages/">archives </a>and the <a
173href="http://bugs.gnome.org/db/pa/lgnome-xml.html">Gnome bug
174database:</a>:</p>
175<ol>
176 <li>provide patches when you find problems</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000177 <li>provide the diffs when you port libxml to a new platform. They may not
Daniel Veillardab8500d2000-10-15 21:06:19 +0000178 be integrated in all cases but help pinpointing portability problems
179 and</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000180 <li>provide documentation fixes (either as patches to the code comments or
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000181 as HTML diffs).</li>
182 <li>provide new documentations pieces (translations, examples, etc ...)</li>
183 <li>Check the TODO file and try to close one of the items</li>
184 <li>take one of the points raised in the archive or the bug database and
Daniel Veillard33a67802001-03-07 09:44:02 +0000185 provide a fix. <a href="mailto:Daniel.Veillard@imag.fr">Get in touch with
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000186 me </a>before to avoid synchronization problems and check that the
187 suggested fix will fit in nicely :-)</li>
188</ol>
189
Daniel Veillard10a2c651999-12-12 13:03:50 +0000190<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000191
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000192<p>The latest versions of libxml can be found on <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000193href="ftp://xmlsoft.org/">xmlsoft.org</a> or on the <a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000194href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either
Daniel Veillard10a2c651999-12-12 13:03:50 +0000195as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source
Daniel Veillard306be992000-07-03 12:38:45 +0000196archive</a> or <a
Daniel Veillarda41123c2001-04-22 19:31:20 +0000197href="ftp://ftp.gnome.org/pub/GNOME/stable/redhat/i386/libxml/">RPM
198packages</a>. (NOTE that you need both the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000199href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
200href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000201packages installed to compile applications using libxml.)</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000202
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000203<p><a name="Snapshot">Snapshot:</a></p>
204<ul>
205 <li>Code from the W3C cvs base libxml <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000206 href="ftp://xmlsoft.org/cvs-snapshot.tar.gz">cvs-snapshot.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000207 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000208 href="ftp://xmlsoft.org/libxml-docs.tar.gz">libxml-docs.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000209</ul>
210
211<p><a name="Contribs">Contribs:</a></p>
212
213<p>I do accept external contributions, especially if compiling on another
214platform, get in touch with me to upload the package. I will keep them in the
Daniel Veillard33a67802001-03-07 09:44:02 +0000215<a href="ftp://xmlsoft.org/contribs/">contrib directory</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000216
Daniel Veillard82687162001-01-22 15:32:01 +0000217<p>Libxml is also available from CVS:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000218<ul>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000219 <li><p>The <a
220 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Gnome
Daniel Veillard402e8c82000-02-29 22:57:47 +0000221 CVS base</a>. Check the <a
222 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a> page;
223 the CVS module is <b>gnome-xml</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000224 </li>
Daniel Veillard82687162001-01-22 15:32:01 +0000225 <li>The <strong>libxslt</strong> module is also present there</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000226</ul>
227
228<h2><a name="News">News</a></h2>
229
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000230<h3>CVS only : check the <a
231href="http://cvs.gnome.org/lxr/source/gnome-xml/ChangeLog">Changelog</a> file
Daniel Veillard189446d2000-10-13 10:23:06 +0000232for a really accurate description</h3>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000233
Daniel Veillard91e9d582001-02-26 07:31:12 +0000234<p>Items floating around but not actively worked on, get in touch with me if
Daniel Veillardab8500d2000-10-15 21:06:19 +0000235you want to test those</p>
236<ul>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000237 <li>Implementing <a href="http://xmlsoft.org/XSLT">XSLT</a>, this is done as
238 a separate C library on top of libxml called libxslt, not released yet but
239 available from CVS</li>
Daniel Veillard28929b22000-11-13 18:22:49 +0000240 <li>Finishing up <a href="http://www.w3.org/TR/xptr">XPointer</a> and <a
241 href="http://www.w3.org/TR/xinclude">XInclude</a></li>
Daniel Veillard82687162001-01-22 15:32:01 +0000242 <li>(seeems working but delayed from release) parsing/import of Docbook SGML
243 docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000244</ul>
245
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000246<h3>2.3.11: June 17 2001</h3>
247<ul>
248 <li>updates to trio, Makefiles and configure should fix some portability
249 problems (alpha)</li>
250 <li>fixed some HTML serialization problems (pre, script, and block/inline
251 handling), added encoding aware APIs, cleanup of this code</li>
252 <li>added xmlHasNsProp()</li>
253 <li>implemented a specific PI for encoding support in the DocBook SGML
254 parser</li>
255 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
256 node selection)</li>
257 <li>fixed a performance problem and an error in the validation code</li>
258 <li>fixed XInclude routine to implement the recursive behaviour</li>
259 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
260 <li>added --version to xmllint for bug reports</li>
261</ul>
262
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000263<h3>2.3.10: June 1 2001</h3>
264<ul>
265 <li>fixed the SGML catalog support</li>
266 <li>a number of reported bugs got fixed, in XPath, iconv detection, XInclude
267 processing</li>
268 <li>XPath string function should now handle unicode correctly</li>
269</ul>
270
Daniel Veillard4623acd2001-05-19 15:13:15 +0000271<h3>2.3.9: May 19 2001</h3>
272
273<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
274<ul>
275 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
276 <li>some serious speed optimisation again</li>
277 <li>some documentation cleanups</li>
278 <li>trying to get better linking on solaris (-R)</li>
279 <li>XPath API cleanup from Thomas Broyer</li>
280 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
281 xmlValidGetValidElements()</li>
282 <li>Added an INSTALL file</li>
283 <li>Attribute removal added to API: #54433</li>
284 <li>added a basic support for SGML catalogs</li>
285 <li>fixed xmlKeepBlanksDefault(0) API</li>
286 <li>bugfix in xmlNodeGetLang()</li>
287 <li>fixed a small configure portability problem</li>
288 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
289</ul>
290
Daniel Veillarda265af72001-05-14 11:13:58 +0000291<h3>1.8.13: May 14 2001</h3>
292<ul>
293 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
294</ul>
295
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000296<h3>2.3.8: May 3 2001</h3>
297<ul>
298 <li>Integrated an SGML DocBook parser for the Gnome project</li>
299 <li>Fixed a few things in the HTML parser</li>
300 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
301 point portability issue</li>
302 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for DOM+validation
303 using the XML REC as input and a 700MHz celeron).</li>
304 <li>incorporated more Windows cleanup</li>
305 <li>added xmlSaveFormatFile()</li>
306 <li>fixed problems in copying nodes with entities references (gdome)</li>
307 <li>removed some troubles surrounding the new validation module</li>
308</ul>
309
Daniel Veillarda41123c2001-04-22 19:31:20 +0000310<h3>2.3.7: April 22 2001</h3>
311<ul>
312 <li>lots of small bug fixes, corrected XPointer</li>
313 <li>Non determinist content model validation support</li>
314 <li>added xmlDocCopyNode for gdome2</li>
315 <li>revamped the way the HTML parser handles end of tags</li>
316 <li>XPath: corrctions of namespacessupport and number formatting</li>
317 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
318 <li>HTML ouput fixes from P C Chow and William M. Brack</li>
319 <li>Improved validation speed sensible for DocBook</li>
320 <li>fixed a big bug with ID declared in external parsed entities</li>
321 <li>portability fixes, update of Trio from Bjorn Reese</li>
322</ul>
323
Daniel Veillardafc73112001-04-11 11:51:41 +0000324<h3>2.3.6: April 8 2001</h3>
325<ul>
326 <li>Code cleanup using extreme gcc compiler warning options, found and
327 cleared half a dozen potential problem</li>
328 <li>the Eazel team found an XML parser bug</li>
329 <li>cleaned up the user of some of the string formatting function. used the
330 trio library code to provide the one needed when the platform is missing
331 them</li>
332 <li>xpath: removed a memory leak and fixed the predicate evaluation problem,
333 extended the testsuite and cleaned up the result. XPointer seems broken
334 ...</li>
335</ul>
336
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000337<h3>2.3.5: Mar 23 2001</h3>
338<ul>
339 <li>Biggest change is separate parsing and evaluation of XPath expressions,
340 there is some new APIs for this too</li>
341 <li>included a number of bug fixes(XML push parser, 51876, notations,
342 52299)</li>
343 <li>Fixed some portability issues</li>
344</ul>
345
Daniel Veillarde356c282001-03-10 12:32:04 +0000346<h3>2.3.4: Mar 10 2001</h3>
347<ul>
348 <li>Fixed bugs #51860 and #51861</li>
349 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
350 size to be application tunable.</li>
351 <li>Some cleanup in the validation code, still a bug left and this part
352 should probably be rewritten to support ambiguous content model :-\</li>
353 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
354 parser</li>
355 <li>Fixed another bug in xmlNodeGetContent()</li>
356 <li>Bjorn fixed XPath node collection and Number formatting</li>
357 <li>Fixed a loop reported in the HTML parsing</li>
358 <li>blank space are reported even if the Dtd content model proves that they
359 are formatting spaces, this is for XmL conformance</li>
360</ul>
361
Daniel Veillardb402c072001-03-01 17:28:58 +0000362<h3>2.3.3: Mar 1 2001</h3>
363<ul>
364 <li>small change in XPath for XSLT</li>
365 <li>documentation cleanups</li>
366 <li>fix in validation by Gary Pennington</li>
367 <li>serious parsing performances improvements</li>
368</ul>
369
Daniel Veillardec70e912001-02-26 20:10:45 +0000370<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +0000371<ul>
372 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
373 <li>fixed a Dtd parsing bug</li>
374 <li>fixed a bug in xmlNodeGetContent</li>
375 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
376</ul>
377
Daniel Veillardec70e912001-02-26 20:10:45 +0000378<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000379<ul>
380 <li>some XPath and HTML bug fixes for XSLT</li>
381 <li>small extension of the hash table interfaces for DOM gdome2
382 implementation</li>
383 <li>A few bug fixes</li>
384</ul>
385
Daniel Veillardec70e912001-02-26 20:10:45 +0000386<h3>2.3.0: Feb 8 2001 (2.2.12 was on 25 Jan but I didn't kept track)</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000387<ul>
388 <li>Lots of XPath bug fixes</li>
389 <li>Add a mode with Dtd lookup but without validation error reporting for
390 XSLT</li>
391 <li>Add support for text node without escaping (XSLT)</li>
392 <li>bug fixes for xmlCheckFilename</li>
393 <li>validation code bug fixes from Gary Pennington</li>
394 <li>Patch from Paul D. Smith correcting URI path normalization</li>
395 <li>Patch to allow simultaneous install of libxml-devel and
396 libxml2-devel</li>
397 <li>the example Makefile is now fixed</li>
398 <li>added HTML to the RPM packages</li>
399 <li>tree copying bugfixes</li>
400 <li>updates to Windows makefiles</li>
401 <li>optimisation patch from Bjorn Reese</li>
402</ul>
403
Daniel Veillardec70e912001-02-26 20:10:45 +0000404<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +0000405<ul>
406 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
407 <li>added htmlHandleOmittedElem()</li>
408 <li>Applied Bjorn Reese's IPV6 first patch</li>
409 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +0000410 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +0000411</ul>
412
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000413<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +0000414<ul>
415 <li>Fix the Windows problems of 2.2.8</li>
416 <li>integrate OpenVMS patches</li>
417 <li>better handling of some nasty HTML input</li>
418 <li>Improved the XPointer implementation</li>
419 <li>integrate a number of provided patches</li>
420</ul>
421
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000422<h3>2.2.9: Nov 25 2000</h3>
423<ul>
424 <li>erroneous release :-(</li>
425</ul>
426
Daniel Veillard28929b22000-11-13 18:22:49 +0000427<h3>2.2.8: Nov 13 2000</h3>
428<ul>
429 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
430 support</li>
431 <li>Patch in conditional section handling</li>
432 <li>updated MS compiler project</li>
433 <li>fixed some XPath problems</li>
434 <li>added an URI escaping function</li>
435 <li>some other bug fixes</li>
436</ul>
437
438<h3>2.2.7: Oct 31 2000</h3>
439<ul>
440 <li>added message redirection</li>
441 <li>XPath improvements (thanks TOM !)</li>
442 <li>xmlIOParseDTD() added</li>
443 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
444 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
445</ul>
446
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000447<h3>2.2.6: Oct 25 2000:</h3>
448<ul>
449 <li>Added an hash table module, migrated a number of internal structure to
450 those</li>
451 <li>Fixed a posteriori validation problems</li>
452 <li>HTTP module cleanups</li>
453 <li>HTML parser improvements (tag errors, script/style handling, attribute
454 normalization)</li>
455 <li>coalescing of adjacent text nodes</li>
456 <li>couple of XPath bug fixes, exported the internal API</li>
457</ul>
458
Daniel Veillardab8500d2000-10-15 21:06:19 +0000459<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000460<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000461 <li>XPointer implementation and testsuite</li>
462 <li>Lot of XPath fixes, added variable and functions registration, more
463 tests</li>
464 <li>Portability fixes, lots of enhancements toward an easy Windows build and
465 release</li>
466 <li>Late validation fixes</li>
467 <li>Integrated a lot of contributed patches</li>
468 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000469 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000470</ul>
471
472<h3>2.2.4: Oct 1 2000:</h3>
473<ul>
474 <li>main XPath problem fixed</li>
475 <li>Integrated portability patches for Windows</li>
476 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000477</ul>
478
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000479<h3>2.2.3: Sep 17 2000</h3>
480<ul>
481 <li>bug fixes</li>
482 <li>cleanup of entity handling code</li>
483 <li>overall review of all loops in the parsers, all sprintf usage has been
484 checked too</li>
485 <li>Far better handling of larges Dtd. Validating against Docbook XML Dtd
486 works smoothly now.</li>
487</ul>
488
489<h3>1.8.10: Sep 6 2000</h3>
490<ul>
491 <li>bug fix release for some Gnome projects</li>
492</ul>
493
494<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000495<ul>
496 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000497 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000498</ul>
499
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000500<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000501<ul>
502 <li>a purely bug fixes release</li>
503 <li>fixed an encoding support problem when parsing from a memory block</li>
504 <li>fixed a DOCTYPE parsing problem</li>
505 <li>removed a bug in the function allowing to override the memory allocation
506 routines</li>
507</ul>
508
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000509<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +0000510<ul>
511 <li>applied a lot of portability fixes</li>
512 <li>better encoding support/cleanup and saving (content is now always
513 encoded in UTF-8)</li>
514 <li>the HTML parser now correctly handles encodings</li>
515 <li>added xmlHasProp()</li>
516 <li>fixed a serious problem with &amp;#38;</li>
517 <li>propagated the fix to FTP client</li>
518 <li>cleanup, bugfixes, etc ...</li>
519 <li>Added a page about <a href="encoding.html">libxml Internationalization
520 support</a></li>
521</ul>
522
Daniel Veillard60979bd2000-07-10 12:17:33 +0000523<h3>1.8.9: July 9 2000</h3>
524<ul>
525 <li>fixed the spec the RPMs should be better</li>
526 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
527 rpmfind users problem</li>
528</ul>
529
Daniel Veillard6388e172000-07-03 16:07:19 +0000530<h3>2.1.1: July 1 2000</h3>
531<ul>
532 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
533 <li>improvements on the HTML parser</li>
534</ul>
535
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000536<h3>2.1.0 and 1.8.8: June 29 2000</h3>
537<ul>
538 <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
539 <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
540 about &amp;#38; charref parsing</li>
541 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
542 also contains numerous fixes and enhancements:
543 <ul>
544 <li>added xmlStopParser() to stop parsing</li>
545 <li>improved a lot parsing speed when there is large CDATA blocs</li>
546 <li>includes XPath patches provided by Picdar Technology</li>
547 <li>tried to fix as much as possible DtD validation and namespace
548 related problems</li>
549 <li>output to a given encoding has been added/tested</li>
550 <li>lot of various fixes</li>
551 </ul>
552 </li>
553</ul>
554
Daniel Veillarde0aed302000-04-16 08:52:20 +0000555<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000556<ul>
557 <li>First public release of libxml2. If you are using libxml, it's a good
Daniel Veillarde0aed302000-04-16 08:52:20 +0000558 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
559 scheduled for Apr 3 the relase occured only on Apr 12 due to massive
560 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000561 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000562 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000563 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000564 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000565 <pre>#include "xxx.h"</pre>
566 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000567 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
568 <li>the memory allocation routines used by libxml can now be overloaded
569 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000570 <li>The previously CVS only tool tester has been renamed
571 <strong>xmllint</strong> and is now installed as part of the libxml2
572 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000573 <li>The I/O interface has been revamped. There is now ways to plug in
574 specific I/O modules, either at the URI scheme detection level using
575 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
576 parser context using xmlCreateIOParserCtxt()</li>
577 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
578 number of the libxml module in use</li>
579 <li>a number of optional features of libxml can now be excluded at configure
580 time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000581</ul>
582
583<h3>2.0.0beta: Mar 14 2000</h3>
584<ul>
585 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000586 <li>It's available only from<a href="ftp://xmlsoft.org/">xmlsoft.org
587 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
588 RPMs</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000589 <li>This version is now the head in the Gnome CVS base, the old one is
590 available under the tag LIB_XML_1_X</li>
591 <li>This includes a very large set of changes. Froma programmatic point of
592 view applications should not have to be modified too much, check the <a
593 href="upgrade.html">upgrade page</a></li>
594 <li>Some interfaces may changes (especially a bit about encoding).</li>
595 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000596 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000597 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
598 handled now</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000599 <li>Better handling of entities, especially well formedness checking and
600 proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000601 <li>DTD conditional sections</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000602 <li>Validation now correcly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000603 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
604 structures to accomodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000605 </ul>
606 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000607 <li>Serious progress were made toward compliance, <a
608 href="conf/result.html">here are the result of the test</a> against the
609 OASIS testsuite (except the japanese tests since I don't support that
610 encoding yet). This URL is rebuilt every couple of hours using the CVS
611 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000612</ul>
613
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000614<h3>1.8.7: Mar 6 2000</h3>
615<ul>
616 <li>This is a bug fix release:</li>
617 <li>It is possible to disable the ignorable blanks heuristic used by
618 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
619 that for adherence to XML spec, this behaviour will be disabled by default
620 in 2.x . The same function will allow to keep compatibility for old
621 code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000622 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
623 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000624 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
625 compilation on some platforms has been fixed</li>
626 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
627 URIs</li>
628</ul>
629
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000630<h3>1.8.6: Jan 31 2000</h3>
631<ul>
632 <li>added a nanoFTP transport module, debugged until the new version of <a
633 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
634 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000635</ul>
636
637<h3>1.8.5: Jan 21 2000</h3>
638<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000639 <li>adding APIs to parse a well balanced chunk of XML (production <a
640 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the XML
641 spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000642 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000643 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
644 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000645 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
646 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000647</ul>
648
649<h3>1.8.4: Jan 13 2000</h3>
650<ul>
651 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
652 <li>all exit() call should have been removed from libxml</li>
653 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
654 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000655</ul>
656
657<h3>1.8.3: Jan 5 2000</h3>
658<ul>
659 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000660 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillarddbfd6411999-12-28 16:35:14 +0000661 <li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000662 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000663 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
664 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000665 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000666 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000667 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000668</ul>
669
670<h3>1.8.2: Dec 21 1999</h3>
671<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000672 <li>I got another problem with includes and C++, I hope this issue is fixed
673 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000674 <li>Added a few tree modification functions: xmlReplaceNode,
675 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
676 xmlDocSetRootElement</li>
677 <li>Tried to improve the HTML output with help from <a
678 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000679</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000680
Daniel Veillarde4e51311999-12-18 15:32:46 +0000681<h3>1.8.1: Dec 18 1999</h3>
682<ul>
683 <li>various patches to avoid troubles when using libxml with C++ compilers
684 the "namespace" keyword and C escaping in include files</li>
685 <li>a problem in one of the core macros IS_CHAR was corrected</li>
686 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
687 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000688 <li>fixed a posteriori validation (validation after parsing, or by using a
689 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000690 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000691</ul>
692
693<h3>1.8.0: Dec 12 1999</h3>
694<ul>
695 <li>cleanup, especially memory wise</li>
696 <li>the parser should be more reliable, especially the HTML one, it should
697 not crash, whatever the input !</li>
698 <li>Integrated various patches, especially a speedup improvement for large
699 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
700 configure with --with-buffers to enable them.</li>
701 <li>attribute normalization, oops should have been added long ago !</li>
702 <li>attributes defaulted from Dtds should be available, xmlSetProp() now
703 does entities escapting by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000704</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000705
706<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000707<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000708 <li>Lots of HTML improvement</li>
709 <li>Fixed some errors when saving both XML and HTML</li>
710 <li>More examples, the regression tests should now look clean</li>
711 <li>Fixed a bug with contiguous charref</li>
712</ul>
713
714<h3>1.7.3: Sep 29 1999</h3>
715<ul>
716 <li>portability problems fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000717 <li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000718 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000719</ul>
720
721<h3>1.7.1: Sep 24 1999</h3>
722<ul>
723 <li>The basic type for strings manipulated by libxml has been renamed in
724 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
725 is that CHAR was conflicting with a predefined type on Windows. However on
726 non WIN32 environment, compatibility is provided by the way of a
727 <strong>#define </strong>.</li>
728 <li>Changed another error : the use of a structure field called errno, and
729 leading to troubles on platforms where it's a macro</li>
730</ul>
731
732<h3>1.7.0: sep 23 1999</h3>
733<ul>
734 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000735 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000736 <li>Added an errno to report errors by another mean than a simple printf
737 like callback</li>
738 <li>Finished ID/IDREF support and checking when validation</li>
739 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000740 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000741 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
742 implementation</li>
743 <li>Added an HTML parser front-end</li>
744</ul>
745
746<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000747
Daniel Veillard402e8c82000-02-29 22:57:47 +0000748<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000749markup-based structured documents. Here is <a name="example">an example XML
750document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000751<pre>&lt;?xml version="1.0"?&gt;
752&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
753 &lt;head&gt;
754 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
755 &lt;/head&gt;
756 &lt;chapter&gt;
757 &lt;title&gt;The Linux adventure&lt;/title&gt;
758 &lt;p&gt;bla bla bla ...&lt;/p&gt;
759 &lt;image href="linus.gif"/&gt;
760 &lt;p&gt;...&lt;/p&gt;
761 &lt;/chapter&gt;
762&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000763
Daniel Veillard402e8c82000-02-29 22:57:47 +0000764<p>The first line specifies that it's an XML document and gives useful
765information about its encoding. Then the document is a text format whose
766structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000767to be closed</strong>. XML is pedantic about this. However, if a tag is empty
768(no content), a single tag can serve as both the opening and closing tag if it
Daniel Veillard60979bd2000-07-10 12:17:33 +0000769ends with <code>/&gt;</code> rather than with <code>&gt;</code>. Note that,
770for example, the image tag has no content (just an attribute) and is closed by
771ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000772
Daniel Veillard402e8c82000-02-29 22:57:47 +0000773<p>XML can be applied sucessfully to a wide range of uses, from long term
774structured document maintenance (where it follows the steps of SGML) to simple
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000775data encoding mechanisms like configuration file formatting (glade),
776spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
777it is used to encode remote calls between a client and a server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000778
Daniel Veillard82687162001-01-22 15:32:01 +0000779<h2><a name="XSLT">XSLT</a></h2>
780
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000781<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
782
Daniel Veillard82687162001-01-22 15:32:01 +0000783<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a language
784for transforming XML documents into other XML documents (or HTML/textual
785output).</p>
786
787<p>A separate library called libxslt is being built on top of libxml2. This
788module "libxslt" can be found in the Gnome CVS base too.</p>
789
Daniel Veillard383b1472001-01-23 11:39:52 +0000790<p>You can check the <a
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000791href="http://cvs.gnome.org/lxr/source/libxslt/FEATURES">features</a> supported
792and the progresses on the <a
Daniel Veillard82687162001-01-22 15:32:01 +0000793href="http://cvs.gnome.org/lxr/source/libxslt/ChangeLog">Changelog</a></p>
794
Daniel Veillard4540be42000-08-19 16:40:28 +0000795<h2>An overview of libxml architecture</h2>
796
Daniel Veillardec70e912001-02-26 20:10:45 +0000797<p>Libxml is made of multiple components; some of them are optional, and most
798of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +0000799<ul>
800 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000801 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000802 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000803 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000804 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000805 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000806 <li>a SAX tree module to build an in-memory DOM representation</li>
807 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000808 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000809 <li>an XPath module for global lookup in a DOM representation
Daniel Veillard91e9d582001-02-26 07:31:12 +0000810 (optional)</li>
811 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000812</ul>
813
814<p>Graphically this gives the following:</p>
815
816<p><img src="libxml.gif" alt="a graphical view of the various"></p>
817
818<p></p>
819
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000820<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000821
822<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000823returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000824<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000825as the file name, the document type, and a <strong>children</strong> pointer
826which is the root of the document (or more exactly the first child under the
827root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000828chained in double-linked lists of siblings and with a children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000829relationship. An xmlNode can also carry properties (a chain of xmlAttr
830structures). An attribute may have a value which is a list of TEXT or
831ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000832
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000833<p>Here is an example (erroneous with respect to the XML spec since there
834should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000835
836<p><img src="structure.gif" alt=" structure.gif "></p>
837
838<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000839called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000840prints them back as parsed. This is useful for detecting errors both in XML
841code and in the XML parser itself. It has an option <strong>--debug</strong>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000842which prints the actual in-memory structure of the document; here is the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000843result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000844<pre>DOCUMENT
845version=1.0
846standalone=true
847 ELEMENT EXAMPLE
848 ATTRIBUTE prop1
849 TEXT
850 content=gnome is great
851 ATTRIBUTE prop2
852 ENTITY_REF
853 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000854 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000855 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000856 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000857 TEXT
858 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000859 ELEMENT chapter
860 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000861 TEXT
862 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000863 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000864 TEXT
865 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000866 ELEMENT image
867 ATTRIBUTE href
868 TEXT
869 content=linus.gif
870 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000871 TEXT
872 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000873
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000874<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000875
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000876<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000877
Daniel Veillard402e8c82000-02-29 22:57:47 +0000878<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000879memory. In that case (and if you don't expect to save back the XML document
880loaded using libxml), it's better to use the SAX interface of libxml. SAX is a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000881<strong>callback-based interface</strong> to the parser. Before parsing, the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000882application layer registers a customized set of callbacks which are called by
883the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000884
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000885<p>To get more detailed step-by-step guidance on using the SAX interface of
Daniel Veillard4540be42000-08-19 16:40:28 +0000886libxml, see the <a
887href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
888documentation</a>.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000889Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000890
891<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
892program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000893binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000894distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000895testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000896<pre>SAX.setDocumentLocator()
897SAX.startDocument()
898SAX.getEntity(amp)
899SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
900SAX.characters( , 3)
901SAX.startElement(head)
902SAX.characters( , 4)
903SAX.startElement(title)
904SAX.characters(Welcome to Gnome, 16)
905SAX.endElement(title)
906SAX.characters( , 3)
907SAX.endElement(head)
908SAX.characters( , 3)
909SAX.startElement(chapter)
910SAX.characters( , 4)
911SAX.startElement(title)
912SAX.characters(The Linux adventure, 19)
913SAX.endElement(title)
914SAX.characters( , 4)
915SAX.startElement(p)
916SAX.characters(bla bla bla ..., 15)
917SAX.endElement(p)
918SAX.characters( , 4)
919SAX.startElement(image, href='linus.gif')
920SAX.endElement(image)
921SAX.characters( , 4)
922SAX.startElement(p)
923SAX.characters(..., 3)
924SAX.endElement(p)
925SAX.characters( , 3)
926SAX.endElement(chapter)
927SAX.characters( , 1)
928SAX.endElement(EXAMPLE)
929SAX.endDocument()</pre>
930
Daniel Veillardec70e912001-02-26 20:10:45 +0000931<p>Most of the other interfaces of libxml are based on the DOM tree-building
932facility, so nearly everything up to the end of this document presupposes the
933use of the standard DOM tree build. Note that the DOM tree itself is built by
934a set of registered default callbacks, without internal specific
935interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000936
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000937<h2><a name="library">The XML library interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000938
939<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000940using the XML library from the C language. It is not intended to be extensive.
941I hope the automatically generated documents will provide the completeness
942required, but as a separate set of documents. The interfaces of the XML
943library are by principle low level, there is nearly zero abstraction. Those
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000944interested in a higher level API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000945
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000946<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
947separated from the <a href="html/libxml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000948interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000949
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000950<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000951
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000952<p>Usually, the first thing to do is to read an XML input. The parser accepts
953documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000954defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000955<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000956 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000957 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000958 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000959</dl>
960<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000961 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000962 <dd><p>Parse an XML document contained in a (possibly compressed)
963 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000964 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000965</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000966
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000967<p>The parser returns a pointer to the document structure (or NULL in case of
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000968failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000969
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000970<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000971
Daniel Veillard91e9d582001-02-26 07:31:12 +0000972<p>In order for the application to keep the control when the document is being
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000973fetched (which is common for GUI based programs) libxml provides a push
974interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000975<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
976 void *user_data,
977 const char *chunk,
978 int size,
979 const char *filename);
980int xmlParseChunk (xmlParserCtxtPtr ctxt,
981 const char *chunk,
982 int size,
983 int terminate);</pre>
984
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000985<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000986<pre> FILE *f;
987
988 f = fopen(filename, "r");
989 if (f != NULL) {
990 int res, size = 1024;
991 char chars[1024];
992 xmlParserCtxtPtr ctxt;
993
994 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000995 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000996 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
997 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000998 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000999 xmlParseChunk(ctxt, chars, res, 0);
1000 }
1001 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +00001002 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +00001003 xmlFreeParserCtxt(ctxt);
1004 }
1005 }</pre>
1006
Daniel Veillardec70e912001-02-26 20:10:45 +00001007<p>The HTML parser embedded into libxml also has a push interface; the
1008functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00001009
1010<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
1011
Daniel Veillardec70e912001-02-26 20:10:45 +00001012<p>The tree-building interface makes the parser memory-hungry, first loading
1013the document in memory and then building the tree itself. Reading a document
1014without building the tree is possible using the SAX interfaces (see SAX.h and
1015<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001016Henstridge's documentation</a>). Note also that the push interface can be
Daniel Veillard91e9d582001-02-26 07:31:12 +00001017limited to SAX: just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +00001018<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00001019
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001020<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001021
1022<p>The other way to get an XML tree in memory is by building it. Basically
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001023there is a set of functions dedicated to building new elements. (These are
Daniel Veillard60979bd2000-07-10 12:17:33 +00001024also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of code
Daniel Veillard361d8452000-04-03 19:48:13 +00001025that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001026<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00001027 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +00001028 xmlNodePtr tree, subtree;
1029
1030 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +00001031 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
1032 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
1033 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
1034 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +00001035 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +00001036 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +00001037 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
1038 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
1039 subtree = xmlNewChild(tree, NULL, "image", NULL);
1040 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001041
1042<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00001043
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001044<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001045
Daniel Veillard9cb5ff42001-01-29 08:22:21 +00001046<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
Daniel Veillard306be992000-07-03 12:38:45 +00001047code has access to the internal structure of all the elements of the tree. The
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001048names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +00001049<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001050<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +00001051example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001052<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001053
1054<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +00001055<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001056
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001057<p>points to the text node containing the chapter title "The Linux
1058adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00001059
Daniel Veillardb24054a1999-12-18 15:32:46 +00001060<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
Daniel Veillard60979bd2000-07-10 12:17:33 +00001061present before the document root, so <code>doc-&gt;children</code> may point
Daniel Veillard91e9d582001-02-26 07:31:12 +00001062to an element which is not the document Root Element; a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +00001063<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +00001064
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001065<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001066
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001067<p>Functions are provided for reading and writing the document content. Here
Daniel Veillard9cb5ff42001-01-29 08:22:21 +00001068is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00001069<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +00001070 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
1071 xmlChar *value);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001072 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node. The
1073 value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001074 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001075</dl>
1076<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +00001077 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +00001078 *name);</code></dt>
Daniel Veillardc92c3042000-09-29 02:42:04 +00001079 <dd><p>This function returns a pointer to new copy of the property
1080 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001081 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001082</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001083
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001084<p>Two functions are provided for reading and writing the text associated with
Daniel Veillard25940b71998-10-29 05:51:30 +00001085elements:</p>
1086<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +00001087 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +00001088 *value);</code></dt>
Daniel Veillardec70e912001-02-26 20:10:45 +00001089 <dd><p>This function takes an "external" string and converts it to one
1090 text node or possibly to a list of entity and text nodes. All
1091 non-predefined entity references like &amp;Gnome; will be stored
1092 internally as entity nodes, hence the result of the function may not be
1093 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001094 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001095</dl>
1096<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +00001097 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +00001098 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001099 <dd><p>This function is the inverse of
1100 <code>xmlStringGetNodeList()</code>. It generates a new string
1101 containing the content of the text and entity nodes. Note the extra
1102 argument inLine. If this argument is set to 1, the function will expand
1103 entity references. For example, instead of returning the &amp;Gnome;
1104 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard91e9d582001-02-26 07:31:12 +00001105 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001106 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001107</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00001108
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001109<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001110
1111<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00001112<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +00001113 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +00001114 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001115 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001116 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001117</dl>
1118<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001119 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001120 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001121 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001122</dl>
1123<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001124 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001125 <dd><p>Saves the document to a file. In this case, the compression
1126 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001127 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001128</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00001129
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001130<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001131
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001132<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001133accesses. The level of compression on saves can be turned on either globally
1134or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00001135<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001136 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001137 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001138 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001139</dl>
1140<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001141 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001142 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001143 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001144</dl>
1145<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001146 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001147 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001148 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001149</dl>
1150<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001151 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001152 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001153 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00001154</dl>
1155
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001156<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001157
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001158<p>Entities in principle are similar to simple C macros. An entity defines an
1159abbreviation for a given string that you can reuse many times throughout the
1160content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001161may occur frequently within a document, or to confine the change needed to a
1162document to a restricted area in the internal subset of the document (at the
1163beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001164<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000011652 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +000011663 &lt;!ENTITY xml "Extensible Markup Language"&gt;
11674 ]&gt;
11685 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000011696 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +000011707 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001171
1172<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
Daniel Veillard91e9d582001-02-26 07:31:12 +00001173its name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001174are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001175predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001176<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001177for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001178<strong>&amp;quot;</strong> for the character '"', and
1179<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001180
1181<p>One of the problems related to entities is that you may want the parser to
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001182substitute an entity's content so that you can see the replacement text in
1183your application. Or you may prefer to keep entity references as such in the
1184content to be able to save the document back without losing this usually
1185precious information (if the user went through the pain of explicitly defining
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001186entities, he may have a a rather negative attitude if you blindly susbtitute
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001187them as saving time). The <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +00001188href="html/libxml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001189function allows you to check and change the behaviour, which is to not
1190substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001191
1192<p>Here is the DOM tree built by libxml for the previous document in the
1193default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001194<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001195DOCUMENT
1196version=1.0
1197 ELEMENT EXAMPLE
1198 TEXT
1199 content=
1200 ENTITY_REF
1201 INTERNAL_GENERAL_ENTITY xml
1202 content=Extensible Markup Language
1203 TEXT
1204 content=</pre>
1205
1206<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001207<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001208DOCUMENT
1209version=1.0
1210 ELEMENT EXAMPLE
1211 TEXT
1212 content= Extensible Markup Language</pre>
1213
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001214<p>So, entities or no entities? Basically, it depends on your use case. I
1215suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001216entities in your XML document or data if you are not willing to handle the
1217entity references elements in the DOM tree.</p>
1218
Daniel Veillard91e9d582001-02-26 07:31:12 +00001219<p>Note that at save time libxml enforces the conversion of the predefined
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001220entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard91e9d582001-02-26 07:31:12 +00001221transparently replace those with chars (i.e. it will not generate entity
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001222reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001223finding them in the input).</p>
1224
Daniel Veillard7b9c4b72000-08-25 16:26:50 +00001225<p><span style="background-color: #FF0000">WARNING</span>: handling entities
Daniel Veillard91e9d582001-02-26 07:31:12 +00001226on top of the libxml SAX interface is difficult!!! If you plan to use
Daniel Veillard7b9c4b72000-08-25 16:26:50 +00001227non-predefined entities in your documents, then the learning cuvre to handle
Daniel Veillard91e9d582001-02-26 07:31:12 +00001228then using the SAX API may be long. If you plan to use complex documents, I
Daniel Veillard7b9c4b72000-08-25 16:26:50 +00001229strongly suggest you consider using the DOM interface instead and let libxml
Daniel Veillard8c6d6af2000-08-25 17:14:13 +00001230deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +00001231
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001232<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001233
Daniel Veillardec303412000-03-24 13:41:54 +00001234<p>The libxml library implements <a
1235href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
1236recognizing namespace contructs in the input, and does namespace lookup
1237automatically when building the DOM tree. A namespace declaration is
1238associated with an in-memory structure and all elements or attributes within
1239that namespace point to it. Hence testing the namespace is a simple and fast
1240equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001241
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001242<p>I suggest that people using libxml use a namespace, and declare it in the
1243root element of their document as the default namespace. Then they don't need
1244to use the prefix in the content but we will have a basis for future semantic
Daniel Veillard91e9d582001-02-26 07:31:12 +00001245refinement and merging of data from different sources. This doesn't increase
Daniel Veillardec70e912001-02-26 20:10:45 +00001246the size of the XML output significantly, but significantly increases its
1247value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001248<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
1249 &lt;elem1&gt;...&lt;/elem1&gt;
1250 &lt;elem2&gt;...&lt;/elem2&gt;
1251&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001252
Daniel Veillardec70e912001-02-26 20:10:45 +00001253<p>The namespace value has to be an absolute URL, but the URL doesn't have to
1254point to any existing resource on the Web. It will bind all the element and
1255atributes with that URL. I suggest to use an URL within a domain you control,
1256and that the URL should contain some kind of version information if possible.
1257For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a good
1258namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +00001259
1260<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001261version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001262and if the version information don't match something you know, warn the user
1263and be liberal in what you accept as the input. Also do *not* try to base
Daniel Veillard60979bd2000-07-10 12:17:33 +00001264namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
Daniel Veillard91e9d582001-02-26 07:31:12 +00001265same as &lt;bar:text&gt; in another document. What really matters is the URI
Daniel Veillard60979bd2000-07-10 12:17:33 +00001266associated with the element or the attribute, not the prefix string (which is
Daniel Veillard91e9d582001-02-26 07:31:12 +00001267just a shortcut for the full URI). In libxml, element and attributes have an
Daniel Veillardec303412000-03-24 13:41:54 +00001268<code>ns</code> field pointing to an xmlNs structure detailing the namespace
Daniel Veillard91e9d582001-02-26 07:31:12 +00001269prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001270
1271<p>@@Interfaces@@</p>
1272
1273<p>@@Examples@@</p>
1274
Daniel Veillard91e9d582001-02-26 07:31:12 +00001275<p>Usually people object to using namespaces together with validity checking.
1276I will try to make sure that using namespaces won't break validity checking,
1277so even if you plan to use or currently are using validation I strongly
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001278suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001279<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard91e9d582001-02-26 07:31:12 +00001280flexible parsers. Using namespaces to mix and differentiate content coming
Daniel Veillard88f00ae2000-03-02 00:15:55 +00001281from multiple DTDs will certainly break current validation schemes. I will try
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001282to provide ways to do this, but this may not be portable or standardized.</p>
1283
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00001284<h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001285
1286<p>Well what is validation and what is a DTD ?</p>
1287
1288<p>Validation is the process of checking a document against a set of
Daniel Veillard91e9d582001-02-26 07:31:12 +00001289construction rules; a <strong>DTD</strong> (Document Type Definition) is such
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001290a set of rules.</p>
1291
1292<p>The validation process and building DTDs are the two most difficult parts
Daniel Veillard91e9d582001-02-26 07:31:12 +00001293of the XML life cycle. Briefly a DTD defines all the possibles element to be
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001294found within your document, what is the formal shape of your document tree (by
1295defining the allowed content of an element, either text, a regular expression
Daniel Veillard306be992000-07-03 12:38:45 +00001296for the allowed list of children, or mixed content i.e. both text and
1297children). The DTD also defines the allowed attributes for all elements and
Daniel Veillardec70e912001-02-26 20:10:45 +00001298the types of the attributes. For more detailed information, I suggest that you
Daniel Veillard81781102001-03-07 09:31:47 +00001299read the related parts of the XML specification, the examples found under
Daniel Veillardec70e912001-02-26 20:10:45 +00001300gnome-xml/test/valid/dtd and any of the large number of books available on
1301XML. The dia example in gnome-xml/test/valid should be both simple and
1302complete enough to allow you to build your own.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001303
Daniel Veillard91e9d582001-02-26 07:31:12 +00001304<p>A word of warning, building a good DTD which will fit the needs of your
1305application in the long-term is far from trivial; however, the extra level of
1306quality it can ensure is well worth the price for some sets of applications or
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001307if you already have already a DTD defined for your application field.</p>
1308
1309<p>The validation is not completely finished but in a (very IMHO) usable
1310state. Until a real validation interface is defined the way to do it is to
1311define and set the <strong>xmlDoValidityCheckingDefaultValue</strong> external
1312variable to 1, this will of course be changed at some point:</p>
1313
1314<p>extern int xmlDoValidityCheckingDefaultValue;</p>
1315
1316<p>...</p>
1317
1318<p>xmlDoValidityCheckingDefaultValue = 1;</p>
1319
1320<p></p>
1321
1322<p>To handle external entities, use the function
1323<strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to
1324link in you HTTP/FTP/Entities database library to the standard libxml
1325core.</p>
1326
1327<p>@@interfaces@@</p>
1328
Daniel Veillard35008381999-10-25 13:15:52 +00001329<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001330
1331<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document Object
Daniel Veillard91e9d582001-02-26 07:31:12 +00001332Model</em>; this is an API for accessing XML or HTML structured documents.
Daniel Veillardec70e912001-02-26 20:10:45 +00001333Native support for DOM in Gnome is on the way (module gnome-dom), and will be
1334based on gnome-xml. This will be a far cleaner interface to manipulate XML
Daniel Veillard3197f162001-04-04 00:40:08 +00001335files within Gnome since it won't expose the internal structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00001336
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001337<p>The current DOM implementation on top of libxml is the <a
Daniel Veillarda47fb3d2001-03-25 17:23:49 +00001338href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this
1339is a full DOM interface, thanks to Paolo Casarini, check the <a
1340href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more
1341informations.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001342
Daniel Veillard35008381999-10-25 13:15:52 +00001343<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001344
1345<p>Here is a real size example, where the actual content of the application
1346data is not kept in the DOM tree but uses internal structures. It is based on
Daniel Veillard14fff061999-06-22 21:49:07 +00001347a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +00001348storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
1349base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001350<pre>&lt;?xml version="1.0"?&gt;
1351&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
1352 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001353
Daniel Veillard60979bd2000-07-10 12:17:33 +00001354 &lt;gjob:Job&gt;
1355 &lt;gjob:Project ID="3"/&gt;
1356 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
1357 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001358
Daniel Veillard60979bd2000-07-10 12:17:33 +00001359 &lt;gjob:Update&gt;
1360 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
1361 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
1362 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
1363 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001364
Daniel Veillard60979bd2000-07-10 12:17:33 +00001365 &lt;gjob:Developers&gt;
1366 &lt;gjob:Developer&gt;
1367 &lt;/gjob:Developer&gt;
1368 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001369
Daniel Veillard60979bd2000-07-10 12:17:33 +00001370 &lt;gjob:Contact&gt;
1371 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
1372 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
1373 &lt;gjob:Company&gt;
1374 &lt;/gjob:Company&gt;
1375 &lt;gjob:Organisation&gt;
1376 &lt;/gjob:Organisation&gt;
1377 &lt;gjob:Webpage&gt;
1378 &lt;/gjob:Webpage&gt;
1379 &lt;gjob:Snailmail&gt;
1380 &lt;/gjob:Snailmail&gt;
1381 &lt;gjob:Phone&gt;
1382 &lt;/gjob:Phone&gt;
1383 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001384
Daniel Veillard60979bd2000-07-10 12:17:33 +00001385 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001386 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +00001387 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001388
Daniel Veillard60979bd2000-07-10 12:17:33 +00001389 &lt;gjob:Skills&gt;
1390 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001391
Daniel Veillard60979bd2000-07-10 12:17:33 +00001392 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001393 A GNOME based system that will allow a superuser to configure
1394 compressed and uncompressed files and/or file systems to be backed
1395 up with a supported media in the system. This should be able to
1396 perform via find commands generating a list of files that are passed
1397 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
1398 or via operations performed on the filesystem itself. Email
1399 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +00001400 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001401
Daniel Veillard60979bd2000-07-10 12:17:33 +00001402 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001403
Daniel Veillard60979bd2000-07-10 12:17:33 +00001404 &lt;/gjob:Jobs&gt;
1405&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001406
1407<p>While loading the XML file into an internal DOM tree is a matter of calling
Daniel Veillardec70e912001-02-26 20:10:45 +00001408only a couple of functions, browsing the tree to gather the ata and generate
1409the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001410
1411<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillardec70e912001-02-26 20:10:45 +00001412structure. For example, the ordering of the attributes is not significant, the
1413XML specification is clear about it. It's also usually a good idea not to
1414depend on the order of the children of a given node, unless it really makes
1415things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001416<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +00001417 * A person record
1418 */
1419typedef struct person {
1420 char *name;
1421 char *email;
1422 char *company;
1423 char *organisation;
1424 char *smail;
1425 char *webPage;
1426 char *phone;
1427} person, *personPtr;
1428
1429/*
1430 * And the code needed to parse it
1431 */
1432personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1433 personPtr ret = NULL;
1434
1435DEBUG("parsePerson\n");
1436 /*
1437 * allocate the struct
1438 */
1439 ret = (personPtr) malloc(sizeof(person));
1440 if (ret == NULL) {
1441 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00001442 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00001443 }
1444 memset(ret, 0, sizeof(person));
1445
1446 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00001447 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00001448 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +00001449 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
1450 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1451 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
1452 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1453 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00001454 }
1455
1456 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00001457}</pre>
1458
Daniel Veillard91e9d582001-02-26 07:31:12 +00001459<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00001460<ul>
Daniel Veillard91e9d582001-02-26 07:31:12 +00001461 <li>Usually a recursive parsing style is the more convenient one: XML data
1462 is by nature subject to repetitive constructs and usually exibits highly
Daniel Veillardb05deb71999-08-10 19:04:08 +00001463 stuctured patterns.</li>
1464 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>, i.e.
1465 the pointer to the global XML document and the namespace reserved to the
1466 application. Document wide information are needed for example to decode
1467 entities and it's a good coding practice to define a namespace for your
1468 application set of data and test that the element and attributes you're
1469 analyzing actually pertains to your application space. This is done by a
Daniel Veillard60979bd2000-07-10 12:17:33 +00001470 simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardec70e912001-02-26 20:10:45 +00001471 <li>To retrieve text and attributes value, you can use the function
1472 <em>xmlNodeListGetString</em> to gather all the text and entity reference
1473 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +00001474</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001475
1476<p>Here is another piece of code used to parse another level of the
1477structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001478<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00001479/*
Daniel Veillard14fff061999-06-22 21:49:07 +00001480 * a Description for a Job
1481 */
1482typedef struct job {
1483 char *projectID;
1484 char *application;
1485 char *category;
1486 personPtr contact;
1487 int nbDevelopers;
1488 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
1489} job, *jobPtr;
1490
1491/*
1492 * And the code needed to parse it
1493 */
1494jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1495 jobPtr ret = NULL;
1496
1497DEBUG("parseJob\n");
1498 /*
1499 * allocate the struct
1500 */
1501 ret = (jobPtr) malloc(sizeof(job));
1502 if (ret == NULL) {
1503 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00001504 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00001505 }
1506 memset(ret, 0, sizeof(job));
1507
1508 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00001509 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00001510 while (cur != NULL) {
1511
Daniel Veillard60979bd2000-07-10 12:17:33 +00001512 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
1513 ret-&gt;projectID = xmlGetProp(cur, "ID");
1514 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +00001515 fprintf(stderr, "Project has no ID\n");
1516 }
1517 }
Daniel Veillard60979bd2000-07-10 12:17:33 +00001518 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
1519 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1520 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
1521 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1522 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
1523 ret-&gt;contact = parsePerson(doc, ns, cur);
1524 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00001525 }
1526
1527 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00001528}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +00001529
Daniel Veillardec70e912001-02-26 20:10:45 +00001530<p>Once you are used to it, writing this kind of code is quite simple, but
1531boring. Ultimately, it could be possble to write stubbers taking either C data
1532structure definitions, a set of XML examples or an XML DTD and produce the
1533code needed to import and export the content between C data and XML storage.
1534This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001535
Daniel Veillard6f0adb52000-07-03 11:41:26 +00001536<p>Feel free to use <a href="example/gjobread.c">the code for the full C
1537parsing example</a> as a template, it is also available with Makefile in the
1538Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001539
Daniel Veillardc310d562000-06-23 18:32:15 +00001540<h2><a name="Contributi">Contributions</a></h2>
1541<ul>
Daniel Veillard851c59c2000-11-24 16:06:22 +00001542 <li><a href="mailto:ari@lusis.org">Ari Johnson</a> provides a C++ wrapper
Daniel Veillardc310d562000-06-23 18:32:15 +00001543 for libxml:
1544 <p>Website: <a
1545 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
1546 <p>Download: <a
1547 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
1548 </li>
1549 <li><a href="mailto:doolin@cs.utk.edu">David Doolin</a> provides a
1550 precompiled Windows version
1551 <p><a
1552 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
1553 </li>
Daniel Veillarde356c282001-03-10 12:32:04 +00001554 <li><a
1555 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
1556 Sergeant</a> developped <a
1557 href="http://axkit.org/download/">XML::LibXSLT</a>, a perl wrapper for
1558 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
1559 application server</a></li>
Daniel Veillardca989762001-06-23 17:39:29 +00001560 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and
1561 <a href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
1562 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00001563 documentation</li>
Daniel Veillardc310d562000-06-23 18:32:15 +00001564 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
1565 href="http://xmlsoft.org/messages/0488.html">man pages</a> (not yet
1566 integrated in the distribution)</li>
1567</ul>
1568
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001569<p></p>
1570
Daniel Veillard33a67802001-03-07 09:44:02 +00001571<p><a href="mailto:Daniel.Veillard@imag.fr">Daniel Veillard</a></p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001572
Daniel Veillardca989762001-06-23 17:39:29 +00001573<p>$Id: xml.html,v 1.89 2001/06/22 16:03:51 veillard Exp $</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00001574</body>
1575</html>