blob: d6abd5037385118a6adc64fdd617e1eb6c0ad857 [file] [log] [blame]
Daniel Veillard09ab7e12001-07-10 15:49:44 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
Daniel Veillardccb09631998-10-27 06:21:04 +00003<html>
4<head>
Daniel Veillard598bec32003-07-06 10:02:03 +00005 <title>The XML C parser and toolkit of Gnome</title>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02006 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Daniel Veillardccb09631998-10-27 06:21:04 +00007</head>
Daniel Veillardb05deb71999-08-10 19:04:08 +00008<body bgcolor="#ffffff">
Daniel Veillard598bec32003-07-06 10:02:03 +00009<h1 align="center">The XML C parser and toolkit of Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +000010
Daniel Veillardf781dba2006-06-09 13:34:49 +000011<h1>Note: this is the flat content of the <a href="index.html">web
12site</a></h1>
Daniel Veillard9c466822001-10-25 12:03:39 +000013
Daniel Veillardc9484202001-10-24 12:35:52 +000014<h1 style="text-align: center">libxml, a.k.a. gnome-xml</h1>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000015
16<p></p>
Daniel Veillard9c466822001-10-25 12:03:39 +000017
Daniel Veillard7ebac022004-02-25 22:36:35 +000018<p
Daniel Veillardf781dba2006-06-09 13:34:49 +000019style="text-align: right; font-style: italic; font-size: 10pt">"Programming
20with libxml2 is like the thrilling embrace of an exotic stranger." <a
21href="http://diveintomark.org/archives/2004/02/18/libxml2">Mark
22Pilgrim</a></p>
Daniel Veillard7ebac022004-02-25 22:36:35 +000023
Daniel Veillardf781dba2006-06-09 13:34:49 +000024<p>Libxml2 is the XML C parser and toolkit developed for the Gnome project
25(but usable outside of the Gnome platform), it is free software available
26under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT
27License</a>. XML itself is a metalanguage to design markup languages, i.e.
28text language where semantic and structure are added to the content using
29extra "markup" information enclosed between angle brackets. HTML is the most
30well-known markup language. Though the library is written in C <a
31href="python.html">a variety of language bindings</a> make it available in
32other environments.</p>
Daniel Veillard9c466822001-10-25 12:03:39 +000033
Daniel Veillardf781dba2006-06-09 13:34:49 +000034<p>Libxml2 is known to be very portable, the library should build and work
35without serious troubles on a variety of systems (Linux, Unix, Windows,
Daniel Veillardd1e312a2009-08-24 11:58:20 +020036CygWin, MacOS, MacOS X, RISC Os, OS/2, VMS, QNX, MVS, VxWorks, ...)</p>
Daniel Veillard710823b2003-03-04 10:05:52 +000037
Daniel Veillardf781dba2006-06-09 13:34:49 +000038<p>Libxml2 implements a number of existing standards related to markup
39languages:</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +000040<ul>
Daniel Veillard9c466822001-10-25 12:03:39 +000041 <li>the XML standard: <a
42 href="http://www.w3.org/TR/REC-xml">http://www.w3.org/TR/REC-xml</a></li>
43 <li>Namespaces in XML: <a
44 href="http://www.w3.org/TR/REC-xml-names/">http://www.w3.org/TR/REC-xml-names/</a></li>
45 <li>XML Base: <a
46 href="http://www.w3.org/TR/xmlbase/">http://www.w3.org/TR/xmlbase/</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +000047 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc2396.txt">RFC 2396</a> :
48 Uniform Resource Identifiers <a
Daniel Veillard9c466822001-10-25 12:03:39 +000049 href="http://www.ietf.org/rfc/rfc2396.txt">http://www.ietf.org/rfc/rfc2396.txt</a></li>
50 <li>XML Path Language (XPath) 1.0: <a
51 href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</a></li>
52 <li>HTML4 parser: <a
53 href="http://www.w3.org/TR/html401/">http://www.w3.org/TR/html401/</a></li>
Daniel Veillard23a52c52003-08-18 10:01:18 +000054 <li>XML Pointer Language (XPointer) Version 1.0: <a
Daniel Veillard9c466822001-10-25 12:03:39 +000055 href="http://www.w3.org/TR/xptr">http://www.w3.org/TR/xptr</a></li>
56 <li>XML Inclusions (XInclude) Version 1.0: <a
57 href="http://www.w3.org/TR/xinclude/">http://www.w3.org/TR/xinclude/</a></li>
Daniel Veillard23a52c52003-08-18 10:01:18 +000058 <li>ISO-8859-x encodings, as well as <a
Daniel Veillardf781dba2006-06-09 13:34:49 +000059 href="http://www.cis.ohio-state.edu/rfc/rfc2044.txt">rfc2044</a> [UTF-8]
60 and <a href="http://www.cis.ohio-state.edu/rfc/rfc2781.txt">rfc2781</a>
61 [UTF-16] Unicode encodings, and more if using iconv support</li>
Daniel Veillard9c466822001-10-25 12:03:39 +000062 <li>part of SGML Open Technical Resolution TR9401:1997</li>
63 <li>XML Catalogs Working Draft 06 August 2001: <a
64 href="http://www.oasis-open.org/committees/entity/spec-2001-08-06.html">http://www.oasis-open.org/committees/entity/spec-2001-08-06.html</a></li>
Daniel Veillard5c396542002-03-15 07:57:50 +000065 <li>Canonical XML Version 1.0: <a
Daniel Veillardf781dba2006-06-09 13:34:49 +000066 href="http://www.w3.org/TR/xml-c14n">http://www.w3.org/TR/xml-c14n</a>
67 and the Exclusive XML Canonicalization CR draft <a
Daniel Veillard2d347fa2002-03-17 10:34:11 +000068 href="http://www.w3.org/TR/xml-exc-c14n">http://www.w3.org/TR/xml-exc-c14n</a></li>
Daniel Veillard758c5312003-12-15 11:51:25 +000069 <li>Relax NG, ISO/IEC 19757-2:2003, <a
Daniel Veillard17bed982003-02-24 20:11:43 +000070 href="http://www.oasis-open.org/committees/relax-ng/spec-20011203.html">http://www.oasis-open.org/committees/relax-ng/spec-20011203.html</a></li>
Daniel Veillardf83a2c72003-04-08 13:48:40 +000071 <li>W3C XML Schemas Part 2: Datatypes <a
Daniel Veillardf781dba2006-06-09 13:34:49 +000072 href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/">REC 02 May
73 2001</a></li>
74 <li>W3C <a href="http://www.w3.org/TR/xml-id/">xml:id</a> Working Draft 7
75 April 2004</li>
Daniel Veillard96984452000-08-31 13:50:12 +000076</ul>
77
Daniel Veillardf781dba2006-06-09 13:34:49 +000078<p>In most cases libxml2 tries to implement the specifications in a
79relatively strictly compliant way. As of release 2.4.16, libxml2 passed all
801800+ tests from the <a
81href="http://www.oasis-open.org/committees/xml-conformance/">OASIS XML Tests
82Suite</a>.</p>
Daniel Veillard5b16f582002-02-20 11:38:46 +000083
Daniel Veillardf781dba2006-06-09 13:34:49 +000084<p>To some extent libxml2 provides support for the following additional
85specifications but doesn't claim to implement them completely:</p>
Daniel Veillard9c466822001-10-25 12:03:39 +000086<ul>
87 <li>Document Object Model (DOM) <a
Daniel Veillardf781dba2006-06-09 13:34:49 +000088 href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>
89 the document model, but it doesn't implement the API itself, gdome2 does
90 this on top of libxml2</li>
91 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc959.txt">RFC 959</a> :
92 libxml2 implements a basic FTP client code</li>
93 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc1945.txt">RFC 1945</a> :
94 HTTP/1.0, again a basic HTTP client code</li>
95 <li>SAX: a SAX2 like interface and a minimal SAX1 implementation compatible
96 with early expat versions</li>
Daniel Veillard9c466822001-10-25 12:03:39 +000097</ul>
98
Daniel Veillardf83a2c72003-04-08 13:48:40 +000099<p>A partial implementation of <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000100href="http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/">XML Schemas Part
1011: Structure</a> is being worked on but it would be far too early to make any
102conformance statement about it at the moment.</p>
Daniel Veillarde6d8e202002-05-02 06:11:10 +0000103
Daniel Veillard96984452000-08-31 13:50:12 +0000104<p>Separate documents:</p>
105<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000106 <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a> providing an
107 implementation of XSLT 1.0 and common extensions like EXSLT for
108 libxml2</li>
William M. Brack43a87292007-02-15 20:41:02 +0000109 <li><a href="http://gdome2.cs.unibo.it/">the gdome2 page</a>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000110 : a standard DOM2 implementation for libxml2</li>
111 <li><a href="http://www.aleksey.com/xmlsec/">the XMLSec page</a>: an
112 implementation of <a href="http://www.w3.org/TR/xmldsig-core/">W3C XML
113 Digital Signature</a> for libxml2</li>
Daniel Veillardfde74702009-07-24 09:01:46 +0200114 <li>also check the related links section for more related and active
Daniel Veillardf781dba2006-06-09 13:34:49 +0000115 projects.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000116</ul>
Daniel Veillardfde74702009-07-24 09:01:46 +0200117<p> Hosting sponsored by <a href="http://www.aoemedia.de/opensource-cms.html"
118>Open Source CMS services</a> from AOE media.</p>
Daniel Veillard806cada2003-03-19 21:58:59 +0000119
Daniel Veillarde1662542002-08-28 11:50:59 +0000120<p>Logo designed by <a href="mailto:liyanage@access.ch">Marc Liyanage</a>.</p>
121
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000122<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000123
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000124<p>This document describes libxml, the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000125href="http://www.w3.org/XML/">XML</a> C parser and toolkit developed for the
126<a href="http://www.gnome.org/">Gnome</a> project. <a
127href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
128structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000129
Daniel Veillard0142b842000-01-14 14:45:24 +0000130<p>Here are some key points about libxml:</p>
131<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000132 <li>Libxml2 exports Push (progressive) and Pull (blocking) type parser
133 interfaces for both XML and HTML.</li>
134 <li>Libxml2 can do DTD validation at parse time, using a parsed document
135 instance, or with an arbitrary DTD.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000136 <li>Libxml2 includes complete <a
Daniel Veillard8c2ecaf2001-07-10 17:53:07 +0000137 href="http://www.w3.org/TR/xpath">XPath</a>, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000138 href="http://www.w3.org/TR/xptr">XPointer</a> and <a
139 href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li>
140 <li>It is written in plain C, making as few assumptions as possible, and
141 sticking closely to ANSI C/POSIX for easy embedding. Works on
142 Linux/Unix/Windows, ported to a number of other platforms.</li>
143 <li>Basic support for HTTP and FTP client allowing applications to fetch
144 remote resources.</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000145 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000146 <li>The internal document representation is as close as possible to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000147 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000148 <li>Libxml2 also has a <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000149 href="http://www.megginson.com/SAX/index.html">SAX like interface</a>;
150 the interface is designed to be compatible with <a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000151 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardc575b992002-02-08 13:28:40 +0000152 <li>This library is released under the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000153 href="http://www.opensource.org/licenses/mit-license.html">MIT
154 License</a>. See the Copyright file in the distribution for the precise
155 wording.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000156</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000157
Daniel Veillardf781dba2006-06-09 13:34:49 +0000158<p>Warning: unless you are forced to because your application links with a
159Gnome-1.X library requiring it, <strong><span
160style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
161libxml2</p>
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000162
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000163<h2><a name="FAQ">FAQ</a></h2>
164
Daniel Veillard0b28e882002-07-24 23:47:05 +0000165<p>Table of Contents:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000166<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000167 <li><a href="FAQ.html#License">License(s)</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000168 <li><a href="FAQ.html#Installati">Installation</a></li>
169 <li><a href="FAQ.html#Compilatio">Compilation</a></li>
170 <li><a href="FAQ.html#Developer">Developer corner</a></li>
171</ul>
172
Daniel Veillard63d83142002-05-20 06:51:05 +0000173<h3><a name="License">License</a>(s)</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000174<ol>
175 <li><em>Licensing Terms for libxml</em>
Daniel Veillard8a469172003-06-12 16:05:07 +0000176 <p>libxml2 is released under the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000177 href="http://www.opensource.org/licenses/mit-license.html">MIT
178 License</a>; see the file Copyright in the distribution for the precise
179 wording</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000180 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000181 <li><em>Can I embed libxml2 in a proprietary application ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000182 <p>Yes. The MIT License allows you to keep proprietary the changes you
183 made to libxml, but it would be graceful to send-back bug fixes and
184 improvements as patches for possible incorporation in the main
185 development tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000186 </li>
187</ol>
188
189<h3><a name="Installati">Installation</a></h3>
190<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000191 <li><strong><span style="background-color: #FF0000">Do Not Use
192 libxml1</span></strong>, use libxml2</li>
William M. Brack43a87292007-02-15 20:41:02 +0000193 <p></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000194 <li><em>Where can I get libxml</em> ?
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000195 <p>The original distribution comes from <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000196 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> or <a
Daniel Veillard024f1992003-12-10 16:43:49 +0000197 href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">gnome.org</a></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000198 <p>Most Linux and BSD distributions include libxml, this is probably the
199 safer way for end-users to use libxml.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000200 <p>David Doolin provides precompiled Windows versions at <a
201 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/ ">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
202 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000203 <p></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000204 <li><em>I see libxml and libxml2 releases, which one should I install ?</em>
205 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000206 <li>If you are not constrained by backward compatibility issues with
207 existing applications, install libxml2 only</li>
208 <li>If you are not doing development, you can safely install both.
209 Usually the packages <a
210 href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a> and <a
211 href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a> are
212 compatible (this is not the case for development packages).</li>
213 <li>If you are a developer and your system provides separate packaging
214 for shared libraries and the development components, it is possible
215 to install libxml and libxml2, and also <a
216 href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>
217 and <a
218 href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>
219 too for libxml2 &gt;= 2.3.0</li>
220 <li>If you are developing a new application, please develop against
221 libxml2(-devel)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000222 </ul>
223 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000224 <li><em>I can't install the libxml package, it conflicts with libxml0</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000225 <p>You probably have an old libxml0 package used to provide the shared
226 library for libxml.so.0, you can probably safely remove it. The libxml
227 packages provided on <a
228 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> provide
229 libxml.so.0</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000230 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000231 <li><em>I can't install the libxml(2) RPM package due to failed
232 dependencies</em>
233 <p>The most generic solution is to re-fetch the latest src.rpm , and
234 rebuild it locally with</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000235 <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000236 <p>If everything goes well it will generate two binary rpm packages (one
237 providing the shared libs and xmllint, and the other one, the -devel
238 package, providing includes, static libraries and scripts needed to build
239 applications with libxml(2)) that you can install locally.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000240 </li>
241</ol>
242
243<h3><a name="Compilatio">Compilation</a></h3>
244<ol>
Daniel Veillard8a469172003-06-12 16:05:07 +0000245 <li><em>What is the process to compile libxml2 ?</em>
246 <p>As most UNIX libraries libxml2 follows the "standard":</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000247 <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p>
248 <p><code>cd libxml-xxxx</code></p>
249 <p><code>./configure --help</code></p>
250 <p>to see the options, then the compilation/installation proper</p>
251 <p><code>./configure [possible options]</code></p>
252 <p><code>make</code></p>
253 <p><code>make install</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000254 <p>At that point you may have to rerun ldconfig or a similar utility to
255 update your list of installed shared libs.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000256 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000257 <li><em>What other libraries are needed to compile/install libxml2 ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000258 <p>Libxml2 does not require any other library, the normal C ANSI API
259 should be sufficient (please report any violation to this rule you may
260 find).</p>
261 <p>However if found at configuration time libxml2 will detect and use the
262 following libs:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000263 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000264 <li><a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a
265 highly portable and available widely compression library.</li>
266 <li>iconv: a powerful character encoding conversion library. It is
267 included by default in recent glibc libraries, so it doesn't need to
268 be installed specifically on Linux. It now seems a <a
269 href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part
270 of the official UNIX</a> specification. Here is one <a
271 href="http://www.gnu.org/software/libiconv/">implementation of the
272 library</a> which source can be found <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000273 href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
274 </ul>
275 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000276 <p></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000277 <li><em>Make check fails on some platforms</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000278 <p>Sometimes the regression tests' results don't completely match the
279 value produced by the parser, and the makefile uses diff to print the
280 delta. On some platforms the diff return breaks the compilation process;
281 if the diff is small this is probably not a serious problem.</p>
282 <p>Sometimes (especially on Solaris) make checks fail due to limitations
283 in make. Try using GNU-make instead.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000284 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000285 <li><em>I use the SVN version and there is no configure script</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000286 <p>The configure script (and other Makefiles) are generated. Use the
287 autogen.sh script to regenerate the configure script and Makefiles,
288 like:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000289 <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
290 </li>
291 <li><em>I have troubles when running make tests with gcc-3.0</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000292 <p>It seems the initial release of gcc-3.0 has a problem with the
293 optimizer which miscompiles the URI module. Please use another
294 compiler.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000295 </li>
296</ol>
297
Daniel Veillardf781dba2006-06-09 13:34:49 +0000298<h3><a name="Developer">Developer</a> corner</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000299<ol>
Daniel Veillard93d95252003-04-29 20:25:40 +0000300 <li><em>Troubles compiling or linking programs using libxml2</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000301 <p>Usually the problem comes from the fact that the compiler doesn't get
302 the right compilation or linking flags. There is a small shell script
303 <code>xml2-config</code> which is installed as part of libxml2 usual
304 install process which provides those flags. Use</p>
Daniel Veillard93d95252003-04-29 20:25:40 +0000305 <p><code>xml2-config --cflags</code></p>
306 <p>to get the compilation flags and</p>
307 <p><code>xml2-config --libs</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000308 <p>to get the linker flags. Usually this is done directly from the
309 Makefile as:</p>
Daniel Veillard93d95252003-04-29 20:25:40 +0000310 <p><code>CFLAGS=`xml2-config --cflags`</code></p>
311 <p><code>LIBS=`xml2-config --libs`</code></p>
312 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000313 <li><em>I want to install my own copy of libxml2 in my home directory and
314 link my programs against it, but it doesn't work</em>
315 <p>There are many different ways to accomplish this. Here is one way to
316 do this under Linux. Suppose your home directory is <code>/home/user.
317 </code>Then:</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000318 <ul>
319 <li>Create a subdirectory, let's call it <code>myxml</code></li>
William M. Brack99906ad2005-01-09 17:02:42 +0000320 <li>unpack the libxml2 distribution into that subdirectory</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000321 <li>chdir into the unpacked distribution
322 (<code>/home/user/myxml/libxml2 </code>)</li>
323 <li>configure the library using the "<code>--prefix</code>" switch,
324 specifying an installation subdirectory in
325 <code>/home/user/myxml</code>, e.g.
326 <p><code>./configure --prefix /home/user/myxml/xmlinst</code> {other
327 configuration options}</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000328 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000329 <li>now run <code>make</code> followed by <code>make install</code></li>
330 <li>At this point, the installation subdirectory contains the complete
331 "private" include files, library files and binary program files (e.g.
332 xmllint), located in
333 <p><code>/home/user/myxml/xmlinst/lib,
334 /home/user/myxml/xmlinst/include </code> and <code>
335 /home/user/myxml/xmlinst/bin</code></p>
Daniel Veillard67952602006-01-05 15:29:44 +0000336 respectively.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000337 <li>In order to use this "private" library, you should first add it to
338 the beginning of your default PATH (so that your own private program
339 files such as xmllint will be used instead of the normal system
340 ones). To do this, the Bash command would be
Daniel Veillard67952602006-01-05 15:29:44 +0000341 <p><code>export PATH=/home/user/myxml/xmlinst/bin:$PATH</code></p>
342 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000343 <li>Now suppose you have a program <code>test1.c</code> that you would
344 like to compile with your "private" library. Simply compile it using
345 the command
Daniel Veillard67952602006-01-05 15:29:44 +0000346 <p><code>gcc `xml2-config --cflags --libs` -o test test.c</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000347 Note that, because your PATH has been set with <code>
348 /home/user/myxml/xmlinst/bin</code> at the beginning, the xml2-config
349 program which you just installed will be used instead of the system
350 default one, and this will <em>automatically</em> get the correct
351 libraries linked with your program.</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000352 </ul>
353 </li>
354
355 <p></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000356 <li><em>xmlDocDump() generates output on one line.</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000357 <p>Libxml2 will not <strong>invent</strong> spaces in the content of a
358 document since <strong>all spaces in the content of a document are
359 significant</strong>. If you build a tree from the API and want
360 indentation:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000361 <ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000362 <li>the correct way is to generate those yourself too.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000363 <li>the dangerous way is to ask libxml2 to add those blanks to your
364 content <strong>modifying the content of your document in the
365 process</strong>. The result may not be what you expect. There is
366 <strong>NO</strong> way to guarantee that such a modification won't
367 affect other parts of the content of your document. See <a
368 href="http://xmlsoft.org/html/libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault
369 ()</a> and <a
370 href="http://xmlsoft.org/html/libxml-tree.html#xmlSaveFormatFile">xmlSaveFormatFile
371 ()</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000372 </ol>
373 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000374 <p></p>
375 <li><em>Extra nodes in the document:</em>
376 <p><em>For an XML file as below:</em></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000377 <pre>&lt;?xml version="1.0"?&gt;
378&lt;PLAN xmlns="http://www.argus.ca/autotest/1.0/"&gt;
379&lt;NODE CommFlag="0"/&gt;
380&lt;NODE CommFlag="1"/&gt;
381&lt;/PLAN&gt;</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000382 <p><em>after parsing it with the function
383 pxmlDoc=xmlParseFile(...);</em></p>
384 <p><em>I want to the get the content of the first node (node with the
385 CommFlag="0")</em></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000386 <p><em>so I did it as following;</em></p>
Daniel Veillard63d83142002-05-20 06:51:05 +0000387 <pre>xmlNodePtr pnode;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000388pnode=pxmlDoc-&gt;children-&gt;children;</pre>
389 <p><em>but it does not work. If I change it to</em></p>
390 <pre>pnode=pxmlDoc-&gt;children-&gt;children-&gt;next;</pre>
391 <p><em>then it works. Can someone explain it to me.</em></p>
392 <p></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000393 <p>In XML all characters in the content of the document are significant
394 <strong>including blanks and formatting line breaks</strong>.</p>
395 <p>The extra nodes you are wondering about are just that, text nodes with
396 the formatting spaces which are part of the document but that people tend
397 to forget. There is a function <a
398 href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault
399 ()</a> to remove those at parse time, but that's an heuristic, and its
400 use should be limited to cases where you are certain there is no
401 mixed-content in the document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000402 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000403 <li><em>I get compilation errors of existing code like when accessing
404 <strong>root</strong> or <strong>child fields</strong> of nodes.</em>
405 <p>You are compiling code developed for libxml version 1 and using a
406 libxml2 development environment. Either switch back to libxml v1 devel or
407 even better fix the code to compile with libxml2 (or both) by <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000408 href="upgrade.html">following the instructions</a>.</p>
409 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000410 <li><em>I get compilation errors about non existing
411 <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong>
412 fields.</em>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000413 <p>The source code you are using has been <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000414 href="upgrade.html">upgraded</a> to be able to compile with both libxml
415 and libxml2, but you need to install a more recent version:
416 libxml(-devel) &gt;= 1.8.8 or libxml2(-devel) &gt;= 2.1.0</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000417 </li>
Daniel Veillard984e5692008-06-11 08:14:22 +0000418 <li><em>Random crashes in threaded applications</em>
419 <p>Read and follow all advices on the <a href="threads.html">thread
420 safety</a> page, and make 100% sure you never call xmlCleanupParser()
421 while the library or an XML document might still be in use by another
422 thread.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000423 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000424 <li><em>The example provided in the web page does not compile.</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000425 <p>It's hard to maintain the documentation in sync with the code
426 &lt;grin/&gt; ...</p>
427 <p>Check the previous points 1/ and 2/ raised before, and please send
428 patches.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000429 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000430 <li><em>Where can I get more examples and information than provided on the
431 web page?</em>
432 <p>Ideally a libxml2 book would be nice. I have no such plan ... But you
433 can:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000434 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000435 <li>check more deeply the <a href="html/libxml-lib.html">existing
436 generated doc</a></li>
437 <li>have a look at <a href="examples/index.html">the set of
438 examples</a>.</li>
Daniel Veillard984e5692008-06-11 08:14:22 +0000439 <li>look for examples of use for libxml2 function using the Gnome code
440 or by asking on Google.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000441 <li><a
Daniel Veillarda4f85b92009-03-25 10:45:20 +0000442 href="http://svn.gnome.org/viewvc/libxml2/trunk/">Browse
Daniel Veillardf781dba2006-06-09 13:34:49 +0000443 the libxml2 source</a> , I try to write code as clean and documented
444 as possible, so looking at it may be helpful. In particular the code
Daniel Veillarda4f85b92009-03-25 10:45:20 +0000445 of <a href="http://svn.gnome.org/viewvc/libxml2/trunk/xmllint.c?view=markup">xmllint.c</a> and of the various testXXX.c test programs should
Daniel Veillardf781dba2006-06-09 13:34:49 +0000446 provide good examples of how to do things with the library.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000447 </ul>
448 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000449 <p></p>
450 <li><em>What about C++ ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000451 <p>libxml2 is written in pure C in order to allow easy reuse on a number
452 of platforms, including embedded systems. I don't intend to convert to
453 C++.</p>
Daniel Veillard91e69c52003-08-04 01:43:07 +0000454 <p>There is however a C++ wrapper which may fulfill your needs:</p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000455 <ul>
456 <li>by Ari Johnson &lt;ari@btigate.com&gt;:
457 <p>Website: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000458 href="http://libxmlplusplus.sourceforge.net/">http://libxmlplusplus.sourceforge.net/</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000459 <p>Download: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000460 href="http://sourceforge.net/project/showfiles.php?group_id=12999">http://sourceforge.net/project/showfiles.php?group_id=12999</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000461 </li>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000462 </ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000463 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000464 <li><em>How to validate a document a posteriori ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000465 <p>It is possible to validate documents which had not been validated at
466 initial parsing time or documents which have been built from scratch
467 using the API. Use the <a
468 href="http://xmlsoft.org/html/libxml-valid.html#xmlValidateDtd">xmlValidateDtd()</a>
469 function. It is also possible to simply add a DTD to an existing
470 document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000471 <pre>xmlDocPtr doc; /* your existing document */
Daniel Veillard0b28e882002-07-24 23:47:05 +0000472xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
473
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000474 dtd-&gt;name = xmlStrDup((xmlChar*)"root_name"); /* use the given root */
475
476 doc-&gt;intSubset = dtd;
477 if (doc-&gt;children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd);
478 else xmlAddPrevSibling(doc-&gt;children, (xmlNodePtr)dtd);
479 </pre>
480 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000481 <li><em>So what is this funky "xmlChar" used all the time?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000482 <p>It is a null terminated sequence of utf-8 characters. And only utf-8!
483 You need to convert strings encoded in different ways to utf-8 before
484 passing them to the API. This can be accomplished with the iconv library
485 for instance.</p>
John Fleck61f6fb62002-10-31 15:23:29 +0000486 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000487 <li>etc ...</li>
488</ol>
489
490<p></p>
491
Daniel Veillard66f68e72003-08-18 16:39:51 +0000492<h2><a name="Documentat">Developer Menu</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000493
Daniel Veillard0b28e882002-07-24 23:47:05 +0000494<p>There are several on-line resources related to using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000495<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000496 <li>Use the <a href="search.php">search engine</a> to look up
497 information.</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000498 <li>Check the <a href="FAQ.html">FAQ.</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000499 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
500 documentation</a> automatically extracted from code comments.</li>
501 <li>Look at the documentation about <a href="encoding.html">libxml
502 internationalization support</a>.</li>
503 <li>This page provides a global overview and <a href="example.html">some
504 examples</a> on how to use libxml.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000505 <li><a href="examples/index.html">Code examples</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000506 <li>John Fleck's libxml2 tutorial: <a href="tutorial/index.html">html</a>
507 or <a href="tutorial/xmltutorial.pdf">pdf</a>.</li>
Daniel Veillard1177ca42003-04-26 22:29:54 +0000508 <li>If you need to parse large files, check the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000509 href="xmlreader.html">xmlReader</a> API tutorial</li>
510 <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
Daniel Veillardf7aeda22013-03-23 10:31:26 +0800511 href="http://www.jamesh.id.au/articles/libxml-sax/libxml-sax.html">some nice
Daniel Veillardf781dba2006-06-09 13:34:49 +0000512 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000513 <li>George Lebl wrote <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000514 href="http://www-106.ibm.com/developerworks/library/l-gnome3/">an article
515 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillarda4f85b92009-03-25 10:45:20 +0000516 <li>Check <a href="http://svn.gnome.org/viewvc/libxml2/trunk/TODO?view=markup">the TODO
Daniel Veillardf781dba2006-06-09 13:34:49 +0000517 file</a>.</li>
518 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>
519 description. If you are starting a new project using libxml you should
520 really use the 2.x version.</li>
Daniel Veillard845cce42002-01-09 11:51:37 +0000521 <li>And don't forget to look at the <a
522 href="http://mail.gnome.org/archives/xml/">mailing-list archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000523</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000524
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000525<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000526
Daniel Veillardf781dba2006-06-09 13:34:49 +0000527<p>Well, bugs or missing features are always possible, and I will make a
528point of fixing them in a timely fashion. The best way to report a bug is to
529use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome
530bug tracking database</a> (make sure to use the "libxml2" module name). I
531look at reports there regularly and it's good to have a reminder when a bug
532is still open. Be sure to specify that the bug is for the package libxml2.</p>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000533
Daniel Veillardf781dba2006-06-09 13:34:49 +0000534<p>For small problems you can try to get help on IRC, the #xml channel on
535irc.gnome.org (port 6667) usually have a few person subscribed which may help
William M. Brack43a87292007-02-15 20:41:02 +0000536(but there is no guarantee and if a real issue is raised it should go on the
Daniel Veillardf781dba2006-06-09 13:34:49 +0000537mailing-list for archival).</p>
Daniel Veillard9582d6c2003-09-16 11:40:04 +0000538
Daniel Veillard0142b842000-01-14 14:45:24 +0000539<p>There is also a mailing-list <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000540href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
541href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
542href="http://xmlsoft.org/messages">old</a>). To subscribe to this list,
543please visit the <a
544href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and
545follow the instructions. <strong>Do not send code, I won't debug it</strong>
546(but patches are really appreciated!).</p>
Daniel Veillardd99224d2004-04-06 10:04:16 +0000547
Daniel Veillardf781dba2006-06-09 13:34:49 +0000548<p>Please note that with the current amount of virus and SPAM, sending mail
549to the list without being subscribed won't work. There is *far too many
550bounces* (in the order of a thousand a day !) I cannot approve them manually
551anymore. If your mail to the list bounced waiting for administrator approval,
552it is LOST ! Repost it and fix the problem triggering the error. Also please
553note that <span style="color: #FF0000; background-color: #FFFFFF">emails with
William M. Brack43a87292007-02-15 20:41:02 +0000554a legal warning asking to not copy or redistribute freely the information
Daniel Veillardf781dba2006-06-09 13:34:49 +0000555they contain</span> are <strong>NOT</strong> acceptable for the mailing-list,
556such mail will as much as possible be discarded automatically, and are less
557likely to be answered if they made it to the list, <strong>DO NOT</strong>
558post to the list from an email address where such legal requirements are
559automatically added, get private paying support if you can't share
William M. Brack43a87292007-02-15 20:41:02 +0000560information.</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000561
Daniel Veillardf781dba2006-06-09 13:34:49 +0000562<p>Check the following <strong><span style="color: #FF0000">before
563posting</span></strong>:</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000564<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000565 <li>Read the <a href="FAQ.html">FAQ</a> and <a href="search.php">use the
566 search engine</a> to get information related to your problem.</li>
567 <li>Make sure you are <a href="ftp://xmlsoft.org/libxml2/">using a recent
568 version</a>, and that the problem still shows up in a recent version.</li>
569 <li>Check the <a href="http://mail.gnome.org/archives/xml/">list
570 archives</a> to see if the problem was reported already. In this case
571 there is probably a fix available, similarly check the <a
572 href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">registered
573 open bugs</a>.</li>
574 <li>Make sure you can reproduce the bug with xmllint or one of the test
575 programs found in source in the distribution.</li>
576 <li>Please send the command showing the error as well as the input (as an
577 attachment)</li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000578</ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000579
Daniel Veillarda37aab82003-06-09 09:10:36 +0000580<p>Then send the bug with associated information to reproduce it to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000581href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
582related I will approve it. Please do not send mail to me directly, it makes
583things really hard to track and in some cases I am not the best person to
584answer a given question, ask on the list.</p>
Daniel Veillard98d071d2003-01-10 09:22:44 +0000585
586<p>To <span style="color: #E50000">be really clear about support</span>:</p>
587<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000588 <li>Support or help <span style="color: #E50000">requests MUST be sent to
589 the list or on bugzilla</span> in case of problems, so that the Question
590 and Answers can be shared publicly. Failing to do so carries the implicit
591 message "I want free support but I don't want to share the benefits with
592 others" and is not welcome. I will automatically Carbon-Copy the
593 xml@gnome.org mailing list for any technical reply made about libxml2 or
594 libxslt.</li>
William M. Brack43a87292007-02-15 20:41:02 +0000595 <li>There is <span style="color: #E50000">no guarantee of support</span>. If
Daniel Veillardf781dba2006-06-09 13:34:49 +0000596 your question remains unanswered after a week, repost it, making sure you
597 gave all the detail needed and the information requested.</li>
598 <li>Failing to provide information as requested or double checking first
599 for prior feedback also carries the implicit message "the time of the
600 library maintainers is less valuable than my time" and might not be
601 welcome.</li>
Daniel Veillard98d071d2003-01-10 09:22:44 +0000602</ul>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000603
Daniel Veillardf781dba2006-06-09 13:34:49 +0000604<p>Of course, bugs reported with a suggested patch for fixing them will
605probably be processed faster than those without.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000606
607<p>If you're looking for help, a quick look at <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000608href="http://mail.gnome.org/archives/xml/">the list archive</a> may actually
609provide the answer. I usually send source samples when answering libxml2
610usage questions. The <a
611href="http://xmlsoft.org/html/book1.html">auto-generated documentation</a> is
612not as polished as I would like (i need to learn more about DocBook), but
613it's a good starting point.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000614
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000615<h2><a name="help">How to help</a></h2>
616
Daniel Veillardf781dba2006-06-09 13:34:49 +0000617<p>You can help the project in various ways, the best thing to do first is to
618subscribe to the mailing-list as explained before, check the <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000619href="http://mail.gnome.org/archives/xml/">archives </a>and the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000620href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome bug
621database</a>:</p>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000622<ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000623 <li>Provide patches when you find problems.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000624 <li>Provide the diffs when you port libxml2 to a new platform. They may not
625 be integrated in all cases but help pinpointing portability problems
626 and</li>
627 <li>Provide documentation fixes (either as patches to the code comments or
628 as HTML diffs).</li>
629 <li>Provide new documentations pieces (translations, examples, etc
630 ...).</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000631 <li>Check the TODO file and try to close one of the items.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000632 <li>Take one of the points raised in the archive or the bug database and
633 provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me
634 </a>before to avoid synchronization problems and check that the suggested
635 fix will fit in nicely :-)</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000636</ol>
637
Daniel Veillard10a2c651999-12-12 13:03:50 +0000638<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000639
Daniel Veillard688f6692004-03-26 10:57:38 +0000640<p>The latest versions of libxml2 can be found on the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000641href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> server ( <a
William M. Brack43a87292007-02-15 20:41:02 +0000642href="ftp://xmlsoft.org/libxml2/">FTP</a> and rsync are available), there are also
Daniel Veillard45e21e22009-08-20 19:40:03 +0200643mirrors (<a href="ftp://fr.rpmfind.net/pub/libxml/">France</a> and
644Antonin Sprinzl also provide <a href="ftp://gd.tuwien.ac.at/pub/libxml/">a
645mirror in Austria</a>). (NOTE that you need both the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000646href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
647href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillard45e21e22009-08-20 19:40:03 +0200648packages installed to compile applications using libxml if using RPMs.)</p>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000649
650<p>You can find all the history of libxml(2) and libxslt releases in the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000651href="http://xmlsoft.org/sources/old/">old</a> directory. The precompiled
652Windows binaries made by Igor Zlatovic are available in the <a
653href="http://xmlsoft.org/sources/win32/">win32</a> directory.</p>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000654
655<p>Binary ports:</p>
656<ul>
Daniel Veillard45e21e22009-08-20 19:40:03 +0200657 <li>RPMs for x86_64 are available directly on <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000658 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>, the source RPM will compile on
Daniel Veillard45e21e22009-08-20 19:40:03 +0200659 any architecture supported.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000660 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
661 maintainer of the Windows port, <a
662 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
663 binaries</a>.</li>
Daniel Veillard9a15b302009-08-07 16:27:15 +0200664 <li>OpenCSW provides <a
665 href="http://opencsw.org/packages/libxml2">Solaris
Daniel Veillardf781dba2006-06-09 13:34:49 +0000666 binaries</a>.</li>
667 <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> provides <a
668 href="http://www.explain.com.au/oss/libxml2xslt.html">Mac Os X
669 binaries</a>.</li>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000670 <li>The HP-UX porting center provides <a
671 href="http://hpux.connect.org.uk/hppd/hpux/Gnome/">HP-UX binaries</a></li>
Daniel Veillard67952602006-01-05 15:29:44 +0000672 <li>Bull provides precompiled <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000673 href="http://gnome.bullfreeware.com/new_index.html">RPMs for AIX</a> as
674 patr of their GNOME packages</li>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000675</ul>
676
677<p>If you know other supported binary ports, please <a
678href="http://veillard.com/">contact me</a>.</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000679
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000680<p><a name="Snapshot">Snapshot:</a></p>
681<ul>
Daniel Veillard45e21e22009-08-20 19:40:03 +0200682 <li>Code from the GNOME GIT base libxml2 module, updated hourly <a
683 href="ftp://xmlsoft.org/libxml2/libxml2-git-snapshot.tar.gz">libxml2-git-snapshot.tar.gz</a>.</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000684 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard9110ed62006-04-03 15:21:57 +0000685 href="ftp://xmlsoft.org/libxml2/libxml-docs.tar.gz">libxml-docs.tar.gz</a>.</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000686</ul>
687
Daniel Veillardc6271d22001-10-27 07:50:58 +0000688<p><a name="Contribs">Contributions:</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000689
Daniel Veillardf781dba2006-06-09 13:34:49 +0000690<p>I do accept external contributions, especially if compiling on another
691platform, get in touch with the list to upload the package, wrappers for
692various languages have been provided, and can be found in the <a
Daniel Veillardd99224d2004-04-06 10:04:16 +0000693href="python.html">bindings section</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000694
Daniel Veillard45e21e22009-08-20 19:40:03 +0200695<p>Libxml2 is also available from GIT:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000696<ul>
Daniel Veillarddde64082011-03-23 08:12:26 +0800697 <li><p>See <a href="http://git.gnome.org/browse/libxml2/">libxml2 Git web</a>.
Daniel Veillard45e21e22009-08-20 19:40:03 +0200698 To checkout a local tree use:</p>
699 <pre>git clone git://git.gnome.org/libxml2</pre>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000700 </li>
Daniel Veillarddde64082011-03-23 08:12:26 +0800701 <li>The <strong>libxslt</strong> module is also present
702 <a href="http://git.gnome.org/browse/libxslt/">there</a>.</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000703</ul>
704
Daniel Veillard78fed532004-10-09 19:44:48 +0000705<h2><a name="News">Releases</a></h2>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000706
Daniel Veillardf781dba2006-06-09 13:34:49 +0000707<p>The <a href="ChangeLog.html">change log</a> describes the recents commits
Daniel Veillard38bbd342012-09-11 15:00:08 +0800708to the <a href="http://git.gnome.org/browse/libxml2/">GIT</a> code base.</p>
Daniel Veillard2d908032004-08-10 10:16:36 +0000709
William M. Brack43a87292007-02-15 20:41:02 +0000710<p>Here is the list of public releases:</p>
Daniel Veillardd99224d2004-04-06 10:04:16 +0000711
Daniel Veillard38bbd342012-09-11 15:00:08 +0800712<h3>2.9.0: Sep 11 2012</h3>
713<ul>
714 <li> Features:<br/>
715 A few new API entry points,<br/>
716 More resilient push parser mode,<br/>
717 A lot of portability improvement,<br/>
718 Faster XPath evaluation<br/>
719 </li>
720
721 <li> Documentation:<br/>
722 xml2-config.1 markup error (Christian Weisgerber),<br/>
723 libxml(3) manpage typo fix (John Bradshaw),<br/>
724 More cleanups to the documentation part of libxml2 (Daniel Richard G)<br/>
725 </li>
726
727 <li> Portability:<br/>
728 Bug 676544 - fails to build with --without-sax1 (Akira TAGOH),<br/>
729 fix builds not having stdint.h (Rob Richards),<br/>
730 GetProcAddressA is available only on WinCE (Daniel Veillard),<br/>
731 More updates and cleanups on autotools and Makefiles (Daniel Richard G),<br/>
732 More changes for Win32 compilation (Eric Zurcher),<br/>
733 Basic changes for Win32 builds of release 2.9.0: compile buf.c (Eric Zurcher),<br/>
734 Bundles all generated files for python into the distribution (Daniel Richard G),<br/>
735 Fix compiler warnings of wincecompat.c (Patrick Gansterer),<br/>
736 Fix non __GNUC__ build (Patrick Gansterer),<br/>
737 Fix windows unicode build (Patrick Gansterer),<br/>
738 clean redefinition of {v}snprintf in C-source (Roumen Petrov),<br/>
739 use xmlBuf... if DEBUG_INPUT is defined (Roumen Petrov),<br/>
740 fix runtests to use pthreads support for various Unix platforms (Daniel Richard G),<br/>
741 Various "make distcheck" and portability fixups 2nd part (Daniel Richard G),<br/>
742 Various "make distcheck" and portability fixups (Daniel Richard G),<br/>
743 Fix compilation on older Visual Studio (Daniel Veillard)<br/>
744 </li>
745
746 <li> Bug Fixes:<br/>
747 Change the XPath code to percolate allocation errors (Daniel Veillard),<br/>
748 Fix reuse of xmlInitParser (Daniel Veillard),<br/>
749 Fix potential crash on entities errors (Daniel Veillard),<br/>
750 initialize var (Rob Richards),<br/>
751 Fix the XPath arity check to also check the XPath stack limits (Daniel Veillard),<br/>
752 Fix problem with specific and generic error handlers (Pietro Cerutti),<br/>
753 Avoid a potential infinite recursion (Daniel Veillard),<br/>
754 Fix an XSD error when generating internal automata (Daniel Veillard),<br/>
755 Patch for xinclude of text using multibyte characters (Vitaly Ostanin),<br/>
756 Fix a segfault on XSD validation on pattern error (Daniel Veillard),<br/>
757 Fix missing xmlsave.h module which was ignored in recent builds (Daniel Veillard),<br/>
758 Add a missing element check (Daniel Veillard),<br/>
759 Adding various checks on node type though the API (Daniel Veillard),<br/>
760 Namespace nodes can't be unlinked with xmlUnlinkNode (Daniel Veillard),<br/>
761 Fix make dist to include new private header files (Daniel Veillard),<br/>
762 More fixups on the push parser behaviour (Daniel Veillard),<br/>
763 Strengthen behaviour of the push parser in problematic situations (Daniel Veillard),<br/>
764 Enforce XML_PARSER_EOF state handling through the parser (Daniel Veillard),<br/>
765 Fixup limits parser (Daniel Veillard),<br/>
766 Do not fetch external parsed entities (Daniel Veillard),<br/>
767 Fix an error in previous commit (Aron Xu),<br/>
768 Fix entities local buffers size problems (Daniel Veillard),<br/>
769 Fix parser local buffers size problems (Daniel Veillard),<br/>
770 Fix a failure to report xmlreader parsing failures (Daniel Veillard)<br/>
771 </li>
772
773 <li> Improvements:<br/>
774 Keep libxml2.syms when running "make distclean" (Daniel Veillard),<br/>
775 Allow to set the quoting character of an xmlWriter (Csaba Raduly),<br/>
776 Keep non-significant blanks node in HTML parser (Daniel Veillard),<br/>
777 Add a forbidden variable error number and message to XPath (Daniel Veillard),<br/>
778 Support long path names on WNT (Michael Stahl),<br/>
779 Improve HTML escaping of attribute on output (Daniel Veillard),<br/>
780 Handle ICU_LIBS as LIBADD, not LDFLAGS to prevent linking errors (Arfrever Frehtes Taifersar Arahesis),<br/>
781 Switching XPath node sorting to Timsort (Vojtech Fried),<br/>
782 Optimizing '//' in XPath expressions (Nick Wellnhofer),<br/>
783 Expose xmlBufShrink in the public tree API (Daniel Veillard),<br/>
784 Visible HTML elements close the head tag (Conrad Irwin),<br/>
785 Fix file and line report for XSD SAX and reader streaming validation (Daniel Veillard),<br/>
786 Fix const qualifyer to definition of xmlBufferDetach (Daniel Veillard),<br/>
787 minimize use of HAVE_CONFIG_H (Roumen Petrov),<br/>
788 fixup regression in Various "make distcheck" and portability fixups (Roumen Petrov),<br/>
789 Add support for big line numbers in error reporting (Daniel Veillard),<br/>
790 Avoid using xmlBuffer for serialization (Daniel Veillard),<br/>
791 Improve compatibility between xmlBuf and xmlBuffer (Daniel Veillard),<br/>
792 Provide new accessors for xmlOutputBuffer (Daniel Veillard),<br/>
793 Improvements for old buffer compatibility (Daniel Veillard),<br/>
794 Expand the limit test program (Daniel Veillard),<br/>
795 Improve error reporting on parser errors (Daniel Veillard),<br/>
796 Implement some default limits in the XPath module (Daniel Veillard),<br/>
797 Introduce some default parser limits (Daniel Veillard),<br/>
798 Cleanups and new limit APIs for dictionaries (Daniel Veillard),<br/>
799 Fixup for buf.c (Daniel Veillard),<br/>
800 Cleanup URI module memory allocation code (Daniel Veillard),<br/>
801 Extend testlimits (Daniel Veillard),<br/>
802 More avoid quadratic behaviour (Daniel Veillard),<br/>
803 Impose a reasonable limit on PI size (Daniel Veillard),<br/>
804 first version of testlimits new test (Daniel Veillard),<br/>
805 Avoid quadratic behaviour in some push parsing cases (Daniel Veillard),<br/>
806 Impose a reasonable limit on comment size (Daniel Veillard),<br/>
807 Impose a reasonable limit on attribute size (Daniel Veillard),<br/>
808 Harden the buffer code and make it more compatible (Daniel Veillard),<br/>
809 More cleanups for input/buffers code (Daniel Veillard),<br/>
810 Cleanup function xmlBufResetInput(),<br/> to set input from Buffer (Daniel Veillard)
811 Swicth the test program for characters to new input buffers (Daniel Veillard),<br/>
812 Convert the HTML tree module to the new buffers (Daniel Veillard),<br/>
813 Convert of the HTML parser to new input buffers (Daniel Veillard),<br/>
814 Convert the writer to new output buffer and save APIs (Daniel Veillard),<br/>
815 Convert XMLReader to the new input buffers (Daniel Veillard),<br/>
816 New saving functions using xmlBuf and conversion (Daniel Veillard),<br/>
817 Provide new xmlBuf based saving functions (Daniel Veillard),<br/>
818 Convert XInclude to the new input buffers (Daniel Veillard),<br/>
819 Convert catalog code to the new input buffers (Daniel Veillard),<br/>
820 Convert C14N to the new Input buffer (Daniel Veillard),<br/>
821 Convert xmlIO.c to the new input and output buffers (Daniel Veillard),<br/>
822 Convert XML parser to the new input buffers (Daniel Veillard),<br/>
823 Incompatible change to the Input and Output buffers (Daniel Veillard),<br/>
824 Adding new encoding function to deal with the new structures (Daniel Veillard),<br/>
825 Convert XPath to xmlBuf (Daniel Veillard),<br/>
826 Adding a new buf module for buffers (Daniel Veillard),<br/>
827 Memory error within SAX2 reuse common framework (Daniel Veillard),<br/>
828 Fix xmllint --xpath node initialization (Daniel Veillard)<br/>
829 </li>
830
831 <li> Cleanups:<br/>
832 Various cleanups to avoid compiler warnings (Daniel Veillard),<br/>
833 Big space and tab cleanup (Daniel Veillard),<br/>
834 Followup to LibXML2 docs/examples cleanup patch (Daniel Veillard),<br/>
835 Second round of cleanups for LibXML2 docs/examples (Daniel Richard),<br/>
836 Remove all .cvsignore as they are not used anymore (Daniel Veillard),<br/>
837 Fix a Timsort function helper comment (Daniel Veillard),<br/>
838 Small cleanup for valgrind target (Daniel Veillard),<br/>
839 Patch for portability of latin characters in C files (Daniel Veillard),<br/>
840 Cleanup some of the parser code (Daniel Veillard),<br/>
841 Fix a variable name in comment (Daniel Veillard),<br/>
842 Regenerated testapi.c (Daniel Veillard),<br/>
843 Regenerating docs and API files (Daniel Veillard),<br/>
844 Small cleanup of unused variables in test (Daniel Veillard),<br/>
845 Expand .gitignore with more files (Daniel Veillard)<br/>
846 </li>
847</ul>
Daniel Veillardc943f702012-05-23 17:10:59 +0800848<h3>2.8.0: May 23 2012</h3>
849<ul>
850 <li>Features:
Daniel Veillard38bbd342012-09-11 15:00:08 +0800851 add lzma compression support (Anders F Bjorklund)
Daniel Veillardc943f702012-05-23 17:10:59 +0800852 </li>
853
854 <li>Documentation:
855 xmlcatalog: Add uri and delegateURI to possible add types in man page. (Ville Skyttä),
856 Update README.tests (Daniel Veillard),
857 URI handling code is not OOM resilient (Daniel Veillard),
858 Fix an error in comment (Daniel Veillard),
859 Fixed bug #617016 (Daniel Mustieles),
860 Fixed two typos in the README document (Daniel Neel),
861 add generated html files (Anders F Bjorklund),
862 Clarify the need to use xmlFreeNode after xmlUnlinkNode (Daniel Veillard),
863 Improve documentation a bit (Daniel Veillard),
864 Updated URL for lxml python bindings (Daniel Veillard)
865 </li>
866
867 <li>Portability:
868 Restore code for Windows compilation (Daniel Veillard),
869 Remove git error message during configure (Christian Dywan),
870 xmllint: Build fix for endTimer if !defined(HAVE_GETTIMEOFDAY) (Patrick R. Gansterer),
871 remove a bashism in confgure.in (John Hein),
872 undef ERROR if already defined (Patrick R. Gansterer),
873 Fix library problems with mingw-w64 (Michael Cronenworth),
874 fix windows build. ifdef addition from bug 666491 makes no sense (Rob Richards),
875 prefer native threads on win32 (Sam Thursfield),
876 Allow to compile with Visual Studio 2010 (Thomas Lemm),
877 Fix mingw's snprintf configure check (Andoni Morales),
878 fixed a 64bit big endian issue (Marcus Meissner),
879 Fix portability failure if netdb.h lacks NO_ADDRESS (Daniel Veillard),
880 Fix windows build from lzma addition (Rob Richards),
881 autogen: Only check for libtoolize (Colin Walters),
882 Fix the Windows build files (Patrick von Reth),
883 634846 Remove a linking option breaking Windows VC10 (Daniel Veillard),
884 599241 fix an initialization problem on Win64 (Andrew W. Nosenko),
885 fix win build (Rob Richards)
886 </li>
887
888 <li>Bug fixes:
889 Part for rand_r checking missing (Daniel Veillard),
890 Cleanup on randomization (Daniel Veillard),
891 Fix undefined reference in python module (Pacho Ramos),
892 Fix a race in xmlNewInputStream (Daniel Veillard),
893 Fix weird streaming RelaxNG errors (Noam),
894 Fix various bugs in new code raised by the API checking (Daniel Veillard),
895 Fix various problems with "make dist" (Daniel Veillard),
896 Fix a memory leak in the xzlib code (Daniel Veillard),
897 HTML parser error with &lt;noscript&gt; in the &lt;head&gt; (Denis Pauk),
898 XSD: optional element in complex type extension (Remi Gacogne),
899 Fix html serialization error and htmlSetMetaEncoding() (Daniel Veillard),
900 Fix a wrong return value in previous patch (Daniel Veillard),
901 Fix an uninitialized variable use (Daniel Veillard),
902 Fix a compilation problem with --minimum (Brandon Slack),
903 Remove redundant and ungarded include of resolv.h (Daniel Veillard),
904 xinclude with parse="text" does not use the entity loader (Shaun McCance),
905 Allow to parse 1 byte HTML files (Denis Pauk),
906 Patch that fixes the skipping of the HTML_PARSE_NOIMPLIED flag (Martin Schröder),
907 Avoid memory leak if xmlParserInputBufferCreateIO fails (Lin Yi-Li),
908 Prevent an infinite loop when dumping a node with encoding problems (Timothy Elliott),
909 xmlParseNodeInContext problems with an empty document (Tim Elliott),
910 HTML element position is not detected propperly (Pavel Andrejs),
911 Fix an off by one pointer access (Jüri Aedla),
912 Try to fix a problem with entities in SAX mode (Daniel Veillard),
913 Fix a crash with xmllint --path on empty results (Daniel Veillard),
914 Fixed bug #667946 (Daniel Mustieles),
915 Fix a logic error in Schemas Component Constraints (Ryan Sleevi),
916 Fix a wrong enum type use in Schemas Types (Nico Weber),
917 Fix SAX2 builder in case of undefined attributes namespace (Daniel Veillard),
918 Fix SAX2 builder in case of undefined element namespaces (Daniel Veillard),
919 fix reference to STDOUT_FILENO on MSVC (Tay Ray Chuan),
920 fix a pair of possible out of array char references (Daniel Veillard),
921 Fix an allocation error when copying entities (Daniel Veillard),
922 Make sure the parser returns when getting a Stop order (Chris Evans),
923 Fix some potential problems on reallocation failures(parser.c) (Xia Xinfeng),
924 Fix a schema type duration comparison overflow (Daniel Veillard),
925 Fix an unimplemented part in RNG value validation (Daniel Veillard),
926 Fix missing error status in XPath evaluation (Daniel Veillard),
927 Hardening of XPath evaluation (Daniel Veillard),
928 Fix an off by one error in encoding (Daniel Veillard),
929 Fix RELAX NG include bug #655288 (Shaun McCance),
930 Fix XSD validation bug #630130 (Toyoda Eizi),
931 Fix some potential problems on reallocation failures (Chris Evans),
932 __xmlRaiseError: fix use of the structured callback channel (Dmitry V. Levin),
933 __xmlRaiseError: fix the structured callback channel's data initialization (Dmitry V. Levin),
934 Fix memory corruption when xmlParseBalancedChunkMemoryInternal is called from xmlParseBalancedChunk (Rob Richards),
935 Small fix for previous commit (Daniel Veillard),
936 Fix a potential freeing error in XPath (Daniel Veillard),
937 Fix a potential memory access error (Daniel Veillard),
938 Reactivate the shared library versionning script (Daniel Veillard)
939 </li>
940
941 <li>Improvements:
942 use mingw C99 compatible functions {v}snprintf instead those from MSVC runtime (Roumen Petrov),
943 New symbols added for the next release (Daniel Veillard),
944 xmlTextReader bails too quickly on error (Andy Lutomirski),
945 Use a hybrid allocation scheme in xmlNodeSetContent (Conrad Irwin),
946 Use buffers when constructing string node lists. (Conrad Irwin),
947 Add HTML parser support for HTML5 meta charset encoding declaration (Denis Pauk),
948 wrong message for double hyphen in comment XML error (Bryan Henderson),
949 Fix "make tst" to grab lzma lib too (Daniel Veillard),
950 Add "whereis" command to xmllint shell (Ryan),
951 Improve xmllint shell (Ryan),
952 add function xmlTextReaderRelaxNGValidateCtxt() (Noam Postavsky),
953 Add --system support to autogen.sh (Daniel Veillard),
954 Add hash randomization to hash and dict structures (Daniel Veillard),
955 included xzlib in dist (Anders F Bjorklund),
956 move xz/lzma helpers to separate included files (Anders F Bjorklund),
957 add generated devhelp files (Anders F Bjorklund),
958 add XML_WITH_LZMA to api (Anders F Bjorklund),
959 autogen.sh: Honor NOCONFIGURE environment variable (Colin Walters),
960 Improve the error report on undefined REFs (Daniel Veillard),
961 Add exception for new W3C PI xml-model (Daniel Veillard),
962 Add options to ignore the internal encoding (Daniel Veillard),
963 testapi: use the right type for the check (Stefan Kost),
964 various: handle return values of write calls (Stefan Kost),
965 testWriter: xmlTextWriterWriteFormatElement wants an int instead of a long int (Stefan Kost),
966 runxmlconf: update to latest testsuite version (Stefan Kost),
967 configure: add -Wno-long-long to CFLAGS (Stefan Kost),
968 configure: support silent automake rules if possible (Stefan Kost),
969 xmlmemory: add a cast as size_t has no portable printf modifier (Stefan Kost),
970 __xmlRaiseError: remove redundant schannel initialization (Dmitry V. Levin),
971 __xmlRaiseError: do cheap code check early (Dmitry V. Levin)
972 </li>
973
974 <li>Cleanups:
975 Cleanups before 2.8.0-rc2 (Daniel Veillard),
976 Avoid an extra operation (Daniel Veillard),
977 Remove vestigial de-ANSI-fication support. (Javier Jardón),
978 autogen.sh: Fix typo (Javier Jardón),
979 Do not use unsigned but unsigned int (Daniel Veillard),
980 Remove two references to u_short (Daniel Veillard),
981 Fix -Wempty-body warning from clang (Nico Weber),
982 Cleanups of lzma support (Daniel Veillard),
983 Augment the list of ignored files (Daniel Veillard),
984 python: remove unused variable (Stefan Kost),
985 python: flag two unused args (Stefan Kost),
986 configure: acconfig.h is deprecated since autoconf-2.50 (Stefan Kost),
987 xpath: remove unused variable (Stefan Kost)
988 </li>
989</ul>
Daniel Veillard4c2e7c62010-11-04 18:35:57 +0100990<h3>2.7.8: Nov 4 2010</h3>
991<ul>
992 <li> Features:
993 480323 add code to plug in ICU converters by default (Giuseppe Iuculano),
994 Add xmlSaveOption XML_SAVE_WSNONSIG (Adam Spragg)
995 </li>
996 <li> Documentation:
997 Fix devhelp documentation installation (Mike Hommey),
998 Fix web site encoding problems (Daniel Veillard),
999 Fix a couple of typo in HTML parser error messages (Michael Day),
1000 Forgot to update the news page for 0.7.7 (Daniel Veillard)
1001 </li>
1002 <li> Portability:
1003 607273 Fix python detection on MSys/Windows (LRN),
1004 614087 Fix Socket API usage to allow Windows64 compilation (Ozkan Sezer),
1005 Fix compilation with Clang (Koop Mast),
1006 Fix Win32 build (Rob Richards)
1007 </li>
1008 <li> Bug Fixes:
1009 595789 fix a remaining potential Solaris problem (Daniel Veillard),
1010 617468 fix progressive HTML parsing with style using "'" (Denis Pauk),
1011 616478 Fix xmllint shell write command (Gwenn Kahz),
1012 614005 Possible erroneous HTML parsing on unterminated script (Pierre Belzile),
1013 627987 Fix XSD IDC errors in imported schemas (Jim Panetta),
1014 629325 XPath rounding errors first cleanup (Phil Shafer),
1015 630140 fix iso995x encoding error (Daniel Veillard),
1016 make sure htmlCtxtReset do reset the disableSAX field (Daniel Veillard),
1017 Fix a change of semantic on XPath preceding and following axis (Daniel Veillard),
1018 Fix a potential segfault due to weak symbols on pthreads (Mike Hommey),
1019 Fix a leak in XPath compilation (Daniel Veillard),
1020 Fix the semantic of XPath axis for namespace/attribute context nodes (Daniel Veillard),
1021 Avoid a descriptor leak in catalog loading code (Carlo Bramini),
1022 Fix a small bug in XPath evaluation code (Marius Wachtler),
1023 Fix handling of XML-1.0 XML namespace declaration (Daniel Veillard),
1024 Fix errors in XSD double validation check (Csaba Raduly),
1025 Fix handling of apos in URIs (Daniel Veillard),
1026 xmlTextReaderReadOuterXml should handle DTD (Rob Richards),
1027 Autogen.sh needs to create m4 directory (Rob Richards)
1028 </li>
1029 <li> Improvements:
1030 606592 update language ID parser to RFC 5646 (Daniel Veillard),
1031 Sort python generated stubs (Mike Hommey),
1032 Add an HTML parser option to avoid a default doctype (Daniel Veillard)
1033 </li>
1034 <li> Cleanups:
1035 618831 don't ship generated files in git (Adrian Bunk),
1036 Switch from the obsolete mkinstalldirs to AC_PROG_MKDIR_P (Adrian Bunk),
1037 Various cleanups on encoding handling (Daniel Veillard),
1038 Fix xmllint to use format=1 for default formatting (Adam Spragg),
1039 Force _xmlSaveCtxt.format to be 0 or 1 (Adam Spragg),
1040 Cleanup encoding pointer comparison (Nikolay Sivov),
1041 Small code cleanup on previous patch (Daniel Veillard)
1042 </li>
1043</ul>
Daniel Veillardf61ba8d2010-03-25 10:54:32 +01001044<h3>2.7.7: Mar 15 2010</h3>
1045<ul>
1046 <li> Improvements:
1047 Adding a --xpath option to xmllint (Daniel Veillard),
1048 Make HTML parser non-recursive (Eugene Pimenov)
1049 </li>
1050 <li> Portability:
1051 relaxng.c: cast to allow compilation with sun studio 11 (Ben Walton),
1052 Fix build failure on Sparc solaris (Roumen Petrov),
1053 use autoreconf in autogen.sh (Daniel Veillard),
1054 Fix build with mingw (Roumen Petrov),
1055 Upgrade some of the configure and autogen (Daniel Veillard),
1056 Fix relaxNG tests in runtest for Windows runtest.c: initialize ret (Rob Richards),
1057 Fix a const warning in xmlNodeSetBase (Martin Trappel),
1058 Fix python generator to not use deprecated xmllib (Daniel Veillard),
1059 Update some automake files (Daniel Veillard),
1060 598785 Fix nanohttp on Windows (spadix)
1061 </li>
1062 <li> Bug Fixes:
1063 libxml violates the zlib interface and crashes (Mark Adler),
1064 Fix broken escape behaviour in regexp ranges (Daniel Veillard),
1065 Fix missing win32 libraries in libxml-2.0.pc (Volker Grabsch),
1066 Fix detection of python linker flags (Daniel Macks),
1067 fix build error in libxml2/python (Paul Smith),
1068 ChunkParser: Incorrect decoding of small xml files (Raul Hudea),
1069 htmlCheckEncoding doesn't update input-end after shrink (Eugene Pimenov),
1070 Fix a missing #ifdef (Daniel Veillard),
1071 Fix encoding selection for xmlParseInNodeContext (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001072 xmlPreviousElementSibling mistake (François Delyon),
Daniel Veillardf61ba8d2010-03-25 10:54:32 +01001073 608773 add a missing check in xmlGROW (Daniel Veillard),
1074 Fix xmlParseInNodeContext for HTML content (Daniel Veillard),
1075 Fix lost namespace when copying node * tree.c: reconcile namespace if not found (Rob Richards),
1076 Fix some missing commas in HTML element lists (Eugene Pimenov),
1077 Correct variable type to unsigned (Nikolay Sivov),
1078 Recognize ID attribute in HTML without DOCTYPE (Daniel Veillard),
1079 Fix memory leak in xmlXPathEvalExpression() (Martin),
1080 Fix an init bug in global.c (Kai Henning),
1081 Fix xmlNodeSetBase() comment (Daniel Veillard),
1082 Fix broken escape behaviour in regexp ranges (Daniel Veillard),
1083 Don't give default HTML boolean attribute values in parser (Daniel Veillard),
1084 xmlCtxtResetLastError should reset ctxt-errNo (Daniel Veillard)
1085 </li>
1086 <li> Cleanups:
1087 Cleanup a couple of weirdness in HTML parser (Eugene Pimenov)
1088 </li>
1089</ul>
Daniel Veillard96bb7402009-10-06 18:38:15 +02001090<h3>2.7.6: Oct 6 2009</h3>
1091<ul>
1092 <li> Bug Fixes:
1093 Restore thread support in default configuration (Andrew W. Nosenko),
1094 URI with no path parsing problem (Daniel Veillard),
1095 Minor patch for conditional defines in threads.c (Eric Zurcher)
1096 </li>
1097</ul>
Daniel Veillard7a896ce2009-09-24 18:38:57 +02001098<h3>2.7.5: Sep 24 2009</h3>
1099<ul>
1100 <li> Bug Fixes:
1101 Restore behavior of --with-threads without argument (Andrew W. Nosenko),
1102 Fix memory leak when doc is NULL (Rob Richards),
1103 595792 fixing a RelaxNG bug introduced in 2.7.4 (Daniel Veillard),
1104 Fix a Relaxng bug raised by libvirt test suite (Daniel Veillard),
1105 Fix a parsing problem with little data at startup (Daniel Veillard),
1106 link python module with python library (Frederic Crozat),
1107 594874 Forgot an fclose in xmllint (Daniel Veillard)
1108 </li>
1109 <li> Cleanup:
1110 Adding symbols.xml to EXTRA_DIST (Daniel Veillard)
1111 </li>
1112</ul>
Daniel Veillard29341682009-09-10 18:23:39 +02001113<h3>2.7.4: Sep 10 2009</h3>
1114<ul>
1115 <li>Improvements:
1116 Switch to GIT (GNOME),
1117 Add symbol versioning to libxml2 shared libs (Daniel Veillard)
1118 </li>
1119 <li>Portability:
1120 593857 try to work around thread pbm MinGW 4.4 (Daniel Veillard),
1121 594250 rename ATTRIBUTE_ALLOC_SIZE to avoid clashes (Daniel Veillard),
1122 Fix Windows build * relaxng.c: fix windows build (Rob Richards),
1123 Fix the globals.h to use XMLPUBFUN (Paul Smith),
1124 Problem with extern extern in header (Daniel Veillard),
1125 Add -lnetwork for compiling on Haiku (Scott McCreary),
1126 Runtest portability patch for Solaris (Tim Rice),
1127 Small patch to accomodate the Haiku OS (Scott McCreary),
1128 584605 package VxWorks folder in the distribution (Daniel Veillard),
1129 574017 Realloc too expensive on most platform (Daniel Veillard),
1130 Fix windows build (Rob Richards),
1131 545579 doesn't compile without schema support (Daniel Veillard),
1132 xmllint use xmlGetNodePath when not compiled in (Daniel Veillard),
1133 Try to avoid __imp__xmlFree link trouble on msys (Daniel Veillard),
1134 Allow to select the threading system on Windows (LRN),
1135 Fix Solaris binary links, cleanups (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001136 Bug 571059 – MSVC doesn't work with the bakefile (Intron),
Daniel Veillard29341682009-09-10 18:23:39 +02001137 fix ATTRIBUTE_PRINTF header clash (Belgabor and Mike Hommey),
1138 fixes for Borland/CodeGear/Embarcadero compilers (Eric Zurcher)
1139 </li>
1140 <li>Documentation:
1141 544910 typo: "renciliateNs" (Leonid Evdokimov),
1142 Add VxWorks to list of OSes (Daniel Veillard),
1143 Regenerate the documentation and update for git (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001144 560524 ¿ xmlTextReaderLocalName description (Daniel Veillard),
Daniel Veillard29341682009-09-10 18:23:39 +02001145 Added sponsoring by AOE media for the server (Daniel Veillard),
1146 updated URLs for GNOME (Vincent Lefevre),
1147 more warnings about xmlCleanupThreads and xmlCleanupParser (Daniel Veillard)
1148 </li>
1149 <li>Bug fixes:
1150 594514 memory leaks - duplicate initialization (MOD),
1151 Wrong block opening in htmlNodeDumpOutputInternal (Daniel Veillard),
1152 492317 Fix Relax-NG validation problems (Daniel Veillard),
1153 558452 fight with reg test and error report (Daniel Veillard),
1154 558452 RNG compilation of optional multiple child (Daniel Veillard),
1155 579746 XSD validation not correct / nilable groups (Daniel Veillard),
1156 502960 provide namespace stack when parsing entity (Daniel Veillard),
1157 566012 part 2 fix regresion tests and push mode (Daniel Veillard),
1158 566012 autodetected encoding and encoding conflict (Daniel Veillard),
1159 584220 xpointer(/) and xinclude problems (Daniel Veillard),
1160 587663 Incorrect Attribute-Value Normalization (Daniel Veillard),
1161 444994 HTML chunked failure for attribute with &lt;&gt; (Daniel Veillard),
1162 Fix end of buffer char being split in XML parser (Daniel Veillard),
1163 Non ASCII character may be split at buffer end (Adiel Mittmann),
1164 440226 Add xmlXIncludeProcessTreeFlagsData API (Stefan Behnel),
1165 572129 speed up parsing of large HTML text nodes (Markus Kull),
1166 Fix HTML parsing with 0 character in CDATA (Daniel Veillard),
1167 Fix SetGenericErrorFunc and SetStructured clash (Wang Lam),
1168 566012 Incomplete EBCDIC parsing support (Martin Kogler),
1169 541335 HTML avoid creating 2 head or 2 body element (Daniel Veillard),
1170 541237 error correcting missing end tags in HTML (Daniel Veillard),
1171 583439 missing line numbers in push mode (Daniel Veillard),
1172 587867 xmllint --html --xmlout serializing as HTML (Daniel Veillard),
1173 559501 avoid select and use poll for nanohttp (Raphael Prevost),
1174 559410 - Regexp bug on (...)? constructs (Daniel Veillard),
1175 Fix a small problem on previous HTML parser patch (Daniel Veillard),
1176 592430 - HTML parser runs into endless loop (Daniel Veillard),
1177 447899 potential double free in xmlFreeTextReader (Daniel Veillard),
1178 446613 small validation bug mixed content with NS (Daniel Veillard),
1179 Fix the problem of revalidating a doc with RNG (Daniel Veillard),
1180 Fix xmlKeepBlanksDefault to not break indent (Nick Wellnhofer),
1181 512131 refs from externalRef part need to be added (Daniel Veillard),
1182 512131 crash in xmlRelaxNGValidateFullElement (Daniel Veillard),
1183 588441 allow '.' in HTML Names even if invalid (Daniel Veillard),
1184 582913 Fix htmlSetMetaEncoding() to be nicer (Daniel Veillard),
1185 579317 Try to find the HTML encoding information (Daniel Veillard),
1186 575875 don't output charset=html (Daniel Veillard),
1187 571271 fix semantic of xsd:all with minOccurs=0 (Daniel Veillard),
1188 570702 fix a bug in regexp determinism checking (Daniel Veillard),
1189 567619 xmlValidateNotationUse missing param test (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001190 574393 ¿ utf-8 filename magic for compressed files (Hans Breuer),
Daniel Veillard29341682009-09-10 18:23:39 +02001191 Fix a couple of problems in the parser (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001192 585505 ¿ Document ids and refs populated by XSD (Wayne Jensen),
Daniel Veillard29341682009-09-10 18:23:39 +02001193 582906 XSD validating multiple imports of the same schema (Jason Childs),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001194 Bug 582887 ¿ problems validating complex schemas (Jason Childs),
1195 Bug 579729 ¿ fix XSD schemas parsing crash (Miroslav Bajtos),
1196 576368 ¿ htmlChunkParser with special attributes (Jiri Netolicky),
1197 Bug 565747 ¿ relax anyURI data character checking (Vincent Lefevre),
Daniel Veillard29341682009-09-10 18:23:39 +02001198 Preserve attributes of include start on tree copy (Petr Pajas),
1199 Skip silently unrecognized XPointer schemes (Jakub Wilk),
1200 Fix leak on SAX1, xmllint --sax1 option and debug (Daniel Veillard),
1201 potential NULL dereference on non-glibc (Jim Meyering),
1202 Fix an XSD validation crash (Daniel Veillard),
1203 Fix a regression in streaming entities support (Daniel Veillard),
1204 Fix a couple of ABI issues with C14N 1.1 (Aleksey Sanin),
1205 Aleksey Sanin support for c14n 1.1 (Aleksey Sanin),
1206 reader bug fix with entities (Daniel Veillard),
1207 use options from current parser ctxt for external entities (Rob Richards),
1208 581612 use %s to printf strings (Christian Persch),
1209 584605 change the threading initialization sequence (Igor Novoseltsev),
1210 580705 keep line numbers in HTML parser (Aaron Patterson),
1211 581803 broken HTML table attributes init (Roland Steiner),
1212 do not set error code in xmlNsWarn (Rob Richards),
1213 564217 fix structured error handling problems,
1214 reuse options from current parser for entities (Rob Richards),
1215 xmlXPathRegisterNs should not allow enpty prefixes (Daniel Veillard),
1216 add a missing check in xmlAddSibling (Kris Breuker),
1217 avoid leaks on errors (Jinmei Tatuya)
1218 </li>
1219 <li>Cleanup:
1220 Chasing dead assignments reported by clang-scan (Daniel Veillard),
1221 A few more safety cleanup raised by scan (Daniel Veillard),
1222 Fixing assorted potential problems raised by scan (Daniel Veillard),
1223 Potential uninitialized arguments raised by scan (Daniel Veillard),
1224 Fix a bunch of scan 'dead increments' and cleanup (Daniel Veillard),
1225 Remove a pedantic warning (Daniel Veillard),
1226 555833 always use rm -f in uninstall-local (Daniel Veillard),
1227 542394 xmlRegisterOutputCallbacks MAX_INPUT_CALLBACK (Daniel Veillard),
1228 Autoregenerate libxml2.syms automated checkings (Daniel Veillard),
1229 Make xmlRecoverDoc const (Martin Trappel) (Daniel Veillard),
1230 Both args of xmlStrcasestr are const (Daniel Veillard),
1231 hide the nbParse* variables used for debugging (Mike Hommey),
1232 570806 changed include of config.h (William M. Brack),
1233 cleanups and error reports when xmlTextWriterVSprintf fails (Jinmei Tatuya)
1234 </li>
1235</ul>
Daniel Veillard97ff9b32009-01-18 21:43:30 +00001236<h3>2.7.3: Jan 18 2009</h3>
1237<ul>
1238 <li>Build fix: fix build when HTML support is not included.</li>
1239 <li>Bug fixes: avoid memory overflow in gigantic text nodes,
1240 indentation problem on the writed (Rob Richards),
1241 xmlAddChildList pointer problem (Rob Richards and Kevin Milburn),
1242 xmlAddChild problem with attribute (Rob Richards and Kris Breuker),
1243 avoid a memory leak in an edge case (Daniel Zimmermann),
1244 deallocate some pthread data (Alex Ott).</li>
1245 <li>Improvements: configure option to avoid rebuilding docs (Adrian Bunk),
1246 limit text nodes to 10MB max by default, add element traversal
1247 APIs, add a parser option to enable pre 2.7 SAX behavior (Rob Richards),
1248 add gcc malloc checking (Marcus Meissner), add gcc printf like functions
1249 parameters checking (Marcus Meissner).</li>
1250</ul>
Daniel Veillard7f4547c2008-10-03 07:58:23 +00001251<h3>2.7.2: Oct 3 2008</h3>
1252<ul>
1253 <li>Portability fix: fix solaris compilation problem, fix compilation
1254 if XPath is not configured in</li>
1255 <li>Bug fixes: nasty entity bug introduced in 2.7.0, restore old behaviour
1256 when saving an HTML doc with an xml dump function, HTML UTF-8 parsing
1257 bug, fix reader custom error handlers (Riccardo Scussat)
1258 <li>Improvement: xmlSave options for more flexibility to save as
1259 XML/HTML/XHTML, handle leading BOM in HTML documents</li>
1260</ul>
1261
Daniel Veillarda7036d92008-09-01 14:50:19 +00001262<h3>2.7.1: Sep 1 2008</h3>
1263<ul>
1264 <li>Portability fix: Borland C fix (Moritz Both)</li>
1265 <li>Bug fixes: python serialization wrappers, XPath QName corner
1266 case handking and leaks (Martin)</li>
1267 <li>Improvement: extend the xmlSave to handle HTML documents and trees</li>
1268 <li>Cleanup: python serialization wrappers</li>
1269</ul>
1270
Daniel Veillard15724252008-08-30 15:01:04 +00001271<h3>2.7.0: Aug 30 2008</h3>
1272<ul>
1273 <li>Documentation: switch ChangeLog to UTF-8, improve mutithreads and
1274 xmlParserCleanup docs</li>
1275 <li>Portability fixes: Older Win32 platforms (Rob Richards), MSVC
1276 porting fix (Rob Richards), Mac OS X regression tests (Sven Herzberg),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001277 non GNUCC builds (Rob Richards), compilation on Haiku (Andreas Färber)
Daniel Veillard15724252008-08-30 15:01:04 +00001278 </li>
1279 <li>Bug fixes: various realloc problems (Ashwin), potential double-free
1280 (Ashwin), regexp crash, icrash with invalid whitespace facets (Rob
1281 Richards), pattern fix when streaming (William Brack), various XML
1282 parsing and validation fixes based on the W3C regression tests, reader
1283 tree skipping function fix (Ashwin), Schemas regexps escaping fix
1284 (Volker Grabsch), handling of entity push errors (Ashwin), fix a slowdown
1285 when encoder cant serialize characters on output</li>
1286 <li>Code cleanup: compilation fix without the reader, without the output
1287 (Robert Schwebel), python whitespace (Martin), many space/tabs cleanups,
1288 serious cleanup of the entity handling code</li>
1289 <li>Improvement: switch parser to XML-1.0 5th edition, add parsing flags
1290 for old versions, switch URI parsing to RFC 3986,
1291 add xmlSchemaValidCtxtGetParserCtxt (Holger Kaelberer),
1292 new hashing functions for dictionnaries (based on Stefan Behnel work),
1293 improve handling of misplaced html/head/body in HTML parser, better
1294 regression test tools and code coverage display, better algorithms
1295 to detect various versions of the billion laughts attacks, make
1296 arbitrary parser limits avoidable as a parser option</li>
1297</ul>
Daniel Veillard596da972008-04-08 14:58:41 +00001298<h3>2.6.32: Apr 8 2008</h3>
1299<ul>
1300 <li>Documentation: returning heap memory to kernel (Wolfram Sang),
1301 trying to clarify xmlCleanupParser() use, xmlXPathContext improvement
1302 (Jack Jansen), improve the *Recover* functions documentation,
1303 XmlNodeType doc link fix (Martijn Arts)</li>
1304 <li>Bug fixes: internal subset memory leak (Ashwin), avoid problem with
1305 paths starting with // (Petr Sumbera), streaming XSD validation callback
1306 patches (Ashwin), fix redirection on port other than 80 (William Brack),
1307 SAX2 leak (Ashwin), XInclude fragment of own document (Chris Ryan),
1308 regexp bug with '.' (Andrew Tosh), flush the writer at the end of the
1309 document (Alfred Mickautsch), output I/O bug fix (William Brack),
1310 writer CDATA output after a text node (Alex Khesin), UTF-16 encoding
1311 detection (William Brack), fix handling of empty CDATA nodes for Safari
1312 team, python binding problem with namespace nodes, improve HTML parsing
1313 (Arnold Hendriks), regexp automata build bug, memory leak fix (Vasily
1314 Chekalkin), XSD test crash, weird system parameter entity parsing problem,
1315 allow save to file:///X:/ windows paths, various attribute normalisation
1316 problems, externalSubsetSplit fix (Ashwin), attribute redefinition in
1317 the DTD (Ashwin), fix in char ref parsing check (Alex Khesin), many
1318 out of memory handling fixes (Ashwin), XPath out of memory handling fixes
1319 (Alvaro Herrera), various realloc problems (Ashwin), UCS4 encoding
1320 conversion buffer size (Christian Fruth), problems with EatName
1321 functions on memory errors, BOM handling in external parsed entities
1322 (Mark Rowe)</li>
1323 <li>Code cleanup: fix build under VS 2008 (David Wimsey), remove useless
1324 mutex in xmlDict (Florent Guilian), Mingw32 compilation fix (Carlo
1325 Bramini), Win and MacOS EOL cleanups (Florent Guiliani), iconv need
1326 a const detection (Roumen Petrov), simplify xmlSetProp (Julien Charbon),
1327 cross compilation fixes for Mingw (Roumen Petrov), SCO Openserver build
1328 fix (Florent Guiliani), iconv uses const on Win32 (Rob Richards),
1329 duplicate code removal (Ashwin), missing malloc test and error reports
1330 (Ashwin), VMS makefile fix (Tycho Hilhorst)</li>
1331 <li>improvements: better plug of schematron in the normal error handling
1332 (Tobias Minich)</li>
1333</ul>
1334
Daniel Veillard28b64e22008-01-11 09:07:51 +00001335<h3>2.6.31: Jan 11 2008</h3>
1336<ul>
1337 <li>Security fix: missing of checks in UTF-8 parsing</li>
1338 <li>Bug fixes: regexp bug, dump attribute from XHTML document, fix
1339 xmlFree(NULL) to not crash in debug mode, Schematron parsing crash
1340 (Rob Richards), global lock free on Windows (Marc-Antoine Ruel),
1341 XSD crash due to double free (Rob Richards), indentation fix in
1342 xmlTextWriterFullEndElement (Felipe Pena), error in attribute type
1343 parsing if attribute redeclared, avoid crash in hash list scanner if
1344 deleting elements, column counter bug fix (Christian Schmidt),
1345 HTML embed element saving fix (Stefan Behnel), avoid -L/usr/lib
1346 output from xml2-config (Fred Crozat), avoid an xmllint crash
1347 (Stefan Kost), don't stop HTML parsing on out of range chars.
1348 </li>
1349 <li>Code cleanup: fix open() call third argument, regexp cut'n paste
1350 copy error, unused variable in __xmlGlobalInitMutexLock (Hannes Eder),
1351 some make distcheck realted fixes (John Carr)</li>
1352 <li>Improvements: HTTP Header: includes port number (William Brack),
1353 testURI --debug option, </li>
1354</ul>
Daniel Veillardc1b3fe02007-08-23 15:00:06 +00001355<h3>2.6.30: Aug 23 2007</h3>
1356<ul>
1357 <li>Portability: Solaris crash on error handling, windows path fixes
1358 (Roland Schwarz and Rob Richards), mingw build (Roland Schwarz)</li>
1359 <li>Bugfixes: xmlXPathNodeSetSort problem (William Brack), leak when
1360 reusing a writer for a new document (Dodji Seketeli), Schemas
1361 xsi:nil handling patch (Frank Gross), relative URI build problem
1362 (Patrik Fimml), crash in xmlDocFormatDump, invalid char in comment
1363 detection bug, fix disparity with xmlSAXUserParseMemory, automata
1364 generation for complex regexp counts problems, Schemas IDC import
1365 problems (Frank Gross), xpath predicate evailation error handling
1366 (William Brack)</li>
1367</ul>
Daniel Veillard38431c32007-06-12 16:20:09 +00001368<h3>2.6.29: Jun 12 2007</h3>
1369<ul>
1370 <li>Portability: patches from Andreas Stricke for WinCEi,
1371 fix compilation warnings (William Brack), avoid warnings on Apple OS/X
1372 (Wendy Doyle and Mark Rowe), Windows compilation and threading
1373 improvements (Rob Richards), compilation against old Python versions,
1374 new GNU tar changes (Ryan Hill)</li>
1375 <li>Documentation: xmlURIUnescapeString comment, </li>
1376 <li>Bugfixes: xmlBufferAdd problem (Richard Jones), 'make valgrind'
1377 flag fix (Richard Jones), regexp interpretation of \,
1378 htmlCreateDocParserCtxt (Jean-Daniel Dupas), configure.in
1379 typo (Bjorn Reese), entity content failure, xmlListAppend() fix
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001380 (Georges-André Silber), XPath number serialization (William Brack),
Daniel Veillard38431c32007-06-12 16:20:09 +00001381 nanohttp gzipped stream fix (William Brack and Alex Cornejo),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001382 xmlCharEncFirstLine typo (Mark Rowe), uri bug (François Delyon),
Daniel Veillard38431c32007-06-12 16:20:09 +00001383 XPath string value of PI nodes (William Brack), XPath node set
1384 sorting bugs (William Brack), avoid outputting namespace decl
1385 dups in the writer (Rob Richards), xmlCtxtReset bug, UTF-8 encoding
1386 error handling, recustion on next in catalogs, fix a Relax-NG crash,
1387 workaround wrong file: URIs, htmlNodeDumpFormatOutput on attributes,
1388 invalid character in attribute detection bug, big comments before
1389 internal subset streaming bug, HTML parsing of attributes with : in
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001390 the name, IDness of name in HTML (Dagfinn I. Mannsåker) </li>
Daniel Veillard38431c32007-06-12 16:20:09 +00001391 <li>Improvement: keep URI query parts in raw form (Richard Jones),
1392 embed tag support in HTML (Michael Day) </li>
1393</ul>
1394
Daniel Veillard39bcf942007-04-17 14:47:05 +00001395<h3>2.6.28: Apr 17 2007</h3>
1396<ul>
1397 <li>Documentation: comment fixes (Markus Keim), xpath comments fixes too
1398 (James Dennett)</li>
1399 <li>Bug fixes: XPath bug (William Brack), HTML parser autoclose stack usage
1400 (Usamah Malik), various regexp bug fixes (DV and William), path conversion
1401 on Windows (Igor Zlatkovic), htmlCtxtReset fix (Michael Day), XPath
1402 principal node of axis bug, HTML serialization of some codepoint
1403 (Steven Rainwater), user data propagation in XInclude (Michael Day),
1404 standalone and XML decl detection (Michael Day), Python id ouptut
1405 for some id, fix the big python string memory leak, URI parsing fixes
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001406 (Stéphane Bidoul and William), long comments parsing bug (William),
Daniel Veillard39bcf942007-04-17 14:47:05 +00001407 concurrent threads initialization (Ted Phelps), invalid char
1408 in text XInclude (William), XPath memory leak (William), tab in
1409 python problems (Andreas Hanke), XPath node comparison error
1410 (Oleg Paraschenko), cleanup patch for reader (Julien Reichel),
1411 XML Schemas attribute group (William), HTML parsing problem (William),
1412 fix char 0x2d in regexps (William), regexp quantifier range with
1413 min occurs of 0 (William), HTML script/style parsing (Mike Day)</li>
1414 <li>Improvement: make xmlTextReaderSetup() public</li>
1415 <li>Compilation and postability: fix a missing include problem (William),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001416 __ss_familly on AIX again (Björn Wiberg), compilation without zlib
Daniel Veillard39bcf942007-04-17 14:47:05 +00001417 (Michael Day), catalog patch for Win32 (Christian Ehrlicher),
1418 Windows CE fixes (Andreas Stricke)</li>
1419 <li>Various CVS to SVN infrastructure changes</li>
1420</ul>
Daniel Veillardc8338f12006-10-25 16:06:29 +00001421<h3>2.6.27: Oct 25 2006</h3>
1422<ul>
1423 <li>Portability fixes: file names on windows (Roland Schwingel,
1424 Emelyanov Alexey), windows compile fixup (Rob Richards),
1425 AIX iconv() is apparently case sensitive</li>
1426 <li>improvements: Python XPath types mapping (Nic Ferrier), XPath optimization
1427 (Kasimier), add xmlXPathCompiledEvalToBoolean (Kasimier), Python node
1428 equality and comparison (Andreas Pakulat), xmlXPathCollectAndTest
1429 improvememt (Kasimier), expose if library was compiled with zlib
1430 support (Andrew Nosenko), cache for xmlSchemaIDCMatcher structs
1431 (Kasimier), xmlTextConcat should work with comments and PIs (Rob
1432 Richards), export htmlNewParserCtxt needed by Michael Day, refactoring
1433 of catalog entity loaders (Michael Day), add XPointer support to
1434 python bindings (Ross Reedstrom, Brian West and Stefan Anca),
1435 try to sort out most file path to URI conversions and xmlPathToUri,
1436 add --html --memory case to xmllint</li>
1437 <li>building fix: fix --with-minimum (Felipe Contreras), VMS fix,
1438 const'ification of HTML parser structures (Matthias Clasen),
1439 portability fix (Emelyanov Alexey), wget autodetection (Peter
1440 Breitenlohner), remove the build path recorded in the python
1441 shared module, separate library flags for shared and static builds
1442 (Mikhail Zabaluev), fix --with-minimum --with-sax1 builds, fix
1443 --with-minimum --with-schemas builds</li>
1444 <li>bug fix: xmlGetNodePath fix (Kasimier), xmlDOMWrapAdoptNode and
1445 attribute (Kasimier), crash when using the recover mode,
1446 xmlXPathEvalExpr problem (Kasimier), xmlXPathCompExprAdd bug (Kasimier),
1447 missing destry in xmlFreeRMutex (Andrew Nosenko), XML Schemas fixes
1448 (Kasimier), warning on entities processing, XHTML script and style
1449 serialization (Kasimier), python generator for long types, bug in
1450 xmlSchemaClearValidCtxt (Bertrand Fritsch), xmlSchemaXPathEvaluate
1451 allocation bug (Marton Illes), error message end of line (Rob Richards),
1452 fix attribute serialization in writer (Rob Richards), PHP4 DTD validation
1453 crasher, parser safety patch (Ben Darnell), _private context propagation
1454 when parsing entities (with Michael Day), fix entities behaviour when
1455 using SAX, URI to file path fix (Mikhail Zabaluev), disapearing validity
1456 context, arg error in SAX callback (Mike Hommey), fix mixed-content
1457 autodetect when using --noblanks, fix xmlIOParseDTD error handling,
1458 fix bug in xmlSplitQName on special Names, fix Relax-NG element content
1459 validation bug, fix xmlReconciliateNs bug, fix potential attribute
1460 XML parsing bug, fix line/column accounting in XML parser, chunking bug
1461 in the HTML parser on script, try to detect obviously buggy HTML
1462 meta encoding indications, bugs with encoding BOM and xmlSaveDoc,
1463 HTML entities in attributes parsing, HTML minimized attribute values,
1464 htmlReadDoc and htmlReadIO were broken, error handling bug in
1465 xmlXPathEvalExpression (Olaf Walkowiak), fix a problem in
1466 htmlCtxtUseOptions, xmlNewInputFromFile could leak (Marius Konitzer),
1467 bug on misformed SSD regexps (Christopher Boumenot)
1468 </li>
1469 <li>documentation: warning about XML_PARSE_COMPACT (Kasimier Buchcik),
1470 fix xmlXPathCastToString documentation, improve man pages for
1471 xmllitn and xmlcatalog (Daniel Leidert), fixed comments of a few
1472 functions</li>
1473</ul>
Daniel Veillardfabafd52006-06-08 08:16:33 +00001474<h3>2.6.26: Jun 6 2006</h3>
Daniel Veillard69839ba2006-06-06 13:27:03 +00001475<ul>
Daniel Veillardfabafd52006-06-08 08:16:33 +00001476 <li>portability fixes: Python detection (Joseph Sacco), compilation
1477 error(William Brack and Graham Bennett), LynxOS patch (Olli Savia)</li>
1478 <li>bug fixes: encoding buffer problem, mix of code and data in
1479 xmlIO.c(Kjartan Maraas), entities in XSD validation (Kasimier Buchcik),
1480 variousXSD validation fixes (Kasimier), memory leak in pattern (Rob
1481 Richards andKasimier), attribute with colon in name (Rob Richards), XPath
1482 leak inerror reporting (Aleksey Sanin), XInclude text include of
1483 selfdocument.</li>
1484 <li>improvements: Xpath optimizations (Kasimier), XPath object
1485 cache(Kasimier)</li>
Daniel Veillard69839ba2006-06-06 13:27:03 +00001486</ul>
1487
Daniel Veillardfabafd52006-06-08 08:16:33 +00001488<h3>2.6.25: Jun 6 2006:</h3>
1489
1490<p>Do not use or package 2.6.25</p>
1491
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +00001492<h3>2.6.24: Apr 28 2006</h3>
1493<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001494 <li>Portability fixes: configure on Windows, testapi compile on windows
1495 (Kasimier Buchcik, venkat naidu), Borland C++ 6 compile (Eric Zurcher),
1496 HP-UX compiler workaround (Rick Jones), xml2-config bugfix, gcc-4.1
1497 cleanups, Python detection scheme (Joseph Sacco), UTF-8 file paths on
1498 Windows (Roland Schwingel).
1499 </li>
1500 <li>Improvements: xmlDOMWrapReconcileNamespaces xmlDOMWrapCloneNode (Kasimier
1501 Buchcik), XML catalog debugging (Rick Jones), update to Unicode 4.01.</li>
1502 <li>Bug fixes: xmlParseChunk() problem in 2.6.23, xmlParseInNodeContext()
1503 on HTML docs, URI behaviour on Windows (Rob Richards), comment streaming
1504 bug, xmlParseComment (with William Brack), regexp bug fixes (DV &amp;
1505 Youri Golovanov), xmlGetNodePath on text/CDATA (Kasimier),
1506 one Relax-NG interleave bug, xmllint --path and --valid,
1507 XSD bugfixes (Kasimier), remove debug
1508 left in Python bindings (Nic Ferrier), xmlCatalogAdd bug (Martin Cole),
1509 xmlSetProp fixes (Rob Richards), HTML IDness (Rob Richards), a large
1510 number of cleanups and small fixes based on Coverity reports, bug
1511 in character ranges, Unicode tables const (Aivars Kalvans), schemas
1512 fix (Stefan Kost), xmlRelaxNGParse error deallocation,
1513 xmlSchemaAddSchemaDoc error deallocation, error handling on unallowed
1514 code point, ixmllint --nonet to never reach the net (Gary Coady),
1515 line break in writer after end PI (Jason Viers). </li>
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +00001516 <li>Documentation: man pages updates and cleanups (Daniel Leidert).</li>
1517 <li>New features: Relax NG structure error handlers.</li>
1518</ul>
1519
Daniel Veillard67952602006-01-05 15:29:44 +00001520<h3>2.6.23: Jan 5 2006</h3>
1521<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001522 <li>portability fixes: Windows (Rob Richards), getaddrinfo on Windows
1523 (Kolja Nowak, Rob Richards), icc warnings (Kjartan Maraas),
1524 --with-minimum compilation fixes (William Brack), error case handling fix
1525 on Solaris (Albert Chin), don't use 'list' as parameter name reported by
1526 Samuel Diaz Garcia, more old Unices portability fixes (Albert Chin),
1527 MinGW compilation (Mark Junker), HP-UX compiler warnings (Rick
1528 Jones),</li>
1529 <li>code cleanup: xmlReportError (Adrian Mouat), remove xmlBufferClose
1530 (Geert Jansen), unreachable code (Oleksandr Kononenko), refactoring
1531 parsing code (Bjorn Reese)</li>
1532 <li>bug fixes: xmlBuildRelativeURI and empty path (William Brack),
1533 combinatory explosion and performances in regexp code, leak in
1534 xmlTextReaderReadString(), xmlStringLenDecodeEntities problem (Massimo
1535 Morara), Identity Constraints bugs and a segfault (Kasimier Buchcik),
1536 XPath pattern based evaluation bugs (DV &amp; Kasimier),
1537 xmlSchemaContentModelDump() memory leak (Kasimier), potential leak in
1538 xmlSchemaCheckCSelectorXPath(), xmlTextWriterVSprintf() misuse of
1539 vsnprintf (William Brack), XHTML serialization fix (Rob Richards), CRLF
1540 split problem (William), issues with non-namespaced attributes in
1541 xmlAddChild() xmlAddNextSibling() and xmlAddPrevSibling() (Rob Richards),
1542 HTML parsing of script, Python must not output to stdout (Nic Ferrier),
1543 exclusive C14N namespace visibility (Aleksey Sanin), XSD dataype
1544 totalDigits bug (Kasimier Buchcik), error handling when writing to an
1545 xmlBuffer (Rob Richards), runtest schemas error not reported (Hisashi
1546 Fujinaka), signed/unsigned problem in date/time code (Albert Chin), fix
1547 XSI driven XSD validation (Kasimier), parsing of xs:decimal (Kasimier),
1548 fix DTD writer output (Rob Richards), leak in xmlTextReaderReadInnerXml
1549 (Gary Coady), regexp bug affecting schemas (Kasimier), configuration of
1550 runtime debugging (Kasimier), xmlNodeBufGetContent bug on entity refs
1551 (Oleksandr Kononenko), xmlRegExecPushString2 bug (Sreeni Nair),
1552 compilation and build fixes (Michael Day), removed dependancies on
1553 xmlSchemaValidError (Kasimier), bug with &lt;xml:foo/&gt;, more XPath
1554 pattern based evaluation fixes (Kasimier)</li>
1555 <li>improvements: XSD Schemas redefinitions/restrictions (Kasimier
1556 Buchcik), node copy checks and fix for attribute (Rob Richards), counted
1557 transition bug in regexps, ctxt-&gt;standalone = -2 to indicate no
1558 standalone attribute was found, add xmlSchemaSetParserStructuredErrors()
1559 (Kasimier Buchcik), add xmlTextReaderSchemaValidateCtxt() to API
1560 (Kasimier), handle gzipped HTTP resources (Gary Coady), add
1561 htmlDocDumpMemoryFormat. (Rob Richards),</li>
1562 <li>documentation: typo (Michael Day), libxml man page (Albert Chin), save
1563 function to XML buffer (Geert Jansen), small doc fix (Aron Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +00001564</ul>
1565
Daniel Veillard33b20b72005-09-12 21:43:20 +00001566<h3>2.6.22: Sep 12 2005</h3>
1567<ul>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001568 <li>build fixes: compile without schematron (Stéphane Bidoul)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001569 <li>bug fixes: xmlDebugDumpNode on namespace node (Oleg Paraschenko)i,
1570 CDATA push parser bug, xmlElemDump problem with XHTML1 doc,
1571 XML_FEATURE_xxx clash with expat headers renamed XML_WITH_xxx, fix some
1572 output formatting for meta element (Rob Richards), script and style
1573 XHTML1 serialization (David Madore), Attribute derivation fixups in XSD
1574 (Kasimier Buchcik), better IDC error reports (Kasimier Buchcik)</li>
1575 <li>improvements: add XML_SAVE_NO_EMPTY xmlSaveOption (Rob Richards), add
1576 XML_SAVE_NO_XHTML xmlSaveOption, XML Schemas improvements preparing for
1577 derive (Kasimier Buchcik).</li>
1578 <li>documentation: generation of gtk-doc like docs, integration with
1579 devhelp.</li>
Daniel Veillard33b20b72005-09-12 21:43:20 +00001580</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00001581
Daniel Veillardb3d14912005-09-04 20:47:39 +00001582<h3>2.6.21: Sep 4 2005</h3>
1583<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001584 <li>build fixes: Cygwin portability fixes (Gerrit P. Haase), calling
1585 convention problems on Windows (Marcus Boerger), cleanups based on Linus'
1586 sparse tool, update of win32/configure.js (Rob Richards), remove warnings
1587 on Windows(Marcus Boerger), compilation without SAX1, detection of the
1588 Python binary, use $GCC inestad of $CC = 'gcc' (Andrew W. Nosenko),
1589 compilation/link with threads and old gcc, compile problem by C370 on
1590 Z/OS,</li>
1591 <li>bug fixes: http_proxy environments (Peter Breitenlohner), HTML UTF-8
1592 bug (Jiri Netolicky), XPath NaN compare bug (William Brack),
1593 htmlParseScript potential bug, Schemas regexp handling of spaces, Base64
1594 Schemas comparisons NIST passes, automata build error xsd:all,
1595 xmlGetNodePath for namespaced attributes (Alexander Pohoyda), xmlSchemas
1596 foreign namespaces handling, XML Schemas facet comparison (Kupriyanov
1597 Anatolij), xmlSchemaPSimpleTypeErr error report (Kasimier Buchcik), xml:
1598 namespace ahndling in Schemas (Kasimier), empty model group in Schemas
1599 (Kasimier), wilcard in Schemas (Kasimier), URI composition (William),
1600 xs:anyType in Schemas (Kasimier), Python resolver emmitting error
1601 messages directly, Python xmlAttr.parent (Jakub Piotr Clapa), trying to
1602 fix the file path/URI conversion, xmlTextReaderGetAttribute fix (Rob
1603 Richards), xmlSchemaFreeAnnot memleak (Kasimier), HTML UTF-8
1604 serialization, streaming XPath, Schemas determinism detection problem,
1605 XInclude bug, Schemas context type (Dean Hill), validation fix (Derek
1606 Poon), xmlTextReaderGetAttribute[Ns] namespaces (Rob Richards), Schemas
1607 type fix (Kuba Nowakowski), UTF-8 parser bug, error in encoding handling,
1608 xmlGetLineNo fixes, bug on entities handling, entity name extraction in
1609 error handling with XInclude, text nodes in HTML body tags (Gary Coady),
1610 xml:id and IDness at the treee level fixes, XPath streaming patterns
1611 bugs.</li>
1612 <li>improvements: structured interfaces for schemas and RNG error reports
1613 (Marcus Boerger), optimization of the char data inner loop parsing
1614 (thanks to Behdad Esfahbod for the idea), schematron validation though
1615 not finished yet, xmlSaveOption to omit XML declaration, keyref match
1616 error reports (Kasimier), formal expression handling code not plugged
1617 yet, more lax mode for the HTML parser, parser XML_PARSE_COMPACT option
1618 for text nodes allocation.</li>
Daniel Veillardb3d14912005-09-04 20:47:39 +00001619 <li>documentation: xmllint man page had --nonet duplicated</li>
1620</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00001621
Daniel Veillard78dfc9f2005-07-10 22:30:30 +00001622<h3>2.6.20: Jul 10 2005</h3>
1623<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001624 <li>build fixes: Windows build (Rob Richards), Mingw compilation (Igor
1625 Zlatkovic), Windows Makefile (Igor), gcc warnings (Kasimier and
1626 andriy@google.com), use gcc weak references to pthread to avoid the
1627 pthread dependancy on Linux, compilation problem (Steve Nairn), compiling
1628 of subset (Morten Welinder), IPv6/ss_family compilation (William Brack),
1629 compilation when disabling parts of the library, standalone test
1630 distribution.</li>
1631 <li>bug fixes: bug in lang(), memory cleanup on errors (William Brack),
1632 HTTP query strings (Aron Stansvik), memory leak in DTD (William), integer
1633 overflow in XPath (William), nanoftp buffer size, pattern "." apth fixup
1634 (Kasimier), leak in tree reported by Malcolm Rowe, replaceNode patch
1635 (Brent Hendricks), CDATA with NULL content (Mark Vakoc), xml:base fixup
1636 on XInclude (William), pattern fixes (William), attribute bug in
1637 exclusive c14n (Aleksey Sanin), xml:space and xml:lang with SAX2 (Rob
1638 Richards), namespace trouble in complex parsing (Malcolm Rowe), XSD type
1639 QNames fixes (Kasimier), XPath streaming fixups (William), RelaxNG bug
1640 (Rob Richards), Schemas for Schemas fixes (Kasimier), removal of ID (Rob
1641 Richards), a small RelaxNG leak, HTML parsing in push mode bug (James
1642 Bursa), failure to detect UTF-8 parsing bugs in CDATA sections,
1643 areBlanks() heuristic failure, duplicate attributes in DTD bug
1644 (William).</li>
1645 <li>improvements: lot of work on Schemas by Kasimier Buchcik both on
1646 conformance and streaming, Schemas validation messages (Kasimier Buchcik,
1647 Matthew Burgess), namespace removal at the python level (Brent
1648 Hendricks), Update to new Schemas regression tests from W3C/Nist
1649 (Kasimier), xmlSchemaValidateFile() (Kasimier), implementation of
1650 xmlTextReaderReadInnerXml and xmlTextReaderReadOuterXml (James Wert),
1651 standalone test framework and programs, new DOM import APIs
1652 xmlDOMWrapReconcileNamespaces() xmlDOMWrapAdoptNode() and
1653 xmlDOMWrapRemoveNode(), extension of xmllint capabilities for SAX and
1654 Schemas regression tests, xmlStopParser() available in pull mode too,
1655 ienhancement to xmllint --shell namespaces support, Windows port of the
1656 standalone testing tools (Kasimier and William),
1657 xmlSchemaValidateStream() xmlSchemaSAXPlug() and xmlSchemaSAXUnplug() SAX
1658 Schemas APIs, Schemas xmlReader support.</li>
Daniel Veillard78dfc9f2005-07-10 22:30:30 +00001659</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00001660
Daniel Veillard771971f2005-04-02 10:49:51 +00001661<h3>2.6.19: Apr 02 2005</h3>
1662<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001663 <li>build fixes: drop .la from RPMs, --with-minimum build fix (William
1664 Brack), use XML_SOCKLEN_T instead of SOCKLEN_T because it breaks with AIX
1665 5.3 compiler, fixed elfgcchack.h generation and PLT reduction code on
1666 Linux/ELF/gcc4</li>
1667 <li>bug fixes: schemas type decimal fixups (William Brack), xmmlint return
1668 code (Gerry Murphy), small schemas fixes (Matthew Burgess and GUY
1669 Fabrice), workaround "DAV:" namespace brokeness in c14n (Aleksey Sanin),
1670 segfault in Schemas (Kasimier Buchcik), Schemas attribute validation
1671 (Kasimier), Prop related functions and xmlNewNodeEatName (Rob Richards),
1672 HTML serialization of name attribute on a elements, Python error handlers
1673 leaks and improvement (Brent Hendricks), uninitialized variable in
1674 encoding code, Relax-NG validation bug, potential crash if
1675 gnorableWhitespace is NULL, xmlSAXParseDoc and xmlParseDoc signatures,
1676 switched back to assuming UTF-8 in case no encoding is given at
1677 serialization time</li>
1678 <li>improvements: lot of work on Schemas by Kasimier Buchcik on facets
1679 checking and also mixed handling.</li>
Daniel Veillard771971f2005-04-02 10:49:51 +00001680 <li></li>
1681</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00001682
Daniel Veillard57c000e2005-03-13 18:34:29 +00001683<h3>2.6.18: Mar 13 2005</h3>
1684<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001685 <li>build fixes: warnings (Peter Breitenlohner), testapi.c generation,
1686 Bakefile support (Francesco Montorsi), Windows compilation (Joel Reed),
1687 some gcc4 fixes, HP-UX portability fixes (Rick Jones).</li>
1688 <li>bug fixes: xmlSchemaElementDump namespace (Kasimier Buchcik), push and
1689 xmlreader stopping on non-fatal errors, thread support for dictionnaries
1690 reference counting (Gary Coady), internal subset and push problem, URL
1691 saved in xmlCopyDoc, various schemas bug fixes (Kasimier), Python paths
1692 fixup (Stephane Bidoul), xmlGetNodePath and namespaces, xmlSetNsProp fix
1693 (Mike Hommey), warning should not count as error (William Brack),
1694 xmlCreatePushParser empty chunk, XInclude parser flags (William), cleanup
1695 FTP and HTTP code to reuse the uri parsing and IPv6 (William),
1696 xmlTextWriterStartAttributeNS fix (Rob Richards), XMLLINT_INDENT being
1697 empty (William), xmlWriter bugs (Rob Richards), multithreading on Windows
1698 (Rich Salz), xmlSearchNsByHref fix (Kasimier), Python binding leak (Brent
1699 Hendricks), aliasing bug exposed by gcc4 on s390, xmlTextReaderNext bug
1700 (Rob Richards), Schemas decimal type fixes (William Brack),
1701 xmlByteConsumed static buffer (Ben Maurer).</li>
1702 <li>improvement: speedup parsing comments and DTDs, dictionnary support for
1703 hash tables, Schemas Identity constraints (Kasimier), streaming XPath
1704 subset, xmlTextReaderReadString added (Bjorn Reese), Schemas canonical
1705 values handling (Kasimier), add xmlTextReaderByteConsumed (Aron
1706 Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +00001707 <li>Documentation: Wiki support (Joel Reed)</li>
Daniel Veillard57c000e2005-03-13 18:34:29 +00001708</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00001709
Daniel Veillard298d9642005-01-16 20:01:55 +00001710<h3>2.6.17: Jan 16 2005</h3>
1711<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001712 <li>build fixes: Windows, warnings removal (William Brack),
1713 maintainer-clean dependency(William), build in a different directory
1714 (William), fixing --with-minimum configure build (William), BeOS build
1715 (Marcin Konicki), Python-2.4 detection (William), compilation on AIX (Dan
1716 McNichol)</li>
1717 <li>bug fixes: xmlTextReaderHasAttributes (Rob Richards), xmlCtxtReadFile()
1718 to use the catalog(s), loop on output (William Brack), XPath memory leak,
1719 ID deallocation problem (Steve Shepard), debugDumpNode crash (William),
1720 warning not using error callback (William), xmlStopParser bug (William),
1721 UTF-16 with BOM on DTDs (William), namespace bug on empty elements in
1722 push mode (Rob Richards), line and col computations fixups (Aleksey
1723 Sanin), xmlURIEscape fix (William), xmlXPathErr on bad range (William),
1724 patterns with too many steps, bug in RNG choice optimization, line number
1725 sometimes missing.</li>
1726 <li>improvements: XSD Schemas (Kasimier Buchcik), python generator
1727 (William), xmlUTF8Strpos speedup (William), unicode Python strings
1728 (William), XSD error reports (Kasimier Buchcik), Python __str__ call
1729 serialize().</li>
1730 <li>new APIs: added xmlDictExists(), GetLineNumber and GetColumnNumber for
1731 the xmlReader (Aleksey Sanin), Dynamic Shared Libraries APIs (mostly Joel
1732 Reed), error extraction API from regexps, new XMLSave option for format
1733 (Phil Shafer)</li>
1734 <li>documentation: site improvement (John Fleck), FAQ entries
1735 (William).</li>
Daniel Veillard298d9642005-01-16 20:01:55 +00001736</ul>
1737
Daniel Veillardc3d7cb42004-11-10 14:34:45 +00001738<h3>2.6.16: Nov 10 2004</h3>
1739<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001740 <li>general hardening and bug fixing crossing all the API based on new
1741 automated regression testing</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +00001742 <li>build fix: IPv6 build and test on AIX (Dodji Seketeli)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001743 <li>bug fixes: problem with XML::Libxml reported by Petr Pajas, encoding
1744 conversion functions return values, UTF-8 bug affecting XPath reported by
1745 Markus Bertheau, catalog problem with NULL entries (William Brack)</li>
1746 <li>documentation: fix to xmllint man page, some API function descritpion
1747 were updated.</li>
1748 <li>improvements: DTD validation APIs provided at the Python level (Brent
1749 Hendricks)</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +00001750</ul>
1751
Daniel Veillardc2f83d12004-10-27 22:59:21 +00001752<h3>2.6.15: Oct 27 2004</h3>
Daniel Veillard6927b102004-10-27 17:29:04 +00001753<ul>
1754 <li>security fixes on the nanoftp and nanohttp modules</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001755 <li>build fixes: xmllint detection bug in configure, building outside the
1756 source tree (Thomas Fitzsimmons)</li>
1757 <li>bug fixes: HTML parser on broken ASCII chars in names (William), Python
1758 paths (Malcolm Tredinnick), xmlHasNsProp and default namespace (William),
1759 saving to python file objects (Malcolm Tredinnick), DTD lookup fix
1760 (Malcolm), save back &lt;group&gt; in catalogs (William), tree build
1761 fixes (DV and Rob Richards), Schemas memory bug, structured error handler
1762 on Python 64bits, thread local memory deallocation, memory leak reported
1763 by Volker Roth, xmlValidateDtd in the presence of an internal subset,
1764 entities and _private problem (William), xmlBuildRelativeURI error
1765 (William).</li>
1766 <li>improvements: better XInclude error reports (William), tree debugging
1767 module and tests, convenience functions at the Reader API (Graham
1768 Bennett), add support for PI in the HTML parser.</li>
Daniel Veillard6927b102004-10-27 17:29:04 +00001769</ul>
1770
Daniel Veillard210818b2004-09-29 15:50:37 +00001771<h3>2.6.14: Sep 29 2004</h3>
1772<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001773 <li>build fixes: configure paths for xmllint and xsltproc, compilation
1774 without HTML parser, compilation warning cleanups (William Brack &amp;
1775 Malcolm Tredinnick), VMS makefile update (Craig Berry),</li>
1776 <li>bug fixes: xmlGetUTF8Char (William Brack), QName properties (Kasimier
1777 Buchcik), XInclude testing, Notation serialization, UTF8ToISO8859x
1778 transcoding (Mark Itzcovitz), lots of XML Schemas cleanup and fixes
1779 (Kasimier), ChangeLog cleanup (Stepan Kasal), memory fixes (Mark Vakoc),
1780 handling of failed realloc(), out of bound array adressing in Schemas
1781 date handling, Python space/tabs cleanups (Malcolm Tredinnick), NMTOKENS
1782 E20 validation fix (Malcolm),</li>
1783 <li>improvements: added W3C XML Schemas testsuite (Kasimier Buchcik), add
1784 xmlSchemaValidateOneElement (Kasimier), Python exception hierearchy
1785 (Malcolm Tredinnick), Python libxml2 driver improvement (Malcolm
1786 Tredinnick), Schemas support for xsi:schemaLocation,
1787 xsi:noNamespaceSchemaLocation, xsi:type (Kasimier Buchcik)</li>
Daniel Veillard210818b2004-09-29 15:50:37 +00001788</ul>
1789
Daniel Veillardd1de4a32004-08-31 13:43:07 +00001790<h3>2.6.13: Aug 31 2004</h3>
1791<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001792 <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag with gcc,
1793 Solaris compiler warning, fixing RPM BuildRequires,</li>
1794 <li>fixes: DTD loading on Windows (Igor), Schemas error reports APIs
1795 (Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 (William Brack
1796 and Julius Mittenzwei), Schemas facet check (Kasimier), default namespace
1797 problem (William), Schemas hexbinary empty values, encoding error could
1798 genrate a serialization loop.</li>
1799 <li>Improvements: Schemas validity improvements (Kasimier), added --path
1800 and --load-trace options to xmllint</li>
Daniel Veillardd1de4a32004-08-31 13:43:07 +00001801 <li>documentation: tutorial update (John Fleck)</li>
1802</ul>
1803
Daniel Veillardb331fff2004-08-22 14:21:57 +00001804<h3>2.6.12: Aug 22 2004</h3>
1805<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001806 <li>build fixes: fix --with-minimum, elfgcchack.h fixes (Peter
1807 Breitenlohner), perl path lookup (William), diff on Solaris (Albert
1808 Chin), some 64bits cleanups.</li>
1809 <li>Python: avoid a warning with 2.3 (William Brack), tab and space mixes
1810 (William), wrapper generator fixes (William), Cygwin support (Gerrit P.
1811 Haase), node wrapper fix (Marc-Antoine Parent), XML Schemas support
1812 (Torkel Lyng)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +00001813 <li>Schemas: a lot of bug fixes and improvements from Kasimier Buchcik</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001814 <li>fixes: RVT fixes (William), XPath context resets bug (William), memory
1815 debug (Steve Hay), catalog white space handling (Peter Breitenlohner),
1816 xmlReader state after attribute reading (William), structured error
1817 handler (William), XInclude generated xml:base fixup (William), Windows
1818 memory reallocation problem (Steve Hay), Out of Memory conditions
1819 handling (William and Olivier Andrieu), htmlNewDoc() charset bug,
1820 htmlReadMemory init (William), a posteriori validation DTD base
1821 (William), notations serialization missing, xmlGetNodePath (Dodji),
1822 xmlCheckUTF8 (Diego Tartara), missing line numbers on entity
1823 (William)</li>
1824 <li>improvements: DocBook catalog build scrip (William), xmlcatalog tool
1825 (Albert Chin), xmllint --c14n option, no_proxy environment (Mike Hommey),
1826 xmlParseInNodeContext() addition, extend xmllint --shell, allow XInclude
1827 to not generate start/end nodes, extend xmllint --version to include CVS
1828 tag (William)</li>
1829 <li>documentation: web pages fixes, validity API docs fixes (William)
1830 schemas API fix (Eric Haszlakiewicz), xmllint man page (John Fleck)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +00001831</ul>
1832
Daniel Veillard45cb0f42004-07-05 17:45:35 +00001833<h3>2.6.11: July 5 2004</h3>
1834<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001835 <li>Schemas: a lot of changes and improvements by Kasimier Buchcik for
1836 attributes, namespaces and simple types.</li>
1837 <li>build fixes: --with-minimum (William Brack), some gcc cleanup
1838 (William), --with-thread-alloc (William)</li>
1839 <li>portability: Windows binary package change (Igor Zlatkovic), Catalog
1840 path on Windows</li>
1841 <li>documentation: update to the tutorial (John Fleck), xmllint return code
1842 (John Fleck), man pages (Ville Skytta),</li>
1843 <li>bug fixes: C14N bug serializing namespaces (Aleksey Sanin), testSAX
1844 properly initialize the library (William), empty node set in XPath
1845 (William), xmlSchemas errors (William), invalid charref problem pointed
1846 by Morus Walter, XInclude xml:base generation (William), Relax-NG bug
1847 with div processing (William), XPointer and xml:base problem(William),
1848 Reader and entities, xmllint return code for schemas (William), reader
1849 streaming problem (Steve Ball), DTD serialization problem (William),
1850 libxml.m4 fixes (Mike Hommey), do not provide destructors as methods on
1851 Python classes, xmlReader buffer bug, Python bindings memory interfaces
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001852 improvement (with Stéphane Bidoul), Fixed the push parser to be back to
Daniel Veillardf781dba2006-06-09 13:34:49 +00001853 synchronous behaviour.</li>
1854 <li>improvement: custom per-thread I/O enhancement (Rob Richards), register
1855 namespace in debug shell (Stefano Debenedetti), Python based regression
1856 test for non-Unix users (William), dynamically increase the number of
1857 XPath extension functions in Python and fix a memory leak (Marc-Antoine
1858 Parent and William)</li>
1859 <li>performance: hack done with Arjan van de Ven to reduce ELF footprint
1860 and generated code on Linux, plus use gcc runtime profiling to optimize
1861 the code generated in the RPM packages.</li>
Daniel Veillard45cb0f42004-07-05 17:45:35 +00001862</ul>
1863
Daniel Veillard81205012004-05-18 03:06:41 +00001864<h3>2.6.10: May 17 2004</h3>
1865<ul>
1866 <li>Web page generated for ChangeLog</li>
1867 <li>build fixes: --without-html problems, make check without make all</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001868 <li>portability: problem with xpath.c on Windows (MSC and Borland), memcmp
1869 vs. strncmp on Solaris, XPath tests on Windows (Mark Vakoc), C++ do not
1870 use "list" as parameter name, make tests work with Python 1.5 (Ed
1871 Davis),</li>
1872 <li>improvements: made xmlTextReaderMode public, small buffers resizing
1873 (Morten Welinder), add --maxmem option to xmllint, add
1874 xmlPopInputCallback() for Matt Sergeant, refactoring of serialization
1875 escaping, added escaping customization</li>
1876 <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp bugs (William
1877 Brack), xmlReader end of stream problem, node deregistration with reader,
1878 URI escaping and filemanes, XHTML1 formatting (Nick Wellnhofer), regexp
1879 transition reduction (William), various XSD Schemas fixes (Kasimier
1880 Buchcik), XInclude fallback problem (William), weird problems with DTD
1881 (William), structured error handler callback context (William), reverse
1882 xmlEncodeSpecialChars() behaviour back to escaping '"'</li>
Daniel Veillard81205012004-05-18 03:06:41 +00001883</ul>
1884
Daniel Veillardeca726d2004-04-18 21:47:34 +00001885<h3>2.6.9: Apr 18 2004</h3>
1886<ul>
1887 <li>implement xml:id Working Draft, relaxed XPath id() checking</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001888 <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and CDATA (Dave
1889 Beckett), Relax-NG compilation (William Brack), Regexp patches (with
1890 William), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed problem (with
1891 William), Relax-NG name classes compares (William), XInclude duplicate
1892 fallback (William), external DTD encoding detection (William), a DTD
1893 validation bug (William), xmlReader Close() fix, recusive extention
1894 schemas</li>
1895 <li>improvements: use xmlRead* APIs in test tools (Mark Vakoc), indenting
1896 save optimization, better handle IIS broken HTTP redirect behaviour (Ian
1897 Hummel), HTML parser frameset (James Bursa), libxml2-python RPM
1898 dependancy, XML Schemas union support (Kasimier Buchcik), warning removal
1899 clanup (William), keep ChangeLog compressed when installing from RPMs</li>
1900 <li>documentation: examples and xmlDocDumpMemory docs (John Fleck), new
1901 example (load, xpath, modify, save), xmlCatalogDump() comments,</li>
1902 <li>Windows: Borland C++ builder (Eric Zurcher), work around Microsoft
1903 compiler NaN handling bug (Mark Vakoc)</li>
Daniel Veillardeca726d2004-04-18 21:47:34 +00001904</ul>
1905
Daniel Veillard252004d2004-03-23 12:32:32 +00001906<h3>2.6.8: Mar 23 2004</h3>
1907<ul>
1908 <li>First step of the cleanup of the serialization code and APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001909 <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling fixes (Adam
1910 Dickmeiss), anyURI for "" (John Belmonte)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00001911 <li>Python: Canonicalization C14N support added (Anthony Carrico)</li>
1912 <li>xmlDocCopyNode() extension (William)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001913 <li>Relax-NG: fix when processing XInclude results (William), external
1914 reference in interleave (William), missing error on &lt;choice&gt;
1915 failure (William), memory leak in schemas datatype facets.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00001916 <li>xmlWriter: patch for better DTD support (Alfred Mickautsch)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001917 <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey and William
1918 Brack), no ID errors if using HTML_PARSE_NOERROR, xmlcatalog fallbacks to
1919 URI on SYSTEM lookup failure, XInclude parse flags inheritance (William),
1920 XInclude and XPointer fixes for entities (William), XML parser bug
1921 reported by Holger Rauch, nanohttp fd leak (William), regexps char
1922 groups '-' handling (William), dictionnary reference counting problems,
1923 do not close stderr.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00001924 <li>performance patches from Petr Pajas</li>
1925 <li>Documentation fixes: XML_CATALOG_FILES in man pages (Mike Hommey)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001926 <li>compilation and portability fixes: --without-valid, catalog cleanups
1927 (Peter Breitenlohner), MingW patch (Roland Schwingel), cross-compilation
1928 to Windows (Christophe de Vienne), --with-html-dir fixup (Julio Merino
1929 Vidal), Windows build (Eric Zurcher)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00001930</ul>
1931
Daniel Veillard92914492004-02-23 16:33:21 +00001932<h3>2.6.7: Feb 23 2004</h3>
1933<ul>
1934 <li>documentation: tutorial updates (John Fleck), benchmark results</li>
1935 <li>xmlWriter: updates and fixes (Alfred Mickautsch, Lucas Brasilino)</li>
1936 <li>XPath optimization (Petr Pajas)</li>
1937 <li>DTD ID handling optimization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001938 <li>bugfixes: xpath number with &gt; 19 fractional (William Brack), push
1939 mode with unescaped '&gt;' characters, fix xmllint --stream --timing, fix
1940 xmllint --memory --stream memory usage, xmlAttrSerializeTxtContent
1941 handling NULL, trying to fix Relax-NG/Perl interface.</li>
Daniel Veillard92914492004-02-23 16:33:21 +00001942 <li>python: 2.3 compatibility, whitespace fixes (Malcolm Tredinnick)</li>
1943 <li>Added relaxng option to xmllint --shell</li>
1944</ul>
1945
Daniel Veillard5c9547e2004-02-12 15:31:49 +00001946<h3>2.6.6: Feb 12 2004</h3>
1947<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001948 <li>nanohttp and nanoftp: buffer overflow error on URI parsing (Igor and
1949 William) reported by Yuuichi Teranishi</li>
1950 <li>bugfixes: make test and path issues, xmlWriter attribute serialization
1951 (William Brack), xmlWriter indentation (William), schemas validation
1952 (Eric Haszlakiewicz), XInclude dictionnaries issues (William and Oleg
1953 Paraschenko), XInclude empty fallback (William), HTML warnings (William),
1954 XPointer in XInclude (William), Python namespace serialization,
1955 isolat1ToUTF8 bound error (Alfred Mickautsch), output of parameter
1956 entities in internal subset (William), internal subset bug in push mode,
1957 &lt;xs:all&gt; fix (Alexey Sarytchev)</li>
1958 <li>Build: fix for automake-1.8 (Alexander Winston), warnings removal
1959 (Philip Ludlam), SOCKLEN_T detection fixes (Daniel Richard), fix
1960 --with-minimum configuration.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +00001961 <li>XInclude: allow the 2001 namespace without warning.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001962 <li>Documentation: missing example/index.html (John Fleck), version
1963 dependancies (John Fleck)</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +00001964 <li>reader API: structured error reporting (Steve Ball)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001965 <li>Windows compilation: mingw, msys (Mikhail Grushinskiy), function
1966 prototype (Cameron Johnson), MSVC6 compiler warnings, _WINSOCKAPI_
1967 patch</li>
1968 <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte offest in
1969 input.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +00001970</ul>
1971
Daniel Veillard189f46b2004-01-25 21:03:04 +00001972<h3>2.6.5: Jan 25 2004</h3>
1973<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001974 <li>Bugfixes: dictionnaries for schemas (William Brack), regexp segfault
1975 (William), xs:all problem (William), a number of XPointer bugfixes
1976 (William), xmllint error go to stderr, DTD validation problem with
1977 namespace, memory leak (William), SAX1 cleanup and minimal options fixes
1978 (Mark Vadoc), parser context reset on error (Shaun McCance), XPath union
1979 evaluation problem (William) , xmlReallocLoc with NULL (Aleksey Sanin),
1980 XML Schemas double free (Steve Ball), XInclude with no href, argument
1981 callbacks order for XPath callbacks (Frederic Peters)</li>
1982 <li>Documentation: python scripts (William Brack), xslt stylesheets (John
1983 Fleck), doc (Sven Zimmerman), I/O example.</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001984 <li>Python bindings: fixes (William), enum support (Stéphane Bidoul),
1985 structured error reporting (Stéphane Bidoul)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001986 <li>XInclude: various fixes for conformance, problem related to dictionnary
1987 references (William &amp; me), recursion (William)</li>
1988 <li>xmlWriter: indentation (Lucas Brasilino), memory leaks (Alfred
1989 Mickautsch),</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +00001990 <li>xmlSchemas: normalizedString datatype (John Belmonte)</li>
1991 <li>code cleanup for strings functions (William)</li>
1992 <li>Windows: compiler patches (Mark Vakoc)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00001993 <li>Parser optimizations, a few new XPath and dictionnary APIs for future
1994 XSLT optimizations.</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +00001995</ul>
1996
Daniel Veillarde6e59cd2003-12-24 11:56:44 +00001997<h3>2.6.4: Dec 24 2003</h3>
1998<ul>
1999 <li>Windows build fixes (Igor Zlatkovic)</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +00002000 <li>Some serious XInclude problems reported by Oleg Paraschenko and</li>
2001 <li>Unix and Makefile packaging fixes (me, William Brack,</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002002 <li>Documentation improvements (John Fleck, William Brack), example fix
2003 (Lucas Brasilino)</li>
2004 <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath handling of
2005 NULL strings (William Brack) , API building reader or parser from
2006 filedescriptor should not close it, changed XPath sorting to be stable
2007 again (William Brack), xmlGetNodePath() generating '(null)' (William
2008 Brack), DTD validation and namespace bug (William Brack), XML Schemas
2009 double inclusion behaviour</li>
Daniel Veillarde6e59cd2003-12-24 11:56:44 +00002010</ul>
2011
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002012<h3>2.6.3: Dec 10 2003</h3>
2013<ul>
2014 <li>documentation updates and cleanup (DV, William Brack, John Fleck)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002015 <li>added a repository of examples, examples from Aleksey Sanin, Dodji
2016 Seketeli, Alfred Mickautsch</li>
2017 <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher, Mingw
2018 (Kenneth Haley)</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002019 <li>Unicode range checking (William Brack)</li>
2020 <li>code cleanup (William Brack)</li>
2021 <li>Python bindings: doc (John Fleck), bug fixes</li>
2022 <li>UTF-16 cleanup and BOM issues (William Brack)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002023 <li>bug fixes: ID and xmlReader validation, XPath (William Brack),
2024 xmlWriter (Alfred Mickautsch), hash.h inclusion problem, HTML parser
2025 (James Bursa), attribute defaulting and validation, some serialization
2026 cleanups, XML_GET_LINE macro, memory debug when using threads (William
2027 Brack), serialization of attributes and entities content, xmlWriter
2028 (Daniel Schulman)</li>
2029 <li>XInclude bugfix, new APIs and update to the last version including the
2030 namespace change.</li>
2031 <li>XML Schemas improvements: include (Robert Stepanek), import and
2032 namespace handling, fixed the regression tests troubles, added examples
2033 based on Eric van der Vlist book, regexp fixes</li>
2034 <li>preliminary pattern support for streaming (needed for schemas
2035 constraints), added xmlTextReaderPreservePattern() to collect subdocument
2036 when streaming.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002037 <li>various fixes in the structured error handling</li>
2038</ul>
2039
Daniel Veillard6d373a22003-11-04 10:26:43 +00002040<h3>2.6.2: Nov 4 2003</h3>
2041<ul>
2042 <li>XPath context unregistration fixes</li>
2043 <li>text node coalescing fixes (Mark Lilback)</li>
2044 <li>API to screate a W3C Schemas from an existing document (Steve Ball)</li>
2045 <li>BeOS patches (Marcin 'Shard' Konicki)</li>
2046 <li>xmlStrVPrintf function added (Aleksey Sanin)</li>
2047 <li>compilation fixes (Mark Vakoc)</li>
2048 <li>stdin parsing fix (William Brack)</li>
2049 <li>a posteriori DTD validation fixes</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002050 <li>xmlReader bug fixes: Walker fixes, python bindings</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +00002051 <li>fixed xmlStopParser() to really stop the parser and errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002052 <li>always generate line numbers when using the new xmlReadxxx
2053 functions</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +00002054 <li>added XInclude support to the xmlReader interface</li>
2055 <li>implemented XML_PARSE_NONET parser option</li>
2056 <li>DocBook XSLT processing bug fixed</li>
2057 <li>HTML serialization for &lt;p&gt; elements (William Brack and me)</li>
2058 <li>XPointer failure in XInclude are now handled as resource errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002059 <li>fixed xmllint --html to use the HTML serializer on output (added
2060 --xmlout to implement the previous behaviour of saving it using the XML
2061 serializer)</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +00002062</ul>
2063
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002064<h3>2.6.1: Oct 28 2003</h3>
2065<ul>
2066 <li>Mostly bugfixes after the big 2.6.0 changes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002067 <li>Unix compilation patches: libxml.m4 (Patrick Welche), warnings cleanup
2068 (William Brack)</li>
2069 <li>Windows compilation patches (Joachim Bauch, Stephane Bidoul, Igor
2070 Zlatkovic)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002071 <li>xmlWriter bugfix (Alfred Mickautsch)</li>
2072 <li>chvalid.[ch]: couple of fixes from Stephane Bidoul</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002073 <li>context reset: error state reset, push parser reset (Graham
2074 Bennett)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002075 <li>context reuse: generate errors if file is not readable</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002076 <li>defaulted attributes for element coming from internal entities
2077 (Stephane Bidoul)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002078 <li>Python: tab and spaces mix (William Brack)</li>
2079 <li>Error handler could crash in DTD validation in 2.6.0</li>
2080 <li>xmlReader: do not use the document or element _private field</li>
2081 <li>testSAX.c: avoid a problem with some PIs (Massimo Morara)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002082 <li>general bug fixes: mandatory encoding in text decl, serializing
2083 Document Fragment nodes, xmlSearchNs 2.6.0 problem (Kasimier Buchcik),
2084 XPath errors not reported, slow HTML parsing of large documents.</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002085</ul>
2086
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002087<h3>2.6.0: Oct 20 2003</h3>
2088<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002089 <li>Major revision release: should be API and ABI compatible but got a lot
2090 of change</li>
2091 <li>Increased the library modularity, far more options can be stripped out,
2092 a --with-minimum configuration will weight around 160KBytes</li>
2093 <li>Use per parser and per document dictionnary, allocate names and small
2094 text nodes from the dictionnary</li>
2095 <li>Switch to a SAX2 like parser rewrote most of the XML parser core,
2096 provides namespace resolution and defaulted attributes, minimize memory
2097 allocations and copies, namespace checking and specific error handling,
2098 immutable buffers, make predefined entities static structures, etc...</li>
2099 <li>rewrote all the error handling in the library, all errors can be
2100 intercepted at a structured level, with precise information
2101 available.</li>
2102 <li>New simpler and more generic XML and HTML parser APIs, allowing to
2103 easilly modify the parsing options and reuse parser context for multiple
2104 consecutive documents.</li>
2105 <li>Similar new APIs for the xmlReader, for options and reuse, provided new
2106 functions to access content as const strings, use them for Python
2107 bindings</li>
2108 <li>a lot of other smaller API improvements: xmlStrPrintf (Aleksey Sanin),
2109 Walker i.e. reader on a document tree based on Alfred Mickautsch code,
2110 make room in nodes for line numbers, reference counting and future PSVI
2111 extensions, generation of character ranges to be checked with faster
2112 algorithm (William), xmlParserMaxDepth (Crutcher Dunnavant), buffer
2113 access</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002114 <li>New xmlWriter API provided by Alfred Mickautsch</li>
2115 <li>Schemas: base64 support by Anthony Carrico</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002116 <li>Parser&lt;-&gt;HTTP integration fix, proper processing of the Mime-Type
William M. Brack43a87292007-02-15 20:41:02 +00002117 and charset information if available.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002118 <li>Relax-NG: bug fixes including the one reported by Martijn Faassen and
2119 zeroOrMore, better error reporting.</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002120 <li>Python bindings (Stéphane Bidoul), never use stdout for errors
Daniel Veillardf781dba2006-06-09 13:34:49 +00002121 output</li>
2122 <li>Portability: all the headers have macros for export and calling
2123 convention definitions (Igor Zlatkovic), VMS update (Craig A. Berry),
2124 Windows: threads (Jesse Pelton), Borland compiler (Eric Zurcher, Igor),
2125 Mingw (Igor), typos (Mark Vakoc), beta version (Stephane Bidoul),
2126 warning cleanups on AIX and MIPS compilers (William Brack), BeOS (Marcin
2127 'Shard' Konicki)</li>
2128 <li>Documentation fixes and README (William Brack), search fix (William),
2129 tutorial updates (John Fleck), namespace docs (Stefan Kost)</li>
2130 <li>Bug fixes: xmlCleanupParser (Dave Beckett), threading uninitialized
2131 mutexes, HTML doctype lowercase, SAX/IO (William), compression detection
2132 and restore (William), attribute declaration in DTDs (William), namespace
2133 on attribute in HTML output (William), input filename (Rob Richards),
2134 namespace DTD validation, xmlReplaceNode (Chris Ryland), I/O callbacks
2135 (Markus Keim), CDATA serialization (Shaun McCance), xmlReader (Peter
2136 Derr), high codepoint charref like &amp;#x10FFFF;, buffer access in push
2137 mode (Justin Fletcher), TLS threads on Windows (Jesse Pelton), XPath bug
2138 (William), xmlCleanupParser (Marc Liyanage), CDATA output (William), HTTP
2139 error handling.</li>
2140 <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 for compat
2141 testing, --nodict for building without tree dictionnary, --nocdata to
2142 replace CDATA by text, --nsclean to remove surperfluous namespace
2143 declarations</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002144 <li>added xml2-config --libtool-libs option from Kevin P. Fleming</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002145 <li>a lot of profiling and tuning of the code, speedup patch for
2146 xmlSearchNs() by Luca Padovani. The xmlReader should do far less
2147 allocation and it speed should get closer to SAX. Chris Anderson worked
2148 on speeding and cleaning up repetitive checking code.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002149 <li>cleanup of "make tests"</li>
2150 <li>libxml-2.0-uninstalled.pc from Malcolm Tredinnick</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002151 <li>deactivated the broken docBook SGML parser code and plugged the XML
2152 parser instead.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002153</ul>
2154
Daniel Veillardeec1ae92003-09-09 13:11:01 +00002155<h3>2.5.11: Sep 9 2003</h3>
2156
2157<p>A bugfix only release:</p>
2158<ul>
2159 <li>risk of crash in Relax-NG</li>
2160 <li>risk of crash when using multithreaded programs</li>
2161</ul>
2162
Daniel Veillardcfba2fe2003-08-15 00:33:43 +00002163<h3>2.5.10: Aug 15 2003</h3>
2164
2165<p>A bugfixes only release</p>
2166<ul>
2167 <li>Windows Makefiles (William Brack)</li>
2168 <li>UTF-16 support fixes (Mark Itzcovitz)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002169 <li>Makefile and portability (William Brack) automake, Linux alpha, Mingw
2170 on Windows (Mikhail Grushinskiy)</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +00002171 <li>HTML parser (Oliver Stoeneberg)</li>
2172 <li>XInclude performance problem reported by Kevin Ruscoe</li>
2173 <li>XML parser performance problem reported by Grant Goodale</li>
2174 <li>xmlSAXParseDTD() bug fix from Malcolm Tredinnick</li>
Daniel Veillardeec1ae92003-09-09 13:11:01 +00002175 <li>and a couple other cleanup</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +00002176</ul>
2177
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002178<h3>2.5.9: Aug 9 2003</h3>
2179<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002180 <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), Windows build
2181 (Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter Sobisch), threading
2182 (Rob Richards), hexBinary type (), UTF-16 BOM (Dodji Seketeli),
2183 xmlReader, Relax-NG schemas compilation, namespace handling, EXSLT (Sean
2184 Griffin), HTML parsing problem (William Brack), DTD validation for mixed
2185 content + namespaces, HTML serialization, library initialization,
2186 progressive HTML parser</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002187 <li>better interfaces for Relax-NG error handling (Joachim Bauch, )</li>
2188 <li>adding xmlXIncludeProcessTree() for XInclud'ing in a subtree</li>
2189 <li>doc fixes and improvements (John Fleck)</li>
2190 <li>configure flag for -with-fexceptions when embedding in C++</li>
2191 <li>couple of new UTF-8 helper functions (William Brack)</li>
2192 <li>general encoding cleanup + ISO-8859-x without iconv (Peter Jacobi)</li>
2193 <li>xmlTextReader cleanup + enum for node types (Bjorn Reese)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002194 <li>general compilation/warning cleanup Solaris/HP-UX/... (William
2195 Brack)</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002196</ul>
2197
Daniel Veillard560c2a42003-07-06 21:13:49 +00002198<h3>2.5.8: Jul 6 2003</h3>
2199<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002200 <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 save (Mark
2201 Itzcovitz), UTF-8 checking, URI saving, error printing (William Brack),
2202 PI related memleak, compilation without schemas or without xpath (Joerg
2203 Schmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem with DTDs,
2204 rpm problem on , i86_64, removed a few compilation problems from 2.5.7,
2205 xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +00002206 <li>portability: DJGPP (MsDos) , OpenVMS (Craig A. Berry)</li>
2207 <li>William Brack fixed multithreading lock problems</li>
2208 <li>IPv6 patch for FTP and HTTP accesses (Archana Shah/Wipro)</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002209 <li>Windows fixes (Igor Zlatkovic, Eric Zurcher), threading (Stéphane
Daniel Veillardf781dba2006-06-09 13:34:49 +00002210 Bidoul)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +00002211 <li>A few W3C Schemas Structure improvements</li>
2212 <li>W3C Schemas Datatype improvements (Charlie Bozeman)</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002213 <li>Python bindings for thread globals (Stéphane Bidoul), and method/class
Daniel Veillardf781dba2006-06-09 13:34:49 +00002214 generator</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002215 <li>added --nonet option to xmllint</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +00002216 <li>documentation improvements (John Fleck)</li>
2217</ul>
2218
Daniel Veillard92fc02c2003-04-24 23:12:35 +00002219<h3>2.5.7: Apr 25 2003</h3>
2220<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002221 <li>Relax-NG: Compiling to regexp and streaming validation on top of the
2222 xmlReader interface, added to xmllint --stream</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +00002223 <li>xmlReader: Expand(), Next() and DOM access glue, bug fixes</li>
2224 <li>Support for large files: RGN validated a 4.5GB instance</li>
2225 <li>Thread support is now configured in by default</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002226 <li>Fixes: update of the Trio code (Bjorn), WXS Date and Duration fixes
2227 (Charles Bozeman), DTD and namespaces (Brent Hendricks), HTML push parser
2228 and zero bytes handling, some missing Windows file path conversions,
2229 behaviour of the parser and validator in the presence of "out of memory"
2230 error conditions</li>
2231 <li>extended the API to be able to plug a garbage collecting memory
2232 allocator, added xmlMallocAtomic() and modified the allocations
2233 accordingly.</li>
2234 <li>Performances: removed excessive malloc() calls, speedup of the push and
2235 xmlReader interfaces, removed excessive thread locking</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +00002236 <li>Documentation: man page (John Fleck), xmlReader documentation</li>
2237 <li>Python: adding binding for xmlCatalogAddLocal (Brent M Hendricks)</li>
2238</ul>
2239
Daniel Veillardc2d4a932003-04-01 11:13:05 +00002240<h3>2.5.6: Apr 1 2003</h3>
2241<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002242 <li>Fixed W3C XML Schemas datatype, should be compliant now except for
2243 binHex and base64 which are not supported yet.</li>
2244 <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large docs and
2245 XInclude entities handling, encoding detection on external subsets, XML
2246 Schemas bugs and memory leaks, HTML parser (James Bursa)</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +00002247 <li>portability: python/trio (Albert Chin), Sun compiler warnings</li>
2248 <li>documentation: added --relaxng option to xmllint man page (John)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002249 <li>improved error reporting: xml:space, start/end tag mismatches, Relax NG
2250 errors</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +00002251</ul>
2252
2253<h3>2.5.5: Mar 24 2003</h3>
Daniel Veillardd8da01c2003-03-24 15:58:23 +00002254<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002255 <li>Lot of fixes on the Relax NG implementation. More testing including
2256 DocBook and TEI examples.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +00002257 <li>Increased the support for W3C XML Schemas datatype</li>
2258 <li>Several bug fixes in the URI handling layer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002259 <li>Bug fixes: HTML parser, xmlReader, DTD validation, XPath, encoding
2260 conversion, line counting in the parser.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +00002261 <li>Added support for $XMLLINT_INDENT environment variable, FTP delete</li>
2262 <li>Fixed the RPM spec file name</li>
2263</ul>
2264
Daniel Veillard17bed982003-02-24 20:11:43 +00002265<h3>2.5.4: Feb 20 2003</h3>
2266<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002267 <li>Conformance testing and lot of fixes on Relax NG and XInclude
2268 implementation</li>
Daniel Veillard17bed982003-02-24 20:11:43 +00002269 <li>Implementation of XPointer element() scheme</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002270 <li>Bug fixes: XML parser, XInclude entities merge, validity checking on
2271 namespaces,
2272 <p>2 serialization bugs, node info generation problems, a DTD regexp
2273 generation problem.</p>
Daniel Veillard17bed982003-02-24 20:11:43 +00002274 </li>
2275 <li>Portability: windows updates and path canonicalization (Igor)</li>
2276 <li>A few typo fixes (Kjartan Maraas)</li>
2277 <li>Python bindings generator fixes (Stephane Bidoul)</li>
2278</ul>
2279
Daniel Veillard1d788d22003-02-10 16:21:58 +00002280<h3>2.5.3: Feb 10 2003</h3>
2281<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002282 <li>RelaxNG and XML Schemas datatypes improvements, and added a first
2283 version of RelaxNG Python bindings</li>
2284 <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API fix for
2285 serializing namespace nodes, encoding conversion bug, XHTML1
2286 serialization</li>
Daniel Veillard1d788d22003-02-10 16:21:58 +00002287 <li>Portability fixes: Windows (Igor), AMD 64bits RPM spec file</li>
2288</ul>
2289
Daniel Veillard72fef162003-02-05 14:31:19 +00002290<h3>2.5.2: Feb 5 2003</h3>
2291<ul>
2292 <li>First implementation of RelaxNG, added --relaxng flag to xmllint</li>
2293 <li>Schemas support now compiled in by default.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002294 <li>Bug fixes: DTD validation, namespace checking, XInclude and entities,
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002295 delegateURI in XML Catalogs, HTML parser, XML reader (Stéphane Bidoul),
Daniel Veillardf781dba2006-06-09 13:34:49 +00002296 XPath parser and evaluation, UTF8ToUTF8 serialization, XML reader memory
2297 consumption, HTML parser, HTML serialization in the presence of
2298 namespaces</li>
Daniel Veillard72fef162003-02-05 14:31:19 +00002299 <li>added an HTML API to check elements and attributes.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002300 <li>Documentation improvement, PDF for the tutorial (John Fleck), doc
2301 patches (Stefan Kost)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +00002302 <li>Portability fixes: NetBSD (Julio Merino), Windows (Igor Zlatkovic)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002303 <li>Added python bindings for XPointer, contextual error reporting
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002304 (Stéphane Bidoul)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +00002305 <li>URI/file escaping problems (Stefano Zacchiroli)</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00002306</ul>
2307
Daniel Veillarde2830f12003-01-08 17:47:49 +00002308<h3>2.5.1: Jan 8 2003</h3>
2309<ul>
2310 <li>Fixes a memory leak and configuration/compilation problems in 2.5.0</li>
2311 <li>documentation updates (John)</li>
2312 <li>a couple of XmlTextReader fixes</li>
2313</ul>
2314
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00002315<h3>2.5.0: Jan 6 2003</h3>
2316<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002317 <li>New <a href="xmlreader.html">XmltextReader interface</a> based on C#
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002318 API (with help of Stéphane Bidoul)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00002319 <li>Windows: more exports, including the new API (Igor)</li>
2320 <li>XInclude fallback fix</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002321 <li>Python: bindings for the new API, packaging (Stéphane Bidoul),
2322 drv_libxml2.py Python xml.sax driver (Stéphane Bidoul), fixes, speedup
Daniel Veillardf781dba2006-06-09 13:34:49 +00002323 and iterators for Python-2.2 (Hannu Krosing)</li>
2324 <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint man update
2325 (John)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00002326 <li>Fix an XML parser bug raised by Vyacheslav Pindyura</li>
2327 <li>Fix for VMS serialization (Nigel Hall) and config (Craig A. Berry)</li>
2328 <li>Entities handling fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002329 <li>new API to optionally track node creation and deletion (Lukas
2330 Schroeder)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00002331 <li>Added documentation for the XmltextReader interface and some <a
2332 href="guidelines.html">XML guidelines</a></li>
2333</ul>
2334
Daniel Veillardc1eed322002-12-12 11:01:32 +00002335<h3>2.4.30: Dec 12 2002</h3>
2336<ul>
2337 <li>2.4.29 broke the python bindings, rereleasing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002338 <li>Improvement/fixes of the XML API generator, and couple of minor code
2339 fixes.</li>
Daniel Veillardc1eed322002-12-12 11:01:32 +00002340</ul>
2341
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00002342<h3>2.4.29: Dec 11 2002</h3>
2343<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002344 <li>Windows fixes (Igor): Windows CE port, pthread linking, python bindings
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002345 (Stéphane Bidoul), Mingw (Magnus Henoch), and export list updates</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00002346 <li>Fix for prev in python bindings (ERDI Gergo)</li>
2347 <li>Fix for entities handling (Marcus Clarke)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002348 <li>Refactored the XML and HTML dumps to a single code path, fixed XHTML1
2349 dump</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00002350 <li>Fix for URI parsing when handling URNs with fragment identifiers</li>
2351 <li>Fix for HTTP URL escaping problem</li>
2352 <li>added an TextXmlReader (C#) like API (work in progress)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002353 <li>Rewrote the API in XML generation script, includes a C parser and saves
William M. Brack43a87292007-02-15 20:41:02 +00002354 more information needed for C# bindings</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00002355</ul>
2356
Daniel Veillardf9c4cad2002-11-22 15:57:07 +00002357<h3>2.4.28: Nov 22 2002</h3>
2358<ul>
2359 <li>a couple of python binding fixes</li>
2360 <li>2 bug fixes in the XML push parser</li>
2361 <li>potential memory leak removed (Martin Stoilov)</li>
2362 <li>fix to the configure script for Unix (Dimitri Papadopoulos)</li>
2363 <li>added encoding support for XInclude parse="text"</li>
2364 <li>autodetection of XHTML1 and specific serialization rules added</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00002365 <li>nasty threading bug fixed (William Brack)</li>
Daniel Veillardf9c4cad2002-11-22 15:57:07 +00002366</ul>
2367
Daniel Veillarddad3f682002-11-17 16:47:27 +00002368<h3>2.4.27: Nov 17 2002</h3>
2369<ul>
2370 <li>fixes for the Python bindings</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002371 <li>a number of bug fixes: SGML catalogs, xmlParseBalancedChunkMemory(),
2372 HTML parser, Schemas (Charles Bozeman), document fragment support
2373 (Christian Glahn), xmlReconciliateNs (Brian Stafford), XPointer,
2374 xmlFreeNode(), xmlSAXParseMemory (Peter Jones), xmlGetNodePath (Petr
2375 Pajas), entities processing</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +00002376 <li>added grep to xmllint --shell</li>
2377 <li>VMS update patch from Craig A. Berry</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002378 <li>cleanup of the Windows build with support for more compilers (Igor),
2379 better thread support on Windows</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +00002380 <li>cleanup of Unix Makefiles and spec file</li>
2381 <li>Improvements to the documentation (John Fleck)</li>
2382</ul>
2383
Daniel Veillard48267432002-10-18 11:21:38 +00002384<h3>2.4.26: Oct 18 2002</h3>
2385<ul>
2386 <li>Patches for Windows CE port, improvements on Windows paths handling</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002387 <li>Fixes to the validation code (DTD and Schemas), xmlNodeGetPath() ,
2388 HTML serialization, Namespace compliance, and a number of small
2389 problems</li>
Daniel Veillard48267432002-10-18 11:21:38 +00002390</ul>
2391
Daniel Veillarde16b5742002-09-26 17:50:03 +00002392<h3>2.4.25: Sep 26 2002</h3>
2393<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002394 <li>A number of bug fixes: XPath, validation, Python bindings, DOM and
2395 tree, xmlI/O, Html</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00002396 <li>Serious rewrite of XInclude</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002397 <li>Made XML Schemas regexp part of the default build and APIs, small fix
2398 and improvement of the regexp core</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00002399 <li>Changed the validation code to reuse XML Schemas regexp APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002400 <li>Better handling of Windows file paths, improvement of Makefiles (Igor,
2401 Daniel Gehriger, Mark Vakoc)</li>
2402 <li>Improved the python I/O bindings, the tests, added resolver and regexp
2403 APIs</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00002404 <li>New logos from Marc Liyanage</li>
2405 <li>Tutorial improvements: John Fleck, Christopher Harris</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002406 <li>Makefile: Fixes for AMD x86_64 (Mandrake), DESTDIR (Christophe
2407 Merlet)</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00002408 <li>removal of all stderr/perror use for error reporting</li>
2409 <li>Better error reporting: XPath and DTD validation</li>
2410 <li>update of the trio portability layer (Bjorn Reese)</li>
2411</ul>
2412
Daniel Veillard42766c02002-08-22 20:52:17 +00002413<p><strong>2.4.24: Aug 22 2002</strong></p>
2414<ul>
2415 <li>XPath fixes (William), xf:escape-uri() (Wesley Terpstra)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002416 <li>Python binding fixes: makefiles (William), generator, rpm build, x86-64
2417 (fcrozat)</li>
Daniel Veillard42766c02002-08-22 20:52:17 +00002418 <li>HTML &lt;style&gt; and boolean attributes serializer fixes</li>
2419 <li>C14N improvements by Aleksey</li>
Daniel Veillarde1662542002-08-28 11:50:59 +00002420 <li>doc cleanups: Rick Jones</li>
Daniel Veillard42766c02002-08-22 20:52:17 +00002421 <li>Windows compiler makefile updates: Igor and Elizabeth Barham</li>
2422 <li>XInclude: implementation of fallback and xml:base fixup added</li>
2423</ul>
2424
Daniel Veillard782afda2002-07-08 15:12:49 +00002425<h3>2.4.23: July 6 2002</h3>
2426<ul>
2427 <li>performances patches: Peter Jacobi</li>
2428 <li>c14n fixes, testsuite and performances: Aleksey Sanin</li>
2429 <li>added xmlDocFormatDump: Chema Celorio</li>
2430 <li>new tutorial: John Fleck</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002431 <li>new hash functions and performances: Sander Vesik, portability fix from
2432 Peter Jacobi</li>
2433 <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XML and
2434 HTML parsers, ID lookup function</li>
Daniel Veillard782afda2002-07-08 15:12:49 +00002435 <li>removal of all remaining sprintf: Aleksey Sanin</li>
2436</ul>
2437
Daniel Veillardc0801af2002-05-28 16:28:42 +00002438<h3>2.4.22: May 27 2002</h3>
2439<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002440 <li>a number of bug fixes: configure scripts, base handling, parser, memory
2441 usage, HTML parser, XPath, documentation (Christian Cornelssen),
2442 indentation, URI parsing</li>
2443 <li>Optimizations for XMLSec, fixing and making public some of the network
2444 protocol handlers (Aleksey)</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +00002445 <li>performance patch from Gary Pennington</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002446 <li>Charles Bozeman provided date and time support for XML Schemas
2447 datatypes</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +00002448</ul>
2449
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00002450<h3>2.4.21: Apr 29 2002</h3>
2451
Daniel Veillardf781dba2006-06-09 13:34:49 +00002452<p>This release is both a bug fix release and also contains the early XML
2453Schemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a> and <a
2454href="http://www.w3.org/TR/xmlschema-2/">datatypes</a> code, beware, all
2455interfaces are likely to change, there is huge holes, it is clearly a work in
2456progress and don't even think of putting this code in a production system,
2457it's actually not compiled in by default. The real fixes are:</p>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00002458<ul>
2459 <li>a couple of bugs or limitations introduced in 2.4.20</li>
2460 <li>patches for Borland C++ and MSC by Igor</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002461 <li>some fixes on XPath strings and conformance patches by Richard
2462 Jinks</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00002463 <li>patch from Aleksey for the ExcC14N specification</li>
2464 <li>OSF/1 bug fix by Bjorn</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +00002465</ul>
2466
Daniel Veillarda7084cd2002-04-15 17:12:47 +00002467<h3>2.4.20: Apr 15 2002</h3>
2468<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +00002469 <li>bug fixes: file descriptor leak, XPath, HTML output, DTD validation</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +00002470 <li>XPath conformance testing by Richard Jinks</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002471 <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, python bindings,
2472 libxml.m4</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +00002473</ul>
2474
Daniel Veillard19274092002-03-25 16:48:03 +00002475<h3>2.4.19: Mar 25 2002</h3>
2476<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002477 <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin to UTF8
2478 encoder</li>
Daniel Veillard19274092002-03-25 16:48:03 +00002479 <li>portability fixes in the HTTP code</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +00002480 <li>memory allocation checks using valgrind, and profiling tests</li>
Daniel Veillard19274092002-03-25 16:48:03 +00002481 <li>revamp of the Windows build and Makefiles</li>
2482</ul>
2483
Daniel Veillard34ce8be2002-03-18 19:37:11 +00002484<h3>2.4.18: Mar 18 2002</h3>
2485<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002486 <li>bug fixes: tree, SAX, canonicalization, validation, portability,
2487 XPath</li>
Daniel Veillard34ce8be2002-03-18 19:37:11 +00002488 <li>removed the --with-buffer option it was becoming unmaintainable</li>
2489 <li>serious cleanup of the Python makefiles</li>
2490 <li>speedup patch to XPath very effective for DocBook stylesheets</li>
2491 <li>Fixes for Windows build, cleanup of the documentation</li>
2492</ul>
2493
Daniel Veillardaf43f632002-03-08 15:05:20 +00002494<h3>2.4.17: Mar 8 2002</h3>
2495<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002496 <li>a lot of bug fixes, including "namespace nodes have no parents in
2497 XPath"</li>
2498 <li>fixed/improved the Python wrappers, added more examples and more
2499 regression tests, XPath extension functions can now return node-sets</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002500 <li>added the XML Canonicalization support from Aleksey Sanin</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +00002501</ul>
2502
Daniel Veillard5f4b5992002-02-20 10:22:49 +00002503<h3>2.4.16: Feb 20 2002</h3>
2504<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002505 <li>a lot of bug fixes, most of them were triggered by the XML Testsuite
2506 from OASIS and W3C. Compliance has been significantly improved.</li>
Daniel Veillard5f4b5992002-02-20 10:22:49 +00002507 <li>a couple of portability fixes too.</li>
2508</ul>
2509
Daniel Veillard397ff112002-02-11 18:27:20 +00002510<h3>2.4.15: Feb 11 2002</h3>
2511<ul>
2512 <li>Fixed the Makefiles, especially the python module ones</li>
2513 <li>A few bug fixes and cleanup</li>
2514 <li>Includes cleanup</li>
2515</ul>
2516
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +00002517<h3>2.4.14: Feb 8 2002</h3>
2518<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +00002519 <li>Change of License to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00002520 href="http://www.opensource.org/licenses/mit-license.html">MIT
2521 License</a> basically for integration in XFree86 codebase, and removing
2522 confusion around the previous dual-licensing</li>
2523 <li>added Python bindings, beta software but should already be quite
2524 complete</li>
2525 <li>a large number of fixes and cleanups, especially for all tree
2526 manipulations</li>
2527 <li>cleanup of the headers, generation of a reference API definition in
2528 XML</li>
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +00002529</ul>
2530
2531<h3>2.4.13: Jan 14 2002</h3>
Daniel Veillard744683d2002-01-14 17:30:20 +00002532<ul>
2533 <li>update of the documentation: John Fleck and Charlie Bozeman</li>
2534 <li>cleanup of timing code from Justin Fletcher</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002535 <li>fixes for Windows and initial thread support on Win32: Igor and Serguei
2536 Narojnyi</li>
Daniel Veillard744683d2002-01-14 17:30:20 +00002537 <li>Cygwin patch from Robert Collins</li>
2538 <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li>
2539</ul>
2540
Daniel Veillardef90ba72001-12-07 14:24:22 +00002541<h3>2.4.12: Dec 7 2001</h3>
2542<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002543 <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman),
2544 XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups
2545 (robert)</li>
Daniel Veillardef90ba72001-12-07 14:24:22 +00002546 <li>Eric Lavigne contributed project files for MacOS</li>
2547 <li>some makefiles cleanups</li>
2548</ul>
2549
Daniel Veillarda4871052001-11-26 13:19:48 +00002550<h3>2.4.11: Nov 26 2001</h3>
2551<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002552 <li>fixed a couple of errors in the includes, fixed a few bugs, some code
2553 cleanups</li>
Daniel Veillarda4871052001-11-26 13:19:48 +00002554 <li>xmllint man pages improvement by Heiko Rupp</li>
2555 <li>updated VMS build instructions from John A Fotheringham</li>
2556 <li>Windows Makefiles updates from Igor</li>
2557</ul>
2558
Daniel Veillard43d3f612001-11-10 11:57:23 +00002559<h3>2.4.10: Nov 10 2001</h3>
2560<ul>
2561 <li>URI escaping fix (Joel Young)</li>
2562 <li>added xmlGetNodePath() (for paths or XPointers generation)</li>
2563 <li>Fixes namespace handling problems when using DTD and validation</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002564 <li>improvements on xmllint: Morus Walter patches for --format and
2565 --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li>
Daniel Veillard43d3f612001-11-10 11:57:23 +00002566 <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li>
2567 <li>fixes to the HTML parser</li>
2568</ul>
2569
2570<h3>2.4.9: Nov 6 2001</h3>
2571<ul>
2572 <li>fixes more catalog bugs</li>
2573 <li>avoid a compilation problem, improve xmlGetLineNo()</li>
2574</ul>
2575
Daniel Veillarded421aa2001-11-04 21:22:45 +00002576<h3>2.4.8: Nov 4 2001</h3>
2577<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002578 <li>fixed SGML catalogs broken in previous release, updated xmlcatalog
2579 tool</li>
Daniel Veillarded421aa2001-11-04 21:22:45 +00002580 <li>fixed a compile errors and some includes troubles.</li>
2581</ul>
2582
Daniel Veillard52dcab32001-10-30 12:51:17 +00002583<h3>2.4.7: Oct 30 2001</h3>
2584<ul>
2585 <li>exported some debugging interfaces</li>
2586 <li>serious rewrite of the catalog code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002587 <li>integrated Gary Pennington thread safety patch, added configure option
2588 and regression tests</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +00002589 <li>removed an HTML parser bug</li>
2590 <li>fixed a couple of potentially serious validation bugs</li>
2591 <li>integrated the SGML DocBook support in xmllint</li>
2592 <li>changed the nanoftp anonymous login passwd</li>
2593 <li>some I/O cleanup and a couple of interfaces for Perl wrapper</li>
2594 <li>general bug fixes</li>
2595 <li>updated xmllint man page by John Fleck</li>
2596 <li>some VMS and Windows updates</li>
2597</ul>
2598
Daniel Veillard60087f32001-10-10 09:45:09 +00002599<h3>2.4.6: Oct 10 2001</h3>
2600<ul>
Daniel Veillard52dcab32001-10-30 12:51:17 +00002601 <li>added an updated man pages by John Fleck</li>
Daniel Veillard60087f32001-10-10 09:45:09 +00002602 <li>portability and configure fixes</li>
2603 <li>an infinite loop on the HTML parser was removed (William)</li>
2604 <li>Windows makefile patches from Igor</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002605 <li>fixed half a dozen bugs reported for libxml or libxslt</li>
Daniel Veillard60087f32001-10-10 09:45:09 +00002606 <li>updated xmlcatalog to be able to modify SGML super catalogs</li>
2607</ul>
2608
Daniel Veillarddadd0872001-09-15 09:21:44 +00002609<h3>2.4.5: Sep 14 2001</h3>
2610<ul>
2611 <li>Remove a few annoying bugs in 2.4.4</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002612 <li>forces the HTML serializer to output decimal charrefs since some
2613 version of Netscape can't handle hexadecimal ones</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +00002614</ul>
2615
2616<h3>1.8.16: Sep 14 2001</h3>
2617<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002618 <li>maintenance release of the old libxml1 branch, couple of bug and
2619 portability fixes</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +00002620</ul>
2621
Daniel Veillard04382ae2001-09-12 18:51:30 +00002622<h3>2.4.4: Sep 12 2001</h3>
2623<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002624 <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
2625 Catalog</li>
Daniel Veillard04382ae2001-09-12 18:51:30 +00002626 <li>a few bug fixes and some portability changes</li>
2627 <li>some documentation cleanups</li>
2628</ul>
2629
Daniel Veillard39936902001-08-24 00:49:01 +00002630<h3>2.4.3: Aug 23 2001</h3>
2631<ul>
2632 <li>XML Catalog support see the doc</li>
2633 <li>New NaN/Infinity floating point code</li>
2634 <li>A few bug fixes</li>
2635</ul>
2636
2637<h3>2.4.2: Aug 15 2001</h3>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +00002638<ul>
2639 <li>adds xmlLineNumbersDefault() to control line number generation</li>
2640 <li>lot of bug fixes</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002641 <li>the Microsoft MSC projects files should now be up to date</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +00002642 <li>inheritance of namespaces from DTD defaulted attributes</li>
2643 <li>fixes a serious potential security bug</li>
2644 <li>added a --format option to xmllint</li>
2645</ul>
2646
2647<h3>2.4.1: July 24 2001</h3>
2648<ul>
2649 <li>possibility to keep line numbers in the tree</li>
2650 <li>some computation NaN fixes</li>
2651 <li>extension of the XPath API</li>
2652 <li>cleanup for alpha and ia64 targets</li>
2653 <li>patch to allow saving through HTTP PUT or POST</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +00002654</ul>
2655
2656<h3>2.4.0: July 10 2001</h3>
2657<ul>
2658 <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002659 <li>Fixed XML Base implementation, added a couple of examples to the
2660 regression tests</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +00002661 <li>A bit of cleanup</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +00002662</ul>
2663
Daniel Veillard5b43fde2001-07-05 23:31:40 +00002664<h3>2.3.14: July 5 2001</h3>
2665<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002666 <li>fixed some entities problems and reduce memory requirement when
2667 substituting them</li>
2668 <li>lots of improvements in the XPath queries interpreter can be
2669 substantially faster</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +00002670 <li>Makefiles and configure cleanups</li>
2671 <li>Fixes to XPath variable eval, and compare on empty node set</li>
2672 <li>HTML tag closing bug fixed</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002673 <li>Fixed an URI reference computation problem when validating</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +00002674</ul>
2675
Daniel Veillard2adbb512001-06-28 16:20:36 +00002676<h3>2.3.13: June 28 2001</h3>
2677<ul>
2678 <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
2679 <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
2680</ul>
2681
2682<h3>1.8.14: June 28 2001</h3>
2683<ul>
2684 <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
2685 <li>Small Makefile fix</li>
2686</ul>
2687
Daniel Veillard11648102001-06-26 16:08:24 +00002688<h3>2.3.12: June 26 2001</h3>
2689<ul>
2690 <li>lots of cleanup</li>
2691 <li>a couple of validation fix</li>
2692 <li>fixed line number counting</li>
2693 <li>fixed serious problems in the XInclude processing</li>
2694 <li>added support for UTF8 BOM at beginning of entities</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002695 <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
2696 miscompile uri.c (William), Thomas Leitner provided a fix for the
2697 optimizer on Tru64</li>
2698 <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
2699 compilation on Windows MSC</li>
Daniel Veillard11648102001-06-26 16:08:24 +00002700 <li>update of libxml-doc.el (Felix Natter)</li>
2701 <li>fixed 2 bugs in URI normalization code</li>
2702</ul>
2703
Daniel Veillarde3c81b52001-06-17 14:50:34 +00002704<h3>2.3.11: June 17 2001</h3>
2705<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002706 <li>updates to trio, Makefiles and configure should fix some portability
2707 problems (alpha)</li>
2708 <li>fixed some HTML serialization problems (pre, script, and block/inline
2709 handling), added encoding aware APIs, cleanup of this code</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +00002710 <li>added xmlHasNsProp()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002711 <li>implemented a specific PI for encoding support in the DocBook SGML
2712 parser</li>
2713 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
2714 node selection)</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +00002715 <li>fixed a performance problem and an error in the validation code</li>
2716 <li>fixed XInclude routine to implement the recursive behaviour</li>
2717 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
2718 <li>added --version to xmllint for bug reports</li>
2719</ul>
2720
Daniel Veillard2e4f1882001-06-01 10:11:57 +00002721<h3>2.3.10: June 1 2001</h3>
2722<ul>
2723 <li>fixed the SGML catalog support</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002724 <li>a number of reported bugs got fixed, in XPath, iconv detection,
2725 XInclude processing</li>
Daniel Veillard2e4f1882001-06-01 10:11:57 +00002726 <li>XPath string function should now handle unicode correctly</li>
2727</ul>
2728
Daniel Veillard4623acd2001-05-19 15:13:15 +00002729<h3>2.3.9: May 19 2001</h3>
2730
2731<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
2732<ul>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002733 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002734 <li>some serious speed optimization again</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +00002735 <li>some documentation cleanups</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002736 <li>trying to get better linking on Solaris (-R)</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +00002737 <li>XPath API cleanup from Thomas Broyer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002738 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
2739 xmlValidGetValidElements()</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +00002740 <li>Added an INSTALL file</li>
2741 <li>Attribute removal added to API: #54433</li>
2742 <li>added a basic support for SGML catalogs</li>
2743 <li>fixed xmlKeepBlanksDefault(0) API</li>
2744 <li>bugfix in xmlNodeGetLang()</li>
2745 <li>fixed a small configure portability problem</li>
2746 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
2747</ul>
2748
Daniel Veillarda265af72001-05-14 11:13:58 +00002749<h3>1.8.13: May 14 2001</h3>
2750<ul>
2751 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
2752</ul>
2753
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +00002754<h3>2.3.8: May 3 2001</h3>
2755<ul>
2756 <li>Integrated an SGML DocBook parser for the Gnome project</li>
2757 <li>Fixed a few things in the HTML parser</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002758 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
2759 point portability issue</li>
2760 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
2761 DOM+validation using the XML REC as input and a 700MHz celeron).</li>
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +00002762 <li>incorporated more Windows cleanup</li>
2763 <li>added xmlSaveFormatFile()</li>
2764 <li>fixed problems in copying nodes with entities references (gdome)</li>
2765 <li>removed some troubles surrounding the new validation module</li>
2766</ul>
2767
Daniel Veillarda41123c2001-04-22 19:31:20 +00002768<h3>2.3.7: April 22 2001</h3>
2769<ul>
2770 <li>lots of small bug fixes, corrected XPointer</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002771 <li>Non deterministic content model validation support</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +00002772 <li>added xmlDocCopyNode for gdome2</li>
2773 <li>revamped the way the HTML parser handles end of tags</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002774 <li>XPath: corrections of namespaces support and number formatting</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +00002775 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002776 <li>HTML output fixes from P C Chow and William M. Brack</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +00002777 <li>Improved validation speed sensible for DocBook</li>
2778 <li>fixed a big bug with ID declared in external parsed entities</li>
2779 <li>portability fixes, update of Trio from Bjorn Reese</li>
2780</ul>
2781
Daniel Veillardafc73112001-04-11 11:51:41 +00002782<h3>2.3.6: April 8 2001</h3>
2783<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002784 <li>Code cleanup using extreme gcc compiler warning options, found and
2785 cleared half a dozen potential problem</li>
Daniel Veillardafc73112001-04-11 11:51:41 +00002786 <li>the Eazel team found an XML parser bug</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002787 <li>cleaned up the user of some of the string formatting function. used the
2788 trio library code to provide the one needed when the platform is missing
2789 them</li>
2790 <li>xpath: removed a memory leak and fixed the predicate evaluation
2791 problem, extended the testsuite and cleaned up the result. XPointer seems
2792 broken ...</li>
Daniel Veillardafc73112001-04-11 11:51:41 +00002793</ul>
2794
Daniel Veillard56a4cb82001-03-24 17:00:36 +00002795<h3>2.3.5: Mar 23 2001</h3>
2796<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002797 <li>Biggest change is separate parsing and evaluation of XPath expressions,
2798 there is some new APIs for this too</li>
2799 <li>included a number of bug fixes(XML push parser, 51876, notations,
2800 52299)</li>
Daniel Veillard56a4cb82001-03-24 17:00:36 +00002801 <li>Fixed some portability issues</li>
2802</ul>
2803
Daniel Veillarde356c282001-03-10 12:32:04 +00002804<h3>2.3.4: Mar 10 2001</h3>
2805<ul>
2806 <li>Fixed bugs #51860 and #51861</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002807 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
2808 size to be application tunable.</li>
2809 <li>Some cleanup in the validation code, still a bug left and this part
2810 should probably be rewritten to support ambiguous content model :-\</li>
2811 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
2812 parser</li>
Daniel Veillarde356c282001-03-10 12:32:04 +00002813 <li>Fixed another bug in xmlNodeGetContent()</li>
2814 <li>Bjorn fixed XPath node collection and Number formatting</li>
2815 <li>Fixed a loop reported in the HTML parsing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002816 <li>blank space are reported even if the Dtd content model proves that they
2817 are formatting spaces, this is for XML conformance</li>
Daniel Veillarde356c282001-03-10 12:32:04 +00002818</ul>
2819
Daniel Veillardb402c072001-03-01 17:28:58 +00002820<h3>2.3.3: Mar 1 2001</h3>
2821<ul>
2822 <li>small change in XPath for XSLT</li>
2823 <li>documentation cleanups</li>
2824 <li>fix in validation by Gary Pennington</li>
2825 <li>serious parsing performances improvements</li>
2826</ul>
2827
Daniel Veillardec70e912001-02-26 20:10:45 +00002828<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +00002829<ul>
2830 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
2831 <li>fixed a Dtd parsing bug</li>
2832 <li>fixed a bug in xmlNodeGetContent</li>
2833 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
2834</ul>
2835
Daniel Veillardec70e912001-02-26 20:10:45 +00002836<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00002837<ul>
2838 <li>some XPath and HTML bug fixes for XSLT</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002839 <li>small extension of the hash table interfaces for DOM gdome2
2840 implementation</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00002841 <li>A few bug fixes</li>
2842</ul>
2843
Daniel Veillardec70e912001-02-26 20:10:45 +00002844<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 +00002845<ul>
2846 <li>Lots of XPath bug fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002847 <li>Add a mode with Dtd lookup but without validation error reporting for
2848 XSLT</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00002849 <li>Add support for text node without escaping (XSLT)</li>
2850 <li>bug fixes for xmlCheckFilename</li>
2851 <li>validation code bug fixes from Gary Pennington</li>
2852 <li>Patch from Paul D. Smith correcting URI path normalization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002853 <li>Patch to allow simultaneous install of libxml-devel and
2854 libxml2-devel</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00002855 <li>the example Makefile is now fixed</li>
2856 <li>added HTML to the RPM packages</li>
2857 <li>tree copying bugfixes</li>
2858 <li>updates to Windows makefiles</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00002859 <li>optimization patch from Bjorn Reese</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00002860</ul>
2861
Daniel Veillardec70e912001-02-26 20:10:45 +00002862<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +00002863<ul>
2864 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
2865 <li>added htmlHandleOmittedElem()</li>
2866 <li>Applied Bjorn Reese's IPV6 first patch</li>
2867 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +00002868 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +00002869</ul>
2870
Daniel Veillard2ddd23d2000-11-25 10:42:19 +00002871<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +00002872<ul>
2873 <li>Fix the Windows problems of 2.2.8</li>
2874 <li>integrate OpenVMS patches</li>
2875 <li>better handling of some nasty HTML input</li>
2876 <li>Improved the XPointer implementation</li>
2877 <li>integrate a number of provided patches</li>
2878</ul>
2879
Daniel Veillard2ddd23d2000-11-25 10:42:19 +00002880<h3>2.2.9: Nov 25 2000</h3>
2881<ul>
2882 <li>erroneous release :-(</li>
2883</ul>
2884
Daniel Veillard28929b22000-11-13 18:22:49 +00002885<h3>2.2.8: Nov 13 2000</h3>
2886<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002887 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
2888 support</li>
Daniel Veillard28929b22000-11-13 18:22:49 +00002889 <li>Patch in conditional section handling</li>
2890 <li>updated MS compiler project</li>
2891 <li>fixed some XPath problems</li>
2892 <li>added an URI escaping function</li>
2893 <li>some other bug fixes</li>
2894</ul>
2895
2896<h3>2.2.7: Oct 31 2000</h3>
2897<ul>
2898 <li>added message redirection</li>
2899 <li>XPath improvements (thanks TOM !)</li>
2900 <li>xmlIOParseDTD() added</li>
2901 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
2902 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
2903</ul>
2904
Daniel Veillard29a11cc2000-10-25 13:32:39 +00002905<h3>2.2.6: Oct 25 2000:</h3>
2906<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002907 <li>Added an hash table module, migrated a number of internal structure to
2908 those</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +00002909 <li>Fixed a posteriori validation problems</li>
2910 <li>HTTP module cleanups</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002911 <li>HTML parser improvements (tag errors, script/style handling, attribute
2912 normalization)</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +00002913 <li>coalescing of adjacent text nodes</li>
2914 <li>couple of XPath bug fixes, exported the internal API</li>
2915</ul>
2916
Daniel Veillardab8500d2000-10-15 21:06:19 +00002917<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +00002918<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +00002919 <li>XPointer implementation and testsuite</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002920 <li>Lot of XPath fixes, added variable and functions registration, more
2921 tests</li>
2922 <li>Portability fixes, lots of enhancements toward an easy Windows build
2923 and release</li>
Daniel Veillard189446d2000-10-13 10:23:06 +00002924 <li>Late validation fixes</li>
2925 <li>Integrated a lot of contributed patches</li>
2926 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +00002927 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +00002928</ul>
2929
2930<h3>2.2.4: Oct 1 2000:</h3>
2931<ul>
2932 <li>main XPath problem fixed</li>
2933 <li>Integrated portability patches for Windows</li>
2934 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +00002935</ul>
2936
Daniel Veillardd5f97f82000-09-17 16:38:14 +00002937<h3>2.2.3: Sep 17 2000</h3>
2938<ul>
2939 <li>bug fixes</li>
2940 <li>cleanup of entity handling code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002941 <li>overall review of all loops in the parsers, all sprintf usage has been
2942 checked too</li>
2943 <li>Far better handling of larges Dtd. Validating against DocBook XML Dtd
2944 works smoothly now.</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +00002945</ul>
2946
2947<h3>1.8.10: Sep 6 2000</h3>
2948<ul>
2949 <li>bug fix release for some Gnome projects</li>
2950</ul>
2951
2952<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +00002953<ul>
2954 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +00002955 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +00002956</ul>
2957
Daniel Veillardd5f97f82000-09-17 16:38:14 +00002958<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +00002959<ul>
2960 <li>a purely bug fixes release</li>
2961 <li>fixed an encoding support problem when parsing from a memory block</li>
2962 <li>fixed a DOCTYPE parsing problem</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002963 <li>removed a bug in the function allowing to override the memory
2964 allocation routines</li>
Daniel Veillarda2679fa2000-07-22 02:38:15 +00002965</ul>
2966
Daniel Veillardd5f97f82000-09-17 16:38:14 +00002967<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +00002968<ul>
2969 <li>applied a lot of portability fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002970 <li>better encoding support/cleanup and saving (content is now always
2971 encoded in UTF-8)</li>
Daniel Veillard94e90602000-07-17 14:38:19 +00002972 <li>the HTML parser now correctly handles encodings</li>
2973 <li>added xmlHasProp()</li>
2974 <li>fixed a serious problem with &amp;#38;</li>
2975 <li>propagated the fix to FTP client</li>
2976 <li>cleanup, bugfixes, etc ...</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002977 <li>Added a page about <a href="encoding.html">libxml Internationalization
2978 support</a></li>
Daniel Veillard94e90602000-07-17 14:38:19 +00002979</ul>
2980
Daniel Veillard60979bd2000-07-10 12:17:33 +00002981<h3>1.8.9: July 9 2000</h3>
2982<ul>
2983 <li>fixed the spec the RPMs should be better</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002984 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
2985 rpmfind users problem</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +00002986</ul>
2987
Daniel Veillard6388e172000-07-03 16:07:19 +00002988<h3>2.1.1: July 1 2000</h3>
2989<ul>
2990 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
2991 <li>improvements on the HTML parser</li>
2992</ul>
2993
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00002994<h3>2.1.0 and 1.8.8: June 29 2000</h3>
2995<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002996 <li>1.8.8 is mostly a commodity package for upgrading to libxml2 according
2997 to <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
2998 about &amp;#38; charref parsing</li>
2999 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
3000 also contains numerous fixes and enhancements:
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00003001 <ul>
3002 <li>added xmlStopParser() to stop parsing</li>
3003 <li>improved a lot parsing speed when there is large CDATA blocs</li>
3004 <li>includes XPath patches provided by Picdar Technology</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003005 <li>tried to fix as much as possible DTD validation and namespace
3006 related problems</li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00003007 <li>output to a given encoding has been added/tested</li>
3008 <li>lot of various fixes</li>
3009 </ul>
3010 </li>
3011</ul>
3012
Daniel Veillarde0aed302000-04-16 08:52:20 +00003013<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +00003014<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003015 <li>First public release of libxml2. If you are using libxml, it's a good
3016 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initially
3017 scheduled for Apr 3 the release occurred only on Apr 12 due to massive
3018 workload.</li>
3019 <li>The include are now located under $prefix/include/libxml (instead of
3020 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +00003021 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +00003022 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +00003023 <pre>#include "xxx.h"</pre>
3024 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +00003025 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003026 <li>the memory allocation routines used by libxml can now be overloaded
3027 dynamically by using xmlMemSetup()</li>
3028 <li>The previously CVS only tool tester has been renamed
3029 <strong>xmllint</strong> and is now installed as part of the libxml2
3030 package</li>
3031 <li>The I/O interface has been revamped. There is now ways to plug in
3032 specific I/O modules, either at the URI scheme detection level using
3033 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
3034 parser context using xmlCreateIOParserCtxt()</li>
3035 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
3036 number of the libxml module in use</li>
3037 <li>a number of optional features of libxml can now be excluded at
3038 configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +00003039</ul>
3040
3041<h3>2.0.0beta: Mar 14 2000</h3>
3042<ul>
3043 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003044 <li>It's available only from<a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org
3045 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
3046 RPMs</li>
3047 <li>This version is now the head in the Gnome CVS base, the old one is
3048 available under the tag LIB_XML_1_X</li>
3049 <li>This includes a very large set of changes. From a programmatic point
3050 of view applications should not have to be modified too much, check the
3051 <a href="upgrade.html">upgrade page</a></li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +00003052 <li>Some interfaces may changes (especially a bit about encoding).</li>
3053 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +00003054 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003055 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
3056 handled now</li>
3057 <li>Better handling of entities, especially well-formedness checking
3058 and proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +00003059 <li>DTD conditional sections</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003060 <li>Validation now correctly handle entities content</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003061 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
3062 structures to accommodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +00003063 </ul>
3064 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +00003065 <li>Serious progress were made toward compliance, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003066 href="conf/result.html">here are the result of the test</a> against the
3067 OASIS testsuite (except the Japanese tests since I don't support that
3068 encoding yet). This URL is rebuilt every couple of hours using the CVS
3069 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +00003070</ul>
3071
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00003072<h3>1.8.7: Mar 6 2000</h3>
3073<ul>
3074 <li>This is a bug fix release:</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003075 <li>It is possible to disable the ignorable blanks heuristic used by
3076 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
3077 that for adherence to XML spec, this behaviour will be disabled by
3078 default in 2.x . The same function will allow to keep compatibility for
3079 old code.</li>
3080 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
3081 avoiding heuristic is really the Right Way :-\</li>
3082 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
3083 compilation on some platforms has been fixed</li>
3084 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
3085 URIs</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00003086</ul>
3087
Daniel Veillarde41f2b72000-01-30 20:00:07 +00003088<h3>1.8.6: Jan 31 2000</h3>
3089<ul>
3090 <li>added a nanoFTP transport module, debugged until the new version of <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003091 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
3092 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +00003093</ul>
3094
3095<h3>1.8.5: Jan 21 2000</h3>
3096<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +00003097 <li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003098 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
3099 XML spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +00003100 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003101 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
3102 to solve the zlib checks problems</li>
3103 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
3104 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +00003105</ul>
3106
3107<h3>1.8.4: Jan 13 2000</h3>
3108<ul>
3109 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
3110 <li>all exit() call should have been removed from libxml</li>
3111 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
3112 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +00003113</ul>
3114
3115<h3>1.8.3: Jan 5 2000</h3>
3116<ul>
3117 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00003118 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003119 <li>lots of bug fixes and improvement added over XMas holidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +00003120 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +00003121 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
3122 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003123 <li>External entity loading code has been revamped, now it uses
3124 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +00003125 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +00003126</ul>
3127
3128<h3>1.8.2: Dec 21 1999</h3>
3129<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003130 <li>I got another problem with includes and C++, I hope this issue is fixed
3131 for good this time</li>
3132 <li>Added a few tree modification functions: xmlReplaceNode,
3133 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
3134 xmlDocSetRootElement</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +00003135 <li>Tried to improve the HTML output with help from <a
3136 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +00003137</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +00003138
Daniel Veillarde4e51311999-12-18 15:32:46 +00003139<h3>1.8.1: Dec 18 1999</h3>
3140<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003141 <li>various patches to avoid troubles when using libxml with C++ compilers
3142 the "namespace" keyword and C escaping in include files</li>
Daniel Veillarde4e51311999-12-18 15:32:46 +00003143 <li>a problem in one of the core macros IS_CHAR was corrected</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003144 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
3145 and more specifically the Dia application</li>
3146 <li>fixed a posteriori validation (validation after parsing, or by using a
3147 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +00003148 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +00003149</ul>
3150
3151<h3>1.8.0: Dec 12 1999</h3>
3152<ul>
3153 <li>cleanup, especially memory wise</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003154 <li>the parser should be more reliable, especially the HTML one, it should
3155 not crash, whatever the input !</li>
3156 <li>Integrated various patches, especially a speedup improvement for large
3157 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
3158 configure with --with-buffers to enable them.</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +00003159 <li>attribute normalization, oops should have been added long ago !</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003160 <li>attributes defaulted from DTDs should be available, xmlSetProp() now
3161 does entities escaping by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +00003162</ul>
Daniel Veillard35008381999-10-25 13:15:52 +00003163
3164<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003165<ul>
Daniel Veillard35008381999-10-25 13:15:52 +00003166 <li>Lots of HTML improvement</li>
3167 <li>Fixed some errors when saving both XML and HTML</li>
3168 <li>More examples, the regression tests should now look clean</li>
3169 <li>Fixed a bug with contiguous charref</li>
3170</ul>
3171
3172<h3>1.7.3: Sep 29 1999</h3>
3173<ul>
3174 <li>portability problems fixed</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003175 <li>snprintf was used unconditionally, leading to link problems on system
3176 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003177</ul>
3178
3179<h3>1.7.1: Sep 24 1999</h3>
3180<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003181 <li>The basic type for strings manipulated by libxml has been renamed in
3182 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
3183 is that CHAR was conflicting with a predefined type on Windows. However
3184 on non WIN32 environment, compatibility is provided by the way of a
3185 <strong>#define </strong>.</li>
3186 <li>Changed another error : the use of a structure field called errno, and
3187 leading to troubles on platforms where it's a macro</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003188</ul>
3189
Daniel Veillard63d83142002-05-20 06:51:05 +00003190<h3>1.7.0: Sep 23 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003191<ul>
3192 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003193 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
3194 <li>Added an errno to report errors by another mean than a simple printf
3195 like callback</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003196 <li>Finished ID/IDREF support and checking when validation</li>
3197 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003198 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
3199 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
3200 implementation</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003201 <li>Added an HTML parser front-end</li>
3202</ul>
3203
3204<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003205
Daniel Veillardf781dba2006-06-09 13:34:49 +00003206<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
3207markup-based structured documents. Here is <a name="example">an example XML
3208document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00003209<pre>&lt;?xml version="1.0"?&gt;
3210&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
3211 &lt;head&gt;
3212 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
3213 &lt;/head&gt;
3214 &lt;chapter&gt;
3215 &lt;title&gt;The Linux adventure&lt;/title&gt;
3216 &lt;p&gt;bla bla bla ...&lt;/p&gt;
3217 &lt;image href="linus.gif"/&gt;
3218 &lt;p&gt;...&lt;/p&gt;
3219 &lt;/chapter&gt;
3220&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00003221
Daniel Veillardf781dba2006-06-09 13:34:49 +00003222<p>The first line specifies that it is an XML document and gives useful
3223information about its encoding. Then the rest of the document is a text
3224format whose structure is specified by tags between brackets. <strong>Each
3225tag opened has to be closed</strong>. XML is pedantic about this. However, if
3226a tag is empty (no content), a single tag can serve as both the opening and
3227closing tag if it ends with <code>/&gt;</code> rather than with
3228<code>&gt;</code>. Note that, for example, the image tag has no content (just
3229an attribute) and is closed by ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00003230
Daniel Veillardf781dba2006-06-09 13:34:49 +00003231<p>XML can be applied successfully to a wide range of tasks, ranging from
3232long term structured document maintenance (where it follows the steps of
3233SGML) to simple data encoding mechanisms like configuration file formatting
3234(glade), spreadsheets (gnumeric), or even shorter lived documents such as
3235WebDAV where it is used to encode remote calls between a client and a
3236server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003237
Daniel Veillard82687162001-01-22 15:32:01 +00003238<h2><a name="XSLT">XSLT</a></h2>
3239
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00003240<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
3241
Daniel Veillardf781dba2006-06-09 13:34:49 +00003242<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
3243language for transforming XML documents into other XML documents (or
3244HTML/textual output).</p>
Daniel Veillard82687162001-01-22 15:32:01 +00003245
Daniel Veillardf781dba2006-06-09 13:34:49 +00003246<p>A separate library called libxslt is available implementing XSLT-1.0 for
William M. Brack43a87292007-02-15 20:41:02 +00003247libxml2. This module "libxslt" too can be found in the Gnome SVN base.</p>
Daniel Veillard82687162001-01-22 15:32:01 +00003248
Daniel Veillard29f61002005-08-06 09:07:15 +00003249<p>You can check the progresses on the libxslt <a
3250href="http://xmlsoft.org/XSLT/ChangeLog.html">Changelog</a>.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003251
3252<h2><a name="Python">Python and bindings</a></h2>
3253
Daniel Veillardf781dba2006-06-09 13:34:49 +00003254<p>There are a number of language bindings and wrappers available for
3255libxml2, the list below is not exhaustive. Please contact the <a
3256href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
3257(<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
3258order to get updates to this list or to discuss the specific topic of libxml2
3259or libxslt wrappers or bindings:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003260<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003261 <li><a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the
3262 most up-to-date C++ bindings for libxml2, check the <a
3263 href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>
3264 and the <a
Daniel Veillardc14401e2002-11-20 14:28:17 +00003265 href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003266 <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
3267 based on the gdome2 bindings</a> maintained by Tobias Peters.</li>
Daniel Veillard9b6fd302002-05-13 12:06:47 +00003268 <li>and a third C++ wrapper by Peter Jones &lt;pjones@pmade.org&gt;
3269 <p>Website: <a
3270 href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
3271 </li>
Daniel Veillardd012f482007-08-22 17:36:57 +00003272 <li>XML::LibXML <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXML">Perl
3273 bindings</a> are available on CPAN, as well as XML::LibXSLT
3274 <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXSLT">Perl libxslt
3275 bindings</a>.</li>
Daniel Veillard4ac494b2003-09-18 15:08:00 +00003276 <li>If you're interested into scripting XML processing, have a look at <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003277 href="http://xsh.sourceforge.net/">XSH</a> an XML editing shell based on
3278 Libxml2 Perl bindings.</li>
3279 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an
3280 earlier version of the libxml/libxslt <a
Daniel Veillard0b28e882002-07-24 23:47:05 +00003281 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li>
Daniel Veillard21473672002-06-17 07:29:22 +00003282 <li>Gopal.V and Peter Minten develop <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003283 href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of
3284 C# libxml2 bindings.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003285 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003286 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
3287 libxml2</a> with Kylix, Delphi and other Pascal compilers.</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +00003288 <li>Uwe Fechner also provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003289 href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2
3290 implementation for Kylix2/D5/D6 from Borland.</li>
3291 <li>There is <a href="http://libxml.rubyforge.org/">bindings for Ruby</a>
3292 and libxml2 bindings are also available in Ruby through the <a
3293 href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
3294 maintained by Tobias Peters.</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +00003295 <li>Steve Ball and contributors maintains <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003296 href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
3297 Tcl</a>.</li>
William M. Brack43a87292007-02-15 20:41:02 +00003298 <li>libxml2 and libxslt are the default XML libraries for PHP5.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003299 <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
3300 an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
3301 libxslt as part of GNU ClasspathX project.</li>
3302 <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for
3303 <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li>
Daniel Veillard67952602006-01-05 15:29:44 +00003304 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003305 href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>
3306 provides <a
3307 href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib
3308 osax</a>. This is an osax for Mac OS X with a set of commands to
3309 implement in AppleScript the XML DOM, XPATH and XSLT. Also includes
3310 commands for Property-lists (Apple's fast lookup table XML format.)</li>
Daniel Veillard67952602006-01-05 15:29:44 +00003311 <li>Francesco Montorsi developped <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003312 href="https://sourceforge.net/project/showfiles.php?group_id=51305&amp;package_id=45182">wxXml2</a>
3313 wrappers that interface libxml2, allowing wxWidgets applications to
3314 load/save/edit XML instances.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003315</ul>
3316
Daniel Veillardf781dba2006-06-09 13:34:49 +00003317<p>The distribution includes a set of Python bindings, which are guaranteed
3318to be maintained as part of the library in the future, though the Python
3319interface have not yet reached the completeness of the C API.</p>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00003320
Daniel Veillardf781dba2006-06-09 13:34:49 +00003321<p>Note that some of the Python purist dislike the default set of Python
3322bindings, rather than complaining I suggest they have a look at <a
Daniel Veillard28fdf8b2011-03-07 08:12:39 +08003323href="http://lxml.de/">lxml the more pythonic bindings for libxml2
Daniel Veillardf781dba2006-06-09 13:34:49 +00003324and libxslt</a> and <a
Daniel Veillard28fdf8b2011-03-07 08:12:39 +08003325href="http://lxml.de/mailinglist/">check the mailing-list</a>.</p>
Daniel Veillard929746e2005-05-11 11:08:22 +00003326
Daniel Veillardd2190fa2010-09-30 13:58:22 +02003327<p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003328maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
3329of the Python bindings</a>.</p>
Daniel Veillardaf43f632002-03-08 15:05:20 +00003330
Daniel Veillardf781dba2006-06-09 13:34:49 +00003331<p>Note to people interested in building bindings, the API is formalized as
3332<a href="libxml2-api.xml">an XML API description file</a> which allows to
3333automate a large part of the Python bindings, this includes function
3334descriptions, enums, structures, typedefs, etc... The Python script used to
3335build the bindings is python/generator.py in the source distribution.</p>
Daniel Veillard7ef0fcb2002-12-14 10:38:55 +00003336
Daniel Veillardaf43f632002-03-08 15:05:20 +00003337<p>To install the Python bindings there are 2 options:</p>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +00003338<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +00003339 <li>If you use an RPM based distribution, simply install the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003340 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
3341 RPM</a> (and if needed the <a
3342 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
3343 RPM</a>).</li>
3344 <li>Otherwise use the <a href="ftp://xmlsoft.org/libxml2/python/">libxml2-python
3345 module distribution</a> corresponding to your installed version of
3346 libxml2 and libxslt. Note that to install it you will need both libxml2
3347 and libxslt installed and run "python setup.py build install" in the
3348 module tree.</li>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +00003349</ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +00003350
Daniel Veillardf781dba2006-06-09 13:34:49 +00003351<p>The distribution includes a set of examples and regression tests for the
3352python bindings in the <code>python/tests</code> directory. Here are some
3353excerpts from those tests:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003354
3355<h3>tst.py:</h3>
3356
3357<p>This is a basic test of the file interface and DOM navigation:</p>
MST 2003 John Fleck2dffb762003-11-29 04:41:24 +00003358<pre>import libxml2, sys
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003359
3360doc = libxml2.parseFile("tst.xml")
3361if doc.name != "tst.xml":
3362 print "doc.name failed"
3363 sys.exit(1)
3364root = doc.children
3365if root.name != "doc":
3366 print "root.name failed"
3367 sys.exit(1)
3368child = root.children
3369if child.name != "foo":
3370 print "child.name failed"
3371 sys.exit(1)
3372doc.freeDoc()</pre>
3373
Daniel Veillardf781dba2006-06-09 13:34:49 +00003374<p>The Python module is called libxml2; parseFile is the equivalent of
3375xmlParseFile (most of the bindings are automatically generated, and the xml
3376prefix is removed and the casing convention are kept). All node seen at the
3377binding level share the same subset of accessors:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003378<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003379 <li><code>name</code> : returns the node name</li>
3380 <li><code>type</code> : returns a string indicating the node type</li>
3381 <li><code>content</code> : returns the content of the node, it is based on
3382 xmlNodeGetContent() and hence is recursive.</li>
3383 <li><code>parent</code> , <code>children</code>, <code>last</code>,
3384 <code>next</code>, <code>prev</code>, <code>doc</code>,
3385 <code>properties</code>: pointing to the associated element in the tree,
3386 those may return None in case no such link exists.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003387</ul>
3388
Daniel Veillardf781dba2006-06-09 13:34:49 +00003389<p>Also note the need to explicitly deallocate documents with freeDoc() .
3390Reference counting for libxml2 trees would need quite a lot of work to
3391function properly, and rather than risk memory leaks if not implemented
3392correctly it sounds safer to have an explicit function to free a tree. The
3393wrapper python objects like doc, root or child are them automatically garbage
3394collected.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003395
3396<h3>validate.py:</h3>
3397
Daniel Veillardf781dba2006-06-09 13:34:49 +00003398<p>This test check the validation interfaces and redirection of error
3399messages:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003400<pre>import libxml2
3401
Daniel Veillard63d83142002-05-20 06:51:05 +00003402#deactivate error messages from the validation
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003403def noerr(ctx, str):
3404 pass
3405
3406libxml2.registerErrorHandler(noerr, None)
3407
3408ctxt = libxml2.createFileParserCtxt("invalid.xml")
3409ctxt.validate(1)
3410ctxt.parseDocument()
3411doc = ctxt.doc()
3412valid = ctxt.isValid()
3413doc.freeDoc()
3414if valid != 0:
Daniel Veillard63d83142002-05-20 06:51:05 +00003415 print "validity check failed"</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003416
Daniel Veillardf781dba2006-06-09 13:34:49 +00003417<p>The first thing to notice is the call to registerErrorHandler(), it
3418defines a new error handler global to the library. It is used to avoid seeing
3419the error messages when trying to validate the invalid document.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003420
Daniel Veillardf781dba2006-06-09 13:34:49 +00003421<p>The main interest of that test is the creation of a parser context with
3422createFileParserCtxt() and how the behaviour can be changed before calling
William M. Brack43a87292007-02-15 20:41:02 +00003423parseDocument() . Similarly the information resulting from the parsing phase
3424is also available using context methods.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003425
Daniel Veillardf781dba2006-06-09 13:34:49 +00003426<p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
3427C function interfaces in terms of objects method as much as possible. The
3428best to get a complete view of what methods are supported is to look at the
3429libxml2.py module containing all the wrappers.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003430
3431<h3>push.py:</h3>
3432
3433<p>This test show how to activate the push parser interface:</p>
3434<pre>import libxml2
3435
3436ctxt = libxml2.createPushParser(None, "&lt;foo", 4, "test.xml")
3437ctxt.parseChunk("/&gt;", 2, 1)
3438doc = ctxt.doc()
3439
3440doc.freeDoc()</pre>
3441
Daniel Veillardf781dba2006-06-09 13:34:49 +00003442<p>The context is created with a special call based on the
3443xmlCreatePushParser() from the C library. The first argument is an optional
3444SAX callback object, then the initial set of data, the length and the name of
3445the resource in case URI-References need to be computed by the parser.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003446
Daniel Veillardf781dba2006-06-09 13:34:49 +00003447<p>Then the data are pushed using the parseChunk() method, the last call
3448setting the third argument terminate to 1.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003449
3450<h3>pushSAX.py:</h3>
3451
Daniel Veillardf781dba2006-06-09 13:34:49 +00003452<p>this test show the use of the event based parsing interfaces. In this case
3453the parser does not build a document, but provides callback information as
3454the parser makes progresses analyzing the data being provided:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003455<pre>import libxml2
3456log = ""
3457
3458class callback:
3459 def startDocument(self):
3460 global log
3461 log = log + "startDocument:"
3462
3463 def endDocument(self):
3464 global log
3465 log = log + "endDocument:"
3466
3467 def startElement(self, tag, attrs):
3468 global log
3469 log = log + "startElement %s %s:" % (tag, attrs)
3470
3471 def endElement(self, tag):
3472 global log
3473 log = log + "endElement %s:" % (tag)
3474
3475 def characters(self, data):
3476 global log
3477 log = log + "characters: %s:" % (data)
3478
3479 def warning(self, msg):
3480 global log
3481 log = log + "warning: %s:" % (msg)
3482
3483 def error(self, msg):
3484 global log
3485 log = log + "error: %s:" % (msg)
3486
3487 def fatalError(self, msg):
3488 global log
3489 log = log + "fatalError: %s:" % (msg)
3490
3491handler = callback()
3492
3493ctxt = libxml2.createPushParser(handler, "&lt;foo", 4, "test.xml")
3494chunk = " url='tst'&gt;b"
3495ctxt.parseChunk(chunk, len(chunk), 0)
3496chunk = "ar&lt;/foo&gt;"
3497ctxt.parseChunk(chunk, len(chunk), 1)
3498
Daniel Veillardfcbfa2d2002-02-21 17:54:27 +00003499reference = "startDocument:startElement foo {'url': 'tst'}:" + \
3500 "characters: bar:endElement foo:endDocument:"
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003501if log != reference:
3502 print "Error got: %s" % log
Daniel Veillard63d83142002-05-20 06:51:05 +00003503 print "Expected: %s" % reference</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003504
Daniel Veillardf781dba2006-06-09 13:34:49 +00003505<p>The key object in that test is the handler, it provides a number of entry
3506points which can be called by the parser as it makes progresses to indicate
3507the information set obtained. The full set of callback is larger than what
3508the callback class in that specific example implements (see the SAX
3509definition for a complete list). The wrapper will only call those supplied by
3510the object when activated. The startElement receives the names of the element
3511and a dictionary containing the attributes carried by this element.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003512
Daniel Veillardf781dba2006-06-09 13:34:49 +00003513<p>Also note that the reference string generated from the callback shows a
3514single character call even though the string "bar" is passed to the parser
3515from 2 different call to parseChunk()</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003516
3517<h3>xpath.py:</h3>
3518
Daniel Veillard63d83142002-05-20 06:51:05 +00003519<p>This is a basic test of XPath wrappers support</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003520<pre>import libxml2
3521
3522doc = libxml2.parseFile("tst.xml")
3523ctxt = doc.xpathNewContext()
3524res = ctxt.xpathEval("//*")
3525if len(res) != 2:
3526 print "xpath query: wrong node set size"
3527 sys.exit(1)
3528if res[0].name != "doc" or res[1].name != "foo":
3529 print "xpath query: wrong node set value"
3530 sys.exit(1)
3531doc.freeDoc()
3532ctxt.xpathFreeContext()</pre>
3533
Daniel Veillardf781dba2006-06-09 13:34:49 +00003534<p>This test parses a file, then create an XPath context to evaluate XPath
3535expression on it. The xpathEval() method execute an XPath query and returns
3536the result mapped in a Python way. String and numbers are natively converted,
3537and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
3538the document, the XPath context need to be freed explicitly, also not that
3539the result of the XPath query may point back to the document tree and hence
3540the document must be freed after the result of the query is used.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003541
3542<h3>xpathext.py:</h3>
3543
Daniel Veillardf781dba2006-06-09 13:34:49 +00003544<p>This test shows how to extend the XPath engine with functions written in
3545python:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003546<pre>import libxml2
3547
3548def foo(ctx, x):
3549 return x + 1
3550
3551doc = libxml2.parseFile("tst.xml")
3552ctxt = doc.xpathNewContext()
3553libxml2.registerXPathFunction(ctxt._o, "foo", None, foo)
3554res = ctxt.xpathEval("foo(1)")
3555if res != 2:
3556 print "xpath extension failure"
3557doc.freeDoc()
3558ctxt.xpathFreeContext()</pre>
3559
Daniel Veillardf781dba2006-06-09 13:34:49 +00003560<p>Note how the extension function is registered with the context (but that
3561part is not yet finalized, this may change slightly in the future).</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003562
3563<h3>tstxpath.py:</h3>
3564
Daniel Veillardf781dba2006-06-09 13:34:49 +00003565<p>This test is similar to the previous one but shows how the extension
3566function can access the XPath evaluation context:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003567<pre>def foo(ctx, x):
3568 global called
3569
3570 #
3571 # test that access to the XPath evaluation contexts
3572 #
3573 pctxt = libxml2.xpathParserContext(_obj=ctx)
3574 ctxt = pctxt.context()
3575 called = ctxt.function()
3576 return x + 1</pre>
3577
Daniel Veillardf781dba2006-06-09 13:34:49 +00003578<p>All the interfaces around the XPath parser(or rather evaluation) context
3579are not finalized, but it should be sufficient to do contextual work at the
3580evaluation point.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003581
3582<h3>Memory debugging:</h3>
3583
3584<p>last but not least, all tests starts with the following prologue:</p>
3585<pre>#memory debug specific
Daniel Veillardaf43f632002-03-08 15:05:20 +00003586libxml2.debugMemory(1)</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003587
3588<p>and ends with the following epilogue:</p>
3589<pre>#memory debug specific
3590libxml2.cleanupParser()
3591if libxml2.debugMemory(1) == 0:
3592 print "OK"
3593else:
3594 print "Memory leak %d bytes" % (libxml2.debugMemory(1))
3595 libxml2.dumpMemory()</pre>
3596
Daniel Veillardf781dba2006-06-09 13:34:49 +00003597<p>Those activate the memory debugging interface of libxml2 where all
3598allocated block in the library are tracked. The prologue then cleans up the
3599library state and checks that all allocated memory has been freed. If not it
3600calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
Daniel Veillard82687162001-01-22 15:32:01 +00003601
Daniel Veillard8a469172003-06-12 16:05:07 +00003602<h2><a name="architecture">libxml2 architecture</a></h2>
Daniel Veillard4540be42000-08-19 16:40:28 +00003603
Daniel Veillardf781dba2006-06-09 13:34:49 +00003604<p>Libxml2 is made of multiple components; some of them are optional, and
3605most of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +00003606<ul>
3607 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00003608 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00003609 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00003610 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00003611 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00003612 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00003613 <li>a SAX tree module to build an in-memory DOM representation</li>
3614 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00003615 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003616 <li>an XPath module for global lookup in a DOM representation
3617 (optional)</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00003618 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00003619</ul>
3620
3621<p>Graphically this gives the following:</p>
3622
3623<p><img src="libxml.gif" alt="a graphical view of the various"></p>
3624
3625<p></p>
3626
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003627<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00003628
Daniel Veillardf781dba2006-06-09 13:34:49 +00003629<p>The parser returns a tree built during the document analysis. The value
3630returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
3631<strong>xmlDoc</strong> structure). This structure contains information such
3632as the file name, the document type, and a <strong>children</strong> pointer
3633which is the root of the document (or more exactly the first child under the
3634root which is the document). The tree is made of <strong>xmlNode</strong>s,
3635chained in double-linked lists of siblings and with a children&lt;-&gt;parent
3636relationship. An xmlNode can also carry properties (a chain of xmlAttr
3637structures). An attribute may have a value which is a list of TEXT or
3638ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00003639
Daniel Veillardf781dba2006-06-09 13:34:49 +00003640<p>Here is an example (erroneous with respect to the XML spec since there
3641should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00003642
3643<p><img src="structure.gif" alt=" structure.gif "></p>
3644
Daniel Veillardf781dba2006-06-09 13:34:49 +00003645<p>In the source package there is a small program (not installed by default)
3646called <strong>xmllint</strong> which parses XML files given as argument and
3647prints them back as parsed. This is useful for detecting errors both in XML
3648code and in the XML parser itself. It has an option <strong>--debug</strong>
3649which prints the actual in-memory structure of the document; here is the
3650result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00003651<pre>DOCUMENT
3652version=1.0
3653standalone=true
3654 ELEMENT EXAMPLE
3655 ATTRIBUTE prop1
3656 TEXT
3657 content=gnome is great
3658 ATTRIBUTE prop2
3659 ENTITY_REF
3660 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +00003661 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +00003662 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00003663 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +00003664 TEXT
3665 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00003666 ELEMENT chapter
3667 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +00003668 TEXT
3669 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00003670 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +00003671 TEXT
3672 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00003673 ELEMENT image
3674 ATTRIBUTE href
3675 TEXT
3676 content=linus.gif
3677 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +00003678 TEXT
3679 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00003680
Daniel Veillard88f00ae2000-03-02 00:15:55 +00003681<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00003682
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003683<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003684
Daniel Veillardf781dba2006-06-09 13:34:49 +00003685<p>Sometimes the DOM tree output is just too large to fit reasonably into
3686memory. In that case (and if you don't expect to save back the XML document
3687loaded using libxml), it's better to use the SAX interface of libxml. SAX is
3688a <strong>callback-based interface</strong> to the parser. Before parsing,
3689the application layer registers a customized set of callbacks which are
3690called by the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003691
Daniel Veillardf781dba2006-06-09 13:34:49 +00003692<p>To get more detailed step-by-step guidance on using the SAX interface of
3693libxml, see the <a
3694href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
3695documentation</a>.written by <a href="mailto:james@daa.com.au">James
3696Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003697
Daniel Veillardf781dba2006-06-09 13:34:49 +00003698<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
3699program located in the gnome-xml module (it's usually not shipped in the
3700binary packages of libxml, but you can find it in the tar source
3701distribution). Here is the sequence of callbacks that would be reported by
3702testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003703<pre>SAX.setDocumentLocator()
3704SAX.startDocument()
3705SAX.getEntity(amp)
3706SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
3707SAX.characters( , 3)
3708SAX.startElement(head)
3709SAX.characters( , 4)
3710SAX.startElement(title)
3711SAX.characters(Welcome to Gnome, 16)
3712SAX.endElement(title)
3713SAX.characters( , 3)
3714SAX.endElement(head)
3715SAX.characters( , 3)
3716SAX.startElement(chapter)
3717SAX.characters( , 4)
3718SAX.startElement(title)
3719SAX.characters(The Linux adventure, 19)
3720SAX.endElement(title)
3721SAX.characters( , 4)
3722SAX.startElement(p)
3723SAX.characters(bla bla bla ..., 15)
3724SAX.endElement(p)
3725SAX.characters( , 4)
3726SAX.startElement(image, href='linus.gif')
3727SAX.endElement(image)
3728SAX.characters( , 4)
3729SAX.startElement(p)
3730SAX.characters(..., 3)
3731SAX.endElement(p)
3732SAX.characters( , 3)
3733SAX.endElement(chapter)
3734SAX.characters( , 1)
3735SAX.endElement(EXAMPLE)
3736SAX.endDocument()</pre>
3737
Daniel Veillardf781dba2006-06-09 13:34:49 +00003738<p>Most of the other interfaces of libxml2 are based on the DOM tree-building
3739facility, so nearly everything up to the end of this document presupposes the
3740use of the standard DOM tree build. Note that the DOM tree itself is built by
3741a set of registered default callbacks, without internal specific
3742interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003743
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003744<h2><a name="Validation">Validation &amp; DTDs</a></h2>
3745
3746<p>Table of Content:</p>
3747<ol>
3748 <li><a href="#General5">General overview</a></li>
3749 <li><a href="#definition">The definition</a></li>
3750 <li><a href="#Simple">Simple rules</a>
3751 <ol>
Daniel Veillard9c466822001-10-25 12:03:39 +00003752 <li><a href="#reference">How to reference a DTD from a document</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003753 <li><a href="#Declaring">Declaring elements</a></li>
3754 <li><a href="#Declaring1">Declaring attributes</a></li>
3755 </ol>
3756 </li>
3757 <li><a href="#Some">Some examples</a></li>
3758 <li><a href="#validate">How to validate</a></li>
3759 <li><a href="#Other">Other resources</a></li>
3760</ol>
3761
3762<h3><a name="General5">General overview</a></h3>
3763
3764<p>Well what is validation and what is a DTD ?</p>
3765
Daniel Veillardf781dba2006-06-09 13:34:49 +00003766<p>DTD is the acronym for Document Type Definition. This is a description of
3767the content for a family of XML files. This is part of the XML 1.0
3768specification, and allows one to describe and verify that a given document
3769instance conforms to the set of rules detailing its structure and content.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003770
Daniel Veillardf781dba2006-06-09 13:34:49 +00003771<p>Validation is the process of checking a document against a DTD (more
3772generally against a set of construction rules).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003773
Daniel Veillardf781dba2006-06-09 13:34:49 +00003774<p>The validation process and building DTDs are the two most difficult parts
3775of the XML life cycle. Briefly a DTD defines all the possible elements to be
3776found within your document, what is the formal shape of your document tree
3777(by defining the allowed content of an element; either text, a regular
3778expression for the allowed list of children, or mixed content i.e. both text
3779and children). The DTD also defines the valid attributes for all elements and
3780the types of those attributes.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003781
3782<h3><a name="definition1">The definition</a></h3>
3783
Daniel Veillardf781dba2006-06-09 13:34:49 +00003784<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a
3785href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
3786Rev1</a>):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003787<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003788 <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
3789 elements</a></li>
3790 <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
3791 attributes</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003792</ul>
3793
Daniel Veillardf781dba2006-06-09 13:34:49 +00003794<p>(unfortunately) all this is inherited from the SGML world, the syntax is
3795ancient...</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003796
3797<h3><a name="Simple1">Simple rules</a></h3>
3798
Daniel Veillardf781dba2006-06-09 13:34:49 +00003799<p>Writing DTDs can be done in many ways. The rules to build them if you need
3800something permanent or something which can evolve over time can be radically
3801different. Really complex DTDs like DocBook ones are flexible but quite
3802harder to design. I will just focus on DTDs for a formats with a fixed simple
3803structure. It is just a set of basic rules, and definitely not exhaustive nor
3804usable for complex DTD design.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003805
3806<h4><a name="reference1">How to reference a DTD from a document</a>:</h4>
3807
Daniel Veillardf781dba2006-06-09 13:34:49 +00003808<p>Assuming the top element of the document is <code>spec</code> and the dtd
3809is placed in the file <code>mydtd</code> in the subdirectory
3810<code>dtds</code> of the directory from where the document were loaded:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003811
3812<p><code>&lt;!DOCTYPE spec SYSTEM "dtds/mydtd"&gt;</code></p>
3813
3814<p>Notes:</p>
3815<ul>
Daniel Veillard0b28e882002-07-24 23:47:05 +00003816 <li>The system string is actually an URI-Reference (as defined in <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003817 href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
3818 full URL string indicating the location of your DTD on the Web. This is a
3819 really good thing to do if you want others to validate your document.</li>
3820 <li>It is also possible to associate a <code>PUBLIC</code> identifier (a
3821 magic string) so that the DTD is looked up in catalogs on the client side
3822 without having to locate it on the web.</li>
3823 <li>A DTD contains a set of element and attribute declarations, but they
3824 don't define what the root of the document should be. This is explicitly
3825 told to the parser/validator as the first element of the
3826 <code>DOCTYPE</code> declaration.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003827</ul>
3828
3829<h4><a name="Declaring2">Declaring elements</a>:</h4>
3830
3831<p>The following declares an element <code>spec</code>:</p>
3832
3833<p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
3834
Daniel Veillardf781dba2006-06-09 13:34:49 +00003835<p>It also expresses that the spec element contains one <code>front</code>,
3836one <code>body</code> and one optional <code>back</code> children elements in
3837this order. The declaration of one element of the structure and its content
3838are done in a single declaration. Similarly the following declares
3839<code>div1</code> elements:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003840
Daniel Veillard51737272002-01-23 23:10:38 +00003841<p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003842
Daniel Veillardf781dba2006-06-09 13:34:49 +00003843<p>which means div1 contains one <code>head</code> then a series of optional
3844<code>p</code>, <code>list</code>s and <code>note</code>s and then an
3845optional <code>div2</code>. And last but not least an element can contain
3846text:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003847
3848<p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
3849
Daniel Veillardf781dba2006-06-09 13:34:49 +00003850<p><code>b</code> contains text or being of mixed content (text and elements
3851in no particular order):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003852
3853<p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
3854
Daniel Veillardf781dba2006-06-09 13:34:49 +00003855<p><code>p </code>can contain text or <code>a</code>, <code>ul</code>,
3856<code>b</code>, <code>i </code>or <code>em</code> elements in no particular
3857order.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003858
3859<h4><a name="Declaring1">Declaring attributes</a>:</h4>
3860
Daniel Veillard0b28e882002-07-24 23:47:05 +00003861<p>Again the attributes declaration includes their content definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003862
3863<p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
3864
Daniel Veillardf781dba2006-06-09 13:34:49 +00003865<p>means that the element <code>termdef</code> can have a <code>name</code>
3866attribute containing text (<code>CDATA</code>) and which is optional
3867(<code>#IMPLIED</code>). The attribute value can also be defined within a
3868set:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003869
Daniel Veillardf781dba2006-06-09 13:34:49 +00003870<p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
3871"ordered"&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003872
Daniel Veillardf781dba2006-06-09 13:34:49 +00003873<p>means <code>list</code> element have a <code>type</code> attribute with 3
3874allowed values "bullets", "ordered" or "glossary" and which default to
3875"ordered" if the attribute is not explicitly specified.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003876
Daniel Veillardf781dba2006-06-09 13:34:49 +00003877<p>The content type of an attribute can be text (<code>CDATA</code>),
3878anchor/reference/references
3879(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
3880(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
3881(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
3882<code>chapter</code> element can have an optional <code>id</code> attribute
3883of type <code>ID</code>, usable for reference from attribute of type
3884IDREF:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003885
3886<p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
3887
Daniel Veillardf781dba2006-06-09 13:34:49 +00003888<p>The last value of an attribute definition can be <code>#REQUIRED
3889</code>meaning that the attribute has to be given, <code>#IMPLIED</code>
3890meaning that it is optional, or the default value (possibly prefixed by
3891<code>#FIXED</code> if it is the only allowed).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003892
3893<p>Notes:</p>
3894<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003895 <li>Usually the attributes pertaining to a given element are declared in a
3896 single expression, but it is just a convention adopted by a lot of DTD
3897 writers:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003898 <pre>&lt;!ATTLIST termdef
3899 id ID #REQUIRED
3900 name CDATA #IMPLIED&gt;</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003901 <p>The previous construct defines both <code>id</code> and
3902 <code>name</code> attributes for the element <code>termdef</code>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003903 </li>
3904</ul>
3905
3906<h3><a name="Some1">Some examples</a></h3>
3907
Daniel Veillardf781dba2006-06-09 13:34:49 +00003908<p>The directory <code>test/valid/dtds/</code> in the libxml2 distribution
3909contains some complex DTD examples. The example in the file
3910<code>test/valid/dia.xml</code> shows an XML file where the simple DTD is
3911directly included within the document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003912
3913<h3><a name="validate1">How to validate</a></h3>
3914
Daniel Veillardf781dba2006-06-09 13:34:49 +00003915<p>The simplest way is to use the xmllint program included with libxml. The
3916<code>--valid</code> option turns-on validation of the files given as input.
3917For example the following validates a copy of the first revision of the XML
39181.0 specification:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003919
3920<p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
3921
Daniel Veillard0b28e882002-07-24 23:47:05 +00003922<p>the -- noout is used to disable output of the resulting tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003923
Daniel Veillardf781dba2006-06-09 13:34:49 +00003924<p>The <code>--dtdvalid dtd</code> allows validation of the document(s)
3925against a given DTD.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003926
Daniel Veillard8a469172003-06-12 16:05:07 +00003927<p>Libxml2 exports an API to handle DTDs and validation, check the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003928href="http://xmlsoft.org/html/libxml-valid.html">associated
3929description</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003930
3931<h3><a name="Other1">Other resources</a></h3>
3932
Daniel Veillardf781dba2006-06-09 13:34:49 +00003933<p>DTDs are as old as SGML. So there may be a number of examples on-line, I
3934will just list one for now, others pointers welcome:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003935<ul>
3936 <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li>
3937</ul>
3938
Daniel Veillardf781dba2006-06-09 13:34:49 +00003939<p>I suggest looking at the examples found under test/valid/dtd and any of
3940the large number of books available on XML. The dia example in test/valid
3941should be both simple and complete enough to allow you to build your own.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003942
3943<p></p>
3944
3945<h2><a name="Memory">Memory Management</a></h2>
3946
3947<p>Table of Content:</p>
3948<ol>
3949 <li><a href="#General3">General overview</a></li>
Daniel Veillard8a469172003-06-12 16:05:07 +00003950 <li><a href="#setting">Setting libxml2 set of memory routines</a></li>
Daniel Veillard05b37c62008-03-31 08:27:07 +00003951 <li><a href="#cleanup">Cleaning up after using the library</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003952 <li><a href="#Debugging">Debugging routines</a></li>
3953 <li><a href="#General4">General memory requirements</a></li>
Daniel Veillardad87d5e2008-02-04 16:50:03 +00003954 <li><a href="#Compacting">Returning memory to the kernel</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003955</ol>
3956
3957<h3><a name="General3">General overview</a></h3>
3958
3959<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003960href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
3961provides the interfaces to the libxml2 memory system:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003962<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003963 <li>libxml2 does not use the libc memory allocator directly but xmlFree(),
3964 xmlMalloc() and xmlRealloc()</li>
3965 <li>those routines can be reallocated to a specific set of routine, by
3966 default the libc ones i.e. free(), malloc() and realloc()</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003967 <li>the xmlmemory.c module includes a set of debugging routine</li>
3968</ul>
3969
Daniel Veillard8a469172003-06-12 16:05:07 +00003970<h3><a name="setting">Setting libxml2 set of memory routines</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003971
Daniel Veillardf781dba2006-06-09 13:34:49 +00003972<p>It is sometimes useful to not use the default memory allocator, either for
3973debugging, analysis or to implement a specific behaviour on memory management
3974(like on embedded systems). Two function calls are available to do so:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003975<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003976 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet
3977 ()</a> which return the current set of functions in use by the parser</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003978 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003979 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
3980 which allow to set up a new set of memory allocation functions</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003981</ul>
3982
Daniel Veillardf781dba2006-06-09 13:34:49 +00003983<p>Of course a call to xmlMemSetup() should probably be done before calling
3984any other libxml2 routines (unless you are sure your allocations routines are
3985compatibles).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003986
Daniel Veillard05b37c62008-03-31 08:27:07 +00003987<h3><a name="cleanup">Cleaning up after using the library</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003988
Daniel Veillardf781dba2006-06-09 13:34:49 +00003989<p>Libxml2 is not stateless, there is a few set of memory structures needing
3990allocation before the parser is fully functional (some encoding structures
3991for example). This also mean that once parsing is finished there is a tiny
3992amount of memory (a few hundred bytes) which can be recollected if you don't
Daniel Veillard05b37c62008-03-31 08:27:07 +00003993reuse the library or any document built with it:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00003994<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003995 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
Daniel Veillard05b37c62008-03-31 08:27:07 +00003996 ()</a> is a centralized routine to free the library state and data. Note
3997 that it won't deallocate any produced tree if any (use the xmlFreeDoc()
3998 and related routines for this). This should be called only when the library
3999 is not used anymore.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004000 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
4001 ()</a> is the dual routine allowing to preallocate the parsing state
4002 which can be useful for example to avoid initialization reentrancy
4003 problems when using libxml2 in multithreaded applications</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004004</ul>
4005
Daniel Veillard05b37c62008-03-31 08:27:07 +00004006<p>Generally xmlCleanupParser() is safe assuming no parsing is ongoing and
4007no document is still being used, if needed the state will be rebuild at the
4008next invocation of parser routines (or by xmlInitParser()), but be careful
4009of the consequences in multithreaded applications.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004010
4011<h3><a name="Debugging">Debugging routines</a></h3>
4012
Daniel Veillardf781dba2006-06-09 13:34:49 +00004013<p>When configured using --with-mem-debug flag (off by default), libxml2 uses
4014a set of memory allocation debugging routines keeping track of all allocated
4015blocks and the location in the code where the routine was called. A couple of
4016other debugging routines allow to dump the memory allocated infos to a file
4017or call a specific routine when a given block number is allocated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004018<ul>
4019 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004020 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a>
4021 <a
4022 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
4023 and <a
4024 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
4025 are the memory debugging replacement allocation routines</li>
4026 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
William M. Brack43a87292007-02-15 20:41:02 +00004027 ()</a> dumps all the information about the allocated memory block lefts
Daniel Veillardf781dba2006-06-09 13:34:49 +00004028 in the <code>.memdump</code> file</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004029</ul>
4030
Daniel Veillardf781dba2006-06-09 13:34:49 +00004031<p>When developing libxml2 memory debug is enabled, the tests programs call
4032xmlMemoryDump () and the "make test" regression tests will check for any
4033memory leak during the full regression test sequence, this helps a lot
4034ensuring that libxml2 does not leak memory and bullet proof memory
4035allocations use (some libc implementations are known to be far too permissive
4036resulting in major portability problems!).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004037
Daniel Veillardf781dba2006-06-09 13:34:49 +00004038<p>If the .memdump reports a leak, it displays the allocation function and
William M. Brack43a87292007-02-15 20:41:02 +00004039also tries to give some information about the content and structure of the
Daniel Veillardf781dba2006-06-09 13:34:49 +00004040allocated blocks left. This is sufficient in most cases to find the culprit,
4041but not always. Assuming the allocation problem is reproducible, it is
4042possible to find more easily:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004043<ol>
4044 <li>write down the block number xxxx not allocated</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004045 <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , the easiest
4046 when using GDB is to simply give the command
Daniel Veillard75794822002-04-11 16:24:32 +00004047 <p><code>set environment XML_MEM_BREAKPOINT xxxx</code></p>
4048 <p>before running the program.</p>
4049 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004050 <li>run the program under a debugger and set a breakpoint on
4051 xmlMallocBreakpoint() a specific function called when this precise block
4052 is allocated</li>
4053 <li>when the breakpoint is reached you can then do a fine analysis of the
4054 allocation an step to see the condition resulting in the missing
4055 deallocation.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004056</ol>
4057
Daniel Veillardf781dba2006-06-09 13:34:49 +00004058<p>I used to use a commercial tool to debug libxml2 memory problems but after
4059noticing that it was not detecting memory leaks that simple mechanism was
4060used and proved extremely efficient until now. Lately I have also used <a
4061href="http://developer.kde.org/~sewardj/">valgrind</a> with quite some
4062success, it is tied to the i386 architecture since it works by emulating the
4063processor and instruction set, it is slow but extremely efficient, i.e. it
4064spot memory usage errors in a very precise way.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004065
4066<h3><a name="General4">General memory requirements</a></h3>
4067
Daniel Veillardf781dba2006-06-09 13:34:49 +00004068<p>How much libxml2 memory require ? It's hard to tell in average it depends
4069of a number of things:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004070<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004071 <li>the parser itself should work in a fixed amount of memory, except for
4072 information maintained about the stacks of names and entities locations.
4073 The I/O and encoding handlers will probably account for a few KBytes.
4074 This is true for both the XML and HTML parser (though the HTML parser
4075 need more state).</li>
4076 <li>If you are generating the DOM tree then memory requirements will grow
4077 nearly linear with the size of the data. In general for a balanced
4078 textual document the internal memory requirement is about 4 times the
4079 size of the UTF8 serialization of this document (example the XML-1.0
4080 recommendation is a bit more of 150KBytes and takes 650KBytes of main
4081 memory when parsed). Validation will add a amount of memory required for
4082 maintaining the external Dtd state which should be linear with the
4083 complexity of the content model defined by the Dtd</li>
4084 <li>If you need to work with fixed memory requirements or don't need the
4085 full DOM tree then using the <a href="xmlreader.html">xmlReader
4086 interface</a> is probably the best way to proceed, it still allows to
4087 validate or operate on subset of the tree if needed.</li>
4088 <li>If you don't care about the advanced features of libxml2 like
4089 validation, DOM, XPath or XPointer, don't use entities, need to work with
4090 fixed memory requirements, and try to get the fastest parsing possible
4091 then the SAX interface should be used, but it has known restrictions.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004092</ul>
4093
4094<p></p>
Daniel Veillardad87d5e2008-02-04 16:50:03 +00004095<h3><a name="Compacting">Returning memory to the kernel</a></h3>
4096
4097<p>You may encounter that your process using libxml2 does not have a
4098reduced memory usage although you freed the trees. This is because
4099libxml2 allocates memory in a number of small chunks. When freeing one
4100of those chunks, the OS may decide that giving this little memory back
4101to the kernel will cause too much overhead and delay the operation. As
4102all chunks are this small, they get actually freed but not returned to
4103the kernel. On systems using glibc, there is a function call
4104"malloc_trim" from malloc.h which does this missing operation (note that
4105it is allowed to fail). Thus, after freeing your tree you may simply try
4106"malloc_trim(0);" to really get the memory back. If your OS does not
4107provide malloc_trim, try searching for a similar function.</p>
4108<p></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004109
4110<h2><a name="Encodings">Encodings support</a></h2>
4111
Daniel Veillardf781dba2006-06-09 13:34:49 +00004112<p>If you are not really familiar with Internationalization (usual shortcut
4113is I18N) , Unicode, characters and glyphs, I suggest you read a <a
4114href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a>
4115by Tim Bray on Unicode and why you should care about it.</p>
Daniel Veillard67952602006-01-05 15:29:44 +00004116
Daniel Veillardf781dba2006-06-09 13:34:49 +00004117<p>If you don't understand why <b>it does not make sense to have a string
4118without knowing what encoding it uses</b>, then as Joel Spolsky said <a
4119href="http://www.joelonsoftware.com/articles/Unicode.html">please do not
4120write another line of code until you finish reading that article.</a>. It is
4121a prerequisite to understand this page, and avoid a lot of problems with
4122libxml2, XML or text processing in general.</p>
Daniel Veillarde5d68de2005-03-10 15:03:40 +00004123
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004124<p>Table of Content:</p>
4125<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004126 <li><a href="encoding.html#What">What does internationalization support
4127 mean ?</a></li>
4128 <li><a href="encoding.html#internal">The internal encoding, how and
4129 why</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004130 <li><a href="encoding.html#implemente">How is it implemented ?</a></li>
4131 <li><a href="encoding.html#Default">Default supported encodings</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004132 <li><a href="encoding.html#extend">How to extend the existing
4133 support</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004134</ol>
4135
4136<h3><a name="What">What does internationalization support mean ?</a></h3>
4137
Daniel Veillardf781dba2006-06-09 13:34:49 +00004138<p>XML was designed from the start to allow the support of any character set
4139by using Unicode. Any conformant XML parser has to support the UTF-8 and
4140UTF-16 default encodings which can both express the full unicode ranges. UTF8
4141is a variable length encoding whose greatest points are to reuse the same
4142encoding for ASCII and to save space for Western encodings, but it is a bit
4143more complex to handle in practice. UTF-16 use 2 bytes per character (and
4144sometimes combines two pairs), it makes implementation easier, but looks a
4145bit overkill for Western languages encoding. Moreover the XML specification
4146allows the document to be encoded in other encodings at the condition that
4147they are clearly labeled as such. For example the following is a wellformed
4148XML document encoded in ISO-8859-1 and using accentuated letters that we
4149French like for both markup and content:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004150<pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004151&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;</pre>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004152
Daniel Veillard8a469172003-06-12 16:05:07 +00004153<p>Having internationalization support in libxml2 means the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004154<ul>
4155 <li>the document is properly parsed</li>
William M. Brack43a87292007-02-15 20:41:02 +00004156 <li>information about it's encoding is saved</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004157 <li>it can be modified</li>
4158 <li>it can be saved in its original encoding</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004159 <li>it can also be saved in another encoding supported by libxml2 (for
4160 example straight UTF8 or even an ASCII form)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004161</ul>
4162
Daniel Veillardf781dba2006-06-09 13:34:49 +00004163<p>Another very important point is that the whole libxml2 API, with the
4164exception of a few routines to read with a specific encoding or save to a
4165specific encoding, is completely agnostic about the original encoding of the
4166document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004167
Daniel Veillardf781dba2006-06-09 13:34:49 +00004168<p>It should be noted too that the HTML parser embedded in libxml2 now obey
4169the same rules too, the following document will be (as of 2.2.2) handled in
4170an internationalized fashion by libxml2 too:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004171<pre>&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
4172 "http://www.w3.org/TR/REC-html40/loose.dtd"&gt;
4173&lt;html lang="fr"&gt;
4174&lt;head&gt;
4175 &lt;META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"&gt;
4176&lt;/head&gt;
4177&lt;body&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004178&lt;p&gt;W3C cr&eacute;e des standards pour le Web.&lt;/body&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004179&lt;/html&gt;</pre>
4180
4181<h3><a name="internal">The internal encoding, how and why</a></h3>
4182
Daniel Veillardf781dba2006-06-09 13:34:49 +00004183<p>One of the core decisions was to force all documents to be converted to a
4184default internal encoding, and that encoding to be UTF-8, here are the
4185rationales for those choices:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004186<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004187 <li>keeping the native encoding in the internal form would force the libxml
4188 users (or the code associated) to be fully aware of the encoding of the
4189 original document, for examples when adding a text node to a document,
4190 the content would have to be provided in the document encoding, i.e. the
4191 client code would have to check it before hand, make sure it's conformant
4192 to the encoding, etc ... Very hard in practice, though in some specific
4193 cases this may make sense.</li>
4194 <li>the second decision was which encoding. From the XML spec only UTF8 and
4195 UTF16 really makes sense as being the two only encodings for which there
4196 is mandatory support. UCS-4 (32 bits fixed size encoding) could be
4197 considered an intelligent choice too since it's a direct Unicode mapping
4198 support. I selected UTF-8 on the basis of efficiency and compatibility
4199 with surrounding software:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004200 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004201 <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
4202 more costly to import and export CPU wise) is also far more compact
4203 than UTF-16 (and UCS-4) for a majority of the documents I see it used
4204 for right now (RPM RDF catalogs, advogato data, various configuration
4205 file formats, etc.) and the key point for today's computer
4206 architecture is efficient uses of caches. If one nearly double the
4207 memory requirement to store the same amount of data, this will trash
4208 caches (main memory/external caches/internal caches) and my take is
4209 that this harms the system far more than the CPU requirements needed
4210 for the conversion to UTF-8</li>
4211 <li>Most of libxml2 version 1 users were using it with straight ASCII
4212 most of the time, doing the conversion with an internal encoding
4213 requiring all their code to be rewritten was a serious show-stopper
4214 for using UTF-16 or UCS-4.</li>
4215 <li>UTF-8 is being used as the de-facto internal encoding standard for
4216 related code like the <a href="http://www.pango.org/">pango</a>
4217 upcoming Gnome text widget, and a lot of Unix code (yet another place
4218 where Unix programmer base takes a different approach from Microsoft
4219 - they are using UTF-16)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004220 </ul>
4221 </li>
4222</ul>
4223
Daniel Veillard8a469172003-06-12 16:05:07 +00004224<p>What does this mean in practice for the libxml2 user:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004225<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004226 <li>xmlChar, the libxml2 data type is a byte, those bytes must be assembled
4227 as UTF-8 valid strings. The proper way to terminate an xmlChar * string
4228 is simply to append 0 byte, as usual.</li>
4229 <li>One just need to make sure that when using chars outside the ASCII set,
4230 the values has been properly converted to UTF-8</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004231</ul>
4232
4233<h3><a name="implemente">How is it implemented ?</a></h3>
4234
Daniel Veillardf781dba2006-06-09 13:34:49 +00004235<p>Let's describe how all this works within libxml, basically the I18N
4236(internationalization) support get triggered only during I/O operation, i.e.
4237when reading a document or saving one. Let's look first at the reading
4238sequence:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004239<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004240 <li>when a document is processed, we usually don't know the encoding, a
4241 simple heuristic allows to detect UTF-16 and UCS-4 from encodings where
4242 the ASCII range (0-0x7F) maps with ASCII</li>
4243 <li>the xml declaration if available is parsed, including the encoding
4244 declaration. At that point, if the autodetected encoding is different
4245 from the one declared a call to xmlSwitchEncoding() is issued.</li>
4246 <li>If there is no encoding declaration, then the input has to be in either
4247 UTF-8 or UTF-16, if it is not then at some point when processing the
4248 input, the converter/checker of UTF-8 form will raise an encoding error.
4249 You may end-up with a garbled document, or no document at all ! Example:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004250 <pre>~/XML -&gt; ./xmllint err.xml
4251err.xml:1: error: Input is not proper UTF-8, indicate encoding !
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004252&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004253 ^
4254err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004255&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004256 ^</pre>
4257 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004258 <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize it, and
4259 then search the default registered encoding converters for that encoding.
4260 If it's not within the default set and iconv() support has been compiled
4261 it, it will ask iconv for such an encoder. If this fails then the parser
4262 will report an error and stops processing:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004263 <pre>~/XML -&gt; ./xmllint err2.xml
4264err2.xml:1: error: Unsupported encoding UnsupportedEnc
4265&lt;?xml version="1.0" encoding="UnsupportedEnc"?&gt;
4266 ^</pre>
4267 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004268 <li>From that point the encoder processes progressively the input (it is
4269 plugged as a front-end to the I/O module) for that entity. It captures
4270 and converts on-the-fly the document to be parsed to UTF-8. The parser
4271 itself just does UTF-8 checking of this input and process it
4272 transparently. The only difference is that the encoding information has
4273 been added to the parsing context (more precisely to the input
4274 corresponding to this entity).</li>
4275 <li>The result (when using DOM) is an internal form completely in UTF-8
4276 with just an encoding information on the document node.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004277</ol>
4278
Daniel Veillardf781dba2006-06-09 13:34:49 +00004279<p>Ok then what happens when saving the document (assuming you
4280collected/built an xmlDoc DOM like structure) ? It depends on the function
4281called, xmlSaveFile() will just try to save in the original encoding, while
4282xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
4283encoding:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004284<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004285 <li>if no encoding is given, libxml2 will look for an encoding value
4286 associated to the document and if it exists will try to save to that
4287 encoding,
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004288 <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
4289 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004290 <li>so if an encoding was specified, either at the API level or on the
4291 document, libxml2 will again canonicalize the encoding name, lookup for a
4292 converter in the registered set or through iconv. If not found the
4293 function will return an error code</li>
4294 <li>the converter is placed before the I/O buffer layer, as another kind of
4295 buffer, then libxml2 will simply push the UTF-8 serialization to through
4296 that buffer, which will then progressively be converted and pushed onto
4297 the I/O layer.</li>
4298 <li>It is possible that the converter code fails on some input, for example
4299 trying to push an UTF-8 encoded Chinese character through the UTF-8 to
4300 ISO-8859-1 converter won't work. Since the encoders are progressive they
4301 will just report the error and the number of bytes converted, at that
4302 point libxml2 will decode the offending character, remove it from the
4303 buffer and replace it with the associated charRef encoding &amp;#123; and
4304 resume the conversion. This guarantees that any document will be saved
4305 without losses (except for markup names where this is not legal, this is
4306 a problem in the current version, in practice avoid using non-ascii
4307 characters for tag or attribute names). A special "ascii" encoding name
4308 is used to save documents to a pure ascii form can be used when
4309 portability is really crucial</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004310</ol>
4311
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004312<p>Here are a few examples based on the same test document and assumin a
4313terminal using ISO-8859-1 as the text encoding:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004314<pre>~/XML -&gt; ./xmllint isolat1
4315&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004316&lt;tr&egrave;s&gt;là&lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004317~/XML -&gt; ./xmllint --encode UTF-8 isolat1
4318&lt;?xml version="1.0" encoding="UTF-8"?&gt;
Daniel Veillard29341682009-09-10 18:23:39 +02004319&lt;très&gt;là &nbsp;&lt;/très&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004320~/XML -&gt; </pre>
4321
Daniel Veillardf781dba2006-06-09 13:34:49 +00004322<p>The same processing is applied (and reuse most of the code) for HTML I18N
4323processing. Looking up and modifying the content encoding is a bit more
4324difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
4325so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
4326been provided. The parser also attempts to switch encoding on the fly when
4327detecting such a tag on input. Except for that the processing is the same
4328(and again reuses the same code).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004329
4330<h3><a name="Default">Default supported encodings</a></h3>
4331
Daniel Veillardf781dba2006-06-09 13:34:49 +00004332<p>libxml2 has a set of default converters for the following encodings
4333(located in encoding.c):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004334<ol>
4335 <li>UTF-8 is supported by default (null handlers)</li>
4336 <li>UTF-16, both little and big endian</li>
4337 <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
4338 <li>ASCII, useful mostly for saving</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004339 <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
4340 predefined entities like &amp;copy; for the Copyright sign.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004341</ol>
4342
Daniel Veillardf781dba2006-06-09 13:34:49 +00004343<p>More over when compiled on an Unix platform with iconv support the full
4344set of encodings supported by iconv can be instantly be used by libxml. On a
4345linux machine with glibc-2.1 the list of supported encodings and aliases fill
43463 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
4347various Japanese ones.</p>
Daniel Veillard67952602006-01-05 15:29:44 +00004348
Daniel Veillardf781dba2006-06-09 13:34:49 +00004349<p>To convert from the UTF-8 values returned from the API to another encoding
4350then it is possible to use the function provided from <a
4351href="html/libxml-encoding.html">the encoding module</a> like <a
4352href="html/libxml-encoding.html#UTF8Toisolat1">UTF8Toisolat1</a>, or use the
4353POSIX <a
4354href="http://www.opengroup.org/onlinepubs/009695399/functions/iconv.html">iconv()</a>
4355API directly.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004356
4357<h4>Encoding aliases</h4>
4358
Daniel Veillardf781dba2006-06-09 13:34:49 +00004359<p>From 2.2.3, libxml2 has support to register encoding names aliases. The
4360goal is to be able to parse document whose encoding is supported but where
4361the name differs (for example from the default set of names accepted by
4362iconv). The following functions allow to register and handle new aliases for
4363existing encodings. Once registered libxml2 will automatically lookup the
4364aliases when handling a document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004365<ul>
4366 <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
4367 <li>int xmlDelEncodingAlias(const char *alias);</li>
4368 <li>const char * xmlGetEncodingAlias(const char *alias);</li>
4369 <li>void xmlCleanupEncodingAliases(void);</li>
4370</ul>
4371
4372<h3><a name="extend">How to extend the existing support</a></h3>
4373
Daniel Veillardf781dba2006-06-09 13:34:49 +00004374<p>Well adding support for new encoding, or overriding one of the encoders
4375(assuming it is buggy) should not be hard, just write input and output
4376conversion routines to/from UTF-8, and register them using
4377xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be
4378called automatically if the parser(s) encounter such an encoding name
4379(register it uppercase, this will help). The description of the encoders,
4380their arguments and expected return values are described in the encoding.h
4381header.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004382
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004383<h2><a name="IO">I/O Interfaces</a></h2>
4384
4385<p>Table of Content:</p>
4386<ol>
4387 <li><a href="#General1">General overview</a></li>
4388 <li><a href="#basic">The basic buffer type</a></li>
4389 <li><a href="#Input">Input I/O handlers</a></li>
4390 <li><a href="#Output">Output I/O handlers</a></li>
4391 <li><a href="#entities">The entities loader</a></li>
4392 <li><a href="#Example2">Example of customized I/O</a></li>
4393</ol>
4394
4395<h3><a name="General1">General overview</a></h3>
4396
4397<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004398href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
4399the interfaces to the libxml2 I/O system. This consists of 4 main parts:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004400<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004401 <li>Entities loader, this is a routine which tries to fetch the entities
4402 (files) based on their PUBLIC and SYSTEM identifiers. The default loader
4403 don't look at the public identifier since libxml2 do not maintain a
4404 catalog. You can redefine you own entity loader by using
4405 <code>xmlGetExternalEntityLoader()</code> and
4406 <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
4407 example</a>.</li>
4408 <li>Input I/O buffers which are a commodity structure used by the parser(s)
William M. Brack43a87292007-02-15 20:41:02 +00004409 input layer to handle fetching the information to feed the parser. This
Daniel Veillardf781dba2006-06-09 13:34:49 +00004410 provides buffering and is also a placeholder where the encoding
4411 converters to UTF8 are piggy-backed.</li>
4412 <li>Output I/O buffers are similar to the Input ones and fulfill similar
4413 task but when generating a serialization from a tree.</li>
4414 <li>A mechanism to register sets of I/O callbacks and associate them with
4415 specific naming schemes like the protocol part of the URIs.
4416 <p>This affect the default I/O operations and allows to use specific I/O
4417 handlers for certain names.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004418 </li>
4419</ul>
4420
Daniel Veillardf781dba2006-06-09 13:34:49 +00004421<p>The general mechanism used when loading http://rpmfind.net/xml.html for
4422example in the HTML parser is the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004423<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004424 <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
4425 the parsing context and the URI string.</li>
4426 <li>the URI string is checked against the existing registered handlers
4427 using their match() callback function, if the HTTP module was compiled
4428 in, it is registered and its match() function will succeeds</li>
4429 <li>the open() function of the handler is called and if successful will
4430 return an I/O Input buffer</li>
4431 <li>the parser will the start reading from this buffer and progressively
4432 fetch information from the resource, calling the read() function of the
4433 handler until the resource is exhausted</li>
4434 <li>if an encoding change is detected it will be installed on the input
4435 buffer, providing buffering and efficient use of the conversion
4436 routines</li>
4437 <li>once the parser has finished, the close() function of the handler is
4438 called once and the Input buffer and associated resources are
4439 deallocated.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004440</ol>
4441
Daniel Veillardf781dba2006-06-09 13:34:49 +00004442<p>The user defined callbacks are checked first to allow overriding of the
4443default libxml2 I/O routines.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004444
4445<h3><a name="basic">The basic buffer type</a></h3>
4446
Daniel Veillardf781dba2006-06-09 13:34:49 +00004447<p>All the buffer manipulation handling is done using the
4448<code>xmlBuffer</code> type define in <code><a
4449href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a
4450resizable memory buffer. The buffer allocation strategy can be selected to be
4451either best-fit or use an exponential doubling one (CPU vs. memory use
4452trade-off). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
4453<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
4454system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
4455of functions allows to manipulate buffers with names starting with the
4456<code>xmlBuffer...</code> prefix.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004457
4458<h3><a name="Input">Input I/O handlers</a></h3>
4459
Daniel Veillardf781dba2006-06-09 13:34:49 +00004460<p>An Input I/O handler is a simple structure
4461<code>xmlParserInputBuffer</code> containing a context associated to the
4462resource (file descriptor, or pointer to a protocol handler), the read() and
4463close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
4464encoding handler are also present to support charset conversion when
4465needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004466
4467<h3><a name="Output">Output I/O handlers</a></h3>
4468
Daniel Veillardf781dba2006-06-09 13:34:49 +00004469<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
4470Input one except the callbacks are write() and close().</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004471
4472<h3><a name="entities">The entities loader</a></h3>
4473
Daniel Veillardf781dba2006-06-09 13:34:49 +00004474<p>The entity loader resolves requests for new entities and create inputs for
4475the parser. Creating an input from a filename or an URI string is done
4476through the xmlNewInputFromFile() routine. The default entity loader do not
4477handle the PUBLIC identifier associated with an entity (if any). So it just
4478calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
4479XML).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004480
Daniel Veillardf781dba2006-06-09 13:34:49 +00004481<p>If you want to hook up a catalog mechanism then you simply need to
4482override the default entity loader, here is an example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004483<pre>#include &lt;libxml/xmlIO.h&gt;
4484
4485xmlExternalEntityLoader defaultLoader = NULL;
4486
4487xmlParserInputPtr
4488xmlMyExternalEntityLoader(const char *URL, const char *ID,
4489 xmlParserCtxtPtr ctxt) {
4490 xmlParserInputPtr ret;
4491 const char *fileID = NULL;
4492 /* lookup for the fileID depending on ID */
4493
4494 ret = xmlNewInputFromFile(ctxt, fileID);
4495 if (ret != NULL)
4496 return(ret);
4497 if (defaultLoader != NULL)
4498 ret = defaultLoader(URL, ID, ctxt);
4499 return(ret);
4500}
4501
4502int main(..) {
4503 ...
4504
4505 /*
4506 * Install our own entity loader
4507 */
4508 defaultLoader = xmlGetExternalEntityLoader();
4509 xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);
4510
4511 ...
4512}</pre>
4513
4514<h3><a name="Example2">Example of customized I/O</a></h3>
4515
Daniel Veillardf781dba2006-06-09 13:34:49 +00004516<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
4517real use case</a>, xmlDocDump() closes the FILE * passed by the application
4518and this was a problem. The <a
4519href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
4520new output handler with the closing call deactivated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004521<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004522 <li>First define a new I/O output allocator where the output don't close
4523 the file:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004524 <pre>xmlOutputBufferPtr
4525xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
Daniel Veillardf781dba2006-06-09 13:34:49 +00004526&nbsp;&nbsp;&nbsp;&nbsp;xmlOutputBufferPtr ret;
4527&nbsp;&nbsp;&nbsp;&nbsp;
4528&nbsp;&nbsp;&nbsp;&nbsp;if (xmlOutputCallbackInitialized == 0)
4529&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlRegisterDefaultOutputCallbacks();
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004530
Daniel Veillardf781dba2006-06-09 13:34:49 +00004531&nbsp;&nbsp;&nbsp;&nbsp;if (file == NULL) return(NULL);
4532&nbsp;&nbsp;&nbsp;&nbsp;ret = xmlAllocOutputBuffer(encoder);
4533&nbsp;&nbsp;&nbsp;&nbsp;if (ret != NULL) {
4534&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;context = file;
4535&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;writecallback = xmlFileWrite;
4536&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;closecallback = NULL; /* No close callback */
4537&nbsp;&nbsp;&nbsp;&nbsp;}
4538&nbsp;&nbsp;&nbsp;&nbsp;return(ret);
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004539} </pre>
4540 </li>
4541 <li>And then use it to save the document:
4542 <pre>FILE *f;
4543xmlOutputBufferPtr output;
4544xmlDocPtr doc;
4545int res;
4546
4547f = ...
4548doc = ....
4549
4550output = xmlOutputBufferCreateOwn(f, NULL);
4551res = xmlSaveFileTo(output, doc, NULL);
4552 </pre>
4553 </li>
4554</ol>
4555
4556<h2><a name="Catalog">Catalog support</a></h2>
4557
4558<p>Table of Content:</p>
4559<ol>
4560 <li><a href="General2">General overview</a></li>
4561 <li><a href="#definition">The definition</a></li>
4562 <li><a href="#Simple">Using catalogs</a></li>
4563 <li><a href="#Some">Some examples</a></li>
4564 <li><a href="#reference">How to tune catalog usage</a></li>
4565 <li><a href="#validate">How to debug catalog processing</a></li>
4566 <li><a href="#Declaring">How to create and maintain catalogs</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004567 <li><a href="#implemento">The implementor corner quick review of the
4568 API</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004569 <li><a href="#Other">Other resources</a></li>
4570</ol>
4571
4572<h3><a name="General2">General overview</a></h3>
4573
Daniel Veillardf781dba2006-06-09 13:34:49 +00004574<p>What is a catalog? Basically it's a lookup mechanism used when an entity
4575(a file or a remote resource) references another entity. The catalog lookup
4576is inserted between the moment the reference is recognized by the software
4577(XML parser, stylesheet processing, or even images referenced for inclusion
4578in a rendering) and the time where loading that resource is actually
4579started.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004580
4581<p>It is basically used for 3 things:</p>
4582<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004583 <li>mapping from "logical" names, the public identifiers and a more
4584 concrete name usable for download (and URI). For example it can associate
4585 the logical name
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004586 <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004587 <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be
4588 downloaded</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004589 <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p>
4590 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004591 <li>remapping from a given URL to another one, like an HTTP indirection
4592 saying that
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004593 <p>"http://www.oasis-open.org/committes/tr.xsl"</p>
4594 <p>should really be looked at</p>
4595 <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p>
4596 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004597 <li>providing a local cache mechanism allowing to load the entities
4598 associated to public identifiers or remote resources, this is a really
4599 important feature for any significant deployment of XML or SGML since it
4600 allows to avoid the aleas and delays associated to fetching remote
4601 resources.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004602</ul>
4603
4604<h3><a name="definition">The definitions</a></h3>
4605
4606<p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p>
4607<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004608 <li>the older SGML catalogs, the official spec is SGML Open Technical
4609 Resolution TR9401:1997, but is better understood by reading <a
4610 href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from
4611 James Clark. This is relatively old and not the preferred mode of
4612 operation of libxml.</li>
4613 <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML
4614 Catalogs</a> is far more flexible, more recent, uses an XML syntax and
4615 should scale quite better. This is the default option of libxml.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004616</ul>
4617
4618<p></p>
4619
4620<h3><a name="Simple">Using catalog</a></h3>
4621
Daniel Veillardf781dba2006-06-09 13:34:49 +00004622<p>In a normal environment libxml2 will by default check the presence of a
4623catalog in /etc/xml/catalog, and assuming it has been correctly populated,
4624the processing is completely transparent to the document user. To take a
4625concrete example, suppose you are authoring a DocBook document, this one
4626starts with the following DOCTYPE definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004627<pre>&lt;?xml version='1.0'?&gt;
4628&lt;!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
4629 "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"&gt;</pre>
4630
Daniel Veillardf781dba2006-06-09 13:34:49 +00004631<p>When validating the document with libxml, the catalog will be
4632automatically consulted to lookup the public identifier "-//Norman Walsh//DTD
4633DocBk XML V3.1.4//EN" and the system identifier
4634"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have
4635been installed on your system and the catalogs actually point to them, libxml
4636will fetch them from the local disk.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004637
Daniel Veillardf781dba2006-06-09 13:34:49 +00004638<p style="font-size: 10pt"><strong>Note</strong>: Really don't use this
4639DOCTYPE example it's a really old version, but is fine as an example.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004640
Daniel Veillardf781dba2006-06-09 13:34:49 +00004641<p>Libxml2 will check the catalog each time that it is requested to load an
4642entity, this includes DTD, external parsed entities, stylesheets, etc ... If
4643your system is correctly configured all the authoring phase and processing
4644should use only local files, even if your document stays portable because it
4645uses the canonical public and system ID, referencing the remote document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004646
4647<h3><a name="Some">Some examples:</a></h3>
4648
Daniel Veillardf781dba2006-06-09 13:34:49 +00004649<p>Here is a couple of fragments from XML Catalogs used in libxml2 early
4650regression tests in <code>test/catalogs</code> :</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004651<pre>&lt;?xml version="1.0"?&gt;
4652&lt;!DOCTYPE catalog PUBLIC
4653 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4654 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4655&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
4656 &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
4657 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
4658...</pre>
4659
Daniel Veillardf781dba2006-06-09 13:34:49 +00004660<p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are
4661written in XML, there is a specific namespace for catalog elements
4662"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this
4663catalog is a <code>public</code> mapping it allows to associate a Public
4664Identifier with an URI.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004665<pre>...
4666 &lt;rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/"
4667 rewritePrefix="file:///usr/share/xml/docbook/"/&gt;
4668...</pre>
4669
Daniel Veillardf781dba2006-06-09 13:34:49 +00004670<p>A <code>rewriteSystem</code> is a very powerful instruction, it says that
4671any URI starting with a given prefix should be looked at another URI
4672constructed by replacing the prefix with an new one. In effect this acts like
4673a cache system for a full area of the Web. In practice it is extremely useful
4674with a file prefix if you have installed a copy of those resources on your
4675local system.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004676<pre>...
4677&lt;delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //"
4678 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4679&lt;delegatePublic publicIdStartString="-//OASIS//ENTITIES DocBook XML"
4680 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4681&lt;delegatePublic publicIdStartString="-//OASIS//DTD DocBook XML"
4682 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4683&lt;delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/"
4684 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4685&lt;delegateURI uriStartString="http://www.oasis-open.org/docbook/"
4686 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4687...</pre>
4688
Daniel Veillardf781dba2006-06-09 13:34:49 +00004689<p>Delegation is the core features which allows to build a tree of catalogs,
4690easier to maintain than a single catalog, based on Public Identifier, System
4691Identifier or URI prefixes it instructs the catalog software to look up
4692entries in another resource. This feature allow to build hierarchies of
4693catalogs, the set of entries presented should be sufficient to redirect the
4694resolution of all DocBook references to the specific catalog in
4695<code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all
4696references for DocBook 4.2.1 to a specific catalog installed at the same time
4697as the DocBook resources on the local machine.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004698
4699<h3><a name="reference">How to tune catalog usage:</a></h3>
4700
Daniel Veillardf781dba2006-06-09 13:34:49 +00004701<p>The user can change the default catalog behaviour by redirecting queries
4702to its own set of catalogs, this can be done by setting the
4703<code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an
4704empty one should deactivate loading the default <code>/etc/xml/catalog</code>
4705default catalog</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004706
4707<h3><a name="validate">How to debug catalog processing:</a></h3>
4708
Daniel Veillardf781dba2006-06-09 13:34:49 +00004709<p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will
William M. Brack43a87292007-02-15 20:41:02 +00004710make libxml2 output debugging information for each catalog operations, for
Daniel Veillardf781dba2006-06-09 13:34:49 +00004711example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004712<pre>orchis:~/XML -&gt; xmllint --memory --noout test/ent2
4713warning: failed to load external entity "title.xml"
4714orchis:~/XML -&gt; export XML_DEBUG_CATALOG=
4715orchis:~/XML -&gt; xmllint --memory --noout test/ent2
4716Failed to parse catalog /etc/xml/catalog
4717Failed to parse catalog /etc/xml/catalog
4718warning: failed to load external entity "title.xml"
4719Catalogs cleanup
4720orchis:~/XML -&gt; </pre>
4721
Daniel Veillardf781dba2006-06-09 13:34:49 +00004722<p>The test/ent2 references an entity, running the parser from memory makes
4723the base URI unavailable and the the "title.xml" entity cannot be loaded.
4724Setting up the debug environment variable allows to detect that an attempt is
4725made to load the <code>/etc/xml/catalog</code> but since it's not present the
4726resolution fails.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004727
Daniel Veillardf781dba2006-06-09 13:34:49 +00004728<p>But the most advanced way to debug XML catalog processing is to use the
4729<strong>xmlcatalog</strong> command shipped with libxml2, it allows to load
4730catalogs and make resolution queries to see what is going on. This is also
4731used for the regression tests:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004732<pre>orchis:~/XML -&gt; ./xmlcatalog test/catalogs/docbook.xml \
4733 "-//OASIS//DTD DocBook XML V4.1.2//EN"
4734http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4735orchis:~/XML -&gt; </pre>
4736
Daniel Veillardf781dba2006-06-09 13:34:49 +00004737<p>For debugging what is going on, adding one -v flags increase the verbosity
4738level to indicate the processing done (adding a second flag also indicate
4739what elements are recognized at parsing):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004740<pre>orchis:~/XML -&gt; ./xmlcatalog -v test/catalogs/docbook.xml \
4741 "-//OASIS//DTD DocBook XML V4.1.2//EN"
4742Parsing catalog test/catalogs/docbook.xml's content
4743Found public match -//OASIS//DTD DocBook XML V4.1.2//EN
4744http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4745Catalogs cleanup
4746orchis:~/XML -&gt; </pre>
4747
Daniel Veillardf781dba2006-06-09 13:34:49 +00004748<p>A shell interface is also available to debug and process multiple queries
4749(and for regression tests):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004750<pre>orchis:~/XML -&gt; ./xmlcatalog -shell test/catalogs/docbook.xml \
4751 "-//OASIS//DTD DocBook XML V4.1.2//EN"
4752&gt; help
4753Commands available:
4754public PublicID: make a PUBLIC identifier lookup
4755system SystemID: make a SYSTEM identifier lookup
4756resolve PublicID SystemID: do a full resolver lookup
4757add 'type' 'orig' 'replace' : add an entry
4758del 'values' : remove values
4759dump: print the current catalog state
4760debug: increase the verbosity level
4761quiet: decrease the verbosity level
4762exit: quit the shell
4763&gt; public "-//OASIS//DTD DocBook XML V4.1.2//EN"
4764http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4765&gt; quit
4766orchis:~/XML -&gt; </pre>
4767
Daniel Veillardf781dba2006-06-09 13:34:49 +00004768<p>This should be sufficient for most debugging purpose, this was actually
4769used heavily to debug the XML Catalog implementation itself.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004770
Daniel Veillardf781dba2006-06-09 13:34:49 +00004771<h3><a name="Declaring">How to create and maintain</a> catalogs:</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004772
Daniel Veillardf781dba2006-06-09 13:34:49 +00004773<p>Basically XML Catalogs are XML files, you can either use XML tools to
4774manage them or use <strong>xmlcatalog</strong> for this. The basic step is
4775to create a catalog the -create option provide this facility:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004776<pre>orchis:~/XML -&gt; ./xmlcatalog --create tst.xml
4777&lt;?xml version="1.0"?&gt;
4778&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4779 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4780&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4781orchis:~/XML -&gt; </pre>
4782
Daniel Veillardf781dba2006-06-09 13:34:49 +00004783<p>By default xmlcatalog does not overwrite the original catalog and save the
4784result on the standard output, this can be overridden using the -noout
4785option. The <code>-add</code> command allows to add entries in the
4786catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004787<pre>orchis:~/XML -&gt; ./xmlcatalog --noout --create --add "public" \
4788 "-//OASIS//DTD DocBook XML V4.1.2//EN" \
4789 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml
4790orchis:~/XML -&gt; cat tst.xml
4791&lt;?xml version="1.0"?&gt;
4792&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" \
4793 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4794&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
4795&lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
4796 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
4797&lt;/catalog&gt;
4798orchis:~/XML -&gt; </pre>
4799
Daniel Veillardf781dba2006-06-09 13:34:49 +00004800<p>The <code>-add</code> option will always take 3 parameters even if some of
4801the XML Catalog constructs (like nextCatalog) will have only a single
4802argument, just pass a third empty string, it will be ignored.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004803
Daniel Veillardf781dba2006-06-09 13:34:49 +00004804<p>Similarly the <code>-del</code> option remove matching entries from the
4805catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004806<pre>orchis:~/XML -&gt; ./xmlcatalog --del \
4807 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml
4808&lt;?xml version="1.0"?&gt;
4809&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4810 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4811&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4812orchis:~/XML -&gt; </pre>
4813
Daniel Veillardf781dba2006-06-09 13:34:49 +00004814<p>The catalog is now empty. Note that the matching of <code>-del</code> is
4815exact and would have worked in a similar fashion with the Public ID
4816string.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004817
Daniel Veillardf781dba2006-06-09 13:34:49 +00004818<p>This is rudimentary but should be sufficient to manage a not too complex
4819catalog tree of resources.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004820
Daniel Veillardf781dba2006-06-09 13:34:49 +00004821<h3><a name="implemento">The implementor corner quick review of the
4822API:</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004823
Daniel Veillardf781dba2006-06-09 13:34:49 +00004824<p>First, and like for every other module of libxml, there is an
4825automatically generated <a href="html/libxml-catalog.html">API page for
4826catalog support</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004827
4828<p>The header for the catalog interfaces should be included as:</p>
4829<pre>#include &lt;libxml/catalog.h&gt;</pre>
4830
Daniel Veillardf781dba2006-06-09 13:34:49 +00004831<p>The API is voluntarily kept very simple. First it is not obvious that
4832applications really need access to it since it is the default behaviour of
4833libxml2 (Note: it is possible to completely override libxml2 default catalog
4834by using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to
4835plug an application specific resolver).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004836
Daniel Veillard8a469172003-06-12 16:05:07 +00004837<p>Basically libxml2 support 2 catalog lists:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004838<ul>
4839 <li>the default one, global shared by all the application</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004840 <li>a per-document catalog, this one is built if the document uses the
4841 <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is
4842 associated to the parser context and destroyed when the parsing context
4843 is destroyed.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004844</ul>
4845
4846<p>the document one will be used first if it exists.</p>
4847
4848<h4>Initialization routines:</h4>
4849
Daniel Veillardf781dba2006-06-09 13:34:49 +00004850<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be
4851used at startup to initialize the catalog, if the catalog should be
4852initialized with specific values xmlLoadCatalog() or xmlLoadCatalogs()
4853should be called before xmlInitializeCatalog() which would otherwise do a
4854default initialization first.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004855
Daniel Veillardf781dba2006-06-09 13:34:49 +00004856<p>The xmlCatalogAddLocal() call is used by the parser to grow the document
4857own catalog list if needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004858
4859<h4>Preferences setup:</h4>
4860
Daniel Veillardf781dba2006-06-09 13:34:49 +00004861<p>The XML Catalog spec requires the possibility to select default
4862preferences between public and system delegation,
4863xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and
4864xmlCatalogGetDefaults() allow to control if XML Catalogs resolution should
4865be forbidden, allowed for global catalog, for document catalog or both, the
4866default is to allow both.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004867
Daniel Veillardf781dba2006-06-09 13:34:49 +00004868<p>And of course xmlCatalogSetDebug() allows to generate debug messages
4869(through the xmlGenericError() mechanism).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004870
4871<h4>Querying routines:</h4>
4872
Daniel Veillardf781dba2006-06-09 13:34:49 +00004873<p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic()
4874and xmlCatalogResolveURI() are relatively explicit if you read the XML
4875Catalog specification they correspond to section 7 algorithms, they should
4876also work if you have loaded an SGML catalog with a simplified semantic.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004877
Daniel Veillardf781dba2006-06-09 13:34:49 +00004878<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but
4879operate on the document catalog list</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004880
4881<h4>Cleanup and Miscellaneous:</h4>
4882
Daniel Veillardf781dba2006-06-09 13:34:49 +00004883<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is
4884the per-document equivalent.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004885
Daniel Veillardf781dba2006-06-09 13:34:49 +00004886<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the
4887first catalog in the global list, and xmlCatalogDump() allows to dump a
4888catalog state, those routines are primarily designed for xmlcatalog, I'm not
4889sure that exposing more complex interfaces (like navigation ones) would be
4890really useful.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004891
Daniel Veillardf781dba2006-06-09 13:34:49 +00004892<p>The xmlParseCatalogFile() is a function used to load XML Catalog files,
4893it's similar as xmlParseFile() except it bypass all catalog lookups, it's
4894provided because this functionality may be useful for client tools.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004895
4896<h4>threaded environments:</h4>
4897
Daniel Veillardf781dba2006-06-09 13:34:49 +00004898<p>Since the catalog tree is built progressively, some care has been taken to
4899try to avoid troubles in multithreaded environments. The code is now thread
4900safe assuming that the libxml2 library has been compiled with threads
4901support.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004902
4903<p></p>
4904
4905<h3><a name="Other">Other resources</a></h3>
4906
Daniel Veillardf781dba2006-06-09 13:34:49 +00004907<p>The XML Catalog specification is relatively recent so there isn't much
4908literature to point at:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004909<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +00004910 <li>You can find a good rant from Norm Walsh about <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004911 href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the
William M. Brack43a87292007-02-15 20:41:02 +00004912 need for catalogs</a>, it provides a lot of context information even if
Daniel Veillardf781dba2006-06-09 13:34:49 +00004913 I don't agree with everything presented. Norm also wrote a more recent
4914 article <a
4915 href="http://wwws.sun.com/software/xml/developers/resolver/article/">XML
4916 entities and URI resolvers</a> describing them.</li>
4917 <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML
4918 catalog proposal</a> from John Cowan</li>
4919 <li>The <a href="http://www.rddl.org/">Resource Directory Description
4920 Language</a> (RDDL) another catalog system but more oriented toward
4921 providing metadata for XML namespaces.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004922 <li>the page from the OASIS Technical <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004923 href="http://www.oasis-open.org/committees/entity/">Committee on Entity
4924 Resolution</a> who maintains XML Catalog, you will find pointers to the
4925 specification update, some background and pointers to others tools
4926 providing XML Catalog support</li>
4927 <li>There is a <a href="buildDocBookCatalog">shell script</a> to generate
4928 XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
4929 directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
4930 the resources found on the system. Otherwise it will just create
4931 ~/xmlcatalog and ~/dbkxmlcatalog and doing:
Daniel Veillard8594de92003-04-25 10:08:44 +00004932 <p><code>export XML_CATALOG_FILES=$HOME/xmlcatalog</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004933 <p>should allow to process DocBook documentations without requiring
4934 network accesses for the DTD or stylesheets</p>
Daniel Veillard35e937a2002-01-19 22:21:54 +00004935 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004936 <li>I have uploaded <a href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">a
4937 small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
4938 to work fine for me too</li>
4939 <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog
4940 manual page</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004941</ul>
4942
Daniel Veillardf781dba2006-06-09 13:34:49 +00004943<p>If you have suggestions for corrections or additions, simply contact
4944me:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004945
4946<h2><a name="library">The parser interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004947
Daniel Veillardf781dba2006-06-09 13:34:49 +00004948<p>This section is directly intended to help programmers getting bootstrapped
4949using the XML tollkit from the C language. It is not intended to be
4950extensive. I hope the automatically generated documents will provide the
4951completeness required, but as a separate set of documents. The interfaces of
4952the XML parser are by principle low level, Those interested in a higher level
4953API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00004954
Daniel Veillardf781dba2006-06-09 13:34:49 +00004955<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
4956separated from the <a href="html/libxml-htmlparser.html">HTML parser
4957interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00004958
Daniel Veillard88f00ae2000-03-02 00:15:55 +00004959<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004960
Daniel Veillardf781dba2006-06-09 13:34:49 +00004961<p>Usually, the first thing to do is to read an XML input. The parser accepts
4962documents either from in-memory strings or from files. The functions are
4963defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004964<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004965 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00004966 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004967 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004968</dl>
4969<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004970 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004971 <dd><p>Parse an XML document contained in a (possibly compressed)
4972 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004973 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004974</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004975
Daniel Veillardf781dba2006-06-09 13:34:49 +00004976<p>The parser returns a pointer to the document structure (or NULL in case of
4977failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004978
Daniel Veillard88f00ae2000-03-02 00:15:55 +00004979<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +00004980
Daniel Veillardf781dba2006-06-09 13:34:49 +00004981<p>In order for the application to keep the control when the document is
4982being fetched (which is common for GUI based programs) libxml2 provides a
4983push interface, too, as of version 1.8.3. Here are the interface
4984functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00004985<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
4986 void *user_data,
4987 const char *chunk,
4988 int size,
4989 const char *filename);
4990int xmlParseChunk (xmlParserCtxtPtr ctxt,
4991 const char *chunk,
4992 int size,
4993 int terminate);</pre>
4994
Daniel Veillard88f00ae2000-03-02 00:15:55 +00004995<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00004996<pre> FILE *f;
4997
4998 f = fopen(filename, "r");
4999 if (f != NULL) {
5000 int res, size = 1024;
5001 char chars[1024];
5002 xmlParserCtxtPtr ctxt;
5003
5004 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +00005005 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +00005006 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
5007 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +00005008 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +00005009 xmlParseChunk(ctxt, chars, res, 0);
5010 }
5011 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +00005012 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +00005013 xmlFreeParserCtxt(ctxt);
5014 }
5015 }</pre>
5016
Daniel Veillardf781dba2006-06-09 13:34:49 +00005017<p>The HTML parser embedded into libxml2 also has a push interface; the
5018functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00005019
5020<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
5021
Daniel Veillardf781dba2006-06-09 13:34:49 +00005022<p>The tree-building interface makes the parser memory-hungry, first loading
5023the document in memory and then building the tree itself. Reading a document
5024without building the tree is possible using the SAX interfaces (see SAX.h and
5025<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
5026Henstridge's documentation</a>). Note also that the push interface can be
5027limited to SAX: just use the two first arguments of
5028<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00005029
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005030<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005031
Daniel Veillardf781dba2006-06-09 13:34:49 +00005032<p>The other way to get an XML tree in memory is by building it. Basically
5033there is a set of functions dedicated to building new elements. (These are
5034also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
5035code that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005036<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00005037 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +00005038 xmlNodePtr tree, subtree;
5039
5040 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +00005041 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
5042 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
5043 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
5044 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +00005045 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +00005046 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +00005047 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
5048 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
5049 subtree = xmlNewChild(tree, NULL, "image", NULL);
5050 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005051
5052<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005053
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005054<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005055
Daniel Veillardf781dba2006-06-09 13:34:49 +00005056<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
5057code has access to the internal structure of all the elements of the tree.
5058The names should be somewhat simple like <strong>parent</strong>,
5059<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
5060<strong>properties</strong>, etc... For example, still with the previous
5061example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005062<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005063
5064<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +00005065<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005066
Daniel Veillardf781dba2006-06-09 13:34:49 +00005067<p>points to the text node containing the chapter title "The Linux
5068adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005069
Daniel Veillardf781dba2006-06-09 13:34:49 +00005070<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
5071present before the document root, so <code>doc-&gt;children</code> may point
5072to an element which is not the document Root Element; a function
5073<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +00005074
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005075<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005076
Daniel Veillardf781dba2006-06-09 13:34:49 +00005077<p>Functions are provided for reading and writing the document content. Here
5078is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005079<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005080 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
5081 xmlChar *value);</code></dt>
5082 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
5083 The value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005084 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005085</dl>
5086<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005087 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
5088 *name);</code></dt>
5089 <dd><p>This function returns a pointer to new copy of the property
5090 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005091 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005092</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005093
Daniel Veillardf781dba2006-06-09 13:34:49 +00005094<p>Two functions are provided for reading and writing the text associated
5095with elements:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005096<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005097 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
5098 *value);</code></dt>
5099 <dd><p>This function takes an "external" string and converts it to one
5100 text node or possibly to a list of entity and text nodes. All
5101 non-predefined entity references like &amp;Gnome; will be stored
5102 internally as entity nodes, hence the result of the function may not be
5103 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005104 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005105</dl>
5106<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005107 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
5108 inLine);</code></dt>
5109 <dd><p>This function is the inverse of
5110 <code>xmlStringGetNodeList()</code>. It generates a new string
5111 containing the content of the text and entity nodes. Note the extra
5112 argument inLine. If this argument is set to 1, the function will expand
5113 entity references. For example, instead of returning the &amp;Gnome;
5114 XML encoding in the string, it will substitute it with its value (say,
5115 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005116 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005117</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005118
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005119<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005120
5121<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005122<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005123 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
5124 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005125 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005126 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005127</dl>
5128<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005129 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005130 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005131 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005132</dl>
5133<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005134 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005135 <dd><p>Saves the document to a file. In this case, the compression
5136 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005137 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005138</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005139
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005140<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005141
Daniel Veillardf781dba2006-06-09 13:34:49 +00005142<p>The library transparently handles compression when doing file-based
5143accesses. The level of compression on saves can be turned on either globally
5144or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005145<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005146 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005147 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005148 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005149</dl>
5150<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005151 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005152 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005153 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005154</dl>
5155<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005156 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005157 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005158 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005159</dl>
5160<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005161 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005162 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005163 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005164</dl>
5165
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005166<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005167
Daniel Veillardf781dba2006-06-09 13:34:49 +00005168<p>Entities in principle are similar to simple C macros. An entity defines an
5169abbreviation for a given string that you can reuse many times throughout the
5170content of your document. Entities are especially useful when a given string
5171may occur frequently within a document, or to confine the change needed to a
5172document to a restricted area in the internal subset of the document (at the
5173beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005174<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000051752 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +000051763 &lt;!ENTITY xml "Extensible Markup Language"&gt;
51774 ]&gt;
51785 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000051796 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +000051807 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005181
Daniel Veillardf781dba2006-06-09 13:34:49 +00005182<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
5183its name with '&amp;' and following it by ';' without any spaces added. There
5184are 5 predefined entities in libxml2 allowing you to escape characters with
5185predefined meaning in some parts of the xml document content:
5186<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
5187for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
5188<strong>&amp;quot;</strong> for the character '"', and
5189<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005190
Daniel Veillardf781dba2006-06-09 13:34:49 +00005191<p>One of the problems related to entities is that you may want the parser to
5192substitute an entity's content so that you can see the replacement text in
5193your application. Or you may prefer to keep entity references as such in the
5194content to be able to save the document back without losing this usually
5195precious information (if the user went through the pain of explicitly
5196defining entities, he may have a a rather negative attitude if you blindly
5197substitute them as saving time). The <a
5198href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a>
5199function allows you to check and change the behaviour, which is to not
5200substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005201
Daniel Veillardf781dba2006-06-09 13:34:49 +00005202<p>Here is the DOM tree built by libxml2 for the previous document in the
5203default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005204<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005205DOCUMENT
5206version=1.0
5207 ELEMENT EXAMPLE
5208 TEXT
5209 content=
5210 ENTITY_REF
5211 INTERNAL_GENERAL_ENTITY xml
5212 content=Extensible Markup Language
5213 TEXT
5214 content=</pre>
5215
5216<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005217<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005218DOCUMENT
5219version=1.0
5220 ELEMENT EXAMPLE
5221 TEXT
5222 content= Extensible Markup Language</pre>
5223
Daniel Veillardf781dba2006-06-09 13:34:49 +00005224<p>So, entities or no entities? Basically, it depends on your use case. I
5225suggest that you keep the non-substituting default behaviour and avoid using
5226entities in your XML document or data if you are not willing to handle the
5227entity references elements in the DOM tree.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005228
Daniel Veillardf781dba2006-06-09 13:34:49 +00005229<p>Note that at save time libxml2 enforces the conversion of the predefined
5230entities where necessary to prevent well-formedness problems, and will also
5231transparently replace those with chars (i.e. it will not generate entity
5232reference elements in the DOM tree or call the reference() SAX callback when
5233finding them in the input).</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005234
Daniel Veillardf781dba2006-06-09 13:34:49 +00005235<p><span style="background-color: #FF0000">WARNING</span>: handling entities
5236on top of the libxml2 SAX interface is difficult!!! If you plan to use
5237non-predefined entities in your documents, then the learning curve to handle
5238then using the SAX API may be long. If you plan to use complex documents, I
5239strongly suggest you consider using the DOM interface instead and let libxml
5240deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +00005241
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005242<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005243
Daniel Veillard8a469172003-06-12 16:05:07 +00005244<p>The libxml2 library implements <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005245href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
5246recognizing namespace constructs in the input, and does namespace lookup
5247automatically when building the DOM tree. A namespace declaration is
5248associated with an in-memory structure and all elements or attributes within
5249that namespace point to it. Hence testing the namespace is a simple and fast
5250equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005251
Daniel Veillardf781dba2006-06-09 13:34:49 +00005252<p>I suggest that people using libxml2 use a namespace, and declare it in the
5253root element of their document as the default namespace. Then they don't need
5254to use the prefix in the content but we will have a basis for future semantic
5255refinement and merging of data from different sources. This doesn't increase
5256the size of the XML output significantly, but significantly increases its
5257value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005258<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
5259 &lt;elem1&gt;...&lt;/elem1&gt;
5260 &lt;elem2&gt;...&lt;/elem2&gt;
5261&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005262
Daniel Veillardf781dba2006-06-09 13:34:49 +00005263<p>The namespace value has to be an absolute URL, but the URL doesn't have to
5264point to any existing resource on the Web. It will bind all the element and
5265attributes with that URL. I suggest to use an URL within a domain you
5266control, and that the URL should contain some kind of version information if
5267possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a
5268good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +00005269
Daniel Veillardf781dba2006-06-09 13:34:49 +00005270<p>Then when you load a file, make sure that a namespace carrying the
5271version-independent prefix is installed on the root element of your document,
5272and if the version information don't match something you know, warn the user
5273and be liberal in what you accept as the input. Also do *not* try to base
5274namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
5275same as &lt;bar:text&gt; in another document. What really matters is the URI
5276associated with the element or the attribute, not the prefix string (which is
5277just a shortcut for the full URI). In libxml, element and attributes have an
5278<code>ns</code> field pointing to an xmlNs structure detailing the namespace
5279prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005280
5281<p>@@Interfaces@@</p>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00005282<pre>xmlNodePtr node;
Daniel Veillardfc8dc352003-10-18 09:07:46 +00005283if(!strncmp(node-&gt;name,"mytag",5)
5284 &amp;&amp; node-&gt;ns
5285 &amp;&amp; !strcmp(node-&gt;ns-&gt;href,"http://www.mysite.com/myns/1.0")) {
5286 ...
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00005287}</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005288
Daniel Veillardf781dba2006-06-09 13:34:49 +00005289<p>Usually people object to using namespaces together with validity checking.
5290I will try to make sure that using namespaces won't break validity checking,
5291so even if you plan to use or currently are using validation I strongly
5292suggest adding namespaces to your document. A default namespace scheme
5293<code>xmlns="http://...."</code> should not break validity even on less
5294flexible parsers. Using namespaces to mix and differentiate content coming
5295from multiple DTDs will certainly break current validation schemes. To check
5296such documents one needs to use schema-validation, which is supported in
5297libxml2 as well. See <a href="http://www.relaxng.org/">relagx-ng</a> and <a
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00005298href="http://www.w3c.org/XML/Schema">w3c-schema</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005299
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005300<h2><a name="Upgrading">Upgrading 1.x code</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005301
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005302<p>Incompatible changes:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005303
Daniel Veillardf781dba2006-06-09 13:34:49 +00005304<p>Version 2 of libxml2 is the first version introducing serious backward
5305incompatible changes. The main goals were:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005306<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005307 <li>a general cleanup. A number of mistakes inherited from the very early
5308 versions couldn't be changed due to compatibility constraints. Example
5309 the "childs" element in the nodes.</li>
5310 <li>Uniformization of the various nodes, at least for their header and link
5311 parts (doc, parent, children, prev, next), the goal is a simpler
5312 programming model and simplifying the task of the DOM implementors.</li>
5313 <li>better conformances to the XML specification, for example version 1.x
5314 had an heuristic to try to detect ignorable white spaces. As a result the
5315 SAX event generated were ignorableWhitespace() while the spec requires
5316 character() in that case. This also mean that a number of DOM node
5317 containing blank text may populate the DOM tree which were not present
5318 before.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005319</ul>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005320
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005321<h3>How to fix libxml-1.x code:</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005322
Daniel Veillardf781dba2006-06-09 13:34:49 +00005323<p>So client code of libxml designed to run with version 1.x may have to be
5324changed to compile against version 2.x of libxml. Here is a list of changes
5325that I have collected, they may not be sufficient, so in case you find other
5326change which are required, <a href="mailto:Daniel.Veillard@w3.org">drop me a
5327mail</a>:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005328<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005329 <li>The package name have changed from libxml to libxml2, the library name
5330 is now -lxml2 . There is a new xml2-config script which should be used to
5331 select the right parameters libxml2</li>
5332 <li>Node <strong>childs</strong> field has been renamed
5333 <strong>children</strong> so s/childs/children/g should be applied
5334 (probability of having "childs" anywhere else is close to 0+</li>
5335 <li>The document don't have anymore a <strong>root</strong> element it has
5336 been replaced by <strong>children</strong> and usually you will get a
5337 list of element here. For example a Dtd element for the internal subset
5338 and it's declaration may be found in that list, as well as processing
5339 instructions or comments found before or after the document root element.
5340 Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of
5341 a document. Alternatively if you are sure to not reference DTDs nor have
5342 PIs or comments before or after the root element
5343 s/-&gt;root/-&gt;children/g will probably do it.</li>
5344 <li>The white space issue, this one is more complex, unless special case of
5345 validating parsing, the line breaks and spaces usually used for indenting
5346 and formatting the document content becomes significant. So they are
5347 reported by SAX and if your using the DOM tree, corresponding nodes are
5348 generated. Too approach can be taken:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005349 <ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005350 <li>lazy one, use the compatibility call
5351 <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are
5352 relying on a special (and possibly broken) set of heuristics of
5353 libxml to detect ignorable blanks. Don't complain if it breaks or
5354 make your application not 100% clean w.r.t. to it's input.</li>
5355 <li>the Right Way: change you code to accept possibly insignificant
5356 blanks characters, or have your tree populated with weird blank text
5357 nodes. You can spot them using the commodity function
5358 <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank
5359 nodes.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005360 </ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005361 <p>Note also that with the new default the output functions don't add any
5362 extra indentation when saving a tree in order to be able to round trip
5363 (read and save) without inflating the document with extra formatting
5364 chars.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005365 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005366 <li>The include path has changed to $prefix/libxml/ and the includes
5367 themselves uses this new prefix in includes instructions... If you are
5368 using (as expected) the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005369 <pre>xml2-config --cflags</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005370 <p>output to generate you compile commands this will probably work out of
5371 the box</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005372 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005373 <li>xmlDetectCharEncoding takes an extra argument indicating the length in
5374 byte of the head of the document available for character detection.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005375</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005376
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005377<h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005378
Daniel Veillardf781dba2006-06-09 13:34:49 +00005379<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released
5380to allow smooth upgrade of existing libxml v1code while retaining
5381compatibility. They offers the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005382<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005383 <li>similar include naming, one should use
5384 <strong>#include&lt;libxml/...&gt;</strong> in both cases.</li>
5385 <li>similar identifiers defined via macros for the child and root fields:
5386 respectively <strong>xmlChildrenNode</strong> and
5387 <strong>xmlRootNode</strong></li>
5388 <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be
5389 inserted once in the client code</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005390</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005391
Daniel Veillardf781dba2006-06-09 13:34:49 +00005392<p>So the roadmap to upgrade your existing libxml applications is the
5393following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005394<ol>
5395 <li>install the libxml-1.8.8 (and libxml-devel-1.8.8) packages</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005396 <li>find all occurrences where the xmlDoc <strong>root</strong> field is
5397 used and change it to <strong>xmlRootNode</strong></li>
5398 <li>similarly find all occurrences where the xmlNode
5399 <strong>childs</strong> field is used and change it to
5400 <strong>xmlChildrenNode</strong></li>
5401 <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your
5402 <strong>main()</strong> or in the library init entry point</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005403 <li>Recompile, check compatibility, it should still work</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005404 <li>Change your configure script to look first for xml2-config and fall
5405 back using xml-config . Use the --cflags and --libs output of the command
5406 as the Include and Linking parameters needed to use libxml.</li>
5407 <li>install libxml2-2.3.x and libxml2-devel-2.3.x (libxml-1.8.y and
5408 libxml-devel-1.8.y can be kept simultaneously)</li>
5409 <li>remove your config.cache, relaunch your configuration mechanism, and
5410 recompile, if steps 2 and 3 were done right it should compile as-is</li>
5411 <li>Test that your application is still running correctly, if not this may
5412 be due to extra empty nodes due to formating spaces being kept in libxml2
5413 contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your
5414 code before calling the parser (next to
5415 <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005416</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005417
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005418<p>Following those steps should work. It worked for some of my own code.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005419
Daniel Veillardf781dba2006-06-09 13:34:49 +00005420<p>Let me put some emphasis on the fact that there is far more changes from
5421libxml 1.x to 2.x than the ones you may have to patch for. The overall code
5422has been considerably cleaned up and the conformance to the XML specification
5423has been drastically improved too. Don't take those changes as an excuse to
5424not upgrade, it may cost a lot on the long term ...</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005425
Daniel Veillard52dcab32001-10-30 12:51:17 +00005426<h2><a name="Thread">Thread safety</a></h2>
5427
Daniel Veillardf781dba2006-06-09 13:34:49 +00005428<p>Starting with 2.4.7, libxml2 makes provisions to ensure that concurrent
5429threads can safely work in parallel parsing different documents. There is
5430however a couple of things to do to ensure it:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +00005431<ul>
5432 <li>configure the library accordingly using the --with-threads options</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005433 <li>call xmlInitParser() in the "main" thread before using any of the
5434 libxml2 API (except possibly selecting a different memory allocator)</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +00005435</ul>
5436
Daniel Veillardf781dba2006-06-09 13:34:49 +00005437<p>Note that the thread safety cannot be ensured for multiple threads sharing
5438the same document, the locking must be done at the application level, libxml
5439exports a basic mutex and reentrant mutexes API in &lt;libxml/threads.h&gt;.
5440The parts of the library checked for thread safety are:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +00005441<ul>
5442 <li>concurrent loading</li>
5443 <li>file access resolution</li>
5444 <li>catalog access</li>
5445 <li>catalog building</li>
5446 <li>entities lookup/accesses</li>
5447 <li>validation</li>
5448 <li>global variables per-thread override</li>
5449 <li>memory handling</li>
5450</ul>
5451
Daniel Veillard28fdf8b2011-03-07 08:12:39 +08005452<p>XPath has been tested for threaded usage on non-modified document
5453 for example when using libxslt, but make 100% sure the documents
5454 are accessed read-only !</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +00005455
Daniel Veillard35008381999-10-25 13:15:52 +00005456<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005457
Daniel Veillardf781dba2006-06-09 13:34:49 +00005458<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
5459Object Model</em>; this is an API for accessing XML or HTML structured
5460documents. Native support for DOM in Gnome is on the way (module gnome-dom),
5461and will be based on gnome-xml. This will be a far cleaner interface to
5462manipulate XML files within Gnome since it won't expose the internal
5463structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00005464
Daniel Veillard8a469172003-06-12 16:05:07 +00005465<p>The current DOM implementation on top of libxml2 is the <a
Daniel Veillarda4f85b92009-03-25 10:45:20 +00005466href="http://svn.gnome.org/viewvc/gdome2/trunk/">gdome2 Gnome module</a>, this
Daniel Veillardf781dba2006-06-09 13:34:49 +00005467is a full DOM interface, thanks to Paolo Casarini, check the <a
William M. Brack43a87292007-02-15 20:41:02 +00005468href="http://gdome2.cs.unibo.it/">Gdome2 homepage</a> for more
5469information.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005470
Daniel Veillard35008381999-10-25 13:15:52 +00005471<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005472
Daniel Veillardf781dba2006-06-09 13:34:49 +00005473<p>Here is a real size example, where the actual content of the application
5474data is not kept in the DOM tree but uses internal structures. It is based on
5475a proposal to keep a database of jobs related to Gnome, with an XML based
5476storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
5477base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005478<pre>&lt;?xml version="1.0"?&gt;
5479&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
5480 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005481
Daniel Veillard60979bd2000-07-10 12:17:33 +00005482 &lt;gjob:Job&gt;
5483 &lt;gjob:Project ID="3"/&gt;
5484 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
5485 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005486
Daniel Veillard60979bd2000-07-10 12:17:33 +00005487 &lt;gjob:Update&gt;
5488 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
5489 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
5490 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
5491 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005492
Daniel Veillard60979bd2000-07-10 12:17:33 +00005493 &lt;gjob:Developers&gt;
5494 &lt;gjob:Developer&gt;
5495 &lt;/gjob:Developer&gt;
5496 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005497
Daniel Veillard60979bd2000-07-10 12:17:33 +00005498 &lt;gjob:Contact&gt;
5499 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
5500 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
5501 &lt;gjob:Company&gt;
5502 &lt;/gjob:Company&gt;
5503 &lt;gjob:Organisation&gt;
5504 &lt;/gjob:Organisation&gt;
5505 &lt;gjob:Webpage&gt;
5506 &lt;/gjob:Webpage&gt;
5507 &lt;gjob:Snailmail&gt;
5508 &lt;/gjob:Snailmail&gt;
5509 &lt;gjob:Phone&gt;
5510 &lt;/gjob:Phone&gt;
5511 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005512
Daniel Veillard60979bd2000-07-10 12:17:33 +00005513 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005514 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +00005515 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005516
Daniel Veillard60979bd2000-07-10 12:17:33 +00005517 &lt;gjob:Skills&gt;
5518 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005519
Daniel Veillard60979bd2000-07-10 12:17:33 +00005520 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005521 A GNOME based system that will allow a superuser to configure
5522 compressed and uncompressed files and/or file systems to be backed
5523 up with a supported media in the system. This should be able to
5524 perform via find commands generating a list of files that are passed
5525 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
5526 or via operations performed on the filesystem itself. Email
5527 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +00005528 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005529
Daniel Veillard60979bd2000-07-10 12:17:33 +00005530 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00005531
Daniel Veillard60979bd2000-07-10 12:17:33 +00005532 &lt;/gjob:Jobs&gt;
5533&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005534
Daniel Veillardf781dba2006-06-09 13:34:49 +00005535<p>While loading the XML file into an internal DOM tree is a matter of
5536calling only a couple of functions, browsing the tree to gather the data and
5537generate the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005538
Daniel Veillardf781dba2006-06-09 13:34:49 +00005539<p>The suggested principle is to be tolerant with respect to the input
5540structure. For example, the ordering of the attributes is not significant,
5541the XML specification is clear about it. It's also usually a good idea not to
5542depend on the order of the children of a given node, unless it really makes
5543things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005544<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +00005545 * A person record
5546 */
5547typedef struct person {
5548 char *name;
5549 char *email;
5550 char *company;
5551 char *organisation;
5552 char *smail;
5553 char *webPage;
5554 char *phone;
5555} person, *personPtr;
5556
5557/*
5558 * And the code needed to parse it
5559 */
5560personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
5561 personPtr ret = NULL;
5562
5563DEBUG("parsePerson\n");
5564 /*
5565 * allocate the struct
5566 */
5567 ret = (personPtr) malloc(sizeof(person));
5568 if (ret == NULL) {
5569 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00005570 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00005571 }
5572 memset(ret, 0, sizeof(person));
5573
5574 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00005575 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00005576 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +00005577 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
5578 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5579 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
5580 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5581 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00005582 }
5583
5584 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00005585}</pre>
5586
Daniel Veillard91e9d582001-02-26 07:31:12 +00005587<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00005588<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005589 <li>Usually a recursive parsing style is the more convenient one: XML data
5590 is by nature subject to repetitive constructs and usually exhibits highly
5591 structured patterns.</li>
5592 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
5593 i.e. the pointer to the global XML document and the namespace reserved to
5594 the application. Document wide information are needed for example to
5595 decode entities and it's a good coding practice to define a namespace for
5596 your application set of data and test that the element and attributes
5597 you're analyzing actually pertains to your application space. This is
5598 done by a simple equality test (cur-&gt;ns == ns).</li>
5599 <li>To retrieve text and attributes value, you can use the function
5600 <em>xmlNodeListGetString</em> to gather all the text and entity reference
5601 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +00005602</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005603
Daniel Veillardf781dba2006-06-09 13:34:49 +00005604<p>Here is another piece of code used to parse another level of the
5605structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005606<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00005607/*
Daniel Veillard14fff061999-06-22 21:49:07 +00005608 * a Description for a Job
5609 */
5610typedef struct job {
5611 char *projectID;
5612 char *application;
5613 char *category;
5614 personPtr contact;
5615 int nbDevelopers;
5616 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
5617} job, *jobPtr;
5618
5619/*
5620 * And the code needed to parse it
5621 */
5622jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
5623 jobPtr ret = NULL;
5624
5625DEBUG("parseJob\n");
5626 /*
5627 * allocate the struct
5628 */
5629 ret = (jobPtr) malloc(sizeof(job));
5630 if (ret == NULL) {
5631 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00005632 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00005633 }
5634 memset(ret, 0, sizeof(job));
5635
5636 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00005637 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00005638 while (cur != NULL) {
5639
Daniel Veillard60979bd2000-07-10 12:17:33 +00005640 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
5641 ret-&gt;projectID = xmlGetProp(cur, "ID");
5642 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +00005643 fprintf(stderr, "Project has no ID\n");
5644 }
5645 }
Daniel Veillard60979bd2000-07-10 12:17:33 +00005646 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
5647 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5648 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
5649 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5650 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
5651 ret-&gt;contact = parsePerson(doc, ns, cur);
5652 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00005653 }
5654
5655 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00005656}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +00005657
Daniel Veillardf781dba2006-06-09 13:34:49 +00005658<p>Once you are used to it, writing this kind of code is quite simple, but
5659boring. Ultimately, it could be possible to write stubbers taking either C
5660data structure definitions, a set of XML examples or an XML DTD and produce
5661the code needed to import and export the content between C data and XML
5662storage. This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005663
Daniel Veillardf781dba2006-06-09 13:34:49 +00005664<p>Feel free to use <a href="example/gjobread.c">the code for the full C
5665parsing example</a> as a template, it is also available with Makefile in the
William M. Brack43a87292007-02-15 20:41:02 +00005666Gnome SVN base under libxml2/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005667
Daniel Veillardc310d562000-06-23 18:32:15 +00005668<h2><a name="Contributi">Contributions</a></h2>
5669<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005670 <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of
5671 patches, Gary Pennington worked on the validation API, threading support
5672 and Solaris port.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005673 <li>John Fleck helps maintaining the documentation and man pages.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005674 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
5675 maintainer of the Windows port, <a
5676 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
5677 binaries</a></li>
5678 <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a> provides
5679 <a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillarde356c282001-03-10 12:32:04 +00005680 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005681 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
5682 Sergeant</a> developed <a
5683 href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
5684 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
5685 application server</a></li>
5686 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a
5687 href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
5688 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
5689 documentation</li>
5690 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
Daniel Veillardaf43f632002-03-08 15:05:20 +00005691 href="http://xmlsoft.org/messages/0488.html">man pages</a></li>
Daniel Veillard5168dbf2001-07-07 00:18:23 +00005692 <li>there is a module for <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005693 href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
5694 in OpenNSD/AOLServer</a></li>
5695 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provided the
5696 first version of libxml/libxslt <a
Daniel Veillard2d347fa2002-03-17 10:34:11 +00005697 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
Daniel Veillard1aadc442001-11-28 13:10:32 +00005698 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005699 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
5700 libxml2</a> with Kylix and Delphi and other Pascal compilers</li>
5701 <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a> implemented the
5702 <a href="http://www.w3.org/Signature/">XML Canonicalization and XML
5703 Digital Signature</a> <a
5704 href="http://www.aleksey.com/xmlsec/">implementations for libxml2</a></li>
5705 <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> and
5706 contributors maintain <a href="http://tclxml.sourceforge.net/">tcl
5707 bindings for libxml2 and libxslt</a>, as well as <a
5708 href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for
5709 xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>
5710 a GUI for xsltproc.</li>
Daniel Veillardc310d562000-06-23 18:32:15 +00005711</ul>
5712
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005713<p></p>
Daniel Veillardccb09631998-10-27 06:21:04 +00005714</body>
5715</html>