blob: 4059fb76ebdd2475de6665e040d36e2df252f358 [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
Nick Wellnhofer8bbe4502017-06-17 16:15:09 +0200535irc.gnome.org (port 6667) usually has a few people 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 Veillard18890f42018-03-05 17:09:43 +0100712<h3>v2.9.8: Mar 05 2018</h3>
713<ul>
714 <li>Portability:<br/>
715 python: remove single use of _PyVerify_fd (Patrick Welche),<br/>
716 Build more test executables on Windows/MSVC (Nick Wellnhofer),<br/>
717 Stop including ansidecl.h (Nick Wellnhofer),<br/>
718 Fix libz and liblzma detection (Nick Wellnhofer),<br/>
719 Revert "Compile testapi with -Wno-unused-function" (Nick Wellnhofer)<br/>
720 </li>
721
722 <li>Bug Fixes:<br/>
723 Fix xmlParserEntityCheck (Nick Wellnhofer),<br/>
724 Halt parser in case of encoding error (Nick Wellnhofer),<br/>
725 Clear entity content in case of errors (Nick Wellnhofer),<br/>
726 Change calls to xmlCharEncInput to set flush false when not final call. Having flush incorrectly set to true causes errors for ICU. (Joel Hockey),<br/>
727 Fix buffer over-read in xmlParseNCNameComplex (Nick Wellnhofer),<br/>
728 Fix ICU library filenames on Windows/MSVC (Nick Wellnhofer),<br/>
729 Fix xmlXPathIsNaN broken by recent commit (Nick Wellnhofer),<br/>
730 Fix -Wenum-compare warnings (Nick Wellnhofer),<br/>
731 Fix callback signature in testapi.c (Nick Wellnhofer),<br/>
732 Fix unused parameter warning without ICU (Nick Wellnhofer),<br/>
733 Fix IO callback signatures (Nick Wellnhofer),<br/>
734 Fix misc callback signatures (Nick Wellnhofer),<br/>
735 Fix list callback signatures (Nick Wellnhofer),<br/>
736 Fix hash callback signatures (Nick Wellnhofer),<br/>
737 Refactor name and type signature for xmlNop (Vlad Tsyrklevich),<br/>
738 Fixed ICU to set flush correctly and provide pivot buffer. (Joel Hockey),<br/>
739 Skip EBCDIC tests if EBCDIC isn't supported (Nick Wellnhofer)<br/>
740 </li>
741
742 <li>Improvements:<br/>
743 Disable pointer-overflow UBSan checks under Travis (Nick Wellnhofer),<br/>
744 Improve handling of context input_id (Daniel Veillard),<br/>
745 Add resource file to Windows DLL (ccpaging),<br/>
746 Run Travis tests with -Werror (Nick Wellnhofer),<br/>
747 Build with "-Wall -Wextra" (Nick Wellnhofer),<br/>
748 Fix -Wtautological-pointer-compare warnings (Nick Wellnhofer),<br/>
749 Remove unused AC_CHECKs (Nick Wellnhofer),<br/>
750 Update information about contributing (Nick Wellnhofer),<br/>
751 Fix -Wmisleading-indentation warnings (Nick Wellnhofer),<br/>
752 Don't touch CFLAGS in configure.ac (Nick Wellnhofer),<br/>
753 Ignore function pointer cast warnings (Nick Wellnhofer),<br/>
754 Simplify XPath NaN, inf and -0 handling (Nick Wellnhofer),<br/>
755 Introduce xmlPosixStrdup and update xmlMemStrdup (Nick Wellnhofer),<br/>
756 Add test for ICU flush and pivot buffer (Nick Wellnhofer),<br/>
757 Compile testapi with -Wno-unused-function (Nick Wellnhofer)<br/>
758 </li>
759</ul>
Daniel Veillardbc5a5d62017-11-02 21:26:55 +0100760<h3>2.9.7: Nov 02 2017</h3>
761<ul>
762 <li>Documentation:<br/>
763 xmlcatalog: refresh man page wrt. quering system catalog easily (Jan Pokorný)<br/>
764 </li>
765
766 <li>Portability:<br/>
767 Fix deprecated Travis compiler flag (Nick Wellnhofer),<br/>
768 Add declaration for DllMain (J. Peter Mugaas),<br/>
769 Fix preprocessor conditional in threads.h (J. Peter Mugaas),<br/>
770 Fix pointer comparison warnings on 64-bit Windows (J. Peter Mugaas),<br/>
771 Fix macro redefinition warning (J. Peter Mugaas),<br/>
772 Default to native threads on MinGW-w64 (Nick Wellnhofer),<br/>
773 Simplify Windows IO functions (Nick Wellnhofer),<br/>
774 Fix runtest on Windows (Nick Wellnhofer),<br/>
775 socklen_t is always int on Windows (Nick Wellnhofer),<br/>
776 Don't redefine socket error codes on Windows (Nick Wellnhofer),<br/>
777 Fix pointer/int cast warnings on 64-bit Windows (Nick Wellnhofer),<br/>
778 Fix Windows compiler warnings in xmlCanonicPath (Nick Wellnhofer)<br/>
779 </li>
780
781 <li>Bug Fixes:<br/>
782 xmlcatalog: restore ability to query system catalog easily (Jan Pokorný),<br/>
783 Fix comparison of nodesets to strings (Nick Wellnhofer)<br/>
784 </li>
785
786 <li>Improvements:<br/>
787 Add Makefile rules to rebuild HTML man pages (Nick Wellnhofer),<br/>
788 Fix mixed decls and code in timsort.h (Nick Wellnhofer),<br/>
789 Rework handling of return values in thread tests (Nick Wellnhofer),<br/>
790 Fix unused variable warnings in testrecurse (Nick Wellnhofer),<br/>
791 Fix -Wimplicit-fallthrough warnings (J. Peter Mugaas),<br/>
792 Upgrade timsort.h to latest revision (Nick Wellnhofer),<br/>
793 Increase warning level to /W3 under MSVC (Nick Wellnhofer),<br/>
794 Fix a couple of warnings in dict.c and threads.c (Nick Wellnhofer),<br/>
795 Update .gitignore for Windows (Nick Wellnhofer),<br/>
796 Fix unused variable warnings in nanohttp.c (Nick Wellnhofer),<br/>
797 Fix the Windows header mess (Nick Wellnhofer),<br/>
798 Don't include winsock2.h in xmllint.c (Nick Wellnhofer),<br/>
799 Remove generated file python/setup.py from version control (Nick Wellnhofer),<br/>
800 Use __linux__ macro in generated code (Nick Wellnhofer)<br/>
801 </li>
802
803</ul>
Daniel Veillard4b4d3d82017-10-06 09:00:53 +0200804<h3>v2.9.6: Oct 06 2017</h3>
805<ul>
806 <li>Portability:<br/>
807 Change preprocessor OS tests to __linux__ (Nick Wellnhofer)<br/>
808 </li>
809
810 <li>Bug Fixes:<br/>
811 Fix XPath stack frame logic (Nick Wellnhofer),<br/>
812 Report undefined XPath variable error message (Nick Wellnhofer),<br/>
813 Fix regression with librsvg (Nick Wellnhofer),<br/>
814 Handle more invalid entity values in recovery mode (Nick Wellnhofer),<br/>
815 Fix structured validation errors (Nick Wellnhofer),<br/>
816 Fix memory leak in LZMA decompressor (Nick Wellnhofer),<br/>
817 Set memory limit for LZMA decompression (Nick Wellnhofer),<br/>
818 Handle illegal entity values in recovery mode (Nick Wellnhofer),<br/>
819 Fix debug dump of streaming XPath expressions (Nick Wellnhofer),<br/>
820 Fix memory leak in nanoftp (Nick Wellnhofer),<br/>
821 Fix memory leaks in SAX1 parser (Nick Wellnhofer)<br/>
822 </li>
823</ul>
Daniel Veillard29601782017-09-04 15:38:47 +0200824<h3>v2.9.5: Sep 04 2017</h3>
825<ul>
826
827 <li>Security:<br/>
828 Detect infinite recursion in parameter entities (Nick Wellnhofer),<br/>
829 Fix handling of parameter-entity references (Nick Wellnhofer),<br/>
830 Disallow namespace nodes in XPointer ranges (Nick Wellnhofer),<br/>
831 Fix XPointer paths beginning with range-to (Nick Wellnhofer)<br/>
832 </li>
833
834 <li>Documentation:<br/>
835 Documentation fixes (Nick Wellnhofer),<br/>
836 Spelling and grammar fixes (Nick Wellnhofer)<br/>
837 </li>
838
839 <li>Portability:<br/>
840 Adding README.zOS to list of extra files for the release (Daniel Veillard),<br/>
841 Description of work needed to compile on zOS (Stéphane Michaut),<br/>
842 Porting libxml2 on zOS encoding of code (Stéphane Michaut),<br/>
843 small changes for OS/400 (Patrick Monnerat),<br/>
844 relaxng.c, xmlschemas.c: Fix build on pre-C99 compilers (Chun-wei Fan)<br/>
845 </li>
846
847 <li>Bug Fixes:<br/>
848 Problem resolving relative URIs (Daniel Veillard),<br/>
849 Fix unwanted warnings when switching encodings (Nick Wellnhofer),<br/>
850 Fix signature of xmlSchemaAugmentImportedIDC (Daniel Veillard),<br/>
851 Heap-buffer-overflow read of size 1 in xmlFAParsePosCharGroup (David Kilzer),<br/>
852 Fix NULL pointer deref in xmlFAParseCharClassEsc (Nick Wellnhofer),<br/>
853 Fix infinite loops with push parser in recovery mode (Nick Wellnhofer),<br/>
854 Send xmllint usage error to stderr (Nick Wellnhofer),<br/>
855 Fix NULL deref in xmlParseExternalEntityPrivate (Nick Wellnhofer),<br/>
856 Make sure not to call IS_BLANK_CH when parsing the DTD (Nick Wellnhofer),<br/>
857 Fix xmlHaltParser (Nick Wellnhofer),<br/>
858 Fix pathological performance when outputting charrefs (Nick Wellnhofer),<br/>
859 Fix invalid-source-encoding warnings in testWriter.c (Nick Wellnhofer),<br/>
860 Fix duplicate SAX callbacks for entity content (David Kilzer),<br/>
861 Treat URIs with scheme as absolute in C14N (Nick Wellnhofer),<br/>
862 Fix copy-paste errors in error messages (Nick Wellnhofer),<br/>
863 Fix sanity check in htmlParseNameComplex (Nick Wellnhofer),<br/>
864 Fix potential infinite loop in xmlStringLenDecodeEntities (Nick Wellnhofer),<br/>
865 Reset parser input pointers on encoding failure (Nick Wellnhofer),<br/>
866 Fix memory leak in xmlParseEntityDecl error path (Nick Wellnhofer),<br/>
867 Fix xmlBuildRelativeURI for URIs starting with './' (Nick Wellnhofer),<br/>
868 Fix type confusion in xmlValidateOneNamespace (Nick Wellnhofer),<br/>
869 Fix memory leak in xmlStringLenGetNodeList (Nick Wellnhofer),<br/>
870 Fix NULL pointer deref in xmlDumpElementContent (Daniel Veillard),<br/>
871 Fix memory leak in xmlBufAttrSerializeTxtContent (Nick Wellnhofer),<br/>
872 Stop parser on unsupported encodings (Nick Wellnhofer),<br/>
873 Check for integer overflow in memory debug code (Nick Wellnhofer),<br/>
874 Fix buffer size checks in xmlSnprintfElementContent (Nick Wellnhofer),<br/>
875 Avoid reparsing in xmlParseStartTag2 (Nick Wellnhofer),<br/>
876 Fix undefined behavior in xmlRegExecPushStringInternal (Nick Wellnhofer),<br/>
877 Check XPath exponents for overflow (Nick Wellnhofer),<br/>
878 Check for overflow in xmlXPathIsPositionalPredicate (Nick Wellnhofer),<br/>
879 Fix spurious error message (Nick Wellnhofer),<br/>
880 Fix memory leak in xmlCanonicPath (Nick Wellnhofer),<br/>
881 Fix memory leak in xmlXPathCompareNodeSetValue (Nick Wellnhofer),<br/>
882 Fix memory leak in pattern error path (Nick Wellnhofer),<br/>
883 Fix memory leak in parser error path (Nick Wellnhofer),<br/>
884 Fix memory leaks in XPointer error paths (Nick Wellnhofer),<br/>
885 Fix memory leak in xmlXPathNodeSetMergeAndClear (Nick Wellnhofer),<br/>
886 Fix memory leak in XPath filter optimizations (Nick Wellnhofer),<br/>
887 Fix memory leaks in XPath error paths (Nick Wellnhofer),<br/>
888 Do not leak the new CData node if adding fails (David Tardon),<br/>
889 Prevent unwanted external entity reference (Neel Mehta),<br/>
890 Increase buffer space for port in HTTP redirect support (Daniel Veillard),<br/>
891 Fix more NULL pointer derefs in xpointer.c (Nick Wellnhofer),<br/>
892 Avoid function/data pointer conversion in xpath.c (Nick Wellnhofer),<br/>
893 Fix format string warnings (Nick Wellnhofer),<br/>
894 Disallow namespace nodes in XPointer points (Nick Wellnhofer),<br/>
895 Fix comparison with root node in xmlXPathCmpNodes (Nick Wellnhofer),<br/>
896 Fix attribute decoding during XML schema validation (Alex Henrie),<br/>
897 Fix NULL pointer deref in XPointer range-to (Nick Wellnhofer)<br/>
898 </li>
899
900 <li>Improvements:<br/>
901 Updating the spec file to reflect Fedora 24 (Daniel Veillard),<br/>
902 Add const in five places to move 1 KiB to .rdata (Bruce Dawson),<br/>
903 Fix missing part of comment for function xmlXPathEvalExpression() (Daniel Veillard),<br/>
904 Get rid of "blanks wrapper" for parameter entities (Nick Wellnhofer),<br/>
905 Simplify handling of parameter entity references (Nick Wellnhofer),<br/>
906 Deduplicate code in encoding.c (Nick Wellnhofer),<br/>
907 Make HTML parser functions take const pointers (Nick Wellnhofer),<br/>
908 Build test programs only when needed (Nick Wellnhofer),<br/>
909 Fix doc/examples/index.py (Nick Wellnhofer),<br/>
910 Fix compiler warnings in threads.c (Nick Wellnhofer),<br/>
911 Fix empty-body warning in nanohttp.c (Nick Wellnhofer),<br/>
912 Fix cast-align warnings (Nick Wellnhofer),<br/>
913 Fix unused-parameter warnings (Nick Wellnhofer),<br/>
914 Rework entity boundary checks (Nick Wellnhofer),<br/>
915 Don't switch encoding for internal parameter entities (Nick Wellnhofer),<br/>
916 Merge duplicate code paths handling PE references (Nick Wellnhofer),<br/>
917 Test SAX2 callbacks with entity substitution (Nick Wellnhofer),<br/>
918 Support catalog and threads tests under --without-sax1 (Nick Wellnhofer),<br/>
919 Misc fixes for 'make tests' (Nick Wellnhofer),<br/>
920 Initialize keepBlanks in HTML parser (Nick Wellnhofer),<br/>
921 Add test cases for bug 758518 (David Kilzer),<br/>
922 Fix compiler warning in htmlParseElementInternal (Nick Wellnhofer),<br/>
923 Remove useless check in xmlParseAttributeListDecl (Nick Wellnhofer),<br/>
924 Allow zero sized memory input buffers (Nick Wellnhofer),<br/>
925 Add TODO comment in xmlSwitchEncoding (Nick Wellnhofer),<br/>
926 Check for integer overflow in xmlXPathFormatNumber (Nick Wellnhofer),<br/>
927 Make Travis print UBSan stacktraces (Nick Wellnhofer),<br/>
928 Add .travis.yml (Nick Wellnhofer),<br/>
929 Fix expected error output in Python tests (Nick Wellnhofer),<br/>
930 Simplify control flow in xmlParseStartTag2 (Nick Wellnhofer),<br/>
931 Disable LeakSanitizer when running API tests (Nick Wellnhofer),<br/>
932 Avoid out-of-bound array access in API tests (Nick Wellnhofer),<br/>
933 Avoid spurious UBSan errors in parser.c (Nick Wellnhofer),<br/>
934 Parse small XPath numbers more accurately (Nick Wellnhofer),<br/>
935 Rework XPath rounding functions (Nick Wellnhofer),<br/>
936 Fix white space in test output (Nick Wellnhofer),<br/>
937 Fix axis traversal from attribute and namespace nodes (Nick Wellnhofer),<br/>
938 Check for trailing characters in XPath expressions earlier (Nick Wellnhofer),<br/>
939 Rework final handling of XPath results (Nick Wellnhofer),<br/>
940 Make xmlXPathEvalExpression call xmlXPathEval (Nick Wellnhofer),<br/>
941 Remove unused variables (Nick Wellnhofer),<br/>
942 Don't print generic error messages in XPath tests (Nick Wellnhofer)<br/>
943 </li>
944
945 <li>Cleanups:<br/>
946 Fix a couple of misleading indentation errors (Daniel Veillard),<br/>
947 Remove unnecessary calls to xmlPopInput (Nick Wellnhofer)<br/>
948 </li>
949</ul>
Daniel Veillardbdec2182016-05-23 16:04:52 +0800950<h3>2.9.4: May 23 2016</h3>
951<ul>
952 <li>Security:<br/>
953 More format string warnings with possible format string vulnerability (David Kilzer),<br/>
954 Avoid building recursive entities (Daniel Veillard),<br/>
955 Heap-based buffer overread in htmlCurrentChar (Pranjal Jumde),<br/>
956 Heap-based buffer-underreads due to xmlParseName (David Kilzer),<br/>
957 Heap use-after-free in xmlSAX2AttributeNs (Pranjal Jumde),<br/>
958 Heap use-after-free in htmlParsePubidLiteral and htmlParseSystemiteral (Pranjal Jumde),<br/>
959 Fix some format string warnings with possible format string vulnerability (David Kilzer),<br/>
960 Detect change of encoding when parsing HTML names (Hugh Davenport),<br/>
961 Fix inappropriate fetch of entities content (Daniel Veillard),<br/>
962 Bug 759398: Heap use-after-free in xmlDictComputeFastKey &lt;https://bugzilla.gnome.org/show_bug.cgi?id=759398&gt; (Pranjal Jumde),<br/>
963 Bug 758605: Heap-based buffer overread in xmlDictAddString &lt;https://bugzilla.gnome.org/show_bug.cgi?id=758605&gt; (Pranjal Jumde),<br/>
964 Bug 758588: Heap-based buffer overread in xmlParserPrintFileContextInternal &lt;https://bugzilla.gnome.org/show_bug.cgi?id=758588&gt; (David Kilzer),<br/>
965 Bug 757711: heap-buffer-overflow in xmlFAParsePosCharGroup &lt;https://bugzilla.gnome.org/show_bug.cgi?id=757711&gt; (Pranjal Jumde),<br/>
966 Add missing increments of recursion depth counter to XML parser. (Peter Simons)<br/>
967 </li>
968
969 <li>Documentation:<br/>
970 Fix typo: s{ ec -&gt; cr }cipt (Jan Pokorný),<br/>
971 Fix typos: dictio{ nn -&gt; n }ar{y,ies} (Jan Pokorný),<br/>
972 Fix typos: PATH_{ SEAPARATOR -&gt; SEPARATOR } (Jan Pokorný),<br/>
973 Correct a typo. (Shlomi Fish)<br/>
974 </li>
975
976 <li>Portability:<br/>
977 Correct the usage of LDFLAGS (Mattias Hansson),<br/>
978 Revert the use of SAVE_LDFLAGS in configure.ac (Mattias Hansson),<br/>
979 libxml2 hardcodes -L/lib in zlib/lzma tests which breaks cross-compiles (Mike Frysinger),<br/>
980 Fix apibuild for a recently added construct (Daniel Veillard),<br/>
981 Use pkg-config to locate zlib when possible (Stewart Brodie),<br/>
982 Use pkg-config to locate ICU when possible (Stewart Brodie),<br/>
983 Portability to non C99 compliant compilers (Patrick Monnerat),<br/>
984 dict.h: Move xmlDictPtr definition before includes to allow direct inclusion. (Patrick Monnerat),<br/>
985 os400: tell about xmllint and xmlcatalog in README400. (Patrick Monnerat),<br/>
986 os400: properly process SGML add in XMLCATALOG command. (Patrick Monnerat),<br/>
987 os400: implement CL command XMLCATALOG. (Patrick Monnerat),<br/>
988 os400: compile and install program xmlcatalog (qshell-only). (Patrick Monnerat),<br/>
989 os400: expand tabs in sources, strip trailing blanks. (Patrick Monnerat),<br/>
990 os400: implement CL command XMLLINT. (Patrick Monnerat),<br/>
991 os400: compile and install program xmllint (qshell-only). (Patrick Monnerat),<br/>
992 os400: initscript make_module(): Use options instead of positional parameters. (Patrick Monnerat),<br/>
993 os400: c14n.rpgle: allow *omit for nullable reference parameters. (Patrick Monnerat),<br/>
994 os400: use like() for double type. (Patrick Monnerat),<br/>
995 os400: use like() for int type. (Patrick Monnerat),<br/>
996 os400: use like() for unsigned int type. (Patrick Monnerat),<br/>
997 os400: use like() for enum types. (Patrick Monnerat),<br/>
998 Add xz to xml2-config --libs output (Baruch Siach),<br/>
999 Bug 760190: configure.ac should be able to build --with-icu without icu-config tool &lt;https://bugzilla.gnome.org/show_bug.cgi?id=760190&gt; (David Kilzer),<br/>
1000 win32\VC10\config.h and VS 2015 (Bruce Dawson),<br/>
1001 Add configure maintainer mode (orzen)<br/>
1002 </li>
1003
1004 <li>Bug Fixes:<br/>
1005 Avoid an out of bound access when serializing malformed strings (Daniel Veillard),<br/>
1006 Unsigned addition may overflow in xmlMallocAtomicLoc() (David Kilzer),<br/>
1007 Integer signed/unsigned type mismatch in xmlParserInputGrow() (David Kilzer),<br/>
1008 Bug 763071: heap-buffer-overflow in xmlStrncat &lt;https://bugzilla.gnome.org/show_bug.cgi?id=763071&gt; (Pranjal Jumde),<br/>
1009 Integer overflow parsing port number in URI (Michael Paddon),<br/>
1010 Fix an error with regexp on nullable counted char transition (Daniel Veillard),<br/>
1011 Fix memory leak with XPath namespace nodes (Nick Wellnhofer),<br/>
1012 Fix namespace axis traversal (Nick Wellnhofer),<br/>
1013 Fix null pointer deref in docs with no root element (Hugh Davenport),<br/>
1014 Fix XSD validation of URIs with ampersands (Alex Henrie),<br/>
1015 xmlschemastypes.c: accept endOfDayFrag Times set to "24:00:00" mean "end of day" and should not cause an error. (Patrick Monnerat),<br/>
1016 xmlcatalog: flush stdout before interactive shell input. (Patrick Monnerat),<br/>
1017 xmllint: flush stdout before interactive shell input. (Patrick Monnerat),<br/>
1018 Don't recurse into OP_VALUEs in xmlXPathOptimizeExpression (Nick Wellnhofer),<br/>
1019 Fix namespace::node() XPath expression (Nick Wellnhofer),<br/>
1020 Fix OOB write in xmlXPathEmptyNodeSet (Nick Wellnhofer),<br/>
1021 Fix parsing of NCNames in XPath (Nick Wellnhofer),<br/>
1022 Fix OOB read with invalid UTF-8 in xmlUTF8Strsize (Nick Wellnhofer),<br/>
1023 Do normalize string-based datatype value in RelaxNG facet checking (Audric Schiltknecht),<br/>
1024 Bug 760921: REGRESSION (8eb55d78): doc/examples/io1 test fails after fix for "xmlSaveUri() incorrectly recomposes URIs with rootless paths" &lt;https://bugzilla.gnome.org/show_bug.cgi?id=760921&gt; (David Kilzer),<br/>
1025 Bug 760861: REGRESSION (bf9c1dad): Missing results for test/schemas/regexp-char-ref_[01].xsd &lt;https://bugzilla.gnome.org/show_bug.cgi?id=760861&gt; (David Kilzer),<br/>
1026 error.c: *input-&gt;cur == 0 does not mean no error (Pavel Raiskup),<br/>
1027 Add missing RNG test files (David Kilzer),<br/>
1028 Bug 760183: REGRESSION (v2.9.3): XML push parser fails with bogus UTF-8 encoding error when multi-byte character in large CDATA section is split across buffer &lt;https://bugzilla.gnome.org/show_bug.cgi?id=760183&gt; (David Kilzer),<br/>
1029 Bug 758572: ASAN crash in make check &lt;https://bugzilla.gnome.org/show_bug.cgi?id=758572&gt; (David Kilzer),<br/>
1030 Bug 721158: Missing ICU string when doing --version on xmllint &lt;https://bugzilla.gnome.org/show_bug.cgi?id=721158&gt; (David Kilzer),<br/>
1031 python 3: libxml2.c wrappers create Unicode str already (Michael Stahl),<br/>
1032 Add autogen.sh to distrib (orzen),<br/>
1033 Heap-based buffer overread in xmlNextChar (Daniel Veillard)<br/>
1034 </li>
1035
1036 <li>Improvements:<br/>
1037 Add more debugging info to runtest (Daniel Veillard),<br/>
1038 Implement "runtest -u" mode (David Kilzer),<br/>
1039 Add a make rule to rebuild for ASAN (Daniel Veillard)<br/>
1040 </li>
1041</ul>
Daniel Veillard6657afe2015-11-20 17:55:11 +08001042<h3>v2.9.3: Nov 20 2015</h3>
1043<ul>
1044 <li>Security:<br/>
1045 CVE-2015-8242 Buffer overead with HTML parser in push mode (Hugh Davenport),<br/>
1046 CVE-2015-7500 Fix memory access error due to incorrect entities boundaries (Daniel Veillard),<br/>
1047 CVE-2015-7499-2 Detect incoherency on GROW (Daniel Veillard),<br/>
1048 CVE-2015-7499-1 Add xmlHaltParser() to stop the parser (Daniel Veillard),<br/>
1049 CVE-2015-5312 Another entity expansion issue (David Drysdale),<br/>
1050 CVE-2015-7497 Avoid an heap buffer overflow in xmlDictComputeFastQKey (David Drysdale),<br/>
1051 CVE-2015-7498 Avoid processing entities after encoding conversion failures (Daniel Veillard),<br/>
1052 CVE-2015-8035 Fix XZ compression support loop (Daniel Veillard),<br/>
1053 CVE-2015-7942-2 Fix an error in previous Conditional section patch (Daniel Veillard),<br/>
1054 CVE-2015-7942 Another variation of overflow in Conditional sections (Daniel Veillard),<br/>
1055 CVE-2015-1819 Enforce the reader to run in constant memory (Daniel Veillard)<br/>
1056 CVE-2015-7941_2 Cleanup conditional section error handling (Daniel Veillard),<br/>
1057 CVE-2015-7941_1 Stop parsing on entities boundaries errors (Daniel Veillard),<br/>
1058 </li>
1059
1060 <li>Documentation:<br/>
1061 Correct spelling of "calling" (Alex Henrie),<br/>
1062 Fix a small error in xmllint --format description (Fabien Degomme),<br/>
1063 Avoid XSS on the search of xmlsoft.org (Daniel Veillard)<br/>
1064 </li>
1065
1066 <li>Portability:<br/>
1067 threads: use forward declarations only for glibc (Michael Heimpold),<br/>
1068 Update Win32 configure.js to search for configure.ac (Daniel Veillard)<br/>
1069 </li>
1070
1071 <li>Bug Fixes:<br/>
1072 Bug on creating new stream from entity (Daniel Veillard),<br/>
1073 Fix some loop issues embedding NEXT (Daniel Veillard),<br/>
1074 Do not print error context when there is none (Daniel Veillard),<br/>
1075 Avoid extra processing of MarkupDecl when EOF (Hugh Davenport),<br/>
1076 Fix parsing short unclosed comment uninitialized access (Daniel Veillard),<br/>
1077 Add missing Null check in xmlParseExternalEntityPrivate (Gaurav Gupta),<br/>
1078 Fix a bug in CData error handling in the push parser (Daniel Veillard),<br/>
1079 Fix a bug on name parsing at the end of current input buffer (Daniel Veillard),<br/>
1080 Fix the spurious ID already defined error (Daniel Veillard),<br/>
1081 Fix previous change to node sort order (Nick Wellnhofer),<br/>
1082 Fix a self assignment issue raised by clang (Scott Graham),<br/>
1083 Fail parsing early on if encoding conversion failed (Daniel Veillard),<br/>
1084 Do not process encoding values if the declaration if broken (Daniel Veillard),<br/>
1085 Silence clang's -Wunknown-attribute (Michael Catanzaro),<br/>
1086 xmlMemUsed is not thread-safe (Martin von Gagern),<br/>
1087 Fix support for except in nameclasses (Daniel Veillard),<br/>
1088 Fix order of root nodes (Nick Wellnhofer),<br/>
1089 Allow attributes on descendant-or-self axis (Nick Wellnhofer),<br/>
1090 Fix the fix to Windows locking (Steve Nairn),<br/>
1091 Fix timsort invariant loop re: Envisage article (Christopher Swenson),<br/>
1092 Don't add IDs in xmlSetTreeDoc (Nick Wellnhofer),<br/>
1093 Account for ID attributes in xmlSetTreeDoc (Nick Wellnhofer),<br/>
1094 Remove various unused value assignments (Philip Withnall),<br/>
1095 Fix missing entities after CVE-2014-3660 fix (Daniel Veillard),<br/>
1096 Revert "Missing initialization for the catalog module" (Daniel Veillard)<br/>
1097 </li>
1098
1099 <li>Improvements:<br/>
1100 Reuse xmlHaltParser() where it makes sense (Daniel Veillard),<br/>
1101 xmlStopParser reset errNo (Daniel Veillard),<br/>
1102 Reenable xz support by default (Daniel Veillard),<br/>
1103 Recover unescaped less-than character in HTML recovery parsing (Daniel Veillard),<br/>
1104 Allow HTML serializer to output HTML5 DOCTYPE (Shaun McCance),<br/>
1105 Regression test for bug #695699 (Nick Wellnhofer),<br/>
1106 Add a couple of XPath tests (Nick Wellnhofer),<br/>
1107 Add Python 3 rpm subpackage (Tomas Radej),<br/>
1108 libxml2-config.cmake.in: update include directories (Samuel Martin),<br/>
1109 Adding example from bugs 738805 to regression tests (Daniel Veillard)<br/>
1110 </li>
1111
1112 <li>Cleanups:<br/>
1113 </li>
1114</ul>
Daniel Veillard726f67e2014-10-16 15:40:16 +08001115<h3>2.9.2: Oct 16 2014</h3>
1116<ul>
1117 <li>Security:<br/>
1118 Fix for CVE-2014-3660 billion laugh variant (Daniel Veillard),<br/>
1119 CVE-2014-0191 Do not fetch external parameter entities (Daniel Veillard)<br/>
1120 </li>
1121
1122 <li>Bug Fixes:<br/>
1123 fix memory leak xml header encoding field with XML_PARSE_IGNORE_ENC (Bart De Schuymer),<br/>
1124 xmlmemory: handle realloc properly (Yegor Yefremov),<br/>
1125 Python generator bug raised by the const change (Daniel Veillard),<br/>
1126 Windows Critical sections not released correctly (Daniel Veillard),<br/>
1127 Parser error on repeated recursive entity expansion containing &amp;lt; (Daniel Veillard),<br/>
1128 xpointer : fixing Null Pointers (Gaurav Gupta),<br/>
1129 Remove Unnecessary Null check in xpointer.c (Gaurav Gupta),<br/>
1130 parser bug on misformed namespace attributes (Dennis Filder),<br/>
1131 Pointer dereferenced before null check (Daniel Veillard),<br/>
1132 Leak of struct addrinfo in xmlNanoFTPConnect() (Gaurav Gupta),<br/>
1133 Possible overflow in HTMLParser.c (Daniel Veillard),<br/>
1134 python/tests/sync.py assumes Python dictionaries are ordered (John Beck),<br/>
1135 Fix Enum check and missing break (Gaurav Gupta),<br/>
1136 xmlIO: Handle error returns from dup() (Philip Withnall),<br/>
1137 Fix a problem properly saving URIs (Daniel Veillard),<br/>
1138 wrong error column in structured error when parsing attribute values (Juergen Keil),<br/>
1139 wrong error column in structured error when skipping whitespace in xml decl (Juergen Keil),<br/>
1140 no error column in structured error handler for xml schema validation errors (Juergen Keil),<br/>
1141 Couple of Missing Null checks (Gaurav Gupta),<br/>
1142 Add couple of missing Null checks (Daniel Veillard),<br/>
1143 xmlschemastypes: Fix potential array overflow (Philip Withnall),<br/>
1144 runtest: Fix a memory leak on parse failure (Philip Withnall),<br/>
1145 xmlIO: Fix an FD leak on gzdopen() failure (Philip Withnall),<br/>
1146 xmlcatalog: Fix a memory leak on quit (Philip Withnall),<br/>
1147 HTMLparser: Correctly initialise a stack allocated structure (Philip Withnall),<br/>
1148 Check for tmon in _xmlSchemaDateAdd() is incorrect (David Kilzer),<br/>
1149 Avoid Possible Null Pointer in trio.c (Gaurav Gupta),<br/>
1150 Fix processing in SAX2 in case of an allocation failure (Daniel Veillard),<br/>
1151 XML Shell command "cd" does not handle "/" at end of path (Daniel Veillard),<br/>
1152 Fix various Missing Null checks (Gaurav Gupta),<br/>
1153 Fix a potential NULL dereference (Daniel Veillard),<br/>
1154 Add a couple of misisng check in xmlRelaxNGCleanupTree (Gaurav Gupta),<br/>
1155 Add a missing argument check (Gaurav Gupta),<br/>
1156 Adding a check in case of allocation error (Gaurav Gupta),<br/>
1157 xmlSaveUri() incorrectly recomposes URIs with rootless paths (Dennis Filder),<br/>
1158 Adding some missing NULL checks (Gaurav),<br/>
1159 Fixes for xmlInitParserCtxt (Daniel Veillard),<br/>
1160 Fix regressions introduced by CVE-2014-0191 patch (Daniel Veillard),<br/>
1161 erroneously ignores a validation error if no error callback set (Daniel Veillard),<br/>
1162 xmllint was not parsing the --c14n11 flag (Sérgio Batista),<br/>
1163 Avoid Possible null pointer dereference in memory debug mode (Gaurav),<br/>
1164 Avoid Double Null Check (Gaurav),<br/>
1165 Restore context size and position after XPATH_OP_ARG (Nick Wellnhofer),<br/>
1166 Fix xmlParseInNodeContext() if node is not element (Daniel Veillard),<br/>
1167 Avoid a possible NULL pointer dereference (Gaurav),<br/>
1168 Fix xmlTextWriterWriteElement when a null content is given (Daniel Veillard),<br/>
1169 Fix an typo 'onrest' in htmlScriptAttributes (Daniel Veillard),<br/>
1170 fixing a ptotential uninitialized access (Daniel Veillard),<br/>
1171 Fix an fd leak in an error case (Daniel Veillard),<br/>
1172 Missing initialization for the catalog module (Daniel Veillard),<br/>
1173 Handling of XPath function arguments in error case (Nick Wellnhofer),<br/>
1174 Fix a couple of missing NULL checks (Gaurav),<br/>
1175 Avoid a possibility of dangling encoding handler (Gaurav),<br/>
1176 Fix HTML push parser to accept HTML_PARSE_NODEFDTD (Arnold Hendriks),<br/>
1177 Fix a bug loading some compressed files (Mike Alexander),<br/>
1178 Fix XPath node comparison bug (Gaurav),<br/>
1179 Type mismatch in xmlschemas.c (Gaurav),<br/>
1180 Type mismatch in xmlschemastypes.c (Gaurav),<br/>
1181 Avoid a deadcode in catalog.c (Daniel Veillard),<br/>
1182 run close socket on Solaris, same as we do on other platforms (Denis Pauk),<br/>
1183 Fix pointer dereferenced before null check (Gaurav),<br/>
1184 Fix a potential NULL dereference in tree code (Daniel Veillard),<br/>
1185 Fix potential NULL pointer dereferences in regexp code (Gaurav),<br/>
1186 xmllint --pretty crashed without following numeric argument (Tim Galeckas),<br/>
1187 Fix XPath expressions of the form '@ns:*' (Nick Wellnhofer),<br/>
1188 Fix XPath '//' optimization with predicates (Nick Wellnhofer),<br/>
1189 Clear up a potential NULL dereference (Daniel Veillard),<br/>
1190 Fix a possible NULL dereference (Gaurav),<br/>
1191 Avoid crash if allocation fails (Daniel Veillard),<br/>
1192 Remove occasional leading space in XPath number formatting (Daniel Veillard),<br/>
1193 Fix handling of mmap errors (Daniel Veillard),<br/>
1194 Catch malloc error and exit accordingly (Daniel Veillard),<br/>
1195 missing else in xlink.c (Ami Fischman),<br/>
1196 Fix a parsing bug on non-ascii element and CR/LF usage (Daniel Veillard),<br/>
1197 Fix a regression in xmlGetDocCompressMode() (Daniel Veillard),<br/>
1198 properly quote the namespace uris written out during c14n (Aleksey Sanin),<br/>
1199 Remove premature XInclude check on URI being relative (Alexey Neyman),<br/>
1200 Fix missing break on last() function for attributes (dcb),<br/>
1201 Do not URI escape in server side includes (Romain Bondue),<br/>
1202 Fix an error in xmlCleanupParser (Alexander Pastukhov)<br/>
1203 </li>
1204
1205 <li>Documentation:<br/>
1206 typo in error messages "colon are forbidden from..." (Daniel Veillard),<br/>
1207 Fix a link to James SAX documentation old page (Daniel Veillard),<br/>
1208 Fix typos in relaxng.c (Jan Pokorný),<br/>
1209 Fix a doc typo (Daniel Veillard),<br/>
1210 Fix typos in {tree,xpath}.c (errror) (Jan Pokorný),<br/>
1211 Add limitations about encoding conversion (Daniel Veillard),<br/>
1212 Fix typos in xmlschemas{,types}.c (Jan Pokorný),<br/>
1213 Fix incorrect spelling entites-&gt;entities (Jan Pokorný),<br/>
1214 Forgot to document 2.9.1 release, regenerate docs (Daniel Veillard)<br/>
1215 </li>
1216
1217 <li>Portability:<br/>
1218 AC_CONFIG_FILES and executable bit (Roumen Petrov),<br/>
1219 remove HAVE_CONFIG_H dependency in testlimits.c (Roumen Petrov),<br/>
1220 fix some tabs mixing incompatible with python3 (Roumen Petrov),<br/>
1221 Visual Studio 14 CTP defines snprintf() (Francis Dupont),<br/>
1222 OS400: do not try to copy unexisting doc files (Patrick Monnerat),<br/>
1223 OS400: use either configure.ac or configure.in. (Patrick Monnerat),<br/>
1224 os400: make-src.sh: create physical file with target CCSID (Patrick Monnerat),<br/>
1225 OS400: Add some more C macros equivalent procedures. (Patrick Monnerat),<br/>
1226 OS400: use C macros to implement equivalent RPG support procedures. (Patrick Monnerat),<br/>
1227 OS400: implement XPath macros as procedures for ILE/RPG support. (Patrick Monnerat),<br/>
1228 OS400: include in distribution tarball. (Patrick Monnerat),<br/>
1229 OS400: Add README: compilation directives and OS/400 specific stuff. (Patrick Monnerat),<br/>
1230 OS400: Add compilation scripts. (Patrick Monnerat),<br/>
1231 OS400: ILE RPG language header files. (Patrick Monnerat),<br/>
1232 OS400: implement some macros as functions for ILE/RPG language support (that as no macros). (Patrick Monnerat),<br/>
1233 OS400: UTF8&lt;--&gt;EBCDIC wrappers for system and external library calls (Patrick Monnerat),<br/>
1234 OS400: Easy character transcoding support (Patrick Monnerat),<br/>
1235 OS400: iconv functions compatibility wrappers and table builder. (Patrick Monnerat),<br/>
1236 OS400: create architecture directory. Implement dlfcn emulation. (Patrick Monnerat),<br/>
1237 Fix building when configuring without xpath and xptr (Daniel Veillard),<br/>
1238 configure: Add --with-python-install-dir (Jonas Eriksson),<br/>
1239 Fix compilation with minimum and xinclude. (Nicolas Le Cam),<br/>
1240 Compile out use of xmlValidateNCName() when not available. (Nicolas Le Cam),<br/>
1241 Fix compilation with minimum and schematron. (Nicolas Le Cam),<br/>
1242 Legacy needs xmlSAX2StartElement() and xmlSAX2EndElement(). (Nicolas Le Cam),<br/>
1243 Don't use xmlValidateName() when not available. (Nicolas Le Cam),<br/>
1244 Fix a portability issue on Windows (Longstreth Jon),<br/>
1245 Various portability patches for OpenVMS (Jacob (Jouk) Jansen),<br/>
1246 Use specific macros for portability to OS/400 (Patrick Monnerat),<br/>
1247 Add macros needed for OS/400 portability (Patrick Monnerat),<br/>
1248 Portability patch for fopen on OS/400 (Patrick Monnerat),<br/>
1249 Portability fixes for OS/400 (Patrick Monnerat),<br/>
1250 Improve va_list portability (Patrick Monnerat),<br/>
1251 Portability fix (Patrick Monnerat),<br/>
1252 Portability fix (Patrick Monnerat),<br/>
1253 Generic portability fix (Patrick Monnerat),<br/>
1254 Shortening lines in headers (Patrick Monnerat),<br/>
1255 build: Use pkg-config to find liblzma in preference to AC_CHECK_LIB (Philip Withnall),<br/>
1256 build: Add @LZMA_LIBS@ to libxml’s pkg-config files (Philip Withnall),<br/>
1257 fix some tabs mixing incompatible with python3 (Daniel Veillard),<br/>
1258 add additional defines checks for support "./configure --with-minimum" (Denis Pauk),<br/>
1259 Another round of fixes for older versions of Python (Arfrever Frehtes Taifersar Arahesis),<br/>
1260 python: fix drv_libxml2.py for python3 compatibility (Alexandre Rostovtsev),<br/>
1261 python: Fix compiler warnings when building python3 bindings (Armin K),<br/>
1262 Fix for compilation with python 2.6.8 (Petr Sumbera)<br/>
1263 </li>
1264
1265 <li>Improvements:<br/>
1266 win32/libxml2.def.src after rebuild in doc (Roumen Petrov),<br/>
1267 elfgcchack.h: more legacy needs xmlSAX2StartElement() and xmlSAX2EndElement() (Roumen Petrov),<br/>
1268 elfgcchack.h: add xmlXPathNodeEval and xmlXPathSetContextNode (Roumen Petrov),<br/>
1269 Provide cmake module (Samuel Martin),<br/>
1270 Fix a couple of issues raised by make dist (Daniel Veillard),<br/>
1271 Fix and add const qualifiers (Kurt Roeckx),<br/>
1272 Preparing for upcoming release of 2.9.2 (Daniel Veillard),<br/>
1273 Fix zlib and lzma libraries check via command line (Dmitriy),<br/>
1274 wrong error column in structured error when parsing end tag (Juergen Keil),<br/>
1275 doc/news.html: small update to avoid line join while generating NEWS. (Patrick Monnerat),<br/>
1276 Add methods for python3 iterator (Ron Angeles),<br/>
1277 Support element node traversal in document fragments. (Kyle VanderBeek),<br/>
1278 xmlNodeSetName: Allow setting the name to a substring of the currently set name (Tristan Van Berkom),<br/>
1279 Added macros for argument casts (Eric Zurcher),<br/>
1280 adding init calls to xml and html Read parsing entry points (Daniel Veillard),<br/>
1281 Get rid of 'REPLACEMENT CHARACTER' Unicode chars in xmlschemas.c (Jan Pokorný),<br/>
1282 Implement choice for name classes on attributes (Shaun McCance),<br/>
1283 Two small namespace tweaks (Daniel Veillard),<br/>
1284 xmllint --memory should fail on empty files (Daniel Veillard),<br/>
1285 Cast encoding name to char pointer to match arg type (Nikolay Sivov)<br/>
1286 </li>
1287
1288 <li>Cleanups:<br/>
1289 Removal of old configure.in (Daniel Veillard),<br/>
1290 Unreachable code in tree.c (Gaurav Gupta),<br/>
1291 Remove a couple of dead conditions (Gaurav Gupta),<br/>
1292 Avoid some dead code and cleanup in relaxng.c (Gaurav),<br/>
1293 Drop not needed checks (Denis Pauk),<br/>
1294 Fix a wrong test (Daniel Veillard)<br/>
1295 </li>
1296</ul>
Daniel Veillarde38217a2013-05-10 15:40:13 +08001297<h3>2.9.1: Apr 19 2013</h3>
1298<ul>
1299 <li> Features:<br/>
1300 Support for Python3 (Daniel Veillard),<br/>
1301 Add xmlXPathSetContextNode and xmlXPathNodeEval (Alex Bligh)<br/>
1302 </li>
1303
1304 <li> Documentation:<br/>
1305 Add documentation for xmllint --xpath (Daniel Veillard),<br/>
1306 Fix the URL of the SAX documentation from James (Daniel Veillard),<br/>
1307 Fix spelling of "length". (Michael Wood)<br/>
1308 </li>
1309
1310 <li> Portability:<br/>
1311 Fix python bindings with versions older than 2.7 (Daniel Veillard),<br/>
1312 rebuild docs:Makefile.am (Roumen Petrov),<br/>
1313 elfgcchack.h after rebuild in doc (Roumen Petrov),<br/>
1314 elfgcchack for buf module (Roumen Petrov),<br/>
1315 Fix a uneeded and wrong extra link parameter (Daniel Veillard),<br/>
1316 Few cleanup patches for Windows (Denis Pauk),<br/>
1317 Fix rpmbuild --nocheck (Mark Salter),<br/>
1318 Fix for win32/configure.js and WITH_THREAD_ALLOC (Daniel Richard),<br/>
1319 Fix Broken multi-arch support in xml2-config (Daniel Veillard),<br/>
1320 Fix a portability issue for GCC &lt; 3.4.0 (Daniel Veillard),<br/>
1321 Windows build fixes (Daniel Richard),<br/>
1322 Fix a thread portability problem (Friedrich Haubensak),<br/>
1323 Downgrade autoconf requirement to 2.63 (Daniel Veillard)<br/>
1324 </li>
1325
1326 <li> Bug Fixes:<br/>
1327 Fix a linking error for python bindings (Daniel Veillard),<br/>
1328 Fix a couple of return without value (Jüri Aedla),<br/>
1329 Improve the hashing functions (Daniel Franke),<br/>
1330 Improve handling of xmlStopParser() (Daniel Veillard),<br/>
1331 Remove risk of lockup in dictionary initialization (Daniel Veillard),<br/>
1332 Activate detection of encoding in external subset (Daniel Veillard),<br/>
1333 Fix an output buffer flushing conversion bug (Mikhail Titov),<br/>
1334 Fix an old bug in xmlSchemaValidateOneElement (Csaba László),<br/>
1335 Fix configure cannot remove messages (Gilles Espinasse),<br/>
1336 fix schema validation in combination with xsi:nil (Daniel Veillard),<br/>
1337 xmlCtxtReadFile doesn't work with literal IPv6 URLs (Steve Wolf),<br/>
1338 Fix a few problems with setEntityLoader (Alexey Neyman),<br/>
1339 Detect excessive entities expansion upon replacement (Daniel Veillard),<br/>
1340 Fix the flushing out of raw buffers on encoding conversions (Daniel,<br/>
1341Veillard),<br/>
1342 Fix some buffer conversion issues (Daniel Veillard),<br/>
1343 When calling xmlNodeDump make sure we grow the buffer quickly (Daniel,<br/>
1344Veillard),<br/>
1345 Fix an error in the progressive DTD parsing code (Dan Winship),<br/>
1346 xmllint should not load DTD by default when using the reader (Daniel,<br/>
1347Veillard),<br/>
1348 Try IBM-037 when looking for EBCDIC handlers (Petr Sumbera),<br/>
1349 Fix potential out of bound access (Daniel Veillard),<br/>
1350 Fix large parse of file from memory (Daniel Veillard),<br/>
1351 Fix a bug in the nsclean option of the parser (Daniel Veillard),<br/>
1352 Fix a regression in 2.9.0 breaking validation while streaming (Daniel,<br/>
1353Veillard),<br/>
1354 Remove potential calls to exit() (Daniel Veillard)<br/>
1355 </li>
1356
1357 <li> Improvements:<br/>
1358 Regenerated API, and testapi, rebuild documentation (Daniel Veillard),<br/>
1359 Fix tree iterators broken by 2to3 script (Daniel Veillard),<br/>
1360 update all tests for Python3 and Python2 (Daniel Veillard),<br/>
1361 A few more fixes for python 3 affecting libxml2.py (Daniel Veillard),<br/>
1362 Fix compilation on Python3 (Daniel Veillard),<br/>
1363 Converting apibuild.py to python3 (Daniel Veillard),<br/>
1364 First pass at starting porting to python3 (Daniel Veillard),<br/>
1365 updated configure.in for python3 (Daniel Veillard),<br/>
1366 Add support for xpathRegisterVariable in Python (Shaun McCance),<br/>
1367 Added a regression tests from bug 694228 data (Daniel Veillard),<br/>
1368 Cache presence of '&lt;' in entities content (Daniel Veillard),<br/>
1369 Avoid extra processing on entities (Daniel Veillard),<br/>
1370 Python binding for xmlRegisterInputCallback (Alexey Neyman),<br/>
1371 Python bindings: DOM casts everything to xmlNode (Alexey Neyman),<br/>
1372 Define LIBXML_THREAD_ALLOC_ENABLED via xmlversion.h (Tim Starling),<br/>
1373 Adding streaming validation to runtest checks (Daniel Veillard),<br/>
1374 Add a --pushsmall option to xmllint (Daniel Veillard)<br/>
1375 </li>
1376
1377 <li> Cleanups:<br/>
1378 Switched comment in file to UTF-8 encoding (Daniel Veillard),<br/>
1379 Extend gitignore (Daniel Veillard),<br/>
1380 Silent the new python test on input (Alexey Neyman),<br/>
1381 Cleanup of a duplicate test (Daniel Veillard),<br/>
1382 Cleanup on duplicate test expressions (Daniel Veillard),<br/>
1383 Fix compiler warning after 153cf15905cf4ec080612ada6703757d10caba1e (Patrick,<br/>
1384Gansterer),<br/>
1385 Spec cleanups and a fix for multiarch support (Daniel Veillard),<br/>
1386 Silence a clang warning (Daniel Veillard),<br/>
1387 Cleanup the Copyright to be pure MIT Licence wording (Daniel Veillard),<br/>
1388 rand_seed should be static in dict.c (Wouter Van Rooy),<br/>
1389 Fix typos in parser comments (Jan Pokorný)<br/>
1390 </li>
1391</ul>
Daniel Veillard38bbd342012-09-11 15:00:08 +08001392<h3>2.9.0: Sep 11 2012</h3>
1393<ul>
1394 <li> Features:<br/>
1395 A few new API entry points,<br/>
1396 More resilient push parser mode,<br/>
1397 A lot of portability improvement,<br/>
1398 Faster XPath evaluation<br/>
1399 </li>
1400
1401 <li> Documentation:<br/>
1402 xml2-config.1 markup error (Christian Weisgerber),<br/>
1403 libxml(3) manpage typo fix (John Bradshaw),<br/>
1404 More cleanups to the documentation part of libxml2 (Daniel Richard G)<br/>
1405 </li>
1406
1407 <li> Portability:<br/>
1408 Bug 676544 - fails to build with --without-sax1 (Akira TAGOH),<br/>
1409 fix builds not having stdint.h (Rob Richards),<br/>
1410 GetProcAddressA is available only on WinCE (Daniel Veillard),<br/>
1411 More updates and cleanups on autotools and Makefiles (Daniel Richard G),<br/>
1412 More changes for Win32 compilation (Eric Zurcher),<br/>
1413 Basic changes for Win32 builds of release 2.9.0: compile buf.c (Eric Zurcher),<br/>
1414 Bundles all generated files for python into the distribution (Daniel Richard G),<br/>
1415 Fix compiler warnings of wincecompat.c (Patrick Gansterer),<br/>
1416 Fix non __GNUC__ build (Patrick Gansterer),<br/>
1417 Fix windows unicode build (Patrick Gansterer),<br/>
1418 clean redefinition of {v}snprintf in C-source (Roumen Petrov),<br/>
1419 use xmlBuf... if DEBUG_INPUT is defined (Roumen Petrov),<br/>
1420 fix runtests to use pthreads support for various Unix platforms (Daniel Richard G),<br/>
1421 Various "make distcheck" and portability fixups 2nd part (Daniel Richard G),<br/>
1422 Various "make distcheck" and portability fixups (Daniel Richard G),<br/>
1423 Fix compilation on older Visual Studio (Daniel Veillard)<br/>
1424 </li>
1425
1426 <li> Bug Fixes:<br/>
1427 Change the XPath code to percolate allocation errors (Daniel Veillard),<br/>
1428 Fix reuse of xmlInitParser (Daniel Veillard),<br/>
1429 Fix potential crash on entities errors (Daniel Veillard),<br/>
1430 initialize var (Rob Richards),<br/>
1431 Fix the XPath arity check to also check the XPath stack limits (Daniel Veillard),<br/>
1432 Fix problem with specific and generic error handlers (Pietro Cerutti),<br/>
1433 Avoid a potential infinite recursion (Daniel Veillard),<br/>
1434 Fix an XSD error when generating internal automata (Daniel Veillard),<br/>
1435 Patch for xinclude of text using multibyte characters (Vitaly Ostanin),<br/>
1436 Fix a segfault on XSD validation on pattern error (Daniel Veillard),<br/>
1437 Fix missing xmlsave.h module which was ignored in recent builds (Daniel Veillard),<br/>
1438 Add a missing element check (Daniel Veillard),<br/>
1439 Adding various checks on node type though the API (Daniel Veillard),<br/>
1440 Namespace nodes can't be unlinked with xmlUnlinkNode (Daniel Veillard),<br/>
1441 Fix make dist to include new private header files (Daniel Veillard),<br/>
1442 More fixups on the push parser behaviour (Daniel Veillard),<br/>
1443 Strengthen behaviour of the push parser in problematic situations (Daniel Veillard),<br/>
1444 Enforce XML_PARSER_EOF state handling through the parser (Daniel Veillard),<br/>
1445 Fixup limits parser (Daniel Veillard),<br/>
1446 Do not fetch external parsed entities (Daniel Veillard),<br/>
1447 Fix an error in previous commit (Aron Xu),<br/>
1448 Fix entities local buffers size problems (Daniel Veillard),<br/>
1449 Fix parser local buffers size problems (Daniel Veillard),<br/>
1450 Fix a failure to report xmlreader parsing failures (Daniel Veillard)<br/>
1451 </li>
1452
1453 <li> Improvements:<br/>
1454 Keep libxml2.syms when running "make distclean" (Daniel Veillard),<br/>
1455 Allow to set the quoting character of an xmlWriter (Csaba Raduly),<br/>
1456 Keep non-significant blanks node in HTML parser (Daniel Veillard),<br/>
1457 Add a forbidden variable error number and message to XPath (Daniel Veillard),<br/>
1458 Support long path names on WNT (Michael Stahl),<br/>
1459 Improve HTML escaping of attribute on output (Daniel Veillard),<br/>
1460 Handle ICU_LIBS as LIBADD, not LDFLAGS to prevent linking errors (Arfrever Frehtes Taifersar Arahesis),<br/>
1461 Switching XPath node sorting to Timsort (Vojtech Fried),<br/>
1462 Optimizing '//' in XPath expressions (Nick Wellnhofer),<br/>
1463 Expose xmlBufShrink in the public tree API (Daniel Veillard),<br/>
1464 Visible HTML elements close the head tag (Conrad Irwin),<br/>
1465 Fix file and line report for XSD SAX and reader streaming validation (Daniel Veillard),<br/>
1466 Fix const qualifyer to definition of xmlBufferDetach (Daniel Veillard),<br/>
1467 minimize use of HAVE_CONFIG_H (Roumen Petrov),<br/>
1468 fixup regression in Various "make distcheck" and portability fixups (Roumen Petrov),<br/>
1469 Add support for big line numbers in error reporting (Daniel Veillard),<br/>
1470 Avoid using xmlBuffer for serialization (Daniel Veillard),<br/>
1471 Improve compatibility between xmlBuf and xmlBuffer (Daniel Veillard),<br/>
1472 Provide new accessors for xmlOutputBuffer (Daniel Veillard),<br/>
1473 Improvements for old buffer compatibility (Daniel Veillard),<br/>
1474 Expand the limit test program (Daniel Veillard),<br/>
1475 Improve error reporting on parser errors (Daniel Veillard),<br/>
1476 Implement some default limits in the XPath module (Daniel Veillard),<br/>
1477 Introduce some default parser limits (Daniel Veillard),<br/>
1478 Cleanups and new limit APIs for dictionaries (Daniel Veillard),<br/>
1479 Fixup for buf.c (Daniel Veillard),<br/>
1480 Cleanup URI module memory allocation code (Daniel Veillard),<br/>
1481 Extend testlimits (Daniel Veillard),<br/>
1482 More avoid quadratic behaviour (Daniel Veillard),<br/>
1483 Impose a reasonable limit on PI size (Daniel Veillard),<br/>
1484 first version of testlimits new test (Daniel Veillard),<br/>
1485 Avoid quadratic behaviour in some push parsing cases (Daniel Veillard),<br/>
1486 Impose a reasonable limit on comment size (Daniel Veillard),<br/>
1487 Impose a reasonable limit on attribute size (Daniel Veillard),<br/>
1488 Harden the buffer code and make it more compatible (Daniel Veillard),<br/>
1489 More cleanups for input/buffers code (Daniel Veillard),<br/>
1490 Cleanup function xmlBufResetInput(),<br/> to set input from Buffer (Daniel Veillard)
1491 Swicth the test program for characters to new input buffers (Daniel Veillard),<br/>
1492 Convert the HTML tree module to the new buffers (Daniel Veillard),<br/>
1493 Convert of the HTML parser to new input buffers (Daniel Veillard),<br/>
1494 Convert the writer to new output buffer and save APIs (Daniel Veillard),<br/>
1495 Convert XMLReader to the new input buffers (Daniel Veillard),<br/>
1496 New saving functions using xmlBuf and conversion (Daniel Veillard),<br/>
1497 Provide new xmlBuf based saving functions (Daniel Veillard),<br/>
1498 Convert XInclude to the new input buffers (Daniel Veillard),<br/>
1499 Convert catalog code to the new input buffers (Daniel Veillard),<br/>
1500 Convert C14N to the new Input buffer (Daniel Veillard),<br/>
1501 Convert xmlIO.c to the new input and output buffers (Daniel Veillard),<br/>
1502 Convert XML parser to the new input buffers (Daniel Veillard),<br/>
1503 Incompatible change to the Input and Output buffers (Daniel Veillard),<br/>
1504 Adding new encoding function to deal with the new structures (Daniel Veillard),<br/>
1505 Convert XPath to xmlBuf (Daniel Veillard),<br/>
1506 Adding a new buf module for buffers (Daniel Veillard),<br/>
1507 Memory error within SAX2 reuse common framework (Daniel Veillard),<br/>
1508 Fix xmllint --xpath node initialization (Daniel Veillard)<br/>
1509 </li>
1510
1511 <li> Cleanups:<br/>
1512 Various cleanups to avoid compiler warnings (Daniel Veillard),<br/>
1513 Big space and tab cleanup (Daniel Veillard),<br/>
1514 Followup to LibXML2 docs/examples cleanup patch (Daniel Veillard),<br/>
1515 Second round of cleanups for LibXML2 docs/examples (Daniel Richard),<br/>
1516 Remove all .cvsignore as they are not used anymore (Daniel Veillard),<br/>
1517 Fix a Timsort function helper comment (Daniel Veillard),<br/>
1518 Small cleanup for valgrind target (Daniel Veillard),<br/>
1519 Patch for portability of latin characters in C files (Daniel Veillard),<br/>
1520 Cleanup some of the parser code (Daniel Veillard),<br/>
1521 Fix a variable name in comment (Daniel Veillard),<br/>
1522 Regenerated testapi.c (Daniel Veillard),<br/>
1523 Regenerating docs and API files (Daniel Veillard),<br/>
1524 Small cleanup of unused variables in test (Daniel Veillard),<br/>
1525 Expand .gitignore with more files (Daniel Veillard)<br/>
1526 </li>
1527</ul>
Daniel Veillardc943f702012-05-23 17:10:59 +08001528<h3>2.8.0: May 23 2012</h3>
1529<ul>
1530 <li>Features:
Daniel Veillard38bbd342012-09-11 15:00:08 +08001531 add lzma compression support (Anders F Bjorklund)
Daniel Veillardc943f702012-05-23 17:10:59 +08001532 </li>
1533
1534 <li>Documentation:
1535 xmlcatalog: Add uri and delegateURI to possible add types in man page. (Ville Skyttä),
1536 Update README.tests (Daniel Veillard),
1537 URI handling code is not OOM resilient (Daniel Veillard),
1538 Fix an error in comment (Daniel Veillard),
1539 Fixed bug #617016 (Daniel Mustieles),
1540 Fixed two typos in the README document (Daniel Neel),
1541 add generated html files (Anders F Bjorklund),
1542 Clarify the need to use xmlFreeNode after xmlUnlinkNode (Daniel Veillard),
1543 Improve documentation a bit (Daniel Veillard),
1544 Updated URL for lxml python bindings (Daniel Veillard)
1545 </li>
1546
1547 <li>Portability:
1548 Restore code for Windows compilation (Daniel Veillard),
1549 Remove git error message during configure (Christian Dywan),
1550 xmllint: Build fix for endTimer if !defined(HAVE_GETTIMEOFDAY) (Patrick R. Gansterer),
1551 remove a bashism in confgure.in (John Hein),
1552 undef ERROR if already defined (Patrick R. Gansterer),
1553 Fix library problems with mingw-w64 (Michael Cronenworth),
1554 fix windows build. ifdef addition from bug 666491 makes no sense (Rob Richards),
1555 prefer native threads on win32 (Sam Thursfield),
1556 Allow to compile with Visual Studio 2010 (Thomas Lemm),
1557 Fix mingw's snprintf configure check (Andoni Morales),
1558 fixed a 64bit big endian issue (Marcus Meissner),
1559 Fix portability failure if netdb.h lacks NO_ADDRESS (Daniel Veillard),
1560 Fix windows build from lzma addition (Rob Richards),
1561 autogen: Only check for libtoolize (Colin Walters),
1562 Fix the Windows build files (Patrick von Reth),
1563 634846 Remove a linking option breaking Windows VC10 (Daniel Veillard),
1564 599241 fix an initialization problem on Win64 (Andrew W. Nosenko),
1565 fix win build (Rob Richards)
1566 </li>
1567
1568 <li>Bug fixes:
1569 Part for rand_r checking missing (Daniel Veillard),
1570 Cleanup on randomization (Daniel Veillard),
1571 Fix undefined reference in python module (Pacho Ramos),
1572 Fix a race in xmlNewInputStream (Daniel Veillard),
1573 Fix weird streaming RelaxNG errors (Noam),
1574 Fix various bugs in new code raised by the API checking (Daniel Veillard),
1575 Fix various problems with "make dist" (Daniel Veillard),
1576 Fix a memory leak in the xzlib code (Daniel Veillard),
1577 HTML parser error with &lt;noscript&gt; in the &lt;head&gt; (Denis Pauk),
1578 XSD: optional element in complex type extension (Remi Gacogne),
1579 Fix html serialization error and htmlSetMetaEncoding() (Daniel Veillard),
1580 Fix a wrong return value in previous patch (Daniel Veillard),
1581 Fix an uninitialized variable use (Daniel Veillard),
1582 Fix a compilation problem with --minimum (Brandon Slack),
1583 Remove redundant and ungarded include of resolv.h (Daniel Veillard),
1584 xinclude with parse="text" does not use the entity loader (Shaun McCance),
1585 Allow to parse 1 byte HTML files (Denis Pauk),
1586 Patch that fixes the skipping of the HTML_PARSE_NOIMPLIED flag (Martin Schröder),
1587 Avoid memory leak if xmlParserInputBufferCreateIO fails (Lin Yi-Li),
1588 Prevent an infinite loop when dumping a node with encoding problems (Timothy Elliott),
1589 xmlParseNodeInContext problems with an empty document (Tim Elliott),
1590 HTML element position is not detected propperly (Pavel Andrejs),
1591 Fix an off by one pointer access (Jüri Aedla),
1592 Try to fix a problem with entities in SAX mode (Daniel Veillard),
1593 Fix a crash with xmllint --path on empty results (Daniel Veillard),
1594 Fixed bug #667946 (Daniel Mustieles),
1595 Fix a logic error in Schemas Component Constraints (Ryan Sleevi),
1596 Fix a wrong enum type use in Schemas Types (Nico Weber),
1597 Fix SAX2 builder in case of undefined attributes namespace (Daniel Veillard),
1598 Fix SAX2 builder in case of undefined element namespaces (Daniel Veillard),
1599 fix reference to STDOUT_FILENO on MSVC (Tay Ray Chuan),
1600 fix a pair of possible out of array char references (Daniel Veillard),
1601 Fix an allocation error when copying entities (Daniel Veillard),
1602 Make sure the parser returns when getting a Stop order (Chris Evans),
1603 Fix some potential problems on reallocation failures(parser.c) (Xia Xinfeng),
1604 Fix a schema type duration comparison overflow (Daniel Veillard),
1605 Fix an unimplemented part in RNG value validation (Daniel Veillard),
1606 Fix missing error status in XPath evaluation (Daniel Veillard),
1607 Hardening of XPath evaluation (Daniel Veillard),
1608 Fix an off by one error in encoding (Daniel Veillard),
1609 Fix RELAX NG include bug #655288 (Shaun McCance),
1610 Fix XSD validation bug #630130 (Toyoda Eizi),
1611 Fix some potential problems on reallocation failures (Chris Evans),
1612 __xmlRaiseError: fix use of the structured callback channel (Dmitry V. Levin),
1613 __xmlRaiseError: fix the structured callback channel's data initialization (Dmitry V. Levin),
1614 Fix memory corruption when xmlParseBalancedChunkMemoryInternal is called from xmlParseBalancedChunk (Rob Richards),
1615 Small fix for previous commit (Daniel Veillard),
1616 Fix a potential freeing error in XPath (Daniel Veillard),
1617 Fix a potential memory access error (Daniel Veillard),
1618 Reactivate the shared library versionning script (Daniel Veillard)
1619 </li>
1620
1621 <li>Improvements:
1622 use mingw C99 compatible functions {v}snprintf instead those from MSVC runtime (Roumen Petrov),
1623 New symbols added for the next release (Daniel Veillard),
1624 xmlTextReader bails too quickly on error (Andy Lutomirski),
1625 Use a hybrid allocation scheme in xmlNodeSetContent (Conrad Irwin),
1626 Use buffers when constructing string node lists. (Conrad Irwin),
1627 Add HTML parser support for HTML5 meta charset encoding declaration (Denis Pauk),
1628 wrong message for double hyphen in comment XML error (Bryan Henderson),
1629 Fix "make tst" to grab lzma lib too (Daniel Veillard),
1630 Add "whereis" command to xmllint shell (Ryan),
1631 Improve xmllint shell (Ryan),
1632 add function xmlTextReaderRelaxNGValidateCtxt() (Noam Postavsky),
1633 Add --system support to autogen.sh (Daniel Veillard),
1634 Add hash randomization to hash and dict structures (Daniel Veillard),
1635 included xzlib in dist (Anders F Bjorklund),
1636 move xz/lzma helpers to separate included files (Anders F Bjorklund),
1637 add generated devhelp files (Anders F Bjorklund),
1638 add XML_WITH_LZMA to api (Anders F Bjorklund),
1639 autogen.sh: Honor NOCONFIGURE environment variable (Colin Walters),
1640 Improve the error report on undefined REFs (Daniel Veillard),
1641 Add exception for new W3C PI xml-model (Daniel Veillard),
1642 Add options to ignore the internal encoding (Daniel Veillard),
1643 testapi: use the right type for the check (Stefan Kost),
1644 various: handle return values of write calls (Stefan Kost),
1645 testWriter: xmlTextWriterWriteFormatElement wants an int instead of a long int (Stefan Kost),
1646 runxmlconf: update to latest testsuite version (Stefan Kost),
1647 configure: add -Wno-long-long to CFLAGS (Stefan Kost),
1648 configure: support silent automake rules if possible (Stefan Kost),
1649 xmlmemory: add a cast as size_t has no portable printf modifier (Stefan Kost),
1650 __xmlRaiseError: remove redundant schannel initialization (Dmitry V. Levin),
1651 __xmlRaiseError: do cheap code check early (Dmitry V. Levin)
1652 </li>
1653
1654 <li>Cleanups:
1655 Cleanups before 2.8.0-rc2 (Daniel Veillard),
1656 Avoid an extra operation (Daniel Veillard),
1657 Remove vestigial de-ANSI-fication support. (Javier Jardón),
1658 autogen.sh: Fix typo (Javier Jardón),
1659 Do not use unsigned but unsigned int (Daniel Veillard),
1660 Remove two references to u_short (Daniel Veillard),
1661 Fix -Wempty-body warning from clang (Nico Weber),
1662 Cleanups of lzma support (Daniel Veillard),
1663 Augment the list of ignored files (Daniel Veillard),
1664 python: remove unused variable (Stefan Kost),
1665 python: flag two unused args (Stefan Kost),
1666 configure: acconfig.h is deprecated since autoconf-2.50 (Stefan Kost),
1667 xpath: remove unused variable (Stefan Kost)
1668 </li>
1669</ul>
Daniel Veillard4c2e7c62010-11-04 18:35:57 +01001670<h3>2.7.8: Nov 4 2010</h3>
1671<ul>
1672 <li> Features:
1673 480323 add code to plug in ICU converters by default (Giuseppe Iuculano),
1674 Add xmlSaveOption XML_SAVE_WSNONSIG (Adam Spragg)
1675 </li>
1676 <li> Documentation:
1677 Fix devhelp documentation installation (Mike Hommey),
1678 Fix web site encoding problems (Daniel Veillard),
1679 Fix a couple of typo in HTML parser error messages (Michael Day),
1680 Forgot to update the news page for 0.7.7 (Daniel Veillard)
1681 </li>
1682 <li> Portability:
1683 607273 Fix python detection on MSys/Windows (LRN),
1684 614087 Fix Socket API usage to allow Windows64 compilation (Ozkan Sezer),
1685 Fix compilation with Clang (Koop Mast),
1686 Fix Win32 build (Rob Richards)
1687 </li>
1688 <li> Bug Fixes:
1689 595789 fix a remaining potential Solaris problem (Daniel Veillard),
1690 617468 fix progressive HTML parsing with style using "'" (Denis Pauk),
1691 616478 Fix xmllint shell write command (Gwenn Kahz),
1692 614005 Possible erroneous HTML parsing on unterminated script (Pierre Belzile),
1693 627987 Fix XSD IDC errors in imported schemas (Jim Panetta),
1694 629325 XPath rounding errors first cleanup (Phil Shafer),
1695 630140 fix iso995x encoding error (Daniel Veillard),
1696 make sure htmlCtxtReset do reset the disableSAX field (Daniel Veillard),
1697 Fix a change of semantic on XPath preceding and following axis (Daniel Veillard),
1698 Fix a potential segfault due to weak symbols on pthreads (Mike Hommey),
1699 Fix a leak in XPath compilation (Daniel Veillard),
1700 Fix the semantic of XPath axis for namespace/attribute context nodes (Daniel Veillard),
1701 Avoid a descriptor leak in catalog loading code (Carlo Bramini),
1702 Fix a small bug in XPath evaluation code (Marius Wachtler),
1703 Fix handling of XML-1.0 XML namespace declaration (Daniel Veillard),
1704 Fix errors in XSD double validation check (Csaba Raduly),
1705 Fix handling of apos in URIs (Daniel Veillard),
1706 xmlTextReaderReadOuterXml should handle DTD (Rob Richards),
1707 Autogen.sh needs to create m4 directory (Rob Richards)
1708 </li>
1709 <li> Improvements:
1710 606592 update language ID parser to RFC 5646 (Daniel Veillard),
1711 Sort python generated stubs (Mike Hommey),
1712 Add an HTML parser option to avoid a default doctype (Daniel Veillard)
1713 </li>
1714 <li> Cleanups:
1715 618831 don't ship generated files in git (Adrian Bunk),
1716 Switch from the obsolete mkinstalldirs to AC_PROG_MKDIR_P (Adrian Bunk),
1717 Various cleanups on encoding handling (Daniel Veillard),
1718 Fix xmllint to use format=1 for default formatting (Adam Spragg),
1719 Force _xmlSaveCtxt.format to be 0 or 1 (Adam Spragg),
1720 Cleanup encoding pointer comparison (Nikolay Sivov),
1721 Small code cleanup on previous patch (Daniel Veillard)
1722 </li>
1723</ul>
Daniel Veillardf61ba8d2010-03-25 10:54:32 +01001724<h3>2.7.7: Mar 15 2010</h3>
1725<ul>
1726 <li> Improvements:
1727 Adding a --xpath option to xmllint (Daniel Veillard),
1728 Make HTML parser non-recursive (Eugene Pimenov)
1729 </li>
1730 <li> Portability:
1731 relaxng.c: cast to allow compilation with sun studio 11 (Ben Walton),
1732 Fix build failure on Sparc solaris (Roumen Petrov),
1733 use autoreconf in autogen.sh (Daniel Veillard),
1734 Fix build with mingw (Roumen Petrov),
1735 Upgrade some of the configure and autogen (Daniel Veillard),
1736 Fix relaxNG tests in runtest for Windows runtest.c: initialize ret (Rob Richards),
1737 Fix a const warning in xmlNodeSetBase (Martin Trappel),
1738 Fix python generator to not use deprecated xmllib (Daniel Veillard),
1739 Update some automake files (Daniel Veillard),
1740 598785 Fix nanohttp on Windows (spadix)
1741 </li>
1742 <li> Bug Fixes:
1743 libxml violates the zlib interface and crashes (Mark Adler),
1744 Fix broken escape behaviour in regexp ranges (Daniel Veillard),
1745 Fix missing win32 libraries in libxml-2.0.pc (Volker Grabsch),
1746 Fix detection of python linker flags (Daniel Macks),
1747 fix build error in libxml2/python (Paul Smith),
1748 ChunkParser: Incorrect decoding of small xml files (Raul Hudea),
1749 htmlCheckEncoding doesn't update input-end after shrink (Eugene Pimenov),
1750 Fix a missing #ifdef (Daniel Veillard),
1751 Fix encoding selection for xmlParseInNodeContext (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001752 xmlPreviousElementSibling mistake (François Delyon),
Daniel Veillardf61ba8d2010-03-25 10:54:32 +01001753 608773 add a missing check in xmlGROW (Daniel Veillard),
1754 Fix xmlParseInNodeContext for HTML content (Daniel Veillard),
1755 Fix lost namespace when copying node * tree.c: reconcile namespace if not found (Rob Richards),
1756 Fix some missing commas in HTML element lists (Eugene Pimenov),
1757 Correct variable type to unsigned (Nikolay Sivov),
1758 Recognize ID attribute in HTML without DOCTYPE (Daniel Veillard),
1759 Fix memory leak in xmlXPathEvalExpression() (Martin),
1760 Fix an init bug in global.c (Kai Henning),
1761 Fix xmlNodeSetBase() comment (Daniel Veillard),
1762 Fix broken escape behaviour in regexp ranges (Daniel Veillard),
1763 Don't give default HTML boolean attribute values in parser (Daniel Veillard),
1764 xmlCtxtResetLastError should reset ctxt-errNo (Daniel Veillard)
1765 </li>
1766 <li> Cleanups:
1767 Cleanup a couple of weirdness in HTML parser (Eugene Pimenov)
1768 </li>
1769</ul>
Daniel Veillard96bb7402009-10-06 18:38:15 +02001770<h3>2.7.6: Oct 6 2009</h3>
1771<ul>
1772 <li> Bug Fixes:
1773 Restore thread support in default configuration (Andrew W. Nosenko),
1774 URI with no path parsing problem (Daniel Veillard),
1775 Minor patch for conditional defines in threads.c (Eric Zurcher)
1776 </li>
1777</ul>
Daniel Veillard7a896ce2009-09-24 18:38:57 +02001778<h3>2.7.5: Sep 24 2009</h3>
1779<ul>
1780 <li> Bug Fixes:
1781 Restore behavior of --with-threads without argument (Andrew W. Nosenko),
1782 Fix memory leak when doc is NULL (Rob Richards),
1783 595792 fixing a RelaxNG bug introduced in 2.7.4 (Daniel Veillard),
1784 Fix a Relaxng bug raised by libvirt test suite (Daniel Veillard),
1785 Fix a parsing problem with little data at startup (Daniel Veillard),
1786 link python module with python library (Frederic Crozat),
1787 594874 Forgot an fclose in xmllint (Daniel Veillard)
1788 </li>
1789 <li> Cleanup:
1790 Adding symbols.xml to EXTRA_DIST (Daniel Veillard)
1791 </li>
1792</ul>
Daniel Veillard29341682009-09-10 18:23:39 +02001793<h3>2.7.4: Sep 10 2009</h3>
1794<ul>
1795 <li>Improvements:
1796 Switch to GIT (GNOME),
1797 Add symbol versioning to libxml2 shared libs (Daniel Veillard)
1798 </li>
1799 <li>Portability:
1800 593857 try to work around thread pbm MinGW 4.4 (Daniel Veillard),
1801 594250 rename ATTRIBUTE_ALLOC_SIZE to avoid clashes (Daniel Veillard),
1802 Fix Windows build * relaxng.c: fix windows build (Rob Richards),
1803 Fix the globals.h to use XMLPUBFUN (Paul Smith),
1804 Problem with extern extern in header (Daniel Veillard),
1805 Add -lnetwork for compiling on Haiku (Scott McCreary),
1806 Runtest portability patch for Solaris (Tim Rice),
1807 Small patch to accomodate the Haiku OS (Scott McCreary),
1808 584605 package VxWorks folder in the distribution (Daniel Veillard),
1809 574017 Realloc too expensive on most platform (Daniel Veillard),
1810 Fix windows build (Rob Richards),
1811 545579 doesn't compile without schema support (Daniel Veillard),
1812 xmllint use xmlGetNodePath when not compiled in (Daniel Veillard),
1813 Try to avoid __imp__xmlFree link trouble on msys (Daniel Veillard),
1814 Allow to select the threading system on Windows (LRN),
1815 Fix Solaris binary links, cleanups (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001816 Bug 571059 – MSVC doesn't work with the bakefile (Intron),
Daniel Veillard29341682009-09-10 18:23:39 +02001817 fix ATTRIBUTE_PRINTF header clash (Belgabor and Mike Hommey),
1818 fixes for Borland/CodeGear/Embarcadero compilers (Eric Zurcher)
1819 </li>
1820 <li>Documentation:
1821 544910 typo: "renciliateNs" (Leonid Evdokimov),
1822 Add VxWorks to list of OSes (Daniel Veillard),
1823 Regenerate the documentation and update for git (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001824 560524 ¿ xmlTextReaderLocalName description (Daniel Veillard),
Daniel Veillard29341682009-09-10 18:23:39 +02001825 Added sponsoring by AOE media for the server (Daniel Veillard),
1826 updated URLs for GNOME (Vincent Lefevre),
1827 more warnings about xmlCleanupThreads and xmlCleanupParser (Daniel Veillard)
1828 </li>
1829 <li>Bug fixes:
1830 594514 memory leaks - duplicate initialization (MOD),
1831 Wrong block opening in htmlNodeDumpOutputInternal (Daniel Veillard),
1832 492317 Fix Relax-NG validation problems (Daniel Veillard),
1833 558452 fight with reg test and error report (Daniel Veillard),
1834 558452 RNG compilation of optional multiple child (Daniel Veillard),
1835 579746 XSD validation not correct / nilable groups (Daniel Veillard),
1836 502960 provide namespace stack when parsing entity (Daniel Veillard),
1837 566012 part 2 fix regresion tests and push mode (Daniel Veillard),
1838 566012 autodetected encoding and encoding conflict (Daniel Veillard),
1839 584220 xpointer(/) and xinclude problems (Daniel Veillard),
1840 587663 Incorrect Attribute-Value Normalization (Daniel Veillard),
1841 444994 HTML chunked failure for attribute with &lt;&gt; (Daniel Veillard),
1842 Fix end of buffer char being split in XML parser (Daniel Veillard),
1843 Non ASCII character may be split at buffer end (Adiel Mittmann),
1844 440226 Add xmlXIncludeProcessTreeFlagsData API (Stefan Behnel),
1845 572129 speed up parsing of large HTML text nodes (Markus Kull),
1846 Fix HTML parsing with 0 character in CDATA (Daniel Veillard),
1847 Fix SetGenericErrorFunc and SetStructured clash (Wang Lam),
1848 566012 Incomplete EBCDIC parsing support (Martin Kogler),
1849 541335 HTML avoid creating 2 head or 2 body element (Daniel Veillard),
1850 541237 error correcting missing end tags in HTML (Daniel Veillard),
1851 583439 missing line numbers in push mode (Daniel Veillard),
1852 587867 xmllint --html --xmlout serializing as HTML (Daniel Veillard),
1853 559501 avoid select and use poll for nanohttp (Raphael Prevost),
1854 559410 - Regexp bug on (...)? constructs (Daniel Veillard),
1855 Fix a small problem on previous HTML parser patch (Daniel Veillard),
1856 592430 - HTML parser runs into endless loop (Daniel Veillard),
1857 447899 potential double free in xmlFreeTextReader (Daniel Veillard),
1858 446613 small validation bug mixed content with NS (Daniel Veillard),
1859 Fix the problem of revalidating a doc with RNG (Daniel Veillard),
1860 Fix xmlKeepBlanksDefault to not break indent (Nick Wellnhofer),
1861 512131 refs from externalRef part need to be added (Daniel Veillard),
1862 512131 crash in xmlRelaxNGValidateFullElement (Daniel Veillard),
1863 588441 allow '.' in HTML Names even if invalid (Daniel Veillard),
1864 582913 Fix htmlSetMetaEncoding() to be nicer (Daniel Veillard),
1865 579317 Try to find the HTML encoding information (Daniel Veillard),
1866 575875 don't output charset=html (Daniel Veillard),
1867 571271 fix semantic of xsd:all with minOccurs=0 (Daniel Veillard),
1868 570702 fix a bug in regexp determinism checking (Daniel Veillard),
1869 567619 xmlValidateNotationUse missing param test (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001870 574393 ¿ utf-8 filename magic for compressed files (Hans Breuer),
Daniel Veillard29341682009-09-10 18:23:39 +02001871 Fix a couple of problems in the parser (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001872 585505 ¿ Document ids and refs populated by XSD (Wayne Jensen),
Daniel Veillard29341682009-09-10 18:23:39 +02001873 582906 XSD validating multiple imports of the same schema (Jason Childs),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001874 Bug 582887 ¿ problems validating complex schemas (Jason Childs),
1875 Bug 579729 ¿ fix XSD schemas parsing crash (Miroslav Bajtos),
1876 576368 ¿ htmlChunkParser with special attributes (Jiri Netolicky),
1877 Bug 565747 ¿ relax anyURI data character checking (Vincent Lefevre),
Daniel Veillard29341682009-09-10 18:23:39 +02001878 Preserve attributes of include start on tree copy (Petr Pajas),
1879 Skip silently unrecognized XPointer schemes (Jakub Wilk),
1880 Fix leak on SAX1, xmllint --sax1 option and debug (Daniel Veillard),
1881 potential NULL dereference on non-glibc (Jim Meyering),
1882 Fix an XSD validation crash (Daniel Veillard),
1883 Fix a regression in streaming entities support (Daniel Veillard),
1884 Fix a couple of ABI issues with C14N 1.1 (Aleksey Sanin),
1885 Aleksey Sanin support for c14n 1.1 (Aleksey Sanin),
1886 reader bug fix with entities (Daniel Veillard),
1887 use options from current parser ctxt for external entities (Rob Richards),
1888 581612 use %s to printf strings (Christian Persch),
1889 584605 change the threading initialization sequence (Igor Novoseltsev),
1890 580705 keep line numbers in HTML parser (Aaron Patterson),
1891 581803 broken HTML table attributes init (Roland Steiner),
1892 do not set error code in xmlNsWarn (Rob Richards),
1893 564217 fix structured error handling problems,
1894 reuse options from current parser for entities (Rob Richards),
1895 xmlXPathRegisterNs should not allow enpty prefixes (Daniel Veillard),
1896 add a missing check in xmlAddSibling (Kris Breuker),
1897 avoid leaks on errors (Jinmei Tatuya)
1898 </li>
1899 <li>Cleanup:
1900 Chasing dead assignments reported by clang-scan (Daniel Veillard),
1901 A few more safety cleanup raised by scan (Daniel Veillard),
1902 Fixing assorted potential problems raised by scan (Daniel Veillard),
1903 Potential uninitialized arguments raised by scan (Daniel Veillard),
1904 Fix a bunch of scan 'dead increments' and cleanup (Daniel Veillard),
1905 Remove a pedantic warning (Daniel Veillard),
1906 555833 always use rm -f in uninstall-local (Daniel Veillard),
1907 542394 xmlRegisterOutputCallbacks MAX_INPUT_CALLBACK (Daniel Veillard),
1908 Autoregenerate libxml2.syms automated checkings (Daniel Veillard),
1909 Make xmlRecoverDoc const (Martin Trappel) (Daniel Veillard),
1910 Both args of xmlStrcasestr are const (Daniel Veillard),
1911 hide the nbParse* variables used for debugging (Mike Hommey),
1912 570806 changed include of config.h (William M. Brack),
1913 cleanups and error reports when xmlTextWriterVSprintf fails (Jinmei Tatuya)
1914 </li>
1915</ul>
Daniel Veillard97ff9b32009-01-18 21:43:30 +00001916<h3>2.7.3: Jan 18 2009</h3>
1917<ul>
1918 <li>Build fix: fix build when HTML support is not included.</li>
1919 <li>Bug fixes: avoid memory overflow in gigantic text nodes,
1920 indentation problem on the writed (Rob Richards),
1921 xmlAddChildList pointer problem (Rob Richards and Kevin Milburn),
1922 xmlAddChild problem with attribute (Rob Richards and Kris Breuker),
1923 avoid a memory leak in an edge case (Daniel Zimmermann),
1924 deallocate some pthread data (Alex Ott).</li>
1925 <li>Improvements: configure option to avoid rebuilding docs (Adrian Bunk),
1926 limit text nodes to 10MB max by default, add element traversal
1927 APIs, add a parser option to enable pre 2.7 SAX behavior (Rob Richards),
1928 add gcc malloc checking (Marcus Meissner), add gcc printf like functions
1929 parameters checking (Marcus Meissner).</li>
1930</ul>
Daniel Veillard7f4547c2008-10-03 07:58:23 +00001931<h3>2.7.2: Oct 3 2008</h3>
1932<ul>
1933 <li>Portability fix: fix solaris compilation problem, fix compilation
1934 if XPath is not configured in</li>
1935 <li>Bug fixes: nasty entity bug introduced in 2.7.0, restore old behaviour
1936 when saving an HTML doc with an xml dump function, HTML UTF-8 parsing
1937 bug, fix reader custom error handlers (Riccardo Scussat)
1938 <li>Improvement: xmlSave options for more flexibility to save as
1939 XML/HTML/XHTML, handle leading BOM in HTML documents</li>
1940</ul>
1941
Daniel Veillarda7036d92008-09-01 14:50:19 +00001942<h3>2.7.1: Sep 1 2008</h3>
1943<ul>
1944 <li>Portability fix: Borland C fix (Moritz Both)</li>
1945 <li>Bug fixes: python serialization wrappers, XPath QName corner
1946 case handking and leaks (Martin)</li>
1947 <li>Improvement: extend the xmlSave to handle HTML documents and trees</li>
1948 <li>Cleanup: python serialization wrappers</li>
1949</ul>
1950
Daniel Veillard15724252008-08-30 15:01:04 +00001951<h3>2.7.0: Aug 30 2008</h3>
1952<ul>
1953 <li>Documentation: switch ChangeLog to UTF-8, improve mutithreads and
1954 xmlParserCleanup docs</li>
1955 <li>Portability fixes: Older Win32 platforms (Rob Richards), MSVC
1956 porting fix (Rob Richards), Mac OS X regression tests (Sven Herzberg),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02001957 non GNUCC builds (Rob Richards), compilation on Haiku (Andreas Färber)
Daniel Veillard15724252008-08-30 15:01:04 +00001958 </li>
1959 <li>Bug fixes: various realloc problems (Ashwin), potential double-free
1960 (Ashwin), regexp crash, icrash with invalid whitespace facets (Rob
1961 Richards), pattern fix when streaming (William Brack), various XML
1962 parsing and validation fixes based on the W3C regression tests, reader
1963 tree skipping function fix (Ashwin), Schemas regexps escaping fix
1964 (Volker Grabsch), handling of entity push errors (Ashwin), fix a slowdown
1965 when encoder cant serialize characters on output</li>
1966 <li>Code cleanup: compilation fix without the reader, without the output
1967 (Robert Schwebel), python whitespace (Martin), many space/tabs cleanups,
1968 serious cleanup of the entity handling code</li>
1969 <li>Improvement: switch parser to XML-1.0 5th edition, add parsing flags
1970 for old versions, switch URI parsing to RFC 3986,
1971 add xmlSchemaValidCtxtGetParserCtxt (Holger Kaelberer),
1972 new hashing functions for dictionnaries (based on Stefan Behnel work),
1973 improve handling of misplaced html/head/body in HTML parser, better
1974 regression test tools and code coverage display, better algorithms
1975 to detect various versions of the billion laughts attacks, make
1976 arbitrary parser limits avoidable as a parser option</li>
1977</ul>
Daniel Veillard596da972008-04-08 14:58:41 +00001978<h3>2.6.32: Apr 8 2008</h3>
1979<ul>
1980 <li>Documentation: returning heap memory to kernel (Wolfram Sang),
1981 trying to clarify xmlCleanupParser() use, xmlXPathContext improvement
1982 (Jack Jansen), improve the *Recover* functions documentation,
1983 XmlNodeType doc link fix (Martijn Arts)</li>
1984 <li>Bug fixes: internal subset memory leak (Ashwin), avoid problem with
1985 paths starting with // (Petr Sumbera), streaming XSD validation callback
1986 patches (Ashwin), fix redirection on port other than 80 (William Brack),
1987 SAX2 leak (Ashwin), XInclude fragment of own document (Chris Ryan),
1988 regexp bug with '.' (Andrew Tosh), flush the writer at the end of the
1989 document (Alfred Mickautsch), output I/O bug fix (William Brack),
1990 writer CDATA output after a text node (Alex Khesin), UTF-16 encoding
1991 detection (William Brack), fix handling of empty CDATA nodes for Safari
1992 team, python binding problem with namespace nodes, improve HTML parsing
1993 (Arnold Hendriks), regexp automata build bug, memory leak fix (Vasily
1994 Chekalkin), XSD test crash, weird system parameter entity parsing problem,
1995 allow save to file:///X:/ windows paths, various attribute normalisation
1996 problems, externalSubsetSplit fix (Ashwin), attribute redefinition in
1997 the DTD (Ashwin), fix in char ref parsing check (Alex Khesin), many
1998 out of memory handling fixes (Ashwin), XPath out of memory handling fixes
1999 (Alvaro Herrera), various realloc problems (Ashwin), UCS4 encoding
2000 conversion buffer size (Christian Fruth), problems with EatName
2001 functions on memory errors, BOM handling in external parsed entities
2002 (Mark Rowe)</li>
2003 <li>Code cleanup: fix build under VS 2008 (David Wimsey), remove useless
2004 mutex in xmlDict (Florent Guilian), Mingw32 compilation fix (Carlo
2005 Bramini), Win and MacOS EOL cleanups (Florent Guiliani), iconv need
2006 a const detection (Roumen Petrov), simplify xmlSetProp (Julien Charbon),
2007 cross compilation fixes for Mingw (Roumen Petrov), SCO Openserver build
2008 fix (Florent Guiliani), iconv uses const on Win32 (Rob Richards),
2009 duplicate code removal (Ashwin), missing malloc test and error reports
2010 (Ashwin), VMS makefile fix (Tycho Hilhorst)</li>
2011 <li>improvements: better plug of schematron in the normal error handling
2012 (Tobias Minich)</li>
2013</ul>
2014
Daniel Veillard28b64e22008-01-11 09:07:51 +00002015<h3>2.6.31: Jan 11 2008</h3>
2016<ul>
2017 <li>Security fix: missing of checks in UTF-8 parsing</li>
2018 <li>Bug fixes: regexp bug, dump attribute from XHTML document, fix
2019 xmlFree(NULL) to not crash in debug mode, Schematron parsing crash
2020 (Rob Richards), global lock free on Windows (Marc-Antoine Ruel),
2021 XSD crash due to double free (Rob Richards), indentation fix in
2022 xmlTextWriterFullEndElement (Felipe Pena), error in attribute type
2023 parsing if attribute redeclared, avoid crash in hash list scanner if
2024 deleting elements, column counter bug fix (Christian Schmidt),
2025 HTML embed element saving fix (Stefan Behnel), avoid -L/usr/lib
2026 output from xml2-config (Fred Crozat), avoid an xmllint crash
2027 (Stefan Kost), don't stop HTML parsing on out of range chars.
2028 </li>
2029 <li>Code cleanup: fix open() call third argument, regexp cut'n paste
2030 copy error, unused variable in __xmlGlobalInitMutexLock (Hannes Eder),
2031 some make distcheck realted fixes (John Carr)</li>
2032 <li>Improvements: HTTP Header: includes port number (William Brack),
2033 testURI --debug option, </li>
2034</ul>
Daniel Veillardc1b3fe02007-08-23 15:00:06 +00002035<h3>2.6.30: Aug 23 2007</h3>
2036<ul>
2037 <li>Portability: Solaris crash on error handling, windows path fixes
2038 (Roland Schwarz and Rob Richards), mingw build (Roland Schwarz)</li>
2039 <li>Bugfixes: xmlXPathNodeSetSort problem (William Brack), leak when
2040 reusing a writer for a new document (Dodji Seketeli), Schemas
2041 xsi:nil handling patch (Frank Gross), relative URI build problem
2042 (Patrik Fimml), crash in xmlDocFormatDump, invalid char in comment
2043 detection bug, fix disparity with xmlSAXUserParseMemory, automata
2044 generation for complex regexp counts problems, Schemas IDC import
2045 problems (Frank Gross), xpath predicate evailation error handling
2046 (William Brack)</li>
2047</ul>
Daniel Veillard38431c32007-06-12 16:20:09 +00002048<h3>2.6.29: Jun 12 2007</h3>
2049<ul>
2050 <li>Portability: patches from Andreas Stricke for WinCEi,
2051 fix compilation warnings (William Brack), avoid warnings on Apple OS/X
2052 (Wendy Doyle and Mark Rowe), Windows compilation and threading
2053 improvements (Rob Richards), compilation against old Python versions,
2054 new GNU tar changes (Ryan Hill)</li>
2055 <li>Documentation: xmlURIUnescapeString comment, </li>
2056 <li>Bugfixes: xmlBufferAdd problem (Richard Jones), 'make valgrind'
2057 flag fix (Richard Jones), regexp interpretation of \,
2058 htmlCreateDocParserCtxt (Jean-Daniel Dupas), configure.in
2059 typo (Bjorn Reese), entity content failure, xmlListAppend() fix
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002060 (Georges-André Silber), XPath number serialization (William Brack),
Daniel Veillard38431c32007-06-12 16:20:09 +00002061 nanohttp gzipped stream fix (William Brack and Alex Cornejo),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002062 xmlCharEncFirstLine typo (Mark Rowe), uri bug (François Delyon),
Daniel Veillard38431c32007-06-12 16:20:09 +00002063 XPath string value of PI nodes (William Brack), XPath node set
2064 sorting bugs (William Brack), avoid outputting namespace decl
2065 dups in the writer (Rob Richards), xmlCtxtReset bug, UTF-8 encoding
2066 error handling, recustion on next in catalogs, fix a Relax-NG crash,
2067 workaround wrong file: URIs, htmlNodeDumpFormatOutput on attributes,
2068 invalid character in attribute detection bug, big comments before
2069 internal subset streaming bug, HTML parsing of attributes with : in
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002070 the name, IDness of name in HTML (Dagfinn I. Mannsåker) </li>
Daniel Veillard38431c32007-06-12 16:20:09 +00002071 <li>Improvement: keep URI query parts in raw form (Richard Jones),
2072 embed tag support in HTML (Michael Day) </li>
2073</ul>
2074
Daniel Veillard39bcf942007-04-17 14:47:05 +00002075<h3>2.6.28: Apr 17 2007</h3>
2076<ul>
2077 <li>Documentation: comment fixes (Markus Keim), xpath comments fixes too
2078 (James Dennett)</li>
2079 <li>Bug fixes: XPath bug (William Brack), HTML parser autoclose stack usage
2080 (Usamah Malik), various regexp bug fixes (DV and William), path conversion
2081 on Windows (Igor Zlatkovic), htmlCtxtReset fix (Michael Day), XPath
2082 principal node of axis bug, HTML serialization of some codepoint
2083 (Steven Rainwater), user data propagation in XInclude (Michael Day),
2084 standalone and XML decl detection (Michael Day), Python id ouptut
2085 for some id, fix the big python string memory leak, URI parsing fixes
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002086 (Stéphane Bidoul and William), long comments parsing bug (William),
Daniel Veillard39bcf942007-04-17 14:47:05 +00002087 concurrent threads initialization (Ted Phelps), invalid char
2088 in text XInclude (William), XPath memory leak (William), tab in
2089 python problems (Andreas Hanke), XPath node comparison error
2090 (Oleg Paraschenko), cleanup patch for reader (Julien Reichel),
2091 XML Schemas attribute group (William), HTML parsing problem (William),
2092 fix char 0x2d in regexps (William), regexp quantifier range with
2093 min occurs of 0 (William), HTML script/style parsing (Mike Day)</li>
2094 <li>Improvement: make xmlTextReaderSetup() public</li>
2095 <li>Compilation and postability: fix a missing include problem (William),
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002096 __ss_familly on AIX again (Björn Wiberg), compilation without zlib
Daniel Veillard39bcf942007-04-17 14:47:05 +00002097 (Michael Day), catalog patch for Win32 (Christian Ehrlicher),
2098 Windows CE fixes (Andreas Stricke)</li>
2099 <li>Various CVS to SVN infrastructure changes</li>
2100</ul>
Daniel Veillardc8338f12006-10-25 16:06:29 +00002101<h3>2.6.27: Oct 25 2006</h3>
2102<ul>
2103 <li>Portability fixes: file names on windows (Roland Schwingel,
2104 Emelyanov Alexey), windows compile fixup (Rob Richards),
2105 AIX iconv() is apparently case sensitive</li>
2106 <li>improvements: Python XPath types mapping (Nic Ferrier), XPath optimization
2107 (Kasimier), add xmlXPathCompiledEvalToBoolean (Kasimier), Python node
2108 equality and comparison (Andreas Pakulat), xmlXPathCollectAndTest
2109 improvememt (Kasimier), expose if library was compiled with zlib
2110 support (Andrew Nosenko), cache for xmlSchemaIDCMatcher structs
2111 (Kasimier), xmlTextConcat should work with comments and PIs (Rob
2112 Richards), export htmlNewParserCtxt needed by Michael Day, refactoring
2113 of catalog entity loaders (Michael Day), add XPointer support to
2114 python bindings (Ross Reedstrom, Brian West and Stefan Anca),
2115 try to sort out most file path to URI conversions and xmlPathToUri,
2116 add --html --memory case to xmllint</li>
2117 <li>building fix: fix --with-minimum (Felipe Contreras), VMS fix,
2118 const'ification of HTML parser structures (Matthias Clasen),
2119 portability fix (Emelyanov Alexey), wget autodetection (Peter
2120 Breitenlohner), remove the build path recorded in the python
2121 shared module, separate library flags for shared and static builds
2122 (Mikhail Zabaluev), fix --with-minimum --with-sax1 builds, fix
2123 --with-minimum --with-schemas builds</li>
2124 <li>bug fix: xmlGetNodePath fix (Kasimier), xmlDOMWrapAdoptNode and
2125 attribute (Kasimier), crash when using the recover mode,
2126 xmlXPathEvalExpr problem (Kasimier), xmlXPathCompExprAdd bug (Kasimier),
2127 missing destry in xmlFreeRMutex (Andrew Nosenko), XML Schemas fixes
2128 (Kasimier), warning on entities processing, XHTML script and style
2129 serialization (Kasimier), python generator for long types, bug in
2130 xmlSchemaClearValidCtxt (Bertrand Fritsch), xmlSchemaXPathEvaluate
2131 allocation bug (Marton Illes), error message end of line (Rob Richards),
2132 fix attribute serialization in writer (Rob Richards), PHP4 DTD validation
2133 crasher, parser safety patch (Ben Darnell), _private context propagation
2134 when parsing entities (with Michael Day), fix entities behaviour when
2135 using SAX, URI to file path fix (Mikhail Zabaluev), disapearing validity
2136 context, arg error in SAX callback (Mike Hommey), fix mixed-content
2137 autodetect when using --noblanks, fix xmlIOParseDTD error handling,
2138 fix bug in xmlSplitQName on special Names, fix Relax-NG element content
2139 validation bug, fix xmlReconciliateNs bug, fix potential attribute
2140 XML parsing bug, fix line/column accounting in XML parser, chunking bug
2141 in the HTML parser on script, try to detect obviously buggy HTML
2142 meta encoding indications, bugs with encoding BOM and xmlSaveDoc,
2143 HTML entities in attributes parsing, HTML minimized attribute values,
2144 htmlReadDoc and htmlReadIO were broken, error handling bug in
2145 xmlXPathEvalExpression (Olaf Walkowiak), fix a problem in
2146 htmlCtxtUseOptions, xmlNewInputFromFile could leak (Marius Konitzer),
2147 bug on misformed SSD regexps (Christopher Boumenot)
2148 </li>
2149 <li>documentation: warning about XML_PARSE_COMPACT (Kasimier Buchcik),
2150 fix xmlXPathCastToString documentation, improve man pages for
2151 xmllitn and xmlcatalog (Daniel Leidert), fixed comments of a few
2152 functions</li>
2153</ul>
Daniel Veillardfabafd52006-06-08 08:16:33 +00002154<h3>2.6.26: Jun 6 2006</h3>
Daniel Veillard69839ba2006-06-06 13:27:03 +00002155<ul>
Daniel Veillardfabafd52006-06-08 08:16:33 +00002156 <li>portability fixes: Python detection (Joseph Sacco), compilation
2157 error(William Brack and Graham Bennett), LynxOS patch (Olli Savia)</li>
2158 <li>bug fixes: encoding buffer problem, mix of code and data in
2159 xmlIO.c(Kjartan Maraas), entities in XSD validation (Kasimier Buchcik),
2160 variousXSD validation fixes (Kasimier), memory leak in pattern (Rob
2161 Richards andKasimier), attribute with colon in name (Rob Richards), XPath
2162 leak inerror reporting (Aleksey Sanin), XInclude text include of
2163 selfdocument.</li>
2164 <li>improvements: Xpath optimizations (Kasimier), XPath object
2165 cache(Kasimier)</li>
Daniel Veillard69839ba2006-06-06 13:27:03 +00002166</ul>
2167
Daniel Veillardfabafd52006-06-08 08:16:33 +00002168<h3>2.6.25: Jun 6 2006:</h3>
2169
2170<p>Do not use or package 2.6.25</p>
2171
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +00002172<h3>2.6.24: Apr 28 2006</h3>
2173<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002174 <li>Portability fixes: configure on Windows, testapi compile on windows
2175 (Kasimier Buchcik, venkat naidu), Borland C++ 6 compile (Eric Zurcher),
2176 HP-UX compiler workaround (Rick Jones), xml2-config bugfix, gcc-4.1
2177 cleanups, Python detection scheme (Joseph Sacco), UTF-8 file paths on
2178 Windows (Roland Schwingel).
2179 </li>
2180 <li>Improvements: xmlDOMWrapReconcileNamespaces xmlDOMWrapCloneNode (Kasimier
2181 Buchcik), XML catalog debugging (Rick Jones), update to Unicode 4.01.</li>
2182 <li>Bug fixes: xmlParseChunk() problem in 2.6.23, xmlParseInNodeContext()
2183 on HTML docs, URI behaviour on Windows (Rob Richards), comment streaming
2184 bug, xmlParseComment (with William Brack), regexp bug fixes (DV &amp;
2185 Youri Golovanov), xmlGetNodePath on text/CDATA (Kasimier),
2186 one Relax-NG interleave bug, xmllint --path and --valid,
2187 XSD bugfixes (Kasimier), remove debug
2188 left in Python bindings (Nic Ferrier), xmlCatalogAdd bug (Martin Cole),
2189 xmlSetProp fixes (Rob Richards), HTML IDness (Rob Richards), a large
2190 number of cleanups and small fixes based on Coverity reports, bug
2191 in character ranges, Unicode tables const (Aivars Kalvans), schemas
2192 fix (Stefan Kost), xmlRelaxNGParse error deallocation,
2193 xmlSchemaAddSchemaDoc error deallocation, error handling on unallowed
2194 code point, ixmllint --nonet to never reach the net (Gary Coady),
2195 line break in writer after end PI (Jason Viers). </li>
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +00002196 <li>Documentation: man pages updates and cleanups (Daniel Leidert).</li>
2197 <li>New features: Relax NG structure error handlers.</li>
2198</ul>
2199
Daniel Veillard67952602006-01-05 15:29:44 +00002200<h3>2.6.23: Jan 5 2006</h3>
2201<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002202 <li>portability fixes: Windows (Rob Richards), getaddrinfo on Windows
2203 (Kolja Nowak, Rob Richards), icc warnings (Kjartan Maraas),
2204 --with-minimum compilation fixes (William Brack), error case handling fix
2205 on Solaris (Albert Chin), don't use 'list' as parameter name reported by
2206 Samuel Diaz Garcia, more old Unices portability fixes (Albert Chin),
2207 MinGW compilation (Mark Junker), HP-UX compiler warnings (Rick
2208 Jones),</li>
2209 <li>code cleanup: xmlReportError (Adrian Mouat), remove xmlBufferClose
2210 (Geert Jansen), unreachable code (Oleksandr Kononenko), refactoring
2211 parsing code (Bjorn Reese)</li>
2212 <li>bug fixes: xmlBuildRelativeURI and empty path (William Brack),
2213 combinatory explosion and performances in regexp code, leak in
2214 xmlTextReaderReadString(), xmlStringLenDecodeEntities problem (Massimo
2215 Morara), Identity Constraints bugs and a segfault (Kasimier Buchcik),
2216 XPath pattern based evaluation bugs (DV &amp; Kasimier),
2217 xmlSchemaContentModelDump() memory leak (Kasimier), potential leak in
2218 xmlSchemaCheckCSelectorXPath(), xmlTextWriterVSprintf() misuse of
2219 vsnprintf (William Brack), XHTML serialization fix (Rob Richards), CRLF
2220 split problem (William), issues with non-namespaced attributes in
2221 xmlAddChild() xmlAddNextSibling() and xmlAddPrevSibling() (Rob Richards),
2222 HTML parsing of script, Python must not output to stdout (Nic Ferrier),
2223 exclusive C14N namespace visibility (Aleksey Sanin), XSD dataype
2224 totalDigits bug (Kasimier Buchcik), error handling when writing to an
2225 xmlBuffer (Rob Richards), runtest schemas error not reported (Hisashi
2226 Fujinaka), signed/unsigned problem in date/time code (Albert Chin), fix
2227 XSI driven XSD validation (Kasimier), parsing of xs:decimal (Kasimier),
2228 fix DTD writer output (Rob Richards), leak in xmlTextReaderReadInnerXml
2229 (Gary Coady), regexp bug affecting schemas (Kasimier), configuration of
2230 runtime debugging (Kasimier), xmlNodeBufGetContent bug on entity refs
2231 (Oleksandr Kononenko), xmlRegExecPushString2 bug (Sreeni Nair),
2232 compilation and build fixes (Michael Day), removed dependancies on
2233 xmlSchemaValidError (Kasimier), bug with &lt;xml:foo/&gt;, more XPath
2234 pattern based evaluation fixes (Kasimier)</li>
2235 <li>improvements: XSD Schemas redefinitions/restrictions (Kasimier
2236 Buchcik), node copy checks and fix for attribute (Rob Richards), counted
2237 transition bug in regexps, ctxt-&gt;standalone = -2 to indicate no
2238 standalone attribute was found, add xmlSchemaSetParserStructuredErrors()
2239 (Kasimier Buchcik), add xmlTextReaderSchemaValidateCtxt() to API
2240 (Kasimier), handle gzipped HTTP resources (Gary Coady), add
2241 htmlDocDumpMemoryFormat. (Rob Richards),</li>
2242 <li>documentation: typo (Michael Day), libxml man page (Albert Chin), save
2243 function to XML buffer (Geert Jansen), small doc fix (Aron Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +00002244</ul>
2245
Daniel Veillard33b20b72005-09-12 21:43:20 +00002246<h3>2.6.22: Sep 12 2005</h3>
2247<ul>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002248 <li>build fixes: compile without schematron (Stéphane Bidoul)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002249 <li>bug fixes: xmlDebugDumpNode on namespace node (Oleg Paraschenko)i,
2250 CDATA push parser bug, xmlElemDump problem with XHTML1 doc,
2251 XML_FEATURE_xxx clash with expat headers renamed XML_WITH_xxx, fix some
2252 output formatting for meta element (Rob Richards), script and style
2253 XHTML1 serialization (David Madore), Attribute derivation fixups in XSD
2254 (Kasimier Buchcik), better IDC error reports (Kasimier Buchcik)</li>
2255 <li>improvements: add XML_SAVE_NO_EMPTY xmlSaveOption (Rob Richards), add
2256 XML_SAVE_NO_XHTML xmlSaveOption, XML Schemas improvements preparing for
2257 derive (Kasimier Buchcik).</li>
2258 <li>documentation: generation of gtk-doc like docs, integration with
2259 devhelp.</li>
Daniel Veillard33b20b72005-09-12 21:43:20 +00002260</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00002261
Daniel Veillardb3d14912005-09-04 20:47:39 +00002262<h3>2.6.21: Sep 4 2005</h3>
2263<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002264 <li>build fixes: Cygwin portability fixes (Gerrit P. Haase), calling
2265 convention problems on Windows (Marcus Boerger), cleanups based on Linus'
2266 sparse tool, update of win32/configure.js (Rob Richards), remove warnings
2267 on Windows(Marcus Boerger), compilation without SAX1, detection of the
2268 Python binary, use $GCC inestad of $CC = 'gcc' (Andrew W. Nosenko),
2269 compilation/link with threads and old gcc, compile problem by C370 on
2270 Z/OS,</li>
2271 <li>bug fixes: http_proxy environments (Peter Breitenlohner), HTML UTF-8
2272 bug (Jiri Netolicky), XPath NaN compare bug (William Brack),
2273 htmlParseScript potential bug, Schemas regexp handling of spaces, Base64
2274 Schemas comparisons NIST passes, automata build error xsd:all,
2275 xmlGetNodePath for namespaced attributes (Alexander Pohoyda), xmlSchemas
2276 foreign namespaces handling, XML Schemas facet comparison (Kupriyanov
2277 Anatolij), xmlSchemaPSimpleTypeErr error report (Kasimier Buchcik), xml:
2278 namespace ahndling in Schemas (Kasimier), empty model group in Schemas
2279 (Kasimier), wilcard in Schemas (Kasimier), URI composition (William),
2280 xs:anyType in Schemas (Kasimier), Python resolver emmitting error
2281 messages directly, Python xmlAttr.parent (Jakub Piotr Clapa), trying to
2282 fix the file path/URI conversion, xmlTextReaderGetAttribute fix (Rob
2283 Richards), xmlSchemaFreeAnnot memleak (Kasimier), HTML UTF-8
2284 serialization, streaming XPath, Schemas determinism detection problem,
2285 XInclude bug, Schemas context type (Dean Hill), validation fix (Derek
2286 Poon), xmlTextReaderGetAttribute[Ns] namespaces (Rob Richards), Schemas
2287 type fix (Kuba Nowakowski), UTF-8 parser bug, error in encoding handling,
2288 xmlGetLineNo fixes, bug on entities handling, entity name extraction in
2289 error handling with XInclude, text nodes in HTML body tags (Gary Coady),
2290 xml:id and IDness at the treee level fixes, XPath streaming patterns
2291 bugs.</li>
2292 <li>improvements: structured interfaces for schemas and RNG error reports
2293 (Marcus Boerger), optimization of the char data inner loop parsing
2294 (thanks to Behdad Esfahbod for the idea), schematron validation though
2295 not finished yet, xmlSaveOption to omit XML declaration, keyref match
2296 error reports (Kasimier), formal expression handling code not plugged
2297 yet, more lax mode for the HTML parser, parser XML_PARSE_COMPACT option
2298 for text nodes allocation.</li>
Daniel Veillardb3d14912005-09-04 20:47:39 +00002299 <li>documentation: xmllint man page had --nonet duplicated</li>
2300</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00002301
Daniel Veillard78dfc9f2005-07-10 22:30:30 +00002302<h3>2.6.20: Jul 10 2005</h3>
2303<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002304 <li>build fixes: Windows build (Rob Richards), Mingw compilation (Igor
2305 Zlatkovic), Windows Makefile (Igor), gcc warnings (Kasimier and
2306 andriy@google.com), use gcc weak references to pthread to avoid the
2307 pthread dependancy on Linux, compilation problem (Steve Nairn), compiling
2308 of subset (Morten Welinder), IPv6/ss_family compilation (William Brack),
2309 compilation when disabling parts of the library, standalone test
2310 distribution.</li>
2311 <li>bug fixes: bug in lang(), memory cleanup on errors (William Brack),
2312 HTTP query strings (Aron Stansvik), memory leak in DTD (William), integer
2313 overflow in XPath (William), nanoftp buffer size, pattern "." apth fixup
2314 (Kasimier), leak in tree reported by Malcolm Rowe, replaceNode patch
2315 (Brent Hendricks), CDATA with NULL content (Mark Vakoc), xml:base fixup
2316 on XInclude (William), pattern fixes (William), attribute bug in
2317 exclusive c14n (Aleksey Sanin), xml:space and xml:lang with SAX2 (Rob
2318 Richards), namespace trouble in complex parsing (Malcolm Rowe), XSD type
2319 QNames fixes (Kasimier), XPath streaming fixups (William), RelaxNG bug
2320 (Rob Richards), Schemas for Schemas fixes (Kasimier), removal of ID (Rob
2321 Richards), a small RelaxNG leak, HTML parsing in push mode bug (James
2322 Bursa), failure to detect UTF-8 parsing bugs in CDATA sections,
2323 areBlanks() heuristic failure, duplicate attributes in DTD bug
2324 (William).</li>
2325 <li>improvements: lot of work on Schemas by Kasimier Buchcik both on
2326 conformance and streaming, Schemas validation messages (Kasimier Buchcik,
2327 Matthew Burgess), namespace removal at the python level (Brent
2328 Hendricks), Update to new Schemas regression tests from W3C/Nist
2329 (Kasimier), xmlSchemaValidateFile() (Kasimier), implementation of
2330 xmlTextReaderReadInnerXml and xmlTextReaderReadOuterXml (James Wert),
2331 standalone test framework and programs, new DOM import APIs
2332 xmlDOMWrapReconcileNamespaces() xmlDOMWrapAdoptNode() and
2333 xmlDOMWrapRemoveNode(), extension of xmllint capabilities for SAX and
2334 Schemas regression tests, xmlStopParser() available in pull mode too,
2335 ienhancement to xmllint --shell namespaces support, Windows port of the
2336 standalone testing tools (Kasimier and William),
2337 xmlSchemaValidateStream() xmlSchemaSAXPlug() and xmlSchemaSAXUnplug() SAX
2338 Schemas APIs, Schemas xmlReader support.</li>
Daniel Veillard78dfc9f2005-07-10 22:30:30 +00002339</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00002340
Daniel Veillard771971f2005-04-02 10:49:51 +00002341<h3>2.6.19: Apr 02 2005</h3>
2342<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002343 <li>build fixes: drop .la from RPMs, --with-minimum build fix (William
2344 Brack), use XML_SOCKLEN_T instead of SOCKLEN_T because it breaks with AIX
2345 5.3 compiler, fixed elfgcchack.h generation and PLT reduction code on
2346 Linux/ELF/gcc4</li>
2347 <li>bug fixes: schemas type decimal fixups (William Brack), xmmlint return
2348 code (Gerry Murphy), small schemas fixes (Matthew Burgess and GUY
2349 Fabrice), workaround "DAV:" namespace brokeness in c14n (Aleksey Sanin),
2350 segfault in Schemas (Kasimier Buchcik), Schemas attribute validation
2351 (Kasimier), Prop related functions and xmlNewNodeEatName (Rob Richards),
2352 HTML serialization of name attribute on a elements, Python error handlers
2353 leaks and improvement (Brent Hendricks), uninitialized variable in
2354 encoding code, Relax-NG validation bug, potential crash if
2355 gnorableWhitespace is NULL, xmlSAXParseDoc and xmlParseDoc signatures,
2356 switched back to assuming UTF-8 in case no encoding is given at
2357 serialization time</li>
2358 <li>improvements: lot of work on Schemas by Kasimier Buchcik on facets
2359 checking and also mixed handling.</li>
Daniel Veillard771971f2005-04-02 10:49:51 +00002360 <li></li>
2361</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00002362
Daniel Veillard57c000e2005-03-13 18:34:29 +00002363<h3>2.6.18: Mar 13 2005</h3>
2364<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002365 <li>build fixes: warnings (Peter Breitenlohner), testapi.c generation,
2366 Bakefile support (Francesco Montorsi), Windows compilation (Joel Reed),
2367 some gcc4 fixes, HP-UX portability fixes (Rick Jones).</li>
2368 <li>bug fixes: xmlSchemaElementDump namespace (Kasimier Buchcik), push and
2369 xmlreader stopping on non-fatal errors, thread support for dictionnaries
2370 reference counting (Gary Coady), internal subset and push problem, URL
2371 saved in xmlCopyDoc, various schemas bug fixes (Kasimier), Python paths
2372 fixup (Stephane Bidoul), xmlGetNodePath and namespaces, xmlSetNsProp fix
2373 (Mike Hommey), warning should not count as error (William Brack),
2374 xmlCreatePushParser empty chunk, XInclude parser flags (William), cleanup
2375 FTP and HTTP code to reuse the uri parsing and IPv6 (William),
2376 xmlTextWriterStartAttributeNS fix (Rob Richards), XMLLINT_INDENT being
2377 empty (William), xmlWriter bugs (Rob Richards), multithreading on Windows
2378 (Rich Salz), xmlSearchNsByHref fix (Kasimier), Python binding leak (Brent
2379 Hendricks), aliasing bug exposed by gcc4 on s390, xmlTextReaderNext bug
2380 (Rob Richards), Schemas decimal type fixes (William Brack),
2381 xmlByteConsumed static buffer (Ben Maurer).</li>
Nick Wellnhofer8bbe4502017-06-17 16:15:09 +02002382 <li>improvement: speedup parsing comments and DTDs, dictionary support for
Daniel Veillardf781dba2006-06-09 13:34:49 +00002383 hash tables, Schemas Identity constraints (Kasimier), streaming XPath
2384 subset, xmlTextReaderReadString added (Bjorn Reese), Schemas canonical
2385 values handling (Kasimier), add xmlTextReaderByteConsumed (Aron
2386 Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +00002387 <li>Documentation: Wiki support (Joel Reed)</li>
Daniel Veillard57c000e2005-03-13 18:34:29 +00002388</ul>
Daniel Veillard67952602006-01-05 15:29:44 +00002389
Daniel Veillard298d9642005-01-16 20:01:55 +00002390<h3>2.6.17: Jan 16 2005</h3>
2391<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002392 <li>build fixes: Windows, warnings removal (William Brack),
2393 maintainer-clean dependency(William), build in a different directory
2394 (William), fixing --with-minimum configure build (William), BeOS build
2395 (Marcin Konicki), Python-2.4 detection (William), compilation on AIX (Dan
2396 McNichol)</li>
2397 <li>bug fixes: xmlTextReaderHasAttributes (Rob Richards), xmlCtxtReadFile()
2398 to use the catalog(s), loop on output (William Brack), XPath memory leak,
2399 ID deallocation problem (Steve Shepard), debugDumpNode crash (William),
2400 warning not using error callback (William), xmlStopParser bug (William),
2401 UTF-16 with BOM on DTDs (William), namespace bug on empty elements in
2402 push mode (Rob Richards), line and col computations fixups (Aleksey
2403 Sanin), xmlURIEscape fix (William), xmlXPathErr on bad range (William),
2404 patterns with too many steps, bug in RNG choice optimization, line number
2405 sometimes missing.</li>
2406 <li>improvements: XSD Schemas (Kasimier Buchcik), python generator
2407 (William), xmlUTF8Strpos speedup (William), unicode Python strings
2408 (William), XSD error reports (Kasimier Buchcik), Python __str__ call
2409 serialize().</li>
2410 <li>new APIs: added xmlDictExists(), GetLineNumber and GetColumnNumber for
2411 the xmlReader (Aleksey Sanin), Dynamic Shared Libraries APIs (mostly Joel
2412 Reed), error extraction API from regexps, new XMLSave option for format
2413 (Phil Shafer)</li>
2414 <li>documentation: site improvement (John Fleck), FAQ entries
2415 (William).</li>
Daniel Veillard298d9642005-01-16 20:01:55 +00002416</ul>
2417
Daniel Veillardc3d7cb42004-11-10 14:34:45 +00002418<h3>2.6.16: Nov 10 2004</h3>
2419<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002420 <li>general hardening and bug fixing crossing all the API based on new
2421 automated regression testing</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +00002422 <li>build fix: IPv6 build and test on AIX (Dodji Seketeli)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002423 <li>bug fixes: problem with XML::Libxml reported by Petr Pajas, encoding
2424 conversion functions return values, UTF-8 bug affecting XPath reported by
2425 Markus Bertheau, catalog problem with NULL entries (William Brack)</li>
2426 <li>documentation: fix to xmllint man page, some API function descritpion
2427 were updated.</li>
2428 <li>improvements: DTD validation APIs provided at the Python level (Brent
2429 Hendricks)</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +00002430</ul>
2431
Daniel Veillardc2f83d12004-10-27 22:59:21 +00002432<h3>2.6.15: Oct 27 2004</h3>
Daniel Veillard6927b102004-10-27 17:29:04 +00002433<ul>
2434 <li>security fixes on the nanoftp and nanohttp modules</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002435 <li>build fixes: xmllint detection bug in configure, building outside the
2436 source tree (Thomas Fitzsimmons)</li>
2437 <li>bug fixes: HTML parser on broken ASCII chars in names (William), Python
2438 paths (Malcolm Tredinnick), xmlHasNsProp and default namespace (William),
2439 saving to python file objects (Malcolm Tredinnick), DTD lookup fix
2440 (Malcolm), save back &lt;group&gt; in catalogs (William), tree build
2441 fixes (DV and Rob Richards), Schemas memory bug, structured error handler
2442 on Python 64bits, thread local memory deallocation, memory leak reported
2443 by Volker Roth, xmlValidateDtd in the presence of an internal subset,
2444 entities and _private problem (William), xmlBuildRelativeURI error
2445 (William).</li>
2446 <li>improvements: better XInclude error reports (William), tree debugging
2447 module and tests, convenience functions at the Reader API (Graham
2448 Bennett), add support for PI in the HTML parser.</li>
Daniel Veillard6927b102004-10-27 17:29:04 +00002449</ul>
2450
Daniel Veillard210818b2004-09-29 15:50:37 +00002451<h3>2.6.14: Sep 29 2004</h3>
2452<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002453 <li>build fixes: configure paths for xmllint and xsltproc, compilation
2454 without HTML parser, compilation warning cleanups (William Brack &amp;
2455 Malcolm Tredinnick), VMS makefile update (Craig Berry),</li>
2456 <li>bug fixes: xmlGetUTF8Char (William Brack), QName properties (Kasimier
2457 Buchcik), XInclude testing, Notation serialization, UTF8ToISO8859x
2458 transcoding (Mark Itzcovitz), lots of XML Schemas cleanup and fixes
2459 (Kasimier), ChangeLog cleanup (Stepan Kasal), memory fixes (Mark Vakoc),
2460 handling of failed realloc(), out of bound array adressing in Schemas
2461 date handling, Python space/tabs cleanups (Malcolm Tredinnick), NMTOKENS
2462 E20 validation fix (Malcolm),</li>
2463 <li>improvements: added W3C XML Schemas testsuite (Kasimier Buchcik), add
2464 xmlSchemaValidateOneElement (Kasimier), Python exception hierearchy
2465 (Malcolm Tredinnick), Python libxml2 driver improvement (Malcolm
2466 Tredinnick), Schemas support for xsi:schemaLocation,
2467 xsi:noNamespaceSchemaLocation, xsi:type (Kasimier Buchcik)</li>
Daniel Veillard210818b2004-09-29 15:50:37 +00002468</ul>
2469
Daniel Veillardd1de4a32004-08-31 13:43:07 +00002470<h3>2.6.13: Aug 31 2004</h3>
2471<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002472 <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag with gcc,
2473 Solaris compiler warning, fixing RPM BuildRequires,</li>
2474 <li>fixes: DTD loading on Windows (Igor), Schemas error reports APIs
2475 (Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 (William Brack
2476 and Julius Mittenzwei), Schemas facet check (Kasimier), default namespace
2477 problem (William), Schemas hexbinary empty values, encoding error could
2478 genrate a serialization loop.</li>
2479 <li>Improvements: Schemas validity improvements (Kasimier), added --path
2480 and --load-trace options to xmllint</li>
Daniel Veillardd1de4a32004-08-31 13:43:07 +00002481 <li>documentation: tutorial update (John Fleck)</li>
2482</ul>
2483
Daniel Veillardb331fff2004-08-22 14:21:57 +00002484<h3>2.6.12: Aug 22 2004</h3>
2485<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002486 <li>build fixes: fix --with-minimum, elfgcchack.h fixes (Peter
2487 Breitenlohner), perl path lookup (William), diff on Solaris (Albert
2488 Chin), some 64bits cleanups.</li>
2489 <li>Python: avoid a warning with 2.3 (William Brack), tab and space mixes
2490 (William), wrapper generator fixes (William), Cygwin support (Gerrit P.
2491 Haase), node wrapper fix (Marc-Antoine Parent), XML Schemas support
2492 (Torkel Lyng)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +00002493 <li>Schemas: a lot of bug fixes and improvements from Kasimier Buchcik</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002494 <li>fixes: RVT fixes (William), XPath context resets bug (William), memory
2495 debug (Steve Hay), catalog white space handling (Peter Breitenlohner),
2496 xmlReader state after attribute reading (William), structured error
2497 handler (William), XInclude generated xml:base fixup (William), Windows
2498 memory reallocation problem (Steve Hay), Out of Memory conditions
2499 handling (William and Olivier Andrieu), htmlNewDoc() charset bug,
2500 htmlReadMemory init (William), a posteriori validation DTD base
2501 (William), notations serialization missing, xmlGetNodePath (Dodji),
2502 xmlCheckUTF8 (Diego Tartara), missing line numbers on entity
2503 (William)</li>
2504 <li>improvements: DocBook catalog build scrip (William), xmlcatalog tool
2505 (Albert Chin), xmllint --c14n option, no_proxy environment (Mike Hommey),
2506 xmlParseInNodeContext() addition, extend xmllint --shell, allow XInclude
2507 to not generate start/end nodes, extend xmllint --version to include CVS
2508 tag (William)</li>
2509 <li>documentation: web pages fixes, validity API docs fixes (William)
2510 schemas API fix (Eric Haszlakiewicz), xmllint man page (John Fleck)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +00002511</ul>
2512
Daniel Veillard45cb0f42004-07-05 17:45:35 +00002513<h3>2.6.11: July 5 2004</h3>
2514<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002515 <li>Schemas: a lot of changes and improvements by Kasimier Buchcik for
2516 attributes, namespaces and simple types.</li>
2517 <li>build fixes: --with-minimum (William Brack), some gcc cleanup
2518 (William), --with-thread-alloc (William)</li>
2519 <li>portability: Windows binary package change (Igor Zlatkovic), Catalog
2520 path on Windows</li>
2521 <li>documentation: update to the tutorial (John Fleck), xmllint return code
2522 (John Fleck), man pages (Ville Skytta),</li>
2523 <li>bug fixes: C14N bug serializing namespaces (Aleksey Sanin), testSAX
2524 properly initialize the library (William), empty node set in XPath
2525 (William), xmlSchemas errors (William), invalid charref problem pointed
2526 by Morus Walter, XInclude xml:base generation (William), Relax-NG bug
2527 with div processing (William), XPointer and xml:base problem(William),
2528 Reader and entities, xmllint return code for schemas (William), reader
2529 streaming problem (Steve Ball), DTD serialization problem (William),
2530 libxml.m4 fixes (Mike Hommey), do not provide destructors as methods on
2531 Python classes, xmlReader buffer bug, Python bindings memory interfaces
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002532 improvement (with Stéphane Bidoul), Fixed the push parser to be back to
Daniel Veillardf781dba2006-06-09 13:34:49 +00002533 synchronous behaviour.</li>
2534 <li>improvement: custom per-thread I/O enhancement (Rob Richards), register
2535 namespace in debug shell (Stefano Debenedetti), Python based regression
2536 test for non-Unix users (William), dynamically increase the number of
2537 XPath extension functions in Python and fix a memory leak (Marc-Antoine
2538 Parent and William)</li>
2539 <li>performance: hack done with Arjan van de Ven to reduce ELF footprint
2540 and generated code on Linux, plus use gcc runtime profiling to optimize
2541 the code generated in the RPM packages.</li>
Daniel Veillard45cb0f42004-07-05 17:45:35 +00002542</ul>
2543
Daniel Veillard81205012004-05-18 03:06:41 +00002544<h3>2.6.10: May 17 2004</h3>
2545<ul>
2546 <li>Web page generated for ChangeLog</li>
2547 <li>build fixes: --without-html problems, make check without make all</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002548 <li>portability: problem with xpath.c on Windows (MSC and Borland), memcmp
2549 vs. strncmp on Solaris, XPath tests on Windows (Mark Vakoc), C++ do not
2550 use "list" as parameter name, make tests work with Python 1.5 (Ed
2551 Davis),</li>
2552 <li>improvements: made xmlTextReaderMode public, small buffers resizing
2553 (Morten Welinder), add --maxmem option to xmllint, add
2554 xmlPopInputCallback() for Matt Sergeant, refactoring of serialization
2555 escaping, added escaping customization</li>
2556 <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp bugs (William
2557 Brack), xmlReader end of stream problem, node deregistration with reader,
2558 URI escaping and filemanes, XHTML1 formatting (Nick Wellnhofer), regexp
2559 transition reduction (William), various XSD Schemas fixes (Kasimier
2560 Buchcik), XInclude fallback problem (William), weird problems with DTD
2561 (William), structured error handler callback context (William), reverse
2562 xmlEncodeSpecialChars() behaviour back to escaping '"'</li>
Daniel Veillard81205012004-05-18 03:06:41 +00002563</ul>
2564
Daniel Veillardeca726d2004-04-18 21:47:34 +00002565<h3>2.6.9: Apr 18 2004</h3>
2566<ul>
2567 <li>implement xml:id Working Draft, relaxed XPath id() checking</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002568 <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and CDATA (Dave
2569 Beckett), Relax-NG compilation (William Brack), Regexp patches (with
2570 William), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed problem (with
2571 William), Relax-NG name classes compares (William), XInclude duplicate
2572 fallback (William), external DTD encoding detection (William), a DTD
2573 validation bug (William), xmlReader Close() fix, recusive extention
2574 schemas</li>
2575 <li>improvements: use xmlRead* APIs in test tools (Mark Vakoc), indenting
2576 save optimization, better handle IIS broken HTTP redirect behaviour (Ian
2577 Hummel), HTML parser frameset (James Bursa), libxml2-python RPM
2578 dependancy, XML Schemas union support (Kasimier Buchcik), warning removal
2579 clanup (William), keep ChangeLog compressed when installing from RPMs</li>
2580 <li>documentation: examples and xmlDocDumpMemory docs (John Fleck), new
2581 example (load, xpath, modify, save), xmlCatalogDump() comments,</li>
2582 <li>Windows: Borland C++ builder (Eric Zurcher), work around Microsoft
2583 compiler NaN handling bug (Mark Vakoc)</li>
Daniel Veillardeca726d2004-04-18 21:47:34 +00002584</ul>
2585
Daniel Veillard252004d2004-03-23 12:32:32 +00002586<h3>2.6.8: Mar 23 2004</h3>
2587<ul>
2588 <li>First step of the cleanup of the serialization code and APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002589 <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling fixes (Adam
2590 Dickmeiss), anyURI for "" (John Belmonte)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00002591 <li>Python: Canonicalization C14N support added (Anthony Carrico)</li>
2592 <li>xmlDocCopyNode() extension (William)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002593 <li>Relax-NG: fix when processing XInclude results (William), external
2594 reference in interleave (William), missing error on &lt;choice&gt;
2595 failure (William), memory leak in schemas datatype facets.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00002596 <li>xmlWriter: patch for better DTD support (Alfred Mickautsch)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002597 <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey and William
2598 Brack), no ID errors if using HTML_PARSE_NOERROR, xmlcatalog fallbacks to
2599 URI on SYSTEM lookup failure, XInclude parse flags inheritance (William),
2600 XInclude and XPointer fixes for entities (William), XML parser bug
2601 reported by Holger Rauch, nanohttp fd leak (William), regexps char
Nick Wellnhofer8bbe4502017-06-17 16:15:09 +02002602 groups '-' handling (William), dictionary reference counting problems,
Daniel Veillardf781dba2006-06-09 13:34:49 +00002603 do not close stderr.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00002604 <li>performance patches from Petr Pajas</li>
2605 <li>Documentation fixes: XML_CATALOG_FILES in man pages (Mike Hommey)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002606 <li>compilation and portability fixes: --without-valid, catalog cleanups
2607 (Peter Breitenlohner), MingW patch (Roland Schwingel), cross-compilation
2608 to Windows (Christophe de Vienne), --with-html-dir fixup (Julio Merino
2609 Vidal), Windows build (Eric Zurcher)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +00002610</ul>
2611
Daniel Veillard92914492004-02-23 16:33:21 +00002612<h3>2.6.7: Feb 23 2004</h3>
2613<ul>
2614 <li>documentation: tutorial updates (John Fleck), benchmark results</li>
2615 <li>xmlWriter: updates and fixes (Alfred Mickautsch, Lucas Brasilino)</li>
2616 <li>XPath optimization (Petr Pajas)</li>
2617 <li>DTD ID handling optimization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002618 <li>bugfixes: xpath number with &gt; 19 fractional (William Brack), push
2619 mode with unescaped '&gt;' characters, fix xmllint --stream --timing, fix
2620 xmllint --memory --stream memory usage, xmlAttrSerializeTxtContent
2621 handling NULL, trying to fix Relax-NG/Perl interface.</li>
Daniel Veillard92914492004-02-23 16:33:21 +00002622 <li>python: 2.3 compatibility, whitespace fixes (Malcolm Tredinnick)</li>
2623 <li>Added relaxng option to xmllint --shell</li>
2624</ul>
2625
Daniel Veillard5c9547e2004-02-12 15:31:49 +00002626<h3>2.6.6: Feb 12 2004</h3>
2627<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002628 <li>nanohttp and nanoftp: buffer overflow error on URI parsing (Igor and
2629 William) reported by Yuuichi Teranishi</li>
2630 <li>bugfixes: make test and path issues, xmlWriter attribute serialization
2631 (William Brack), xmlWriter indentation (William), schemas validation
2632 (Eric Haszlakiewicz), XInclude dictionnaries issues (William and Oleg
2633 Paraschenko), XInclude empty fallback (William), HTML warnings (William),
2634 XPointer in XInclude (William), Python namespace serialization,
2635 isolat1ToUTF8 bound error (Alfred Mickautsch), output of parameter
2636 entities in internal subset (William), internal subset bug in push mode,
2637 &lt;xs:all&gt; fix (Alexey Sarytchev)</li>
2638 <li>Build: fix for automake-1.8 (Alexander Winston), warnings removal
2639 (Philip Ludlam), SOCKLEN_T detection fixes (Daniel Richard), fix
2640 --with-minimum configuration.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +00002641 <li>XInclude: allow the 2001 namespace without warning.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002642 <li>Documentation: missing example/index.html (John Fleck), version
2643 dependancies (John Fleck)</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +00002644 <li>reader API: structured error reporting (Steve Ball)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002645 <li>Windows compilation: mingw, msys (Mikhail Grushinskiy), function
2646 prototype (Cameron Johnson), MSVC6 compiler warnings, _WINSOCKAPI_
2647 patch</li>
2648 <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte offest in
2649 input.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +00002650</ul>
2651
Daniel Veillard189f46b2004-01-25 21:03:04 +00002652<h3>2.6.5: Jan 25 2004</h3>
2653<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002654 <li>Bugfixes: dictionnaries for schemas (William Brack), regexp segfault
2655 (William), xs:all problem (William), a number of XPointer bugfixes
2656 (William), xmllint error go to stderr, DTD validation problem with
2657 namespace, memory leak (William), SAX1 cleanup and minimal options fixes
2658 (Mark Vadoc), parser context reset on error (Shaun McCance), XPath union
2659 evaluation problem (William) , xmlReallocLoc with NULL (Aleksey Sanin),
2660 XML Schemas double free (Steve Ball), XInclude with no href, argument
2661 callbacks order for XPath callbacks (Frederic Peters)</li>
2662 <li>Documentation: python scripts (William Brack), xslt stylesheets (John
2663 Fleck), doc (Sven Zimmerman), I/O example.</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002664 <li>Python bindings: fixes (William), enum support (Stéphane Bidoul),
2665 structured error reporting (Stéphane Bidoul)</li>
Nick Wellnhofer8bbe4502017-06-17 16:15:09 +02002666 <li>XInclude: various fixes for conformance, problem related to dictionary
Daniel Veillardf781dba2006-06-09 13:34:49 +00002667 references (William &amp; me), recursion (William)</li>
2668 <li>xmlWriter: indentation (Lucas Brasilino), memory leaks (Alfred
2669 Mickautsch),</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +00002670 <li>xmlSchemas: normalizedString datatype (John Belmonte)</li>
2671 <li>code cleanup for strings functions (William)</li>
2672 <li>Windows: compiler patches (Mark Vakoc)</li>
Nick Wellnhofer8bbe4502017-06-17 16:15:09 +02002673 <li>Parser optimizations, a few new XPath and dictionary APIs for future
Daniel Veillardf781dba2006-06-09 13:34:49 +00002674 XSLT optimizations.</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +00002675</ul>
2676
Daniel Veillarde6e59cd2003-12-24 11:56:44 +00002677<h3>2.6.4: Dec 24 2003</h3>
2678<ul>
2679 <li>Windows build fixes (Igor Zlatkovic)</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +00002680 <li>Some serious XInclude problems reported by Oleg Paraschenko and</li>
2681 <li>Unix and Makefile packaging fixes (me, William Brack,</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002682 <li>Documentation improvements (John Fleck, William Brack), example fix
2683 (Lucas Brasilino)</li>
2684 <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath handling of
2685 NULL strings (William Brack) , API building reader or parser from
2686 filedescriptor should not close it, changed XPath sorting to be stable
2687 again (William Brack), xmlGetNodePath() generating '(null)' (William
2688 Brack), DTD validation and namespace bug (William Brack), XML Schemas
2689 double inclusion behaviour</li>
Daniel Veillarde6e59cd2003-12-24 11:56:44 +00002690</ul>
2691
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002692<h3>2.6.3: Dec 10 2003</h3>
2693<ul>
2694 <li>documentation updates and cleanup (DV, William Brack, John Fleck)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002695 <li>added a repository of examples, examples from Aleksey Sanin, Dodji
2696 Seketeli, Alfred Mickautsch</li>
2697 <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher, Mingw
2698 (Kenneth Haley)</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002699 <li>Unicode range checking (William Brack)</li>
2700 <li>code cleanup (William Brack)</li>
2701 <li>Python bindings: doc (John Fleck), bug fixes</li>
2702 <li>UTF-16 cleanup and BOM issues (William Brack)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002703 <li>bug fixes: ID and xmlReader validation, XPath (William Brack),
2704 xmlWriter (Alfred Mickautsch), hash.h inclusion problem, HTML parser
2705 (James Bursa), attribute defaulting and validation, some serialization
2706 cleanups, XML_GET_LINE macro, memory debug when using threads (William
2707 Brack), serialization of attributes and entities content, xmlWriter
2708 (Daniel Schulman)</li>
2709 <li>XInclude bugfix, new APIs and update to the last version including the
2710 namespace change.</li>
2711 <li>XML Schemas improvements: include (Robert Stepanek), import and
2712 namespace handling, fixed the regression tests troubles, added examples
2713 based on Eric van der Vlist book, regexp fixes</li>
2714 <li>preliminary pattern support for streaming (needed for schemas
2715 constraints), added xmlTextReaderPreservePattern() to collect subdocument
2716 when streaming.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002717 <li>various fixes in the structured error handling</li>
2718</ul>
2719
Daniel Veillard6d373a22003-11-04 10:26:43 +00002720<h3>2.6.2: Nov 4 2003</h3>
2721<ul>
2722 <li>XPath context unregistration fixes</li>
2723 <li>text node coalescing fixes (Mark Lilback)</li>
2724 <li>API to screate a W3C Schemas from an existing document (Steve Ball)</li>
2725 <li>BeOS patches (Marcin 'Shard' Konicki)</li>
2726 <li>xmlStrVPrintf function added (Aleksey Sanin)</li>
2727 <li>compilation fixes (Mark Vakoc)</li>
2728 <li>stdin parsing fix (William Brack)</li>
2729 <li>a posteriori DTD validation fixes</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +00002730 <li>xmlReader bug fixes: Walker fixes, python bindings</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +00002731 <li>fixed xmlStopParser() to really stop the parser and errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002732 <li>always generate line numbers when using the new xmlReadxxx
2733 functions</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +00002734 <li>added XInclude support to the xmlReader interface</li>
2735 <li>implemented XML_PARSE_NONET parser option</li>
2736 <li>DocBook XSLT processing bug fixed</li>
2737 <li>HTML serialization for &lt;p&gt; elements (William Brack and me)</li>
2738 <li>XPointer failure in XInclude are now handled as resource errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002739 <li>fixed xmllint --html to use the HTML serializer on output (added
2740 --xmlout to implement the previous behaviour of saving it using the XML
2741 serializer)</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +00002742</ul>
2743
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002744<h3>2.6.1: Oct 28 2003</h3>
2745<ul>
2746 <li>Mostly bugfixes after the big 2.6.0 changes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002747 <li>Unix compilation patches: libxml.m4 (Patrick Welche), warnings cleanup
2748 (William Brack)</li>
2749 <li>Windows compilation patches (Joachim Bauch, Stephane Bidoul, Igor
2750 Zlatkovic)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002751 <li>xmlWriter bugfix (Alfred Mickautsch)</li>
2752 <li>chvalid.[ch]: couple of fixes from Stephane Bidoul</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002753 <li>context reset: error state reset, push parser reset (Graham
2754 Bennett)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002755 <li>context reuse: generate errors if file is not readable</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002756 <li>defaulted attributes for element coming from internal entities
2757 (Stephane Bidoul)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002758 <li>Python: tab and spaces mix (William Brack)</li>
2759 <li>Error handler could crash in DTD validation in 2.6.0</li>
2760 <li>xmlReader: do not use the document or element _private field</li>
2761 <li>testSAX.c: avoid a problem with some PIs (Massimo Morara)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002762 <li>general bug fixes: mandatory encoding in text decl, serializing
2763 Document Fragment nodes, xmlSearchNs 2.6.0 problem (Kasimier Buchcik),
2764 XPath errors not reported, slow HTML parsing of large documents.</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +00002765</ul>
2766
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002767<h3>2.6.0: Oct 20 2003</h3>
2768<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002769 <li>Major revision release: should be API and ABI compatible but got a lot
2770 of change</li>
2771 <li>Increased the library modularity, far more options can be stripped out,
2772 a --with-minimum configuration will weight around 160KBytes</li>
Nick Wellnhofer8bbe4502017-06-17 16:15:09 +02002773 <li>Use per parser and per document dictionary, allocate names and small
2774 text nodes from the dictionary</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002775 <li>Switch to a SAX2 like parser rewrote most of the XML parser core,
2776 provides namespace resolution and defaulted attributes, minimize memory
2777 allocations and copies, namespace checking and specific error handling,
2778 immutable buffers, make predefined entities static structures, etc...</li>
2779 <li>rewrote all the error handling in the library, all errors can be
2780 intercepted at a structured level, with precise information
2781 available.</li>
2782 <li>New simpler and more generic XML and HTML parser APIs, allowing to
2783 easilly modify the parsing options and reuse parser context for multiple
2784 consecutive documents.</li>
2785 <li>Similar new APIs for the xmlReader, for options and reuse, provided new
2786 functions to access content as const strings, use them for Python
2787 bindings</li>
2788 <li>a lot of other smaller API improvements: xmlStrPrintf (Aleksey Sanin),
2789 Walker i.e. reader on a document tree based on Alfred Mickautsch code,
2790 make room in nodes for line numbers, reference counting and future PSVI
2791 extensions, generation of character ranges to be checked with faster
2792 algorithm (William), xmlParserMaxDepth (Crutcher Dunnavant), buffer
2793 access</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002794 <li>New xmlWriter API provided by Alfred Mickautsch</li>
2795 <li>Schemas: base64 support by Anthony Carrico</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002796 <li>Parser&lt;-&gt;HTTP integration fix, proper processing of the Mime-Type
William M. Brack43a87292007-02-15 20:41:02 +00002797 and charset information if available.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002798 <li>Relax-NG: bug fixes including the one reported by Martijn Faassen and
2799 zeroOrMore, better error reporting.</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002800 <li>Python bindings (Stéphane Bidoul), never use stdout for errors
Daniel Veillardf781dba2006-06-09 13:34:49 +00002801 output</li>
2802 <li>Portability: all the headers have macros for export and calling
2803 convention definitions (Igor Zlatkovic), VMS update (Craig A. Berry),
2804 Windows: threads (Jesse Pelton), Borland compiler (Eric Zurcher, Igor),
2805 Mingw (Igor), typos (Mark Vakoc), beta version (Stephane Bidoul),
2806 warning cleanups on AIX and MIPS compilers (William Brack), BeOS (Marcin
2807 'Shard' Konicki)</li>
2808 <li>Documentation fixes and README (William Brack), search fix (William),
2809 tutorial updates (John Fleck), namespace docs (Stefan Kost)</li>
2810 <li>Bug fixes: xmlCleanupParser (Dave Beckett), threading uninitialized
2811 mutexes, HTML doctype lowercase, SAX/IO (William), compression detection
2812 and restore (William), attribute declaration in DTDs (William), namespace
2813 on attribute in HTML output (William), input filename (Rob Richards),
2814 namespace DTD validation, xmlReplaceNode (Chris Ryland), I/O callbacks
2815 (Markus Keim), CDATA serialization (Shaun McCance), xmlReader (Peter
2816 Derr), high codepoint charref like &amp;#x10FFFF;, buffer access in push
2817 mode (Justin Fletcher), TLS threads on Windows (Jesse Pelton), XPath bug
2818 (William), xmlCleanupParser (Marc Liyanage), CDATA output (William), HTTP
2819 error handling.</li>
2820 <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 for compat
Nick Wellnhofer8bbe4502017-06-17 16:15:09 +02002821 testing, --nodict for building without tree dictionary, --nocdata to
Daniel Veillardf781dba2006-06-09 13:34:49 +00002822 replace CDATA by text, --nsclean to remove surperfluous namespace
2823 declarations</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002824 <li>added xml2-config --libtool-libs option from Kevin P. Fleming</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002825 <li>a lot of profiling and tuning of the code, speedup patch for
2826 xmlSearchNs() by Luca Padovani. The xmlReader should do far less
2827 allocation and it speed should get closer to SAX. Chris Anderson worked
2828 on speeding and cleaning up repetitive checking code.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002829 <li>cleanup of "make tests"</li>
2830 <li>libxml-2.0-uninstalled.pc from Malcolm Tredinnick</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002831 <li>deactivated the broken docBook SGML parser code and plugged the XML
2832 parser instead.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00002833</ul>
2834
Daniel Veillardeec1ae92003-09-09 13:11:01 +00002835<h3>2.5.11: Sep 9 2003</h3>
2836
2837<p>A bugfix only release:</p>
2838<ul>
2839 <li>risk of crash in Relax-NG</li>
2840 <li>risk of crash when using multithreaded programs</li>
2841</ul>
2842
Daniel Veillardcfba2fe2003-08-15 00:33:43 +00002843<h3>2.5.10: Aug 15 2003</h3>
2844
2845<p>A bugfixes only release</p>
2846<ul>
2847 <li>Windows Makefiles (William Brack)</li>
2848 <li>UTF-16 support fixes (Mark Itzcovitz)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002849 <li>Makefile and portability (William Brack) automake, Linux alpha, Mingw
2850 on Windows (Mikhail Grushinskiy)</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +00002851 <li>HTML parser (Oliver Stoeneberg)</li>
2852 <li>XInclude performance problem reported by Kevin Ruscoe</li>
2853 <li>XML parser performance problem reported by Grant Goodale</li>
2854 <li>xmlSAXParseDTD() bug fix from Malcolm Tredinnick</li>
Daniel Veillardeec1ae92003-09-09 13:11:01 +00002855 <li>and a couple other cleanup</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +00002856</ul>
2857
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002858<h3>2.5.9: Aug 9 2003</h3>
2859<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002860 <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), Windows build
2861 (Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter Sobisch), threading
2862 (Rob Richards), hexBinary type (), UTF-16 BOM (Dodji Seketeli),
2863 xmlReader, Relax-NG schemas compilation, namespace handling, EXSLT (Sean
2864 Griffin), HTML parsing problem (William Brack), DTD validation for mixed
2865 content + namespaces, HTML serialization, library initialization,
2866 progressive HTML parser</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002867 <li>better interfaces for Relax-NG error handling (Joachim Bauch, )</li>
2868 <li>adding xmlXIncludeProcessTree() for XInclud'ing in a subtree</li>
2869 <li>doc fixes and improvements (John Fleck)</li>
2870 <li>configure flag for -with-fexceptions when embedding in C++</li>
2871 <li>couple of new UTF-8 helper functions (William Brack)</li>
2872 <li>general encoding cleanup + ISO-8859-x without iconv (Peter Jacobi)</li>
2873 <li>xmlTextReader cleanup + enum for node types (Bjorn Reese)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002874 <li>general compilation/warning cleanup Solaris/HP-UX/... (William
2875 Brack)</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002876</ul>
2877
Daniel Veillard560c2a42003-07-06 21:13:49 +00002878<h3>2.5.8: Jul 6 2003</h3>
2879<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002880 <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 save (Mark
2881 Itzcovitz), UTF-8 checking, URI saving, error printing (William Brack),
2882 PI related memleak, compilation without schemas or without xpath (Joerg
2883 Schmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem with DTDs,
2884 rpm problem on , i86_64, removed a few compilation problems from 2.5.7,
2885 xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +00002886 <li>portability: DJGPP (MsDos) , OpenVMS (Craig A. Berry)</li>
2887 <li>William Brack fixed multithreading lock problems</li>
2888 <li>IPv6 patch for FTP and HTTP accesses (Archana Shah/Wipro)</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002889 <li>Windows fixes (Igor Zlatkovic, Eric Zurcher), threading (Stéphane
Daniel Veillardf781dba2006-06-09 13:34:49 +00002890 Bidoul)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +00002891 <li>A few W3C Schemas Structure improvements</li>
2892 <li>W3C Schemas Datatype improvements (Charlie Bozeman)</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002893 <li>Python bindings for thread globals (Stéphane Bidoul), and method/class
Daniel Veillardf781dba2006-06-09 13:34:49 +00002894 generator</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +00002895 <li>added --nonet option to xmllint</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +00002896 <li>documentation improvements (John Fleck)</li>
2897</ul>
2898
Daniel Veillard92fc02c2003-04-24 23:12:35 +00002899<h3>2.5.7: Apr 25 2003</h3>
2900<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002901 <li>Relax-NG: Compiling to regexp and streaming validation on top of the
2902 xmlReader interface, added to xmllint --stream</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +00002903 <li>xmlReader: Expand(), Next() and DOM access glue, bug fixes</li>
2904 <li>Support for large files: RGN validated a 4.5GB instance</li>
2905 <li>Thread support is now configured in by default</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002906 <li>Fixes: update of the Trio code (Bjorn), WXS Date and Duration fixes
2907 (Charles Bozeman), DTD and namespaces (Brent Hendricks), HTML push parser
2908 and zero bytes handling, some missing Windows file path conversions,
2909 behaviour of the parser and validator in the presence of "out of memory"
2910 error conditions</li>
2911 <li>extended the API to be able to plug a garbage collecting memory
2912 allocator, added xmlMallocAtomic() and modified the allocations
2913 accordingly.</li>
2914 <li>Performances: removed excessive malloc() calls, speedup of the push and
2915 xmlReader interfaces, removed excessive thread locking</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +00002916 <li>Documentation: man page (John Fleck), xmlReader documentation</li>
2917 <li>Python: adding binding for xmlCatalogAddLocal (Brent M Hendricks)</li>
2918</ul>
2919
Daniel Veillardc2d4a932003-04-01 11:13:05 +00002920<h3>2.5.6: Apr 1 2003</h3>
2921<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002922 <li>Fixed W3C XML Schemas datatype, should be compliant now except for
2923 binHex and base64 which are not supported yet.</li>
2924 <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large docs and
2925 XInclude entities handling, encoding detection on external subsets, XML
2926 Schemas bugs and memory leaks, HTML parser (James Bursa)</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +00002927 <li>portability: python/trio (Albert Chin), Sun compiler warnings</li>
2928 <li>documentation: added --relaxng option to xmllint man page (John)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002929 <li>improved error reporting: xml:space, start/end tag mismatches, Relax NG
2930 errors</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +00002931</ul>
2932
2933<h3>2.5.5: Mar 24 2003</h3>
Daniel Veillardd8da01c2003-03-24 15:58:23 +00002934<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002935 <li>Lot of fixes on the Relax NG implementation. More testing including
2936 DocBook and TEI examples.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +00002937 <li>Increased the support for W3C XML Schemas datatype</li>
2938 <li>Several bug fixes in the URI handling layer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002939 <li>Bug fixes: HTML parser, xmlReader, DTD validation, XPath, encoding
2940 conversion, line counting in the parser.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +00002941 <li>Added support for $XMLLINT_INDENT environment variable, FTP delete</li>
2942 <li>Fixed the RPM spec file name</li>
2943</ul>
2944
Daniel Veillard17bed982003-02-24 20:11:43 +00002945<h3>2.5.4: Feb 20 2003</h3>
2946<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002947 <li>Conformance testing and lot of fixes on Relax NG and XInclude
2948 implementation</li>
Daniel Veillard17bed982003-02-24 20:11:43 +00002949 <li>Implementation of XPointer element() scheme</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002950 <li>Bug fixes: XML parser, XInclude entities merge, validity checking on
2951 namespaces,
2952 <p>2 serialization bugs, node info generation problems, a DTD regexp
2953 generation problem.</p>
Daniel Veillard17bed982003-02-24 20:11:43 +00002954 </li>
2955 <li>Portability: windows updates and path canonicalization (Igor)</li>
2956 <li>A few typo fixes (Kjartan Maraas)</li>
2957 <li>Python bindings generator fixes (Stephane Bidoul)</li>
2958</ul>
2959
Daniel Veillard1d788d22003-02-10 16:21:58 +00002960<h3>2.5.3: Feb 10 2003</h3>
2961<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002962 <li>RelaxNG and XML Schemas datatypes improvements, and added a first
2963 version of RelaxNG Python bindings</li>
2964 <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API fix for
2965 serializing namespace nodes, encoding conversion bug, XHTML1
2966 serialization</li>
Daniel Veillard1d788d22003-02-10 16:21:58 +00002967 <li>Portability fixes: Windows (Igor), AMD 64bits RPM spec file</li>
2968</ul>
2969
Daniel Veillard72fef162003-02-05 14:31:19 +00002970<h3>2.5.2: Feb 5 2003</h3>
2971<ul>
2972 <li>First implementation of RelaxNG, added --relaxng flag to xmllint</li>
2973 <li>Schemas support now compiled in by default.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002974 <li>Bug fixes: DTD validation, namespace checking, XInclude and entities,
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002975 delegateURI in XML Catalogs, HTML parser, XML reader (Stéphane Bidoul),
Daniel Veillardf781dba2006-06-09 13:34:49 +00002976 XPath parser and evaluation, UTF8ToUTF8 serialization, XML reader memory
2977 consumption, HTML parser, HTML serialization in the presence of
2978 namespaces</li>
Daniel Veillard72fef162003-02-05 14:31:19 +00002979 <li>added an HTML API to check elements and attributes.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002980 <li>Documentation improvement, PDF for the tutorial (John Fleck), doc
2981 patches (Stefan Kost)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +00002982 <li>Portability fixes: NetBSD (Julio Merino), Windows (Igor Zlatkovic)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002983 <li>Added python bindings for XPointer, contextual error reporting
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002984 (Stéphane Bidoul)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +00002985 <li>URI/file escaping problems (Stefano Zacchiroli)</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00002986</ul>
2987
Daniel Veillarde2830f12003-01-08 17:47:49 +00002988<h3>2.5.1: Jan 8 2003</h3>
2989<ul>
2990 <li>Fixes a memory leak and configuration/compilation problems in 2.5.0</li>
2991 <li>documentation updates (John)</li>
2992 <li>a couple of XmlTextReader fixes</li>
2993</ul>
2994
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00002995<h3>2.5.0: Jan 6 2003</h3>
2996<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00002997 <li>New <a href="xmlreader.html">XmltextReader interface</a> based on C#
Daniel Veillardd2190fa2010-09-30 13:58:22 +02002998 API (with help of Stéphane Bidoul)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00002999 <li>Windows: more exports, including the new API (Igor)</li>
3000 <li>XInclude fallback fix</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +02003001 <li>Python: bindings for the new API, packaging (Stéphane Bidoul),
3002 drv_libxml2.py Python xml.sax driver (Stéphane Bidoul), fixes, speedup
Daniel Veillardf781dba2006-06-09 13:34:49 +00003003 and iterators for Python-2.2 (Hannu Krosing)</li>
3004 <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint man update
3005 (John)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00003006 <li>Fix an XML parser bug raised by Vyacheslav Pindyura</li>
3007 <li>Fix for VMS serialization (Nigel Hall) and config (Craig A. Berry)</li>
3008 <li>Entities handling fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003009 <li>new API to optionally track node creation and deletion (Lukas
3010 Schroeder)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00003011 <li>Added documentation for the XmltextReader interface and some <a
3012 href="guidelines.html">XML guidelines</a></li>
3013</ul>
3014
Daniel Veillardc1eed322002-12-12 11:01:32 +00003015<h3>2.4.30: Dec 12 2002</h3>
3016<ul>
3017 <li>2.4.29 broke the python bindings, rereleasing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003018 <li>Improvement/fixes of the XML API generator, and couple of minor code
3019 fixes.</li>
Daniel Veillardc1eed322002-12-12 11:01:32 +00003020</ul>
3021
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00003022<h3>2.4.29: Dec 11 2002</h3>
3023<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003024 <li>Windows fixes (Igor): Windows CE port, pthread linking, python bindings
Daniel Veillardd2190fa2010-09-30 13:58:22 +02003025 (Stéphane Bidoul), Mingw (Magnus Henoch), and export list updates</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00003026 <li>Fix for prev in python bindings (ERDI Gergo)</li>
3027 <li>Fix for entities handling (Marcus Clarke)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003028 <li>Refactored the XML and HTML dumps to a single code path, fixed XHTML1
3029 dump</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00003030 <li>Fix for URI parsing when handling URNs with fragment identifiers</li>
3031 <li>Fix for HTTP URL escaping problem</li>
3032 <li>added an TextXmlReader (C#) like API (work in progress)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003033 <li>Rewrote the API in XML generation script, includes a C parser and saves
William M. Brack43a87292007-02-15 20:41:02 +00003034 more information needed for C# bindings</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00003035</ul>
3036
Daniel Veillardf9c4cad2002-11-22 15:57:07 +00003037<h3>2.4.28: Nov 22 2002</h3>
3038<ul>
3039 <li>a couple of python binding fixes</li>
3040 <li>2 bug fixes in the XML push parser</li>
3041 <li>potential memory leak removed (Martin Stoilov)</li>
3042 <li>fix to the configure script for Unix (Dimitri Papadopoulos)</li>
3043 <li>added encoding support for XInclude parse="text"</li>
3044 <li>autodetection of XHTML1 and specific serialization rules added</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +00003045 <li>nasty threading bug fixed (William Brack)</li>
Daniel Veillardf9c4cad2002-11-22 15:57:07 +00003046</ul>
3047
Daniel Veillarddad3f682002-11-17 16:47:27 +00003048<h3>2.4.27: Nov 17 2002</h3>
3049<ul>
3050 <li>fixes for the Python bindings</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003051 <li>a number of bug fixes: SGML catalogs, xmlParseBalancedChunkMemory(),
3052 HTML parser, Schemas (Charles Bozeman), document fragment support
3053 (Christian Glahn), xmlReconciliateNs (Brian Stafford), XPointer,
3054 xmlFreeNode(), xmlSAXParseMemory (Peter Jones), xmlGetNodePath (Petr
3055 Pajas), entities processing</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +00003056 <li>added grep to xmllint --shell</li>
3057 <li>VMS update patch from Craig A. Berry</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003058 <li>cleanup of the Windows build with support for more compilers (Igor),
3059 better thread support on Windows</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +00003060 <li>cleanup of Unix Makefiles and spec file</li>
3061 <li>Improvements to the documentation (John Fleck)</li>
3062</ul>
3063
Daniel Veillard48267432002-10-18 11:21:38 +00003064<h3>2.4.26: Oct 18 2002</h3>
3065<ul>
3066 <li>Patches for Windows CE port, improvements on Windows paths handling</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003067 <li>Fixes to the validation code (DTD and Schemas), xmlNodeGetPath() ,
3068 HTML serialization, Namespace compliance, and a number of small
3069 problems</li>
Daniel Veillard48267432002-10-18 11:21:38 +00003070</ul>
3071
Daniel Veillarde16b5742002-09-26 17:50:03 +00003072<h3>2.4.25: Sep 26 2002</h3>
3073<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003074 <li>A number of bug fixes: XPath, validation, Python bindings, DOM and
3075 tree, xmlI/O, Html</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00003076 <li>Serious rewrite of XInclude</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003077 <li>Made XML Schemas regexp part of the default build and APIs, small fix
3078 and improvement of the regexp core</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00003079 <li>Changed the validation code to reuse XML Schemas regexp APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003080 <li>Better handling of Windows file paths, improvement of Makefiles (Igor,
3081 Daniel Gehriger, Mark Vakoc)</li>
3082 <li>Improved the python I/O bindings, the tests, added resolver and regexp
3083 APIs</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00003084 <li>New logos from Marc Liyanage</li>
3085 <li>Tutorial improvements: John Fleck, Christopher Harris</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003086 <li>Makefile: Fixes for AMD x86_64 (Mandrake), DESTDIR (Christophe
3087 Merlet)</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +00003088 <li>removal of all stderr/perror use for error reporting</li>
3089 <li>Better error reporting: XPath and DTD validation</li>
3090 <li>update of the trio portability layer (Bjorn Reese)</li>
3091</ul>
3092
Daniel Veillard42766c02002-08-22 20:52:17 +00003093<p><strong>2.4.24: Aug 22 2002</strong></p>
3094<ul>
3095 <li>XPath fixes (William), xf:escape-uri() (Wesley Terpstra)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003096 <li>Python binding fixes: makefiles (William), generator, rpm build, x86-64
3097 (fcrozat)</li>
Daniel Veillard42766c02002-08-22 20:52:17 +00003098 <li>HTML &lt;style&gt; and boolean attributes serializer fixes</li>
3099 <li>C14N improvements by Aleksey</li>
Daniel Veillarde1662542002-08-28 11:50:59 +00003100 <li>doc cleanups: Rick Jones</li>
Daniel Veillard42766c02002-08-22 20:52:17 +00003101 <li>Windows compiler makefile updates: Igor and Elizabeth Barham</li>
3102 <li>XInclude: implementation of fallback and xml:base fixup added</li>
3103</ul>
3104
Daniel Veillard782afda2002-07-08 15:12:49 +00003105<h3>2.4.23: July 6 2002</h3>
3106<ul>
3107 <li>performances patches: Peter Jacobi</li>
3108 <li>c14n fixes, testsuite and performances: Aleksey Sanin</li>
3109 <li>added xmlDocFormatDump: Chema Celorio</li>
3110 <li>new tutorial: John Fleck</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003111 <li>new hash functions and performances: Sander Vesik, portability fix from
3112 Peter Jacobi</li>
3113 <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XML and
3114 HTML parsers, ID lookup function</li>
Daniel Veillard782afda2002-07-08 15:12:49 +00003115 <li>removal of all remaining sprintf: Aleksey Sanin</li>
3116</ul>
3117
Daniel Veillardc0801af2002-05-28 16:28:42 +00003118<h3>2.4.22: May 27 2002</h3>
3119<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003120 <li>a number of bug fixes: configure scripts, base handling, parser, memory
3121 usage, HTML parser, XPath, documentation (Christian Cornelssen),
3122 indentation, URI parsing</li>
3123 <li>Optimizations for XMLSec, fixing and making public some of the network
3124 protocol handlers (Aleksey)</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +00003125 <li>performance patch from Gary Pennington</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003126 <li>Charles Bozeman provided date and time support for XML Schemas
3127 datatypes</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +00003128</ul>
3129
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00003130<h3>2.4.21: Apr 29 2002</h3>
3131
Daniel Veillardf781dba2006-06-09 13:34:49 +00003132<p>This release is both a bug fix release and also contains the early XML
3133Schemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a> and <a
3134href="http://www.w3.org/TR/xmlschema-2/">datatypes</a> code, beware, all
3135interfaces are likely to change, there is huge holes, it is clearly a work in
3136progress and don't even think of putting this code in a production system,
Daniel Veillard726f67e2014-10-16 15:40:16 +08003137it's actually not compiled in by default. The real fixes are:
3138</p>
3139
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00003140<ul>
3141 <li>a couple of bugs or limitations introduced in 2.4.20</li>
3142 <li>patches for Borland C++ and MSC by Igor</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003143 <li>some fixes on XPath strings and conformance patches by Richard
3144 Jinks</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +00003145 <li>patch from Aleksey for the ExcC14N specification</li>
3146 <li>OSF/1 bug fix by Bjorn</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +00003147</ul>
3148
Daniel Veillarda7084cd2002-04-15 17:12:47 +00003149<h3>2.4.20: Apr 15 2002</h3>
3150<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +00003151 <li>bug fixes: file descriptor leak, XPath, HTML output, DTD validation</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +00003152 <li>XPath conformance testing by Richard Jinks</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003153 <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, python bindings,
3154 libxml.m4</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +00003155</ul>
3156
Daniel Veillard19274092002-03-25 16:48:03 +00003157<h3>2.4.19: Mar 25 2002</h3>
3158<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003159 <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin to UTF8
3160 encoder</li>
Daniel Veillard19274092002-03-25 16:48:03 +00003161 <li>portability fixes in the HTTP code</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +00003162 <li>memory allocation checks using valgrind, and profiling tests</li>
Daniel Veillard19274092002-03-25 16:48:03 +00003163 <li>revamp of the Windows build and Makefiles</li>
3164</ul>
3165
Daniel Veillard34ce8be2002-03-18 19:37:11 +00003166<h3>2.4.18: Mar 18 2002</h3>
3167<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003168 <li>bug fixes: tree, SAX, canonicalization, validation, portability,
3169 XPath</li>
Daniel Veillard34ce8be2002-03-18 19:37:11 +00003170 <li>removed the --with-buffer option it was becoming unmaintainable</li>
3171 <li>serious cleanup of the Python makefiles</li>
3172 <li>speedup patch to XPath very effective for DocBook stylesheets</li>
3173 <li>Fixes for Windows build, cleanup of the documentation</li>
3174</ul>
3175
Daniel Veillardaf43f632002-03-08 15:05:20 +00003176<h3>2.4.17: Mar 8 2002</h3>
3177<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003178 <li>a lot of bug fixes, including "namespace nodes have no parents in
3179 XPath"</li>
3180 <li>fixed/improved the Python wrappers, added more examples and more
3181 regression tests, XPath extension functions can now return node-sets</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003182 <li>added the XML Canonicalization support from Aleksey Sanin</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +00003183</ul>
3184
Daniel Veillard5f4b5992002-02-20 10:22:49 +00003185<h3>2.4.16: Feb 20 2002</h3>
3186<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003187 <li>a lot of bug fixes, most of them were triggered by the XML Testsuite
3188 from OASIS and W3C. Compliance has been significantly improved.</li>
Daniel Veillard5f4b5992002-02-20 10:22:49 +00003189 <li>a couple of portability fixes too.</li>
3190</ul>
3191
Daniel Veillard397ff112002-02-11 18:27:20 +00003192<h3>2.4.15: Feb 11 2002</h3>
3193<ul>
3194 <li>Fixed the Makefiles, especially the python module ones</li>
3195 <li>A few bug fixes and cleanup</li>
3196 <li>Includes cleanup</li>
3197</ul>
3198
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +00003199<h3>2.4.14: Feb 8 2002</h3>
3200<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +00003201 <li>Change of License to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003202 href="http://www.opensource.org/licenses/mit-license.html">MIT
3203 License</a> basically for integration in XFree86 codebase, and removing
3204 confusion around the previous dual-licensing</li>
3205 <li>added Python bindings, beta software but should already be quite
3206 complete</li>
3207 <li>a large number of fixes and cleanups, especially for all tree
3208 manipulations</li>
3209 <li>cleanup of the headers, generation of a reference API definition in
3210 XML</li>
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +00003211</ul>
3212
3213<h3>2.4.13: Jan 14 2002</h3>
Daniel Veillard744683d2002-01-14 17:30:20 +00003214<ul>
3215 <li>update of the documentation: John Fleck and Charlie Bozeman</li>
3216 <li>cleanup of timing code from Justin Fletcher</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003217 <li>fixes for Windows and initial thread support on Win32: Igor and Serguei
3218 Narojnyi</li>
Daniel Veillard744683d2002-01-14 17:30:20 +00003219 <li>Cygwin patch from Robert Collins</li>
3220 <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li>
3221</ul>
3222
Daniel Veillardef90ba72001-12-07 14:24:22 +00003223<h3>2.4.12: Dec 7 2001</h3>
3224<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003225 <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman),
3226 XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups
3227 (robert)</li>
Daniel Veillardef90ba72001-12-07 14:24:22 +00003228 <li>Eric Lavigne contributed project files for MacOS</li>
3229 <li>some makefiles cleanups</li>
3230</ul>
3231
Daniel Veillarda4871052001-11-26 13:19:48 +00003232<h3>2.4.11: Nov 26 2001</h3>
3233<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003234 <li>fixed a couple of errors in the includes, fixed a few bugs, some code
3235 cleanups</li>
Daniel Veillarda4871052001-11-26 13:19:48 +00003236 <li>xmllint man pages improvement by Heiko Rupp</li>
3237 <li>updated VMS build instructions from John A Fotheringham</li>
3238 <li>Windows Makefiles updates from Igor</li>
3239</ul>
3240
Daniel Veillard43d3f612001-11-10 11:57:23 +00003241<h3>2.4.10: Nov 10 2001</h3>
3242<ul>
3243 <li>URI escaping fix (Joel Young)</li>
3244 <li>added xmlGetNodePath() (for paths or XPointers generation)</li>
3245 <li>Fixes namespace handling problems when using DTD and validation</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003246 <li>improvements on xmllint: Morus Walter patches for --format and
3247 --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li>
Daniel Veillard43d3f612001-11-10 11:57:23 +00003248 <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li>
3249 <li>fixes to the HTML parser</li>
3250</ul>
3251
3252<h3>2.4.9: Nov 6 2001</h3>
3253<ul>
3254 <li>fixes more catalog bugs</li>
3255 <li>avoid a compilation problem, improve xmlGetLineNo()</li>
3256</ul>
3257
Daniel Veillarded421aa2001-11-04 21:22:45 +00003258<h3>2.4.8: Nov 4 2001</h3>
3259<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003260 <li>fixed SGML catalogs broken in previous release, updated xmlcatalog
3261 tool</li>
Daniel Veillarded421aa2001-11-04 21:22:45 +00003262 <li>fixed a compile errors and some includes troubles.</li>
3263</ul>
3264
Daniel Veillard52dcab32001-10-30 12:51:17 +00003265<h3>2.4.7: Oct 30 2001</h3>
3266<ul>
3267 <li>exported some debugging interfaces</li>
3268 <li>serious rewrite of the catalog code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003269 <li>integrated Gary Pennington thread safety patch, added configure option
3270 and regression tests</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +00003271 <li>removed an HTML parser bug</li>
3272 <li>fixed a couple of potentially serious validation bugs</li>
3273 <li>integrated the SGML DocBook support in xmllint</li>
3274 <li>changed the nanoftp anonymous login passwd</li>
3275 <li>some I/O cleanup and a couple of interfaces for Perl wrapper</li>
3276 <li>general bug fixes</li>
3277 <li>updated xmllint man page by John Fleck</li>
3278 <li>some VMS and Windows updates</li>
3279</ul>
3280
Daniel Veillard60087f32001-10-10 09:45:09 +00003281<h3>2.4.6: Oct 10 2001</h3>
3282<ul>
Daniel Veillard52dcab32001-10-30 12:51:17 +00003283 <li>added an updated man pages by John Fleck</li>
Daniel Veillard60087f32001-10-10 09:45:09 +00003284 <li>portability and configure fixes</li>
3285 <li>an infinite loop on the HTML parser was removed (William)</li>
3286 <li>Windows makefile patches from Igor</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003287 <li>fixed half a dozen bugs reported for libxml or libxslt</li>
Daniel Veillard60087f32001-10-10 09:45:09 +00003288 <li>updated xmlcatalog to be able to modify SGML super catalogs</li>
3289</ul>
3290
Daniel Veillarddadd0872001-09-15 09:21:44 +00003291<h3>2.4.5: Sep 14 2001</h3>
3292<ul>
3293 <li>Remove a few annoying bugs in 2.4.4</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003294 <li>forces the HTML serializer to output decimal charrefs since some
3295 version of Netscape can't handle hexadecimal ones</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +00003296</ul>
3297
3298<h3>1.8.16: Sep 14 2001</h3>
3299<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003300 <li>maintenance release of the old libxml1 branch, couple of bug and
3301 portability fixes</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +00003302</ul>
3303
Daniel Veillard04382ae2001-09-12 18:51:30 +00003304<h3>2.4.4: Sep 12 2001</h3>
3305<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003306 <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
3307 Catalog</li>
Daniel Veillard04382ae2001-09-12 18:51:30 +00003308 <li>a few bug fixes and some portability changes</li>
3309 <li>some documentation cleanups</li>
3310</ul>
3311
Daniel Veillard39936902001-08-24 00:49:01 +00003312<h3>2.4.3: Aug 23 2001</h3>
3313<ul>
3314 <li>XML Catalog support see the doc</li>
3315 <li>New NaN/Infinity floating point code</li>
3316 <li>A few bug fixes</li>
3317</ul>
3318
3319<h3>2.4.2: Aug 15 2001</h3>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +00003320<ul>
3321 <li>adds xmlLineNumbersDefault() to control line number generation</li>
3322 <li>lot of bug fixes</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003323 <li>the Microsoft MSC projects files should now be up to date</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +00003324 <li>inheritance of namespaces from DTD defaulted attributes</li>
3325 <li>fixes a serious potential security bug</li>
3326 <li>added a --format option to xmllint</li>
3327</ul>
3328
3329<h3>2.4.1: July 24 2001</h3>
3330<ul>
3331 <li>possibility to keep line numbers in the tree</li>
3332 <li>some computation NaN fixes</li>
3333 <li>extension of the XPath API</li>
3334 <li>cleanup for alpha and ia64 targets</li>
3335 <li>patch to allow saving through HTTP PUT or POST</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +00003336</ul>
3337
3338<h3>2.4.0: July 10 2001</h3>
3339<ul>
3340 <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003341 <li>Fixed XML Base implementation, added a couple of examples to the
3342 regression tests</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +00003343 <li>A bit of cleanup</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +00003344</ul>
3345
Daniel Veillard5b43fde2001-07-05 23:31:40 +00003346<h3>2.3.14: July 5 2001</h3>
3347<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003348 <li>fixed some entities problems and reduce memory requirement when
3349 substituting them</li>
3350 <li>lots of improvements in the XPath queries interpreter can be
3351 substantially faster</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +00003352 <li>Makefiles and configure cleanups</li>
3353 <li>Fixes to XPath variable eval, and compare on empty node set</li>
3354 <li>HTML tag closing bug fixed</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003355 <li>Fixed an URI reference computation problem when validating</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +00003356</ul>
3357
Daniel Veillard2adbb512001-06-28 16:20:36 +00003358<h3>2.3.13: June 28 2001</h3>
3359<ul>
3360 <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
3361 <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
3362</ul>
3363
3364<h3>1.8.14: June 28 2001</h3>
3365<ul>
3366 <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
3367 <li>Small Makefile fix</li>
3368</ul>
3369
Daniel Veillard11648102001-06-26 16:08:24 +00003370<h3>2.3.12: June 26 2001</h3>
3371<ul>
3372 <li>lots of cleanup</li>
3373 <li>a couple of validation fix</li>
3374 <li>fixed line number counting</li>
3375 <li>fixed serious problems in the XInclude processing</li>
3376 <li>added support for UTF8 BOM at beginning of entities</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003377 <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
3378 miscompile uri.c (William), Thomas Leitner provided a fix for the
3379 optimizer on Tru64</li>
3380 <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
3381 compilation on Windows MSC</li>
Daniel Veillard11648102001-06-26 16:08:24 +00003382 <li>update of libxml-doc.el (Felix Natter)</li>
3383 <li>fixed 2 bugs in URI normalization code</li>
3384</ul>
3385
Daniel Veillarde3c81b52001-06-17 14:50:34 +00003386<h3>2.3.11: June 17 2001</h3>
3387<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003388 <li>updates to trio, Makefiles and configure should fix some portability
3389 problems (alpha)</li>
3390 <li>fixed some HTML serialization problems (pre, script, and block/inline
3391 handling), added encoding aware APIs, cleanup of this code</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +00003392 <li>added xmlHasNsProp()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003393 <li>implemented a specific PI for encoding support in the DocBook SGML
3394 parser</li>
3395 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
3396 node selection)</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +00003397 <li>fixed a performance problem and an error in the validation code</li>
3398 <li>fixed XInclude routine to implement the recursive behaviour</li>
3399 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
3400 <li>added --version to xmllint for bug reports</li>
3401</ul>
3402
Daniel Veillard2e4f1882001-06-01 10:11:57 +00003403<h3>2.3.10: June 1 2001</h3>
3404<ul>
3405 <li>fixed the SGML catalog support</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003406 <li>a number of reported bugs got fixed, in XPath, iconv detection,
3407 XInclude processing</li>
Daniel Veillard2e4f1882001-06-01 10:11:57 +00003408 <li>XPath string function should now handle unicode correctly</li>
3409</ul>
3410
Daniel Veillard4623acd2001-05-19 15:13:15 +00003411<h3>2.3.9: May 19 2001</h3>
3412
Daniel Veillard726f67e2014-10-16 15:40:16 +08003413<p>Lots of bugfixes, and added a basic SGML catalog support:
3414</p>
Daniel Veillard4623acd2001-05-19 15:13:15 +00003415<ul>
Daniel Veillard726f67e2014-10-16 15:40:16 +08003416 <li>HTML push bugfix #54891 and another patch from Jonas Borgstrom</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003417 <li>some serious speed optimization again</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +00003418 <li>some documentation cleanups</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003419 <li>trying to get better linking on Solaris (-R)</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +00003420 <li>XPath API cleanup from Thomas Broyer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003421 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
3422 xmlValidGetValidElements()</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +00003423 <li>Added an INSTALL file</li>
3424 <li>Attribute removal added to API: #54433</li>
3425 <li>added a basic support for SGML catalogs</li>
3426 <li>fixed xmlKeepBlanksDefault(0) API</li>
3427 <li>bugfix in xmlNodeGetLang()</li>
3428 <li>fixed a small configure portability problem</li>
3429 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
3430</ul>
3431
Daniel Veillarda265af72001-05-14 11:13:58 +00003432<h3>1.8.13: May 14 2001</h3>
3433<ul>
3434 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
3435</ul>
3436
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +00003437<h3>2.3.8: May 3 2001</h3>
3438<ul>
3439 <li>Integrated an SGML DocBook parser for the Gnome project</li>
3440 <li>Fixed a few things in the HTML parser</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003441 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
3442 point portability issue</li>
3443 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
3444 DOM+validation using the XML REC as input and a 700MHz celeron).</li>
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +00003445 <li>incorporated more Windows cleanup</li>
3446 <li>added xmlSaveFormatFile()</li>
3447 <li>fixed problems in copying nodes with entities references (gdome)</li>
3448 <li>removed some troubles surrounding the new validation module</li>
3449</ul>
3450
Daniel Veillarda41123c2001-04-22 19:31:20 +00003451<h3>2.3.7: April 22 2001</h3>
3452<ul>
3453 <li>lots of small bug fixes, corrected XPointer</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003454 <li>Non deterministic content model validation support</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +00003455 <li>added xmlDocCopyNode for gdome2</li>
3456 <li>revamped the way the HTML parser handles end of tags</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003457 <li>XPath: corrections of namespaces support and number formatting</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +00003458 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003459 <li>HTML output fixes from P C Chow and William M. Brack</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +00003460 <li>Improved validation speed sensible for DocBook</li>
3461 <li>fixed a big bug with ID declared in external parsed entities</li>
3462 <li>portability fixes, update of Trio from Bjorn Reese</li>
3463</ul>
3464
Daniel Veillardafc73112001-04-11 11:51:41 +00003465<h3>2.3.6: April 8 2001</h3>
3466<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003467 <li>Code cleanup using extreme gcc compiler warning options, found and
3468 cleared half a dozen potential problem</li>
Daniel Veillardafc73112001-04-11 11:51:41 +00003469 <li>the Eazel team found an XML parser bug</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003470 <li>cleaned up the user of some of the string formatting function. used the
3471 trio library code to provide the one needed when the platform is missing
3472 them</li>
3473 <li>xpath: removed a memory leak and fixed the predicate evaluation
3474 problem, extended the testsuite and cleaned up the result. XPointer seems
3475 broken ...</li>
Daniel Veillardafc73112001-04-11 11:51:41 +00003476</ul>
3477
Daniel Veillard56a4cb82001-03-24 17:00:36 +00003478<h3>2.3.5: Mar 23 2001</h3>
3479<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003480 <li>Biggest change is separate parsing and evaluation of XPath expressions,
3481 there is some new APIs for this too</li>
3482 <li>included a number of bug fixes(XML push parser, 51876, notations,
3483 52299)</li>
Daniel Veillard56a4cb82001-03-24 17:00:36 +00003484 <li>Fixed some portability issues</li>
3485</ul>
3486
Daniel Veillarde356c282001-03-10 12:32:04 +00003487<h3>2.3.4: Mar 10 2001</h3>
3488<ul>
3489 <li>Fixed bugs #51860 and #51861</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003490 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
3491 size to be application tunable.</li>
3492 <li>Some cleanup in the validation code, still a bug left and this part
3493 should probably be rewritten to support ambiguous content model :-\</li>
3494 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
3495 parser</li>
Daniel Veillarde356c282001-03-10 12:32:04 +00003496 <li>Fixed another bug in xmlNodeGetContent()</li>
3497 <li>Bjorn fixed XPath node collection and Number formatting</li>
3498 <li>Fixed a loop reported in the HTML parsing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003499 <li>blank space are reported even if the Dtd content model proves that they
3500 are formatting spaces, this is for XML conformance</li>
Daniel Veillarde356c282001-03-10 12:32:04 +00003501</ul>
3502
Daniel Veillardb402c072001-03-01 17:28:58 +00003503<h3>2.3.3: Mar 1 2001</h3>
3504<ul>
3505 <li>small change in XPath for XSLT</li>
3506 <li>documentation cleanups</li>
3507 <li>fix in validation by Gary Pennington</li>
3508 <li>serious parsing performances improvements</li>
3509</ul>
3510
Daniel Veillardec70e912001-02-26 20:10:45 +00003511<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +00003512<ul>
3513 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
3514 <li>fixed a Dtd parsing bug</li>
3515 <li>fixed a bug in xmlNodeGetContent</li>
3516 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
3517</ul>
3518
Daniel Veillardec70e912001-02-26 20:10:45 +00003519<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00003520<ul>
3521 <li>some XPath and HTML bug fixes for XSLT</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003522 <li>small extension of the hash table interfaces for DOM gdome2
3523 implementation</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00003524 <li>A few bug fixes</li>
3525</ul>
3526
Daniel Veillardec70e912001-02-26 20:10:45 +00003527<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 +00003528<ul>
3529 <li>Lots of XPath bug fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003530 <li>Add a mode with Dtd lookup but without validation error reporting for
3531 XSLT</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00003532 <li>Add support for text node without escaping (XSLT)</li>
3533 <li>bug fixes for xmlCheckFilename</li>
3534 <li>validation code bug fixes from Gary Pennington</li>
3535 <li>Patch from Paul D. Smith correcting URI path normalization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003536 <li>Patch to allow simultaneous install of libxml-devel and
3537 libxml2-devel</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00003538 <li>the example Makefile is now fixed</li>
3539 <li>added HTML to the RPM packages</li>
3540 <li>tree copying bugfixes</li>
3541 <li>updates to Windows makefiles</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003542 <li>optimization patch from Bjorn Reese</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00003543</ul>
3544
Daniel Veillardec70e912001-02-26 20:10:45 +00003545<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +00003546<ul>
3547 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
3548 <li>added htmlHandleOmittedElem()</li>
3549 <li>Applied Bjorn Reese's IPV6 first patch</li>
3550 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +00003551 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +00003552</ul>
3553
Daniel Veillard2ddd23d2000-11-25 10:42:19 +00003554<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +00003555<ul>
3556 <li>Fix the Windows problems of 2.2.8</li>
3557 <li>integrate OpenVMS patches</li>
3558 <li>better handling of some nasty HTML input</li>
3559 <li>Improved the XPointer implementation</li>
3560 <li>integrate a number of provided patches</li>
3561</ul>
3562
Daniel Veillard2ddd23d2000-11-25 10:42:19 +00003563<h3>2.2.9: Nov 25 2000</h3>
3564<ul>
3565 <li>erroneous release :-(</li>
3566</ul>
3567
Daniel Veillard28929b22000-11-13 18:22:49 +00003568<h3>2.2.8: Nov 13 2000</h3>
3569<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003570 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
3571 support</li>
Daniel Veillard28929b22000-11-13 18:22:49 +00003572 <li>Patch in conditional section handling</li>
3573 <li>updated MS compiler project</li>
3574 <li>fixed some XPath problems</li>
3575 <li>added an URI escaping function</li>
3576 <li>some other bug fixes</li>
3577</ul>
3578
3579<h3>2.2.7: Oct 31 2000</h3>
3580<ul>
3581 <li>added message redirection</li>
3582 <li>XPath improvements (thanks TOM !)</li>
3583 <li>xmlIOParseDTD() added</li>
3584 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
3585 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
3586</ul>
3587
Daniel Veillard29a11cc2000-10-25 13:32:39 +00003588<h3>2.2.6: Oct 25 2000:</h3>
3589<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003590 <li>Added an hash table module, migrated a number of internal structure to
3591 those</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +00003592 <li>Fixed a posteriori validation problems</li>
3593 <li>HTTP module cleanups</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003594 <li>HTML parser improvements (tag errors, script/style handling, attribute
3595 normalization)</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +00003596 <li>coalescing of adjacent text nodes</li>
3597 <li>couple of XPath bug fixes, exported the internal API</li>
3598</ul>
3599
Daniel Veillardab8500d2000-10-15 21:06:19 +00003600<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +00003601<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +00003602 <li>XPointer implementation and testsuite</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003603 <li>Lot of XPath fixes, added variable and functions registration, more
3604 tests</li>
3605 <li>Portability fixes, lots of enhancements toward an easy Windows build
3606 and release</li>
Daniel Veillard189446d2000-10-13 10:23:06 +00003607 <li>Late validation fixes</li>
3608 <li>Integrated a lot of contributed patches</li>
3609 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +00003610 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +00003611</ul>
3612
3613<h3>2.2.4: Oct 1 2000:</h3>
3614<ul>
3615 <li>main XPath problem fixed</li>
3616 <li>Integrated portability patches for Windows</li>
3617 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +00003618</ul>
3619
Daniel Veillardd5f97f82000-09-17 16:38:14 +00003620<h3>2.2.3: Sep 17 2000</h3>
3621<ul>
3622 <li>bug fixes</li>
3623 <li>cleanup of entity handling code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003624 <li>overall review of all loops in the parsers, all sprintf usage has been
3625 checked too</li>
3626 <li>Far better handling of larges Dtd. Validating against DocBook XML Dtd
3627 works smoothly now.</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +00003628</ul>
3629
3630<h3>1.8.10: Sep 6 2000</h3>
3631<ul>
3632 <li>bug fix release for some Gnome projects</li>
3633</ul>
3634
3635<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +00003636<ul>
3637 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +00003638 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +00003639</ul>
3640
Daniel Veillardd5f97f82000-09-17 16:38:14 +00003641<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +00003642<ul>
3643 <li>a purely bug fixes release</li>
3644 <li>fixed an encoding support problem when parsing from a memory block</li>
3645 <li>fixed a DOCTYPE parsing problem</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003646 <li>removed a bug in the function allowing to override the memory
3647 allocation routines</li>
Daniel Veillarda2679fa2000-07-22 02:38:15 +00003648</ul>
3649
Daniel Veillardd5f97f82000-09-17 16:38:14 +00003650<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +00003651<ul>
3652 <li>applied a lot of portability fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003653 <li>better encoding support/cleanup and saving (content is now always
3654 encoded in UTF-8)</li>
Daniel Veillard94e90602000-07-17 14:38:19 +00003655 <li>the HTML parser now correctly handles encodings</li>
3656 <li>added xmlHasProp()</li>
3657 <li>fixed a serious problem with &amp;#38;</li>
3658 <li>propagated the fix to FTP client</li>
3659 <li>cleanup, bugfixes, etc ...</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003660 <li>Added a page about <a href="encoding.html">libxml Internationalization
3661 support</a></li>
Daniel Veillard94e90602000-07-17 14:38:19 +00003662</ul>
3663
Daniel Veillard60979bd2000-07-10 12:17:33 +00003664<h3>1.8.9: July 9 2000</h3>
3665<ul>
3666 <li>fixed the spec the RPMs should be better</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003667 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
3668 rpmfind users problem</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +00003669</ul>
3670
Daniel Veillard6388e172000-07-03 16:07:19 +00003671<h3>2.1.1: July 1 2000</h3>
3672<ul>
3673 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
3674 <li>improvements on the HTML parser</li>
3675</ul>
3676
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00003677<h3>2.1.0 and 1.8.8: June 29 2000</h3>
3678<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003679 <li>1.8.8 is mostly a commodity package for upgrading to libxml2 according
3680 to <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
3681 about &amp;#38; charref parsing</li>
3682 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
3683 also contains numerous fixes and enhancements:
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00003684 <ul>
3685 <li>added xmlStopParser() to stop parsing</li>
3686 <li>improved a lot parsing speed when there is large CDATA blocs</li>
3687 <li>includes XPath patches provided by Picdar Technology</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003688 <li>tried to fix as much as possible DTD validation and namespace
3689 related problems</li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +00003690 <li>output to a given encoding has been added/tested</li>
3691 <li>lot of various fixes</li>
3692 </ul>
3693 </li>
3694</ul>
3695
Daniel Veillarde0aed302000-04-16 08:52:20 +00003696<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +00003697<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003698 <li>First public release of libxml2. If you are using libxml, it's a good
3699 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initially
3700 scheduled for Apr 3 the release occurred only on Apr 12 due to massive
3701 workload.</li>
3702 <li>The include are now located under $prefix/include/libxml (instead of
3703 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +00003704 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +00003705 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +00003706 <pre>#include "xxx.h"</pre>
3707 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +00003708 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003709 <li>the memory allocation routines used by libxml can now be overloaded
3710 dynamically by using xmlMemSetup()</li>
3711 <li>The previously CVS only tool tester has been renamed
3712 <strong>xmllint</strong> and is now installed as part of the libxml2
3713 package</li>
3714 <li>The I/O interface has been revamped. There is now ways to plug in
3715 specific I/O modules, either at the URI scheme detection level using
3716 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
3717 parser context using xmlCreateIOParserCtxt()</li>
3718 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
3719 number of the libxml module in use</li>
3720 <li>a number of optional features of libxml can now be excluded at
3721 configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +00003722</ul>
3723
3724<h3>2.0.0beta: Mar 14 2000</h3>
3725<ul>
3726 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003727 <li>It's available only from<a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org
3728 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
3729 RPMs</li>
3730 <li>This version is now the head in the Gnome CVS base, the old one is
3731 available under the tag LIB_XML_1_X</li>
3732 <li>This includes a very large set of changes. From a programmatic point
3733 of view applications should not have to be modified too much, check the
3734 <a href="upgrade.html">upgrade page</a></li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +00003735 <li>Some interfaces may changes (especially a bit about encoding).</li>
3736 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +00003737 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003738 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
3739 handled now</li>
3740 <li>Better handling of entities, especially well-formedness checking
3741 and proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +00003742 <li>DTD conditional sections</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003743 <li>Validation now correctly handle entities content</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003744 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
3745 structures to accommodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +00003746 </ul>
3747 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +00003748 <li>Serious progress were made toward compliance, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003749 href="conf/result.html">here are the result of the test</a> against the
3750 OASIS testsuite (except the Japanese tests since I don't support that
3751 encoding yet). This URL is rebuilt every couple of hours using the CVS
3752 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +00003753</ul>
3754
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00003755<h3>1.8.7: Mar 6 2000</h3>
3756<ul>
3757 <li>This is a bug fix release:</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003758 <li>It is possible to disable the ignorable blanks heuristic used by
3759 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
3760 that for adherence to XML spec, this behaviour will be disabled by
3761 default in 2.x . The same function will allow to keep compatibility for
3762 old code.</li>
3763 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
3764 avoiding heuristic is really the Right Way :-\</li>
3765 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
3766 compilation on some platforms has been fixed</li>
3767 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
3768 URIs</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00003769</ul>
3770
Daniel Veillarde41f2b72000-01-30 20:00:07 +00003771<h3>1.8.6: Jan 31 2000</h3>
3772<ul>
3773 <li>added a nanoFTP transport module, debugged until the new version of <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003774 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
3775 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +00003776</ul>
3777
3778<h3>1.8.5: Jan 21 2000</h3>
3779<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +00003780 <li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003781 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
3782 XML spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +00003783 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003784 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
3785 to solve the zlib checks problems</li>
3786 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
3787 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +00003788</ul>
3789
3790<h3>1.8.4: Jan 13 2000</h3>
3791<ul>
3792 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
3793 <li>all exit() call should have been removed from libxml</li>
3794 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
3795 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +00003796</ul>
3797
3798<h3>1.8.3: Jan 5 2000</h3>
3799<ul>
3800 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +00003801 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillard63d83142002-05-20 06:51:05 +00003802 <li>lots of bug fixes and improvement added over XMas holidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +00003803 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +00003804 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
3805 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003806 <li>External entity loading code has been revamped, now it uses
3807 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +00003808 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +00003809</ul>
3810
3811<h3>1.8.2: Dec 21 1999</h3>
3812<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003813 <li>I got another problem with includes and C++, I hope this issue is fixed
3814 for good this time</li>
3815 <li>Added a few tree modification functions: xmlReplaceNode,
3816 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
3817 xmlDocSetRootElement</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +00003818 <li>Tried to improve the HTML output with help from <a
3819 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +00003820</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +00003821
Daniel Veillarde4e51311999-12-18 15:32:46 +00003822<h3>1.8.1: Dec 18 1999</h3>
3823<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003824 <li>various patches to avoid troubles when using libxml with C++ compilers
3825 the "namespace" keyword and C escaping in include files</li>
Daniel Veillarde4e51311999-12-18 15:32:46 +00003826 <li>a problem in one of the core macros IS_CHAR was corrected</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003827 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
3828 and more specifically the Dia application</li>
3829 <li>fixed a posteriori validation (validation after parsing, or by using a
3830 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +00003831 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +00003832</ul>
3833
3834<h3>1.8.0: Dec 12 1999</h3>
3835<ul>
3836 <li>cleanup, especially memory wise</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003837 <li>the parser should be more reliable, especially the HTML one, it should
3838 not crash, whatever the input !</li>
3839 <li>Integrated various patches, especially a speedup improvement for large
3840 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
3841 configure with --with-buffers to enable them.</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +00003842 <li>attribute normalization, oops should have been added long ago !</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003843 <li>attributes defaulted from DTDs should be available, xmlSetProp() now
3844 does entities escaping by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +00003845</ul>
Daniel Veillard35008381999-10-25 13:15:52 +00003846
3847<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003848<ul>
Daniel Veillard35008381999-10-25 13:15:52 +00003849 <li>Lots of HTML improvement</li>
3850 <li>Fixed some errors when saving both XML and HTML</li>
3851 <li>More examples, the regression tests should now look clean</li>
3852 <li>Fixed a bug with contiguous charref</li>
3853</ul>
3854
3855<h3>1.7.3: Sep 29 1999</h3>
3856<ul>
3857 <li>portability problems fixed</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003858 <li>snprintf was used unconditionally, leading to link problems on system
3859 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003860</ul>
3861
3862<h3>1.7.1: Sep 24 1999</h3>
3863<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003864 <li>The basic type for strings manipulated by libxml has been renamed in
3865 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
3866 is that CHAR was conflicting with a predefined type on Windows. However
3867 on non WIN32 environment, compatibility is provided by the way of a
3868 <strong>#define </strong>.</li>
3869 <li>Changed another error : the use of a structure field called errno, and
3870 leading to troubles on platforms where it's a macro</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003871</ul>
3872
Daniel Veillard63d83142002-05-20 06:51:05 +00003873<h3>1.7.0: Sep 23 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003874<ul>
3875 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003876 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
3877 <li>Added an errno to report errors by another mean than a simple printf
3878 like callback</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003879 <li>Finished ID/IDREF support and checking when validation</li>
3880 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003881 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
3882 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
3883 implementation</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00003884 <li>Added an HTML parser front-end</li>
3885</ul>
3886
3887<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003888
Daniel Veillardf781dba2006-06-09 13:34:49 +00003889<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
3890markup-based structured documents. Here is <a name="example">an example XML
3891document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00003892<pre>&lt;?xml version="1.0"?&gt;
3893&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
3894 &lt;head&gt;
3895 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
3896 &lt;/head&gt;
3897 &lt;chapter&gt;
3898 &lt;title&gt;The Linux adventure&lt;/title&gt;
3899 &lt;p&gt;bla bla bla ...&lt;/p&gt;
3900 &lt;image href="linus.gif"/&gt;
3901 &lt;p&gt;...&lt;/p&gt;
3902 &lt;/chapter&gt;
3903&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00003904
Daniel Veillardf781dba2006-06-09 13:34:49 +00003905<p>The first line specifies that it is an XML document and gives useful
3906information about its encoding. Then the rest of the document is a text
3907format whose structure is specified by tags between brackets. <strong>Each
3908tag opened has to be closed</strong>. XML is pedantic about this. However, if
3909a tag is empty (no content), a single tag can serve as both the opening and
3910closing tag if it ends with <code>/&gt;</code> rather than with
3911<code>&gt;</code>. Note that, for example, the image tag has no content (just
3912an attribute) and is closed by ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00003913
Daniel Veillardf781dba2006-06-09 13:34:49 +00003914<p>XML can be applied successfully to a wide range of tasks, ranging from
3915long term structured document maintenance (where it follows the steps of
3916SGML) to simple data encoding mechanisms like configuration file formatting
3917(glade), spreadsheets (gnumeric), or even shorter lived documents such as
3918WebDAV where it is used to encode remote calls between a client and a
3919server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00003920
Daniel Veillard82687162001-01-22 15:32:01 +00003921<h2><a name="XSLT">XSLT</a></h2>
3922
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +00003923<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
3924
Daniel Veillardf781dba2006-06-09 13:34:49 +00003925<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
3926language for transforming XML documents into other XML documents (or
3927HTML/textual output).</p>
Daniel Veillard82687162001-01-22 15:32:01 +00003928
Daniel Veillardf781dba2006-06-09 13:34:49 +00003929<p>A separate library called libxslt is available implementing XSLT-1.0 for
William M. Brack43a87292007-02-15 20:41:02 +00003930libxml2. This module "libxslt" too can be found in the Gnome SVN base.</p>
Daniel Veillard82687162001-01-22 15:32:01 +00003931
Daniel Veillard29f61002005-08-06 09:07:15 +00003932<p>You can check the progresses on the libxslt <a
3933href="http://xmlsoft.org/XSLT/ChangeLog.html">Changelog</a>.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003934
3935<h2><a name="Python">Python and bindings</a></h2>
3936
Daniel Veillardf781dba2006-06-09 13:34:49 +00003937<p>There are a number of language bindings and wrappers available for
3938libxml2, the list below is not exhaustive. Please contact the <a
3939href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
3940(<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
3941order to get updates to this list or to discuss the specific topic of libxml2
3942or libxslt wrappers or bindings:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003943<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003944 <li><a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the
3945 most up-to-date C++ bindings for libxml2, check the <a
3946 href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>
3947 and the <a
Daniel Veillardc14401e2002-11-20 14:28:17 +00003948 href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003949 <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
3950 based on the gdome2 bindings</a> maintained by Tobias Peters.</li>
Daniel Veillard9b6fd302002-05-13 12:06:47 +00003951 <li>and a third C++ wrapper by Peter Jones &lt;pjones@pmade.org&gt;
3952 <p>Website: <a
3953 href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
3954 </li>
Daniel Veillardd012f482007-08-22 17:36:57 +00003955 <li>XML::LibXML <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXML">Perl
3956 bindings</a> are available on CPAN, as well as XML::LibXSLT
3957 <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXSLT">Perl libxslt
3958 bindings</a>.</li>
Daniel Veillard4ac494b2003-09-18 15:08:00 +00003959 <li>If you're interested into scripting XML processing, have a look at <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003960 href="http://xsh.sourceforge.net/">XSH</a> an XML editing shell based on
3961 Libxml2 Perl bindings.</li>
3962 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an
3963 earlier version of the libxml/libxslt <a
Daniel Veillard0b28e882002-07-24 23:47:05 +00003964 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li>
Daniel Veillard21473672002-06-17 07:29:22 +00003965 <li>Gopal.V and Peter Minten develop <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003966 href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of
3967 C# libxml2 bindings.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003968 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003969 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
3970 libxml2</a> with Kylix, Delphi and other Pascal compilers.</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +00003971 <li>Uwe Fechner also provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003972 href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2
3973 implementation for Kylix2/D5/D6 from Borland.</li>
3974 <li>There is <a href="http://libxml.rubyforge.org/">bindings for Ruby</a>
3975 and libxml2 bindings are also available in Ruby through the <a
3976 href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
3977 maintained by Tobias Peters.</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +00003978 <li>Steve Ball and contributors maintains <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003979 href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
3980 Tcl</a>.</li>
William M. Brack43a87292007-02-15 20:41:02 +00003981 <li>libxml2 and libxslt are the default XML libraries for PHP5.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00003982 <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
3983 an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
3984 libxslt as part of GNU ClasspathX project.</li>
3985 <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for
3986 <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li>
Daniel Veillard67952602006-01-05 15:29:44 +00003987 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003988 href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>
3989 provides <a
3990 href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib
3991 osax</a>. This is an osax for Mac OS X with a set of commands to
3992 implement in AppleScript the XML DOM, XPATH and XSLT. Also includes
3993 commands for Property-lists (Apple's fast lookup table XML format.)</li>
Daniel Veillard67952602006-01-05 15:29:44 +00003994 <li>Francesco Montorsi developped <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00003995 href="https://sourceforge.net/project/showfiles.php?group_id=51305&amp;package_id=45182">wxXml2</a>
3996 wrappers that interface libxml2, allowing wxWidgets applications to
3997 load/save/edit XML instances.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00003998</ul>
3999
Daniel Veillardf781dba2006-06-09 13:34:49 +00004000<p>The distribution includes a set of Python bindings, which are guaranteed
4001to be maintained as part of the library in the future, though the Python
4002interface have not yet reached the completeness of the C API.</p>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +00004003
Daniel Veillardf781dba2006-06-09 13:34:49 +00004004<p>Note that some of the Python purist dislike the default set of Python
4005bindings, rather than complaining I suggest they have a look at <a
Daniel Veillard28fdf8b2011-03-07 08:12:39 +08004006href="http://lxml.de/">lxml the more pythonic bindings for libxml2
Daniel Veillardf781dba2006-06-09 13:34:49 +00004007and libxslt</a> and <a
Daniel Veillard28fdf8b2011-03-07 08:12:39 +08004008href="http://lxml.de/mailinglist/">check the mailing-list</a>.</p>
Daniel Veillard929746e2005-05-11 11:08:22 +00004009
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004010<p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004011maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
4012of the Python bindings</a>.</p>
Daniel Veillardaf43f632002-03-08 15:05:20 +00004013
Daniel Veillardf781dba2006-06-09 13:34:49 +00004014<p>Note to people interested in building bindings, the API is formalized as
4015<a href="libxml2-api.xml">an XML API description file</a> which allows to
4016automate a large part of the Python bindings, this includes function
4017descriptions, enums, structures, typedefs, etc... The Python script used to
4018build the bindings is python/generator.py in the source distribution.</p>
Daniel Veillard7ef0fcb2002-12-14 10:38:55 +00004019
Daniel Veillardaf43f632002-03-08 15:05:20 +00004020<p>To install the Python bindings there are 2 options:</p>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +00004021<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +00004022 <li>If you use an RPM based distribution, simply install the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004023 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
4024 RPM</a> (and if needed the <a
4025 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
4026 RPM</a>).</li>
4027 <li>Otherwise use the <a href="ftp://xmlsoft.org/libxml2/python/">libxml2-python
4028 module distribution</a> corresponding to your installed version of
4029 libxml2 and libxslt. Note that to install it you will need both libxml2
4030 and libxslt installed and run "python setup.py build install" in the
4031 module tree.</li>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +00004032</ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +00004033
Daniel Veillardf781dba2006-06-09 13:34:49 +00004034<p>The distribution includes a set of examples and regression tests for the
4035python bindings in the <code>python/tests</code> directory. Here are some
4036excerpts from those tests:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004037
4038<h3>tst.py:</h3>
4039
4040<p>This is a basic test of the file interface and DOM navigation:</p>
MST 2003 John Fleck2dffb762003-11-29 04:41:24 +00004041<pre>import libxml2, sys
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004042
4043doc = libxml2.parseFile("tst.xml")
4044if doc.name != "tst.xml":
4045 print "doc.name failed"
4046 sys.exit(1)
4047root = doc.children
4048if root.name != "doc":
4049 print "root.name failed"
4050 sys.exit(1)
4051child = root.children
4052if child.name != "foo":
4053 print "child.name failed"
4054 sys.exit(1)
4055doc.freeDoc()</pre>
4056
Daniel Veillardf781dba2006-06-09 13:34:49 +00004057<p>The Python module is called libxml2; parseFile is the equivalent of
4058xmlParseFile (most of the bindings are automatically generated, and the xml
4059prefix is removed and the casing convention are kept). All node seen at the
4060binding level share the same subset of accessors:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004061<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004062 <li><code>name</code> : returns the node name</li>
4063 <li><code>type</code> : returns a string indicating the node type</li>
4064 <li><code>content</code> : returns the content of the node, it is based on
4065 xmlNodeGetContent() and hence is recursive.</li>
4066 <li><code>parent</code> , <code>children</code>, <code>last</code>,
4067 <code>next</code>, <code>prev</code>, <code>doc</code>,
4068 <code>properties</code>: pointing to the associated element in the tree,
4069 those may return None in case no such link exists.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004070</ul>
4071
Daniel Veillardf781dba2006-06-09 13:34:49 +00004072<p>Also note the need to explicitly deallocate documents with freeDoc() .
4073Reference counting for libxml2 trees would need quite a lot of work to
4074function properly, and rather than risk memory leaks if not implemented
4075correctly it sounds safer to have an explicit function to free a tree. The
4076wrapper python objects like doc, root or child are them automatically garbage
4077collected.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004078
4079<h3>validate.py:</h3>
4080
Daniel Veillardf781dba2006-06-09 13:34:49 +00004081<p>This test check the validation interfaces and redirection of error
4082messages:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004083<pre>import libxml2
4084
Daniel Veillard63d83142002-05-20 06:51:05 +00004085#deactivate error messages from the validation
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004086def noerr(ctx, str):
4087 pass
4088
4089libxml2.registerErrorHandler(noerr, None)
4090
4091ctxt = libxml2.createFileParserCtxt("invalid.xml")
4092ctxt.validate(1)
4093ctxt.parseDocument()
4094doc = ctxt.doc()
4095valid = ctxt.isValid()
4096doc.freeDoc()
4097if valid != 0:
Daniel Veillard63d83142002-05-20 06:51:05 +00004098 print "validity check failed"</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004099
Daniel Veillardf781dba2006-06-09 13:34:49 +00004100<p>The first thing to notice is the call to registerErrorHandler(), it
4101defines a new error handler global to the library. It is used to avoid seeing
4102the error messages when trying to validate the invalid document.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004103
Daniel Veillardf781dba2006-06-09 13:34:49 +00004104<p>The main interest of that test is the creation of a parser context with
4105createFileParserCtxt() and how the behaviour can be changed before calling
William M. Brack43a87292007-02-15 20:41:02 +00004106parseDocument() . Similarly the information resulting from the parsing phase
4107is also available using context methods.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004108
Daniel Veillardf781dba2006-06-09 13:34:49 +00004109<p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
4110C function interfaces in terms of objects method as much as possible. The
4111best to get a complete view of what methods are supported is to look at the
4112libxml2.py module containing all the wrappers.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004113
4114<h3>push.py:</h3>
4115
4116<p>This test show how to activate the push parser interface:</p>
4117<pre>import libxml2
4118
4119ctxt = libxml2.createPushParser(None, "&lt;foo", 4, "test.xml")
4120ctxt.parseChunk("/&gt;", 2, 1)
4121doc = ctxt.doc()
4122
4123doc.freeDoc()</pre>
4124
Daniel Veillardf781dba2006-06-09 13:34:49 +00004125<p>The context is created with a special call based on the
4126xmlCreatePushParser() from the C library. The first argument is an optional
4127SAX callback object, then the initial set of data, the length and the name of
4128the resource in case URI-References need to be computed by the parser.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004129
Daniel Veillardf781dba2006-06-09 13:34:49 +00004130<p>Then the data are pushed using the parseChunk() method, the last call
4131setting the third argument terminate to 1.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004132
4133<h3>pushSAX.py:</h3>
4134
Daniel Veillardf781dba2006-06-09 13:34:49 +00004135<p>this test show the use of the event based parsing interfaces. In this case
4136the parser does not build a document, but provides callback information as
4137the parser makes progresses analyzing the data being provided:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004138<pre>import libxml2
4139log = ""
4140
4141class callback:
4142 def startDocument(self):
4143 global log
4144 log = log + "startDocument:"
4145
4146 def endDocument(self):
4147 global log
4148 log = log + "endDocument:"
4149
4150 def startElement(self, tag, attrs):
4151 global log
4152 log = log + "startElement %s %s:" % (tag, attrs)
4153
4154 def endElement(self, tag):
4155 global log
4156 log = log + "endElement %s:" % (tag)
4157
4158 def characters(self, data):
4159 global log
4160 log = log + "characters: %s:" % (data)
4161
4162 def warning(self, msg):
4163 global log
4164 log = log + "warning: %s:" % (msg)
4165
4166 def error(self, msg):
4167 global log
4168 log = log + "error: %s:" % (msg)
4169
4170 def fatalError(self, msg):
4171 global log
4172 log = log + "fatalError: %s:" % (msg)
4173
4174handler = callback()
4175
4176ctxt = libxml2.createPushParser(handler, "&lt;foo", 4, "test.xml")
4177chunk = " url='tst'&gt;b"
4178ctxt.parseChunk(chunk, len(chunk), 0)
4179chunk = "ar&lt;/foo&gt;"
4180ctxt.parseChunk(chunk, len(chunk), 1)
4181
Daniel Veillardfcbfa2d2002-02-21 17:54:27 +00004182reference = "startDocument:startElement foo {'url': 'tst'}:" + \
4183 "characters: bar:endElement foo:endDocument:"
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004184if log != reference:
4185 print "Error got: %s" % log
Daniel Veillard63d83142002-05-20 06:51:05 +00004186 print "Expected: %s" % reference</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004187
Daniel Veillardf781dba2006-06-09 13:34:49 +00004188<p>The key object in that test is the handler, it provides a number of entry
4189points which can be called by the parser as it makes progresses to indicate
4190the information set obtained. The full set of callback is larger than what
4191the callback class in that specific example implements (see the SAX
4192definition for a complete list). The wrapper will only call those supplied by
4193the object when activated. The startElement receives the names of the element
4194and a dictionary containing the attributes carried by this element.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004195
Daniel Veillardf781dba2006-06-09 13:34:49 +00004196<p>Also note that the reference string generated from the callback shows a
4197single character call even though the string "bar" is passed to the parser
4198from 2 different call to parseChunk()</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004199
4200<h3>xpath.py:</h3>
4201
Daniel Veillard63d83142002-05-20 06:51:05 +00004202<p>This is a basic test of XPath wrappers support</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004203<pre>import libxml2
4204
4205doc = libxml2.parseFile("tst.xml")
4206ctxt = doc.xpathNewContext()
4207res = ctxt.xpathEval("//*")
4208if len(res) != 2:
4209 print "xpath query: wrong node set size"
4210 sys.exit(1)
4211if res[0].name != "doc" or res[1].name != "foo":
4212 print "xpath query: wrong node set value"
4213 sys.exit(1)
4214doc.freeDoc()
4215ctxt.xpathFreeContext()</pre>
4216
Daniel Veillardf781dba2006-06-09 13:34:49 +00004217<p>This test parses a file, then create an XPath context to evaluate XPath
4218expression on it. The xpathEval() method execute an XPath query and returns
4219the result mapped in a Python way. String and numbers are natively converted,
4220and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
4221the document, the XPath context need to be freed explicitly, also not that
4222the result of the XPath query may point back to the document tree and hence
4223the document must be freed after the result of the query is used.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004224
4225<h3>xpathext.py:</h3>
4226
Daniel Veillardf781dba2006-06-09 13:34:49 +00004227<p>This test shows how to extend the XPath engine with functions written in
4228python:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004229<pre>import libxml2
4230
4231def foo(ctx, x):
4232 return x + 1
4233
4234doc = libxml2.parseFile("tst.xml")
4235ctxt = doc.xpathNewContext()
4236libxml2.registerXPathFunction(ctxt._o, "foo", None, foo)
4237res = ctxt.xpathEval("foo(1)")
4238if res != 2:
4239 print "xpath extension failure"
4240doc.freeDoc()
4241ctxt.xpathFreeContext()</pre>
4242
Daniel Veillardf781dba2006-06-09 13:34:49 +00004243<p>Note how the extension function is registered with the context (but that
4244part is not yet finalized, this may change slightly in the future).</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004245
4246<h3>tstxpath.py:</h3>
4247
Daniel Veillardf781dba2006-06-09 13:34:49 +00004248<p>This test is similar to the previous one but shows how the extension
4249function can access the XPath evaluation context:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004250<pre>def foo(ctx, x):
4251 global called
4252
4253 #
4254 # test that access to the XPath evaluation contexts
4255 #
4256 pctxt = libxml2.xpathParserContext(_obj=ctx)
4257 ctxt = pctxt.context()
4258 called = ctxt.function()
4259 return x + 1</pre>
4260
Daniel Veillardf781dba2006-06-09 13:34:49 +00004261<p>All the interfaces around the XPath parser(or rather evaluation) context
4262are not finalized, but it should be sufficient to do contextual work at the
4263evaluation point.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004264
4265<h3>Memory debugging:</h3>
4266
4267<p>last but not least, all tests starts with the following prologue:</p>
4268<pre>#memory debug specific
Daniel Veillardaf43f632002-03-08 15:05:20 +00004269libxml2.debugMemory(1)</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +00004270
4271<p>and ends with the following epilogue:</p>
4272<pre>#memory debug specific
4273libxml2.cleanupParser()
4274if libxml2.debugMemory(1) == 0:
4275 print "OK"
4276else:
4277 print "Memory leak %d bytes" % (libxml2.debugMemory(1))
4278 libxml2.dumpMemory()</pre>
4279
Daniel Veillardf781dba2006-06-09 13:34:49 +00004280<p>Those activate the memory debugging interface of libxml2 where all
4281allocated block in the library are tracked. The prologue then cleans up the
4282library state and checks that all allocated memory has been freed. If not it
4283calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
Daniel Veillard82687162001-01-22 15:32:01 +00004284
Daniel Veillard8a469172003-06-12 16:05:07 +00004285<h2><a name="architecture">libxml2 architecture</a></h2>
Daniel Veillard4540be42000-08-19 16:40:28 +00004286
Daniel Veillardf781dba2006-06-09 13:34:49 +00004287<p>Libxml2 is made of multiple components; some of them are optional, and
4288most of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +00004289<ul>
4290 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00004291 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00004292 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00004293 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00004294 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00004295 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00004296 <li>a SAX tree module to build an in-memory DOM representation</li>
4297 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00004298 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004299 <li>an XPath module for global lookup in a DOM representation
4300 (optional)</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +00004301 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +00004302</ul>
4303
4304<p>Graphically this gives the following:</p>
4305
4306<p><img src="libxml.gif" alt="a graphical view of the various"></p>
4307
4308<p></p>
4309
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00004310<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004311
Daniel Veillardf781dba2006-06-09 13:34:49 +00004312<p>The parser returns a tree built during the document analysis. The value
4313returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
4314<strong>xmlDoc</strong> structure). This structure contains information such
4315as the file name, the document type, and a <strong>children</strong> pointer
4316which is the root of the document (or more exactly the first child under the
4317root which is the document). The tree is made of <strong>xmlNode</strong>s,
4318chained in double-linked lists of siblings and with a children&lt;-&gt;parent
4319relationship. An xmlNode can also carry properties (a chain of xmlAttr
4320structures). An attribute may have a value which is a list of TEXT or
4321ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004322
Daniel Veillardf781dba2006-06-09 13:34:49 +00004323<p>Here is an example (erroneous with respect to the XML spec since there
4324should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004325
4326<p><img src="structure.gif" alt=" structure.gif "></p>
4327
Daniel Veillardf781dba2006-06-09 13:34:49 +00004328<p>In the source package there is a small program (not installed by default)
4329called <strong>xmllint</strong> which parses XML files given as argument and
4330prints them back as parsed. This is useful for detecting errors both in XML
4331code and in the XML parser itself. It has an option <strong>--debug</strong>
4332which prints the actual in-memory structure of the document; here is the
4333result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004334<pre>DOCUMENT
4335version=1.0
4336standalone=true
4337 ELEMENT EXAMPLE
4338 ATTRIBUTE prop1
4339 TEXT
4340 content=gnome is great
4341 ATTRIBUTE prop2
4342 ENTITY_REF
4343 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +00004344 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +00004345 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004346 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +00004347 TEXT
4348 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004349 ELEMENT chapter
4350 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +00004351 TEXT
4352 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004353 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +00004354 TEXT
4355 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00004356 ELEMENT image
4357 ATTRIBUTE href
4358 TEXT
4359 content=linus.gif
4360 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +00004361 TEXT
4362 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00004363
Daniel Veillard88f00ae2000-03-02 00:15:55 +00004364<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00004365
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00004366<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00004367
Daniel Veillardf781dba2006-06-09 13:34:49 +00004368<p>Sometimes the DOM tree output is just too large to fit reasonably into
4369memory. In that case (and if you don't expect to save back the XML document
4370loaded using libxml), it's better to use the SAX interface of libxml. SAX is
4371a <strong>callback-based interface</strong> to the parser. Before parsing,
4372the application layer registers a customized set of callbacks which are
4373called by the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00004374
Daniel Veillardf781dba2006-06-09 13:34:49 +00004375<p>To get more detailed step-by-step guidance on using the SAX interface of
4376libxml, see the <a
Daniel Veillard4e73bfa2014-07-12 17:46:46 +08004377href="http://www.jamesh.id.au/articles/libxml-sax/libxml-sax.html">nice
Daniel Veillardf781dba2006-06-09 13:34:49 +00004378documentation</a>.written by <a href="mailto:james@daa.com.au">James
4379Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00004380
Daniel Veillardf781dba2006-06-09 13:34:49 +00004381<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
4382program located in the gnome-xml module (it's usually not shipped in the
4383binary packages of libxml, but you can find it in the tar source
4384distribution). Here is the sequence of callbacks that would be reported by
4385testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00004386<pre>SAX.setDocumentLocator()
4387SAX.startDocument()
4388SAX.getEntity(amp)
4389SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
4390SAX.characters( , 3)
4391SAX.startElement(head)
4392SAX.characters( , 4)
4393SAX.startElement(title)
4394SAX.characters(Welcome to Gnome, 16)
4395SAX.endElement(title)
4396SAX.characters( , 3)
4397SAX.endElement(head)
4398SAX.characters( , 3)
4399SAX.startElement(chapter)
4400SAX.characters( , 4)
4401SAX.startElement(title)
4402SAX.characters(The Linux adventure, 19)
4403SAX.endElement(title)
4404SAX.characters( , 4)
4405SAX.startElement(p)
4406SAX.characters(bla bla bla ..., 15)
4407SAX.endElement(p)
4408SAX.characters( , 4)
4409SAX.startElement(image, href='linus.gif')
4410SAX.endElement(image)
4411SAX.characters( , 4)
4412SAX.startElement(p)
4413SAX.characters(..., 3)
4414SAX.endElement(p)
4415SAX.characters( , 3)
4416SAX.endElement(chapter)
4417SAX.characters( , 1)
4418SAX.endElement(EXAMPLE)
4419SAX.endDocument()</pre>
4420
Daniel Veillardf781dba2006-06-09 13:34:49 +00004421<p>Most of the other interfaces of libxml2 are based on the DOM tree-building
4422facility, so nearly everything up to the end of this document presupposes the
4423use of the standard DOM tree build. Note that the DOM tree itself is built by
4424a set of registered default callbacks, without internal specific
4425interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00004426
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004427<h2><a name="Validation">Validation &amp; DTDs</a></h2>
4428
4429<p>Table of Content:</p>
4430<ol>
4431 <li><a href="#General5">General overview</a></li>
4432 <li><a href="#definition">The definition</a></li>
4433 <li><a href="#Simple">Simple rules</a>
4434 <ol>
Daniel Veillard9c466822001-10-25 12:03:39 +00004435 <li><a href="#reference">How to reference a DTD from a document</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004436 <li><a href="#Declaring">Declaring elements</a></li>
4437 <li><a href="#Declaring1">Declaring attributes</a></li>
4438 </ol>
4439 </li>
4440 <li><a href="#Some">Some examples</a></li>
4441 <li><a href="#validate">How to validate</a></li>
4442 <li><a href="#Other">Other resources</a></li>
4443</ol>
4444
4445<h3><a name="General5">General overview</a></h3>
4446
4447<p>Well what is validation and what is a DTD ?</p>
4448
Daniel Veillardf781dba2006-06-09 13:34:49 +00004449<p>DTD is the acronym for Document Type Definition. This is a description of
4450the content for a family of XML files. This is part of the XML 1.0
4451specification, and allows one to describe and verify that a given document
4452instance conforms to the set of rules detailing its structure and content.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004453
Daniel Veillardf781dba2006-06-09 13:34:49 +00004454<p>Validation is the process of checking a document against a DTD (more
4455generally against a set of construction rules).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004456
Daniel Veillardf781dba2006-06-09 13:34:49 +00004457<p>The validation process and building DTDs are the two most difficult parts
4458of the XML life cycle. Briefly a DTD defines all the possible elements to be
4459found within your document, what is the formal shape of your document tree
4460(by defining the allowed content of an element; either text, a regular
4461expression for the allowed list of children, or mixed content i.e. both text
4462and children). The DTD also defines the valid attributes for all elements and
4463the types of those attributes.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004464
4465<h3><a name="definition1">The definition</a></h3>
4466
Daniel Veillardf781dba2006-06-09 13:34:49 +00004467<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a
4468href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
4469Rev1</a>):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004470<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004471 <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
4472 elements</a></li>
4473 <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
4474 attributes</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004475</ul>
4476
Daniel Veillardf781dba2006-06-09 13:34:49 +00004477<p>(unfortunately) all this is inherited from the SGML world, the syntax is
4478ancient...</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004479
4480<h3><a name="Simple1">Simple rules</a></h3>
4481
Daniel Veillardf781dba2006-06-09 13:34:49 +00004482<p>Writing DTDs can be done in many ways. The rules to build them if you need
4483something permanent or something which can evolve over time can be radically
4484different. Really complex DTDs like DocBook ones are flexible but quite
4485harder to design. I will just focus on DTDs for a formats with a fixed simple
4486structure. It is just a set of basic rules, and definitely not exhaustive nor
4487usable for complex DTD design.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004488
4489<h4><a name="reference1">How to reference a DTD from a document</a>:</h4>
4490
Daniel Veillardf781dba2006-06-09 13:34:49 +00004491<p>Assuming the top element of the document is <code>spec</code> and the dtd
4492is placed in the file <code>mydtd</code> in the subdirectory
4493<code>dtds</code> of the directory from where the document were loaded:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004494
4495<p><code>&lt;!DOCTYPE spec SYSTEM "dtds/mydtd"&gt;</code></p>
4496
4497<p>Notes:</p>
4498<ul>
Daniel Veillard0b28e882002-07-24 23:47:05 +00004499 <li>The system string is actually an URI-Reference (as defined in <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004500 href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
4501 full URL string indicating the location of your DTD on the Web. This is a
4502 really good thing to do if you want others to validate your document.</li>
4503 <li>It is also possible to associate a <code>PUBLIC</code> identifier (a
4504 magic string) so that the DTD is looked up in catalogs on the client side
4505 without having to locate it on the web.</li>
4506 <li>A DTD contains a set of element and attribute declarations, but they
4507 don't define what the root of the document should be. This is explicitly
4508 told to the parser/validator as the first element of the
4509 <code>DOCTYPE</code> declaration.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004510</ul>
4511
4512<h4><a name="Declaring2">Declaring elements</a>:</h4>
4513
4514<p>The following declares an element <code>spec</code>:</p>
4515
4516<p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
4517
Daniel Veillardf781dba2006-06-09 13:34:49 +00004518<p>It also expresses that the spec element contains one <code>front</code>,
4519one <code>body</code> and one optional <code>back</code> children elements in
4520this order. The declaration of one element of the structure and its content
4521are done in a single declaration. Similarly the following declares
4522<code>div1</code> elements:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004523
Daniel Veillard51737272002-01-23 23:10:38 +00004524<p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004525
Daniel Veillardf781dba2006-06-09 13:34:49 +00004526<p>which means div1 contains one <code>head</code> then a series of optional
4527<code>p</code>, <code>list</code>s and <code>note</code>s and then an
4528optional <code>div2</code>. And last but not least an element can contain
4529text:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004530
4531<p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
4532
Daniel Veillardf781dba2006-06-09 13:34:49 +00004533<p><code>b</code> contains text or being of mixed content (text and elements
4534in no particular order):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004535
4536<p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
4537
Daniel Veillardf781dba2006-06-09 13:34:49 +00004538<p><code>p </code>can contain text or <code>a</code>, <code>ul</code>,
4539<code>b</code>, <code>i </code>or <code>em</code> elements in no particular
4540order.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004541
4542<h4><a name="Declaring1">Declaring attributes</a>:</h4>
4543
Daniel Veillard0b28e882002-07-24 23:47:05 +00004544<p>Again the attributes declaration includes their content definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004545
4546<p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
4547
Daniel Veillardf781dba2006-06-09 13:34:49 +00004548<p>means that the element <code>termdef</code> can have a <code>name</code>
4549attribute containing text (<code>CDATA</code>) and which is optional
4550(<code>#IMPLIED</code>). The attribute value can also be defined within a
4551set:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004552
Daniel Veillardf781dba2006-06-09 13:34:49 +00004553<p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
4554"ordered"&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004555
Daniel Veillardf781dba2006-06-09 13:34:49 +00004556<p>means <code>list</code> element have a <code>type</code> attribute with 3
4557allowed values "bullets", "ordered" or "glossary" and which default to
4558"ordered" if the attribute is not explicitly specified.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004559
Daniel Veillardf781dba2006-06-09 13:34:49 +00004560<p>The content type of an attribute can be text (<code>CDATA</code>),
4561anchor/reference/references
4562(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
4563(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
4564(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
4565<code>chapter</code> element can have an optional <code>id</code> attribute
4566of type <code>ID</code>, usable for reference from attribute of type
4567IDREF:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004568
4569<p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
4570
Daniel Veillardf781dba2006-06-09 13:34:49 +00004571<p>The last value of an attribute definition can be <code>#REQUIRED
4572</code>meaning that the attribute has to be given, <code>#IMPLIED</code>
4573meaning that it is optional, or the default value (possibly prefixed by
4574<code>#FIXED</code> if it is the only allowed).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004575
4576<p>Notes:</p>
4577<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004578 <li>Usually the attributes pertaining to a given element are declared in a
4579 single expression, but it is just a convention adopted by a lot of DTD
4580 writers:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004581 <pre>&lt;!ATTLIST termdef
4582 id ID #REQUIRED
4583 name CDATA #IMPLIED&gt;</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004584 <p>The previous construct defines both <code>id</code> and
4585 <code>name</code> attributes for the element <code>termdef</code>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004586 </li>
4587</ul>
4588
4589<h3><a name="Some1">Some examples</a></h3>
4590
Daniel Veillardf781dba2006-06-09 13:34:49 +00004591<p>The directory <code>test/valid/dtds/</code> in the libxml2 distribution
4592contains some complex DTD examples. The example in the file
4593<code>test/valid/dia.xml</code> shows an XML file where the simple DTD is
4594directly included within the document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004595
4596<h3><a name="validate1">How to validate</a></h3>
4597
Daniel Veillardf781dba2006-06-09 13:34:49 +00004598<p>The simplest way is to use the xmllint program included with libxml. The
4599<code>--valid</code> option turns-on validation of the files given as input.
4600For example the following validates a copy of the first revision of the XML
46011.0 specification:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004602
4603<p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
4604
Daniel Veillard0b28e882002-07-24 23:47:05 +00004605<p>the -- noout is used to disable output of the resulting tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004606
Daniel Veillardf781dba2006-06-09 13:34:49 +00004607<p>The <code>--dtdvalid dtd</code> allows validation of the document(s)
4608against a given DTD.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004609
Daniel Veillard8a469172003-06-12 16:05:07 +00004610<p>Libxml2 exports an API to handle DTDs and validation, check the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004611href="http://xmlsoft.org/html/libxml-valid.html">associated
4612description</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004613
4614<h3><a name="Other1">Other resources</a></h3>
4615
Daniel Veillardf781dba2006-06-09 13:34:49 +00004616<p>DTDs are as old as SGML. So there may be a number of examples on-line, I
4617will just list one for now, others pointers welcome:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004618<ul>
4619 <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li>
4620</ul>
4621
Daniel Veillardf781dba2006-06-09 13:34:49 +00004622<p>I suggest looking at the examples found under test/valid/dtd and any of
4623the large number of books available on XML. The dia example in test/valid
4624should be both simple and complete enough to allow you to build your own.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004625
4626<p></p>
4627
4628<h2><a name="Memory">Memory Management</a></h2>
4629
4630<p>Table of Content:</p>
4631<ol>
4632 <li><a href="#General3">General overview</a></li>
Daniel Veillard8a469172003-06-12 16:05:07 +00004633 <li><a href="#setting">Setting libxml2 set of memory routines</a></li>
Daniel Veillard05b37c62008-03-31 08:27:07 +00004634 <li><a href="#cleanup">Cleaning up after using the library</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004635 <li><a href="#Debugging">Debugging routines</a></li>
4636 <li><a href="#General4">General memory requirements</a></li>
Daniel Veillardad87d5e2008-02-04 16:50:03 +00004637 <li><a href="#Compacting">Returning memory to the kernel</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004638</ol>
4639
4640<h3><a name="General3">General overview</a></h3>
4641
4642<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004643href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
4644provides the interfaces to the libxml2 memory system:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004645<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004646 <li>libxml2 does not use the libc memory allocator directly but xmlFree(),
4647 xmlMalloc() and xmlRealloc()</li>
4648 <li>those routines can be reallocated to a specific set of routine, by
4649 default the libc ones i.e. free(), malloc() and realloc()</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004650 <li>the xmlmemory.c module includes a set of debugging routine</li>
4651</ul>
4652
Daniel Veillard8a469172003-06-12 16:05:07 +00004653<h3><a name="setting">Setting libxml2 set of memory routines</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004654
Daniel Veillardf781dba2006-06-09 13:34:49 +00004655<p>It is sometimes useful to not use the default memory allocator, either for
4656debugging, analysis or to implement a specific behaviour on memory management
4657(like on embedded systems). Two function calls are available to do so:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004658<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004659 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet
4660 ()</a> which return the current set of functions in use by the parser</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004661 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004662 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
4663 which allow to set up a new set of memory allocation functions</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004664</ul>
4665
Daniel Veillardf781dba2006-06-09 13:34:49 +00004666<p>Of course a call to xmlMemSetup() should probably be done before calling
4667any other libxml2 routines (unless you are sure your allocations routines are
4668compatibles).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004669
Daniel Veillard05b37c62008-03-31 08:27:07 +00004670<h3><a name="cleanup">Cleaning up after using the library</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004671
Daniel Veillardf781dba2006-06-09 13:34:49 +00004672<p>Libxml2 is not stateless, there is a few set of memory structures needing
4673allocation before the parser is fully functional (some encoding structures
4674for example). This also mean that once parsing is finished there is a tiny
4675amount of memory (a few hundred bytes) which can be recollected if you don't
Daniel Veillard05b37c62008-03-31 08:27:07 +00004676reuse the library or any document built with it:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004677<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004678 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
Daniel Veillard05b37c62008-03-31 08:27:07 +00004679 ()</a> is a centralized routine to free the library state and data. Note
4680 that it won't deallocate any produced tree if any (use the xmlFreeDoc()
4681 and related routines for this). This should be called only when the library
4682 is not used anymore.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004683 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
4684 ()</a> is the dual routine allowing to preallocate the parsing state
4685 which can be useful for example to avoid initialization reentrancy
4686 problems when using libxml2 in multithreaded applications</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004687</ul>
4688
Daniel Veillard05b37c62008-03-31 08:27:07 +00004689<p>Generally xmlCleanupParser() is safe assuming no parsing is ongoing and
4690no document is still being used, if needed the state will be rebuild at the
4691next invocation of parser routines (or by xmlInitParser()), but be careful
4692of the consequences in multithreaded applications.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004693
4694<h3><a name="Debugging">Debugging routines</a></h3>
4695
Daniel Veillardf781dba2006-06-09 13:34:49 +00004696<p>When configured using --with-mem-debug flag (off by default), libxml2 uses
4697a set of memory allocation debugging routines keeping track of all allocated
4698blocks and the location in the code where the routine was called. A couple of
4699other debugging routines allow to dump the memory allocated infos to a file
4700or call a specific routine when a given block number is allocated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004701<ul>
4702 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00004703 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a>
4704 <a
4705 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
4706 and <a
4707 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
4708 are the memory debugging replacement allocation routines</li>
4709 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
William M. Brack43a87292007-02-15 20:41:02 +00004710 ()</a> dumps all the information about the allocated memory block lefts
Daniel Veillardf781dba2006-06-09 13:34:49 +00004711 in the <code>.memdump</code> file</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004712</ul>
4713
Daniel Veillardf781dba2006-06-09 13:34:49 +00004714<p>When developing libxml2 memory debug is enabled, the tests programs call
4715xmlMemoryDump () and the "make test" regression tests will check for any
4716memory leak during the full regression test sequence, this helps a lot
4717ensuring that libxml2 does not leak memory and bullet proof memory
4718allocations use (some libc implementations are known to be far too permissive
4719resulting in major portability problems!).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004720
Daniel Veillardf781dba2006-06-09 13:34:49 +00004721<p>If the .memdump reports a leak, it displays the allocation function and
William M. Brack43a87292007-02-15 20:41:02 +00004722also tries to give some information about the content and structure of the
Daniel Veillardf781dba2006-06-09 13:34:49 +00004723allocated blocks left. This is sufficient in most cases to find the culprit,
4724but not always. Assuming the allocation problem is reproducible, it is
4725possible to find more easily:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004726<ol>
4727 <li>write down the block number xxxx not allocated</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004728 <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , the easiest
4729 when using GDB is to simply give the command
Daniel Veillard75794822002-04-11 16:24:32 +00004730 <p><code>set environment XML_MEM_BREAKPOINT xxxx</code></p>
4731 <p>before running the program.</p>
4732 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004733 <li>run the program under a debugger and set a breakpoint on
4734 xmlMallocBreakpoint() a specific function called when this precise block
4735 is allocated</li>
4736 <li>when the breakpoint is reached you can then do a fine analysis of the
4737 allocation an step to see the condition resulting in the missing
4738 deallocation.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004739</ol>
4740
Daniel Veillardf781dba2006-06-09 13:34:49 +00004741<p>I used to use a commercial tool to debug libxml2 memory problems but after
4742noticing that it was not detecting memory leaks that simple mechanism was
4743used and proved extremely efficient until now. Lately I have also used <a
4744href="http://developer.kde.org/~sewardj/">valgrind</a> with quite some
4745success, it is tied to the i386 architecture since it works by emulating the
4746processor and instruction set, it is slow but extremely efficient, i.e. it
4747spot memory usage errors in a very precise way.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004748
4749<h3><a name="General4">General memory requirements</a></h3>
4750
Daniel Veillardf781dba2006-06-09 13:34:49 +00004751<p>How much libxml2 memory require ? It's hard to tell in average it depends
4752of a number of things:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004753<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004754 <li>the parser itself should work in a fixed amount of memory, except for
4755 information maintained about the stacks of names and entities locations.
4756 The I/O and encoding handlers will probably account for a few KBytes.
4757 This is true for both the XML and HTML parser (though the HTML parser
4758 need more state).</li>
4759 <li>If you are generating the DOM tree then memory requirements will grow
4760 nearly linear with the size of the data. In general for a balanced
4761 textual document the internal memory requirement is about 4 times the
4762 size of the UTF8 serialization of this document (example the XML-1.0
4763 recommendation is a bit more of 150KBytes and takes 650KBytes of main
4764 memory when parsed). Validation will add a amount of memory required for
4765 maintaining the external Dtd state which should be linear with the
4766 complexity of the content model defined by the Dtd</li>
4767 <li>If you need to work with fixed memory requirements or don't need the
4768 full DOM tree then using the <a href="xmlreader.html">xmlReader
4769 interface</a> is probably the best way to proceed, it still allows to
4770 validate or operate on subset of the tree if needed.</li>
4771 <li>If you don't care about the advanced features of libxml2 like
4772 validation, DOM, XPath or XPointer, don't use entities, need to work with
4773 fixed memory requirements, and try to get the fastest parsing possible
4774 then the SAX interface should be used, but it has known restrictions.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004775</ul>
4776
4777<p></p>
Daniel Veillardad87d5e2008-02-04 16:50:03 +00004778<h3><a name="Compacting">Returning memory to the kernel</a></h3>
4779
4780<p>You may encounter that your process using libxml2 does not have a
4781reduced memory usage although you freed the trees. This is because
4782libxml2 allocates memory in a number of small chunks. When freeing one
4783of those chunks, the OS may decide that giving this little memory back
4784to the kernel will cause too much overhead and delay the operation. As
4785all chunks are this small, they get actually freed but not returned to
4786the kernel. On systems using glibc, there is a function call
4787"malloc_trim" from malloc.h which does this missing operation (note that
4788it is allowed to fail). Thus, after freeing your tree you may simply try
4789"malloc_trim(0);" to really get the memory back. If your OS does not
4790provide malloc_trim, try searching for a similar function.</p>
4791<p></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004792
4793<h2><a name="Encodings">Encodings support</a></h2>
4794
Daniel Veillardf781dba2006-06-09 13:34:49 +00004795<p>If you are not really familiar with Internationalization (usual shortcut
4796is I18N) , Unicode, characters and glyphs, I suggest you read a <a
4797href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a>
4798by Tim Bray on Unicode and why you should care about it.</p>
Daniel Veillard67952602006-01-05 15:29:44 +00004799
Daniel Veillardf781dba2006-06-09 13:34:49 +00004800<p>If you don't understand why <b>it does not make sense to have a string
4801without knowing what encoding it uses</b>, then as Joel Spolsky said <a
4802href="http://www.joelonsoftware.com/articles/Unicode.html">please do not
4803write another line of code until you finish reading that article.</a>. It is
4804a prerequisite to understand this page, and avoid a lot of problems with
4805libxml2, XML or text processing in general.</p>
Daniel Veillarde5d68de2005-03-10 15:03:40 +00004806
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004807<p>Table of Content:</p>
4808<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004809 <li><a href="encoding.html#What">What does internationalization support
4810 mean ?</a></li>
4811 <li><a href="encoding.html#internal">The internal encoding, how and
4812 why</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004813 <li><a href="encoding.html#implemente">How is it implemented ?</a></li>
4814 <li><a href="encoding.html#Default">Default supported encodings</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004815 <li><a href="encoding.html#extend">How to extend the existing
4816 support</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004817</ol>
4818
4819<h3><a name="What">What does internationalization support mean ?</a></h3>
4820
Daniel Veillardf781dba2006-06-09 13:34:49 +00004821<p>XML was designed from the start to allow the support of any character set
4822by using Unicode. Any conformant XML parser has to support the UTF-8 and
4823UTF-16 default encodings which can both express the full unicode ranges. UTF8
4824is a variable length encoding whose greatest points are to reuse the same
4825encoding for ASCII and to save space for Western encodings, but it is a bit
4826more complex to handle in practice. UTF-16 use 2 bytes per character (and
4827sometimes combines two pairs), it makes implementation easier, but looks a
4828bit overkill for Western languages encoding. Moreover the XML specification
4829allows the document to be encoded in other encodings at the condition that
4830they are clearly labeled as such. For example the following is a wellformed
4831XML document encoded in ISO-8859-1 and using accentuated letters that we
4832French like for both markup and content:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004833<pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004834&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;</pre>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004835
Daniel Veillard8a469172003-06-12 16:05:07 +00004836<p>Having internationalization support in libxml2 means the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004837<ul>
4838 <li>the document is properly parsed</li>
William M. Brack43a87292007-02-15 20:41:02 +00004839 <li>information about it's encoding is saved</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004840 <li>it can be modified</li>
4841 <li>it can be saved in its original encoding</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004842 <li>it can also be saved in another encoding supported by libxml2 (for
4843 example straight UTF8 or even an ASCII form)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004844</ul>
4845
Daniel Veillardf781dba2006-06-09 13:34:49 +00004846<p>Another very important point is that the whole libxml2 API, with the
4847exception of a few routines to read with a specific encoding or save to a
4848specific encoding, is completely agnostic about the original encoding of the
4849document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004850
Daniel Veillardf781dba2006-06-09 13:34:49 +00004851<p>It should be noted too that the HTML parser embedded in libxml2 now obey
4852the same rules too, the following document will be (as of 2.2.2) handled in
4853an internationalized fashion by libxml2 too:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004854<pre>&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
4855 "http://www.w3.org/TR/REC-html40/loose.dtd"&gt;
4856&lt;html lang="fr"&gt;
4857&lt;head&gt;
4858 &lt;META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"&gt;
4859&lt;/head&gt;
4860&lt;body&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004861&lt;p&gt;W3C cr&eacute;e des standards pour le Web.&lt;/body&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004862&lt;/html&gt;</pre>
4863
4864<h3><a name="internal">The internal encoding, how and why</a></h3>
4865
Daniel Veillardf781dba2006-06-09 13:34:49 +00004866<p>One of the core decisions was to force all documents to be converted to a
4867default internal encoding, and that encoding to be UTF-8, here are the
4868rationales for those choices:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004869<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004870 <li>keeping the native encoding in the internal form would force the libxml
4871 users (or the code associated) to be fully aware of the encoding of the
4872 original document, for examples when adding a text node to a document,
4873 the content would have to be provided in the document encoding, i.e. the
4874 client code would have to check it before hand, make sure it's conformant
4875 to the encoding, etc ... Very hard in practice, though in some specific
4876 cases this may make sense.</li>
4877 <li>the second decision was which encoding. From the XML spec only UTF8 and
4878 UTF16 really makes sense as being the two only encodings for which there
4879 is mandatory support. UCS-4 (32 bits fixed size encoding) could be
4880 considered an intelligent choice too since it's a direct Unicode mapping
4881 support. I selected UTF-8 on the basis of efficiency and compatibility
4882 with surrounding software:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004883 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004884 <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
4885 more costly to import and export CPU wise) is also far more compact
4886 than UTF-16 (and UCS-4) for a majority of the documents I see it used
4887 for right now (RPM RDF catalogs, advogato data, various configuration
4888 file formats, etc.) and the key point for today's computer
4889 architecture is efficient uses of caches. If one nearly double the
4890 memory requirement to store the same amount of data, this will trash
4891 caches (main memory/external caches/internal caches) and my take is
4892 that this harms the system far more than the CPU requirements needed
4893 for the conversion to UTF-8</li>
4894 <li>Most of libxml2 version 1 users were using it with straight ASCII
4895 most of the time, doing the conversion with an internal encoding
4896 requiring all their code to be rewritten was a serious show-stopper
4897 for using UTF-16 or UCS-4.</li>
4898 <li>UTF-8 is being used as the de-facto internal encoding standard for
4899 related code like the <a href="http://www.pango.org/">pango</a>
4900 upcoming Gnome text widget, and a lot of Unix code (yet another place
4901 where Unix programmer base takes a different approach from Microsoft
4902 - they are using UTF-16)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004903 </ul>
4904 </li>
4905</ul>
4906
Daniel Veillard8a469172003-06-12 16:05:07 +00004907<p>What does this mean in practice for the libxml2 user:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004908<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004909 <li>xmlChar, the libxml2 data type is a byte, those bytes must be assembled
4910 as UTF-8 valid strings. The proper way to terminate an xmlChar * string
4911 is simply to append 0 byte, as usual.</li>
4912 <li>One just need to make sure that when using chars outside the ASCII set,
4913 the values has been properly converted to UTF-8</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004914</ul>
4915
4916<h3><a name="implemente">How is it implemented ?</a></h3>
4917
Daniel Veillardf781dba2006-06-09 13:34:49 +00004918<p>Let's describe how all this works within libxml, basically the I18N
4919(internationalization) support get triggered only during I/O operation, i.e.
4920when reading a document or saving one. Let's look first at the reading
4921sequence:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004922<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004923 <li>when a document is processed, we usually don't know the encoding, a
4924 simple heuristic allows to detect UTF-16 and UCS-4 from encodings where
4925 the ASCII range (0-0x7F) maps with ASCII</li>
4926 <li>the xml declaration if available is parsed, including the encoding
4927 declaration. At that point, if the autodetected encoding is different
4928 from the one declared a call to xmlSwitchEncoding() is issued.</li>
4929 <li>If there is no encoding declaration, then the input has to be in either
4930 UTF-8 or UTF-16, if it is not then at some point when processing the
4931 input, the converter/checker of UTF-8 form will raise an encoding error.
4932 You may end-up with a garbled document, or no document at all ! Example:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004933 <pre>~/XML -&gt; ./xmllint err.xml
4934err.xml:1: error: Input is not proper UTF-8, indicate encoding !
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004935&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004936 ^
4937err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004938&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004939 ^</pre>
4940 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004941 <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize it, and
4942 then search the default registered encoding converters for that encoding.
4943 If it's not within the default set and iconv() support has been compiled
4944 it, it will ask iconv for such an encoder. If this fails then the parser
4945 will report an error and stops processing:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004946 <pre>~/XML -&gt; ./xmllint err2.xml
4947err2.xml:1: error: Unsupported encoding UnsupportedEnc
4948&lt;?xml version="1.0" encoding="UnsupportedEnc"?&gt;
4949 ^</pre>
4950 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004951 <li>From that point the encoder processes progressively the input (it is
4952 plugged as a front-end to the I/O module) for that entity. It captures
4953 and converts on-the-fly the document to be parsed to UTF-8. The parser
4954 itself just does UTF-8 checking of this input and process it
4955 transparently. The only difference is that the encoding information has
4956 been added to the parsing context (more precisely to the input
4957 corresponding to this entity).</li>
4958 <li>The result (when using DOM) is an internal form completely in UTF-8
4959 with just an encoding information on the document node.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004960</ol>
4961
Daniel Veillardf781dba2006-06-09 13:34:49 +00004962<p>Ok then what happens when saving the document (assuming you
4963collected/built an xmlDoc DOM like structure) ? It depends on the function
4964called, xmlSaveFile() will just try to save in the original encoding, while
4965xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
4966encoding:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004967<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004968 <li>if no encoding is given, libxml2 will look for an encoding value
4969 associated to the document and if it exists will try to save to that
4970 encoding,
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004971 <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
4972 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00004973 <li>so if an encoding was specified, either at the API level or on the
4974 document, libxml2 will again canonicalize the encoding name, lookup for a
4975 converter in the registered set or through iconv. If not found the
4976 function will return an error code</li>
4977 <li>the converter is placed before the I/O buffer layer, as another kind of
4978 buffer, then libxml2 will simply push the UTF-8 serialization to through
4979 that buffer, which will then progressively be converted and pushed onto
4980 the I/O layer.</li>
4981 <li>It is possible that the converter code fails on some input, for example
4982 trying to push an UTF-8 encoded Chinese character through the UTF-8 to
4983 ISO-8859-1 converter won't work. Since the encoders are progressive they
4984 will just report the error and the number of bytes converted, at that
4985 point libxml2 will decode the offending character, remove it from the
4986 buffer and replace it with the associated charRef encoding &amp;#123; and
4987 resume the conversion. This guarantees that any document will be saved
4988 without losses (except for markup names where this is not legal, this is
4989 a problem in the current version, in practice avoid using non-ascii
4990 characters for tag or attribute names). A special "ascii" encoding name
4991 is used to save documents to a pure ascii form can be used when
4992 portability is really crucial</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004993</ol>
4994
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004995<p>Here are a few examples based on the same test document and assumin a
4996terminal using ISO-8859-1 as the text encoding:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00004997<pre>~/XML -&gt; ./xmllint isolat1
4998&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +02004999&lt;tr&egrave;s&gt;là&lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005000~/XML -&gt; ./xmllint --encode UTF-8 isolat1
5001&lt;?xml version="1.0" encoding="UTF-8"?&gt;
Daniel Veillard29341682009-09-10 18:23:39 +02005002&lt;très&gt;là &nbsp;&lt;/très&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005003~/XML -&gt; </pre>
5004
Daniel Veillardf781dba2006-06-09 13:34:49 +00005005<p>The same processing is applied (and reuse most of the code) for HTML I18N
5006processing. Looking up and modifying the content encoding is a bit more
5007difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
5008so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
5009been provided. The parser also attempts to switch encoding on the fly when
5010detecting such a tag on input. Except for that the processing is the same
5011(and again reuses the same code).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005012
5013<h3><a name="Default">Default supported encodings</a></h3>
5014
Daniel Veillardf781dba2006-06-09 13:34:49 +00005015<p>libxml2 has a set of default converters for the following encodings
5016(located in encoding.c):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005017<ol>
5018 <li>UTF-8 is supported by default (null handlers)</li>
5019 <li>UTF-16, both little and big endian</li>
5020 <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
5021 <li>ASCII, useful mostly for saving</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005022 <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
5023 predefined entities like &amp;copy; for the Copyright sign.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005024</ol>
5025
Daniel Veillardf781dba2006-06-09 13:34:49 +00005026<p>More over when compiled on an Unix platform with iconv support the full
5027set of encodings supported by iconv can be instantly be used by libxml. On a
5028linux machine with glibc-2.1 the list of supported encodings and aliases fill
50293 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
5030various Japanese ones.</p>
Daniel Veillard67952602006-01-05 15:29:44 +00005031
Daniel Veillardf781dba2006-06-09 13:34:49 +00005032<p>To convert from the UTF-8 values returned from the API to another encoding
5033then it is possible to use the function provided from <a
5034href="html/libxml-encoding.html">the encoding module</a> like <a
5035href="html/libxml-encoding.html#UTF8Toisolat1">UTF8Toisolat1</a>, or use the
5036POSIX <a
5037href="http://www.opengroup.org/onlinepubs/009695399/functions/iconv.html">iconv()</a>
5038API directly.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005039
5040<h4>Encoding aliases</h4>
5041
Daniel Veillardf781dba2006-06-09 13:34:49 +00005042<p>From 2.2.3, libxml2 has support to register encoding names aliases. The
5043goal is to be able to parse document whose encoding is supported but where
5044the name differs (for example from the default set of names accepted by
5045iconv). The following functions allow to register and handle new aliases for
5046existing encodings. Once registered libxml2 will automatically lookup the
5047aliases when handling a document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005048<ul>
5049 <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
5050 <li>int xmlDelEncodingAlias(const char *alias);</li>
5051 <li>const char * xmlGetEncodingAlias(const char *alias);</li>
5052 <li>void xmlCleanupEncodingAliases(void);</li>
5053</ul>
5054
5055<h3><a name="extend">How to extend the existing support</a></h3>
5056
Daniel Veillardf781dba2006-06-09 13:34:49 +00005057<p>Well adding support for new encoding, or overriding one of the encoders
5058(assuming it is buggy) should not be hard, just write input and output
5059conversion routines to/from UTF-8, and register them using
5060xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be
5061called automatically if the parser(s) encounter such an encoding name
5062(register it uppercase, this will help). The description of the encoders,
5063their arguments and expected return values are described in the encoding.h
5064header.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005065
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005066<h2><a name="IO">I/O Interfaces</a></h2>
5067
5068<p>Table of Content:</p>
5069<ol>
5070 <li><a href="#General1">General overview</a></li>
5071 <li><a href="#basic">The basic buffer type</a></li>
5072 <li><a href="#Input">Input I/O handlers</a></li>
5073 <li><a href="#Output">Output I/O handlers</a></li>
5074 <li><a href="#entities">The entities loader</a></li>
5075 <li><a href="#Example2">Example of customized I/O</a></li>
5076</ol>
5077
5078<h3><a name="General1">General overview</a></h3>
5079
5080<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005081href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
5082the interfaces to the libxml2 I/O system. This consists of 4 main parts:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005083<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005084 <li>Entities loader, this is a routine which tries to fetch the entities
5085 (files) based on their PUBLIC and SYSTEM identifiers. The default loader
5086 don't look at the public identifier since libxml2 do not maintain a
5087 catalog. You can redefine you own entity loader by using
5088 <code>xmlGetExternalEntityLoader()</code> and
5089 <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
5090 example</a>.</li>
5091 <li>Input I/O buffers which are a commodity structure used by the parser(s)
William M. Brack43a87292007-02-15 20:41:02 +00005092 input layer to handle fetching the information to feed the parser. This
Daniel Veillardf781dba2006-06-09 13:34:49 +00005093 provides buffering and is also a placeholder where the encoding
5094 converters to UTF8 are piggy-backed.</li>
5095 <li>Output I/O buffers are similar to the Input ones and fulfill similar
5096 task but when generating a serialization from a tree.</li>
5097 <li>A mechanism to register sets of I/O callbacks and associate them with
5098 specific naming schemes like the protocol part of the URIs.
5099 <p>This affect the default I/O operations and allows to use specific I/O
5100 handlers for certain names.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005101 </li>
5102</ul>
5103
Daniel Veillardf781dba2006-06-09 13:34:49 +00005104<p>The general mechanism used when loading http://rpmfind.net/xml.html for
5105example in the HTML parser is the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005106<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005107 <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
5108 the parsing context and the URI string.</li>
5109 <li>the URI string is checked against the existing registered handlers
5110 using their match() callback function, if the HTTP module was compiled
5111 in, it is registered and its match() function will succeeds</li>
5112 <li>the open() function of the handler is called and if successful will
5113 return an I/O Input buffer</li>
5114 <li>the parser will the start reading from this buffer and progressively
5115 fetch information from the resource, calling the read() function of the
5116 handler until the resource is exhausted</li>
5117 <li>if an encoding change is detected it will be installed on the input
5118 buffer, providing buffering and efficient use of the conversion
5119 routines</li>
5120 <li>once the parser has finished, the close() function of the handler is
5121 called once and the Input buffer and associated resources are
5122 deallocated.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005123</ol>
5124
Daniel Veillardf781dba2006-06-09 13:34:49 +00005125<p>The user defined callbacks are checked first to allow overriding of the
5126default libxml2 I/O routines.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005127
5128<h3><a name="basic">The basic buffer type</a></h3>
5129
Daniel Veillardf781dba2006-06-09 13:34:49 +00005130<p>All the buffer manipulation handling is done using the
5131<code>xmlBuffer</code> type define in <code><a
5132href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a
5133resizable memory buffer. The buffer allocation strategy can be selected to be
5134either best-fit or use an exponential doubling one (CPU vs. memory use
5135trade-off). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
5136<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
5137system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
5138of functions allows to manipulate buffers with names starting with the
5139<code>xmlBuffer...</code> prefix.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005140
5141<h3><a name="Input">Input I/O handlers</a></h3>
5142
Daniel Veillardf781dba2006-06-09 13:34:49 +00005143<p>An Input I/O handler is a simple structure
5144<code>xmlParserInputBuffer</code> containing a context associated to the
5145resource (file descriptor, or pointer to a protocol handler), the read() and
5146close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
5147encoding handler are also present to support charset conversion when
5148needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005149
5150<h3><a name="Output">Output I/O handlers</a></h3>
5151
Daniel Veillardf781dba2006-06-09 13:34:49 +00005152<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
5153Input one except the callbacks are write() and close().</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005154
5155<h3><a name="entities">The entities loader</a></h3>
5156
Daniel Veillardf781dba2006-06-09 13:34:49 +00005157<p>The entity loader resolves requests for new entities and create inputs for
5158the parser. Creating an input from a filename or an URI string is done
5159through the xmlNewInputFromFile() routine. The default entity loader do not
5160handle the PUBLIC identifier associated with an entity (if any). So it just
5161calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
5162XML).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005163
Daniel Veillardf781dba2006-06-09 13:34:49 +00005164<p>If you want to hook up a catalog mechanism then you simply need to
5165override the default entity loader, here is an example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005166<pre>#include &lt;libxml/xmlIO.h&gt;
5167
5168xmlExternalEntityLoader defaultLoader = NULL;
5169
5170xmlParserInputPtr
5171xmlMyExternalEntityLoader(const char *URL, const char *ID,
5172 xmlParserCtxtPtr ctxt) {
5173 xmlParserInputPtr ret;
5174 const char *fileID = NULL;
5175 /* lookup for the fileID depending on ID */
5176
5177 ret = xmlNewInputFromFile(ctxt, fileID);
5178 if (ret != NULL)
5179 return(ret);
5180 if (defaultLoader != NULL)
5181 ret = defaultLoader(URL, ID, ctxt);
5182 return(ret);
5183}
5184
5185int main(..) {
5186 ...
5187
5188 /*
5189 * Install our own entity loader
5190 */
5191 defaultLoader = xmlGetExternalEntityLoader();
5192 xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);
5193
5194 ...
5195}</pre>
5196
5197<h3><a name="Example2">Example of customized I/O</a></h3>
5198
Daniel Veillardf781dba2006-06-09 13:34:49 +00005199<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
5200real use case</a>, xmlDocDump() closes the FILE * passed by the application
5201and this was a problem. The <a
5202href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
5203new output handler with the closing call deactivated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005204<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005205 <li>First define a new I/O output allocator where the output don't close
5206 the file:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005207 <pre>xmlOutputBufferPtr
5208xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
Daniel Veillardf781dba2006-06-09 13:34:49 +00005209&nbsp;&nbsp;&nbsp;&nbsp;xmlOutputBufferPtr ret;
5210&nbsp;&nbsp;&nbsp;&nbsp;
5211&nbsp;&nbsp;&nbsp;&nbsp;if (xmlOutputCallbackInitialized == 0)
5212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlRegisterDefaultOutputCallbacks();
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005213
Daniel Veillardf781dba2006-06-09 13:34:49 +00005214&nbsp;&nbsp;&nbsp;&nbsp;if (file == NULL) return(NULL);
5215&nbsp;&nbsp;&nbsp;&nbsp;ret = xmlAllocOutputBuffer(encoder);
5216&nbsp;&nbsp;&nbsp;&nbsp;if (ret != NULL) {
5217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;context = file;
5218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;writecallback = xmlFileWrite;
5219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;closecallback = NULL; /* No close callback */
5220&nbsp;&nbsp;&nbsp;&nbsp;}
5221&nbsp;&nbsp;&nbsp;&nbsp;return(ret);
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005222} </pre>
5223 </li>
5224 <li>And then use it to save the document:
5225 <pre>FILE *f;
5226xmlOutputBufferPtr output;
5227xmlDocPtr doc;
5228int res;
5229
5230f = ...
5231doc = ....
5232
5233output = xmlOutputBufferCreateOwn(f, NULL);
5234res = xmlSaveFileTo(output, doc, NULL);
5235 </pre>
5236 </li>
5237</ol>
5238
5239<h2><a name="Catalog">Catalog support</a></h2>
5240
5241<p>Table of Content:</p>
5242<ol>
5243 <li><a href="General2">General overview</a></li>
5244 <li><a href="#definition">The definition</a></li>
5245 <li><a href="#Simple">Using catalogs</a></li>
5246 <li><a href="#Some">Some examples</a></li>
5247 <li><a href="#reference">How to tune catalog usage</a></li>
5248 <li><a href="#validate">How to debug catalog processing</a></li>
5249 <li><a href="#Declaring">How to create and maintain catalogs</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005250 <li><a href="#implemento">The implementor corner quick review of the
5251 API</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005252 <li><a href="#Other">Other resources</a></li>
5253</ol>
5254
5255<h3><a name="General2">General overview</a></h3>
5256
Daniel Veillardf781dba2006-06-09 13:34:49 +00005257<p>What is a catalog? Basically it's a lookup mechanism used when an entity
5258(a file or a remote resource) references another entity. The catalog lookup
5259is inserted between the moment the reference is recognized by the software
5260(XML parser, stylesheet processing, or even images referenced for inclusion
5261in a rendering) and the time where loading that resource is actually
5262started.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005263
5264<p>It is basically used for 3 things:</p>
5265<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005266 <li>mapping from "logical" names, the public identifiers and a more
5267 concrete name usable for download (and URI). For example it can associate
5268 the logical name
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005269 <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005270 <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be
5271 downloaded</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005272 <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p>
5273 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005274 <li>remapping from a given URL to another one, like an HTTP indirection
5275 saying that
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005276 <p>"http://www.oasis-open.org/committes/tr.xsl"</p>
5277 <p>should really be looked at</p>
5278 <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p>
5279 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005280 <li>providing a local cache mechanism allowing to load the entities
5281 associated to public identifiers or remote resources, this is a really
5282 important feature for any significant deployment of XML or SGML since it
5283 allows to avoid the aleas and delays associated to fetching remote
5284 resources.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005285</ul>
5286
5287<h3><a name="definition">The definitions</a></h3>
5288
5289<p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p>
5290<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005291 <li>the older SGML catalogs, the official spec is SGML Open Technical
5292 Resolution TR9401:1997, but is better understood by reading <a
5293 href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from
5294 James Clark. This is relatively old and not the preferred mode of
5295 operation of libxml.</li>
5296 <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML
5297 Catalogs</a> is far more flexible, more recent, uses an XML syntax and
5298 should scale quite better. This is the default option of libxml.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005299</ul>
5300
5301<p></p>
5302
5303<h3><a name="Simple">Using catalog</a></h3>
5304
Daniel Veillardf781dba2006-06-09 13:34:49 +00005305<p>In a normal environment libxml2 will by default check the presence of a
5306catalog in /etc/xml/catalog, and assuming it has been correctly populated,
5307the processing is completely transparent to the document user. To take a
5308concrete example, suppose you are authoring a DocBook document, this one
5309starts with the following DOCTYPE definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005310<pre>&lt;?xml version='1.0'?&gt;
5311&lt;!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
5312 "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"&gt;</pre>
5313
Daniel Veillardf781dba2006-06-09 13:34:49 +00005314<p>When validating the document with libxml, the catalog will be
5315automatically consulted to lookup the public identifier "-//Norman Walsh//DTD
5316DocBk XML V3.1.4//EN" and the system identifier
5317"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have
5318been installed on your system and the catalogs actually point to them, libxml
5319will fetch them from the local disk.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005320
Daniel Veillardf781dba2006-06-09 13:34:49 +00005321<p style="font-size: 10pt"><strong>Note</strong>: Really don't use this
5322DOCTYPE example it's a really old version, but is fine as an example.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005323
Daniel Veillardf781dba2006-06-09 13:34:49 +00005324<p>Libxml2 will check the catalog each time that it is requested to load an
5325entity, this includes DTD, external parsed entities, stylesheets, etc ... If
5326your system is correctly configured all the authoring phase and processing
5327should use only local files, even if your document stays portable because it
5328uses the canonical public and system ID, referencing the remote document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005329
5330<h3><a name="Some">Some examples:</a></h3>
5331
Daniel Veillardf781dba2006-06-09 13:34:49 +00005332<p>Here is a couple of fragments from XML Catalogs used in libxml2 early
5333regression tests in <code>test/catalogs</code> :</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005334<pre>&lt;?xml version="1.0"?&gt;
5335&lt;!DOCTYPE catalog PUBLIC
5336 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
5337 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
5338&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
5339 &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
5340 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
5341...</pre>
5342
Daniel Veillardf781dba2006-06-09 13:34:49 +00005343<p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are
5344written in XML, there is a specific namespace for catalog elements
5345"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this
5346catalog is a <code>public</code> mapping it allows to associate a Public
5347Identifier with an URI.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005348<pre>...
5349 &lt;rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/"
5350 rewritePrefix="file:///usr/share/xml/docbook/"/&gt;
5351...</pre>
5352
Daniel Veillardf781dba2006-06-09 13:34:49 +00005353<p>A <code>rewriteSystem</code> is a very powerful instruction, it says that
5354any URI starting with a given prefix should be looked at another URI
5355constructed by replacing the prefix with an new one. In effect this acts like
5356a cache system for a full area of the Web. In practice it is extremely useful
5357with a file prefix if you have installed a copy of those resources on your
5358local system.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005359<pre>...
5360&lt;delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //"
5361 catalog="file:///usr/share/xml/docbook.xml"/&gt;
5362&lt;delegatePublic publicIdStartString="-//OASIS//ENTITIES DocBook XML"
5363 catalog="file:///usr/share/xml/docbook.xml"/&gt;
5364&lt;delegatePublic publicIdStartString="-//OASIS//DTD DocBook XML"
5365 catalog="file:///usr/share/xml/docbook.xml"/&gt;
5366&lt;delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/"
5367 catalog="file:///usr/share/xml/docbook.xml"/&gt;
5368&lt;delegateURI uriStartString="http://www.oasis-open.org/docbook/"
5369 catalog="file:///usr/share/xml/docbook.xml"/&gt;
5370...</pre>
5371
Daniel Veillardf781dba2006-06-09 13:34:49 +00005372<p>Delegation is the core features which allows to build a tree of catalogs,
5373easier to maintain than a single catalog, based on Public Identifier, System
5374Identifier or URI prefixes it instructs the catalog software to look up
5375entries in another resource. This feature allow to build hierarchies of
5376catalogs, the set of entries presented should be sufficient to redirect the
5377resolution of all DocBook references to the specific catalog in
5378<code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all
5379references for DocBook 4.2.1 to a specific catalog installed at the same time
5380as the DocBook resources on the local machine.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005381
5382<h3><a name="reference">How to tune catalog usage:</a></h3>
5383
Daniel Veillardf781dba2006-06-09 13:34:49 +00005384<p>The user can change the default catalog behaviour by redirecting queries
5385to its own set of catalogs, this can be done by setting the
5386<code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an
5387empty one should deactivate loading the default <code>/etc/xml/catalog</code>
5388default catalog</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005389
5390<h3><a name="validate">How to debug catalog processing:</a></h3>
5391
Daniel Veillardf781dba2006-06-09 13:34:49 +00005392<p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will
William M. Brack43a87292007-02-15 20:41:02 +00005393make libxml2 output debugging information for each catalog operations, for
Daniel Veillardf781dba2006-06-09 13:34:49 +00005394example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005395<pre>orchis:~/XML -&gt; xmllint --memory --noout test/ent2
5396warning: failed to load external entity "title.xml"
5397orchis:~/XML -&gt; export XML_DEBUG_CATALOG=
5398orchis:~/XML -&gt; xmllint --memory --noout test/ent2
5399Failed to parse catalog /etc/xml/catalog
5400Failed to parse catalog /etc/xml/catalog
5401warning: failed to load external entity "title.xml"
5402Catalogs cleanup
5403orchis:~/XML -&gt; </pre>
5404
Daniel Veillardf781dba2006-06-09 13:34:49 +00005405<p>The test/ent2 references an entity, running the parser from memory makes
5406the base URI unavailable and the the "title.xml" entity cannot be loaded.
5407Setting up the debug environment variable allows to detect that an attempt is
5408made to load the <code>/etc/xml/catalog</code> but since it's not present the
5409resolution fails.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005410
Daniel Veillardf781dba2006-06-09 13:34:49 +00005411<p>But the most advanced way to debug XML catalog processing is to use the
5412<strong>xmlcatalog</strong> command shipped with libxml2, it allows to load
5413catalogs and make resolution queries to see what is going on. This is also
5414used for the regression tests:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005415<pre>orchis:~/XML -&gt; ./xmlcatalog test/catalogs/docbook.xml \
5416 "-//OASIS//DTD DocBook XML V4.1.2//EN"
5417http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
5418orchis:~/XML -&gt; </pre>
5419
Daniel Veillardf781dba2006-06-09 13:34:49 +00005420<p>For debugging what is going on, adding one -v flags increase the verbosity
5421level to indicate the processing done (adding a second flag also indicate
5422what elements are recognized at parsing):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005423<pre>orchis:~/XML -&gt; ./xmlcatalog -v test/catalogs/docbook.xml \
5424 "-//OASIS//DTD DocBook XML V4.1.2//EN"
5425Parsing catalog test/catalogs/docbook.xml's content
5426Found public match -//OASIS//DTD DocBook XML V4.1.2//EN
5427http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
5428Catalogs cleanup
5429orchis:~/XML -&gt; </pre>
5430
Daniel Veillardf781dba2006-06-09 13:34:49 +00005431<p>A shell interface is also available to debug and process multiple queries
5432(and for regression tests):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005433<pre>orchis:~/XML -&gt; ./xmlcatalog -shell test/catalogs/docbook.xml \
5434 "-//OASIS//DTD DocBook XML V4.1.2//EN"
5435&gt; help
5436Commands available:
5437public PublicID: make a PUBLIC identifier lookup
5438system SystemID: make a SYSTEM identifier lookup
5439resolve PublicID SystemID: do a full resolver lookup
5440add 'type' 'orig' 'replace' : add an entry
5441del 'values' : remove values
5442dump: print the current catalog state
5443debug: increase the verbosity level
5444quiet: decrease the verbosity level
5445exit: quit the shell
5446&gt; public "-//OASIS//DTD DocBook XML V4.1.2//EN"
5447http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
5448&gt; quit
5449orchis:~/XML -&gt; </pre>
5450
Daniel Veillardf781dba2006-06-09 13:34:49 +00005451<p>This should be sufficient for most debugging purpose, this was actually
5452used heavily to debug the XML Catalog implementation itself.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005453
Daniel Veillardf781dba2006-06-09 13:34:49 +00005454<h3><a name="Declaring">How to create and maintain</a> catalogs:</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005455
Daniel Veillardf781dba2006-06-09 13:34:49 +00005456<p>Basically XML Catalogs are XML files, you can either use XML tools to
5457manage them or use <strong>xmlcatalog</strong> for this. The basic step is
5458to create a catalog the -create option provide this facility:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005459<pre>orchis:~/XML -&gt; ./xmlcatalog --create tst.xml
5460&lt;?xml version="1.0"?&gt;
5461&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
5462 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
5463&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
5464orchis:~/XML -&gt; </pre>
5465
Daniel Veillardf781dba2006-06-09 13:34:49 +00005466<p>By default xmlcatalog does not overwrite the original catalog and save the
5467result on the standard output, this can be overridden using the -noout
5468option. The <code>-add</code> command allows to add entries in the
5469catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005470<pre>orchis:~/XML -&gt; ./xmlcatalog --noout --create --add "public" \
5471 "-//OASIS//DTD DocBook XML V4.1.2//EN" \
5472 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml
5473orchis:~/XML -&gt; cat tst.xml
5474&lt;?xml version="1.0"?&gt;
5475&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" \
5476 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
5477&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
5478&lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
5479 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
5480&lt;/catalog&gt;
5481orchis:~/XML -&gt; </pre>
5482
Daniel Veillardf781dba2006-06-09 13:34:49 +00005483<p>The <code>-add</code> option will always take 3 parameters even if some of
5484the XML Catalog constructs (like nextCatalog) will have only a single
5485argument, just pass a third empty string, it will be ignored.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005486
Daniel Veillardf781dba2006-06-09 13:34:49 +00005487<p>Similarly the <code>-del</code> option remove matching entries from the
5488catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005489<pre>orchis:~/XML -&gt; ./xmlcatalog --del \
5490 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml
5491&lt;?xml version="1.0"?&gt;
5492&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
5493 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
5494&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
5495orchis:~/XML -&gt; </pre>
5496
Daniel Veillardf781dba2006-06-09 13:34:49 +00005497<p>The catalog is now empty. Note that the matching of <code>-del</code> is
5498exact and would have worked in a similar fashion with the Public ID
5499string.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005500
Daniel Veillardf781dba2006-06-09 13:34:49 +00005501<p>This is rudimentary but should be sufficient to manage a not too complex
5502catalog tree of resources.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005503
Daniel Veillardf781dba2006-06-09 13:34:49 +00005504<h3><a name="implemento">The implementor corner quick review of the
5505API:</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005506
Daniel Veillardf781dba2006-06-09 13:34:49 +00005507<p>First, and like for every other module of libxml, there is an
5508automatically generated <a href="html/libxml-catalog.html">API page for
5509catalog support</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005510
5511<p>The header for the catalog interfaces should be included as:</p>
5512<pre>#include &lt;libxml/catalog.h&gt;</pre>
5513
Daniel Veillardf781dba2006-06-09 13:34:49 +00005514<p>The API is voluntarily kept very simple. First it is not obvious that
5515applications really need access to it since it is the default behaviour of
5516libxml2 (Note: it is possible to completely override libxml2 default catalog
5517by using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to
5518plug an application specific resolver).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005519
Daniel Veillard8a469172003-06-12 16:05:07 +00005520<p>Basically libxml2 support 2 catalog lists:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005521<ul>
5522 <li>the default one, global shared by all the application</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005523 <li>a per-document catalog, this one is built if the document uses the
5524 <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is
5525 associated to the parser context and destroyed when the parsing context
5526 is destroyed.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005527</ul>
5528
5529<p>the document one will be used first if it exists.</p>
5530
5531<h4>Initialization routines:</h4>
5532
Daniel Veillardf781dba2006-06-09 13:34:49 +00005533<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be
5534used at startup to initialize the catalog, if the catalog should be
5535initialized with specific values xmlLoadCatalog() or xmlLoadCatalogs()
5536should be called before xmlInitializeCatalog() which would otherwise do a
5537default initialization first.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005538
Daniel Veillardf781dba2006-06-09 13:34:49 +00005539<p>The xmlCatalogAddLocal() call is used by the parser to grow the document
5540own catalog list if needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005541
5542<h4>Preferences setup:</h4>
5543
Daniel Veillardf781dba2006-06-09 13:34:49 +00005544<p>The XML Catalog spec requires the possibility to select default
5545preferences between public and system delegation,
5546xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and
5547xmlCatalogGetDefaults() allow to control if XML Catalogs resolution should
5548be forbidden, allowed for global catalog, for document catalog or both, the
5549default is to allow both.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005550
Daniel Veillardf781dba2006-06-09 13:34:49 +00005551<p>And of course xmlCatalogSetDebug() allows to generate debug messages
5552(through the xmlGenericError() mechanism).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005553
5554<h4>Querying routines:</h4>
5555
Daniel Veillardf781dba2006-06-09 13:34:49 +00005556<p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic()
5557and xmlCatalogResolveURI() are relatively explicit if you read the XML
5558Catalog specification they correspond to section 7 algorithms, they should
5559also work if you have loaded an SGML catalog with a simplified semantic.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005560
Daniel Veillardf781dba2006-06-09 13:34:49 +00005561<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but
5562operate on the document catalog list</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005563
5564<h4>Cleanup and Miscellaneous:</h4>
5565
Daniel Veillardf781dba2006-06-09 13:34:49 +00005566<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is
5567the per-document equivalent.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005568
Daniel Veillardf781dba2006-06-09 13:34:49 +00005569<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the
5570first catalog in the global list, and xmlCatalogDump() allows to dump a
5571catalog state, those routines are primarily designed for xmlcatalog, I'm not
5572sure that exposing more complex interfaces (like navigation ones) would be
5573really useful.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005574
Daniel Veillardf781dba2006-06-09 13:34:49 +00005575<p>The xmlParseCatalogFile() is a function used to load XML Catalog files,
5576it's similar as xmlParseFile() except it bypass all catalog lookups, it's
5577provided because this functionality may be useful for client tools.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005578
5579<h4>threaded environments:</h4>
5580
Daniel Veillardf781dba2006-06-09 13:34:49 +00005581<p>Since the catalog tree is built progressively, some care has been taken to
5582try to avoid troubles in multithreaded environments. The code is now thread
5583safe assuming that the libxml2 library has been compiled with threads
5584support.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005585
5586<p></p>
5587
5588<h3><a name="Other">Other resources</a></h3>
5589
Daniel Veillardf781dba2006-06-09 13:34:49 +00005590<p>The XML Catalog specification is relatively recent so there isn't much
5591literature to point at:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005592<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +00005593 <li>You can find a good rant from Norm Walsh about <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005594 href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the
William M. Brack43a87292007-02-15 20:41:02 +00005595 need for catalogs</a>, it provides a lot of context information even if
Daniel Veillardf781dba2006-06-09 13:34:49 +00005596 I don't agree with everything presented. Norm also wrote a more recent
5597 article <a
5598 href="http://wwws.sun.com/software/xml/developers/resolver/article/">XML
5599 entities and URI resolvers</a> describing them.</li>
5600 <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML
5601 catalog proposal</a> from John Cowan</li>
5602 <li>The <a href="http://www.rddl.org/">Resource Directory Description
5603 Language</a> (RDDL) another catalog system but more oriented toward
5604 providing metadata for XML namespaces.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005605 <li>the page from the OASIS Technical <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005606 href="http://www.oasis-open.org/committees/entity/">Committee on Entity
5607 Resolution</a> who maintains XML Catalog, you will find pointers to the
5608 specification update, some background and pointers to others tools
5609 providing XML Catalog support</li>
5610 <li>There is a <a href="buildDocBookCatalog">shell script</a> to generate
5611 XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
5612 directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
5613 the resources found on the system. Otherwise it will just create
5614 ~/xmlcatalog and ~/dbkxmlcatalog and doing:
Daniel Veillard8594de92003-04-25 10:08:44 +00005615 <p><code>export XML_CATALOG_FILES=$HOME/xmlcatalog</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005616 <p>should allow to process DocBook documentations without requiring
5617 network accesses for the DTD or stylesheets</p>
Daniel Veillard35e937a2002-01-19 22:21:54 +00005618 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005619 <li>I have uploaded <a href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">a
5620 small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
5621 to work fine for me too</li>
5622 <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog
5623 manual page</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005624</ul>
5625
Daniel Veillardf781dba2006-06-09 13:34:49 +00005626<p>If you have suggestions for corrections or additions, simply contact
5627me:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005628
5629<h2><a name="library">The parser interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005630
Daniel Veillardf781dba2006-06-09 13:34:49 +00005631<p>This section is directly intended to help programmers getting bootstrapped
5632using the XML tollkit from the C language. It is not intended to be
5633extensive. I hope the automatically generated documents will provide the
5634completeness required, but as a separate set of documents. The interfaces of
5635the XML parser are by principle low level, Those interested in a higher level
5636API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00005637
Daniel Veillardf781dba2006-06-09 13:34:49 +00005638<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
5639separated from the <a href="html/libxml-htmlparser.html">HTML parser
5640interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00005641
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005642<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005643
Daniel Veillardf781dba2006-06-09 13:34:49 +00005644<p>Usually, the first thing to do is to read an XML input. The parser accepts
5645documents either from in-memory strings or from files. The functions are
5646defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005647<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005648 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005649 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005650 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005651</dl>
5652<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005653 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005654 <dd><p>Parse an XML document contained in a (possibly compressed)
5655 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005656 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005657</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005658
Daniel Veillardf781dba2006-06-09 13:34:49 +00005659<p>The parser returns a pointer to the document structure (or NULL in case of
5660failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005661
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005662<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +00005663
Daniel Veillardf781dba2006-06-09 13:34:49 +00005664<p>In order for the application to keep the control when the document is
5665being fetched (which is common for GUI based programs) libxml2 provides a
5666push interface, too, as of version 1.8.3. Here are the interface
5667functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00005668<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
5669 void *user_data,
5670 const char *chunk,
5671 int size,
5672 const char *filename);
5673int xmlParseChunk (xmlParserCtxtPtr ctxt,
5674 const char *chunk,
5675 int size,
5676 int terminate);</pre>
5677
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005678<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00005679<pre> FILE *f;
5680
5681 f = fopen(filename, "r");
5682 if (f != NULL) {
5683 int res, size = 1024;
5684 char chars[1024];
5685 xmlParserCtxtPtr ctxt;
5686
5687 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +00005688 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +00005689 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
5690 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +00005691 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +00005692 xmlParseChunk(ctxt, chars, res, 0);
5693 }
5694 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +00005695 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +00005696 xmlFreeParserCtxt(ctxt);
5697 }
5698 }</pre>
5699
Daniel Veillardf781dba2006-06-09 13:34:49 +00005700<p>The HTML parser embedded into libxml2 also has a push interface; the
5701functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +00005702
5703<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
5704
Daniel Veillardf781dba2006-06-09 13:34:49 +00005705<p>The tree-building interface makes the parser memory-hungry, first loading
5706the document in memory and then building the tree itself. Reading a document
5707without building the tree is possible using the SAX interfaces (see SAX.h and
5708<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
5709Henstridge's documentation</a>). Note also that the push interface can be
5710limited to SAX: just use the two first arguments of
5711<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +00005712
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005713<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005714
Daniel Veillardf781dba2006-06-09 13:34:49 +00005715<p>The other way to get an XML tree in memory is by building it. Basically
5716there is a set of functions dedicated to building new elements. (These are
5717also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
5718code that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005719<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00005720 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +00005721 xmlNodePtr tree, subtree;
5722
5723 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +00005724 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
5725 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
5726 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
5727 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +00005728 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +00005729 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +00005730 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
5731 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
5732 subtree = xmlNewChild(tree, NULL, "image", NULL);
5733 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005734
5735<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005736
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005737<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005738
Daniel Veillardf781dba2006-06-09 13:34:49 +00005739<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
5740code has access to the internal structure of all the elements of the tree.
5741The names should be somewhat simple like <strong>parent</strong>,
5742<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
5743<strong>properties</strong>, etc... For example, still with the previous
5744example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005745<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005746
5747<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +00005748<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005749
Daniel Veillardf781dba2006-06-09 13:34:49 +00005750<p>points to the text node containing the chapter title "The Linux
5751adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005752
Daniel Veillardf781dba2006-06-09 13:34:49 +00005753<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
5754present before the document root, so <code>doc-&gt;children</code> may point
5755to an element which is not the document Root Element; a function
5756<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +00005757
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005758<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005759
Daniel Veillardf781dba2006-06-09 13:34:49 +00005760<p>Functions are provided for reading and writing the document content. Here
5761is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005762<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005763 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
5764 xmlChar *value);</code></dt>
5765 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
5766 The value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005767 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005768</dl>
5769<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005770 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
5771 *name);</code></dt>
5772 <dd><p>This function returns a pointer to new copy of the property
5773 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005774 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005775</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005776
Daniel Veillardf781dba2006-06-09 13:34:49 +00005777<p>Two functions are provided for reading and writing the text associated
5778with elements:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005779<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005780 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
5781 *value);</code></dt>
5782 <dd><p>This function takes an "external" string and converts it to one
5783 text node or possibly to a list of entity and text nodes. All
5784 non-predefined entity references like &amp;Gnome; will be stored
5785 internally as entity nodes, hence the result of the function may not be
5786 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005787 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005788</dl>
5789<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005790 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
5791 inLine);</code></dt>
5792 <dd><p>This function is the inverse of
5793 <code>xmlStringGetNodeList()</code>. It generates a new string
5794 containing the content of the text and entity nodes. Note the extra
5795 argument inLine. If this argument is set to 1, the function will expand
5796 entity references. For example, instead of returning the &amp;Gnome;
5797 XML encoding in the string, it will substitute it with its value (say,
5798 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005799 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005800</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005801
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005802<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005803
5804<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005805<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005806 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
5807 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005808 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005809 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005810</dl>
5811<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005812 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005813 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005814 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005815</dl>
5816<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005817 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005818 <dd><p>Saves the document to a file. In this case, the compression
5819 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005820 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005821</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +00005822
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005823<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005824
Daniel Veillardf781dba2006-06-09 13:34:49 +00005825<p>The library transparently handles compression when doing file-based
5826accesses. The level of compression on saves can be turned on either globally
5827or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +00005828<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005829 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005830 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005831 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005832</dl>
5833<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005834 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005835 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005836 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005837</dl>
5838<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005839 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005840 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005841 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005842</dl>
5843<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005844 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +00005845 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00005846 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +00005847</dl>
5848
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005849<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005850
Daniel Veillardf781dba2006-06-09 13:34:49 +00005851<p>Entities in principle are similar to simple C macros. An entity defines an
5852abbreviation for a given string that you can reuse many times throughout the
5853content of your document. Entities are especially useful when a given string
5854may occur frequently within a document, or to confine the change needed to a
5855document to a restricted area in the internal subset of the document (at the
5856beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005857<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000058582 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +000058593 &lt;!ENTITY xml "Extensible Markup Language"&gt;
58604 ]&gt;
58615 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +000058626 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +000058637 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005864
Daniel Veillardf781dba2006-06-09 13:34:49 +00005865<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
5866its name with '&amp;' and following it by ';' without any spaces added. There
5867are 5 predefined entities in libxml2 allowing you to escape characters with
5868predefined meaning in some parts of the xml document content:
5869<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
5870for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
5871<strong>&amp;quot;</strong> for the character '"', and
5872<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005873
Daniel Veillardf781dba2006-06-09 13:34:49 +00005874<p>One of the problems related to entities is that you may want the parser to
5875substitute an entity's content so that you can see the replacement text in
5876your application. Or you may prefer to keep entity references as such in the
5877content to be able to save the document back without losing this usually
5878precious information (if the user went through the pain of explicitly
5879defining entities, he may have a a rather negative attitude if you blindly
5880substitute them as saving time). The <a
5881href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a>
5882function allows you to check and change the behaviour, which is to not
5883substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005884
Daniel Veillardf781dba2006-06-09 13:34:49 +00005885<p>Here is the DOM tree built by libxml2 for the previous document in the
5886default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005887<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005888DOCUMENT
5889version=1.0
5890 ELEMENT EXAMPLE
5891 TEXT
5892 content=
5893 ENTITY_REF
5894 INTERNAL_GENERAL_ENTITY xml
5895 content=Extensible Markup Language
5896 TEXT
5897 content=</pre>
5898
5899<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005900<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005901DOCUMENT
5902version=1.0
5903 ELEMENT EXAMPLE
5904 TEXT
5905 content= Extensible Markup Language</pre>
5906
Daniel Veillardf781dba2006-06-09 13:34:49 +00005907<p>So, entities or no entities? Basically, it depends on your use case. I
5908suggest that you keep the non-substituting default behaviour and avoid using
5909entities in your XML document or data if you are not willing to handle the
5910entity references elements in the DOM tree.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005911
Daniel Veillardf781dba2006-06-09 13:34:49 +00005912<p>Note that at save time libxml2 enforces the conversion of the predefined
5913entities where necessary to prevent well-formedness problems, and will also
5914transparently replace those with chars (i.e. it will not generate entity
5915reference elements in the DOM tree or call the reference() SAX callback when
5916finding them in the input).</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005917
Daniel Veillardf781dba2006-06-09 13:34:49 +00005918<p><span style="background-color: #FF0000">WARNING</span>: handling entities
5919on top of the libxml2 SAX interface is difficult!!! If you plan to use
5920non-predefined entities in your documents, then the learning curve to handle
5921then using the SAX API may be long. If you plan to use complex documents, I
5922strongly suggest you consider using the DOM interface instead and let libxml
5923deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +00005924
Daniel Veillard2f4dfc41999-09-24 14:03:48 +00005925<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005926
Daniel Veillard8a469172003-06-12 16:05:07 +00005927<p>The libxml2 library implements <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00005928href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
5929recognizing namespace constructs in the input, and does namespace lookup
5930automatically when building the DOM tree. A namespace declaration is
5931associated with an in-memory structure and all elements or attributes within
5932that namespace point to it. Hence testing the namespace is a simple and fast
5933equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005934
Daniel Veillardf781dba2006-06-09 13:34:49 +00005935<p>I suggest that people using libxml2 use a namespace, and declare it in the
5936root element of their document as the default namespace. Then they don't need
5937to use the prefix in the content but we will have a basis for future semantic
5938refinement and merging of data from different sources. This doesn't increase
5939the size of the XML output significantly, but significantly increases its
5940value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00005941<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
5942 &lt;elem1&gt;...&lt;/elem1&gt;
5943 &lt;elem2&gt;...&lt;/elem2&gt;
5944&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005945
Daniel Veillardf781dba2006-06-09 13:34:49 +00005946<p>The namespace value has to be an absolute URL, but the URL doesn't have to
5947point to any existing resource on the Web. It will bind all the element and
5948attributes with that URL. I suggest to use an URL within a domain you
5949control, and that the URL should contain some kind of version information if
5950possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a
5951good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +00005952
Daniel Veillardf781dba2006-06-09 13:34:49 +00005953<p>Then when you load a file, make sure that a namespace carrying the
5954version-independent prefix is installed on the root element of your document,
5955and if the version information don't match something you know, warn the user
5956and be liberal in what you accept as the input. Also do *not* try to base
5957namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
5958same as &lt;bar:text&gt; in another document. What really matters is the URI
5959associated with the element or the attribute, not the prefix string (which is
5960just a shortcut for the full URI). In libxml, element and attributes have an
5961<code>ns</code> field pointing to an xmlNs structure detailing the namespace
5962prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005963
5964<p>@@Interfaces@@</p>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00005965<pre>xmlNodePtr node;
Daniel Veillardfc8dc352003-10-18 09:07:46 +00005966if(!strncmp(node-&gt;name,"mytag",5)
5967 &amp;&amp; node-&gt;ns
5968 &amp;&amp; !strcmp(node-&gt;ns-&gt;href,"http://www.mysite.com/myns/1.0")) {
5969 ...
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00005970}</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005971
Daniel Veillardf781dba2006-06-09 13:34:49 +00005972<p>Usually people object to using namespaces together with validity checking.
5973I will try to make sure that using namespaces won't break validity checking,
5974so even if you plan to use or currently are using validation I strongly
5975suggest adding namespaces to your document. A default namespace scheme
5976<code>xmlns="http://...."</code> should not break validity even on less
5977flexible parsers. Using namespaces to mix and differentiate content coming
5978from multiple DTDs will certainly break current validation schemes. To check
5979such documents one needs to use schema-validation, which is supported in
5980libxml2 as well. See <a href="http://www.relaxng.org/">relagx-ng</a> and <a
Daniel Veillard3e35f8e2003-10-21 00:05:38 +00005981href="http://www.w3c.org/XML/Schema">w3c-schema</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005982
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005983<h2><a name="Upgrading">Upgrading 1.x code</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005984
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005985<p>Incompatible changes:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00005986
Daniel Veillardf781dba2006-06-09 13:34:49 +00005987<p>Version 2 of libxml2 is the first version introducing serious backward
5988incompatible changes. The main goals were:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00005989<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00005990 <li>a general cleanup. A number of mistakes inherited from the very early
5991 versions couldn't be changed due to compatibility constraints. Example
5992 the "childs" element in the nodes.</li>
5993 <li>Uniformization of the various nodes, at least for their header and link
5994 parts (doc, parent, children, prev, next), the goal is a simpler
5995 programming model and simplifying the task of the DOM implementors.</li>
5996 <li>better conformances to the XML specification, for example version 1.x
5997 had an heuristic to try to detect ignorable white spaces. As a result the
5998 SAX event generated were ignorableWhitespace() while the spec requires
5999 character() in that case. This also mean that a number of DOM node
6000 containing blank text may populate the DOM tree which were not present
6001 before.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006002</ul>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006003
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006004<h3>How to fix libxml-1.x code:</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006005
Daniel Veillardf781dba2006-06-09 13:34:49 +00006006<p>So client code of libxml designed to run with version 1.x may have to be
6007changed to compile against version 2.x of libxml. Here is a list of changes
6008that I have collected, they may not be sufficient, so in case you find other
6009change which are required, <a href="mailto:Daniel.Veillard@w3.org">drop me a
6010mail</a>:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006011<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006012 <li>The package name have changed from libxml to libxml2, the library name
6013 is now -lxml2 . There is a new xml2-config script which should be used to
6014 select the right parameters libxml2</li>
6015 <li>Node <strong>childs</strong> field has been renamed
6016 <strong>children</strong> so s/childs/children/g should be applied
6017 (probability of having "childs" anywhere else is close to 0+</li>
6018 <li>The document don't have anymore a <strong>root</strong> element it has
6019 been replaced by <strong>children</strong> and usually you will get a
6020 list of element here. For example a Dtd element for the internal subset
6021 and it's declaration may be found in that list, as well as processing
6022 instructions or comments found before or after the document root element.
6023 Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of
6024 a document. Alternatively if you are sure to not reference DTDs nor have
6025 PIs or comments before or after the root element
6026 s/-&gt;root/-&gt;children/g will probably do it.</li>
6027 <li>The white space issue, this one is more complex, unless special case of
6028 validating parsing, the line breaks and spaces usually used for indenting
6029 and formatting the document content becomes significant. So they are
6030 reported by SAX and if your using the DOM tree, corresponding nodes are
6031 generated. Too approach can be taken:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006032 <ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006033 <li>lazy one, use the compatibility call
6034 <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are
6035 relying on a special (and possibly broken) set of heuristics of
6036 libxml to detect ignorable blanks. Don't complain if it breaks or
6037 make your application not 100% clean w.r.t. to it's input.</li>
6038 <li>the Right Way: change you code to accept possibly insignificant
6039 blanks characters, or have your tree populated with weird blank text
6040 nodes. You can spot them using the commodity function
6041 <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank
6042 nodes.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006043 </ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006044 <p>Note also that with the new default the output functions don't add any
6045 extra indentation when saving a tree in order to be able to round trip
6046 (read and save) without inflating the document with extra formatting
6047 chars.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006048 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006049 <li>The include path has changed to $prefix/libxml/ and the includes
6050 themselves uses this new prefix in includes instructions... If you are
6051 using (as expected) the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006052 <pre>xml2-config --cflags</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006053 <p>output to generate you compile commands this will probably work out of
6054 the box</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006055 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006056 <li>xmlDetectCharEncoding takes an extra argument indicating the length in
6057 byte of the head of the document available for character detection.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006058</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006059
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006060<h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006061
Daniel Veillardf781dba2006-06-09 13:34:49 +00006062<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released
6063to allow smooth upgrade of existing libxml v1code while retaining
6064compatibility. They offers the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006065<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006066 <li>similar include naming, one should use
6067 <strong>#include&lt;libxml/...&gt;</strong> in both cases.</li>
6068 <li>similar identifiers defined via macros for the child and root fields:
6069 respectively <strong>xmlChildrenNode</strong> and
6070 <strong>xmlRootNode</strong></li>
6071 <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be
6072 inserted once in the client code</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006073</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006074
Daniel Veillardf781dba2006-06-09 13:34:49 +00006075<p>So the roadmap to upgrade your existing libxml applications is the
6076following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006077<ol>
6078 <li>install the libxml-1.8.8 (and libxml-devel-1.8.8) packages</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006079 <li>find all occurrences where the xmlDoc <strong>root</strong> field is
6080 used and change it to <strong>xmlRootNode</strong></li>
6081 <li>similarly find all occurrences where the xmlNode
6082 <strong>childs</strong> field is used and change it to
6083 <strong>xmlChildrenNode</strong></li>
6084 <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your
6085 <strong>main()</strong> or in the library init entry point</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006086 <li>Recompile, check compatibility, it should still work</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006087 <li>Change your configure script to look first for xml2-config and fall
6088 back using xml-config . Use the --cflags and --libs output of the command
6089 as the Include and Linking parameters needed to use libxml.</li>
6090 <li>install libxml2-2.3.x and libxml2-devel-2.3.x (libxml-1.8.y and
6091 libxml-devel-1.8.y can be kept simultaneously)</li>
6092 <li>remove your config.cache, relaunch your configuration mechanism, and
6093 recompile, if steps 2 and 3 were done right it should compile as-is</li>
6094 <li>Test that your application is still running correctly, if not this may
6095 be due to extra empty nodes due to formating spaces being kept in libxml2
6096 contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your
6097 code before calling the parser (next to
6098 <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006099</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006100
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006101<p>Following those steps should work. It worked for some of my own code.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006102
Daniel Veillardf781dba2006-06-09 13:34:49 +00006103<p>Let me put some emphasis on the fact that there is far more changes from
6104libxml 1.x to 2.x than the ones you may have to patch for. The overall code
6105has been considerably cleaned up and the conformance to the XML specification
6106has been drastically improved too. Don't take those changes as an excuse to
6107not upgrade, it may cost a lot on the long term ...</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006108
Daniel Veillard52dcab32001-10-30 12:51:17 +00006109<h2><a name="Thread">Thread safety</a></h2>
6110
Daniel Veillardf781dba2006-06-09 13:34:49 +00006111<p>Starting with 2.4.7, libxml2 makes provisions to ensure that concurrent
6112threads can safely work in parallel parsing different documents. There is
6113however a couple of things to do to ensure it:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +00006114<ul>
6115 <li>configure the library accordingly using the --with-threads options</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006116 <li>call xmlInitParser() in the "main" thread before using any of the
6117 libxml2 API (except possibly selecting a different memory allocator)</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +00006118</ul>
6119
Daniel Veillardf781dba2006-06-09 13:34:49 +00006120<p>Note that the thread safety cannot be ensured for multiple threads sharing
6121the same document, the locking must be done at the application level, libxml
6122exports a basic mutex and reentrant mutexes API in &lt;libxml/threads.h&gt;.
6123The parts of the library checked for thread safety are:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +00006124<ul>
6125 <li>concurrent loading</li>
6126 <li>file access resolution</li>
6127 <li>catalog access</li>
6128 <li>catalog building</li>
6129 <li>entities lookup/accesses</li>
6130 <li>validation</li>
6131 <li>global variables per-thread override</li>
6132 <li>memory handling</li>
6133</ul>
6134
Daniel Veillard28fdf8b2011-03-07 08:12:39 +08006135<p>XPath has been tested for threaded usage on non-modified document
6136 for example when using libxslt, but make 100% sure the documents
6137 are accessed read-only !</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +00006138
Daniel Veillard35008381999-10-25 13:15:52 +00006139<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006140
Daniel Veillardf781dba2006-06-09 13:34:49 +00006141<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
6142Object Model</em>; this is an API for accessing XML or HTML structured
6143documents. Native support for DOM in Gnome is on the way (module gnome-dom),
6144and will be based on gnome-xml. This will be a far cleaner interface to
6145manipulate XML files within Gnome since it won't expose the internal
6146structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00006147
Daniel Veillard8a469172003-06-12 16:05:07 +00006148<p>The current DOM implementation on top of libxml2 is the <a
Daniel Veillarda4f85b92009-03-25 10:45:20 +00006149href="http://svn.gnome.org/viewvc/gdome2/trunk/">gdome2 Gnome module</a>, this
Daniel Veillardf781dba2006-06-09 13:34:49 +00006150is a full DOM interface, thanks to Paolo Casarini, check the <a
William M. Brack43a87292007-02-15 20:41:02 +00006151href="http://gdome2.cs.unibo.it/">Gdome2 homepage</a> for more
6152information.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006153
Daniel Veillard35008381999-10-25 13:15:52 +00006154<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006155
Daniel Veillardf781dba2006-06-09 13:34:49 +00006156<p>Here is a real size example, where the actual content of the application
6157data is not kept in the DOM tree but uses internal structures. It is based on
6158a proposal to keep a database of jobs related to Gnome, with an XML based
6159storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
6160base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00006161<pre>&lt;?xml version="1.0"?&gt;
6162&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
6163 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006164
Daniel Veillard60979bd2000-07-10 12:17:33 +00006165 &lt;gjob:Job&gt;
6166 &lt;gjob:Project ID="3"/&gt;
6167 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
6168 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006169
Daniel Veillard60979bd2000-07-10 12:17:33 +00006170 &lt;gjob:Update&gt;
6171 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
6172 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
6173 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
6174 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006175
Daniel Veillard60979bd2000-07-10 12:17:33 +00006176 &lt;gjob:Developers&gt;
6177 &lt;gjob:Developer&gt;
6178 &lt;/gjob:Developer&gt;
6179 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006180
Daniel Veillard60979bd2000-07-10 12:17:33 +00006181 &lt;gjob:Contact&gt;
6182 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
6183 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
6184 &lt;gjob:Company&gt;
6185 &lt;/gjob:Company&gt;
6186 &lt;gjob:Organisation&gt;
6187 &lt;/gjob:Organisation&gt;
6188 &lt;gjob:Webpage&gt;
6189 &lt;/gjob:Webpage&gt;
6190 &lt;gjob:Snailmail&gt;
6191 &lt;/gjob:Snailmail&gt;
6192 &lt;gjob:Phone&gt;
6193 &lt;/gjob:Phone&gt;
6194 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006195
Daniel Veillard60979bd2000-07-10 12:17:33 +00006196 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006197 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +00006198 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006199
Daniel Veillard60979bd2000-07-10 12:17:33 +00006200 &lt;gjob:Skills&gt;
6201 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006202
Daniel Veillard60979bd2000-07-10 12:17:33 +00006203 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006204 A GNOME based system that will allow a superuser to configure
6205 compressed and uncompressed files and/or file systems to be backed
6206 up with a supported media in the system. This should be able to
6207 perform via find commands generating a list of files that are passed
6208 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
6209 or via operations performed on the filesystem itself. Email
6210 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +00006211 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006212
Daniel Veillard60979bd2000-07-10 12:17:33 +00006213 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +00006214
Daniel Veillard60979bd2000-07-10 12:17:33 +00006215 &lt;/gjob:Jobs&gt;
6216&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006217
Daniel Veillardf781dba2006-06-09 13:34:49 +00006218<p>While loading the XML file into an internal DOM tree is a matter of
6219calling only a couple of functions, browsing the tree to gather the data and
6220generate the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006221
Daniel Veillardf781dba2006-06-09 13:34:49 +00006222<p>The suggested principle is to be tolerant with respect to the input
6223structure. For example, the ordering of the attributes is not significant,
6224the XML specification is clear about it. It's also usually a good idea not to
6225depend on the order of the children of a given node, unless it really makes
6226things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006227<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +00006228 * A person record
6229 */
6230typedef struct person {
6231 char *name;
6232 char *email;
6233 char *company;
6234 char *organisation;
6235 char *smail;
6236 char *webPage;
6237 char *phone;
6238} person, *personPtr;
6239
6240/*
6241 * And the code needed to parse it
6242 */
6243personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
6244 personPtr ret = NULL;
6245
6246DEBUG("parsePerson\n");
6247 /*
6248 * allocate the struct
6249 */
6250 ret = (personPtr) malloc(sizeof(person));
6251 if (ret == NULL) {
6252 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00006253 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00006254 }
6255 memset(ret, 0, sizeof(person));
6256
6257 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00006258 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00006259 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +00006260 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
6261 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
6262 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
6263 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
6264 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00006265 }
6266
6267 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00006268}</pre>
6269
Daniel Veillard91e9d582001-02-26 07:31:12 +00006270<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +00006271<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006272 <li>Usually a recursive parsing style is the more convenient one: XML data
6273 is by nature subject to repetitive constructs and usually exhibits highly
6274 structured patterns.</li>
6275 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
6276 i.e. the pointer to the global XML document and the namespace reserved to
6277 the application. Document wide information are needed for example to
6278 decode entities and it's a good coding practice to define a namespace for
6279 your application set of data and test that the element and attributes
6280 you're analyzing actually pertains to your application space. This is
6281 done by a simple equality test (cur-&gt;ns == ns).</li>
6282 <li>To retrieve text and attributes value, you can use the function
6283 <em>xmlNodeListGetString</em> to gather all the text and entity reference
6284 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +00006285</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006286
Daniel Veillardf781dba2006-06-09 13:34:49 +00006287<p>Here is another piece of code used to parse another level of the
6288structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +00006289<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +00006290/*
Daniel Veillard14fff061999-06-22 21:49:07 +00006291 * a Description for a Job
6292 */
6293typedef struct job {
6294 char *projectID;
6295 char *application;
6296 char *category;
6297 personPtr contact;
6298 int nbDevelopers;
6299 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
6300} job, *jobPtr;
6301
6302/*
6303 * And the code needed to parse it
6304 */
6305jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
6306 jobPtr ret = NULL;
6307
6308DEBUG("parseJob\n");
6309 /*
6310 * allocate the struct
6311 */
6312 ret = (jobPtr) malloc(sizeof(job));
6313 if (ret == NULL) {
6314 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +00006315 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +00006316 }
6317 memset(ret, 0, sizeof(job));
6318
6319 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +00006320 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +00006321 while (cur != NULL) {
6322
Daniel Veillard60979bd2000-07-10 12:17:33 +00006323 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
6324 ret-&gt;projectID = xmlGetProp(cur, "ID");
6325 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +00006326 fprintf(stderr, "Project has no ID\n");
6327 }
6328 }
Daniel Veillard60979bd2000-07-10 12:17:33 +00006329 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
6330 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
6331 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
6332 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
6333 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
6334 ret-&gt;contact = parsePerson(doc, ns, cur);
6335 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +00006336 }
6337
6338 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +00006339}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +00006340
Daniel Veillardf781dba2006-06-09 13:34:49 +00006341<p>Once you are used to it, writing this kind of code is quite simple, but
6342boring. Ultimately, it could be possible to write stubbers taking either C
6343data structure definitions, a set of XML examples or an XML DTD and produce
6344the code needed to import and export the content between C data and XML
6345storage. This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006346
Daniel Veillardf781dba2006-06-09 13:34:49 +00006347<p>Feel free to use <a href="example/gjobread.c">the code for the full C
6348parsing example</a> as a template, it is also available with Makefile in the
William M. Brack43a87292007-02-15 20:41:02 +00006349Gnome SVN base under libxml2/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +00006350
Daniel Veillardc310d562000-06-23 18:32:15 +00006351<h2><a name="Contributi">Contributions</a></h2>
6352<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006353 <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of
6354 patches, Gary Pennington worked on the validation API, threading support
6355 and Solaris port.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +00006356 <li>John Fleck helps maintaining the documentation and man pages.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +00006357 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
6358 maintainer of the Windows port, <a
6359 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
6360 binaries</a></li>
6361 <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a> provides
6362 <a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillarde356c282001-03-10 12:32:04 +00006363 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +00006364 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
6365 Sergeant</a> developed <a
6366 href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
6367 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
6368 application server</a></li>
6369 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a
6370 href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
6371 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
6372 documentation</li>
6373 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
Daniel Veillardaf43f632002-03-08 15:05:20 +00006374 href="http://xmlsoft.org/messages/0488.html">man pages</a></li>
Daniel Veillard5168dbf2001-07-07 00:18:23 +00006375 <li>there is a module for <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00006376 href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
6377 in OpenNSD/AOLServer</a></li>
6378 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provided the
6379 first version of libxml/libxslt <a
Daniel Veillard2d347fa2002-03-17 10:34:11 +00006380 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
Daniel Veillard1aadc442001-11-28 13:10:32 +00006381 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +00006382 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
6383 libxml2</a> with Kylix and Delphi and other Pascal compilers</li>
6384 <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a> implemented the
6385 <a href="http://www.w3.org/Signature/">XML Canonicalization and XML
6386 Digital Signature</a> <a
6387 href="http://www.aleksey.com/xmlsec/">implementations for libxml2</a></li>
6388 <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> and
6389 contributors maintain <a href="http://tclxml.sourceforge.net/">tcl
6390 bindings for libxml2 and libxslt</a>, as well as <a
6391 href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for
6392 xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>
6393 a GUI for xsltproc.</li>
Daniel Veillardc310d562000-06-23 18:32:15 +00006394</ul>
6395
Daniel Veillardc8eab3a1999-09-04 18:27:23 +00006396<p></p>
Daniel Veillardccb09631998-10-27 06:21:04 +00006397</body>
6398</html>