blob: a46a1c96d0082e2765ba75cb0c156ac73a368dbd [file] [log] [blame]
Daniel Veillardccb09631998-10-27 06:21:04 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
Daniel Veillardb05deb71999-08-10 19:04:08 +00002 "http://www.w3.org/TR/REC-html40/loose.dtd">
Daniel Veillardccb09631998-10-27 06:21:04 +00003<html>
4<head>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005 <title>The XML library for Gnome</title>
Daniel Veillard94e90602000-07-17 14:38:19 +00006 <meta name="GENERATOR" content="amaya V3.2.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"
13alt="W3C Logo"></a></p>
Daniel Veillardec303412000-03-24 13:41:54 +000014
Daniel Veillardccb09631998-10-27 06:21:04 +000015<h1 align="center">The XML library for Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +000016
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000017<h2 style="text-align: center">libxml, a.k.a. gnome-xml</h2>
18
19<p></p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000020<ul>
21 <li><a href="#Introducti">Introduction</a></li>
22 <li><a href="#Documentat">Documentation</a></li>
Daniel Veillard10a2c651999-12-12 13:03:50 +000023 <li><a href="#Downloads">Downloads</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000024 <li><a href="#News">News</a></li>
25 <li><a href="#XML">XML</a></li>
26 <li><a href="#tree">The tree output</a></li>
27 <li><a href="#interface">The SAX interface</a></li>
28 <li><a href="#library">The XML library interfaces</a>
29 <ul>
Daniel Veillard0142b842000-01-14 14:45:24 +000030 <li><a href="#Invoking">Invoking the parser: the pull way</a></li>
31 <li><a href="#Invoking">Invoking the parser: the push way</a></li>
32 <li><a href="#Invoking2">Invoking the parser: the SAX interface</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000033 <li><a href="#Building">Building a tree from scratch</a></li>
34 <li><a href="#Traversing">Traversing the tree</a></li>
35 <li><a href="#Modifying">Modifying the tree</a></li>
36 <li><a href="#Saving">Saving the tree</a></li>
37 <li><a href="#Compressio">Compression</a></li>
38 </ul>
39 </li>
40 <li><a href="#Entities">Entities or no entities</a></li>
41 <li><a href="#Namespaces">Namespaces</a></li>
42 <li><a href="#Validation">Validation</a></li>
43 <li><a href="#Principles">DOM principles</a></li>
44 <li><a href="#real">A real example</a></li>
Daniel Veillardc310d562000-06-23 18:32:15 +000045 <li><a href="#Contributi">Contribution</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000046</ul>
47
48<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000049
Daniel Veillardf13e1ed2000-03-06 07:41:49 +000050<p>This document describes libxml, the <a
51href="http://www.w3.org/XML/">XML</a> library provided in the <a
52href="http://www.gnome.org/">Gnome</a> framework. XML is a standard for
53building tag-based structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +000054
Daniel Veillard0142b842000-01-14 14:45:24 +000055<p>Here are some key points about libxml:</p>
56<ul>
Daniel Veillard6f0adb52000-07-03 11:41:26 +000057 <li>It is written in plain C, making as few assumptions as possible and
58 sticking closely to ANSI C for easy embedding.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +000059 <li>The internal document repesentation is as close as possible to the <a
60 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
61 <li>Libxml also has a <a href="http://www.megginson.com/SAX/index.html">SAX
Daniel Veillard402e8c82000-02-29 22:57:47 +000062 like interface</a>; the interface is designed to be compatible with <a
63 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillard88f00ae2000-03-02 00:15:55 +000064 <li>Libxml now includes a nearly complete <a
Daniel Veillard0142b842000-01-14 14:45:24 +000065 href="http://www.w3.org/TR/xpath">XPath</a> implementation.</li>
Daniel Veillard402e8c82000-02-29 22:57:47 +000066 <li>Libxml exports Push and Pull type parser interfaces for both XML and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +000067 HTML.</li>
Daniel Veillardec303412000-03-24 13:41:54 +000068 <li>This library is released both under the <a
69 href="http://www.w3.org/Consortium/Legal/copyright-software-19980720.html">W3C
70 IPR</a> and the GNU LGPL. Use either at your convenience, basically this
71 should make everybody happy, if not, drop me a mail.</li>
Daniel Veillardc310d562000-06-23 18:32:15 +000072 <li>There is <a href="upgrade.html">a first set of instructions</a>
Daniel Veillardedfb29b2000-03-14 19:59:05 +000073 concerning upgrade from libxml-1.x to libxml-2.x</li>
Daniel Veillard0142b842000-01-14 14:45:24 +000074</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +000075
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000076<h2><a name="Documentat">Documentation</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +000077
Daniel Veillard402e8c82000-02-29 22:57:47 +000078<p>There are some on-line resources about using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +000079<ol>
Daniel Veillard365e13b2000-07-02 07:56:37 +000080 <li>Check the <a href="FAQ.html">FAQ</a></li>
Daniel Veillardc19fccc2000-07-03 11:52:01 +000081 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
Daniel Veillard365e13b2000-07-02 07:56:37 +000082 documentation</a> automatically extracted from code comments.</li>
Daniel Veillard8d869642000-07-14 12:12:59 +000083 <li>Look at the documentation about <a href="encoding.html">libxml
84 internationalization support</a></li>
Daniel Veillard0142b842000-01-14 14:45:24 +000085 <li>This page provides a global overview and <a href="#real">some
Daniel Veillard402e8c82000-02-29 22:57:47 +000086 examples</a> on how to use libxml.</li>
87 <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
88 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
89 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +000090 <li>George Lebl wrote <a
91 href="http://www-4.ibm.com/software/developer/library/gnome3/">an article
Daniel Veillard402e8c82000-02-29 22:57:47 +000092 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +000093 <li>It is also a good idea to check to <a href="mailto:raph@levien.com">Raph
94 Levien</a> <a href="http://levien.com/gnome/">web site</a> since he is
95 building the <a href="http://levien.com/gnome/gdome.html">DOM interface
Daniel Veillard402e8c82000-02-29 22:57:47 +000096 gdome</a> on top of libxml result tree and an implementation of <a
Daniel Veillard0142b842000-01-14 14:45:24 +000097 href="http://www.w3.org/Graphics/SVG/">SVG</a> called <a
98 href="http://www.levien.com/svg/">gill</a>. Check his <a
99 href="http://www.levien.com/gnome/domination.html">DOMination
100 paper</a>.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000101 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
102 file</a></li>
103 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are
104 starting a new project using libxml you should really use the 2.x
105 version.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000106 <li>And don't forget to look at the <a href="/messages/">mailing-list
Daniel Veillardc310d562000-06-23 18:32:15 +0000107 archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000108</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000109
Daniel Veillard0142b842000-01-14 14:45:24 +0000110<h3>Reporting bugs and getting help</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000111
Daniel Veillard402e8c82000-02-29 22:57:47 +0000112<p>Well, bugs or missing features are always possible, and I will make a point
113of fixing them in a timely fashion. The best way to report a bug is to <a
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000114href="http://bugs.gnome.org/db/pa/lgnome-xml.html">use the Gnome bug tracking
Daniel Veillard402e8c82000-02-29 22:57:47 +0000115database</a>. I look at reports there regularly and it's good to have a
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000116reminder when a bug is still open. Check the <a
117href="http://bugs.gnome.org/Reporting.html">instructions on reporting bugs</a>
Daniel Veillard402e8c82000-02-29 22:57:47 +0000118and be sure to specify that the bug is for the package gnome-xml.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000119
Daniel Veillard0142b842000-01-14 14:45:24 +0000120<p>There is also a mailing-list <a
121href="mailto:xml@rufus.w3.org">xml@rufus.w3.org</a> for libxml, with an <a
122href="http://xmlsoft.org/messages">on-line archive</a>. To subscribe to this
Daniel Veillard402e8c82000-02-29 22:57:47 +0000123majordomo based list, send a mail message to <a
Daniel Veillard0142b842000-01-14 14:45:24 +0000124href="mailto:majordomo@rufus.w3.org">majordomo@rufus.w3.org</a> with
125"subscribe xml" in the <strong>content</strong> of the message.</p>
126
Daniel Veillard402e8c82000-02-29 22:57:47 +0000127<p>Alternatively, you can just send the bug to the <a
Daniel Veillard10a2c651999-12-12 13:03:50 +0000128href="mailto:xml@rufus.w3.org">xml@rufus.w3.org</a> list.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000129
Daniel Veillardec303412000-03-24 13:41:54 +0000130<p>Of course, bugs reports with a suggested patch for fixing them will
131probably be processed faster.</p>
132
133<p>If you're looking for help, a quick look at <a
134href="http://xmlsoft.org/messages/#407">the list archive</a> may actually
135provide the answer, I usually send source samples when answering libxml usage
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000136questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated
Daniel Veillardec303412000-03-24 13:41:54 +0000137documentantion</a> is not as polished as I would like (i need to learn more
138about Docbook), but it's a good starting point.</p>
139
Daniel Veillard10a2c651999-12-12 13:03:50 +0000140<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000141
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000142<p>The latest versions of libxml can be found on <a
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000143href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> or on the <a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000144href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either
Daniel Veillard10a2c651999-12-12 13:03:50 +0000145as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source
Daniel Veillard306be992000-07-03 12:38:45 +0000146archive</a> or <a
147href="ftp://ftp.gnome.org/pub/GNOME/contrib/redhat/SRPMS/">RPM packages</a>.
148(NOTE that you need both the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000149href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
150href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000151packages installed to compile applications using libxml.)</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000152
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000153<p><a name="Snapshot">Snapshot:</a></p>
154<ul>
155 <li>Code from the W3C cvs base libxml <a
156 href="ftp://rpmfind.net/pub/libxml/cvs-snapshot.tar.gz">cvs-snapshot.tar.gz</a></li>
157 <li>Docs, content of the web site, the list archive included <a
158 href="ftp://rpmfind.net/pub/libxml/libxml-docs.tar.gz">libxml-docs.tar.gz</a></li>
159</ul>
160
161<p><a name="Contribs">Contribs:</a></p>
162
163<p>I do accept external contributions, especially if compiling on another
164platform, get in touch with me to upload the package. I will keep them in the
165<a href="ftp://rpmfind.net/pub/libxml/contribs/">contrib directory</a></p>
166
Daniel Veillardc310d562000-06-23 18:32:15 +0000167<p>Libxml is also available from 2 CVS bases:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000168<ul>
169 <li><p>The <a href="http://dev.w3.org/cvsweb/XML/">W3C CVS base</a>,
Daniel Veillard0142b842000-01-14 14:45:24 +0000170 available read-only using the CVS pserver authentification (I tend to use
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000171 this base for my own development, so it's updated more regularly, but the
172 content may not be as stable):</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000173 <pre>CVSROOT=:pserver:anonymous@dev.w3.org:/sources/public
Daniel Veillard365e13b2000-07-02 07:56:37 +0000174 password: anonymous
175 module: XML</pre>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000176 </li>
177 <li><p>The <a
178 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Gnome
Daniel Veillard402e8c82000-02-29 22:57:47 +0000179 CVS base</a>. Check the <a
180 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a> page;
181 the CVS module is <b>gnome-xml</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000182 </li>
183</ul>
184
185<h2><a name="News">News</a></h2>
186
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000187<h3>CVS only : check the <a
188href="http://cvs.gnome.org/lxr/source/gnome-xml/ChangeLog">Changelog</a> file
189for really accurate description</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000190<ul>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000191 <li>working on HTML and XML links recognition layers, get in touch with me
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000192 if you want to test those.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000193</ul>
194
Daniel Veillard94e90602000-07-17 14:38:19 +0000195<h2>2.2.0: July 14 2000</h2>
196<ul>
197 <li>applied a lot of portability fixes</li>
198 <li>better encoding support/cleanup and saving (content is now always
199 encoded in UTF-8)</li>
200 <li>the HTML parser now correctly handles encodings</li>
201 <li>added xmlHasProp()</li>
202 <li>fixed a serious problem with &amp;#38;</li>
203 <li>propagated the fix to FTP client</li>
204 <li>cleanup, bugfixes, etc ...</li>
205 <li>Added a page about <a href="encoding.html">libxml Internationalization
206 support</a></li>
207</ul>
208
Daniel Veillard60979bd2000-07-10 12:17:33 +0000209<h3>1.8.9: July 9 2000</h3>
210<ul>
211 <li>fixed the spec the RPMs should be better</li>
212 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
213 rpmfind users problem</li>
214</ul>
215
Daniel Veillard6388e172000-07-03 16:07:19 +0000216<h3>2.1.1: July 1 2000</h3>
217<ul>
218 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
219 <li>improvements on the HTML parser</li>
220</ul>
221
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000222<h3>2.1.0 and 1.8.8: June 29 2000</h3>
223<ul>
224 <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
225 <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
226 about &amp;#38; charref parsing</li>
227 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
228 also contains numerous fixes and enhancements:
229 <ul>
230 <li>added xmlStopParser() to stop parsing</li>
231 <li>improved a lot parsing speed when there is large CDATA blocs</li>
232 <li>includes XPath patches provided by Picdar Technology</li>
233 <li>tried to fix as much as possible DtD validation and namespace
234 related problems</li>
235 <li>output to a given encoding has been added/tested</li>
236 <li>lot of various fixes</li>
237 </ul>
238 </li>
239</ul>
240
Daniel Veillarde0aed302000-04-16 08:52:20 +0000241<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000242<ul>
243 <li>First public release of libxml2. If you are using libxml, it's a good
Daniel Veillarde0aed302000-04-16 08:52:20 +0000244 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
245 scheduled for Apr 3 the relase occured only on Apr 12 due to massive
246 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000247 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000248 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000249 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000250 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000251 <pre>#include "xxx.h"</pre>
252 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000253 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
254 <li>the memory allocation routines used by libxml can now be overloaded
255 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000256 <li>The previously CVS only tool tester has been renamed
257 <strong>xmllint</strong> and is now installed as part of the libxml2
258 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000259 <li>The I/O interface has been revamped. There is now ways to plug in
260 specific I/O modules, either at the URI scheme detection level using
261 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
262 parser context using xmlCreateIOParserCtxt()</li>
263 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
264 number of the libxml module in use</li>
265 <li>a number of optional features of libxml can now be excluded at configure
266 time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000267</ul>
268
269<h3>2.0.0beta: Mar 14 2000</h3>
270<ul>
271 <li>This is a first Beta release of libxml version 2</li>
272 <li>It's available only from<a href="ftp://rpmfind.net/pub/libxml/">
273 rpmfind.net FTP</a>, it's packaged as libxml2-2.0.0beta and available as
274 tar and RPMs</li>
275 <li>This version is now the head in the Gnome CVS base, the old one is
276 available under the tag LIB_XML_1_X</li>
277 <li>This includes a very large set of changes. Froma programmatic point of
278 view applications should not have to be modified too much, check the <a
279 href="upgrade.html">upgrade page</a></li>
280 <li>Some interfaces may changes (especially a bit about encoding).</li>
281 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000282 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000283 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
284 handled now</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000285 <li>Better handling of entities, especially well formedness checking and
286 proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000287 <li>DTD conditional sections</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000288 <li>Validation now correcly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000289 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
290 structures to accomodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000291 </ul>
292 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000293 <li>Serious progress were made toward compliance, <a
294 href="conf/result.html">here are the result of the test</a> against the
295 OASIS testsuite (except the japanese tests since I don't support that
296 encoding yet). This URL is rebuilt every couple of hours using the CVS
297 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000298</ul>
299
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000300<h3>1.8.7: Mar 6 2000</h3>
301<ul>
302 <li>This is a bug fix release:</li>
303 <li>It is possible to disable the ignorable blanks heuristic used by
304 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
305 that for adherence to XML spec, this behaviour will be disabled by default
306 in 2.x . The same function will allow to keep compatibility for old
307 code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000308 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
309 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000310 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
311 compilation on some platforms has been fixed</li>
312 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
313 URIs</li>
314</ul>
315
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000316<h3>1.8.6: Jan 31 2000</h3>
317<ul>
318 <li>added a nanoFTP transport module, debugged until the new version of <a
319 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
320 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000321</ul>
322
323<h3>1.8.5: Jan 21 2000</h3>
324<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000325 <li>adding APIs to parse a well balanced chunk of XML (production <a
326 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the XML
327 spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000328 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000329 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
330 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000331 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
332 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000333</ul>
334
335<h3>1.8.4: Jan 13 2000</h3>
336<ul>
337 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
338 <li>all exit() call should have been removed from libxml</li>
339 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
340 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000341</ul>
342
343<h3>1.8.3: Jan 5 2000</h3>
344<ul>
345 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000346 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillarddbfd6411999-12-28 16:35:14 +0000347 <li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000348 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000349 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
350 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000351 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000352 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000353 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000354</ul>
355
356<h3>1.8.2: Dec 21 1999</h3>
357<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000358 <li>I got another problem with includes and C++, I hope this issue is fixed
359 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000360 <li>Added a few tree modification functions: xmlReplaceNode,
361 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
362 xmlDocSetRootElement</li>
363 <li>Tried to improve the HTML output with help from <a
364 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000365</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000366
Daniel Veillarde4e51311999-12-18 15:32:46 +0000367<h3>1.8.1: Dec 18 1999</h3>
368<ul>
369 <li>various patches to avoid troubles when using libxml with C++ compilers
370 the "namespace" keyword and C escaping in include files</li>
371 <li>a problem in one of the core macros IS_CHAR was corrected</li>
372 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
373 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000374 <li>fixed a posteriori validation (validation after parsing, or by using a
375 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000376 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000377</ul>
378
379<h3>1.8.0: Dec 12 1999</h3>
380<ul>
381 <li>cleanup, especially memory wise</li>
382 <li>the parser should be more reliable, especially the HTML one, it should
383 not crash, whatever the input !</li>
384 <li>Integrated various patches, especially a speedup improvement for large
385 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
386 configure with --with-buffers to enable them.</li>
387 <li>attribute normalization, oops should have been added long ago !</li>
388 <li>attributes defaulted from Dtds should be available, xmlSetProp() now
389 does entities escapting by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000390</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000391
392<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000393<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000394 <li>Lots of HTML improvement</li>
395 <li>Fixed some errors when saving both XML and HTML</li>
396 <li>More examples, the regression tests should now look clean</li>
397 <li>Fixed a bug with contiguous charref</li>
398</ul>
399
400<h3>1.7.3: Sep 29 1999</h3>
401<ul>
402 <li>portability problems fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000403 <li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000404 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000405</ul>
406
407<h3>1.7.1: Sep 24 1999</h3>
408<ul>
409 <li>The basic type for strings manipulated by libxml has been renamed in
410 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
411 is that CHAR was conflicting with a predefined type on Windows. However on
412 non WIN32 environment, compatibility is provided by the way of a
413 <strong>#define </strong>.</li>
414 <li>Changed another error : the use of a structure field called errno, and
415 leading to troubles on platforms where it's a macro</li>
416</ul>
417
418<h3>1.7.0: sep 23 1999</h3>
419<ul>
420 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000421 href="html/gnome-xml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000422 <li>Added an errno to report errors by another mean than a simple printf
423 like callback</li>
424 <li>Finished ID/IDREF support and checking when validation</li>
425 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000426 href="html/gnome-xml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000427 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
428 implementation</li>
429 <li>Added an HTML parser front-end</li>
430</ul>
431
432<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000433
Daniel Veillard402e8c82000-02-29 22:57:47 +0000434<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000435markup-based structured documents. Here is <a name="example">an example XML
436document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000437<pre>&lt;?xml version="1.0"?&gt;
438&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
439 &lt;head&gt;
440 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
441 &lt;/head&gt;
442 &lt;chapter&gt;
443 &lt;title&gt;The Linux adventure&lt;/title&gt;
444 &lt;p&gt;bla bla bla ...&lt;/p&gt;
445 &lt;image href="linus.gif"/&gt;
446 &lt;p&gt;...&lt;/p&gt;
447 &lt;/chapter&gt;
448&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000449
Daniel Veillard402e8c82000-02-29 22:57:47 +0000450<p>The first line specifies that it's an XML document and gives useful
451information about its encoding. Then the document is a text format whose
452structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000453to be closed</strong>. XML is pedantic about this. However, if a tag is empty
454(no content), a single tag can serve as both the opening and closing tag if it
Daniel Veillard60979bd2000-07-10 12:17:33 +0000455ends with <code>/&gt;</code> rather than with <code>&gt;</code>. Note that,
456for example, the image tag has no content (just an attribute) and is closed by
457ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000458
Daniel Veillard402e8c82000-02-29 22:57:47 +0000459<p>XML can be applied sucessfully to a wide range of uses, from long term
460structured document maintenance (where it follows the steps of SGML) to simple
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000461data encoding mechanisms like configuration file formatting (glade),
462spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
463it is used to encode remote calls between a client and a server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000464
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000465<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000466
467<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000468returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000469<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000470as the file name, the document type, and a <strong>children</strong> pointer
471which is the root of the document (or more exactly the first child under the
472root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard60979bd2000-07-10 12:17:33 +0000473chained in double-linked lists of siblings and with children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000474relationship. An xmlNode can also carry properties (a chain of xmlAttr
475structures). An attribute may have a value which is a list of TEXT or
476ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000477
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000478<p>Here is an example (erroneous with respect to the XML spec since there
479should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000480
481<p><img src="structure.gif" alt=" structure.gif "></p>
482
483<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000484called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000485prints them back as parsed. This is useful for detecting errors both in XML
486code and in the XML parser itself. It has an option <strong>--debug</strong>
487which prints the actual in-memory structure of the document, here is the
488result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000489<pre>DOCUMENT
490version=1.0
491standalone=true
492 ELEMENT EXAMPLE
493 ATTRIBUTE prop1
494 TEXT
495 content=gnome is great
496 ATTRIBUTE prop2
497 ENTITY_REF
498 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000499 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000500 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000501 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000502 TEXT
503 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000504 ELEMENT chapter
505 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000506 TEXT
507 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000508 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000509 TEXT
510 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000511 ELEMENT image
512 ATTRIBUTE href
513 TEXT
514 content=linus.gif
515 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000516 TEXT
517 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000518
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000519<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000520
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000521<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000522
Daniel Veillard402e8c82000-02-29 22:57:47 +0000523<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000524memory. In that case (and if you don't expect to save back the XML document
525loaded using libxml), it's better to use the SAX interface of libxml. SAX is a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000526<strong>callback-based interface</strong> to the parser. Before parsing, the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000527application layer registers a customized set of callbacks which are called by
528the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000529
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000530<p>To get more detailed step-by-step guidance on using the SAX interface of
531libxml, see the
Daniel Veillard60979bd2000-07-10 12:17:33 +0000532href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html"&gt;nice
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000533documentation.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000534Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000535
536<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
537program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000538binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000539distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000540testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000541<pre>SAX.setDocumentLocator()
542SAX.startDocument()
543SAX.getEntity(amp)
544SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
545SAX.characters( , 3)
546SAX.startElement(head)
547SAX.characters( , 4)
548SAX.startElement(title)
549SAX.characters(Welcome to Gnome, 16)
550SAX.endElement(title)
551SAX.characters( , 3)
552SAX.endElement(head)
553SAX.characters( , 3)
554SAX.startElement(chapter)
555SAX.characters( , 4)
556SAX.startElement(title)
557SAX.characters(The Linux adventure, 19)
558SAX.endElement(title)
559SAX.characters( , 4)
560SAX.startElement(p)
561SAX.characters(bla bla bla ..., 15)
562SAX.endElement(p)
563SAX.characters( , 4)
564SAX.startElement(image, href='linus.gif')
565SAX.endElement(image)
566SAX.characters( , 4)
567SAX.startElement(p)
568SAX.characters(..., 3)
569SAX.endElement(p)
570SAX.characters( , 3)
571SAX.endElement(chapter)
572SAX.characters( , 1)
573SAX.endElement(EXAMPLE)
574SAX.endDocument()</pre>
575
Daniel Veillard402e8c82000-02-29 22:57:47 +0000576<p>Most of the other functionalities of libxml are based on the DOM
577tree-building facility, so nearly everything up to the end of this document
578presupposes the use of the standard DOM tree build. Note that the DOM tree
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000579itself is built by a set of registered default callbacks, without internal
580specific interface.</p>
581
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000582<h2><a name="library">The XML library interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000583
584<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000585using the XML library from the C language. It is not intended to be extensive.
586I hope the automatically generated documents will provide the completeness
587required, but as a separate set of documents. The interfaces of the XML
588library are by principle low level, there is nearly zero abstraction. Those
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000589interested in a higher level API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000590
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000591<p>The <a href="html/gnome-xml-parser.html">parser interfaces for XML</a> are
592separated from the <a href="html/gnome-xml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000593interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000594
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000595<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000596
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000597<p>Usually, the first thing to do is to read an XML input. The parser accepts
598documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000599defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000600<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000601 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000602 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000603 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000604</dl>
605<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000606 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000607 <dd><p>Parse an XML document contained in a (possibly compressed)
608 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000609 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000610</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000611
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000612<p>The parser returns a pointer to the document structure (or NULL in case of
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000613failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000614
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000615<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000616
617<p>In order for the application to keep the control when the document is been
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000618fetched (which is common for GUI based programs) libxml provides a push
619interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000620<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
621 void *user_data,
622 const char *chunk,
623 int size,
624 const char *filename);
625int xmlParseChunk (xmlParserCtxtPtr ctxt,
626 const char *chunk,
627 int size,
628 int terminate);</pre>
629
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000630<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000631<pre> FILE *f;
632
633 f = fopen(filename, "r");
634 if (f != NULL) {
635 int res, size = 1024;
636 char chars[1024];
637 xmlParserCtxtPtr ctxt;
638
639 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000640 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000641 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
642 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000643 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000644 xmlParseChunk(ctxt, chars, res, 0);
645 }
646 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000647 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000648 xmlFreeParserCtxt(ctxt);
649 }
650 }</pre>
651
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000652<p>Also note that the HTML parser embedded into libxml also has a push
653interface; the functions are just prefixed by "html" rather than "xml"</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000654
655<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
656
Daniel Veillardb05deb71999-08-10 19:04:08 +0000657<p>A couple of comments can be made, first this mean that the parser is
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000658memory-hungry, first to load the document in memory, second to build the tree.
Daniel Veillard0142b842000-01-14 14:45:24 +0000659Reading a document without building the tree is possible using the SAX
660interfaces (see SAX.h and <a
661href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000662Henstridge's documentation</a>). Note also that the push interface can be
663limited to SAX. Just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +0000664<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000665
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000666<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000667
668<p>The other way to get an XML tree in memory is by building it. Basically
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000669there is a set of functions dedicated to building new elements. (These are
Daniel Veillard60979bd2000-07-10 12:17:33 +0000670also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of code
Daniel Veillard361d8452000-04-03 19:48:13 +0000671that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000672<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000673 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000674 xmlNodePtr tree, subtree;
675
676 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000677 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
678 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
679 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
680 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000681 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000682 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000683 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
684 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
685 subtree = xmlNewChild(tree, NULL, "image", NULL);
686 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000687
688<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000689
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000690<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000691
Daniel Veillard306be992000-07-03 12:38:45 +0000692<p>Basically by <a href="html/gnome-xml-tree.html">including "tree.h"</a> your
693code has access to the internal structure of all the elements of the tree. The
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000694names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +0000695<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000696<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +0000697example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000698<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000699
700<p>points to the title element,</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000701<pre>doc-&gt;children-&gt;children-&gt;next-&gt;child-&gt;child</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000702
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000703<p>points to the text node containing the chapter title "The Linux
704adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000705
Daniel Veillardb24054a1999-12-18 15:32:46 +0000706<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
Daniel Veillard60979bd2000-07-10 12:17:33 +0000707present before the document root, so <code>doc-&gt;children</code> may point
708to an element which is not the document Root Element, a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000709<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000710
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000711<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000712
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000713<p>Functions are provided for reading and writing the document content. Here
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000714is an excerpt from the <a href="html/gnome-xml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000715<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000716 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
717 xmlChar *value);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000718 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node. The
719 value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000720 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000721</dl>
722<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000723 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000724 *name);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000725 <dd><p>This function returns a pointer to the property content. Note that
726 no extra copy is made.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000727 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000728</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000729
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000730<p>Two functions are provided for reading and writing the text associated with
Daniel Veillard25940b71998-10-29 05:51:30 +0000731elements:</p>
732<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000733 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000734 *value);</code></dt>
735 <dd><p>This function takes an "external" string and convert it to one text
736 node or possibly to a list of entity and text nodes. All non-predefined
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000737 entity references like &amp;Gnome; will be stored internally as entity
738 nodes, hence the result of the function may not be a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000739 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000740</dl>
741<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000742 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000743 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000744 <dd><p>This function is the inverse of
745 <code>xmlStringGetNodeList()</code>. It generates a new string
746 containing the content of the text and entity nodes. Note the extra
747 argument inLine. If this argument is set to 1, the function will expand
748 entity references. For example, instead of returning the &amp;Gnome;
749 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000750 "GNU Network Object Model Environment"). Set this argument if you want
751 to use the string for non-XML usage like User Interface.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000752 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000753</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000754
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000755<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000756
757<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000758<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000759 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000760 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000761 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000762 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000763</dl>
764<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000765 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000766 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000767 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000768</dl>
769<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000770 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000771 <dd><p>Saves the document to a file. In this case, the compression
772 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000773 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000774</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000775
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000776<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000777
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000778<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000779accesses. The level of compression on saves can be turned on either globally
780or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000781<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000782 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000783 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000784 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000785</dl>
786<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000787 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000788 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000789 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000790</dl>
791<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000792 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000793 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000794 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000795</dl>
796<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000797 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000798 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000799 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000800</dl>
801
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000802<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000803
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000804<p>Entities in principle are similar to simple C macros. An entity defines an
805abbreviation for a given string that you can reuse many times throughout the
806content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000807may occur frequently within a document, or to confine the change needed to a
808document to a restricted area in the internal subset of the document (at the
809beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000810<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00008112 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +00008123 &lt;!ENTITY xml "Extensible Markup Language"&gt;
8134 ]&gt;
8145 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00008156 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +00008167 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000817
818<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000819it's name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000820are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000821predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000822<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000823for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000824<strong>&amp;quot;</strong> for the character '"', and
825<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000826
827<p>One of the problems related to entities is that you may want the parser to
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000828substitute an entity's content so that you can see the replacement text in
829your application. Or you may prefer to keep entity references as such in the
830content to be able to save the document back without losing this usually
831precious information (if the user went through the pain of explicitly defining
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000832entities, he may have a a rather negative attitude if you blindly susbtitute
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000833them as saving time). The <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000834href="html/gnome-xml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000835function allows you to check and change the behaviour, which is to not
836substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000837
838<p>Here is the DOM tree built by libxml for the previous document in the
839default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000840<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000841DOCUMENT
842version=1.0
843 ELEMENT EXAMPLE
844 TEXT
845 content=
846 ENTITY_REF
847 INTERNAL_GENERAL_ENTITY xml
848 content=Extensible Markup Language
849 TEXT
850 content=</pre>
851
852<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000853<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000854DOCUMENT
855version=1.0
856 ELEMENT EXAMPLE
857 TEXT
858 content= Extensible Markup Language</pre>
859
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000860<p>So, entities or no entities? Basically, it depends on your use case. I
861suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000862entities in your XML document or data if you are not willing to handle the
863entity references elements in the DOM tree.</p>
864
865<p>Note that at save time libxml enforce the conversion of the predefined
866entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000867transparently replace those with chars (i.e., it will not generate entity
868reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000869finding them in the input).</p>
870
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000871<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000872
Daniel Veillardec303412000-03-24 13:41:54 +0000873<p>The libxml library implements <a
874href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
875recognizing namespace contructs in the input, and does namespace lookup
876automatically when building the DOM tree. A namespace declaration is
877associated with an in-memory structure and all elements or attributes within
878that namespace point to it. Hence testing the namespace is a simple and fast
879equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000880
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000881<p>I suggest that people using libxml use a namespace, and declare it in the
882root element of their document as the default namespace. Then they don't need
883to use the prefix in the content but we will have a basis for future semantic
884refinement and merging of data from different sources. This doesn't augment
885significantly the size of the XML output, but significantly increase its value
Daniel Veillardec303412000-03-24 13:41:54 +0000886in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000887<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
888 &lt;elem1&gt;...&lt;/elem1&gt;
889 &lt;elem2&gt;...&lt;/elem2&gt;
890&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000891
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000892<p>Concerning the namespace value, this has to be an URL, but the URL doesn't
Daniel Veillardec303412000-03-24 13:41:54 +0000893have to point to any existing resource on the Web. It will bind all the
894element and atributes with that URL. I suggest to use an URL within a domain
895you control, and that the URL should contain some kind of version information
896if possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is
Daniel Veillard361d8452000-04-03 19:48:13 +0000897a good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000898
899<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000900version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000901and if the version information don't match something you know, warn the user
902and be liberal in what you accept as the input. Also do *not* try to base
Daniel Veillard60979bd2000-07-10 12:17:33 +0000903namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
904same as &lt;bar:text&gt; in another document. What really matter is the URI
905associated with the element or the attribute, not the prefix string (which is
906just a shortcut for the full URI). In libxml element and attributes have a
Daniel Veillardec303412000-03-24 13:41:54 +0000907<code>ns</code> field pointing to an xmlNs structure detailing the namespace
908prefix and it's URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000909
910<p>@@Interfaces@@</p>
911
912<p>@@Examples@@</p>
913
914<p>Usually people object using namespace in the case of validation, I object
915this and will make sure that using namespaces won't break validity checking,
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000916so even is you plan to use or currently are using validation I strongly
917suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000918<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000919flexible parsers. Now using namespace to mix and differentiate content coming
920from multiple DTDs will certainly break current validation schemes. I will try
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000921to provide ways to do this, but this may not be portable or standardized.</p>
922
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000923<h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000924
925<p>Well what is validation and what is a DTD ?</p>
926
927<p>Validation is the process of checking a document against a set of
928construction rules, a <strong>DTD</strong> (Document Type Definition) is such
929a set of rules.</p>
930
931<p>The validation process and building DTDs are the two most difficult parts
932of XML life cycle. Briefly a DTD defines all the possibles element to be
933found within your document, what is the formal shape of your document tree (by
934defining the allowed content of an element, either text, a regular expression
Daniel Veillard306be992000-07-03 12:38:45 +0000935for the allowed list of children, or mixed content i.e. both text and
936children). The DTD also defines the allowed attributes for all elements and
937the types of the attributes. For more detailed informations, I suggest to read
938the related parts of the XML specification, the examples found under
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000939gnome-xml/test/valid/dtd and the large amount of books available on XML. The
940dia example in gnome-xml/test/valid should be both simple and complete enough
941to allow you to build your own.</p>
942
943<p>A word of warning, building a good DTD which will fit your needs of your
944application in the long-term is far from trivial, however the extra level of
945quality it can insure is well worth the price for some sets of applications or
946if you already have already a DTD defined for your application field.</p>
947
948<p>The validation is not completely finished but in a (very IMHO) usable
949state. Until a real validation interface is defined the way to do it is to
950define and set the <strong>xmlDoValidityCheckingDefaultValue</strong> external
951variable to 1, this will of course be changed at some point:</p>
952
953<p>extern int xmlDoValidityCheckingDefaultValue;</p>
954
955<p>...</p>
956
957<p>xmlDoValidityCheckingDefaultValue = 1;</p>
958
959<p></p>
960
961<p>To handle external entities, use the function
962<strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to
963link in you HTTP/FTP/Entities database library to the standard libxml
964core.</p>
965
966<p>@@interfaces@@</p>
967
Daniel Veillard35008381999-10-25 13:15:52 +0000968<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000969
970<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document Object
Daniel Veillardccb09631998-10-27 06:21:04 +0000971Model</em> this is an API for accessing XML or HTML structured documents.
972Native support for DOM in Gnome is on the way (module gnome-dom), and it will
Daniel Veillard25940b71998-10-29 05:51:30 +0000973be based on gnome-xml. This will be a far cleaner interface to manipulate XML
Daniel Veillardc08a2c61999-09-08 21:35:25 +0000974files within Gnome since it won't expose the internal structure. DOM defines a
Daniel Veillard25940b71998-10-29 05:51:30 +0000975set of IDL (or Java) interfaces allowing to traverse and manipulate a
976document. The DOM library will allow accessing and modifying "live" documents
977presents on other programs like this:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000978
979<p><img src="DOM.gif" alt=" DOM.gif "></p>
980
981<p>This should help greatly doing things like modifying a gnumeric spreadsheet
Daniel Veillardccb09631998-10-27 06:21:04 +0000982embedded in a GWP document for example.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000983
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000984<p>The current DOM implementation on top of libxml is the <a
985href="http://cvs.gnome.org/lxr/source/gdome/">gdome Gnome module</a>, this is
986a full DOM interface, thanks to <a href="mailto:raph@levien.com">Raph
987Levien</a>.</p>
988
989<p>The gnome-dom module in the Gnome CVS base is obsolete</p>
990
Daniel Veillard35008381999-10-25 13:15:52 +0000991<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000992
993<p>Here is a real size example, where the actual content of the application
994data is not kept in the DOM tree but uses internal structures. It is based on
Daniel Veillard14fff061999-06-22 21:49:07 +0000995a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +0000996storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
997base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000998<pre>&lt;?xml version="1.0"?&gt;
999&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
1000 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001001
Daniel Veillard60979bd2000-07-10 12:17:33 +00001002 &lt;gjob:Job&gt;
1003 &lt;gjob:Project ID="3"/&gt;
1004 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
1005 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001006
Daniel Veillard60979bd2000-07-10 12:17:33 +00001007 &lt;gjob:Update&gt;
1008 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
1009 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
1010 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
1011 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001012
Daniel Veillard60979bd2000-07-10 12:17:33 +00001013 &lt;gjob:Developers&gt;
1014 &lt;gjob:Developer&gt;
1015 &lt;/gjob:Developer&gt;
1016 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001017
Daniel Veillard60979bd2000-07-10 12:17:33 +00001018 &lt;gjob:Contact&gt;
1019 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
1020 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
1021 &lt;gjob:Company&gt;
1022 &lt;/gjob:Company&gt;
1023 &lt;gjob:Organisation&gt;
1024 &lt;/gjob:Organisation&gt;
1025 &lt;gjob:Webpage&gt;
1026 &lt;/gjob:Webpage&gt;
1027 &lt;gjob:Snailmail&gt;
1028 &lt;/gjob:Snailmail&gt;
1029 &lt;gjob:Phone&gt;
1030 &lt;/gjob:Phone&gt;
1031 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001032
Daniel Veillard60979bd2000-07-10 12:17:33 +00001033 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001034 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +00001035 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001036
Daniel Veillard60979bd2000-07-10 12:17:33 +00001037 &lt;gjob:Skills&gt;
1038 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001039
Daniel Veillard60979bd2000-07-10 12:17:33 +00001040 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001041 A GNOME based system that will allow a superuser to configure
1042 compressed and uncompressed files and/or file systems to be backed
1043 up with a supported media in the system. This should be able to
1044 perform via find commands generating a list of files that are passed
1045 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
1046 or via operations performed on the filesystem itself. Email
1047 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +00001048 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001049
Daniel Veillard60979bd2000-07-10 12:17:33 +00001050 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001051
Daniel Veillard60979bd2000-07-10 12:17:33 +00001052 &lt;/gjob:Jobs&gt;
1053&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001054
1055<p>While loading the XML file into an internal DOM tree is a matter of calling
1056only a couple of functions, browsing the tree to gather the informations and
1057generate the internals structures is harder, and more error prone.</p>
1058
1059<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001060structure. For example, the ordering of the attributes is not significant,
1061Cthe XML specification is clear about it. It's also usually a good idea to not
Daniel Veillard306be992000-07-03 12:38:45 +00001062be dependent of the orders of the children of a given node, unless it really
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001063makes things harder. Here is some code to parse the informations for a
1064person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001065<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +00001066 * A person record
1067 */
1068typedef struct person {
1069 char *name;
1070 char *email;
1071 char *company;
1072 char *organisation;
1073 char *smail;
1074 char *webPage;
1075 char *phone;
1076} person, *personPtr;
1077
1078/*
1079 * And the code needed to parse it
1080 */
1081personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1082 personPtr ret = NULL;
1083
1084DEBUG("parsePerson\n");
1085 /*
1086 * allocate the struct
1087 */
1088 ret = (personPtr) malloc(sizeof(person));
1089 if (ret == NULL) {
1090 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00001091 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00001092 }
1093 memset(ret, 0, sizeof(person));
1094
1095 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00001096 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00001097 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +00001098 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
1099 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1100 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
1101 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1102 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00001103 }
1104
1105 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00001106}</pre>
1107
1108<p>Here is a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00001109<ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001110 <li>Usually a recursive parsing style is the more convenient one, XML data
1111 being by nature subject to repetitive constructs and usualy exibit highly
1112 stuctured patterns.</li>
1113 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>, i.e.
1114 the pointer to the global XML document and the namespace reserved to the
1115 application. Document wide information are needed for example to decode
1116 entities and it's a good coding practice to define a namespace for your
1117 application set of data and test that the element and attributes you're
1118 analyzing actually pertains to your application space. This is done by a
Daniel Veillard60979bd2000-07-10 12:17:33 +00001119 simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001120 <li>To retrieve text and attributes value, it is suggested to use the
1121 function <em>xmlNodeListGetString</em> to gather all the text and entity
1122 reference nodes generated by the DOM output and produce an single text
1123 string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +00001124</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001125
1126<p>Here is another piece of code used to parse another level of the
1127structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001128<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00001129/*
Daniel Veillard14fff061999-06-22 21:49:07 +00001130 * a Description for a Job
1131 */
1132typedef struct job {
1133 char *projectID;
1134 char *application;
1135 char *category;
1136 personPtr contact;
1137 int nbDevelopers;
1138 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
1139} job, *jobPtr;
1140
1141/*
1142 * And the code needed to parse it
1143 */
1144jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1145 jobPtr ret = NULL;
1146
1147DEBUG("parseJob\n");
1148 /*
1149 * allocate the struct
1150 */
1151 ret = (jobPtr) malloc(sizeof(job));
1152 if (ret == NULL) {
1153 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00001154 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00001155 }
1156 memset(ret, 0, sizeof(job));
1157
1158 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00001159 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00001160 while (cur != NULL) {
1161
Daniel Veillard60979bd2000-07-10 12:17:33 +00001162 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
1163 ret-&gt;projectID = xmlGetProp(cur, "ID");
1164 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +00001165 fprintf(stderr, "Project has no ID\n");
1166 }
1167 }
Daniel Veillard60979bd2000-07-10 12:17:33 +00001168 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
1169 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1170 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
1171 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1172 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
1173 ret-&gt;contact = parsePerson(doc, ns, cur);
1174 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00001175 }
1176
1177 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00001178}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +00001179
Daniel Veillardb05deb71999-08-10 19:04:08 +00001180<p>One can notice that once used to it, writing this kind of code is quite
1181simple, but boring. Ultimately, it could be possble to write stubbers taking
1182either C data structure definitions, a set of XML examples or an XML DTD and
1183produce the code needed to import and export the content between C data and
1184XML storage. This is left as an exercise to the reader :-)</p>
1185
Daniel Veillard6f0adb52000-07-03 11:41:26 +00001186<p>Feel free to use <a href="example/gjobread.c">the code for the full C
1187parsing example</a> as a template, it is also available with Makefile in the
1188Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001189
Daniel Veillardc310d562000-06-23 18:32:15 +00001190<h2><a name="Contributi">Contributions</a></h2>
1191<ul>
1192 <li><a href="mailto:ari@btigate.com">Ari Johnson</a> provides a C++ wrapper
1193 for libxml:
1194 <p>Website: <a
1195 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
1196 <p>Download: <a
1197 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
1198 </li>
1199 <li><a href="mailto:doolin@cs.utk.edu">David Doolin</a> provides a
1200 precompiled Windows version
1201 <p><a
1202 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
1203 </li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00001204 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> provided <a
1205 href="libxml-doc.el">an emacs module</a> to lookup libxml functions
1206 documentation</li>
Daniel Veillardc310d562000-06-23 18:32:15 +00001207 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
1208 href="http://xmlsoft.org/messages/0488.html">man pages</a> (not yet
1209 integrated in the distribution)</li>
1210</ul>
1211
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001212<p></p>
1213
1214<p><a href="mailto:Daniel.Veillard@w3.org">Daniel Veillard</a></p>
1215
Daniel Veillard94e90602000-07-17 14:38:19 +00001216<p>$Id: xml.html,v 1.42 2000/07/14 12:12:59 veillard Exp $</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00001217</body>
1218</html>