Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 008186fc7fe681c4fa0abd831bc4cb244f46ab01 / . / doc / xml.html
blob: 2f66881fac86b12770555a2e6afff1f4331ae2a2 [file] [log] [blame]
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3<html>
4<head>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]5 <title>The XML C library for Gnome</title>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]6 <meta name="GENERATOR" content="amaya V5.0">
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]7 <meta http-equiv="Content-Type" content="text/html">
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]8</head>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]9
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]10<body bgcolor="#ffffff">
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]11<p><a href="http://www.gnome.org/"><img src="smallfootonly.gif"
12alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png"
Daniel Veillardb370a742001-06-09 16:58:47 +0000[diff] [blame]13alt="W3C Logo"></a><a href="http://www.redhat.com"><img src="redhat.gif"
14alt="Red Hat Logo"></a></p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]15
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]16<h1 align="center">The XML C library for Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]17
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]18<h2 style="text-align: center">libxml, a.k.a. gnome-xml</h2>
19
20<p></p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]21<ul>
22 <li><a href="#Introducti">Introduction</a></li>
23 <li><a href="#Documentat">Documentation</a></li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]24 <li><a href="#Reporting">Reporting bugs and getting help</a></li>
25 <li><a href="#help">how to help</a></li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]26 <li><a href="#Downloads">Downloads</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]27 <li><a href="#News">News</a></li>
28 <li><a href="#XML">XML</a></li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]29 <li><a href="#XSLT">XSLT</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]30 <li><a href="#tree">The tree output</a></li>
31 <li><a href="#interface">The SAX interface</a></li>
32 <li><a href="#library">The XML library interfaces</a>
33 <ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]34 <li><a href="#Invoking">Invoking the parser: the pull way</a></li>
35 <li><a href="#Invoking">Invoking the parser: the push way</a></li>
36 <li><a href="#Invoking2">Invoking the parser: the SAX interface</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]37 <li><a href="#Building">Building a tree from scratch</a></li>
38 <li><a href="#Traversing">Traversing the tree</a></li>
39 <li><a href="#Modifying">Modifying the tree</a></li>
40 <li><a href="#Saving">Saving the tree</a></li>
41 <li><a href="#Compressio">Compression</a></li>
42 </ul>
43 </li>
44 <li><a href="#Entities">Entities or no entities</a></li>
45 <li><a href="#Namespaces">Namespaces</a></li>
46 <li><a href="#Validation">Validation</a></li>
47 <li><a href="#Principles">DOM principles</a></li>
48 <li><a href="#real">A real example</a></li>
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]49 <li><a href="#Contributi">Contributions</a></li>
50</ul>
51
52<p>Separate documents:</p>
53<ul>
54 <li><a href="upgrade.html">upgrade instructions for migrating to
55 libxml2</a></li>
56 <li><a href="encoding.html">libxml Internationalization support</a></li>
57 <li><a href="xmlio.html">libxml Input/Output interfaces</a></li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]58 <li><a href="xmlmem.html">libxml Memory interfaces</a></li>
Daniel Veillarde7ead2d2001-08-22 23:44:09 +0000[diff] [blame]59 <li><a href="catalog.html">libxml Catalog support</a></li>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]60 <li><a href="xmldtd.html">a short introduction about DTDs and
61 libxml</a></li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]62 <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a></li>
Daniel Veillard7b06bcb2001-06-22 16:03:51 +0000[diff] [blame]63 <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page: a
64 standard DOM interface for libxml2</a></li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]65</ul>
66
67<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]68
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]69<p>This document describes libxml, the <a
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]70href="http://www.w3.org/XML/">XML</a> C library developped for the <a
71href="http://www.gnome.org/">Gnome</a> project. <a
72href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
73structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]74
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]75<p>Here are some key points about libxml:</p>
76<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]77 <li>Libxml exports Push and Pull type parser interfaces for both XML and
78 HTML.</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]79 <li>Libxml can do DTD validation at parse time, using a parsed document
80 instance, or with an arbitrary DTD.</li>
81 <li>Libxml now includes nearly complete <a
Daniel Veillard8c2ecaf2001-07-10 17:53:07 +0000[diff] [blame]82 href="http://www.w3.org/TR/xpath">XPath</a>, <a
83 href="http://www.w3.org/TR/xptr">XPointer</a> and <a
84 href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]85 <li>It is written in plain C, making as few assumptions as possible, and
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]86 sticking closely to ANSI C/POSIX for easy embedding. Works on
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]87 Linux/Unix/Windows, ported to a number of other platforms.</li>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]88 <li>Basic support for HTTP and FTP client allowing aplications to fetch
89 remote resources</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]90 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]91 <li>The internal document repesentation is as close as possible to the <a
92 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
93 <li>Libxml also has a <a href="http://www.megginson.com/SAX/index.html">SAX
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]94 like interface</a>; the interface is designed to be compatible with <a
95 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]96 <li>This library is released both under the <a
97 href="http://www.w3.org/Consortium/Legal/copyright-software-19980720.html">W3C
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]98 IPR</a> and the <a href="http://www.gnu.org/copyleft/lesser.html">GNU
99 LGPL</a>. Use either at your convenience, basically this should make
100 everybody happy, if not, drop me a mail.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]101</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]102
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000[diff] [blame]103<p>Warning: unless you are forced to because your application links with a
104Gnome library requiring it, <strong><span
105style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
106libxml2</p>
107
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]108<h2><a name="Documentat">Documentation</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]109
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]110<p>There are some on-line resources about using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]111<ol>
Daniel Veillard365e13b2000-07-02 07:56:37 +0000[diff] [blame]112 <li>Check the <a href="FAQ.html">FAQ</a></li>
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]113 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000[diff] [blame]114 documentation</a> automatically extracted from code comments (using <a
115 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gtk-doc">gtk
116 doc</a>).</li>
Daniel Veillard8d869642000-07-14 12:12:59 +0000[diff] [blame]117 <li>Look at the documentation about <a href="encoding.html">libxml
118 internationalization support</a></li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]119 <li>This page provides a global overview and <a href="#real">some
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]120 examples</a> on how to use libxml.</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]121 <li><a href="mailto:james@daa.com.au">James Henstridge</a>
122 wrote <a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]123 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
124 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]125 <li>George Lebl wrote <a
126 href="http://www-4.ibm.com/software/developer/library/gnome3/">an article
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]127 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]128 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
129 file</a></li>
130 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>. If you are
131 starting a new project using libxml you should really use the 2.x
132 version.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]133 <li>And don't forget to look at the <a href="/messages/">mailing-list
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]134 archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]135</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]136
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]137<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]138
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]139<p>Well, bugs or missing features are always possible, and I will make a
140point of fixing them in a timely fashion. The best way to report a bug is to
141use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome
142bug tracking database</a> (make sure to use the "libxml" module name). I look
143at reports there regularly and it's good to have a reminder when a bug is
144still open. Check the <a
145href="http://bugzilla.gnome.org/bugwritinghelp.html">instructions on
146reporting bugs</a> and be sure to specify that the bug is for the package
147libxml.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]148
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]149<p>There is also a mailing-list <a
Daniel Veillard3197f162001-04-04 00:40:08 +0000[diff] [blame]150href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
151href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]152href="http://xmlsoft.org/messages">old</a>). To subscribe to this list,
153please visit the <a
154href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and
155follow the instructions. <strong>Do not send code, I won't debug it</strong>
156(but patches are really appreciated!).</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]157
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame^]158<p>Check the following <strong><span style="color: #FF0000">before
159posting</span></strong>:</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]160<ul>
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame^]161 <li>read the <a href="FAQ.html">FAQ</a> </li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]162 <li>make sure you are <a href="ftp://xmlsoft.org/">using a recent
163 version</a>, and that the problem still shows up in those</li>
164 <li>check the <a href="http://mail.gnome.org/archives/xml/">list
165 archives</a> to see if the problem was reported already, in this case
Daniel Veillarde7ead2d2001-08-22 23:44:09 +0000[diff] [blame]166 there is probably a fix available, similary check the <a
167 href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">registered
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]168 open bugs</a></li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]169 <li>make sure you can reproduce the bug with xmllint or one of the test
170 programs found in source in the distribution</li>
171 <li>Please send the command showing the error as well as the input (as an
172 attachement)</li>
173</ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]174
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame^]175<p> Then send the bug with associated informations to reproduce it to the <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]176href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame^]177related I will approve it.. Please do not send me mail directly, it makes
178things really harder to track and in some cases I'm not the best person to
179answer a given question, ask the list instead.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]180
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]181<p>Of course, bugs reported with a suggested patch for fixing them will
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]182probably be processed faster.</p>
183
184<p>If you're looking for help, a quick look at <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]185href="http://mail.gnome.org/archives/xml/">the list archive</a> may actually
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]186provide the answer, I usually send source samples when answering libxml usage
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]187questions. The <a href="http://xmlsoft.org/html/book1.html">auto-generated
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]188documentantion</a> is not as polished as I would like (i need to learn more
189about Docbook), but it's a good starting point.</p>
190
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]191<h2><a name="help">How to help</a></h2>
192
193<p>You can help the project in various ways, the best thing to do first is to
194subscribe to the mailing-list as explained before, check the <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]195href="http://mail.gnome.org/archives/xml/">archives </a>and the <a
196href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Gnome bug
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]197database:</a>:</p>
198<ol>
199 <li>provide patches when you find problems</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]200 <li>provide the diffs when you port libxml to a new platform. They may not
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]201 be integrated in all cases but help pinpointing portability problems
202 and</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]203 <li>provide documentation fixes (either as patches to the code comments or
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]204 as HTML diffs).</li>
205 <li>provide new documentations pieces (translations, examples, etc ...)</li>
206 <li>Check the TODO file and try to close one of the items</li>
207 <li>take one of the points raised in the archive or the bug database and
Daniel Veillarde7ead2d2001-08-22 23:44:09 +0000[diff] [blame]208 provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me
209 </a>before to avoid synchronization problems and check that the suggested
210 fix will fit in nicely :-)</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]211</ol>
212
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]213<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]214
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]215<p>The latest versions of libxml can be found on <a
Daniel Veillard20c8cf22001-06-26 22:47:36 +0000[diff] [blame]216href="ftp://xmlsoft.org/">xmlsoft.org</a> (<a
217href="ftp://speakeasy.rpmfind.net/pub/libxml/">Seattle</a>, <a
218href="ftp://fr.rpmfind.net/pub/libxml/">France</a>) or on the <a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]219href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> either
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]220as a <a href="ftp://ftp.gnome.org/pub/GNOME/stable/sources/libxml/">source
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]221archive</a> or <a
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]222href="ftp://ftp.gnome.org/pub/GNOME/stable/redhat/i386/libxml/">RPM
223packages</a>. (NOTE that you need both the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]224href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
225href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard95189532001-07-26 18:30:26 +0000[diff] [blame]226packages installed to compile applications using libxml.) <a
227href="mailto:izlatkovic@daenet.de">Igor Zlatkovic</a> is now the maintainer
228of the Windows port, <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]229href="http://www.fh-frankfurt.de/~igor/projects/libxml/index.html">he
230provides binaries</a></p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]231
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]232<p><a name="Snapshot">Snapshot:</a></p>
233<ul>
234 <li>Code from the W3C cvs base libxml <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]235 href="ftp://xmlsoft.org/cvs-snapshot.tar.gz">cvs-snapshot.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]236 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]237 href="ftp://xmlsoft.org/libxml-docs.tar.gz">libxml-docs.tar.gz</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]238</ul>
239
240<p><a name="Contribs">Contribs:</a></p>
241
242<p>I do accept external contributions, especially if compiling on another
243platform, get in touch with me to upload the package. I will keep them in the
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]244<a href="ftp://xmlsoft.org/contribs/">contrib directory</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]245
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]246<p>Libxml is also available from CVS:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]247<ul>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]248 <li><p>The <a
249 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Gnome
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]250 CVS base</a>. Check the <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]251 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a>
252 page; the CVS module is <b>gnome-xml</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]253 </li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]254 <li>The <strong>libxslt</strong> module is also present there</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]255</ul>
256
257<h2><a name="News">News</a></h2>
258
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]259<h3>CVS only : check the <a
260href="http://cvs.gnome.org/lxr/source/gnome-xml/ChangeLog">Changelog</a> file
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]261for a really accurate description</h3>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]262
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]263<p>Items floating around but not actively worked on, get in touch with me if
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]264you want to test those</p>
265<ul>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]266 <li>Implementing <a href="http://xmlsoft.org/XSLT">XSLT</a>, this is done
267 as a separate C library on top of libxml called libxslt</li>
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]268 <li>Finishing up <a href="http://www.w3.org/TR/xptr">XPointer</a> and <a
269 href="http://www.w3.org/TR/xinclude">XInclude</a></li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]270 <li>(seeems working but delayed from release) parsing/import of Docbook
271 SGML docs</li>
272</ul>
273
Daniel Veillard04382ae2001-09-12 18:51:30 +0000[diff] [blame]274<h3>2.4.4: Sep 12 2001</h3>
275<ul>
276 <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
277 Catalog</li>
278 <li>a few bug fixes and some portability changes</li>
279 <li>some documentation cleanups</li>
280</ul>
281
Daniel Veillard39936902001-08-24 00:49:01 +0000[diff] [blame]282<h3>2.4.3: Aug 23 2001</h3>
283<ul>
284 <li>XML Catalog support see the doc</li>
285 <li>New NaN/Infinity floating point code</li>
286 <li>A few bug fixes</li>
287</ul>
288
289<h3>2.4.2: Aug 15 2001</h3>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]290<ul>
291 <li>adds xmlLineNumbersDefault() to control line number generation</li>
292 <li>lot of bug fixes</li>
293 <li>the Microsoft MSC projects files shuld now be up to date</li>
294 <li>inheritance of namespaces from DTD defaulted attributes</li>
295 <li>fixes a serious potential security bug</li>
296 <li>added a --format option to xmllint</li>
297</ul>
298
299<h3>2.4.1: July 24 2001</h3>
300<ul>
301 <li>possibility to keep line numbers in the tree</li>
302 <li>some computation NaN fixes</li>
303 <li>extension of the XPath API</li>
304 <li>cleanup for alpha and ia64 targets</li>
305 <li>patch to allow saving through HTTP PUT or POST</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]306</ul>
307
308<h3>2.4.0: July 10 2001</h3>
309<ul>
310 <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
311 <li>Fixed XML Base implementation, added a coupel of examples to the
312 regression tests</li>
313 <li>A bit of cleanup</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]314</ul>
315
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]316<h3>2.3.14: July 5 2001</h3>
317<ul>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]318 <li>fixed some entities problems and reduce mem requirement when
319 substituing them</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]320 <li>lots of improvements in the XPath queries interpreter can be
321 substancially faster</li>
322 <li>Makefiles and configure cleanups</li>
323 <li>Fixes to XPath variable eval, and compare on empty node set</li>
324 <li>HTML tag closing bug fixed</li>
325 <li>Fixed an URI reference computating problem when validating</li>
326</ul>
327
Daniel Veillard2adbb512001-06-28 16:20:36 +0000[diff] [blame]328<h3>2.3.13: June 28 2001</h3>
329<ul>
330 <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
331 <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
332</ul>
333
334<h3>1.8.14: June 28 2001</h3>
335<ul>
336 <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
337 <li>Small Makefile fix</li>
338</ul>
339
Daniel Veillard11648102001-06-26 16:08:24 +0000[diff] [blame]340<h3>2.3.12: June 26 2001</h3>
341<ul>
342 <li>lots of cleanup</li>
343 <li>a couple of validation fix</li>
344 <li>fixed line number counting</li>
345 <li>fixed serious problems in the XInclude processing</li>
346 <li>added support for UTF8 BOM at beginning of entities</li>
347 <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
348 miscompile uri.c (William), Thomas Leitner provided a fix for the
349 optimizer on Tru64</li>
350 <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
351 compilation on Windows MSC</li>
352 <li>update of libxml-doc.el (Felix Natter)</li>
353 <li>fixed 2 bugs in URI normalization code</li>
354</ul>
355
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]356<h3>2.3.11: June 17 2001</h3>
357<ul>
358 <li>updates to trio, Makefiles and configure should fix some portability
359 problems (alpha)</li>
360 <li>fixed some HTML serialization problems (pre, script, and block/inline
361 handling), added encoding aware APIs, cleanup of this code</li>
362 <li>added xmlHasNsProp()</li>
363 <li>implemented a specific PI for encoding support in the DocBook SGML
364 parser</li>
365 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
366 node selection)</li>
367 <li>fixed a performance problem and an error in the validation code</li>
368 <li>fixed XInclude routine to implement the recursive behaviour</li>
369 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
370 <li>added --version to xmllint for bug reports</li>
371</ul>
372
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]373<h3>2.3.10: June 1 2001</h3>
374<ul>
375 <li>fixed the SGML catalog support</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]376 <li>a number of reported bugs got fixed, in XPath, iconv detection,
377 XInclude processing</li>
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]378 <li>XPath string function should now handle unicode correctly</li>
379</ul>
380
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]381<h3>2.3.9: May 19 2001</h3>
382
383<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
384<ul>
385 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
386 <li>some serious speed optimisation again</li>
387 <li>some documentation cleanups</li>
388 <li>trying to get better linking on solaris (-R)</li>
389 <li>XPath API cleanup from Thomas Broyer</li>
390 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
391 xmlValidGetValidElements()</li>
392 <li>Added an INSTALL file</li>
393 <li>Attribute removal added to API: #54433</li>
394 <li>added a basic support for SGML catalogs</li>
395 <li>fixed xmlKeepBlanksDefault(0) API</li>
396 <li>bugfix in xmlNodeGetLang()</li>
397 <li>fixed a small configure portability problem</li>
398 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
399</ul>
400
Daniel Veillarda265af72001-05-14 11:13:58 +0000[diff] [blame]401<h3>1.8.13: May 14 2001</h3>
402<ul>
403 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
404</ul>
405
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]406<h3>2.3.8: May 3 2001</h3>
407<ul>
408 <li>Integrated an SGML DocBook parser for the Gnome project</li>
409 <li>Fixed a few things in the HTML parser</li>
410 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
411 point portability issue</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]412 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
413 DOM+validation using the XML REC as input and a 700MHz celeron).</li>
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]414 <li>incorporated more Windows cleanup</li>
415 <li>added xmlSaveFormatFile()</li>
416 <li>fixed problems in copying nodes with entities references (gdome)</li>
417 <li>removed some troubles surrounding the new validation module</li>
418</ul>
419
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]420<h3>2.3.7: April 22 2001</h3>
421<ul>
422 <li>lots of small bug fixes, corrected XPointer</li>
423 <li>Non determinist content model validation support</li>
424 <li>added xmlDocCopyNode for gdome2</li>
425 <li>revamped the way the HTML parser handles end of tags</li>
426 <li>XPath: corrctions of namespacessupport and number formatting</li>
427 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
428 <li>HTML ouput fixes from P C Chow and William M. Brack</li>
429 <li>Improved validation speed sensible for DocBook</li>
430 <li>fixed a big bug with ID declared in external parsed entities</li>
431 <li>portability fixes, update of Trio from Bjorn Reese</li>
432</ul>
433
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]434<h3>2.3.6: April 8 2001</h3>
435<ul>
436 <li>Code cleanup using extreme gcc compiler warning options, found and
437 cleared half a dozen potential problem</li>
438 <li>the Eazel team found an XML parser bug</li>
439 <li>cleaned up the user of some of the string formatting function. used the
440 trio library code to provide the one needed when the platform is missing
441 them</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]442 <li>xpath: removed a memory leak and fixed the predicate evaluation
443 problem, extended the testsuite and cleaned up the result. XPointer seems
444 broken ...</li>
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]445</ul>
446
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]447<h3>2.3.5: Mar 23 2001</h3>
448<ul>
449 <li>Biggest change is separate parsing and evaluation of XPath expressions,
450 there is some new APIs for this too</li>
451 <li>included a number of bug fixes(XML push parser, 51876, notations,
452 52299)</li>
453 <li>Fixed some portability issues</li>
454</ul>
455
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]456<h3>2.3.4: Mar 10 2001</h3>
457<ul>
458 <li>Fixed bugs #51860 and #51861</li>
459 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
460 size to be application tunable.</li>
461 <li>Some cleanup in the validation code, still a bug left and this part
462 should probably be rewritten to support ambiguous content model :-\</li>
463 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
464 parser</li>
465 <li>Fixed another bug in xmlNodeGetContent()</li>
466 <li>Bjorn fixed XPath node collection and Number formatting</li>
467 <li>Fixed a loop reported in the HTML parsing</li>
468 <li>blank space are reported even if the Dtd content model proves that they
469 are formatting spaces, this is for XmL conformance</li>
470</ul>
471
Daniel Veillardb402c072001-03-01 17:28:58 +0000[diff] [blame]472<h3>2.3.3: Mar 1 2001</h3>
473<ul>
474 <li>small change in XPath for XSLT</li>
475 <li>documentation cleanups</li>
476 <li>fix in validation by Gary Pennington</li>
477 <li>serious parsing performances improvements</li>
478</ul>
479
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]480<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +0000[diff] [blame]481<ul>
482 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
483 <li>fixed a Dtd parsing bug</li>
484 <li>fixed a bug in xmlNodeGetContent</li>
485 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
486</ul>
487
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]488<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]489<ul>
490 <li>some XPath and HTML bug fixes for XSLT</li>
491 <li>small extension of the hash table interfaces for DOM gdome2
492 implementation</li>
493 <li>A few bug fixes</li>
494</ul>
495
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]496<h3>2.3.0: Feb 8 2001 (2.2.12 was on 25 Jan but I didn't kept track)</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]497<ul>
498 <li>Lots of XPath bug fixes</li>
499 <li>Add a mode with Dtd lookup but without validation error reporting for
500 XSLT</li>
501 <li>Add support for text node without escaping (XSLT)</li>
502 <li>bug fixes for xmlCheckFilename</li>
503 <li>validation code bug fixes from Gary Pennington</li>
504 <li>Patch from Paul D. Smith correcting URI path normalization</li>
505 <li>Patch to allow simultaneous install of libxml-devel and
506 libxml2-devel</li>
507 <li>the example Makefile is now fixed</li>
508 <li>added HTML to the RPM packages</li>
509 <li>tree copying bugfixes</li>
510 <li>updates to Windows makefiles</li>
511 <li>optimisation patch from Bjorn Reese</li>
512</ul>
513
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]514<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]515<ul>
516 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
517 <li>added htmlHandleOmittedElem()</li>
518 <li>Applied Bjorn Reese's IPV6 first patch</li>
519 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]520 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]521</ul>
522
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]523<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +0000[diff] [blame]524<ul>
525 <li>Fix the Windows problems of 2.2.8</li>
526 <li>integrate OpenVMS patches</li>
527 <li>better handling of some nasty HTML input</li>
528 <li>Improved the XPointer implementation</li>
529 <li>integrate a number of provided patches</li>
530</ul>
531
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]532<h3>2.2.9: Nov 25 2000</h3>
533<ul>
534 <li>erroneous release :-(</li>
535</ul>
536
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]537<h3>2.2.8: Nov 13 2000</h3>
538<ul>
539 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
540 support</li>
541 <li>Patch in conditional section handling</li>
542 <li>updated MS compiler project</li>
543 <li>fixed some XPath problems</li>
544 <li>added an URI escaping function</li>
545 <li>some other bug fixes</li>
546</ul>
547
548<h3>2.2.7: Oct 31 2000</h3>
549<ul>
550 <li>added message redirection</li>
551 <li>XPath improvements (thanks TOM !)</li>
552 <li>xmlIOParseDTD() added</li>
553 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
554 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
555</ul>
556
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]557<h3>2.2.6: Oct 25 2000:</h3>
558<ul>
559 <li>Added an hash table module, migrated a number of internal structure to
560 those</li>
561 <li>Fixed a posteriori validation problems</li>
562 <li>HTTP module cleanups</li>
563 <li>HTML parser improvements (tag errors, script/style handling, attribute
564 normalization)</li>
565 <li>coalescing of adjacent text nodes</li>
566 <li>couple of XPath bug fixes, exported the internal API</li>
567</ul>
568
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]569<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]570<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]571 <li>XPointer implementation and testsuite</li>
572 <li>Lot of XPath fixes, added variable and functions registration, more
573 tests</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]574 <li>Portability fixes, lots of enhancements toward an easy Windows build
575 and release</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]576 <li>Late validation fixes</li>
577 <li>Integrated a lot of contributed patches</li>
578 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]579 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]580</ul>
581
582<h3>2.2.4: Oct 1 2000:</h3>
583<ul>
584 <li>main XPath problem fixed</li>
585 <li>Integrated portability patches for Windows</li>
586 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]587</ul>
588
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]589<h3>2.2.3: Sep 17 2000</h3>
590<ul>
591 <li>bug fixes</li>
592 <li>cleanup of entity handling code</li>
593 <li>overall review of all loops in the parsers, all sprintf usage has been
594 checked too</li>
595 <li>Far better handling of larges Dtd. Validating against Docbook XML Dtd
596 works smoothly now.</li>
597</ul>
598
599<h3>1.8.10: Sep 6 2000</h3>
600<ul>
601 <li>bug fix release for some Gnome projects</li>
602</ul>
603
604<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]605<ul>
606 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]607 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]608</ul>
609
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]610<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]611<ul>
612 <li>a purely bug fixes release</li>
613 <li>fixed an encoding support problem when parsing from a memory block</li>
614 <li>fixed a DOCTYPE parsing problem</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]615 <li>removed a bug in the function allowing to override the memory
616 allocation routines</li>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]617</ul>
618
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]619<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]620<ul>
621 <li>applied a lot of portability fixes</li>
622 <li>better encoding support/cleanup and saving (content is now always
623 encoded in UTF-8)</li>
624 <li>the HTML parser now correctly handles encodings</li>
625 <li>added xmlHasProp()</li>
626 <li>fixed a serious problem with &amp;#38;</li>
627 <li>propagated the fix to FTP client</li>
628 <li>cleanup, bugfixes, etc ...</li>
629 <li>Added a page about <a href="encoding.html">libxml Internationalization
630 support</a></li>
631</ul>
632
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]633<h3>1.8.9: July 9 2000</h3>
634<ul>
635 <li>fixed the spec the RPMs should be better</li>
636 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
637 rpmfind users problem</li>
638</ul>
639
Daniel Veillard6388e172000-07-03 16:07:19 +0000[diff] [blame]640<h3>2.1.1: July 1 2000</h3>
641<ul>
642 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
643 <li>improvements on the HTML parser</li>
644</ul>
645
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]646<h3>2.1.0 and 1.8.8: June 29 2000</h3>
647<ul>
648 <li>1.8.8 is mostly a comodity package for upgrading to libxml2 accoding to
649 <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
650 about &amp;#38; charref parsing</li>
651 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
652 also contains numerous fixes and enhancements:
653 <ul>
654 <li>added xmlStopParser() to stop parsing</li>
655 <li>improved a lot parsing speed when there is large CDATA blocs</li>
656 <li>includes XPath patches provided by Picdar Technology</li>
657 <li>tried to fix as much as possible DtD validation and namespace
658 related problems</li>
659 <li>output to a given encoding has been added/tested</li>
660 <li>lot of various fixes</li>
661 </ul>
662 </li>
663</ul>
664
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]665<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]666<ul>
667 <li>First public release of libxml2. If you are using libxml, it's a good
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]668 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initally
669 scheduled for Apr 3 the relase occured only on Apr 12 due to massive
670 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]671 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]672 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]673 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]674 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]675 <pre>#include "xxx.h"</pre>
676 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000[diff] [blame]677 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
678 <li>the memory allocation routines used by libxml can now be overloaded
679 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]680 <li>The previously CVS only tool tester has been renamed
681 <strong>xmllint</strong> and is now installed as part of the libxml2
682 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]683 <li>The I/O interface has been revamped. There is now ways to plug in
684 specific I/O modules, either at the URI scheme detection level using
685 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
686 parser context using xmlCreateIOParserCtxt()</li>
687 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
688 number of the libxml module in use</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]689 <li>a number of optional features of libxml can now be excluded at
690 configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]691</ul>
692
693<h3>2.0.0beta: Mar 14 2000</h3>
694<ul>
695 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]696 <li>It's available only from<a href="ftp://xmlsoft.org/">xmlsoft.org
697 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
698 RPMs</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]699 <li>This version is now the head in the Gnome CVS base, the old one is
700 available under the tag LIB_XML_1_X</li>
701 <li>This includes a very large set of changes. Froma programmatic point of
702 view applications should not have to be modified too much, check the <a
703 href="upgrade.html">upgrade page</a></li>
704 <li>Some interfaces may changes (especially a bit about encoding).</li>
705 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]706 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]707 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
708 handled now</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]709 <li>Better handling of entities, especially well formedness checking
710 and proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]711 <li>DTD conditional sections</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]712 <li>Validation now correcly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]713 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
714 structures to accomodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]715 </ul>
716 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]717 <li>Serious progress were made toward compliance, <a
718 href="conf/result.html">here are the result of the test</a> against the
719 OASIS testsuite (except the japanese tests since I don't support that
720 encoding yet). This URL is rebuilt every couple of hours using the CVS
721 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]722</ul>
723
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]724<h3>1.8.7: Mar 6 2000</h3>
725<ul>
726 <li>This is a bug fix release:</li>
727 <li>It is possible to disable the ignorable blanks heuristic used by
728 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]729 that for adherence to XML spec, this behaviour will be disabled by
730 default in 2.x . The same function will allow to keep compatibility for
731 old code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]732 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
733 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]734 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
735 compilation on some platforms has been fixed</li>
736 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
737 URIs</li>
738</ul>
739
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]740<h3>1.8.6: Jan 31 2000</h3>
741<ul>
742 <li>added a nanoFTP transport module, debugged until the new version of <a
743 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
744 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000[diff] [blame]745</ul>
746
747<h3>1.8.5: Jan 21 2000</h3>
748<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]749 <li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]750 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
751 XML spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]752 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]753 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
754 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]755 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
756 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]757</ul>
758
759<h3>1.8.4: Jan 13 2000</h3>
760<ul>
761 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
762 <li>all exit() call should have been removed from libxml</li>
763 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
764 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]765</ul>
766
767<h3>1.8.3: Jan 5 2000</h3>
768<ul>
769 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]770 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillarddbfd6411999-12-28 16:35:14 +0000[diff] [blame]771 <li>lots of bug fixes and improvement added over XMas hollidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]772 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]773 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
774 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]775 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]776 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]777 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]778</ul>
779
780<h3>1.8.2: Dec 21 1999</h3>
781<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]782 <li>I got another problem with includes and C++, I hope this issue is fixed
783 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]784 <li>Added a few tree modification functions: xmlReplaceNode,
785 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
786 xmlDocSetRootElement</li>
787 <li>Tried to improve the HTML output with help from <a
788 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]789</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]790
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]791<h3>1.8.1: Dec 18 1999</h3>
792<ul>
793 <li>various patches to avoid troubles when using libxml with C++ compilers
794 the "namespace" keyword and C escaping in include files</li>
795 <li>a problem in one of the core macros IS_CHAR was corrected</li>
796 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
797 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]798 <li>fixed a posteriori validation (validation after parsing, or by using a
799 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]800 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]801</ul>
802
803<h3>1.8.0: Dec 12 1999</h3>
804<ul>
805 <li>cleanup, especially memory wise</li>
806 <li>the parser should be more reliable, especially the HTML one, it should
807 not crash, whatever the input !</li>
808 <li>Integrated various patches, especially a speedup improvement for large
809 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
810 configure with --with-buffers to enable them.</li>
811 <li>attribute normalization, oops should have been added long ago !</li>
812 <li>attributes defaulted from Dtds should be available, xmlSetProp() now
813 does entities escapting by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]814</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]815
816<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]817<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]818 <li>Lots of HTML improvement</li>
819 <li>Fixed some errors when saving both XML and HTML</li>
820 <li>More examples, the regression tests should now look clean</li>
821 <li>Fixed a bug with contiguous charref</li>
822</ul>
823
824<h3>1.7.3: Sep 29 1999</h3>
825<ul>
826 <li>portability problems fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]827 <li>snprintf was used unconditionnally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]828 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]829</ul>
830
831<h3>1.7.1: Sep 24 1999</h3>
832<ul>
833 <li>The basic type for strings manipulated by libxml has been renamed in
834 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]835 is that CHAR was conflicting with a predefined type on Windows. However
836 on non WIN32 environment, compatibility is provided by the way of a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]837 <strong>#define </strong>.</li>
838 <li>Changed another error : the use of a structure field called errno, and
839 leading to troubles on platforms where it's a macro</li>
840</ul>
841
842<h3>1.7.0: sep 23 1999</h3>
843<ul>
844 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]845 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]846 <li>Added an errno to report errors by another mean than a simple printf
847 like callback</li>
848 <li>Finished ID/IDREF support and checking when validation</li>
849 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]850 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]851 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
852 implementation</li>
853 <li>Added an HTML parser front-end</li>
854</ul>
855
856<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]857
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]858<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]859markup-based structured documents. Here is <a name="example">an example XML
860document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]861<pre>&lt;?xml version="1.0"?&gt;
862&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
863 &lt;head&gt;
864 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
865 &lt;/head&gt;
866 &lt;chapter&gt;
867 &lt;title&gt;The Linux adventure&lt;/title&gt;
868 &lt;p&gt;bla bla bla ...&lt;/p&gt;
869 &lt;image href="linus.gif"/&gt;
870 &lt;p&gt;...&lt;/p&gt;
871 &lt;/chapter&gt;
872&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]873
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]874<p>The first line specifies that it's an XML document and gives useful
875information about its encoding. Then the document is a text format whose
876structure is specified by tags between brackets. <strong>Each tag opened has
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]877to be closed</strong>. XML is pedantic about this. However, if a tag is empty
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]878(no content), a single tag can serve as both the opening and closing tag if
879it ends with <code>/&gt;</code> rather than with <code>&gt;</code>. Note
880that, for example, the image tag has no content (just an attribute) and is
881closed by ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]882
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]883<p>XML can be applied sucessfully to a wide range of uses, from long term
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]884structured document maintenance (where it follows the steps of SGML) to
885simple data encoding mechanisms like configuration file formatting (glade),
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]886spreadsheets (gnumeric), or even shorter lived documents such as WebDAV where
887it is used to encode remote calls between a client and a server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]888
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]889<h2><a name="XSLT">XSLT</a></h2>
890
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]891<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
892
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]893<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
894language for transforming XML documents into other XML documents (or
895HTML/textual output).</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]896
897<p>A separate library called libxslt is being built on top of libxml2. This
898module "libxslt" can be found in the Gnome CVS base too.</p>
899
Daniel Veillard383b1472001-01-23 11:39:52 +0000[diff] [blame]900<p>You can check the <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]901href="http://cvs.gnome.org/lxr/source/libxslt/FEATURES">features</a>
902supported and the progresses on the <a
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]903href="http://cvs.gnome.org/lxr/source/libxslt/ChangeLog">Changelog</a></p>
904
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]905<h2>An overview of libxml architecture</h2>
906
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]907<p>Libxml is made of multiple components; some of them are optional, and most
908of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]909<ul>
910 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]911 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]912 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]913 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]914 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]915 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]916 <li>a SAX tree module to build an in-memory DOM representation</li>
917 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]918 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]919 <li>an XPath module for global lookup in a DOM representation
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]920 (optional)</li>
921 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]922</ul>
923
924<p>Graphically this gives the following:</p>
925
926<p><img src="libxml.gif" alt="a graphical view of the various"></p>
927
928<p></p>
929
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]930<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]931
932<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]933returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]934<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]935as the file name, the document type, and a <strong>children</strong> pointer
936which is the root of the document (or more exactly the first child under the
937root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]938chained in double-linked lists of siblings and with a children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]939relationship. An xmlNode can also carry properties (a chain of xmlAttr
940structures). An attribute may have a value which is a list of TEXT or
941ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]942
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]943<p>Here is an example (erroneous with respect to the XML spec since there
944should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]945
946<p><img src="structure.gif" alt=" structure.gif "></p>
947
948<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]949called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]950prints them back as parsed. This is useful for detecting errors both in XML
951code and in the XML parser itself. It has an option <strong>--debug</strong>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]952which prints the actual in-memory structure of the document; here is the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]953result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]954<pre>DOCUMENT
955version=1.0
956standalone=true
957 ELEMENT EXAMPLE
958 ATTRIBUTE prop1
959 TEXT
960 content=gnome is great
961 ATTRIBUTE prop2
962 ENTITY_REF
963 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]964 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]965 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]966 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]967 TEXT
968 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]969 ELEMENT chapter
970 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]971 TEXT
972 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]973 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]974 TEXT
975 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]976 ELEMENT image
977 ATTRIBUTE href
978 TEXT
979 content=linus.gif
980 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]981 TEXT
982 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]983
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]984<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]985
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]986<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]987
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]988<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]989memory. In that case (and if you don't expect to save back the XML document
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]990loaded using libxml), it's better to use the SAX interface of libxml. SAX is
991a <strong>callback-based interface</strong> to the parser. Before parsing,
992the application layer registers a customized set of callbacks which are
993called by the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]994
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]995<p>To get more detailed step-by-step guidance on using the SAX interface of
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]996libxml, see the <a
997href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
998documentation</a>.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]999Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1000
1001<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
1002program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1003binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]1004distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1005testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1006<pre>SAX.setDocumentLocator()
1007SAX.startDocument()
1008SAX.getEntity(amp)
1009SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
1010SAX.characters( , 3)
1011SAX.startElement(head)
1012SAX.characters( , 4)
1013SAX.startElement(title)
1014SAX.characters(Welcome to Gnome, 16)
1015SAX.endElement(title)
1016SAX.characters( , 3)
1017SAX.endElement(head)
1018SAX.characters( , 3)
1019SAX.startElement(chapter)
1020SAX.characters( , 4)
1021SAX.startElement(title)
1022SAX.characters(The Linux adventure, 19)
1023SAX.endElement(title)
1024SAX.characters( , 4)
1025SAX.startElement(p)
1026SAX.characters(bla bla bla ..., 15)
1027SAX.endElement(p)
1028SAX.characters( , 4)
1029SAX.startElement(image, href='linus.gif')
1030SAX.endElement(image)
1031SAX.characters( , 4)
1032SAX.startElement(p)
1033SAX.characters(..., 3)
1034SAX.endElement(p)
1035SAX.characters( , 3)
1036SAX.endElement(chapter)
1037SAX.characters( , 1)
1038SAX.endElement(EXAMPLE)
1039SAX.endDocument()</pre>
1040
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1041<p>Most of the other interfaces of libxml are based on the DOM tree-building
1042facility, so nearly everything up to the end of this document presupposes the
1043use of the standard DOM tree build. Note that the DOM tree itself is built by
1044a set of registered default callbacks, without internal specific
1045interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1046
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1047<h2><a name="library">The XML library interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1048
1049<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1050using the XML library from the C language. It is not intended to be
1051extensive. I hope the automatically generated documents will provide the
1052completeness required, but as a separate set of documents. The interfaces of
1053the XML library are by principle low level, there is nearly zero abstraction.
1054Those interested in a higher level API should <a href="#DOM">look at
1055DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1056
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1057<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
1058separated from the <a href="html/libxml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1059interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1060
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1061<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1062
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1063<p>Usually, the first thing to do is to read an XML input. The parser accepts
1064documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1065defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1066<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1067 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1068 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1069 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1070</dl>
1071<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1072 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1073 <dd><p>Parse an XML document contained in a (possibly compressed)
1074 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1075 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1076</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1077
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1078<p>The parser returns a pointer to the document structure (or NULL in case of
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1079failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1080
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1081<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1082
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1083<p>In order for the application to keep the control when the document is
1084being fetched (which is common for GUI based programs) libxml provides a push
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1085interface, too, as of version 1.8.3. Here are the interface functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1086<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
1087 void *user_data,
1088 const char *chunk,
1089 int size,
1090 const char *filename);
1091int xmlParseChunk (xmlParserCtxtPtr ctxt,
1092 const char *chunk,
1093 int size,
1094 int terminate);</pre>
1095
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1096<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1097<pre> FILE *f;
1098
1099 f = fopen(filename, "r");
1100 if (f != NULL) {
1101 int res, size = 1024;
1102 char chars[1024];
1103 xmlParserCtxtPtr ctxt;
1104
1105 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1106 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1107 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
1108 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1109 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1110 xmlParseChunk(ctxt, chars, res, 0);
1111 }
1112 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1113 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1114 xmlFreeParserCtxt(ctxt);
1115 }
1116 }</pre>
1117
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1118<p>The HTML parser embedded into libxml also has a push interface; the
1119functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1120
1121<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
1122
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1123<p>The tree-building interface makes the parser memory-hungry, first loading
1124the document in memory and then building the tree itself. Reading a document
1125without building the tree is possible using the SAX interfaces (see SAX.h and
1126<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1127Henstridge's documentation</a>). Note also that the push interface can be
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1128limited to SAX: just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1129<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1130
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1131<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1132
1133<p>The other way to get an XML tree in memory is by building it. Basically
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1134there is a set of functions dedicated to building new elements. (These are
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1135also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
1136code that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1137<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1138 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1139 xmlNodePtr tree, subtree;
1140
1141 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1142 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
1143 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
1144 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
1145 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1146 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1147 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1148 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
1149 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
1150 subtree = xmlNewChild(tree, NULL, "image", NULL);
1151 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1152
1153<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1154
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1155<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1156
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1157<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1158code has access to the internal structure of all the elements of the tree.
1159The names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]1160<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1161<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]1162example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1163<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1164
1165<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1166<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1167
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1168<p>points to the text node containing the chapter title "The Linux
1169adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1170
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]1171<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1172present before the document root, so <code>doc-&gt;children</code> may point
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1173to an element which is not the document Root Element; a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]1174<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]1175
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1176<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1177
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1178<p>Functions are provided for reading and writing the document content. Here
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1179is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1180<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1181 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
1182 xmlChar *value);</code></dt>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1183 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
1184 The value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1185 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1186</dl>
1187<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1188 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1189 *name);</code></dt>
Daniel Veillardc92c3042000-09-29 02:42:04 +0000[diff] [blame]1190 <dd><p>This function returns a pointer to new copy of the property
1191 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1192 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1193</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1194
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1195<p>Two functions are provided for reading and writing the text associated
1196with elements:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1197<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1198 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1199 *value);</code></dt>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1200 <dd><p>This function takes an "external" string and converts it to one
1201 text node or possibly to a list of entity and text nodes. All
1202 non-predefined entity references like &amp;Gnome; will be stored
1203 internally as entity nodes, hence the result of the function may not be
1204 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1205 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1206</dl>
1207<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1208 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1209 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1210 <dd><p>This function is the inverse of
1211 <code>xmlStringGetNodeList()</code>. It generates a new string
1212 containing the content of the text and entity nodes. Note the extra
1213 argument inLine. If this argument is set to 1, the function will expand
1214 entity references. For example, instead of returning the &amp;Gnome;
1215 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1216 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1217 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1218</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1219
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1220<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1221
1222<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1223<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]1224 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1225 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1226 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1227 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1228</dl>
1229<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1230 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1231 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1232 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1233</dl>
1234<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1235 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1236 <dd><p>Saves the document to a file. In this case, the compression
1237 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1238 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1239</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]1240
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1241<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1242
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1243<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1244accesses. The level of compression on saves can be turned on either globally
1245or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1246<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1247 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1248 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1249 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1250</dl>
1251<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1252 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1253 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1254 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1255</dl>
1256<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1257 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1258 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1259 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1260</dl>
1261<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1262 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1263 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1264 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]1265</dl>
1266
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1267<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1268
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1269<p>Entities in principle are similar to simple C macros. An entity defines an
1270abbreviation for a given string that you can reuse many times throughout the
1271content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1272may occur frequently within a document, or to confine the change needed to a
1273document to a restricted area in the internal subset of the document (at the
1274beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1275<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]12762 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]12773 &lt;!ENTITY xml "Extensible Markup Language"&gt;
12784 ]&gt;
12795 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]12806 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]12817 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1282
1283<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1284its name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1285are 5 predefined entities in libxml allowing you to escape charaters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1286predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1287<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1288for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1289<strong>&amp;quot;</strong> for the character '"', and
1290<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1291
1292<p>One of the problems related to entities is that you may want the parser to
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1293substitute an entity's content so that you can see the replacement text in
1294your application. Or you may prefer to keep entity references as such in the
1295content to be able to save the document back without losing this usually
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1296precious information (if the user went through the pain of explicitly
1297defining entities, he may have a a rather negative attitude if you blindly
1298susbtitute them as saving time). The <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]1299href="html/libxml-parser.html#XMLSUBSTITUTEENTITIESDEFAULT">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1300function allows you to check and change the behaviour, which is to not
1301substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1302
1303<p>Here is the DOM tree built by libxml for the previous document in the
1304default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1305<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1306DOCUMENT
1307version=1.0
1308 ELEMENT EXAMPLE
1309 TEXT
1310 content=
1311 ENTITY_REF
1312 INTERNAL_GENERAL_ENTITY xml
1313 content=Extensible Markup Language
1314 TEXT
1315 content=</pre>
1316
1317<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1318<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1319DOCUMENT
1320version=1.0
1321 ELEMENT EXAMPLE
1322 TEXT
1323 content= Extensible Markup Language</pre>
1324
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1325<p>So, entities or no entities? Basically, it depends on your use case. I
1326suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1327entities in your XML document or data if you are not willing to handle the
1328entity references elements in the DOM tree.</p>
1329
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1330<p>Note that at save time libxml enforces the conversion of the predefined
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1331entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1332transparently replace those with chars (i.e. it will not generate entity
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1333reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1334finding them in the input).</p>
1335
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1336<p><span style="background-color: #FF0000">WARNING</span>: handling entities
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1337on top of the libxml SAX interface is difficult!!! If you plan to use
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1338non-predefined entities in your documents, then the learning cuvre to handle
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1339then using the SAX API may be long. If you plan to use complex documents, I
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1340strongly suggest you consider using the DOM interface instead and let libxml
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000[diff] [blame]1341deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]1342
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1343<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1344
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]1345<p>The libxml library implements <a
1346href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
1347recognizing namespace contructs in the input, and does namespace lookup
1348automatically when building the DOM tree. A namespace declaration is
1349associated with an in-memory structure and all elements or attributes within
1350that namespace point to it. Hence testing the namespace is a simple and fast
1351equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1352
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1353<p>I suggest that people using libxml use a namespace, and declare it in the
1354root element of their document as the default namespace. Then they don't need
1355to use the prefix in the content but we will have a basis for future semantic
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1356refinement and merging of data from different sources. This doesn't increase
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1357the size of the XML output significantly, but significantly increases its
1358value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1359<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
1360 &lt;elem1&gt;...&lt;/elem1&gt;
1361 &lt;elem2&gt;...&lt;/elem2&gt;
1362&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1363
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1364<p>The namespace value has to be an absolute URL, but the URL doesn't have to
1365point to any existing resource on the Web. It will bind all the element and
1366atributes with that URL. I suggest to use an URL within a domain you control,
1367and that the URL should contain some kind of version information if possible.
1368For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a good
1369namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]1370
1371<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]1372version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1373and if the version information don't match something you know, warn the user
1374and be liberal in what you accept as the input. Also do *not* try to base
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1375namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1376same as &lt;bar:text&gt; in another document. What really matters is the URI
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1377associated with the element or the attribute, not the prefix string (which is
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1378just a shortcut for the full URI). In libxml, element and attributes have an
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]1379<code>ns</code> field pointing to an xmlNs structure detailing the namespace
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1380prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1381
1382<p>@@Interfaces@@</p>
1383
1384<p>@@Examples@@</p>
1385
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1386<p>Usually people object to using namespaces together with validity checking.
1387I will try to make sure that using namespaces won't break validity checking,
1388so even if you plan to use or currently are using validation I strongly
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]1389suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1390<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1391flexible parsers. Using namespaces to mix and differentiate content coming
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1392from multiple DTDs will certainly break current validation schemes. I will
1393try to provide ways to do this, but this may not be portable or
1394standardized.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1395
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]1396<h2><a name="Validation">Validation, or are you afraid of DTDs ?</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1397
1398<p>Well what is validation and what is a DTD ?</p>
1399
1400<p>Validation is the process of checking a document against a set of
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1401construction rules; a <strong>DTD</strong> (Document Type Definition) is such
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1402a set of rules.</p>
1403
1404<p>The validation process and building DTDs are the two most difficult parts
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1405of the XML life cycle. Briefly a DTD defines all the possibles element to be
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1406found within your document, what is the formal shape of your document tree
1407(by defining the allowed content of an element, either text, a regular
1408expression for the allowed list of children, or mixed content i.e. both text
1409and children). The DTD also defines the allowed attributes for all elements
1410and the types of the attributes. For more detailed information, I suggest
1411that you read the related parts of the XML specification, the examples found
1412under gnome-xml/test/valid/dtd and any of the large number of books available
1413on XML. The dia example in gnome-xml/test/valid should be both simple and
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1414complete enough to allow you to build your own.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1415
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1416<p>A word of warning, building a good DTD which will fit the needs of your
1417application in the long-term is far from trivial; however, the extra level of
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1418quality it can ensure is well worth the price for some sets of applications
1419or if you already have already a DTD defined for your application field.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1420
1421<p>The validation is not completely finished but in a (very IMHO) usable
1422state. Until a real validation interface is defined the way to do it is to
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1423define and set the <strong>xmlDoValidityCheckingDefaultValue</strong>
1424external variable to 1, this will of course be changed at some point:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1425
1426<p>extern int xmlDoValidityCheckingDefaultValue;</p>
1427
1428<p>...</p>
1429
1430<p>xmlDoValidityCheckingDefaultValue = 1;</p>
1431
1432<p></p>
1433
1434<p>To handle external entities, use the function
1435<strong>xmlSetExternalEntityLoader</strong>(xmlExternalEntityLoader f); to
1436link in you HTTP/FTP/Entities database library to the standard libxml
1437core.</p>
1438
1439<p>@@interfaces@@</p>
1440
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]1441<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1442
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1443<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
1444Object Model</em>; this is an API for accessing XML or HTML structured
1445documents. Native support for DOM in Gnome is on the way (module gnome-dom),
1446and will be based on gnome-xml. This will be a far cleaner interface to
1447manipulate XML files within Gnome since it won't expose the internal
1448structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1449
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1450<p>The current DOM implementation on top of libxml is the <a
Daniel Veillarda47fb3d2001-03-25 17:23:49 +0000[diff] [blame]1451href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this
1452is a full DOM interface, thanks to Paolo Casarini, check the <a
1453href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more
1454informations.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1455
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]1456<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1457
1458<p>Here is a real size example, where the actual content of the application
1459data is not kept in the DOM tree but uses internal structures. It is based on
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1460a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1461storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
1462base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1463<pre>&lt;?xml version="1.0"?&gt;
1464&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
1465 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1466
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1467 &lt;gjob:Job&gt;
1468 &lt;gjob:Project ID="3"/&gt;
1469 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
1470 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1471
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1472 &lt;gjob:Update&gt;
1473 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
1474 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
1475 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
1476 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1477
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1478 &lt;gjob:Developers&gt;
1479 &lt;gjob:Developer&gt;
1480 &lt;/gjob:Developer&gt;
1481 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1482
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1483 &lt;gjob:Contact&gt;
1484 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
1485 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
1486 &lt;gjob:Company&gt;
1487 &lt;/gjob:Company&gt;
1488 &lt;gjob:Organisation&gt;
1489 &lt;/gjob:Organisation&gt;
1490 &lt;gjob:Webpage&gt;
1491 &lt;/gjob:Webpage&gt;
1492 &lt;gjob:Snailmail&gt;
1493 &lt;/gjob:Snailmail&gt;
1494 &lt;gjob:Phone&gt;
1495 &lt;/gjob:Phone&gt;
1496 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1497
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1498 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1499 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1500 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1501
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1502 &lt;gjob:Skills&gt;
1503 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1504
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1505 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1506 A GNOME based system that will allow a superuser to configure
1507 compressed and uncompressed files and/or file systems to be backed
1508 up with a supported media in the system. This should be able to
1509 perform via find commands generating a list of files that are passed
1510 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
1511 or via operations performed on the filesystem itself. Email
1512 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1513 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1514
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1515 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1516
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1517 &lt;/gjob:Jobs&gt;
1518&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1519
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1520<p>While loading the XML file into an internal DOM tree is a matter of
1521calling only a couple of functions, browsing the tree to gather the ata and
1522generate the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1523
1524<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1525structure. For example, the ordering of the attributes is not significant,
1526the XML specification is clear about it. It's also usually a good idea not to
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1527depend on the order of the children of a given node, unless it really makes
1528things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1529<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1530 * A person record
1531 */
1532typedef struct person {
1533 char *name;
1534 char *email;
1535 char *company;
1536 char *organisation;
1537 char *smail;
1538 char *webPage;
1539 char *phone;
1540} person, *personPtr;
1541
1542/*
1543 * And the code needed to parse it
1544 */
1545personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1546 personPtr ret = NULL;
1547
1548DEBUG("parsePerson\n");
1549 /*
1550 * allocate the struct
1551 */
1552 ret = (personPtr) malloc(sizeof(person));
1553 if (ret == NULL) {
1554 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1555 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1556 }
1557 memset(ret, 0, sizeof(person));
1558
1559 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1560 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1561 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1562 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
1563 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1564 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
1565 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1566 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1567 }
1568
1569 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1570}</pre>
1571
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1572<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1573<ul>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]1574 <li>Usually a recursive parsing style is the more convenient one: XML data
1575 is by nature subject to repetitive constructs and usually exibits highly
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1576 stuctured patterns.</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1577 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
1578 i.e. the pointer to the global XML document and the namespace reserved to
1579 the application. Document wide information are needed for example to
1580 decode entities and it's a good coding practice to define a namespace for
1581 your application set of data and test that the element and attributes
1582 you're analyzing actually pertains to your application space. This is
1583 done by a simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1584 <li>To retrieve text and attributes value, you can use the function
1585 <em>xmlNodeListGetString</em> to gather all the text and entity reference
1586 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1587</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1588
1589<p>Here is another piece of code used to parse another level of the
1590structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1591<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1592/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1593 * a Description for a Job
1594 */
1595typedef struct job {
1596 char *projectID;
1597 char *application;
1598 char *category;
1599 personPtr contact;
1600 int nbDevelopers;
1601 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
1602} job, *jobPtr;
1603
1604/*
1605 * And the code needed to parse it
1606 */
1607jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
1608 jobPtr ret = NULL;
1609
1610DEBUG("parseJob\n");
1611 /*
1612 * allocate the struct
1613 */
1614 ret = (jobPtr) malloc(sizeof(job));
1615 if (ret == NULL) {
1616 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1617 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1618 }
1619 memset(ret, 0, sizeof(job));
1620
1621 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1622 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1623 while (cur != NULL) {
1624
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1625 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
1626 ret-&gt;projectID = xmlGetProp(cur, "ID");
1627 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1628 fprintf(stderr, "Project has no ID\n");
1629 }
1630 }
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1631 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
1632 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1633 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
1634 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
1635 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
1636 ret-&gt;contact = parsePerson(doc, ns, cur);
1637 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1638 }
1639
1640 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1641}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]1642
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1643<p>Once you are used to it, writing this kind of code is quite simple, but
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1644boring. Ultimately, it could be possble to write stubbers taking either C
1645data structure definitions, a set of XML examples or an XML DTD and produce
1646the code needed to import and export the content between C data and XML
1647storage. This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1648
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]1649<p>Feel free to use <a href="example/gjobread.c">the code for the full C
1650parsing example</a> as a template, it is also available with Makefile in the
1651Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]1652
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1653<h2><a name="Contributi">Contributions</a></h2>
1654<ul>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1655 <li><a href="mailto:ari@lusis.org">Ari Johnson</a>
1656 provides a C++ wrapper for libxml:
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1657 <p>Website: <a
1658 href="http://lusis.org/~ari/xml++/">http://lusis.org/~ari/xml++/</a></p>
1659 <p>Download: <a
1660 href="http://lusis.org/~ari/xml++/libxml++.tar.gz">http://lusis.org/~ari/xml++/libxml++.tar.gz</a></p>
1661 </li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1662 <li><a href="mailto:izlatkovic@daenet.de">Igor Zlatkovic</a>
1663 is now the maintainer of the Windows port, <a
Daniel Veillard95189532001-07-26 18:30:26 +0000[diff] [blame]1664 href="http://www.fh-frankfurt.de/~igor/projects/libxml/index.html">he
1665 provides binaries</a></li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]1666 <li><a
1667 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1668 Sergeant</a>
1669 developped <a href="http://axkit.org/download/">XML::LibXSLT</a>, a perl
1670 wrapper for libxml2/libxslt as part of the <a
1671 href="http://axkit.com/">AxKit XML application server</a></li>
1672 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a>
1673 and <a href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
Daniel Veillardca989762001-06-23 17:39:29 +0000[diff] [blame]1674 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]1675 documentation</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1676 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a>
1677 provided <a href="http://xmlsoft.org/messages/0488.html">man
1678 pages</a></li>
Daniel Veillard5168dbf2001-07-07 00:18:23 +0000[diff] [blame]1679 <li>there is a module for <a
1680 href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
1681 in OpenNSD/AOLServer</a></li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1682 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a>
1683 provides libxml/libxslt <a href="http://www.rexx.com/~dkuhlman">wrappers
1684 for Python</a></li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]1685</ul>
1686
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1687<p></p>
1688
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]1689<p><a href="mailto:daniel@veillard.com">Daniel Veillard</a></p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]1690
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame^]1691<p>$Id: xml.html,v 1.109 2001/09/12 18:51:29 veillard Exp $</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]1692</body>
1693</html>