blob: 0cc44af30a18a7ee7b9f294984d178d8b8fed913 [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 Veillarda2679fa2000-07-22 02:38:15 +00006 <meta name="GENERATOR" content="amaya V3.2">
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 Veillard786d7c82000-08-12 23:38:57 +0000195<h2>2.2.2: August 12 2000</h2>
196<ul>
197 <li>mostly bug fixes</li>
198 <li>started adding routines to access xml parser context options </li>
199</ul>
200
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000201<h2>2.2.1: July 21 2000</h2>
202<ul>
203 <li>a purely bug fixes release</li>
204 <li>fixed an encoding support problem when parsing from a memory block</li>
205 <li>fixed a DOCTYPE parsing problem</li>
206 <li>removed a bug in the function allowing to override the memory allocation
207 routines</li>
208</ul>
209
Daniel Veillard94e90602000-07-17 14:38:19 +0000210<h2>2.2.0: July 14 2000</h2>
211<ul>
212 <li>applied a lot of portability fixes</li>
213 <li>better encoding support/cleanup and saving (content is now always
214 encoded in UTF-8)</li>
215 <li>the HTML parser now correctly handles encodings</li>
216 <li>added xmlHasProp()</li>
217 <li>fixed a serious problem with &amp;#38;</li>
218 <li>propagated the fix to FTP client</li>
219 <li>cleanup, bugfixes, etc ...</li>
220 <li>Added a page about <a href="encoding.html">libxml Internationalization
221 support</a></li>
222</ul>
223
Daniel Veillard60979bd2000-07-10 12:17:33 +0000224<h3>1.8.9: July 9 2000</h3>
225<ul>
226 <li>fixed the spec the RPMs should be better</li>
227 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
228 rpmfind users problem</li>
229</ul>
230
Daniel Veillard6388e172000-07-03 16:07:19 +0000231<h3>2.1.1: July 1 2000</h3>
232<ul>
233 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
234 <li>improvements on the HTML parser</li>
235</ul>
236
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000237<h3>2.1.0 and 1.8.8: June 29 2000</h3>
238<ul>
239 <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
240 <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
241 about &amp;#38; charref parsing</li>
242 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
243 also contains numerous fixes and enhancements:
244 <ul>
245 <li>added xmlStopParser() to stop parsing</li>
246 <li>improved a lot parsing speed when there is large CDATA blocs</li>
247 <li>includes XPath patches provided by Picdar Technology</li>
248 <li>tried to fix as much as possible DtD validation and namespace
249 related problems</li>
250 <li>output to a given encoding has been added/tested</li>
251 <li>lot of various fixes</li>
252 </ul>
253 </li>
254</ul>
255
Daniel Veillarde0aed302000-04-16 08:52:20 +0000256<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000257<ul>
258 <li>First public release of libxml2. If you are using libxml, it's a good
Daniel Veillarde0aed302000-04-16 08:52:20 +0000259 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
260 scheduled for Apr 3 the relase occured only on Apr 12 due to massive
261 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000262 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000263 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000264 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000265 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000266 <pre>#include "xxx.h"</pre>
267 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000268 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
269 <li>the memory allocation routines used by libxml can now be overloaded
270 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000271 <li>The previously CVS only tool tester has been renamed
272 <strong>xmllint</strong> and is now installed as part of the libxml2
273 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000274 <li>The I/O interface has been revamped. There is now ways to plug in
275 specific I/O modules, either at the URI scheme detection level using
276 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
277 parser context using xmlCreateIOParserCtxt()</li>
278 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
279 number of the libxml module in use</li>
280 <li>a number of optional features of libxml can now be excluded at configure
281 time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000282</ul>
283
284<h3>2.0.0beta: Mar 14 2000</h3>
285<ul>
286 <li>This is a first Beta release of libxml version 2</li>
287 <li>It's available only from<a href="ftp://rpmfind.net/pub/libxml/">
288 rpmfind.net FTP</a>, it's packaged as libxml2-2.0.0beta and available as
289 tar and RPMs</li>
290 <li>This version is now the head in the Gnome CVS base, the old one is
291 available under the tag LIB_XML_1_X</li>
292 <li>This includes a very large set of changes. Froma programmatic point of
293 view applications should not have to be modified too much, check the <a
294 href="upgrade.html">upgrade page</a></li>
295 <li>Some interfaces may changes (especially a bit about encoding).</li>
296 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000297 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000298 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
299 handled now</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000300 <li>Better handling of entities, especially well formedness checking and
301 proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000302 <li>DTD conditional sections</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000303 <li>Validation now correcly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000304 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
305 structures to accomodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000306 </ul>
307 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000308 <li>Serious progress were made toward compliance, <a
309 href="conf/result.html">here are the result of the test</a> against the
310 OASIS testsuite (except the japanese tests since I don't support that
311 encoding yet). This URL is rebuilt every couple of hours using the CVS
312 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000313</ul>
314
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000315<h3>1.8.7: Mar 6 2000</h3>
316<ul>
317 <li>This is a bug fix release:</li>
318 <li>It is possible to disable the ignorable blanks heuristic used by
319 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
320 that for adherence to XML spec, this behaviour will be disabled by default
321 in 2.x . The same function will allow to keep compatibility for old
322 code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000323 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
324 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000325 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
326 compilation on some platforms has been fixed</li>
327 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
328 URIs</li>
329</ul>
330
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000331<h3>1.8.6: Jan 31 2000</h3>
332<ul>
333 <li>added a nanoFTP transport module, debugged until the new version of <a
334 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
335 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000336</ul>
337
338<h3>1.8.5: Jan 21 2000</h3>
339<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000340 <li>adding APIs to parse a well balanced chunk of XML (production <a
341 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the XML
342 spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000343 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000344 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
345 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000346 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
347 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000348</ul>
349
350<h3>1.8.4: Jan 13 2000</h3>
351<ul>
352 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
353 <li>all exit() call should have been removed from libxml</li>
354 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
355 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000356</ul>
357
358<h3>1.8.3: Jan 5 2000</h3>
359<ul>
360 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000361 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillarddbfd6411999-12-28 16:35:14 +0000362 <li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000363 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000364 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
365 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000366 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000367 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000368 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000369</ul>
370
371<h3>1.8.2: Dec 21 1999</h3>
372<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000373 <li>I got another problem with includes and C++, I hope this issue is fixed
374 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000375 <li>Added a few tree modification functions: xmlReplaceNode,
376 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
377 xmlDocSetRootElement</li>
378 <li>Tried to improve the HTML output with help from <a
379 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000380</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000381
Daniel Veillarde4e51311999-12-18 15:32:46 +0000382<h3>1.8.1: Dec 18 1999</h3>
383<ul>
384 <li>various patches to avoid troubles when using libxml with C++ compilers
385 the "namespace" keyword and C escaping in include files</li>
386 <li>a problem in one of the core macros IS_CHAR was corrected</li>
387 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
388 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000389 <li>fixed a posteriori validation (validation after parsing, or by using a
390 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000391 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000392</ul>
393
394<h3>1.8.0: Dec 12 1999</h3>
395<ul>
396 <li>cleanup, especially memory wise</li>
397 <li>the parser should be more reliable, especially the HTML one, it should
398 not crash, whatever the input !</li>
399 <li>Integrated various patches, especially a speedup improvement for large
400 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
401 configure with --with-buffers to enable them.</li>
402 <li>attribute normalization, oops should have been added long ago !</li>
403 <li>attributes defaulted from Dtds should be available, xmlSetProp() now
404 does entities escapting by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000405</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000406
407<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000408<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000409 <li>Lots of HTML improvement</li>
410 <li>Fixed some errors when saving both XML and HTML</li>
411 <li>More examples, the regression tests should now look clean</li>
412 <li>Fixed a bug with contiguous charref</li>
413</ul>
414
415<h3>1.7.3: Sep 29 1999</h3>
416<ul>
417 <li>portability problems fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000418 <li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000419 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000420</ul>
421
422<h3>1.7.1: Sep 24 1999</h3>
423<ul>
424 <li>The basic type for strings manipulated by libxml has been renamed in
425 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
426 is that CHAR was conflicting with a predefined type on Windows. However on
427 non WIN32 environment, compatibility is provided by the way of a
428 <strong>#define </strong>.</li>
429 <li>Changed another error : the use of a structure field called errno, and
430 leading to troubles on platforms where it's a macro</li>
431</ul>
432
433<h3>1.7.0: sep 23 1999</h3>
434<ul>
435 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000436 href="html/gnome-xml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000437 <li>Added an errno to report errors by another mean than a simple printf
438 like callback</li>
439 <li>Finished ID/IDREF support and checking when validation</li>
440 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000441 href="html/gnome-xml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000442 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
443 implementation</li>
444 <li>Added an HTML parser front-end</li>
445</ul>
446
447<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000448
Daniel Veillard402e8c82000-02-29 22:57:47 +0000449<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000450markup-based structured documents. Here is <a name="example">an example XML
451document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000452<pre>&lt;?xml version="1.0"?&gt;
453&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
454 &lt;head&gt;
455 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
456 &lt;/head&gt;
457 &lt;chapter&gt;
458 &lt;title&gt;The Linux adventure&lt;/title&gt;
459 &lt;p&gt;bla bla bla ...&lt;/p&gt;
460 &lt;image href="linus.gif"/&gt;
461 &lt;p&gt;...&lt;/p&gt;
462 &lt;/chapter&gt;
463&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000464
Daniel Veillard402e8c82000-02-29 22:57:47 +0000465<p>The first line specifies that it's an XML document and gives useful
466information about its encoding. Then the document is a text format whose
467structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000468to be closed</strong>. XML is pedantic about this. However, if a tag is empty
469(no content), a single tag can serve as both the opening and closing tag if it
Daniel Veillard60979bd2000-07-10 12:17:33 +0000470ends with <code>/&gt;</code> rather than with <code>&gt;</code>. Note that,
471for example, the image tag has no content (just an attribute) and is closed by
472ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000473
Daniel Veillard402e8c82000-02-29 22:57:47 +0000474<p>XML can be applied sucessfully to a wide range of uses, from long term
475structured document maintenance (where it follows the steps of SGML) to simple
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000476data encoding mechanisms like configuration file formatting (glade),
477spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
478it is used to encode remote calls between a client and a server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000479
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000480<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000481
482<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000483returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000484<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000485as the file name, the document type, and a <strong>children</strong> pointer
486which is the root of the document (or more exactly the first child under the
487root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard60979bd2000-07-10 12:17:33 +0000488chained in double-linked lists of siblings and with children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000489relationship. An xmlNode can also carry properties (a chain of xmlAttr
490structures). An attribute may have a value which is a list of TEXT or
491ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000492
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000493<p>Here is an example (erroneous with respect to the XML spec since there
494should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000495
496<p><img src="structure.gif" alt=" structure.gif "></p>
497
498<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000499called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000500prints them back as parsed. This is useful for detecting errors both in XML
501code and in the XML parser itself. It has an option <strong>--debug</strong>
502which prints the actual in-memory structure of the document, here is the
503result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000504<pre>DOCUMENT
505version=1.0
506standalone=true
507 ELEMENT EXAMPLE
508 ATTRIBUTE prop1
509 TEXT
510 content=gnome is great
511 ATTRIBUTE prop2
512 ENTITY_REF
513 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000514 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000515 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000516 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000517 TEXT
518 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000519 ELEMENT chapter
520 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000521 TEXT
522 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000523 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000524 TEXT
525 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000526 ELEMENT image
527 ATTRIBUTE href
528 TEXT
529 content=linus.gif
530 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000531 TEXT
532 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000533
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000534<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000535
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000536<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000537
Daniel Veillard402e8c82000-02-29 22:57:47 +0000538<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000539memory. In that case (and if you don't expect to save back the XML document
540loaded using libxml), it's better to use the SAX interface of libxml. SAX is a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000541<strong>callback-based interface</strong> to the parser. Before parsing, the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000542application layer registers a customized set of callbacks which are called by
543the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000544
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000545<p>To get more detailed step-by-step guidance on using the SAX interface of
546libxml, see the
Daniel Veillard60979bd2000-07-10 12:17:33 +0000547href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html"&gt;nice
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000548documentation.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000549Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000550
551<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
552program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000553binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000554distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000555testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000556<pre>SAX.setDocumentLocator()
557SAX.startDocument()
558SAX.getEntity(amp)
559SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
560SAX.characters( , 3)
561SAX.startElement(head)
562SAX.characters( , 4)
563SAX.startElement(title)
564SAX.characters(Welcome to Gnome, 16)
565SAX.endElement(title)
566SAX.characters( , 3)
567SAX.endElement(head)
568SAX.characters( , 3)
569SAX.startElement(chapter)
570SAX.characters( , 4)
571SAX.startElement(title)
572SAX.characters(The Linux adventure, 19)
573SAX.endElement(title)
574SAX.characters( , 4)
575SAX.startElement(p)
576SAX.characters(bla bla bla ..., 15)
577SAX.endElement(p)
578SAX.characters( , 4)
579SAX.startElement(image, href='linus.gif')
580SAX.endElement(image)
581SAX.characters( , 4)
582SAX.startElement(p)
583SAX.characters(..., 3)
584SAX.endElement(p)
585SAX.characters( , 3)
586SAX.endElement(chapter)
587SAX.characters( , 1)
588SAX.endElement(EXAMPLE)
589SAX.endDocument()</pre>
590
Daniel Veillard402e8c82000-02-29 22:57:47 +0000591<p>Most of the other functionalities of libxml are based on the DOM
592tree-building facility, so nearly everything up to the end of this document
593presupposes the use of the standard DOM tree build. Note that the DOM tree
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000594itself is built by a set of registered default callbacks, without internal
595specific interface.</p>
596
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000597<h2><a name="library">The XML library interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000598
599<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000600using the XML library from the C language. It is not intended to be extensive.
601I hope the automatically generated documents will provide the completeness
602required, but as a separate set of documents. The interfaces of the XML
603library are by principle low level, there is nearly zero abstraction. Those
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000604interested in a higher level API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000605
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000606<p>The <a href="html/gnome-xml-parser.html">parser interfaces for XML</a> are
607separated from the <a href="html/gnome-xml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000608interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000609
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000610<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000611
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000612<p>Usually, the first thing to do is to read an XML input. The parser accepts
613documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000614defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000615<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000616 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000617 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000618 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000619</dl>
620<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000621 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000622 <dd><p>Parse an XML document contained in a (possibly compressed)
623 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000624 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000625</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000626
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000627<p>The parser returns a pointer to the document structure (or NULL in case of
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000628failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000629
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000630<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000631
632<p>In order for the application to keep the control when the document is been
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000633fetched (which is common for GUI based programs) libxml provides a push
634interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000635<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
636 void *user_data,
637 const char *chunk,
638 int size,
639 const char *filename);
640int xmlParseChunk (xmlParserCtxtPtr ctxt,
641 const char *chunk,
642 int size,
643 int terminate);</pre>
644
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000645<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000646<pre> FILE *f;
647
648 f = fopen(filename, "r");
649 if (f != NULL) {
650 int res, size = 1024;
651 char chars[1024];
652 xmlParserCtxtPtr ctxt;
653
654 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000655 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000656 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
657 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000658 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000659 xmlParseChunk(ctxt, chars, res, 0);
660 }
661 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000662 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000663 xmlFreeParserCtxt(ctxt);
664 }
665 }</pre>
666
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000667<p>Also note that the HTML parser embedded into libxml also has a push
668interface; the functions are just prefixed by "html" rather than "xml"</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000669
670<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
671
Daniel Veillardb05deb71999-08-10 19:04:08 +0000672<p>A couple of comments can be made, first this mean that the parser is
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000673memory-hungry, first to load the document in memory, second to build the tree.
Daniel Veillard0142b842000-01-14 14:45:24 +0000674Reading a document without building the tree is possible using the SAX
675interfaces (see SAX.h and <a
676href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000677Henstridge's documentation</a>). Note also that the push interface can be
678limited to SAX. Just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +0000679<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000680
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000681<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000682
683<p>The other way to get an XML tree in memory is by building it. Basically
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000684there is a set of functions dedicated to building new elements. (These are
Daniel Veillard60979bd2000-07-10 12:17:33 +0000685also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of code
Daniel Veillard361d8452000-04-03 19:48:13 +0000686that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000687<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000688 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000689 xmlNodePtr tree, subtree;
690
691 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000692 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
693 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
694 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
695 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000696 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000697 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000698 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
699 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
700 subtree = xmlNewChild(tree, NULL, "image", NULL);
701 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000702
703<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000704
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000705<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000706
Daniel Veillard306be992000-07-03 12:38:45 +0000707<p>Basically by <a href="html/gnome-xml-tree.html">including "tree.h"</a> your
708code has access to the internal structure of all the elements of the tree. The
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000709names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +0000710<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000711<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +0000712example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000713<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000714
715<p>points to the title element,</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000716<pre>doc-&gt;children-&gt;children-&gt;next-&gt;child-&gt;child</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000717
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000718<p>points to the text node containing the chapter title "The Linux
719adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000720
Daniel Veillardb24054a1999-12-18 15:32:46 +0000721<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
Daniel Veillard60979bd2000-07-10 12:17:33 +0000722present before the document root, so <code>doc-&gt;children</code> may point
723to an element which is not the document Root Element, a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000724<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000725
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000726<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000727
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000728<p>Functions are provided for reading and writing the document content. Here
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000729is an excerpt from the <a href="html/gnome-xml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000730<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000731 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
732 xmlChar *value);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000733 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node. The
734 value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000735 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000736</dl>
737<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000738 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000739 *name);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000740 <dd><p>This function returns a pointer to the property content. Note that
741 no extra copy is made.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000742 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000743</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000744
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000745<p>Two functions are provided for reading and writing the text associated with
Daniel Veillard25940b71998-10-29 05:51:30 +0000746elements:</p>
747<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000748 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000749 *value);</code></dt>
750 <dd><p>This function takes an "external" string and convert it to one text
751 node or possibly to a list of entity and text nodes. All non-predefined
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000752 entity references like &amp;Gnome; will be stored internally as entity
753 nodes, hence the result of the function may not be a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000754 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000755</dl>
756<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000757 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000758 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000759 <dd><p>This function is the inverse of
760 <code>xmlStringGetNodeList()</code>. It generates a new string
761 containing the content of the text and entity nodes. Note the extra
762 argument inLine. If this argument is set to 1, the function will expand
763 entity references. For example, instead of returning the &amp;Gnome;
764 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000765 "GNU Network Object Model Environment"). Set this argument if you want
766 to use the string for non-XML usage like User Interface.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000767 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000768</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000769
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000770<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000771
772<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000773<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000774 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000775 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000776 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000777 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000778</dl>
779<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000780 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000781 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000782 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000783</dl>
784<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000785 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000786 <dd><p>Saves the document to a file. In this case, the compression
787 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000788 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000789</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000790
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000791<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000792
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000793<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000794accesses. The level of compression on saves can be turned on either globally
795or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000796<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000797 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000798 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000799 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000800</dl>
801<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000802 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000803 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000804 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000805</dl>
806<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000807 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000808 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000809 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000810</dl>
811<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000812 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000813 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000814 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000815</dl>
816
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000817<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000818
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000819<p>Entities in principle are similar to simple C macros. An entity defines an
820abbreviation for a given string that you can reuse many times throughout the
821content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000822may occur frequently within a document, or to confine the change needed to a
823document to a restricted area in the internal subset of the document (at the
824beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000825<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00008262 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +00008273 &lt;!ENTITY xml "Extensible Markup Language"&gt;
8284 ]&gt;
8295 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00008306 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +00008317 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000832
833<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000834it's name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000835are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000836predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000837<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000838for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000839<strong>&amp;quot;</strong> for the character '"', and
840<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000841
842<p>One of the problems related to entities is that you may want the parser to
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000843substitute an entity's content so that you can see the replacement text in
844your application. Or you may prefer to keep entity references as such in the
845content to be able to save the document back without losing this usually
846precious information (if the user went through the pain of explicitly defining
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000847entities, he may have a a rather negative attitude if you blindly susbtitute
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000848them as saving time). The <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000849href="html/gnome-xml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000850function allows you to check and change the behaviour, which is to not
851substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000852
853<p>Here is the DOM tree built by libxml for the previous document in the
854default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000855<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000856DOCUMENT
857version=1.0
858 ELEMENT EXAMPLE
859 TEXT
860 content=
861 ENTITY_REF
862 INTERNAL_GENERAL_ENTITY xml
863 content=Extensible Markup Language
864 TEXT
865 content=</pre>
866
867<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000868<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000869DOCUMENT
870version=1.0
871 ELEMENT EXAMPLE
872 TEXT
873 content= Extensible Markup Language</pre>
874
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000875<p>So, entities or no entities? Basically, it depends on your use case. I
876suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000877entities in your XML document or data if you are not willing to handle the
878entity references elements in the DOM tree.</p>
879
880<p>Note that at save time libxml enforce the conversion of the predefined
881entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000882transparently replace those with chars (i.e., it will not generate entity
883reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000884finding them in the input).</p>
885
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000886<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000887
Daniel Veillardec303412000-03-24 13:41:54 +0000888<p>The libxml library implements <a
889href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
890recognizing namespace contructs in the input, and does namespace lookup
891automatically when building the DOM tree. A namespace declaration is
892associated with an in-memory structure and all elements or attributes within
893that namespace point to it. Hence testing the namespace is a simple and fast
894equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000895
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000896<p>I suggest that people using libxml use a namespace, and declare it in the
897root element of their document as the default namespace. Then they don't need
898to use the prefix in the content but we will have a basis for future semantic
899refinement and merging of data from different sources. This doesn't augment
900significantly the size of the XML output, but significantly increase its value
Daniel Veillardec303412000-03-24 13:41:54 +0000901in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000902<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
903 &lt;elem1&gt;...&lt;/elem1&gt;
904 &lt;elem2&gt;...&lt;/elem2&gt;
905&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000906
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000907<p>Concerning the namespace value, this has to be an URL, but the URL doesn't
Daniel Veillardec303412000-03-24 13:41:54 +0000908have to point to any existing resource on the Web. It will bind all the
909element and atributes with that URL. I suggest to use an URL within a domain
910you control, and that the URL should contain some kind of version information
911if possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is
Daniel Veillard361d8452000-04-03 19:48:13 +0000912a good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000913
914<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000915version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000916and if the version information don't match something you know, warn the user
917and be liberal in what you accept as the input. Also do *not* try to base
Daniel Veillard60979bd2000-07-10 12:17:33 +0000918namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
919same as &lt;bar:text&gt; in another document. What really matter is the URI
920associated with the element or the attribute, not the prefix string (which is
921just a shortcut for the full URI). In libxml element and attributes have a
Daniel Veillardec303412000-03-24 13:41:54 +0000922<code>ns</code> field pointing to an xmlNs structure detailing the namespace
923prefix and it's URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000924
925<p>@@Interfaces@@</p>
926
927<p>@@Examples@@</p>
928
929<p>Usually people object using namespace in the case of validation, I object
930this and will make sure that using namespaces won't break validity checking,
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000931so even is you plan to use or currently are using validation I strongly
932suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000933<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000934flexible parsers. Now using namespace to mix and differentiate content coming
935from multiple DTDs will certainly break current validation schemes. I will try
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000936to provide ways to do this, but this may not be portable or standardized.</p>
937
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000938<h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000939
940<p>Well what is validation and what is a DTD ?</p>
941
942<p>Validation is the process of checking a document against a set of
943construction rules, a <strong>DTD</strong> (Document Type Definition) is such
944a set of rules.</p>
945
946<p>The validation process and building DTDs are the two most difficult parts
947of XML life cycle. Briefly a DTD defines all the possibles element to be
948found within your document, what is the formal shape of your document tree (by
949defining the allowed content of an element, either text, a regular expression
Daniel Veillard306be992000-07-03 12:38:45 +0000950for the allowed list of children, or mixed content i.e. both text and
951children). The DTD also defines the allowed attributes for all elements and
952the types of the attributes. For more detailed informations, I suggest to read
953the related parts of the XML specification, the examples found under
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000954gnome-xml/test/valid/dtd and the large amount of books available on XML. The
955dia example in gnome-xml/test/valid should be both simple and complete enough
956to allow you to build your own.</p>
957
958<p>A word of warning, building a good DTD which will fit your needs of your
959application in the long-term is far from trivial, however the extra level of
960quality it can insure is well worth the price for some sets of applications or
961if you already have already a DTD defined for your application field.</p>
962
963<p>The validation is not completely finished but in a (very IMHO) usable
964state. Until a real validation interface is defined the way to do it is to
965define and set the <strong>xmlDoValidityCheckingDefaultValue</strong> external
966variable to 1, this will of course be changed at some point:</p>
967
968<p>extern int xmlDoValidityCheckingDefaultValue;</p>
969
970<p>...</p>
971
972<p>xmlDoValidityCheckingDefaultValue = 1;</p>
973
974<p></p>
975
976<p>To handle external entities, use the function
977<strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to
978link in you HTTP/FTP/Entities database library to the standard libxml
979core.</p>
980
981<p>@@interfaces@@</p>
982
Daniel Veillard35008381999-10-25 13:15:52 +0000983<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000984
985<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document Object
Daniel Veillardccb09631998-10-27 06:21:04 +0000986Model</em> this is an API for accessing XML or HTML structured documents.
987Native support for DOM in Gnome is on the way (module gnome-dom), and it will
Daniel Veillard25940b71998-10-29 05:51:30 +0000988be based on gnome-xml. This will be a far cleaner interface to manipulate XML
Daniel Veillardc08a2c61999-09-08 21:35:25 +0000989files within Gnome since it won't expose the internal structure. DOM defines a
Daniel Veillard25940b71998-10-29 05:51:30 +0000990set of IDL (or Java) interfaces allowing to traverse and manipulate a
991document. The DOM library will allow accessing and modifying "live" documents
992presents on other programs like this:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000993
994<p><img src="DOM.gif" alt=" DOM.gif "></p>
995
996<p>This should help greatly doing things like modifying a gnumeric spreadsheet
Daniel Veillardccb09631998-10-27 06:21:04 +0000997embedded in a GWP document for example.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000998
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000999<p>The current DOM implementation on top of libxml is the <a
1000href="http://cvs.gnome.org/lxr/source/gdome/">gdome Gnome module</a>, this is
1001a full DOM interface, thanks to <a href="mailto:raph@levien.com">Raph
1002Levien</a>.</p>
1003
1004<p>The gnome-dom module in the Gnome CVS base is obsolete</p>
1005
Daniel Veillard35008381999-10-25 13:15:52 +00001006<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001007
1008<p>Here is a real size example, where the actual content of the application
1009data is not kept in the DOM tree but uses internal structures. It is based on
Daniel Veillard14fff061999-06-22 21:49:07 +00001010a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +00001011storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
1012base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001013<pre>&lt;?xml version="1.0"?&gt;
1014&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
1015 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001016
Daniel Veillard60979bd2000-07-10 12:17:33 +00001017 &lt;gjob:Job&gt;
1018 &lt;gjob:Project ID="3"/&gt;
1019 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
1020 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001021
Daniel Veillard60979bd2000-07-10 12:17:33 +00001022 &lt;gjob:Update&gt;
1023 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
1024 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
1025 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
1026 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001027
Daniel Veillard60979bd2000-07-10 12:17:33 +00001028 &lt;gjob:Developers&gt;
1029 &lt;gjob:Developer&gt;
1030 &lt;/gjob:Developer&gt;
1031 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001032
Daniel Veillard60979bd2000-07-10 12:17:33 +00001033 &lt;gjob:Contact&gt;
1034 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
1035 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
1036 &lt;gjob:Company&gt;
1037 &lt;/gjob:Company&gt;
1038 &lt;gjob:Organisation&gt;
1039 &lt;/gjob:Organisation&gt;
1040 &lt;gjob:Webpage&gt;
1041 &lt;/gjob:Webpage&gt;
1042 &lt;gjob:Snailmail&gt;
1043 &lt;/gjob:Snailmail&gt;
1044 &lt;gjob:Phone&gt;
1045 &lt;/gjob:Phone&gt;
1046 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001047
Daniel Veillard60979bd2000-07-10 12:17:33 +00001048 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001049 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +00001050 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001051
Daniel Veillard60979bd2000-07-10 12:17:33 +00001052 &lt;gjob:Skills&gt;
1053 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001054
Daniel Veillard60979bd2000-07-10 12:17:33 +00001055 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001056 A GNOME based system that will allow a superuser to configure
1057 compressed and uncompressed files and/or file systems to be backed
1058 up with a supported media in the system. This should be able to
1059 perform via find commands generating a list of files that are passed
1060 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
1061 or via operations performed on the filesystem itself. Email
1062 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +00001063 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001064
Daniel Veillard60979bd2000-07-10 12:17:33 +00001065 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00001066
Daniel Veillard60979bd2000-07-10 12:17:33 +00001067 &lt;/gjob:Jobs&gt;
1068&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001069
1070<p>While loading the XML file into an internal DOM tree is a matter of calling
1071only a couple of functions, browsing the tree to gather the informations and
1072generate the internals structures is harder, and more error prone.</p>
1073
1074<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001075structure. For example, the ordering of the attributes is not significant,
1076Cthe XML specification is clear about it. It's also usually a good idea to not
Daniel Veillard306be992000-07-03 12:38:45 +00001077be dependent of the orders of the children of a given node, unless it really
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00001078makes things harder. Here is some code to parse the informations for a
1079person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001080<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +00001081 * A person record
1082 */
1083typedef struct person {
1084 char *name;
1085 char *email;
1086 char *company;
1087 char *organisation;
1088 char *smail;
1089 char *webPage;
1090 char *phone;
1091} person, *personPtr;
1092
1093/*
1094 * And the code needed to parse it
1095 */
1096personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1097 personPtr ret = NULL;
1098
1099DEBUG("parsePerson\n");
1100 /*
1101 * allocate the struct
1102 */
1103 ret = (personPtr) malloc(sizeof(person));
1104 if (ret == NULL) {
1105 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00001106 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00001107 }
1108 memset(ret, 0, sizeof(person));
1109
1110 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00001111 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00001112 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +00001113 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
1114 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1115 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
1116 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1117 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00001118 }
1119
1120 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00001121}</pre>
1122
1123<p>Here is a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00001124<ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001125 <li>Usually a recursive parsing style is the more convenient one, XML data
1126 being by nature subject to repetitive constructs and usualy exibit highly
1127 stuctured patterns.</li>
1128 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>, i.e.
1129 the pointer to the global XML document and the namespace reserved to the
1130 application. Document wide information are needed for example to decode
1131 entities and it's a good coding practice to define a namespace for your
1132 application set of data and test that the element and attributes you're
1133 analyzing actually pertains to your application space. This is done by a
Daniel Veillard60979bd2000-07-10 12:17:33 +00001134 simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001135 <li>To retrieve text and attributes value, it is suggested to use the
1136 function <em>xmlNodeListGetString</em> to gather all the text and entity
1137 reference nodes generated by the DOM output and produce an single text
1138 string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +00001139</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001140
1141<p>Here is another piece of code used to parse another level of the
1142structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00001143<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00001144/*
Daniel Veillard14fff061999-06-22 21:49:07 +00001145 * a Description for a Job
1146 */
1147typedef struct job {
1148 char *projectID;
1149 char *application;
1150 char *category;
1151 personPtr contact;
1152 int nbDevelopers;
1153 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
1154} job, *jobPtr;
1155
1156/*
1157 * And the code needed to parse it
1158 */
1159jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1160 jobPtr ret = NULL;
1161
1162DEBUG("parseJob\n");
1163 /*
1164 * allocate the struct
1165 */
1166 ret = (jobPtr) malloc(sizeof(job));
1167 if (ret == NULL) {
1168 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00001169 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00001170 }
1171 memset(ret, 0, sizeof(job));
1172
1173 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00001174 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00001175 while (cur != NULL) {
1176
Daniel Veillard60979bd2000-07-10 12:17:33 +00001177 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
1178 ret-&gt;projectID = xmlGetProp(cur, "ID");
1179 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +00001180 fprintf(stderr, "Project has no ID\n");
1181 }
1182 }
Daniel Veillard60979bd2000-07-10 12:17:33 +00001183 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
1184 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1185 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
1186 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1187 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
1188 ret-&gt;contact = parsePerson(doc, ns, cur);
1189 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00001190 }
1191
1192 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00001193}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +00001194
Daniel Veillardb05deb71999-08-10 19:04:08 +00001195<p>One can notice that once used to it, writing this kind of code is quite
1196simple, but boring. Ultimately, it could be possble to write stubbers taking
1197either C data structure definitions, a set of XML examples or an XML DTD and
1198produce the code needed to import and export the content between C data and
1199XML storage. This is left as an exercise to the reader :-)</p>
1200
Daniel Veillard6f0adb52000-07-03 11:41:26 +00001201<p>Feel free to use <a href="example/gjobread.c">the code for the full C
1202parsing example</a> as a template, it is also available with Makefile in the
1203Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00001204
Daniel Veillardc310d562000-06-23 18:32:15 +00001205<h2><a name="Contributi">Contributions</a></h2>
1206<ul>
1207 <li><a href="mailto:ari@btigate.com">Ari Johnson</a> provides a C++ wrapper
1208 for libxml:
1209 <p>Website: <a
1210 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
1211 <p>Download: <a
1212 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
1213 </li>
1214 <li><a href="mailto:doolin@cs.utk.edu">David Doolin</a> provides a
1215 precompiled Windows version
1216 <p><a
1217 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
1218 </li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00001219 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> provided <a
1220 href="libxml-doc.el">an emacs module</a> to lookup libxml functions
1221 documentation</li>
Daniel Veillardc310d562000-06-23 18:32:15 +00001222 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
1223 href="http://xmlsoft.org/messages/0488.html">man pages</a> (not yet
1224 integrated in the distribution)</li>
1225</ul>
1226
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00001227<p></p>
1228
1229<p><a href="mailto:Daniel.Veillard@w3.org">Daniel Veillard</a></p>
1230
Daniel Veillard786d7c82000-08-12 23:38:57 +00001231<p>$Id: xml.html,v 1.44 2000/07/22 02:38:15 veillard Exp $</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00001232</body>
1233</html>