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