Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 31aa38158a0ec6075749838639775f3c01e01f6c / . / doc / xml.html
blob: 8113e45b8fc21a067bc26761f9911bf89c8b0767 [file] [log] [blame]
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3<html>
4<head>
Daniel Veillard598bec32003-07-06 10:02:03 +0000[diff] [blame]5 <title>The XML C parser and toolkit of Gnome</title>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]7</head>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]8<body bgcolor="#ffffff">
Daniel Veillard598bec32003-07-06 10:02:03 +0000[diff] [blame]9<h1 align="center">The XML C parser and toolkit of Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]10
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]11<h1>Note: this is the flat content of the <a href="index.html">web
12site</a></h1>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]13
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]14<h1 style="text-align: center">libxml, a.k.a. gnome-xml</h1>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]15
16<p></p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]17
Daniel Veillard7ebac022004-02-25 22:36:35 +0000[diff] [blame]18<p
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]19style="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 +0000[diff] [blame]23
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]24<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 +0000[diff] [blame]33
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]34<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 +0200[diff] [blame]36CygWin, MacOS, MacOS X, RISC Os, OS/2, VMS, QNX, MVS, VxWorks, ...)</p>
Daniel Veillard710823b2003-03-04 10:05:52 +0000[diff] [blame]37
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]38<p>Libxml2 implements a number of existing standards related to markup
39languages:</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]40<ul>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]41 <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 +0000[diff] [blame]47 <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 +0000[diff] [blame]49 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 +0000[diff] [blame]54 <li>XML Pointer Language (XPointer) Version 1.0: <a
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]55 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 +0000[diff] [blame]58 <li>ISO-8859-x encodings, as well as <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]59 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 +0000[diff] [blame]62 <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 +0000[diff] [blame]65 <li>Canonical XML Version 1.0: <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]66 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 +0000[diff] [blame]68 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 +0000[diff] [blame]69 <li>Relax NG, ISO/IEC 19757-2:2003, <a
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]70 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 +0000[diff] [blame]71 <li>W3C XML Schemas Part 2: Datatypes <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]72 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 +0000[diff] [blame]76</ul>
77
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]78<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 +0000[diff] [blame]83
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]84<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 +0000[diff] [blame]86<ul>
87 <li>Document Object Model (DOM) <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]88 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 +0000[diff] [blame]97</ul>
98
Daniel Veillardf83a2c72003-04-08 13:48:40 +0000[diff] [blame]99<p>A partial implementation of <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]100href="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 +0000[diff] [blame]103
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]104<p>Separate documents:</p>
105<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]106 <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 +0000[diff] [blame]109 <li><a href="http://gdome2.cs.unibo.it/">the gdome2 page</a>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]110 : 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 +0200[diff] [blame]114 <li>also check the related links section for more related and active
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]115 projects.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]116</ul>
Daniel Veillardfde74702009-07-24 09:01:46 +0200[diff] [blame]117<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 +0000[diff] [blame]119
Daniel Veillarde1662542002-08-28 11:50:59 +0000[diff] [blame]120<p>Logo designed by <a href="mailto:liyanage@access.ch">Marc Liyanage</a>.</p>
121
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]122<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]123
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]124<p>This document describes libxml, the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]125href="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 +0000[diff] [blame]129
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]130<p>Here are some key points about libxml:</p>
131<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]132 <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 +0000[diff] [blame]136 <li>Libxml2 includes complete <a
Daniel Veillard8c2ecaf2001-07-10 17:53:07 +0000[diff] [blame]137 href="http://www.w3.org/TR/xpath">XPath</a>, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]138 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 +0000[diff] [blame]145 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]146 <li>The internal document representation is as close as possible to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]147 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]148 <li>Libxml2 also has a <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]149 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 +0000[diff] [blame]151 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]152 <li>This library is released under the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]153 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 +0000[diff] [blame]156</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]157
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]158<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 +0000[diff] [blame]162
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]163<h2><a name="FAQ">FAQ</a></h2>
164
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]165<p>Table of Contents:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]166<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]167 <li><a href="FAQ.html#License">License(s)</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]168 <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 +0000[diff] [blame]173<h3><a name="License">License</a>(s)</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]174<ol>
175 <li><em>Licensing Terms for libxml</em>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]176 <p>libxml2 is released under the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]177 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 +0000[diff] [blame]180 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]181 <li><em>Can I embed libxml2 in a proprietary application ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]182 <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 +0000[diff] [blame]186 </li>
187</ol>
188
189<h3><a name="Installati">Installation</a></h3>
190<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]191 <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 +0000[diff] [blame]193 <p></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]194 <li><em>Where can I get libxml</em> ?
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]195 <p>The original distribution comes from <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]196 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> or <a
Daniel Veillard024f1992003-12-10 16:43:49 +0000[diff] [blame]197 href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">gnome.org</a></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]198 <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 +0000[diff] [blame]200 <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 +0000[diff] [blame]203 <p></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]204 <li><em>I see libxml and libxml2 releases, which one should I install ?</em>
205 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]206 <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 +0000[diff] [blame]222 </ul>
223 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]224 <li><em>I can't install the libxml package, it conflicts with libxml0</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]225 <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 +0000[diff] [blame]230 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]231 <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 +0000[diff] [blame]235 <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]236 <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 +0000[diff] [blame]240 </li>
241</ol>
242
243<h3><a name="Compilatio">Compilation</a></h3>
244<ol>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]245 <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 +0000[diff] [blame]247 <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 +0000[diff] [blame]254 <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 +0000[diff] [blame]256 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]257 <li><em>What other libraries are needed to compile/install libxml2 ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]258 <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 +0000[diff] [blame]263 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]264 <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 +0000[diff] [blame]273 href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
274 </ul>
275 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]276 <p></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]277 <li><em>Make check fails on some platforms</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]278 <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 +0000[diff] [blame]284 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]285 <li><em>I use the SVN version and there is no configure script</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]286 <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 +0000[diff] [blame]289 <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 +0000[diff] [blame]292 <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 +0000[diff] [blame]295 </li>
296</ol>
297
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]298<h3><a name="Developer">Developer</a> corner</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]299<ol>
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]300 <li><em>Troubles compiling or linking programs using libxml2</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]301 <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 +0000[diff] [blame]305 <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 +0000[diff] [blame]308 <p>to get the linker flags. Usually this is done directly from the
309 Makefile as:</p>
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]310 <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 +0000[diff] [blame]313 <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 +0000[diff] [blame]318 <ul>
319 <li>Create a subdirectory, let's call it <code>myxml</code></li>
William M. Brack99906ad2005-01-09 17:02:42 +0000[diff] [blame]320 <li>unpack the libxml2 distribution into that subdirectory</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]321 <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 +0000[diff] [blame]328 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]329 <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 +0000[diff] [blame]336 respectively.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]337 <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 +0000[diff] [blame]341 <p><code>export PATH=/home/user/myxml/xmlinst/bin:$PATH</code></p>
342 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]343 <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 +0000[diff] [blame]346 <p><code>gcc `xml2-config --cflags --libs` -o test test.c</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]347 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 +0000[diff] [blame]352 </ul>
353 </li>
354
355 <p></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]356 <li><em>xmlDocDump() generates output on one line.</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]357 <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 +0000[diff] [blame]361 <ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]362 <li>the correct way is to generate those yourself too.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]363 <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 +0000[diff] [blame]372 </ol>
373 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]374 <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 +0000[diff] [blame]377 <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 +0000[diff] [blame]382 <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 +0000[diff] [blame]386 <p><em>so I did it as following;</em></p>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]387 <pre>xmlNodePtr pnode;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]388pnode=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 +0000[diff] [blame]393 <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 +0000[diff] [blame]402 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]403 <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 +0000[diff] [blame]408 href="upgrade.html">following the instructions</a>.</p>
409 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]410 <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 +0000[diff] [blame]413 <p>The source code you are using has been <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]414 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 +0000[diff] [blame]417 </li>
Daniel Veillard984e5692008-06-11 08:14:22 +0000[diff] [blame]418 <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 +0000[diff] [blame]423 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]424 <li><em>The example provided in the web page does not compile.</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]425 <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 +0000[diff] [blame]429 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]430 <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 +0000[diff] [blame]434 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]435 <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 +0000[diff] [blame]439 <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 +0000[diff] [blame]441 <li><a
Daniel Veillarda4f85b92009-03-25 10:45:20 +0000[diff] [blame]442 href="http://svn.gnome.org/viewvc/libxml2/trunk/">Browse
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]443 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 +0000[diff] [blame]445 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 +0000[diff] [blame]446 provide good examples of how to do things with the library.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]447 </ul>
448 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]449 <p></p>
450 <li><em>What about C++ ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]451 <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 +0000[diff] [blame]454 <p>There is however a C++ wrapper which may fulfill your needs:</p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]455 <ul>
456 <li>by Ari Johnson &lt;ari@btigate.com&gt;:
457 <p>Website: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]458 href="http://libxmlplusplus.sourceforge.net/">http://libxmlplusplus.sourceforge.net/</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]459 <p>Download: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]460 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 +0000[diff] [blame]461 </li>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]462 </ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]463 </li>
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]464 <li><em>How to validate a document a posteriori ?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]465 <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 +0000[diff] [blame]471 <pre>xmlDocPtr doc; /* your existing document */
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]472xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
473
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]474 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 +0000[diff] [blame]481 <li><em>So what is this funky "xmlChar" used all the time?</em>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]482 <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 +0000[diff] [blame]486 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]487 <li>etc ...</li>
488</ol>
489
490<p></p>
491
Daniel Veillard66f68e72003-08-18 16:39:51 +0000[diff] [blame]492<h2><a name="Documentat">Developer Menu</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]493
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]494<p>There are several on-line resources related to using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]495<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]496 <li>Use the <a href="search.php">search engine</a> to look up
497 information.</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]498 <li>Check the <a href="FAQ.html">FAQ.</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]499 <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 +0000[diff] [blame]505 <li><a href="examples/index.html">Code examples</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]506 <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 +0000[diff] [blame]508 <li>If you need to parse large files, check the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]509 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 +0800[diff] [blame]511 href="http://www.jamesh.id.au/articles/libxml-sax/libxml-sax.html">some nice
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]512 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]513 <li>George Lebl wrote <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]514 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 +0000[diff] [blame]516 <li>Check <a href="http://svn.gnome.org/viewvc/libxml2/trunk/TODO?view=markup">the TODO
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]517 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 +0000[diff] [blame]521 <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 +0000[diff] [blame]523</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]524
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]525<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]526
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]527<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 +0000[diff] [blame]533
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]534<p>For small problems you can try to get help on IRC, the #xml channel on
535irc.gnome.org (port 6667) usually have a few person subscribed which may help
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]536(but there is no guarantee and if a real issue is raised it should go on the
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]537mailing-list for archival).</p>
Daniel Veillard9582d6c2003-09-16 11:40:04 +0000[diff] [blame]538
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]539<p>There is also a mailing-list <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]540href="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 +0000[diff] [blame]547
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]548<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 +0000[diff] [blame]554a legal warning asking to not copy or redistribute freely the information
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]555they 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 +0000[diff] [blame]560information.</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]561
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]562<p>Check the following <strong><span style="color: #FF0000">before
563posting</span></strong>:</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]564<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]565 <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 +0000[diff] [blame]578</ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]579
Daniel Veillarda37aab82003-06-09 09:10:36 +0000[diff] [blame]580<p>Then send the bug with associated information to reproduce it to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]581href="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 +0000[diff] [blame]585
586<p>To <span style="color: #E50000">be really clear about support</span>:</p>
587<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]588 <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 +0000[diff] [blame]595 <li>There is <span style="color: #E50000">no guarantee of support</span>. If
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]596 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 +0000[diff] [blame]602</ul>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]603
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]604<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 +0000[diff] [blame]606
607<p>If you're looking for help, a quick look at <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]608href="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 +0000[diff] [blame]614
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]615<h2><a name="help">How to help</a></h2>
616
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]617<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 +0000[diff] [blame]619href="http://mail.gnome.org/archives/xml/">archives </a>and the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]620href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome bug
621database</a>:</p>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]622<ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]623 <li>Provide patches when you find problems.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]624 <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 +0000[diff] [blame]631 <li>Check the TODO file and try to close one of the items.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]632 <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 +0000[diff] [blame]636</ol>
637
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]638<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]639
Daniel Veillard688f6692004-03-26 10:57:38 +0000[diff] [blame]640<p>The latest versions of libxml2 can be found on the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]641href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a> server ( <a
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]642href="ftp://xmlsoft.org/libxml2/">FTP</a> and rsync are available), there are also
Daniel Veillard45e21e22009-08-20 19:40:03 +0200[diff] [blame]643mirrors (<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 +0000[diff] [blame]646href="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 +0200[diff] [blame]648packages installed to compile applications using libxml if using RPMs.)</p>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]649
650<p>You can find all the history of libxml(2) and libxslt releases in the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]651href="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 +0000[diff] [blame]654
655<p>Binary ports:</p>
656<ul>
Daniel Veillard45e21e22009-08-20 19:40:03 +0200[diff] [blame]657 <li>RPMs for x86_64 are available directly on <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]658 href="ftp://xmlsoft.org/libxml2/">xmlsoft.org</a>, the source RPM will compile on
Daniel Veillard45e21e22009-08-20 19:40:03 +0200[diff] [blame]659 any architecture supported.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]660 <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 +0200[diff] [blame]664 <li>OpenCSW provides <a
665 href="http://opencsw.org/packages/libxml2">Solaris
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]666 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 +0000[diff] [blame]670 <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 +0000[diff] [blame]672 <li>Bull provides precompiled <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]673 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 +0000[diff] [blame]675</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 +0000[diff] [blame]679
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]680<p><a name="Snapshot">Snapshot:</a></p>
681<ul>
Daniel Veillard45e21e22009-08-20 19:40:03 +0200[diff] [blame]682 <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 +0000[diff] [blame]684 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard9110ed62006-04-03 15:21:57 +0000[diff] [blame]685 href="ftp://xmlsoft.org/libxml2/libxml-docs.tar.gz">libxml-docs.tar.gz</a>.</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]686</ul>
687
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]688<p><a name="Contribs">Contributions:</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]689
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]690<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 +0000[diff] [blame]693href="python.html">bindings section</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]694
Daniel Veillard45e21e22009-08-20 19:40:03 +0200[diff] [blame]695<p>Libxml2 is also available from GIT:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]696<ul>
Daniel Veillarddde64082011-03-23 08:12:26 +0800[diff] [blame]697 <li><p>See <a href="http://git.gnome.org/browse/libxml2/">libxml2 Git web</a>.
Daniel Veillard45e21e22009-08-20 19:40:03 +0200[diff] [blame]698 To checkout a local tree use:</p>
699 <pre>git clone git://git.gnome.org/libxml2</pre>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]700 </li>
Daniel Veillarddde64082011-03-23 08:12:26 +0800[diff] [blame]701 <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 +0000[diff] [blame]703</ul>
704
Daniel Veillard78fed532004-10-09 19:44:48 +0000[diff] [blame]705<h2><a name="News">Releases</a></h2>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]706
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]707<p>The <a href="ChangeLog.html">change log</a> describes the recents commits
Daniel Veillard38bbd342012-09-11 15:00:08 +0800[diff] [blame]708to the <a href="http://git.gnome.org/browse/libxml2/">GIT</a> code base.</p>
Daniel Veillard2d908032004-08-10 10:16:36 +0000[diff] [blame]709
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]710<p>Here is the list of public releases:</p>
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]711
Daniel Veillarde38217a2013-05-10 15:40:13 +0800[diff] [blame]712<h3>2.9.1: Apr 19 2013</h3>
713<ul>
714 <li> Features:<br/>
715 Support for Python3 (Daniel Veillard),<br/>
716 Add xmlXPathSetContextNode and xmlXPathNodeEval (Alex Bligh)<br/>
717 </li>
718
719 <li> Documentation:<br/>
720 Add documentation for xmllint --xpath (Daniel Veillard),<br/>
721 Fix the URL of the SAX documentation from James (Daniel Veillard),<br/>
722 Fix spelling of "length". (Michael Wood)<br/>
723 </li>
724
725 <li> Portability:<br/>
726 Fix python bindings with versions older than 2.7 (Daniel Veillard),<br/>
727 rebuild docs:Makefile.am (Roumen Petrov),<br/>
728 elfgcchack.h after rebuild in doc (Roumen Petrov),<br/>
729 elfgcchack for buf module (Roumen Petrov),<br/>
730 Fix a uneeded and wrong extra link parameter (Daniel Veillard),<br/>
731 Few cleanup patches for Windows (Denis Pauk),<br/>
732 Fix rpmbuild --nocheck (Mark Salter),<br/>
733 Fix for win32/configure.js and WITH_THREAD_ALLOC (Daniel Richard),<br/>
734 Fix Broken multi-arch support in xml2-config (Daniel Veillard),<br/>
735 Fix a portability issue for GCC &lt; 3.4.0 (Daniel Veillard),<br/>
736 Windows build fixes (Daniel Richard),<br/>
737 Fix a thread portability problem (Friedrich Haubensak),<br/>
738 Downgrade autoconf requirement to 2.63 (Daniel Veillard)<br/>
739 </li>
740
741 <li> Bug Fixes:<br/>
742 Fix a linking error for python bindings (Daniel Veillard),<br/>
743 Fix a couple of return without value (Jüri Aedla),<br/>
744 Improve the hashing functions (Daniel Franke),<br/>
745 Improve handling of xmlStopParser() (Daniel Veillard),<br/>
746 Remove risk of lockup in dictionary initialization (Daniel Veillard),<br/>
747 Activate detection of encoding in external subset (Daniel Veillard),<br/>
748 Fix an output buffer flushing conversion bug (Mikhail Titov),<br/>
749 Fix an old bug in xmlSchemaValidateOneElement (Csaba László),<br/>
750 Fix configure cannot remove messages (Gilles Espinasse),<br/>
751 fix schema validation in combination with xsi:nil (Daniel Veillard),<br/>
752 xmlCtxtReadFile doesn't work with literal IPv6 URLs (Steve Wolf),<br/>
753 Fix a few problems with setEntityLoader (Alexey Neyman),<br/>
754 Detect excessive entities expansion upon replacement (Daniel Veillard),<br/>
755 Fix the flushing out of raw buffers on encoding conversions (Daniel,<br/>
756Veillard),<br/>
757 Fix some buffer conversion issues (Daniel Veillard),<br/>
758 When calling xmlNodeDump make sure we grow the buffer quickly (Daniel,<br/>
759Veillard),<br/>
760 Fix an error in the progressive DTD parsing code (Dan Winship),<br/>
761 xmllint should not load DTD by default when using the reader (Daniel,<br/>
762Veillard),<br/>
763 Try IBM-037 when looking for EBCDIC handlers (Petr Sumbera),<br/>
764 Fix potential out of bound access (Daniel Veillard),<br/>
765 Fix large parse of file from memory (Daniel Veillard),<br/>
766 Fix a bug in the nsclean option of the parser (Daniel Veillard),<br/>
767 Fix a regression in 2.9.0 breaking validation while streaming (Daniel,<br/>
768Veillard),<br/>
769 Remove potential calls to exit() (Daniel Veillard)<br/>
770 </li>
771
772 <li> Improvements:<br/>
773 Regenerated API, and testapi, rebuild documentation (Daniel Veillard),<br/>
774 Fix tree iterators broken by 2to3 script (Daniel Veillard),<br/>
775 update all tests for Python3 and Python2 (Daniel Veillard),<br/>
776 A few more fixes for python 3 affecting libxml2.py (Daniel Veillard),<br/>
777 Fix compilation on Python3 (Daniel Veillard),<br/>
778 Converting apibuild.py to python3 (Daniel Veillard),<br/>
779 First pass at starting porting to python3 (Daniel Veillard),<br/>
780 updated configure.in for python3 (Daniel Veillard),<br/>
781 Add support for xpathRegisterVariable in Python (Shaun McCance),<br/>
782 Added a regression tests from bug 694228 data (Daniel Veillard),<br/>
783 Cache presence of '&lt;' in entities content (Daniel Veillard),<br/>
784 Avoid extra processing on entities (Daniel Veillard),<br/>
785 Python binding for xmlRegisterInputCallback (Alexey Neyman),<br/>
786 Python bindings: DOM casts everything to xmlNode (Alexey Neyman),<br/>
787 Define LIBXML_THREAD_ALLOC_ENABLED via xmlversion.h (Tim Starling),<br/>
788 Adding streaming validation to runtest checks (Daniel Veillard),<br/>
789 Add a --pushsmall option to xmllint (Daniel Veillard)<br/>
790 </li>
791
792 <li> Cleanups:<br/>
793 Switched comment in file to UTF-8 encoding (Daniel Veillard),<br/>
794 Extend gitignore (Daniel Veillard),<br/>
795 Silent the new python test on input (Alexey Neyman),<br/>
796 Cleanup of a duplicate test (Daniel Veillard),<br/>
797 Cleanup on duplicate test expressions (Daniel Veillard),<br/>
798 Fix compiler warning after 153cf15905cf4ec080612ada6703757d10caba1e (Patrick,<br/>
799Gansterer),<br/>
800 Spec cleanups and a fix for multiarch support (Daniel Veillard),<br/>
801 Silence a clang warning (Daniel Veillard),<br/>
802 Cleanup the Copyright to be pure MIT Licence wording (Daniel Veillard),<br/>
803 rand_seed should be static in dict.c (Wouter Van Rooy),<br/>
804 Fix typos in parser comments (Jan Pokorný)<br/>
805 </li>
806</ul>
Daniel Veillard38bbd342012-09-11 15:00:08 +0800[diff] [blame]807<h3>2.9.0: Sep 11 2012</h3>
808<ul>
809 <li> Features:<br/>
810 A few new API entry points,<br/>
811 More resilient push parser mode,<br/>
812 A lot of portability improvement,<br/>
813 Faster XPath evaluation<br/>
814 </li>
815
816 <li> Documentation:<br/>
817 xml2-config.1 markup error (Christian Weisgerber),<br/>
818 libxml(3) manpage typo fix (John Bradshaw),<br/>
819 More cleanups to the documentation part of libxml2 (Daniel Richard G)<br/>
820 </li>
821
822 <li> Portability:<br/>
823 Bug 676544 - fails to build with --without-sax1 (Akira TAGOH),<br/>
824 fix builds not having stdint.h (Rob Richards),<br/>
825 GetProcAddressA is available only on WinCE (Daniel Veillard),<br/>
826 More updates and cleanups on autotools and Makefiles (Daniel Richard G),<br/>
827 More changes for Win32 compilation (Eric Zurcher),<br/>
828 Basic changes for Win32 builds of release 2.9.0: compile buf.c (Eric Zurcher),<br/>
829 Bundles all generated files for python into the distribution (Daniel Richard G),<br/>
830 Fix compiler warnings of wincecompat.c (Patrick Gansterer),<br/>
831 Fix non __GNUC__ build (Patrick Gansterer),<br/>
832 Fix windows unicode build (Patrick Gansterer),<br/>
833 clean redefinition of {v}snprintf in C-source (Roumen Petrov),<br/>
834 use xmlBuf... if DEBUG_INPUT is defined (Roumen Petrov),<br/>
835 fix runtests to use pthreads support for various Unix platforms (Daniel Richard G),<br/>
836 Various "make distcheck" and portability fixups 2nd part (Daniel Richard G),<br/>
837 Various "make distcheck" and portability fixups (Daniel Richard G),<br/>
838 Fix compilation on older Visual Studio (Daniel Veillard)<br/>
839 </li>
840
841 <li> Bug Fixes:<br/>
842 Change the XPath code to percolate allocation errors (Daniel Veillard),<br/>
843 Fix reuse of xmlInitParser (Daniel Veillard),<br/>
844 Fix potential crash on entities errors (Daniel Veillard),<br/>
845 initialize var (Rob Richards),<br/>
846 Fix the XPath arity check to also check the XPath stack limits (Daniel Veillard),<br/>
847 Fix problem with specific and generic error handlers (Pietro Cerutti),<br/>
848 Avoid a potential infinite recursion (Daniel Veillard),<br/>
849 Fix an XSD error when generating internal automata (Daniel Veillard),<br/>
850 Patch for xinclude of text using multibyte characters (Vitaly Ostanin),<br/>
851 Fix a segfault on XSD validation on pattern error (Daniel Veillard),<br/>
852 Fix missing xmlsave.h module which was ignored in recent builds (Daniel Veillard),<br/>
853 Add a missing element check (Daniel Veillard),<br/>
854 Adding various checks on node type though the API (Daniel Veillard),<br/>
855 Namespace nodes can't be unlinked with xmlUnlinkNode (Daniel Veillard),<br/>
856 Fix make dist to include new private header files (Daniel Veillard),<br/>
857 More fixups on the push parser behaviour (Daniel Veillard),<br/>
858 Strengthen behaviour of the push parser in problematic situations (Daniel Veillard),<br/>
859 Enforce XML_PARSER_EOF state handling through the parser (Daniel Veillard),<br/>
860 Fixup limits parser (Daniel Veillard),<br/>
861 Do not fetch external parsed entities (Daniel Veillard),<br/>
862 Fix an error in previous commit (Aron Xu),<br/>
863 Fix entities local buffers size problems (Daniel Veillard),<br/>
864 Fix parser local buffers size problems (Daniel Veillard),<br/>
865 Fix a failure to report xmlreader parsing failures (Daniel Veillard)<br/>
866 </li>
867
868 <li> Improvements:<br/>
869 Keep libxml2.syms when running "make distclean" (Daniel Veillard),<br/>
870 Allow to set the quoting character of an xmlWriter (Csaba Raduly),<br/>
871 Keep non-significant blanks node in HTML parser (Daniel Veillard),<br/>
872 Add a forbidden variable error number and message to XPath (Daniel Veillard),<br/>
873 Support long path names on WNT (Michael Stahl),<br/>
874 Improve HTML escaping of attribute on output (Daniel Veillard),<br/>
875 Handle ICU_LIBS as LIBADD, not LDFLAGS to prevent linking errors (Arfrever Frehtes Taifersar Arahesis),<br/>
876 Switching XPath node sorting to Timsort (Vojtech Fried),<br/>
877 Optimizing '//' in XPath expressions (Nick Wellnhofer),<br/>
878 Expose xmlBufShrink in the public tree API (Daniel Veillard),<br/>
879 Visible HTML elements close the head tag (Conrad Irwin),<br/>
880 Fix file and line report for XSD SAX and reader streaming validation (Daniel Veillard),<br/>
881 Fix const qualifyer to definition of xmlBufferDetach (Daniel Veillard),<br/>
882 minimize use of HAVE_CONFIG_H (Roumen Petrov),<br/>
883 fixup regression in Various "make distcheck" and portability fixups (Roumen Petrov),<br/>
884 Add support for big line numbers in error reporting (Daniel Veillard),<br/>
885 Avoid using xmlBuffer for serialization (Daniel Veillard),<br/>
886 Improve compatibility between xmlBuf and xmlBuffer (Daniel Veillard),<br/>
887 Provide new accessors for xmlOutputBuffer (Daniel Veillard),<br/>
888 Improvements for old buffer compatibility (Daniel Veillard),<br/>
889 Expand the limit test program (Daniel Veillard),<br/>
890 Improve error reporting on parser errors (Daniel Veillard),<br/>
891 Implement some default limits in the XPath module (Daniel Veillard),<br/>
892 Introduce some default parser limits (Daniel Veillard),<br/>
893 Cleanups and new limit APIs for dictionaries (Daniel Veillard),<br/>
894 Fixup for buf.c (Daniel Veillard),<br/>
895 Cleanup URI module memory allocation code (Daniel Veillard),<br/>
896 Extend testlimits (Daniel Veillard),<br/>
897 More avoid quadratic behaviour (Daniel Veillard),<br/>
898 Impose a reasonable limit on PI size (Daniel Veillard),<br/>
899 first version of testlimits new test (Daniel Veillard),<br/>
900 Avoid quadratic behaviour in some push parsing cases (Daniel Veillard),<br/>
901 Impose a reasonable limit on comment size (Daniel Veillard),<br/>
902 Impose a reasonable limit on attribute size (Daniel Veillard),<br/>
903 Harden the buffer code and make it more compatible (Daniel Veillard),<br/>
904 More cleanups for input/buffers code (Daniel Veillard),<br/>
905 Cleanup function xmlBufResetInput(),<br/> to set input from Buffer (Daniel Veillard)
906 Swicth the test program for characters to new input buffers (Daniel Veillard),<br/>
907 Convert the HTML tree module to the new buffers (Daniel Veillard),<br/>
908 Convert of the HTML parser to new input buffers (Daniel Veillard),<br/>
909 Convert the writer to new output buffer and save APIs (Daniel Veillard),<br/>
910 Convert XMLReader to the new input buffers (Daniel Veillard),<br/>
911 New saving functions using xmlBuf and conversion (Daniel Veillard),<br/>
912 Provide new xmlBuf based saving functions (Daniel Veillard),<br/>
913 Convert XInclude to the new input buffers (Daniel Veillard),<br/>
914 Convert catalog code to the new input buffers (Daniel Veillard),<br/>
915 Convert C14N to the new Input buffer (Daniel Veillard),<br/>
916 Convert xmlIO.c to the new input and output buffers (Daniel Veillard),<br/>
917 Convert XML parser to the new input buffers (Daniel Veillard),<br/>
918 Incompatible change to the Input and Output buffers (Daniel Veillard),<br/>
919 Adding new encoding function to deal with the new structures (Daniel Veillard),<br/>
920 Convert XPath to xmlBuf (Daniel Veillard),<br/>
921 Adding a new buf module for buffers (Daniel Veillard),<br/>
922 Memory error within SAX2 reuse common framework (Daniel Veillard),<br/>
923 Fix xmllint --xpath node initialization (Daniel Veillard)<br/>
924 </li>
925
926 <li> Cleanups:<br/>
927 Various cleanups to avoid compiler warnings (Daniel Veillard),<br/>
928 Big space and tab cleanup (Daniel Veillard),<br/>
929 Followup to LibXML2 docs/examples cleanup patch (Daniel Veillard),<br/>
930 Second round of cleanups for LibXML2 docs/examples (Daniel Richard),<br/>
931 Remove all .cvsignore as they are not used anymore (Daniel Veillard),<br/>
932 Fix a Timsort function helper comment (Daniel Veillard),<br/>
933 Small cleanup for valgrind target (Daniel Veillard),<br/>
934 Patch for portability of latin characters in C files (Daniel Veillard),<br/>
935 Cleanup some of the parser code (Daniel Veillard),<br/>
936 Fix a variable name in comment (Daniel Veillard),<br/>
937 Regenerated testapi.c (Daniel Veillard),<br/>
938 Regenerating docs and API files (Daniel Veillard),<br/>
939 Small cleanup of unused variables in test (Daniel Veillard),<br/>
940 Expand .gitignore with more files (Daniel Veillard)<br/>
941 </li>
942</ul>
Daniel Veillardc943f702012-05-23 17:10:59 +0800[diff] [blame]943<h3>2.8.0: May 23 2012</h3>
944<ul>
945 <li>Features:
Daniel Veillard38bbd342012-09-11 15:00:08 +0800[diff] [blame]946 add lzma compression support (Anders F Bjorklund)
Daniel Veillardc943f702012-05-23 17:10:59 +0800[diff] [blame]947 </li>
948
949 <li>Documentation:
950 xmlcatalog: Add uri and delegateURI to possible add types in man page. (Ville Skyttä),
951 Update README.tests (Daniel Veillard),
952 URI handling code is not OOM resilient (Daniel Veillard),
953 Fix an error in comment (Daniel Veillard),
954 Fixed bug #617016 (Daniel Mustieles),
955 Fixed two typos in the README document (Daniel Neel),
956 add generated html files (Anders F Bjorklund),
957 Clarify the need to use xmlFreeNode after xmlUnlinkNode (Daniel Veillard),
958 Improve documentation a bit (Daniel Veillard),
959 Updated URL for lxml python bindings (Daniel Veillard)
960 </li>
961
962 <li>Portability:
963 Restore code for Windows compilation (Daniel Veillard),
964 Remove git error message during configure (Christian Dywan),
965 xmllint: Build fix for endTimer if !defined(HAVE_GETTIMEOFDAY) (Patrick R. Gansterer),
966 remove a bashism in confgure.in (John Hein),
967 undef ERROR if already defined (Patrick R. Gansterer),
968 Fix library problems with mingw-w64 (Michael Cronenworth),
969 fix windows build. ifdef addition from bug 666491 makes no sense (Rob Richards),
970 prefer native threads on win32 (Sam Thursfield),
971 Allow to compile with Visual Studio 2010 (Thomas Lemm),
972 Fix mingw's snprintf configure check (Andoni Morales),
973 fixed a 64bit big endian issue (Marcus Meissner),
974 Fix portability failure if netdb.h lacks NO_ADDRESS (Daniel Veillard),
975 Fix windows build from lzma addition (Rob Richards),
976 autogen: Only check for libtoolize (Colin Walters),
977 Fix the Windows build files (Patrick von Reth),
978 634846 Remove a linking option breaking Windows VC10 (Daniel Veillard),
979 599241 fix an initialization problem on Win64 (Andrew W. Nosenko),
980 fix win build (Rob Richards)
981 </li>
982
983 <li>Bug fixes:
984 Part for rand_r checking missing (Daniel Veillard),
985 Cleanup on randomization (Daniel Veillard),
986 Fix undefined reference in python module (Pacho Ramos),
987 Fix a race in xmlNewInputStream (Daniel Veillard),
988 Fix weird streaming RelaxNG errors (Noam),
989 Fix various bugs in new code raised by the API checking (Daniel Veillard),
990 Fix various problems with "make dist" (Daniel Veillard),
991 Fix a memory leak in the xzlib code (Daniel Veillard),
992 HTML parser error with &lt;noscript&gt; in the &lt;head&gt; (Denis Pauk),
993 XSD: optional element in complex type extension (Remi Gacogne),
994 Fix html serialization error and htmlSetMetaEncoding() (Daniel Veillard),
995 Fix a wrong return value in previous patch (Daniel Veillard),
996 Fix an uninitialized variable use (Daniel Veillard),
997 Fix a compilation problem with --minimum (Brandon Slack),
998 Remove redundant and ungarded include of resolv.h (Daniel Veillard),
999 xinclude with parse="text" does not use the entity loader (Shaun McCance),
1000 Allow to parse 1 byte HTML files (Denis Pauk),
1001 Patch that fixes the skipping of the HTML_PARSE_NOIMPLIED flag (Martin Schröder),
1002 Avoid memory leak if xmlParserInputBufferCreateIO fails (Lin Yi-Li),
1003 Prevent an infinite loop when dumping a node with encoding problems (Timothy Elliott),
1004 xmlParseNodeInContext problems with an empty document (Tim Elliott),
1005 HTML element position is not detected propperly (Pavel Andrejs),
1006 Fix an off by one pointer access (Jüri Aedla),
1007 Try to fix a problem with entities in SAX mode (Daniel Veillard),
1008 Fix a crash with xmllint --path on empty results (Daniel Veillard),
1009 Fixed bug #667946 (Daniel Mustieles),
1010 Fix a logic error in Schemas Component Constraints (Ryan Sleevi),
1011 Fix a wrong enum type use in Schemas Types (Nico Weber),
1012 Fix SAX2 builder in case of undefined attributes namespace (Daniel Veillard),
1013 Fix SAX2 builder in case of undefined element namespaces (Daniel Veillard),
1014 fix reference to STDOUT_FILENO on MSVC (Tay Ray Chuan),
1015 fix a pair of possible out of array char references (Daniel Veillard),
1016 Fix an allocation error when copying entities (Daniel Veillard),
1017 Make sure the parser returns when getting a Stop order (Chris Evans),
1018 Fix some potential problems on reallocation failures(parser.c) (Xia Xinfeng),
1019 Fix a schema type duration comparison overflow (Daniel Veillard),
1020 Fix an unimplemented part in RNG value validation (Daniel Veillard),
1021 Fix missing error status in XPath evaluation (Daniel Veillard),
1022 Hardening of XPath evaluation (Daniel Veillard),
1023 Fix an off by one error in encoding (Daniel Veillard),
1024 Fix RELAX NG include bug #655288 (Shaun McCance),
1025 Fix XSD validation bug #630130 (Toyoda Eizi),
1026 Fix some potential problems on reallocation failures (Chris Evans),
1027 __xmlRaiseError: fix use of the structured callback channel (Dmitry V. Levin),
1028 __xmlRaiseError: fix the structured callback channel's data initialization (Dmitry V. Levin),
1029 Fix memory corruption when xmlParseBalancedChunkMemoryInternal is called from xmlParseBalancedChunk (Rob Richards),
1030 Small fix for previous commit (Daniel Veillard),
1031 Fix a potential freeing error in XPath (Daniel Veillard),
1032 Fix a potential memory access error (Daniel Veillard),
1033 Reactivate the shared library versionning script (Daniel Veillard)
1034 </li>
1035
1036 <li>Improvements:
1037 use mingw C99 compatible functions {v}snprintf instead those from MSVC runtime (Roumen Petrov),
1038 New symbols added for the next release (Daniel Veillard),
1039 xmlTextReader bails too quickly on error (Andy Lutomirski),
1040 Use a hybrid allocation scheme in xmlNodeSetContent (Conrad Irwin),
1041 Use buffers when constructing string node lists. (Conrad Irwin),
1042 Add HTML parser support for HTML5 meta charset encoding declaration (Denis Pauk),
1043 wrong message for double hyphen in comment XML error (Bryan Henderson),
1044 Fix "make tst" to grab lzma lib too (Daniel Veillard),
1045 Add "whereis" command to xmllint shell (Ryan),
1046 Improve xmllint shell (Ryan),
1047 add function xmlTextReaderRelaxNGValidateCtxt() (Noam Postavsky),
1048 Add --system support to autogen.sh (Daniel Veillard),
1049 Add hash randomization to hash and dict structures (Daniel Veillard),
1050 included xzlib in dist (Anders F Bjorklund),
1051 move xz/lzma helpers to separate included files (Anders F Bjorklund),
1052 add generated devhelp files (Anders F Bjorklund),
1053 add XML_WITH_LZMA to api (Anders F Bjorklund),
1054 autogen.sh: Honor NOCONFIGURE environment variable (Colin Walters),
1055 Improve the error report on undefined REFs (Daniel Veillard),
1056 Add exception for new W3C PI xml-model (Daniel Veillard),
1057 Add options to ignore the internal encoding (Daniel Veillard),
1058 testapi: use the right type for the check (Stefan Kost),
1059 various: handle return values of write calls (Stefan Kost),
1060 testWriter: xmlTextWriterWriteFormatElement wants an int instead of a long int (Stefan Kost),
1061 runxmlconf: update to latest testsuite version (Stefan Kost),
1062 configure: add -Wno-long-long to CFLAGS (Stefan Kost),
1063 configure: support silent automake rules if possible (Stefan Kost),
1064 xmlmemory: add a cast as size_t has no portable printf modifier (Stefan Kost),
1065 __xmlRaiseError: remove redundant schannel initialization (Dmitry V. Levin),
1066 __xmlRaiseError: do cheap code check early (Dmitry V. Levin)
1067 </li>
1068
1069 <li>Cleanups:
1070 Cleanups before 2.8.0-rc2 (Daniel Veillard),
1071 Avoid an extra operation (Daniel Veillard),
1072 Remove vestigial de-ANSI-fication support. (Javier Jardón),
1073 autogen.sh: Fix typo (Javier Jardón),
1074 Do not use unsigned but unsigned int (Daniel Veillard),
1075 Remove two references to u_short (Daniel Veillard),
1076 Fix -Wempty-body warning from clang (Nico Weber),
1077 Cleanups of lzma support (Daniel Veillard),
1078 Augment the list of ignored files (Daniel Veillard),
1079 python: remove unused variable (Stefan Kost),
1080 python: flag two unused args (Stefan Kost),
1081 configure: acconfig.h is deprecated since autoconf-2.50 (Stefan Kost),
1082 xpath: remove unused variable (Stefan Kost)
1083 </li>
1084</ul>
Daniel Veillard4c2e7c62010-11-04 18:35:57 +0100[diff] [blame]1085<h3>2.7.8: Nov 4 2010</h3>
1086<ul>
1087 <li> Features:
1088 480323 add code to plug in ICU converters by default (Giuseppe Iuculano),
1089 Add xmlSaveOption XML_SAVE_WSNONSIG (Adam Spragg)
1090 </li>
1091 <li> Documentation:
1092 Fix devhelp documentation installation (Mike Hommey),
1093 Fix web site encoding problems (Daniel Veillard),
1094 Fix a couple of typo in HTML parser error messages (Michael Day),
1095 Forgot to update the news page for 0.7.7 (Daniel Veillard)
1096 </li>
1097 <li> Portability:
1098 607273 Fix python detection on MSys/Windows (LRN),
1099 614087 Fix Socket API usage to allow Windows64 compilation (Ozkan Sezer),
1100 Fix compilation with Clang (Koop Mast),
1101 Fix Win32 build (Rob Richards)
1102 </li>
1103 <li> Bug Fixes:
1104 595789 fix a remaining potential Solaris problem (Daniel Veillard),
1105 617468 fix progressive HTML parsing with style using "'" (Denis Pauk),
1106 616478 Fix xmllint shell write command (Gwenn Kahz),
1107 614005 Possible erroneous HTML parsing on unterminated script (Pierre Belzile),
1108 627987 Fix XSD IDC errors in imported schemas (Jim Panetta),
1109 629325 XPath rounding errors first cleanup (Phil Shafer),
1110 630140 fix iso995x encoding error (Daniel Veillard),
1111 make sure htmlCtxtReset do reset the disableSAX field (Daniel Veillard),
1112 Fix a change of semantic on XPath preceding and following axis (Daniel Veillard),
1113 Fix a potential segfault due to weak symbols on pthreads (Mike Hommey),
1114 Fix a leak in XPath compilation (Daniel Veillard),
1115 Fix the semantic of XPath axis for namespace/attribute context nodes (Daniel Veillard),
1116 Avoid a descriptor leak in catalog loading code (Carlo Bramini),
1117 Fix a small bug in XPath evaluation code (Marius Wachtler),
1118 Fix handling of XML-1.0 XML namespace declaration (Daniel Veillard),
1119 Fix errors in XSD double validation check (Csaba Raduly),
1120 Fix handling of apos in URIs (Daniel Veillard),
1121 xmlTextReaderReadOuterXml should handle DTD (Rob Richards),
1122 Autogen.sh needs to create m4 directory (Rob Richards)
1123 </li>
1124 <li> Improvements:
1125 606592 update language ID parser to RFC 5646 (Daniel Veillard),
1126 Sort python generated stubs (Mike Hommey),
1127 Add an HTML parser option to avoid a default doctype (Daniel Veillard)
1128 </li>
1129 <li> Cleanups:
1130 618831 don't ship generated files in git (Adrian Bunk),
1131 Switch from the obsolete mkinstalldirs to AC_PROG_MKDIR_P (Adrian Bunk),
1132 Various cleanups on encoding handling (Daniel Veillard),
1133 Fix xmllint to use format=1 for default formatting (Adam Spragg),
1134 Force _xmlSaveCtxt.format to be 0 or 1 (Adam Spragg),
1135 Cleanup encoding pointer comparison (Nikolay Sivov),
1136 Small code cleanup on previous patch (Daniel Veillard)
1137 </li>
1138</ul>
Daniel Veillardf61ba8d2010-03-25 10:54:32 +0100[diff] [blame]1139<h3>2.7.7: Mar 15 2010</h3>
1140<ul>
1141 <li> Improvements:
1142 Adding a --xpath option to xmllint (Daniel Veillard),
1143 Make HTML parser non-recursive (Eugene Pimenov)
1144 </li>
1145 <li> Portability:
1146 relaxng.c: cast to allow compilation with sun studio 11 (Ben Walton),
1147 Fix build failure on Sparc solaris (Roumen Petrov),
1148 use autoreconf in autogen.sh (Daniel Veillard),
1149 Fix build with mingw (Roumen Petrov),
1150 Upgrade some of the configure and autogen (Daniel Veillard),
1151 Fix relaxNG tests in runtest for Windows runtest.c: initialize ret (Rob Richards),
1152 Fix a const warning in xmlNodeSetBase (Martin Trappel),
1153 Fix python generator to not use deprecated xmllib (Daniel Veillard),
1154 Update some automake files (Daniel Veillard),
1155 598785 Fix nanohttp on Windows (spadix)
1156 </li>
1157 <li> Bug Fixes:
1158 libxml violates the zlib interface and crashes (Mark Adler),
1159 Fix broken escape behaviour in regexp ranges (Daniel Veillard),
1160 Fix missing win32 libraries in libxml-2.0.pc (Volker Grabsch),
1161 Fix detection of python linker flags (Daniel Macks),
1162 fix build error in libxml2/python (Paul Smith),
1163 ChunkParser: Incorrect decoding of small xml files (Raul Hudea),
1164 htmlCheckEncoding doesn't update input-end after shrink (Eugene Pimenov),
1165 Fix a missing #ifdef (Daniel Veillard),
1166 Fix encoding selection for xmlParseInNodeContext (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1167 xmlPreviousElementSibling mistake (François Delyon),
Daniel Veillardf61ba8d2010-03-25 10:54:32 +0100[diff] [blame]1168 608773 add a missing check in xmlGROW (Daniel Veillard),
1169 Fix xmlParseInNodeContext for HTML content (Daniel Veillard),
1170 Fix lost namespace when copying node * tree.c: reconcile namespace if not found (Rob Richards),
1171 Fix some missing commas in HTML element lists (Eugene Pimenov),
1172 Correct variable type to unsigned (Nikolay Sivov),
1173 Recognize ID attribute in HTML without DOCTYPE (Daniel Veillard),
1174 Fix memory leak in xmlXPathEvalExpression() (Martin),
1175 Fix an init bug in global.c (Kai Henning),
1176 Fix xmlNodeSetBase() comment (Daniel Veillard),
1177 Fix broken escape behaviour in regexp ranges (Daniel Veillard),
1178 Don't give default HTML boolean attribute values in parser (Daniel Veillard),
1179 xmlCtxtResetLastError should reset ctxt-errNo (Daniel Veillard)
1180 </li>
1181 <li> Cleanups:
1182 Cleanup a couple of weirdness in HTML parser (Eugene Pimenov)
1183 </li>
1184</ul>
Daniel Veillard96bb7402009-10-06 18:38:15 +0200[diff] [blame]1185<h3>2.7.6: Oct 6 2009</h3>
1186<ul>
1187 <li> Bug Fixes:
1188 Restore thread support in default configuration (Andrew W. Nosenko),
1189 URI with no path parsing problem (Daniel Veillard),
1190 Minor patch for conditional defines in threads.c (Eric Zurcher)
1191 </li>
1192</ul>
Daniel Veillard7a896ce2009-09-24 18:38:57 +0200[diff] [blame]1193<h3>2.7.5: Sep 24 2009</h3>
1194<ul>
1195 <li> Bug Fixes:
1196 Restore behavior of --with-threads without argument (Andrew W. Nosenko),
1197 Fix memory leak when doc is NULL (Rob Richards),
1198 595792 fixing a RelaxNG bug introduced in 2.7.4 (Daniel Veillard),
1199 Fix a Relaxng bug raised by libvirt test suite (Daniel Veillard),
1200 Fix a parsing problem with little data at startup (Daniel Veillard),
1201 link python module with python library (Frederic Crozat),
1202 594874 Forgot an fclose in xmllint (Daniel Veillard)
1203 </li>
1204 <li> Cleanup:
1205 Adding symbols.xml to EXTRA_DIST (Daniel Veillard)
1206 </li>
1207</ul>
Daniel Veillard29341682009-09-10 18:23:39 +0200[diff] [blame]1208<h3>2.7.4: Sep 10 2009</h3>
1209<ul>
1210 <li>Improvements:
1211 Switch to GIT (GNOME),
1212 Add symbol versioning to libxml2 shared libs (Daniel Veillard)
1213 </li>
1214 <li>Portability:
1215 593857 try to work around thread pbm MinGW 4.4 (Daniel Veillard),
1216 594250 rename ATTRIBUTE_ALLOC_SIZE to avoid clashes (Daniel Veillard),
1217 Fix Windows build * relaxng.c: fix windows build (Rob Richards),
1218 Fix the globals.h to use XMLPUBFUN (Paul Smith),
1219 Problem with extern extern in header (Daniel Veillard),
1220 Add -lnetwork for compiling on Haiku (Scott McCreary),
1221 Runtest portability patch for Solaris (Tim Rice),
1222 Small patch to accomodate the Haiku OS (Scott McCreary),
1223 584605 package VxWorks folder in the distribution (Daniel Veillard),
1224 574017 Realloc too expensive on most platform (Daniel Veillard),
1225 Fix windows build (Rob Richards),
1226 545579 doesn't compile without schema support (Daniel Veillard),
1227 xmllint use xmlGetNodePath when not compiled in (Daniel Veillard),
1228 Try to avoid __imp__xmlFree link trouble on msys (Daniel Veillard),
1229 Allow to select the threading system on Windows (LRN),
1230 Fix Solaris binary links, cleanups (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1231 Bug 571059 – MSVC doesn't work with the bakefile (Intron),
Daniel Veillard29341682009-09-10 18:23:39 +0200[diff] [blame]1232 fix ATTRIBUTE_PRINTF header clash (Belgabor and Mike Hommey),
1233 fixes for Borland/CodeGear/Embarcadero compilers (Eric Zurcher)
1234 </li>
1235 <li>Documentation:
1236 544910 typo: "renciliateNs" (Leonid Evdokimov),
1237 Add VxWorks to list of OSes (Daniel Veillard),
1238 Regenerate the documentation and update for git (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1239 560524 ¿ xmlTextReaderLocalName description (Daniel Veillard),
Daniel Veillard29341682009-09-10 18:23:39 +0200[diff] [blame]1240 Added sponsoring by AOE media for the server (Daniel Veillard),
1241 updated URLs for GNOME (Vincent Lefevre),
1242 more warnings about xmlCleanupThreads and xmlCleanupParser (Daniel Veillard)
1243 </li>
1244 <li>Bug fixes:
1245 594514 memory leaks - duplicate initialization (MOD),
1246 Wrong block opening in htmlNodeDumpOutputInternal (Daniel Veillard),
1247 492317 Fix Relax-NG validation problems (Daniel Veillard),
1248 558452 fight with reg test and error report (Daniel Veillard),
1249 558452 RNG compilation of optional multiple child (Daniel Veillard),
1250 579746 XSD validation not correct / nilable groups (Daniel Veillard),
1251 502960 provide namespace stack when parsing entity (Daniel Veillard),
1252 566012 part 2 fix regresion tests and push mode (Daniel Veillard),
1253 566012 autodetected encoding and encoding conflict (Daniel Veillard),
1254 584220 xpointer(/) and xinclude problems (Daniel Veillard),
1255 587663 Incorrect Attribute-Value Normalization (Daniel Veillard),
1256 444994 HTML chunked failure for attribute with &lt;&gt; (Daniel Veillard),
1257 Fix end of buffer char being split in XML parser (Daniel Veillard),
1258 Non ASCII character may be split at buffer end (Adiel Mittmann),
1259 440226 Add xmlXIncludeProcessTreeFlagsData API (Stefan Behnel),
1260 572129 speed up parsing of large HTML text nodes (Markus Kull),
1261 Fix HTML parsing with 0 character in CDATA (Daniel Veillard),
1262 Fix SetGenericErrorFunc and SetStructured clash (Wang Lam),
1263 566012 Incomplete EBCDIC parsing support (Martin Kogler),
1264 541335 HTML avoid creating 2 head or 2 body element (Daniel Veillard),
1265 541237 error correcting missing end tags in HTML (Daniel Veillard),
1266 583439 missing line numbers in push mode (Daniel Veillard),
1267 587867 xmllint --html --xmlout serializing as HTML (Daniel Veillard),
1268 559501 avoid select and use poll for nanohttp (Raphael Prevost),
1269 559410 - Regexp bug on (...)? constructs (Daniel Veillard),
1270 Fix a small problem on previous HTML parser patch (Daniel Veillard),
1271 592430 - HTML parser runs into endless loop (Daniel Veillard),
1272 447899 potential double free in xmlFreeTextReader (Daniel Veillard),
1273 446613 small validation bug mixed content with NS (Daniel Veillard),
1274 Fix the problem of revalidating a doc with RNG (Daniel Veillard),
1275 Fix xmlKeepBlanksDefault to not break indent (Nick Wellnhofer),
1276 512131 refs from externalRef part need to be added (Daniel Veillard),
1277 512131 crash in xmlRelaxNGValidateFullElement (Daniel Veillard),
1278 588441 allow '.' in HTML Names even if invalid (Daniel Veillard),
1279 582913 Fix htmlSetMetaEncoding() to be nicer (Daniel Veillard),
1280 579317 Try to find the HTML encoding information (Daniel Veillard),
1281 575875 don't output charset=html (Daniel Veillard),
1282 571271 fix semantic of xsd:all with minOccurs=0 (Daniel Veillard),
1283 570702 fix a bug in regexp determinism checking (Daniel Veillard),
1284 567619 xmlValidateNotationUse missing param test (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1285 574393 ¿ utf-8 filename magic for compressed files (Hans Breuer),
Daniel Veillard29341682009-09-10 18:23:39 +0200[diff] [blame]1286 Fix a couple of problems in the parser (Daniel Veillard),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1287 585505 ¿ Document ids and refs populated by XSD (Wayne Jensen),
Daniel Veillard29341682009-09-10 18:23:39 +0200[diff] [blame]1288 582906 XSD validating multiple imports of the same schema (Jason Childs),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1289 Bug 582887 ¿ problems validating complex schemas (Jason Childs),
1290 Bug 579729 ¿ fix XSD schemas parsing crash (Miroslav Bajtos),
1291 576368 ¿ htmlChunkParser with special attributes (Jiri Netolicky),
1292 Bug 565747 ¿ relax anyURI data character checking (Vincent Lefevre),
Daniel Veillard29341682009-09-10 18:23:39 +0200[diff] [blame]1293 Preserve attributes of include start on tree copy (Petr Pajas),
1294 Skip silently unrecognized XPointer schemes (Jakub Wilk),
1295 Fix leak on SAX1, xmllint --sax1 option and debug (Daniel Veillard),
1296 potential NULL dereference on non-glibc (Jim Meyering),
1297 Fix an XSD validation crash (Daniel Veillard),
1298 Fix a regression in streaming entities support (Daniel Veillard),
1299 Fix a couple of ABI issues with C14N 1.1 (Aleksey Sanin),
1300 Aleksey Sanin support for c14n 1.1 (Aleksey Sanin),
1301 reader bug fix with entities (Daniel Veillard),
1302 use options from current parser ctxt for external entities (Rob Richards),
1303 581612 use %s to printf strings (Christian Persch),
1304 584605 change the threading initialization sequence (Igor Novoseltsev),
1305 580705 keep line numbers in HTML parser (Aaron Patterson),
1306 581803 broken HTML table attributes init (Roland Steiner),
1307 do not set error code in xmlNsWarn (Rob Richards),
1308 564217 fix structured error handling problems,
1309 reuse options from current parser for entities (Rob Richards),
1310 xmlXPathRegisterNs should not allow enpty prefixes (Daniel Veillard),
1311 add a missing check in xmlAddSibling (Kris Breuker),
1312 avoid leaks on errors (Jinmei Tatuya)
1313 </li>
1314 <li>Cleanup:
1315 Chasing dead assignments reported by clang-scan (Daniel Veillard),
1316 A few more safety cleanup raised by scan (Daniel Veillard),
1317 Fixing assorted potential problems raised by scan (Daniel Veillard),
1318 Potential uninitialized arguments raised by scan (Daniel Veillard),
1319 Fix a bunch of scan 'dead increments' and cleanup (Daniel Veillard),
1320 Remove a pedantic warning (Daniel Veillard),
1321 555833 always use rm -f in uninstall-local (Daniel Veillard),
1322 542394 xmlRegisterOutputCallbacks MAX_INPUT_CALLBACK (Daniel Veillard),
1323 Autoregenerate libxml2.syms automated checkings (Daniel Veillard),
1324 Make xmlRecoverDoc const (Martin Trappel) (Daniel Veillard),
1325 Both args of xmlStrcasestr are const (Daniel Veillard),
1326 hide the nbParse* variables used for debugging (Mike Hommey),
1327 570806 changed include of config.h (William M. Brack),
1328 cleanups and error reports when xmlTextWriterVSprintf fails (Jinmei Tatuya)
1329 </li>
1330</ul>
Daniel Veillard97ff9b32009-01-18 21:43:30 +0000[diff] [blame]1331<h3>2.7.3: Jan 18 2009</h3>
1332<ul>
1333 <li>Build fix: fix build when HTML support is not included.</li>
1334 <li>Bug fixes: avoid memory overflow in gigantic text nodes,
1335 indentation problem on the writed (Rob Richards),
1336 xmlAddChildList pointer problem (Rob Richards and Kevin Milburn),
1337 xmlAddChild problem with attribute (Rob Richards and Kris Breuker),
1338 avoid a memory leak in an edge case (Daniel Zimmermann),
1339 deallocate some pthread data (Alex Ott).</li>
1340 <li>Improvements: configure option to avoid rebuilding docs (Adrian Bunk),
1341 limit text nodes to 10MB max by default, add element traversal
1342 APIs, add a parser option to enable pre 2.7 SAX behavior (Rob Richards),
1343 add gcc malloc checking (Marcus Meissner), add gcc printf like functions
1344 parameters checking (Marcus Meissner).</li>
1345</ul>
Daniel Veillard7f4547c2008-10-03 07:58:23 +0000[diff] [blame]1346<h3>2.7.2: Oct 3 2008</h3>
1347<ul>
1348 <li>Portability fix: fix solaris compilation problem, fix compilation
1349 if XPath is not configured in</li>
1350 <li>Bug fixes: nasty entity bug introduced in 2.7.0, restore old behaviour
1351 when saving an HTML doc with an xml dump function, HTML UTF-8 parsing
1352 bug, fix reader custom error handlers (Riccardo Scussat)
1353 <li>Improvement: xmlSave options for more flexibility to save as
1354 XML/HTML/XHTML, handle leading BOM in HTML documents</li>
1355</ul>
1356
Daniel Veillarda7036d92008-09-01 14:50:19 +0000[diff] [blame]1357<h3>2.7.1: Sep 1 2008</h3>
1358<ul>
1359 <li>Portability fix: Borland C fix (Moritz Both)</li>
1360 <li>Bug fixes: python serialization wrappers, XPath QName corner
1361 case handking and leaks (Martin)</li>
1362 <li>Improvement: extend the xmlSave to handle HTML documents and trees</li>
1363 <li>Cleanup: python serialization wrappers</li>
1364</ul>
1365
Daniel Veillard15724252008-08-30 15:01:04 +0000[diff] [blame]1366<h3>2.7.0: Aug 30 2008</h3>
1367<ul>
1368 <li>Documentation: switch ChangeLog to UTF-8, improve mutithreads and
1369 xmlParserCleanup docs</li>
1370 <li>Portability fixes: Older Win32 platforms (Rob Richards), MSVC
1371 porting fix (Rob Richards), Mac OS X regression tests (Sven Herzberg),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1372 non GNUCC builds (Rob Richards), compilation on Haiku (Andreas Färber)
Daniel Veillard15724252008-08-30 15:01:04 +0000[diff] [blame]1373 </li>
1374 <li>Bug fixes: various realloc problems (Ashwin), potential double-free
1375 (Ashwin), regexp crash, icrash with invalid whitespace facets (Rob
1376 Richards), pattern fix when streaming (William Brack), various XML
1377 parsing and validation fixes based on the W3C regression tests, reader
1378 tree skipping function fix (Ashwin), Schemas regexps escaping fix
1379 (Volker Grabsch), handling of entity push errors (Ashwin), fix a slowdown
1380 when encoder cant serialize characters on output</li>
1381 <li>Code cleanup: compilation fix without the reader, without the output
1382 (Robert Schwebel), python whitespace (Martin), many space/tabs cleanups,
1383 serious cleanup of the entity handling code</li>
1384 <li>Improvement: switch parser to XML-1.0 5th edition, add parsing flags
1385 for old versions, switch URI parsing to RFC 3986,
1386 add xmlSchemaValidCtxtGetParserCtxt (Holger Kaelberer),
1387 new hashing functions for dictionnaries (based on Stefan Behnel work),
1388 improve handling of misplaced html/head/body in HTML parser, better
1389 regression test tools and code coverage display, better algorithms
1390 to detect various versions of the billion laughts attacks, make
1391 arbitrary parser limits avoidable as a parser option</li>
1392</ul>
Daniel Veillard596da972008-04-08 14:58:41 +0000[diff] [blame]1393<h3>2.6.32: Apr 8 2008</h3>
1394<ul>
1395 <li>Documentation: returning heap memory to kernel (Wolfram Sang),
1396 trying to clarify xmlCleanupParser() use, xmlXPathContext improvement
1397 (Jack Jansen), improve the *Recover* functions documentation,
1398 XmlNodeType doc link fix (Martijn Arts)</li>
1399 <li>Bug fixes: internal subset memory leak (Ashwin), avoid problem with
1400 paths starting with // (Petr Sumbera), streaming XSD validation callback
1401 patches (Ashwin), fix redirection on port other than 80 (William Brack),
1402 SAX2 leak (Ashwin), XInclude fragment of own document (Chris Ryan),
1403 regexp bug with '.' (Andrew Tosh), flush the writer at the end of the
1404 document (Alfred Mickautsch), output I/O bug fix (William Brack),
1405 writer CDATA output after a text node (Alex Khesin), UTF-16 encoding
1406 detection (William Brack), fix handling of empty CDATA nodes for Safari
1407 team, python binding problem with namespace nodes, improve HTML parsing
1408 (Arnold Hendriks), regexp automata build bug, memory leak fix (Vasily
1409 Chekalkin), XSD test crash, weird system parameter entity parsing problem,
1410 allow save to file:///X:/ windows paths, various attribute normalisation
1411 problems, externalSubsetSplit fix (Ashwin), attribute redefinition in
1412 the DTD (Ashwin), fix in char ref parsing check (Alex Khesin), many
1413 out of memory handling fixes (Ashwin), XPath out of memory handling fixes
1414 (Alvaro Herrera), various realloc problems (Ashwin), UCS4 encoding
1415 conversion buffer size (Christian Fruth), problems with EatName
1416 functions on memory errors, BOM handling in external parsed entities
1417 (Mark Rowe)</li>
1418 <li>Code cleanup: fix build under VS 2008 (David Wimsey), remove useless
1419 mutex in xmlDict (Florent Guilian), Mingw32 compilation fix (Carlo
1420 Bramini), Win and MacOS EOL cleanups (Florent Guiliani), iconv need
1421 a const detection (Roumen Petrov), simplify xmlSetProp (Julien Charbon),
1422 cross compilation fixes for Mingw (Roumen Petrov), SCO Openserver build
1423 fix (Florent Guiliani), iconv uses const on Win32 (Rob Richards),
1424 duplicate code removal (Ashwin), missing malloc test and error reports
1425 (Ashwin), VMS makefile fix (Tycho Hilhorst)</li>
1426 <li>improvements: better plug of schematron in the normal error handling
1427 (Tobias Minich)</li>
1428</ul>
1429
Daniel Veillard28b64e22008-01-11 09:07:51 +0000[diff] [blame]1430<h3>2.6.31: Jan 11 2008</h3>
1431<ul>
1432 <li>Security fix: missing of checks in UTF-8 parsing</li>
1433 <li>Bug fixes: regexp bug, dump attribute from XHTML document, fix
1434 xmlFree(NULL) to not crash in debug mode, Schematron parsing crash
1435 (Rob Richards), global lock free on Windows (Marc-Antoine Ruel),
1436 XSD crash due to double free (Rob Richards), indentation fix in
1437 xmlTextWriterFullEndElement (Felipe Pena), error in attribute type
1438 parsing if attribute redeclared, avoid crash in hash list scanner if
1439 deleting elements, column counter bug fix (Christian Schmidt),
1440 HTML embed element saving fix (Stefan Behnel), avoid -L/usr/lib
1441 output from xml2-config (Fred Crozat), avoid an xmllint crash
1442 (Stefan Kost), don't stop HTML parsing on out of range chars.
1443 </li>
1444 <li>Code cleanup: fix open() call third argument, regexp cut'n paste
1445 copy error, unused variable in __xmlGlobalInitMutexLock (Hannes Eder),
1446 some make distcheck realted fixes (John Carr)</li>
1447 <li>Improvements: HTTP Header: includes port number (William Brack),
1448 testURI --debug option, </li>
1449</ul>
Daniel Veillardc1b3fe02007-08-23 15:00:06 +0000[diff] [blame]1450<h3>2.6.30: Aug 23 2007</h3>
1451<ul>
1452 <li>Portability: Solaris crash on error handling, windows path fixes
1453 (Roland Schwarz and Rob Richards), mingw build (Roland Schwarz)</li>
1454 <li>Bugfixes: xmlXPathNodeSetSort problem (William Brack), leak when
1455 reusing a writer for a new document (Dodji Seketeli), Schemas
1456 xsi:nil handling patch (Frank Gross), relative URI build problem
1457 (Patrik Fimml), crash in xmlDocFormatDump, invalid char in comment
1458 detection bug, fix disparity with xmlSAXUserParseMemory, automata
1459 generation for complex regexp counts problems, Schemas IDC import
1460 problems (Frank Gross), xpath predicate evailation error handling
1461 (William Brack)</li>
1462</ul>
Daniel Veillard38431c32007-06-12 16:20:09 +0000[diff] [blame]1463<h3>2.6.29: Jun 12 2007</h3>
1464<ul>
1465 <li>Portability: patches from Andreas Stricke for WinCEi,
1466 fix compilation warnings (William Brack), avoid warnings on Apple OS/X
1467 (Wendy Doyle and Mark Rowe), Windows compilation and threading
1468 improvements (Rob Richards), compilation against old Python versions,
1469 new GNU tar changes (Ryan Hill)</li>
1470 <li>Documentation: xmlURIUnescapeString comment, </li>
1471 <li>Bugfixes: xmlBufferAdd problem (Richard Jones), 'make valgrind'
1472 flag fix (Richard Jones), regexp interpretation of \,
1473 htmlCreateDocParserCtxt (Jean-Daniel Dupas), configure.in
1474 typo (Bjorn Reese), entity content failure, xmlListAppend() fix
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1475 (Georges-André Silber), XPath number serialization (William Brack),
Daniel Veillard38431c32007-06-12 16:20:09 +0000[diff] [blame]1476 nanohttp gzipped stream fix (William Brack and Alex Cornejo),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1477 xmlCharEncFirstLine typo (Mark Rowe), uri bug (François Delyon),
Daniel Veillard38431c32007-06-12 16:20:09 +0000[diff] [blame]1478 XPath string value of PI nodes (William Brack), XPath node set
1479 sorting bugs (William Brack), avoid outputting namespace decl
1480 dups in the writer (Rob Richards), xmlCtxtReset bug, UTF-8 encoding
1481 error handling, recustion on next in catalogs, fix a Relax-NG crash,
1482 workaround wrong file: URIs, htmlNodeDumpFormatOutput on attributes,
1483 invalid character in attribute detection bug, big comments before
1484 internal subset streaming bug, HTML parsing of attributes with : in
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1485 the name, IDness of name in HTML (Dagfinn I. Mannsåker) </li>
Daniel Veillard38431c32007-06-12 16:20:09 +0000[diff] [blame]1486 <li>Improvement: keep URI query parts in raw form (Richard Jones),
1487 embed tag support in HTML (Michael Day) </li>
1488</ul>
1489
Daniel Veillard39bcf942007-04-17 14:47:05 +0000[diff] [blame]1490<h3>2.6.28: Apr 17 2007</h3>
1491<ul>
1492 <li>Documentation: comment fixes (Markus Keim), xpath comments fixes too
1493 (James Dennett)</li>
1494 <li>Bug fixes: XPath bug (William Brack), HTML parser autoclose stack usage
1495 (Usamah Malik), various regexp bug fixes (DV and William), path conversion
1496 on Windows (Igor Zlatkovic), htmlCtxtReset fix (Michael Day), XPath
1497 principal node of axis bug, HTML serialization of some codepoint
1498 (Steven Rainwater), user data propagation in XInclude (Michael Day),
1499 standalone and XML decl detection (Michael Day), Python id ouptut
1500 for some id, fix the big python string memory leak, URI parsing fixes
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1501 (Stéphane Bidoul and William), long comments parsing bug (William),
Daniel Veillard39bcf942007-04-17 14:47:05 +0000[diff] [blame]1502 concurrent threads initialization (Ted Phelps), invalid char
1503 in text XInclude (William), XPath memory leak (William), tab in
1504 python problems (Andreas Hanke), XPath node comparison error
1505 (Oleg Paraschenko), cleanup patch for reader (Julien Reichel),
1506 XML Schemas attribute group (William), HTML parsing problem (William),
1507 fix char 0x2d in regexps (William), regexp quantifier range with
1508 min occurs of 0 (William), HTML script/style parsing (Mike Day)</li>
1509 <li>Improvement: make xmlTextReaderSetup() public</li>
1510 <li>Compilation and postability: fix a missing include problem (William),
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1511 __ss_familly on AIX again (Björn Wiberg), compilation without zlib
Daniel Veillard39bcf942007-04-17 14:47:05 +0000[diff] [blame]1512 (Michael Day), catalog patch for Win32 (Christian Ehrlicher),
1513 Windows CE fixes (Andreas Stricke)</li>
1514 <li>Various CVS to SVN infrastructure changes</li>
1515</ul>
Daniel Veillardc8338f12006-10-25 16:06:29 +0000[diff] [blame]1516<h3>2.6.27: Oct 25 2006</h3>
1517<ul>
1518 <li>Portability fixes: file names on windows (Roland Schwingel,
1519 Emelyanov Alexey), windows compile fixup (Rob Richards),
1520 AIX iconv() is apparently case sensitive</li>
1521 <li>improvements: Python XPath types mapping (Nic Ferrier), XPath optimization
1522 (Kasimier), add xmlXPathCompiledEvalToBoolean (Kasimier), Python node
1523 equality and comparison (Andreas Pakulat), xmlXPathCollectAndTest
1524 improvememt (Kasimier), expose if library was compiled with zlib
1525 support (Andrew Nosenko), cache for xmlSchemaIDCMatcher structs
1526 (Kasimier), xmlTextConcat should work with comments and PIs (Rob
1527 Richards), export htmlNewParserCtxt needed by Michael Day, refactoring
1528 of catalog entity loaders (Michael Day), add XPointer support to
1529 python bindings (Ross Reedstrom, Brian West and Stefan Anca),
1530 try to sort out most file path to URI conversions and xmlPathToUri,
1531 add --html --memory case to xmllint</li>
1532 <li>building fix: fix --with-minimum (Felipe Contreras), VMS fix,
1533 const'ification of HTML parser structures (Matthias Clasen),
1534 portability fix (Emelyanov Alexey), wget autodetection (Peter
1535 Breitenlohner), remove the build path recorded in the python
1536 shared module, separate library flags for shared and static builds
1537 (Mikhail Zabaluev), fix --with-minimum --with-sax1 builds, fix
1538 --with-minimum --with-schemas builds</li>
1539 <li>bug fix: xmlGetNodePath fix (Kasimier), xmlDOMWrapAdoptNode and
1540 attribute (Kasimier), crash when using the recover mode,
1541 xmlXPathEvalExpr problem (Kasimier), xmlXPathCompExprAdd bug (Kasimier),
1542 missing destry in xmlFreeRMutex (Andrew Nosenko), XML Schemas fixes
1543 (Kasimier), warning on entities processing, XHTML script and style
1544 serialization (Kasimier), python generator for long types, bug in
1545 xmlSchemaClearValidCtxt (Bertrand Fritsch), xmlSchemaXPathEvaluate
1546 allocation bug (Marton Illes), error message end of line (Rob Richards),
1547 fix attribute serialization in writer (Rob Richards), PHP4 DTD validation
1548 crasher, parser safety patch (Ben Darnell), _private context propagation
1549 when parsing entities (with Michael Day), fix entities behaviour when
1550 using SAX, URI to file path fix (Mikhail Zabaluev), disapearing validity
1551 context, arg error in SAX callback (Mike Hommey), fix mixed-content
1552 autodetect when using --noblanks, fix xmlIOParseDTD error handling,
1553 fix bug in xmlSplitQName on special Names, fix Relax-NG element content
1554 validation bug, fix xmlReconciliateNs bug, fix potential attribute
1555 XML parsing bug, fix line/column accounting in XML parser, chunking bug
1556 in the HTML parser on script, try to detect obviously buggy HTML
1557 meta encoding indications, bugs with encoding BOM and xmlSaveDoc,
1558 HTML entities in attributes parsing, HTML minimized attribute values,
1559 htmlReadDoc and htmlReadIO were broken, error handling bug in
1560 xmlXPathEvalExpression (Olaf Walkowiak), fix a problem in
1561 htmlCtxtUseOptions, xmlNewInputFromFile could leak (Marius Konitzer),
1562 bug on misformed SSD regexps (Christopher Boumenot)
1563 </li>
1564 <li>documentation: warning about XML_PARSE_COMPACT (Kasimier Buchcik),
1565 fix xmlXPathCastToString documentation, improve man pages for
1566 xmllitn and xmlcatalog (Daniel Leidert), fixed comments of a few
1567 functions</li>
1568</ul>
Daniel Veillardfabafd52006-06-08 08:16:33 +0000[diff] [blame]1569<h3>2.6.26: Jun 6 2006</h3>
Daniel Veillard69839ba2006-06-06 13:27:03 +0000[diff] [blame]1570<ul>
Daniel Veillardfabafd52006-06-08 08:16:33 +0000[diff] [blame]1571 <li>portability fixes: Python detection (Joseph Sacco), compilation
1572 error(William Brack and Graham Bennett), LynxOS patch (Olli Savia)</li>
1573 <li>bug fixes: encoding buffer problem, mix of code and data in
1574 xmlIO.c(Kjartan Maraas), entities in XSD validation (Kasimier Buchcik),
1575 variousXSD validation fixes (Kasimier), memory leak in pattern (Rob
1576 Richards andKasimier), attribute with colon in name (Rob Richards), XPath
1577 leak inerror reporting (Aleksey Sanin), XInclude text include of
1578 selfdocument.</li>
1579 <li>improvements: Xpath optimizations (Kasimier), XPath object
1580 cache(Kasimier)</li>
Daniel Veillard69839ba2006-06-06 13:27:03 +0000[diff] [blame]1581</ul>
1582
Daniel Veillardfabafd52006-06-08 08:16:33 +0000[diff] [blame]1583<h3>2.6.25: Jun 6 2006:</h3>
1584
1585<p>Do not use or package 2.6.25</p>
1586
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +0000[diff] [blame]1587<h3>2.6.24: Apr 28 2006</h3>
1588<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1589 <li>Portability fixes: configure on Windows, testapi compile on windows
1590 (Kasimier Buchcik, venkat naidu), Borland C++ 6 compile (Eric Zurcher),
1591 HP-UX compiler workaround (Rick Jones), xml2-config bugfix, gcc-4.1
1592 cleanups, Python detection scheme (Joseph Sacco), UTF-8 file paths on
1593 Windows (Roland Schwingel).
1594 </li>
1595 <li>Improvements: xmlDOMWrapReconcileNamespaces xmlDOMWrapCloneNode (Kasimier
1596 Buchcik), XML catalog debugging (Rick Jones), update to Unicode 4.01.</li>
1597 <li>Bug fixes: xmlParseChunk() problem in 2.6.23, xmlParseInNodeContext()
1598 on HTML docs, URI behaviour on Windows (Rob Richards), comment streaming
1599 bug, xmlParseComment (with William Brack), regexp bug fixes (DV &amp;
1600 Youri Golovanov), xmlGetNodePath on text/CDATA (Kasimier),
1601 one Relax-NG interleave bug, xmllint --path and --valid,
1602 XSD bugfixes (Kasimier), remove debug
1603 left in Python bindings (Nic Ferrier), xmlCatalogAdd bug (Martin Cole),
1604 xmlSetProp fixes (Rob Richards), HTML IDness (Rob Richards), a large
1605 number of cleanups and small fixes based on Coverity reports, bug
1606 in character ranges, Unicode tables const (Aivars Kalvans), schemas
1607 fix (Stefan Kost), xmlRelaxNGParse error deallocation,
1608 xmlSchemaAddSchemaDoc error deallocation, error handling on unallowed
1609 code point, ixmllint --nonet to never reach the net (Gary Coady),
1610 line break in writer after end PI (Jason Viers). </li>
Daniel Veillardb2f8f1d2006-04-28 16:30:48 +0000[diff] [blame]1611 <li>Documentation: man pages updates and cleanups (Daniel Leidert).</li>
1612 <li>New features: Relax NG structure error handlers.</li>
1613</ul>
1614
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1615<h3>2.6.23: Jan 5 2006</h3>
1616<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1617 <li>portability fixes: Windows (Rob Richards), getaddrinfo on Windows
1618 (Kolja Nowak, Rob Richards), icc warnings (Kjartan Maraas),
1619 --with-minimum compilation fixes (William Brack), error case handling fix
1620 on Solaris (Albert Chin), don't use 'list' as parameter name reported by
1621 Samuel Diaz Garcia, more old Unices portability fixes (Albert Chin),
1622 MinGW compilation (Mark Junker), HP-UX compiler warnings (Rick
1623 Jones),</li>
1624 <li>code cleanup: xmlReportError (Adrian Mouat), remove xmlBufferClose
1625 (Geert Jansen), unreachable code (Oleksandr Kononenko), refactoring
1626 parsing code (Bjorn Reese)</li>
1627 <li>bug fixes: xmlBuildRelativeURI and empty path (William Brack),
1628 combinatory explosion and performances in regexp code, leak in
1629 xmlTextReaderReadString(), xmlStringLenDecodeEntities problem (Massimo
1630 Morara), Identity Constraints bugs and a segfault (Kasimier Buchcik),
1631 XPath pattern based evaluation bugs (DV &amp; Kasimier),
1632 xmlSchemaContentModelDump() memory leak (Kasimier), potential leak in
1633 xmlSchemaCheckCSelectorXPath(), xmlTextWriterVSprintf() misuse of
1634 vsnprintf (William Brack), XHTML serialization fix (Rob Richards), CRLF
1635 split problem (William), issues with non-namespaced attributes in
1636 xmlAddChild() xmlAddNextSibling() and xmlAddPrevSibling() (Rob Richards),
1637 HTML parsing of script, Python must not output to stdout (Nic Ferrier),
1638 exclusive C14N namespace visibility (Aleksey Sanin), XSD dataype
1639 totalDigits bug (Kasimier Buchcik), error handling when writing to an
1640 xmlBuffer (Rob Richards), runtest schemas error not reported (Hisashi
1641 Fujinaka), signed/unsigned problem in date/time code (Albert Chin), fix
1642 XSI driven XSD validation (Kasimier), parsing of xs:decimal (Kasimier),
1643 fix DTD writer output (Rob Richards), leak in xmlTextReaderReadInnerXml
1644 (Gary Coady), regexp bug affecting schemas (Kasimier), configuration of
1645 runtime debugging (Kasimier), xmlNodeBufGetContent bug on entity refs
1646 (Oleksandr Kononenko), xmlRegExecPushString2 bug (Sreeni Nair),
1647 compilation and build fixes (Michael Day), removed dependancies on
1648 xmlSchemaValidError (Kasimier), bug with &lt;xml:foo/&gt;, more XPath
1649 pattern based evaluation fixes (Kasimier)</li>
1650 <li>improvements: XSD Schemas redefinitions/restrictions (Kasimier
1651 Buchcik), node copy checks and fix for attribute (Rob Richards), counted
1652 transition bug in regexps, ctxt-&gt;standalone = -2 to indicate no
1653 standalone attribute was found, add xmlSchemaSetParserStructuredErrors()
1654 (Kasimier Buchcik), add xmlTextReaderSchemaValidateCtxt() to API
1655 (Kasimier), handle gzipped HTTP resources (Gary Coady), add
1656 htmlDocDumpMemoryFormat. (Rob Richards),</li>
1657 <li>documentation: typo (Michael Day), libxml man page (Albert Chin), save
1658 function to XML buffer (Geert Jansen), small doc fix (Aron Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1659</ul>
1660
Daniel Veillard33b20b72005-09-12 21:43:20 +0000[diff] [blame]1661<h3>2.6.22: Sep 12 2005</h3>
1662<ul>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1663 <li>build fixes: compile without schematron (Stéphane Bidoul)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1664 <li>bug fixes: xmlDebugDumpNode on namespace node (Oleg Paraschenko)i,
1665 CDATA push parser bug, xmlElemDump problem with XHTML1 doc,
1666 XML_FEATURE_xxx clash with expat headers renamed XML_WITH_xxx, fix some
1667 output formatting for meta element (Rob Richards), script and style
1668 XHTML1 serialization (David Madore), Attribute derivation fixups in XSD
1669 (Kasimier Buchcik), better IDC error reports (Kasimier Buchcik)</li>
1670 <li>improvements: add XML_SAVE_NO_EMPTY xmlSaveOption (Rob Richards), add
1671 XML_SAVE_NO_XHTML xmlSaveOption, XML Schemas improvements preparing for
1672 derive (Kasimier Buchcik).</li>
1673 <li>documentation: generation of gtk-doc like docs, integration with
1674 devhelp.</li>
Daniel Veillard33b20b72005-09-12 21:43:20 +0000[diff] [blame]1675</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1676
Daniel Veillardb3d14912005-09-04 20:47:39 +0000[diff] [blame]1677<h3>2.6.21: Sep 4 2005</h3>
1678<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1679 <li>build fixes: Cygwin portability fixes (Gerrit P. Haase), calling
1680 convention problems on Windows (Marcus Boerger), cleanups based on Linus'
1681 sparse tool, update of win32/configure.js (Rob Richards), remove warnings
1682 on Windows(Marcus Boerger), compilation without SAX1, detection of the
1683 Python binary, use $GCC inestad of $CC = 'gcc' (Andrew W. Nosenko),
1684 compilation/link with threads and old gcc, compile problem by C370 on
1685 Z/OS,</li>
1686 <li>bug fixes: http_proxy environments (Peter Breitenlohner), HTML UTF-8
1687 bug (Jiri Netolicky), XPath NaN compare bug (William Brack),
1688 htmlParseScript potential bug, Schemas regexp handling of spaces, Base64
1689 Schemas comparisons NIST passes, automata build error xsd:all,
1690 xmlGetNodePath for namespaced attributes (Alexander Pohoyda), xmlSchemas
1691 foreign namespaces handling, XML Schemas facet comparison (Kupriyanov
1692 Anatolij), xmlSchemaPSimpleTypeErr error report (Kasimier Buchcik), xml:
1693 namespace ahndling in Schemas (Kasimier), empty model group in Schemas
1694 (Kasimier), wilcard in Schemas (Kasimier), URI composition (William),
1695 xs:anyType in Schemas (Kasimier), Python resolver emmitting error
1696 messages directly, Python xmlAttr.parent (Jakub Piotr Clapa), trying to
1697 fix the file path/URI conversion, xmlTextReaderGetAttribute fix (Rob
1698 Richards), xmlSchemaFreeAnnot memleak (Kasimier), HTML UTF-8
1699 serialization, streaming XPath, Schemas determinism detection problem,
1700 XInclude bug, Schemas context type (Dean Hill), validation fix (Derek
1701 Poon), xmlTextReaderGetAttribute[Ns] namespaces (Rob Richards), Schemas
1702 type fix (Kuba Nowakowski), UTF-8 parser bug, error in encoding handling,
1703 xmlGetLineNo fixes, bug on entities handling, entity name extraction in
1704 error handling with XInclude, text nodes in HTML body tags (Gary Coady),
1705 xml:id and IDness at the treee level fixes, XPath streaming patterns
1706 bugs.</li>
1707 <li>improvements: structured interfaces for schemas and RNG error reports
1708 (Marcus Boerger), optimization of the char data inner loop parsing
1709 (thanks to Behdad Esfahbod for the idea), schematron validation though
1710 not finished yet, xmlSaveOption to omit XML declaration, keyref match
1711 error reports (Kasimier), formal expression handling code not plugged
1712 yet, more lax mode for the HTML parser, parser XML_PARSE_COMPACT option
1713 for text nodes allocation.</li>
Daniel Veillardb3d14912005-09-04 20:47:39 +0000[diff] [blame]1714 <li>documentation: xmllint man page had --nonet duplicated</li>
1715</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1716
Daniel Veillard78dfc9f2005-07-10 22:30:30 +0000[diff] [blame]1717<h3>2.6.20: Jul 10 2005</h3>
1718<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1719 <li>build fixes: Windows build (Rob Richards), Mingw compilation (Igor
1720 Zlatkovic), Windows Makefile (Igor), gcc warnings (Kasimier and
1721 andriy@google.com), use gcc weak references to pthread to avoid the
1722 pthread dependancy on Linux, compilation problem (Steve Nairn), compiling
1723 of subset (Morten Welinder), IPv6/ss_family compilation (William Brack),
1724 compilation when disabling parts of the library, standalone test
1725 distribution.</li>
1726 <li>bug fixes: bug in lang(), memory cleanup on errors (William Brack),
1727 HTTP query strings (Aron Stansvik), memory leak in DTD (William), integer
1728 overflow in XPath (William), nanoftp buffer size, pattern "." apth fixup
1729 (Kasimier), leak in tree reported by Malcolm Rowe, replaceNode patch
1730 (Brent Hendricks), CDATA with NULL content (Mark Vakoc), xml:base fixup
1731 on XInclude (William), pattern fixes (William), attribute bug in
1732 exclusive c14n (Aleksey Sanin), xml:space and xml:lang with SAX2 (Rob
1733 Richards), namespace trouble in complex parsing (Malcolm Rowe), XSD type
1734 QNames fixes (Kasimier), XPath streaming fixups (William), RelaxNG bug
1735 (Rob Richards), Schemas for Schemas fixes (Kasimier), removal of ID (Rob
1736 Richards), a small RelaxNG leak, HTML parsing in push mode bug (James
1737 Bursa), failure to detect UTF-8 parsing bugs in CDATA sections,
1738 areBlanks() heuristic failure, duplicate attributes in DTD bug
1739 (William).</li>
1740 <li>improvements: lot of work on Schemas by Kasimier Buchcik both on
1741 conformance and streaming, Schemas validation messages (Kasimier Buchcik,
1742 Matthew Burgess), namespace removal at the python level (Brent
1743 Hendricks), Update to new Schemas regression tests from W3C/Nist
1744 (Kasimier), xmlSchemaValidateFile() (Kasimier), implementation of
1745 xmlTextReaderReadInnerXml and xmlTextReaderReadOuterXml (James Wert),
1746 standalone test framework and programs, new DOM import APIs
1747 xmlDOMWrapReconcileNamespaces() xmlDOMWrapAdoptNode() and
1748 xmlDOMWrapRemoveNode(), extension of xmllint capabilities for SAX and
1749 Schemas regression tests, xmlStopParser() available in pull mode too,
1750 ienhancement to xmllint --shell namespaces support, Windows port of the
1751 standalone testing tools (Kasimier and William),
1752 xmlSchemaValidateStream() xmlSchemaSAXPlug() and xmlSchemaSAXUnplug() SAX
1753 Schemas APIs, Schemas xmlReader support.</li>
Daniel Veillard78dfc9f2005-07-10 22:30:30 +0000[diff] [blame]1754</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1755
Daniel Veillard771971f2005-04-02 10:49:51 +0000[diff] [blame]1756<h3>2.6.19: Apr 02 2005</h3>
1757<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1758 <li>build fixes: drop .la from RPMs, --with-minimum build fix (William
1759 Brack), use XML_SOCKLEN_T instead of SOCKLEN_T because it breaks with AIX
1760 5.3 compiler, fixed elfgcchack.h generation and PLT reduction code on
1761 Linux/ELF/gcc4</li>
1762 <li>bug fixes: schemas type decimal fixups (William Brack), xmmlint return
1763 code (Gerry Murphy), small schemas fixes (Matthew Burgess and GUY
1764 Fabrice), workaround "DAV:" namespace brokeness in c14n (Aleksey Sanin),
1765 segfault in Schemas (Kasimier Buchcik), Schemas attribute validation
1766 (Kasimier), Prop related functions and xmlNewNodeEatName (Rob Richards),
1767 HTML serialization of name attribute on a elements, Python error handlers
1768 leaks and improvement (Brent Hendricks), uninitialized variable in
1769 encoding code, Relax-NG validation bug, potential crash if
1770 gnorableWhitespace is NULL, xmlSAXParseDoc and xmlParseDoc signatures,
1771 switched back to assuming UTF-8 in case no encoding is given at
1772 serialization time</li>
1773 <li>improvements: lot of work on Schemas by Kasimier Buchcik on facets
1774 checking and also mixed handling.</li>
Daniel Veillard771971f2005-04-02 10:49:51 +0000[diff] [blame]1775 <li></li>
1776</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1777
Daniel Veillard57c000e2005-03-13 18:34:29 +0000[diff] [blame]1778<h3>2.6.18: Mar 13 2005</h3>
1779<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1780 <li>build fixes: warnings (Peter Breitenlohner), testapi.c generation,
1781 Bakefile support (Francesco Montorsi), Windows compilation (Joel Reed),
1782 some gcc4 fixes, HP-UX portability fixes (Rick Jones).</li>
1783 <li>bug fixes: xmlSchemaElementDump namespace (Kasimier Buchcik), push and
1784 xmlreader stopping on non-fatal errors, thread support for dictionnaries
1785 reference counting (Gary Coady), internal subset and push problem, URL
1786 saved in xmlCopyDoc, various schemas bug fixes (Kasimier), Python paths
1787 fixup (Stephane Bidoul), xmlGetNodePath and namespaces, xmlSetNsProp fix
1788 (Mike Hommey), warning should not count as error (William Brack),
1789 xmlCreatePushParser empty chunk, XInclude parser flags (William), cleanup
1790 FTP and HTTP code to reuse the uri parsing and IPv6 (William),
1791 xmlTextWriterStartAttributeNS fix (Rob Richards), XMLLINT_INDENT being
1792 empty (William), xmlWriter bugs (Rob Richards), multithreading on Windows
1793 (Rich Salz), xmlSearchNsByHref fix (Kasimier), Python binding leak (Brent
1794 Hendricks), aliasing bug exposed by gcc4 on s390, xmlTextReaderNext bug
1795 (Rob Richards), Schemas decimal type fixes (William Brack),
1796 xmlByteConsumed static buffer (Ben Maurer).</li>
1797 <li>improvement: speedup parsing comments and DTDs, dictionnary support for
1798 hash tables, Schemas Identity constraints (Kasimier), streaming XPath
1799 subset, xmlTextReaderReadString added (Bjorn Reese), Schemas canonical
1800 values handling (Kasimier), add xmlTextReaderByteConsumed (Aron
1801 Stansvik),</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1802 <li>Documentation: Wiki support (Joel Reed)</li>
Daniel Veillard57c000e2005-03-13 18:34:29 +0000[diff] [blame]1803</ul>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]1804
Daniel Veillard298d9642005-01-16 20:01:55 +0000[diff] [blame]1805<h3>2.6.17: Jan 16 2005</h3>
1806<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1807 <li>build fixes: Windows, warnings removal (William Brack),
1808 maintainer-clean dependency(William), build in a different directory
1809 (William), fixing --with-minimum configure build (William), BeOS build
1810 (Marcin Konicki), Python-2.4 detection (William), compilation on AIX (Dan
1811 McNichol)</li>
1812 <li>bug fixes: xmlTextReaderHasAttributes (Rob Richards), xmlCtxtReadFile()
1813 to use the catalog(s), loop on output (William Brack), XPath memory leak,
1814 ID deallocation problem (Steve Shepard), debugDumpNode crash (William),
1815 warning not using error callback (William), xmlStopParser bug (William),
1816 UTF-16 with BOM on DTDs (William), namespace bug on empty elements in
1817 push mode (Rob Richards), line and col computations fixups (Aleksey
1818 Sanin), xmlURIEscape fix (William), xmlXPathErr on bad range (William),
1819 patterns with too many steps, bug in RNG choice optimization, line number
1820 sometimes missing.</li>
1821 <li>improvements: XSD Schemas (Kasimier Buchcik), python generator
1822 (William), xmlUTF8Strpos speedup (William), unicode Python strings
1823 (William), XSD error reports (Kasimier Buchcik), Python __str__ call
1824 serialize().</li>
1825 <li>new APIs: added xmlDictExists(), GetLineNumber and GetColumnNumber for
1826 the xmlReader (Aleksey Sanin), Dynamic Shared Libraries APIs (mostly Joel
1827 Reed), error extraction API from regexps, new XMLSave option for format
1828 (Phil Shafer)</li>
1829 <li>documentation: site improvement (John Fleck), FAQ entries
1830 (William).</li>
Daniel Veillard298d9642005-01-16 20:01:55 +0000[diff] [blame]1831</ul>
1832
Daniel Veillardc3d7cb42004-11-10 14:34:45 +0000[diff] [blame]1833<h3>2.6.16: Nov 10 2004</h3>
1834<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1835 <li>general hardening and bug fixing crossing all the API based on new
1836 automated regression testing</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +0000[diff] [blame]1837 <li>build fix: IPv6 build and test on AIX (Dodji Seketeli)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1838 <li>bug fixes: problem with XML::Libxml reported by Petr Pajas, encoding
1839 conversion functions return values, UTF-8 bug affecting XPath reported by
1840 Markus Bertheau, catalog problem with NULL entries (William Brack)</li>
1841 <li>documentation: fix to xmllint man page, some API function descritpion
1842 were updated.</li>
1843 <li>improvements: DTD validation APIs provided at the Python level (Brent
1844 Hendricks)</li>
Daniel Veillardc3d7cb42004-11-10 14:34:45 +0000[diff] [blame]1845</ul>
1846
Daniel Veillardc2f83d12004-10-27 22:59:21 +0000[diff] [blame]1847<h3>2.6.15: Oct 27 2004</h3>
Daniel Veillard6927b102004-10-27 17:29:04 +0000[diff] [blame]1848<ul>
1849 <li>security fixes on the nanoftp and nanohttp modules</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1850 <li>build fixes: xmllint detection bug in configure, building outside the
1851 source tree (Thomas Fitzsimmons)</li>
1852 <li>bug fixes: HTML parser on broken ASCII chars in names (William), Python
1853 paths (Malcolm Tredinnick), xmlHasNsProp and default namespace (William),
1854 saving to python file objects (Malcolm Tredinnick), DTD lookup fix
1855 (Malcolm), save back &lt;group&gt; in catalogs (William), tree build
1856 fixes (DV and Rob Richards), Schemas memory bug, structured error handler
1857 on Python 64bits, thread local memory deallocation, memory leak reported
1858 by Volker Roth, xmlValidateDtd in the presence of an internal subset,
1859 entities and _private problem (William), xmlBuildRelativeURI error
1860 (William).</li>
1861 <li>improvements: better XInclude error reports (William), tree debugging
1862 module and tests, convenience functions at the Reader API (Graham
1863 Bennett), add support for PI in the HTML parser.</li>
Daniel Veillard6927b102004-10-27 17:29:04 +0000[diff] [blame]1864</ul>
1865
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]1866<h3>2.6.14: Sep 29 2004</h3>
1867<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1868 <li>build fixes: configure paths for xmllint and xsltproc, compilation
1869 without HTML parser, compilation warning cleanups (William Brack &amp;
1870 Malcolm Tredinnick), VMS makefile update (Craig Berry),</li>
1871 <li>bug fixes: xmlGetUTF8Char (William Brack), QName properties (Kasimier
1872 Buchcik), XInclude testing, Notation serialization, UTF8ToISO8859x
1873 transcoding (Mark Itzcovitz), lots of XML Schemas cleanup and fixes
1874 (Kasimier), ChangeLog cleanup (Stepan Kasal), memory fixes (Mark Vakoc),
1875 handling of failed realloc(), out of bound array adressing in Schemas
1876 date handling, Python space/tabs cleanups (Malcolm Tredinnick), NMTOKENS
1877 E20 validation fix (Malcolm),</li>
1878 <li>improvements: added W3C XML Schemas testsuite (Kasimier Buchcik), add
1879 xmlSchemaValidateOneElement (Kasimier), Python exception hierearchy
1880 (Malcolm Tredinnick), Python libxml2 driver improvement (Malcolm
1881 Tredinnick), Schemas support for xsi:schemaLocation,
1882 xsi:noNamespaceSchemaLocation, xsi:type (Kasimier Buchcik)</li>
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]1883</ul>
1884
Daniel Veillardd1de4a32004-08-31 13:43:07 +0000[diff] [blame]1885<h3>2.6.13: Aug 31 2004</h3>
1886<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1887 <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag with gcc,
1888 Solaris compiler warning, fixing RPM BuildRequires,</li>
1889 <li>fixes: DTD loading on Windows (Igor), Schemas error reports APIs
1890 (Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 (William Brack
1891 and Julius Mittenzwei), Schemas facet check (Kasimier), default namespace
1892 problem (William), Schemas hexbinary empty values, encoding error could
1893 genrate a serialization loop.</li>
1894 <li>Improvements: Schemas validity improvements (Kasimier), added --path
1895 and --load-trace options to xmllint</li>
Daniel Veillardd1de4a32004-08-31 13:43:07 +0000[diff] [blame]1896 <li>documentation: tutorial update (John Fleck)</li>
1897</ul>
1898
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]1899<h3>2.6.12: Aug 22 2004</h3>
1900<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1901 <li>build fixes: fix --with-minimum, elfgcchack.h fixes (Peter
1902 Breitenlohner), perl path lookup (William), diff on Solaris (Albert
1903 Chin), some 64bits cleanups.</li>
1904 <li>Python: avoid a warning with 2.3 (William Brack), tab and space mixes
1905 (William), wrapper generator fixes (William), Cygwin support (Gerrit P.
1906 Haase), node wrapper fix (Marc-Antoine Parent), XML Schemas support
1907 (Torkel Lyng)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]1908 <li>Schemas: a lot of bug fixes and improvements from Kasimier Buchcik</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1909 <li>fixes: RVT fixes (William), XPath context resets bug (William), memory
1910 debug (Steve Hay), catalog white space handling (Peter Breitenlohner),
1911 xmlReader state after attribute reading (William), structured error
1912 handler (William), XInclude generated xml:base fixup (William), Windows
1913 memory reallocation problem (Steve Hay), Out of Memory conditions
1914 handling (William and Olivier Andrieu), htmlNewDoc() charset bug,
1915 htmlReadMemory init (William), a posteriori validation DTD base
1916 (William), notations serialization missing, xmlGetNodePath (Dodji),
1917 xmlCheckUTF8 (Diego Tartara), missing line numbers on entity
1918 (William)</li>
1919 <li>improvements: DocBook catalog build scrip (William), xmlcatalog tool
1920 (Albert Chin), xmllint --c14n option, no_proxy environment (Mike Hommey),
1921 xmlParseInNodeContext() addition, extend xmllint --shell, allow XInclude
1922 to not generate start/end nodes, extend xmllint --version to include CVS
1923 tag (William)</li>
1924 <li>documentation: web pages fixes, validity API docs fixes (William)
1925 schemas API fix (Eric Haszlakiewicz), xmllint man page (John Fleck)</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]1926</ul>
1927
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]1928<h3>2.6.11: July 5 2004</h3>
1929<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1930 <li>Schemas: a lot of changes and improvements by Kasimier Buchcik for
1931 attributes, namespaces and simple types.</li>
1932 <li>build fixes: --with-minimum (William Brack), some gcc cleanup
1933 (William), --with-thread-alloc (William)</li>
1934 <li>portability: Windows binary package change (Igor Zlatkovic), Catalog
1935 path on Windows</li>
1936 <li>documentation: update to the tutorial (John Fleck), xmllint return code
1937 (John Fleck), man pages (Ville Skytta),</li>
1938 <li>bug fixes: C14N bug serializing namespaces (Aleksey Sanin), testSAX
1939 properly initialize the library (William), empty node set in XPath
1940 (William), xmlSchemas errors (William), invalid charref problem pointed
1941 by Morus Walter, XInclude xml:base generation (William), Relax-NG bug
1942 with div processing (William), XPointer and xml:base problem(William),
1943 Reader and entities, xmllint return code for schemas (William), reader
1944 streaming problem (Steve Ball), DTD serialization problem (William),
1945 libxml.m4 fixes (Mike Hommey), do not provide destructors as methods on
1946 Python classes, xmlReader buffer bug, Python bindings memory interfaces
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]1947 improvement (with Stéphane Bidoul), Fixed the push parser to be back to
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1948 synchronous behaviour.</li>
1949 <li>improvement: custom per-thread I/O enhancement (Rob Richards), register
1950 namespace in debug shell (Stefano Debenedetti), Python based regression
1951 test for non-Unix users (William), dynamically increase the number of
1952 XPath extension functions in Python and fix a memory leak (Marc-Antoine
1953 Parent and William)</li>
1954 <li>performance: hack done with Arjan van de Ven to reduce ELF footprint
1955 and generated code on Linux, plus use gcc runtime profiling to optimize
1956 the code generated in the RPM packages.</li>
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]1957</ul>
1958
Daniel Veillard81205012004-05-18 03:06:41 +0000[diff] [blame]1959<h3>2.6.10: May 17 2004</h3>
1960<ul>
1961 <li>Web page generated for ChangeLog</li>
1962 <li>build fixes: --without-html problems, make check without make all</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1963 <li>portability: problem with xpath.c on Windows (MSC and Borland), memcmp
1964 vs. strncmp on Solaris, XPath tests on Windows (Mark Vakoc), C++ do not
1965 use "list" as parameter name, make tests work with Python 1.5 (Ed
1966 Davis),</li>
1967 <li>improvements: made xmlTextReaderMode public, small buffers resizing
1968 (Morten Welinder), add --maxmem option to xmllint, add
1969 xmlPopInputCallback() for Matt Sergeant, refactoring of serialization
1970 escaping, added escaping customization</li>
1971 <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp bugs (William
1972 Brack), xmlReader end of stream problem, node deregistration with reader,
1973 URI escaping and filemanes, XHTML1 formatting (Nick Wellnhofer), regexp
1974 transition reduction (William), various XSD Schemas fixes (Kasimier
1975 Buchcik), XInclude fallback problem (William), weird problems with DTD
1976 (William), structured error handler callback context (William), reverse
1977 xmlEncodeSpecialChars() behaviour back to escaping '"'</li>
Daniel Veillard81205012004-05-18 03:06:41 +0000[diff] [blame]1978</ul>
1979
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]1980<h3>2.6.9: Apr 18 2004</h3>
1981<ul>
1982 <li>implement xml:id Working Draft, relaxed XPath id() checking</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]1983 <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and CDATA (Dave
1984 Beckett), Relax-NG compilation (William Brack), Regexp patches (with
1985 William), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed problem (with
1986 William), Relax-NG name classes compares (William), XInclude duplicate
1987 fallback (William), external DTD encoding detection (William), a DTD
1988 validation bug (William), xmlReader Close() fix, recusive extention
1989 schemas</li>
1990 <li>improvements: use xmlRead* APIs in test tools (Mark Vakoc), indenting
1991 save optimization, better handle IIS broken HTTP redirect behaviour (Ian
1992 Hummel), HTML parser frameset (James Bursa), libxml2-python RPM
1993 dependancy, XML Schemas union support (Kasimier Buchcik), warning removal
1994 clanup (William), keep ChangeLog compressed when installing from RPMs</li>
1995 <li>documentation: examples and xmlDocDumpMemory docs (John Fleck), new
1996 example (load, xpath, modify, save), xmlCatalogDump() comments,</li>
1997 <li>Windows: Borland C++ builder (Eric Zurcher), work around Microsoft
1998 compiler NaN handling bug (Mark Vakoc)</li>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]1999</ul>
2000
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]2001<h3>2.6.8: Mar 23 2004</h3>
2002<ul>
2003 <li>First step of the cleanup of the serialization code and APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2004 <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling fixes (Adam
2005 Dickmeiss), anyURI for "" (John Belmonte)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]2006 <li>Python: Canonicalization C14N support added (Anthony Carrico)</li>
2007 <li>xmlDocCopyNode() extension (William)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2008 <li>Relax-NG: fix when processing XInclude results (William), external
2009 reference in interleave (William), missing error on &lt;choice&gt;
2010 failure (William), memory leak in schemas datatype facets.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]2011 <li>xmlWriter: patch for better DTD support (Alfred Mickautsch)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2012 <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey and William
2013 Brack), no ID errors if using HTML_PARSE_NOERROR, xmlcatalog fallbacks to
2014 URI on SYSTEM lookup failure, XInclude parse flags inheritance (William),
2015 XInclude and XPointer fixes for entities (William), XML parser bug
2016 reported by Holger Rauch, nanohttp fd leak (William), regexps char
2017 groups '-' handling (William), dictionnary reference counting problems,
2018 do not close stderr.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]2019 <li>performance patches from Petr Pajas</li>
2020 <li>Documentation fixes: XML_CATALOG_FILES in man pages (Mike Hommey)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2021 <li>compilation and portability fixes: --without-valid, catalog cleanups
2022 (Peter Breitenlohner), MingW patch (Roland Schwingel), cross-compilation
2023 to Windows (Christophe de Vienne), --with-html-dir fixup (Julio Merino
2024 Vidal), Windows build (Eric Zurcher)</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]2025</ul>
2026
Daniel Veillard92914492004-02-23 16:33:21 +0000[diff] [blame]2027<h3>2.6.7: Feb 23 2004</h3>
2028<ul>
2029 <li>documentation: tutorial updates (John Fleck), benchmark results</li>
2030 <li>xmlWriter: updates and fixes (Alfred Mickautsch, Lucas Brasilino)</li>
2031 <li>XPath optimization (Petr Pajas)</li>
2032 <li>DTD ID handling optimization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2033 <li>bugfixes: xpath number with &gt; 19 fractional (William Brack), push
2034 mode with unescaped '&gt;' characters, fix xmllint --stream --timing, fix
2035 xmllint --memory --stream memory usage, xmlAttrSerializeTxtContent
2036 handling NULL, trying to fix Relax-NG/Perl interface.</li>
Daniel Veillard92914492004-02-23 16:33:21 +0000[diff] [blame]2037 <li>python: 2.3 compatibility, whitespace fixes (Malcolm Tredinnick)</li>
2038 <li>Added relaxng option to xmllint --shell</li>
2039</ul>
2040
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]2041<h3>2.6.6: Feb 12 2004</h3>
2042<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2043 <li>nanohttp and nanoftp: buffer overflow error on URI parsing (Igor and
2044 William) reported by Yuuichi Teranishi</li>
2045 <li>bugfixes: make test and path issues, xmlWriter attribute serialization
2046 (William Brack), xmlWriter indentation (William), schemas validation
2047 (Eric Haszlakiewicz), XInclude dictionnaries issues (William and Oleg
2048 Paraschenko), XInclude empty fallback (William), HTML warnings (William),
2049 XPointer in XInclude (William), Python namespace serialization,
2050 isolat1ToUTF8 bound error (Alfred Mickautsch), output of parameter
2051 entities in internal subset (William), internal subset bug in push mode,
2052 &lt;xs:all&gt; fix (Alexey Sarytchev)</li>
2053 <li>Build: fix for automake-1.8 (Alexander Winston), warnings removal
2054 (Philip Ludlam), SOCKLEN_T detection fixes (Daniel Richard), fix
2055 --with-minimum configuration.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]2056 <li>XInclude: allow the 2001 namespace without warning.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2057 <li>Documentation: missing example/index.html (John Fleck), version
2058 dependancies (John Fleck)</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]2059 <li>reader API: structured error reporting (Steve Ball)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2060 <li>Windows compilation: mingw, msys (Mikhail Grushinskiy), function
2061 prototype (Cameron Johnson), MSVC6 compiler warnings, _WINSOCKAPI_
2062 patch</li>
2063 <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte offest in
2064 input.</li>
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]2065</ul>
2066
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]2067<h3>2.6.5: Jan 25 2004</h3>
2068<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2069 <li>Bugfixes: dictionnaries for schemas (William Brack), regexp segfault
2070 (William), xs:all problem (William), a number of XPointer bugfixes
2071 (William), xmllint error go to stderr, DTD validation problem with
2072 namespace, memory leak (William), SAX1 cleanup and minimal options fixes
2073 (Mark Vadoc), parser context reset on error (Shaun McCance), XPath union
2074 evaluation problem (William) , xmlReallocLoc with NULL (Aleksey Sanin),
2075 XML Schemas double free (Steve Ball), XInclude with no href, argument
2076 callbacks order for XPath callbacks (Frederic Peters)</li>
2077 <li>Documentation: python scripts (William Brack), xslt stylesheets (John
2078 Fleck), doc (Sven Zimmerman), I/O example.</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2079 <li>Python bindings: fixes (William), enum support (Stéphane Bidoul),
2080 structured error reporting (Stéphane Bidoul)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2081 <li>XInclude: various fixes for conformance, problem related to dictionnary
2082 references (William &amp; me), recursion (William)</li>
2083 <li>xmlWriter: indentation (Lucas Brasilino), memory leaks (Alfred
2084 Mickautsch),</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]2085 <li>xmlSchemas: normalizedString datatype (John Belmonte)</li>
2086 <li>code cleanup for strings functions (William)</li>
2087 <li>Windows: compiler patches (Mark Vakoc)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2088 <li>Parser optimizations, a few new XPath and dictionnary APIs for future
2089 XSLT optimizations.</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]2090</ul>
2091
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]2092<h3>2.6.4: Dec 24 2003</h3>
2093<ul>
2094 <li>Windows build fixes (Igor Zlatkovic)</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]2095 <li>Some serious XInclude problems reported by Oleg Paraschenko and</li>
2096 <li>Unix and Makefile packaging fixes (me, William Brack,</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2097 <li>Documentation improvements (John Fleck, William Brack), example fix
2098 (Lucas Brasilino)</li>
2099 <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath handling of
2100 NULL strings (William Brack) , API building reader or parser from
2101 filedescriptor should not close it, changed XPath sorting to be stable
2102 again (William Brack), xmlGetNodePath() generating '(null)' (William
2103 Brack), DTD validation and namespace bug (William Brack), XML Schemas
2104 double inclusion behaviour</li>
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]2105</ul>
2106
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]2107<h3>2.6.3: Dec 10 2003</h3>
2108<ul>
2109 <li>documentation updates and cleanup (DV, William Brack, John Fleck)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2110 <li>added a repository of examples, examples from Aleksey Sanin, Dodji
2111 Seketeli, Alfred Mickautsch</li>
2112 <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher, Mingw
2113 (Kenneth Haley)</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]2114 <li>Unicode range checking (William Brack)</li>
2115 <li>code cleanup (William Brack)</li>
2116 <li>Python bindings: doc (John Fleck), bug fixes</li>
2117 <li>UTF-16 cleanup and BOM issues (William Brack)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2118 <li>bug fixes: ID and xmlReader validation, XPath (William Brack),
2119 xmlWriter (Alfred Mickautsch), hash.h inclusion problem, HTML parser
2120 (James Bursa), attribute defaulting and validation, some serialization
2121 cleanups, XML_GET_LINE macro, memory debug when using threads (William
2122 Brack), serialization of attributes and entities content, xmlWriter
2123 (Daniel Schulman)</li>
2124 <li>XInclude bugfix, new APIs and update to the last version including the
2125 namespace change.</li>
2126 <li>XML Schemas improvements: include (Robert Stepanek), import and
2127 namespace handling, fixed the regression tests troubles, added examples
2128 based on Eric van der Vlist book, regexp fixes</li>
2129 <li>preliminary pattern support for streaming (needed for schemas
2130 constraints), added xmlTextReaderPreservePattern() to collect subdocument
2131 when streaming.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]2132 <li>various fixes in the structured error handling</li>
2133</ul>
2134
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]2135<h3>2.6.2: Nov 4 2003</h3>
2136<ul>
2137 <li>XPath context unregistration fixes</li>
2138 <li>text node coalescing fixes (Mark Lilback)</li>
2139 <li>API to screate a W3C Schemas from an existing document (Steve Ball)</li>
2140 <li>BeOS patches (Marcin 'Shard' Konicki)</li>
2141 <li>xmlStrVPrintf function added (Aleksey Sanin)</li>
2142 <li>compilation fixes (Mark Vakoc)</li>
2143 <li>stdin parsing fix (William Brack)</li>
2144 <li>a posteriori DTD validation fixes</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]2145 <li>xmlReader bug fixes: Walker fixes, python bindings</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]2146 <li>fixed xmlStopParser() to really stop the parser and errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2147 <li>always generate line numbers when using the new xmlReadxxx
2148 functions</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]2149 <li>added XInclude support to the xmlReader interface</li>
2150 <li>implemented XML_PARSE_NONET parser option</li>
2151 <li>DocBook XSLT processing bug fixed</li>
2152 <li>HTML serialization for &lt;p&gt; elements (William Brack and me)</li>
2153 <li>XPointer failure in XInclude are now handled as resource errors</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2154 <li>fixed xmllint --html to use the HTML serializer on output (added
2155 --xmlout to implement the previous behaviour of saving it using the XML
2156 serializer)</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]2157</ul>
2158
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]2159<h3>2.6.1: Oct 28 2003</h3>
2160<ul>
2161 <li>Mostly bugfixes after the big 2.6.0 changes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2162 <li>Unix compilation patches: libxml.m4 (Patrick Welche), warnings cleanup
2163 (William Brack)</li>
2164 <li>Windows compilation patches (Joachim Bauch, Stephane Bidoul, Igor
2165 Zlatkovic)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]2166 <li>xmlWriter bugfix (Alfred Mickautsch)</li>
2167 <li>chvalid.[ch]: couple of fixes from Stephane Bidoul</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2168 <li>context reset: error state reset, push parser reset (Graham
2169 Bennett)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]2170 <li>context reuse: generate errors if file is not readable</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2171 <li>defaulted attributes for element coming from internal entities
2172 (Stephane Bidoul)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]2173 <li>Python: tab and spaces mix (William Brack)</li>
2174 <li>Error handler could crash in DTD validation in 2.6.0</li>
2175 <li>xmlReader: do not use the document or element _private field</li>
2176 <li>testSAX.c: avoid a problem with some PIs (Massimo Morara)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2177 <li>general bug fixes: mandatory encoding in text decl, serializing
2178 Document Fragment nodes, xmlSearchNs 2.6.0 problem (Kasimier Buchcik),
2179 XPath errors not reported, slow HTML parsing of large documents.</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]2180</ul>
2181
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]2182<h3>2.6.0: Oct 20 2003</h3>
2183<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2184 <li>Major revision release: should be API and ABI compatible but got a lot
2185 of change</li>
2186 <li>Increased the library modularity, far more options can be stripped out,
2187 a --with-minimum configuration will weight around 160KBytes</li>
2188 <li>Use per parser and per document dictionnary, allocate names and small
2189 text nodes from the dictionnary</li>
2190 <li>Switch to a SAX2 like parser rewrote most of the XML parser core,
2191 provides namespace resolution and defaulted attributes, minimize memory
2192 allocations and copies, namespace checking and specific error handling,
2193 immutable buffers, make predefined entities static structures, etc...</li>
2194 <li>rewrote all the error handling in the library, all errors can be
2195 intercepted at a structured level, with precise information
2196 available.</li>
2197 <li>New simpler and more generic XML and HTML parser APIs, allowing to
2198 easilly modify the parsing options and reuse parser context for multiple
2199 consecutive documents.</li>
2200 <li>Similar new APIs for the xmlReader, for options and reuse, provided new
2201 functions to access content as const strings, use them for Python
2202 bindings</li>
2203 <li>a lot of other smaller API improvements: xmlStrPrintf (Aleksey Sanin),
2204 Walker i.e. reader on a document tree based on Alfred Mickautsch code,
2205 make room in nodes for line numbers, reference counting and future PSVI
2206 extensions, generation of character ranges to be checked with faster
2207 algorithm (William), xmlParserMaxDepth (Crutcher Dunnavant), buffer
2208 access</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]2209 <li>New xmlWriter API provided by Alfred Mickautsch</li>
2210 <li>Schemas: base64 support by Anthony Carrico</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2211 <li>Parser&lt;-&gt;HTTP integration fix, proper processing of the Mime-Type
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]2212 and charset information if available.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2213 <li>Relax-NG: bug fixes including the one reported by Martijn Faassen and
2214 zeroOrMore, better error reporting.</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2215 <li>Python bindings (Stéphane Bidoul), never use stdout for errors
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2216 output</li>
2217 <li>Portability: all the headers have macros for export and calling
2218 convention definitions (Igor Zlatkovic), VMS update (Craig A. Berry),
2219 Windows: threads (Jesse Pelton), Borland compiler (Eric Zurcher, Igor),
2220 Mingw (Igor), typos (Mark Vakoc), beta version (Stephane Bidoul),
2221 warning cleanups on AIX and MIPS compilers (William Brack), BeOS (Marcin
2222 'Shard' Konicki)</li>
2223 <li>Documentation fixes and README (William Brack), search fix (William),
2224 tutorial updates (John Fleck), namespace docs (Stefan Kost)</li>
2225 <li>Bug fixes: xmlCleanupParser (Dave Beckett), threading uninitialized
2226 mutexes, HTML doctype lowercase, SAX/IO (William), compression detection
2227 and restore (William), attribute declaration in DTDs (William), namespace
2228 on attribute in HTML output (William), input filename (Rob Richards),
2229 namespace DTD validation, xmlReplaceNode (Chris Ryland), I/O callbacks
2230 (Markus Keim), CDATA serialization (Shaun McCance), xmlReader (Peter
2231 Derr), high codepoint charref like &amp;#x10FFFF;, buffer access in push
2232 mode (Justin Fletcher), TLS threads on Windows (Jesse Pelton), XPath bug
2233 (William), xmlCleanupParser (Marc Liyanage), CDATA output (William), HTTP
2234 error handling.</li>
2235 <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 for compat
2236 testing, --nodict for building without tree dictionnary, --nocdata to
2237 replace CDATA by text, --nsclean to remove surperfluous namespace
2238 declarations</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]2239 <li>added xml2-config --libtool-libs option from Kevin P. Fleming</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2240 <li>a lot of profiling and tuning of the code, speedup patch for
2241 xmlSearchNs() by Luca Padovani. The xmlReader should do far less
2242 allocation and it speed should get closer to SAX. Chris Anderson worked
2243 on speeding and cleaning up repetitive checking code.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]2244 <li>cleanup of "make tests"</li>
2245 <li>libxml-2.0-uninstalled.pc from Malcolm Tredinnick</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2246 <li>deactivated the broken docBook SGML parser code and plugged the XML
2247 parser instead.</li>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]2248</ul>
2249
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]2250<h3>2.5.11: Sep 9 2003</h3>
2251
2252<p>A bugfix only release:</p>
2253<ul>
2254 <li>risk of crash in Relax-NG</li>
2255 <li>risk of crash when using multithreaded programs</li>
2256</ul>
2257
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]2258<h3>2.5.10: Aug 15 2003</h3>
2259
2260<p>A bugfixes only release</p>
2261<ul>
2262 <li>Windows Makefiles (William Brack)</li>
2263 <li>UTF-16 support fixes (Mark Itzcovitz)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2264 <li>Makefile and portability (William Brack) automake, Linux alpha, Mingw
2265 on Windows (Mikhail Grushinskiy)</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]2266 <li>HTML parser (Oliver Stoeneberg)</li>
2267 <li>XInclude performance problem reported by Kevin Ruscoe</li>
2268 <li>XML parser performance problem reported by Grant Goodale</li>
2269 <li>xmlSAXParseDTD() bug fix from Malcolm Tredinnick</li>
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]2270 <li>and a couple other cleanup</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]2271</ul>
2272
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]2273<h3>2.5.9: Aug 9 2003</h3>
2274<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2275 <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), Windows build
2276 (Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter Sobisch), threading
2277 (Rob Richards), hexBinary type (), UTF-16 BOM (Dodji Seketeli),
2278 xmlReader, Relax-NG schemas compilation, namespace handling, EXSLT (Sean
2279 Griffin), HTML parsing problem (William Brack), DTD validation for mixed
2280 content + namespaces, HTML serialization, library initialization,
2281 progressive HTML parser</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]2282 <li>better interfaces for Relax-NG error handling (Joachim Bauch, )</li>
2283 <li>adding xmlXIncludeProcessTree() for XInclud'ing in a subtree</li>
2284 <li>doc fixes and improvements (John Fleck)</li>
2285 <li>configure flag for -with-fexceptions when embedding in C++</li>
2286 <li>couple of new UTF-8 helper functions (William Brack)</li>
2287 <li>general encoding cleanup + ISO-8859-x without iconv (Peter Jacobi)</li>
2288 <li>xmlTextReader cleanup + enum for node types (Bjorn Reese)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2289 <li>general compilation/warning cleanup Solaris/HP-UX/... (William
2290 Brack)</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]2291</ul>
2292
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]2293<h3>2.5.8: Jul 6 2003</h3>
2294<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2295 <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 save (Mark
2296 Itzcovitz), UTF-8 checking, URI saving, error printing (William Brack),
2297 PI related memleak, compilation without schemas or without xpath (Joerg
2298 Schmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem with DTDs,
2299 rpm problem on , i86_64, removed a few compilation problems from 2.5.7,
2300 xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]2301 <li>portability: DJGPP (MsDos) , OpenVMS (Craig A. Berry)</li>
2302 <li>William Brack fixed multithreading lock problems</li>
2303 <li>IPv6 patch for FTP and HTTP accesses (Archana Shah/Wipro)</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2304 <li>Windows fixes (Igor Zlatkovic, Eric Zurcher), threading (Stéphane
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2305 Bidoul)</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]2306 <li>A few W3C Schemas Structure improvements</li>
2307 <li>W3C Schemas Datatype improvements (Charlie Bozeman)</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2308 <li>Python bindings for thread globals (Stéphane Bidoul), and method/class
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2309 generator</li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]2310 <li>added --nonet option to xmllint</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]2311 <li>documentation improvements (John Fleck)</li>
2312</ul>
2313
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]2314<h3>2.5.7: Apr 25 2003</h3>
2315<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2316 <li>Relax-NG: Compiling to regexp and streaming validation on top of the
2317 xmlReader interface, added to xmllint --stream</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]2318 <li>xmlReader: Expand(), Next() and DOM access glue, bug fixes</li>
2319 <li>Support for large files: RGN validated a 4.5GB instance</li>
2320 <li>Thread support is now configured in by default</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2321 <li>Fixes: update of the Trio code (Bjorn), WXS Date and Duration fixes
2322 (Charles Bozeman), DTD and namespaces (Brent Hendricks), HTML push parser
2323 and zero bytes handling, some missing Windows file path conversions,
2324 behaviour of the parser and validator in the presence of "out of memory"
2325 error conditions</li>
2326 <li>extended the API to be able to plug a garbage collecting memory
2327 allocator, added xmlMallocAtomic() and modified the allocations
2328 accordingly.</li>
2329 <li>Performances: removed excessive malloc() calls, speedup of the push and
2330 xmlReader interfaces, removed excessive thread locking</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]2331 <li>Documentation: man page (John Fleck), xmlReader documentation</li>
2332 <li>Python: adding binding for xmlCatalogAddLocal (Brent M Hendricks)</li>
2333</ul>
2334
Daniel Veillardc2d4a932003-04-01 11:13:05 +0000[diff] [blame]2335<h3>2.5.6: Apr 1 2003</h3>
2336<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2337 <li>Fixed W3C XML Schemas datatype, should be compliant now except for
2338 binHex and base64 which are not supported yet.</li>
2339 <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large docs and
2340 XInclude entities handling, encoding detection on external subsets, XML
2341 Schemas bugs and memory leaks, HTML parser (James Bursa)</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +0000[diff] [blame]2342 <li>portability: python/trio (Albert Chin), Sun compiler warnings</li>
2343 <li>documentation: added --relaxng option to xmllint man page (John)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2344 <li>improved error reporting: xml:space, start/end tag mismatches, Relax NG
2345 errors</li>
Daniel Veillardc2d4a932003-04-01 11:13:05 +0000[diff] [blame]2346</ul>
2347
2348<h3>2.5.5: Mar 24 2003</h3>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]2349<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2350 <li>Lot of fixes on the Relax NG implementation. More testing including
2351 DocBook and TEI examples.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]2352 <li>Increased the support for W3C XML Schemas datatype</li>
2353 <li>Several bug fixes in the URI handling layer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2354 <li>Bug fixes: HTML parser, xmlReader, DTD validation, XPath, encoding
2355 conversion, line counting in the parser.</li>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]2356 <li>Added support for $XMLLINT_INDENT environment variable, FTP delete</li>
2357 <li>Fixed the RPM spec file name</li>
2358</ul>
2359
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]2360<h3>2.5.4: Feb 20 2003</h3>
2361<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2362 <li>Conformance testing and lot of fixes on Relax NG and XInclude
2363 implementation</li>
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]2364 <li>Implementation of XPointer element() scheme</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2365 <li>Bug fixes: XML parser, XInclude entities merge, validity checking on
2366 namespaces,
2367 <p>2 serialization bugs, node info generation problems, a DTD regexp
2368 generation problem.</p>
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]2369 </li>
2370 <li>Portability: windows updates and path canonicalization (Igor)</li>
2371 <li>A few typo fixes (Kjartan Maraas)</li>
2372 <li>Python bindings generator fixes (Stephane Bidoul)</li>
2373</ul>
2374
Daniel Veillard1d788d22003-02-10 16:21:58 +0000[diff] [blame]2375<h3>2.5.3: Feb 10 2003</h3>
2376<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2377 <li>RelaxNG and XML Schemas datatypes improvements, and added a first
2378 version of RelaxNG Python bindings</li>
2379 <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API fix for
2380 serializing namespace nodes, encoding conversion bug, XHTML1
2381 serialization</li>
Daniel Veillard1d788d22003-02-10 16:21:58 +0000[diff] [blame]2382 <li>Portability fixes: Windows (Igor), AMD 64bits RPM spec file</li>
2383</ul>
2384
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]2385<h3>2.5.2: Feb 5 2003</h3>
2386<ul>
2387 <li>First implementation of RelaxNG, added --relaxng flag to xmllint</li>
2388 <li>Schemas support now compiled in by default.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2389 <li>Bug fixes: DTD validation, namespace checking, XInclude and entities,
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2390 delegateURI in XML Catalogs, HTML parser, XML reader (Stéphane Bidoul),
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2391 XPath parser and evaluation, UTF8ToUTF8 serialization, XML reader memory
2392 consumption, HTML parser, HTML serialization in the presence of
2393 namespaces</li>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]2394 <li>added an HTML API to check elements and attributes.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2395 <li>Documentation improvement, PDF for the tutorial (John Fleck), doc
2396 patches (Stefan Kost)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]2397 <li>Portability fixes: NetBSD (Julio Merino), Windows (Igor Zlatkovic)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2398 <li>Added python bindings for XPointer, contextual error reporting
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2399 (Stéphane Bidoul)</li>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]2400 <li>URI/file escaping problems (Stefano Zacchiroli)</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]2401</ul>
2402
Daniel Veillarde2830f12003-01-08 17:47:49 +0000[diff] [blame]2403<h3>2.5.1: Jan 8 2003</h3>
2404<ul>
2405 <li>Fixes a memory leak and configuration/compilation problems in 2.5.0</li>
2406 <li>documentation updates (John)</li>
2407 <li>a couple of XmlTextReader fixes</li>
2408</ul>
2409
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2410<h3>2.5.0: Jan 6 2003</h3>
2411<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2412 <li>New <a href="xmlreader.html">XmltextReader interface</a> based on C#
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2413 API (with help of Stéphane Bidoul)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2414 <li>Windows: more exports, including the new API (Igor)</li>
2415 <li>XInclude fallback fix</li>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2416 <li>Python: bindings for the new API, packaging (Stéphane Bidoul),
2417 drv_libxml2.py Python xml.sax driver (Stéphane Bidoul), fixes, speedup
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2418 and iterators for Python-2.2 (Hannu Krosing)</li>
2419 <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint man update
2420 (John)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2421 <li>Fix an XML parser bug raised by Vyacheslav Pindyura</li>
2422 <li>Fix for VMS serialization (Nigel Hall) and config (Craig A. Berry)</li>
2423 <li>Entities handling fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2424 <li>new API to optionally track node creation and deletion (Lukas
2425 Schroeder)</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2426 <li>Added documentation for the XmltextReader interface and some <a
2427 href="guidelines.html">XML guidelines</a></li>
2428</ul>
2429
Daniel Veillardc1eed322002-12-12 11:01:32 +0000[diff] [blame]2430<h3>2.4.30: Dec 12 2002</h3>
2431<ul>
2432 <li>2.4.29 broke the python bindings, rereleasing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2433 <li>Improvement/fixes of the XML API generator, and couple of minor code
2434 fixes.</li>
Daniel Veillardc1eed322002-12-12 11:01:32 +0000[diff] [blame]2435</ul>
2436
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]2437<h3>2.4.29: Dec 11 2002</h3>
2438<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2439 <li>Windows fixes (Igor): Windows CE port, pthread linking, python bindings
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2440 (Stéphane Bidoul), Mingw (Magnus Henoch), and export list updates</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]2441 <li>Fix for prev in python bindings (ERDI Gergo)</li>
2442 <li>Fix for entities handling (Marcus Clarke)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2443 <li>Refactored the XML and HTML dumps to a single code path, fixed XHTML1
2444 dump</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]2445 <li>Fix for URI parsing when handling URNs with fragment identifiers</li>
2446 <li>Fix for HTTP URL escaping problem</li>
2447 <li>added an TextXmlReader (C#) like API (work in progress)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2448 <li>Rewrote the API in XML generation script, includes a C parser and saves
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]2449 more information needed for C# bindings</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]2450</ul>
2451
Daniel Veillardf9c4cad2002-11-22 15:57:07 +0000[diff] [blame]2452<h3>2.4.28: Nov 22 2002</h3>
2453<ul>
2454 <li>a couple of python binding fixes</li>
2455 <li>2 bug fixes in the XML push parser</li>
2456 <li>potential memory leak removed (Martin Stoilov)</li>
2457 <li>fix to the configure script for Unix (Dimitri Papadopoulos)</li>
2458 <li>added encoding support for XInclude parse="text"</li>
2459 <li>autodetection of XHTML1 and specific serialization rules added</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]2460 <li>nasty threading bug fixed (William Brack)</li>
Daniel Veillardf9c4cad2002-11-22 15:57:07 +0000[diff] [blame]2461</ul>
2462
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]2463<h3>2.4.27: Nov 17 2002</h3>
2464<ul>
2465 <li>fixes for the Python bindings</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2466 <li>a number of bug fixes: SGML catalogs, xmlParseBalancedChunkMemory(),
2467 HTML parser, Schemas (Charles Bozeman), document fragment support
2468 (Christian Glahn), xmlReconciliateNs (Brian Stafford), XPointer,
2469 xmlFreeNode(), xmlSAXParseMemory (Peter Jones), xmlGetNodePath (Petr
2470 Pajas), entities processing</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]2471 <li>added grep to xmllint --shell</li>
2472 <li>VMS update patch from Craig A. Berry</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2473 <li>cleanup of the Windows build with support for more compilers (Igor),
2474 better thread support on Windows</li>
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]2475 <li>cleanup of Unix Makefiles and spec file</li>
2476 <li>Improvements to the documentation (John Fleck)</li>
2477</ul>
2478
Daniel Veillard48267432002-10-18 11:21:38 +0000[diff] [blame]2479<h3>2.4.26: Oct 18 2002</h3>
2480<ul>
2481 <li>Patches for Windows CE port, improvements on Windows paths handling</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2482 <li>Fixes to the validation code (DTD and Schemas), xmlNodeGetPath() ,
2483 HTML serialization, Namespace compliance, and a number of small
2484 problems</li>
Daniel Veillard48267432002-10-18 11:21:38 +0000[diff] [blame]2485</ul>
2486
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]2487<h3>2.4.25: Sep 26 2002</h3>
2488<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2489 <li>A number of bug fixes: XPath, validation, Python bindings, DOM and
2490 tree, xmlI/O, Html</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]2491 <li>Serious rewrite of XInclude</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2492 <li>Made XML Schemas regexp part of the default build and APIs, small fix
2493 and improvement of the regexp core</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]2494 <li>Changed the validation code to reuse XML Schemas regexp APIs</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2495 <li>Better handling of Windows file paths, improvement of Makefiles (Igor,
2496 Daniel Gehriger, Mark Vakoc)</li>
2497 <li>Improved the python I/O bindings, the tests, added resolver and regexp
2498 APIs</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]2499 <li>New logos from Marc Liyanage</li>
2500 <li>Tutorial improvements: John Fleck, Christopher Harris</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2501 <li>Makefile: Fixes for AMD x86_64 (Mandrake), DESTDIR (Christophe
2502 Merlet)</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]2503 <li>removal of all stderr/perror use for error reporting</li>
2504 <li>Better error reporting: XPath and DTD validation</li>
2505 <li>update of the trio portability layer (Bjorn Reese)</li>
2506</ul>
2507
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2508<p><strong>2.4.24: Aug 22 2002</strong></p>
2509<ul>
2510 <li>XPath fixes (William), xf:escape-uri() (Wesley Terpstra)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2511 <li>Python binding fixes: makefiles (William), generator, rpm build, x86-64
2512 (fcrozat)</li>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2513 <li>HTML &lt;style&gt; and boolean attributes serializer fixes</li>
2514 <li>C14N improvements by Aleksey</li>
Daniel Veillarde1662542002-08-28 11:50:59 +0000[diff] [blame]2515 <li>doc cleanups: Rick Jones</li>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2516 <li>Windows compiler makefile updates: Igor and Elizabeth Barham</li>
2517 <li>XInclude: implementation of fallback and xml:base fixup added</li>
2518</ul>
2519
Daniel Veillard782afda2002-07-08 15:12:49 +0000[diff] [blame]2520<h3>2.4.23: July 6 2002</h3>
2521<ul>
2522 <li>performances patches: Peter Jacobi</li>
2523 <li>c14n fixes, testsuite and performances: Aleksey Sanin</li>
2524 <li>added xmlDocFormatDump: Chema Celorio</li>
2525 <li>new tutorial: John Fleck</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2526 <li>new hash functions and performances: Sander Vesik, portability fix from
2527 Peter Jacobi</li>
2528 <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XML and
2529 HTML parsers, ID lookup function</li>
Daniel Veillard782afda2002-07-08 15:12:49 +0000[diff] [blame]2530 <li>removal of all remaining sprintf: Aleksey Sanin</li>
2531</ul>
2532
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2533<h3>2.4.22: May 27 2002</h3>
2534<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2535 <li>a number of bug fixes: configure scripts, base handling, parser, memory
2536 usage, HTML parser, XPath, documentation (Christian Cornelssen),
2537 indentation, URI parsing</li>
2538 <li>Optimizations for XMLSec, fixing and making public some of the network
2539 protocol handlers (Aleksey)</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2540 <li>performance patch from Gary Pennington</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2541 <li>Charles Bozeman provided date and time support for XML Schemas
2542 datatypes</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2543</ul>
2544
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]2545<h3>2.4.21: Apr 29 2002</h3>
2546
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2547<p>This release is both a bug fix release and also contains the early XML
2548Schemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a> and <a
2549href="http://www.w3.org/TR/xmlschema-2/">datatypes</a> code, beware, all
2550interfaces are likely to change, there is huge holes, it is clearly a work in
2551progress and don't even think of putting this code in a production system,
2552it's actually not compiled in by default. The real fixes are:</p>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]2553<ul>
2554 <li>a couple of bugs or limitations introduced in 2.4.20</li>
2555 <li>patches for Borland C++ and MSC by Igor</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2556 <li>some fixes on XPath strings and conformance patches by Richard
2557 Jinks</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]2558 <li>patch from Aleksey for the ExcC14N specification</li>
2559 <li>OSF/1 bug fix by Bjorn</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2560</ul>
2561
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]2562<h3>2.4.20: Apr 15 2002</h3>
2563<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2564 <li>bug fixes: file descriptor leak, XPath, HTML output, DTD validation</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]2565 <li>XPath conformance testing by Richard Jinks</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2566 <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, python bindings,
2567 libxml.m4</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]2568</ul>
2569
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]2570<h3>2.4.19: Mar 25 2002</h3>
2571<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2572 <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin to UTF8
2573 encoder</li>
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]2574 <li>portability fixes in the HTTP code</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +0000[diff] [blame]2575 <li>memory allocation checks using valgrind, and profiling tests</li>
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]2576 <li>revamp of the Windows build and Makefiles</li>
2577</ul>
2578
Daniel Veillard34ce8be2002-03-18 19:37:11 +0000[diff] [blame]2579<h3>2.4.18: Mar 18 2002</h3>
2580<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2581 <li>bug fixes: tree, SAX, canonicalization, validation, portability,
2582 XPath</li>
Daniel Veillard34ce8be2002-03-18 19:37:11 +0000[diff] [blame]2583 <li>removed the --with-buffer option it was becoming unmaintainable</li>
2584 <li>serious cleanup of the Python makefiles</li>
2585 <li>speedup patch to XPath very effective for DocBook stylesheets</li>
2586 <li>Fixes for Windows build, cleanup of the documentation</li>
2587</ul>
2588
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2589<h3>2.4.17: Mar 8 2002</h3>
2590<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2591 <li>a lot of bug fixes, including "namespace nodes have no parents in
2592 XPath"</li>
2593 <li>fixed/improved the Python wrappers, added more examples and more
2594 regression tests, XPath extension functions can now return node-sets</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2595 <li>added the XML Canonicalization support from Aleksey Sanin</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2596</ul>
2597
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000[diff] [blame]2598<h3>2.4.16: Feb 20 2002</h3>
2599<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2600 <li>a lot of bug fixes, most of them were triggered by the XML Testsuite
2601 from OASIS and W3C. Compliance has been significantly improved.</li>
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000[diff] [blame]2602 <li>a couple of portability fixes too.</li>
2603</ul>
2604
Daniel Veillard397ff112002-02-11 18:27:20 +0000[diff] [blame]2605<h3>2.4.15: Feb 11 2002</h3>
2606<ul>
2607 <li>Fixed the Makefiles, especially the python module ones</li>
2608 <li>A few bug fixes and cleanup</li>
2609 <li>Includes cleanup</li>
2610</ul>
2611
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame]2612<h3>2.4.14: Feb 8 2002</h3>
2613<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2614 <li>Change of License to the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2615 href="http://www.opensource.org/licenses/mit-license.html">MIT
2616 License</a> basically for integration in XFree86 codebase, and removing
2617 confusion around the previous dual-licensing</li>
2618 <li>added Python bindings, beta software but should already be quite
2619 complete</li>
2620 <li>a large number of fixes and cleanups, especially for all tree
2621 manipulations</li>
2622 <li>cleanup of the headers, generation of a reference API definition in
2623 XML</li>
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame]2624</ul>
2625
2626<h3>2.4.13: Jan 14 2002</h3>
Daniel Veillard744683d2002-01-14 17:30:20 +0000[diff] [blame]2627<ul>
2628 <li>update of the documentation: John Fleck and Charlie Bozeman</li>
2629 <li>cleanup of timing code from Justin Fletcher</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2630 <li>fixes for Windows and initial thread support on Win32: Igor and Serguei
2631 Narojnyi</li>
Daniel Veillard744683d2002-01-14 17:30:20 +0000[diff] [blame]2632 <li>Cygwin patch from Robert Collins</li>
2633 <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li>
2634</ul>
2635
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]2636<h3>2.4.12: Dec 7 2001</h3>
2637<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2638 <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman),
2639 XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups
2640 (robert)</li>
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]2641 <li>Eric Lavigne contributed project files for MacOS</li>
2642 <li>some makefiles cleanups</li>
2643</ul>
2644
Daniel Veillarda4871052001-11-26 13:19:48 +0000[diff] [blame]2645<h3>2.4.11: Nov 26 2001</h3>
2646<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2647 <li>fixed a couple of errors in the includes, fixed a few bugs, some code
2648 cleanups</li>
Daniel Veillarda4871052001-11-26 13:19:48 +0000[diff] [blame]2649 <li>xmllint man pages improvement by Heiko Rupp</li>
2650 <li>updated VMS build instructions from John A Fotheringham</li>
2651 <li>Windows Makefiles updates from Igor</li>
2652</ul>
2653
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]2654<h3>2.4.10: Nov 10 2001</h3>
2655<ul>
2656 <li>URI escaping fix (Joel Young)</li>
2657 <li>added xmlGetNodePath() (for paths or XPointers generation)</li>
2658 <li>Fixes namespace handling problems when using DTD and validation</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2659 <li>improvements on xmllint: Morus Walter patches for --format and
2660 --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li>
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]2661 <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li>
2662 <li>fixes to the HTML parser</li>
2663</ul>
2664
2665<h3>2.4.9: Nov 6 2001</h3>
2666<ul>
2667 <li>fixes more catalog bugs</li>
2668 <li>avoid a compilation problem, improve xmlGetLineNo()</li>
2669</ul>
2670
Daniel Veillarded421aa2001-11-04 21:22:45 +0000[diff] [blame]2671<h3>2.4.8: Nov 4 2001</h3>
2672<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2673 <li>fixed SGML catalogs broken in previous release, updated xmlcatalog
2674 tool</li>
Daniel Veillarded421aa2001-11-04 21:22:45 +0000[diff] [blame]2675 <li>fixed a compile errors and some includes troubles.</li>
2676</ul>
2677
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]2678<h3>2.4.7: Oct 30 2001</h3>
2679<ul>
2680 <li>exported some debugging interfaces</li>
2681 <li>serious rewrite of the catalog code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2682 <li>integrated Gary Pennington thread safety patch, added configure option
2683 and regression tests</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]2684 <li>removed an HTML parser bug</li>
2685 <li>fixed a couple of potentially serious validation bugs</li>
2686 <li>integrated the SGML DocBook support in xmllint</li>
2687 <li>changed the nanoftp anonymous login passwd</li>
2688 <li>some I/O cleanup and a couple of interfaces for Perl wrapper</li>
2689 <li>general bug fixes</li>
2690 <li>updated xmllint man page by John Fleck</li>
2691 <li>some VMS and Windows updates</li>
2692</ul>
2693
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]2694<h3>2.4.6: Oct 10 2001</h3>
2695<ul>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]2696 <li>added an updated man pages by John Fleck</li>
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]2697 <li>portability and configure fixes</li>
2698 <li>an infinite loop on the HTML parser was removed (William)</li>
2699 <li>Windows makefile patches from Igor</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2700 <li>fixed half a dozen bugs reported for libxml or libxslt</li>
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]2701 <li>updated xmlcatalog to be able to modify SGML super catalogs</li>
2702</ul>
2703
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]2704<h3>2.4.5: Sep 14 2001</h3>
2705<ul>
2706 <li>Remove a few annoying bugs in 2.4.4</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2707 <li>forces the HTML serializer to output decimal charrefs since some
2708 version of Netscape can't handle hexadecimal ones</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]2709</ul>
2710
2711<h3>1.8.16: Sep 14 2001</h3>
2712<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2713 <li>maintenance release of the old libxml1 branch, couple of bug and
2714 portability fixes</li>
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]2715</ul>
2716
Daniel Veillard04382ae2001-09-12 18:51:30 +0000[diff] [blame]2717<h3>2.4.4: Sep 12 2001</h3>
2718<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2719 <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
2720 Catalog</li>
Daniel Veillard04382ae2001-09-12 18:51:30 +0000[diff] [blame]2721 <li>a few bug fixes and some portability changes</li>
2722 <li>some documentation cleanups</li>
2723</ul>
2724
Daniel Veillard39936902001-08-24 00:49:01 +0000[diff] [blame]2725<h3>2.4.3: Aug 23 2001</h3>
2726<ul>
2727 <li>XML Catalog support see the doc</li>
2728 <li>New NaN/Infinity floating point code</li>
2729 <li>A few bug fixes</li>
2730</ul>
2731
2732<h3>2.4.2: Aug 15 2001</h3>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2733<ul>
2734 <li>adds xmlLineNumbersDefault() to control line number generation</li>
2735 <li>lot of bug fixes</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2736 <li>the Microsoft MSC projects files should now be up to date</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2737 <li>inheritance of namespaces from DTD defaulted attributes</li>
2738 <li>fixes a serious potential security bug</li>
2739 <li>added a --format option to xmllint</li>
2740</ul>
2741
2742<h3>2.4.1: July 24 2001</h3>
2743<ul>
2744 <li>possibility to keep line numbers in the tree</li>
2745 <li>some computation NaN fixes</li>
2746 <li>extension of the XPath API</li>
2747 <li>cleanup for alpha and ia64 targets</li>
2748 <li>patch to allow saving through HTTP PUT or POST</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]2749</ul>
2750
2751<h3>2.4.0: July 10 2001</h3>
2752<ul>
2753 <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2754 <li>Fixed XML Base implementation, added a couple of examples to the
2755 regression tests</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]2756 <li>A bit of cleanup</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]2757</ul>
2758
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]2759<h3>2.3.14: July 5 2001</h3>
2760<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2761 <li>fixed some entities problems and reduce memory requirement when
2762 substituting them</li>
2763 <li>lots of improvements in the XPath queries interpreter can be
2764 substantially faster</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]2765 <li>Makefiles and configure cleanups</li>
2766 <li>Fixes to XPath variable eval, and compare on empty node set</li>
2767 <li>HTML tag closing bug fixed</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2768 <li>Fixed an URI reference computation problem when validating</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]2769</ul>
2770
Daniel Veillard2adbb512001-06-28 16:20:36 +0000[diff] [blame]2771<h3>2.3.13: June 28 2001</h3>
2772<ul>
2773 <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
2774 <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
2775</ul>
2776
2777<h3>1.8.14: June 28 2001</h3>
2778<ul>
2779 <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
2780 <li>Small Makefile fix</li>
2781</ul>
2782
Daniel Veillard11648102001-06-26 16:08:24 +0000[diff] [blame]2783<h3>2.3.12: June 26 2001</h3>
2784<ul>
2785 <li>lots of cleanup</li>
2786 <li>a couple of validation fix</li>
2787 <li>fixed line number counting</li>
2788 <li>fixed serious problems in the XInclude processing</li>
2789 <li>added support for UTF8 BOM at beginning of entities</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2790 <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
2791 miscompile uri.c (William), Thomas Leitner provided a fix for the
2792 optimizer on Tru64</li>
2793 <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
2794 compilation on Windows MSC</li>
Daniel Veillard11648102001-06-26 16:08:24 +0000[diff] [blame]2795 <li>update of libxml-doc.el (Felix Natter)</li>
2796 <li>fixed 2 bugs in URI normalization code</li>
2797</ul>
2798
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]2799<h3>2.3.11: June 17 2001</h3>
2800<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2801 <li>updates to trio, Makefiles and configure should fix some portability
2802 problems (alpha)</li>
2803 <li>fixed some HTML serialization problems (pre, script, and block/inline
2804 handling), added encoding aware APIs, cleanup of this code</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]2805 <li>added xmlHasNsProp()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2806 <li>implemented a specific PI for encoding support in the DocBook SGML
2807 parser</li>
2808 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
2809 node selection)</li>
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]2810 <li>fixed a performance problem and an error in the validation code</li>
2811 <li>fixed XInclude routine to implement the recursive behaviour</li>
2812 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
2813 <li>added --version to xmllint for bug reports</li>
2814</ul>
2815
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]2816<h3>2.3.10: June 1 2001</h3>
2817<ul>
2818 <li>fixed the SGML catalog support</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2819 <li>a number of reported bugs got fixed, in XPath, iconv detection,
2820 XInclude processing</li>
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]2821 <li>XPath string function should now handle unicode correctly</li>
2822</ul>
2823
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]2824<h3>2.3.9: May 19 2001</h3>
2825
2826<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
2827<ul>
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]2828 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2829 <li>some serious speed optimization again</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]2830 <li>some documentation cleanups</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2831 <li>trying to get better linking on Solaris (-R)</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]2832 <li>XPath API cleanup from Thomas Broyer</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2833 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
2834 xmlValidGetValidElements()</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]2835 <li>Added an INSTALL file</li>
2836 <li>Attribute removal added to API: #54433</li>
2837 <li>added a basic support for SGML catalogs</li>
2838 <li>fixed xmlKeepBlanksDefault(0) API</li>
2839 <li>bugfix in xmlNodeGetLang()</li>
2840 <li>fixed a small configure portability problem</li>
2841 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
2842</ul>
2843
Daniel Veillarda265af72001-05-14 11:13:58 +0000[diff] [blame]2844<h3>1.8.13: May 14 2001</h3>
2845<ul>
2846 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
2847</ul>
2848
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]2849<h3>2.3.8: May 3 2001</h3>
2850<ul>
2851 <li>Integrated an SGML DocBook parser for the Gnome project</li>
2852 <li>Fixed a few things in the HTML parser</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2853 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
2854 point portability issue</li>
2855 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
2856 DOM+validation using the XML REC as input and a 700MHz celeron).</li>
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]2857 <li>incorporated more Windows cleanup</li>
2858 <li>added xmlSaveFormatFile()</li>
2859 <li>fixed problems in copying nodes with entities references (gdome)</li>
2860 <li>removed some troubles surrounding the new validation module</li>
2861</ul>
2862
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2863<h3>2.3.7: April 22 2001</h3>
2864<ul>
2865 <li>lots of small bug fixes, corrected XPointer</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2866 <li>Non deterministic content model validation support</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2867 <li>added xmlDocCopyNode for gdome2</li>
2868 <li>revamped the way the HTML parser handles end of tags</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2869 <li>XPath: corrections of namespaces support and number formatting</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2870 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2871 <li>HTML output fixes from P C Chow and William M. Brack</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]2872 <li>Improved validation speed sensible for DocBook</li>
2873 <li>fixed a big bug with ID declared in external parsed entities</li>
2874 <li>portability fixes, update of Trio from Bjorn Reese</li>
2875</ul>
2876
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]2877<h3>2.3.6: April 8 2001</h3>
2878<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2879 <li>Code cleanup using extreme gcc compiler warning options, found and
2880 cleared half a dozen potential problem</li>
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]2881 <li>the Eazel team found an XML parser bug</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2882 <li>cleaned up the user of some of the string formatting function. used the
2883 trio library code to provide the one needed when the platform is missing
2884 them</li>
2885 <li>xpath: removed a memory leak and fixed the predicate evaluation
2886 problem, extended the testsuite and cleaned up the result. XPointer seems
2887 broken ...</li>
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]2888</ul>
2889
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]2890<h3>2.3.5: Mar 23 2001</h3>
2891<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2892 <li>Biggest change is separate parsing and evaluation of XPath expressions,
2893 there is some new APIs for this too</li>
2894 <li>included a number of bug fixes(XML push parser, 51876, notations,
2895 52299)</li>
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]2896 <li>Fixed some portability issues</li>
2897</ul>
2898
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]2899<h3>2.3.4: Mar 10 2001</h3>
2900<ul>
2901 <li>Fixed bugs #51860 and #51861</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2902 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
2903 size to be application tunable.</li>
2904 <li>Some cleanup in the validation code, still a bug left and this part
2905 should probably be rewritten to support ambiguous content model :-\</li>
2906 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
2907 parser</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]2908 <li>Fixed another bug in xmlNodeGetContent()</li>
2909 <li>Bjorn fixed XPath node collection and Number formatting</li>
2910 <li>Fixed a loop reported in the HTML parsing</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2911 <li>blank space are reported even if the Dtd content model proves that they
2912 are formatting spaces, this is for XML conformance</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]2913</ul>
2914
Daniel Veillardb402c072001-03-01 17:28:58 +0000[diff] [blame]2915<h3>2.3.3: Mar 1 2001</h3>
2916<ul>
2917 <li>small change in XPath for XSLT</li>
2918 <li>documentation cleanups</li>
2919 <li>fix in validation by Gary Pennington</li>
2920 <li>serious parsing performances improvements</li>
2921</ul>
2922
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2923<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +0000[diff] [blame]2924<ul>
2925 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
2926 <li>fixed a Dtd parsing bug</li>
2927 <li>fixed a bug in xmlNodeGetContent</li>
2928 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
2929</ul>
2930
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2931<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2932<ul>
2933 <li>some XPath and HTML bug fixes for XSLT</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2934 <li>small extension of the hash table interfaces for DOM gdome2
2935 implementation</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2936 <li>A few bug fixes</li>
2937</ul>
2938
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2939<h3>2.3.0: Feb 8 2001 (2.2.12 was on 25 Jan but I didn't kept track)</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2940<ul>
2941 <li>Lots of XPath bug fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2942 <li>Add a mode with Dtd lookup but without validation error reporting for
2943 XSLT</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2944 <li>Add support for text node without escaping (XSLT)</li>
2945 <li>bug fixes for xmlCheckFilename</li>
2946 <li>validation code bug fixes from Gary Pennington</li>
2947 <li>Patch from Paul D. Smith correcting URI path normalization</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2948 <li>Patch to allow simultaneous install of libxml-devel and
2949 libxml2-devel</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2950 <li>the example Makefile is now fixed</li>
2951 <li>added HTML to the RPM packages</li>
2952 <li>tree copying bugfixes</li>
2953 <li>updates to Windows makefiles</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2954 <li>optimization patch from Bjorn Reese</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2955</ul>
2956
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2957<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]2958<ul>
2959 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
2960 <li>added htmlHandleOmittedElem()</li>
2961 <li>Applied Bjorn Reese's IPV6 first patch</li>
2962 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2963 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]2964</ul>
2965
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]2966<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +0000[diff] [blame]2967<ul>
2968 <li>Fix the Windows problems of 2.2.8</li>
2969 <li>integrate OpenVMS patches</li>
2970 <li>better handling of some nasty HTML input</li>
2971 <li>Improved the XPointer implementation</li>
2972 <li>integrate a number of provided patches</li>
2973</ul>
2974
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]2975<h3>2.2.9: Nov 25 2000</h3>
2976<ul>
2977 <li>erroneous release :-(</li>
2978</ul>
2979
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]2980<h3>2.2.8: Nov 13 2000</h3>
2981<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]2982 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
2983 support</li>
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]2984 <li>Patch in conditional section handling</li>
2985 <li>updated MS compiler project</li>
2986 <li>fixed some XPath problems</li>
2987 <li>added an URI escaping function</li>
2988 <li>some other bug fixes</li>
2989</ul>
2990
2991<h3>2.2.7: Oct 31 2000</h3>
2992<ul>
2993 <li>added message redirection</li>
2994 <li>XPath improvements (thanks TOM !)</li>
2995 <li>xmlIOParseDTD() added</li>
2996 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
2997 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
2998</ul>
2999
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]3000<h3>2.2.6: Oct 25 2000:</h3>
3001<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3002 <li>Added an hash table module, migrated a number of internal structure to
3003 those</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]3004 <li>Fixed a posteriori validation problems</li>
3005 <li>HTTP module cleanups</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3006 <li>HTML parser improvements (tag errors, script/style handling, attribute
3007 normalization)</li>
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]3008 <li>coalescing of adjacent text nodes</li>
3009 <li>couple of XPath bug fixes, exported the internal API</li>
3010</ul>
3011
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]3012<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]3013<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]3014 <li>XPointer implementation and testsuite</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3015 <li>Lot of XPath fixes, added variable and functions registration, more
3016 tests</li>
3017 <li>Portability fixes, lots of enhancements toward an easy Windows build
3018 and release</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]3019 <li>Late validation fixes</li>
3020 <li>Integrated a lot of contributed patches</li>
3021 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]3022 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]3023</ul>
3024
3025<h3>2.2.4: Oct 1 2000:</h3>
3026<ul>
3027 <li>main XPath problem fixed</li>
3028 <li>Integrated portability patches for Windows</li>
3029 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]3030</ul>
3031
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]3032<h3>2.2.3: Sep 17 2000</h3>
3033<ul>
3034 <li>bug fixes</li>
3035 <li>cleanup of entity handling code</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3036 <li>overall review of all loops in the parsers, all sprintf usage has been
3037 checked too</li>
3038 <li>Far better handling of larges Dtd. Validating against DocBook XML Dtd
3039 works smoothly now.</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]3040</ul>
3041
3042<h3>1.8.10: Sep 6 2000</h3>
3043<ul>
3044 <li>bug fix release for some Gnome projects</li>
3045</ul>
3046
3047<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]3048<ul>
3049 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]3050 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]3051</ul>
3052
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]3053<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]3054<ul>
3055 <li>a purely bug fixes release</li>
3056 <li>fixed an encoding support problem when parsing from a memory block</li>
3057 <li>fixed a DOCTYPE parsing problem</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3058 <li>removed a bug in the function allowing to override the memory
3059 allocation routines</li>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]3060</ul>
3061
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]3062<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]3063<ul>
3064 <li>applied a lot of portability fixes</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3065 <li>better encoding support/cleanup and saving (content is now always
3066 encoded in UTF-8)</li>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]3067 <li>the HTML parser now correctly handles encodings</li>
3068 <li>added xmlHasProp()</li>
3069 <li>fixed a serious problem with &amp;#38;</li>
3070 <li>propagated the fix to FTP client</li>
3071 <li>cleanup, bugfixes, etc ...</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3072 <li>Added a page about <a href="encoding.html">libxml Internationalization
3073 support</a></li>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]3074</ul>
3075
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3076<h3>1.8.9: July 9 2000</h3>
3077<ul>
3078 <li>fixed the spec the RPMs should be better</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3079 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
3080 rpmfind users problem</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3081</ul>
3082
Daniel Veillard6388e172000-07-03 16:07:19 +0000[diff] [blame]3083<h3>2.1.1: July 1 2000</h3>
3084<ul>
3085 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
3086 <li>improvements on the HTML parser</li>
3087</ul>
3088
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]3089<h3>2.1.0 and 1.8.8: June 29 2000</h3>
3090<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3091 <li>1.8.8 is mostly a commodity package for upgrading to libxml2 according
3092 to <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
3093 about &amp;#38; charref parsing</li>
3094 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
3095 also contains numerous fixes and enhancements:
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]3096 <ul>
3097 <li>added xmlStopParser() to stop parsing</li>
3098 <li>improved a lot parsing speed when there is large CDATA blocs</li>
3099 <li>includes XPath patches provided by Picdar Technology</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3100 <li>tried to fix as much as possible DTD validation and namespace
3101 related problems</li>
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]3102 <li>output to a given encoding has been added/tested</li>
3103 <li>lot of various fixes</li>
3104 </ul>
3105 </li>
3106</ul>
3107
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]3108<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]3109<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3110 <li>First public release of libxml2. If you are using libxml, it's a good
3111 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initially
3112 scheduled for Apr 3 the release occurred only on Apr 12 due to massive
3113 workload.</li>
3114 <li>The include are now located under $prefix/include/libxml (instead of
3115 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3116 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]3117 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]3118 <pre>#include "xxx.h"</pre>
3119 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000[diff] [blame]3120 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3121 <li>the memory allocation routines used by libxml can now be overloaded
3122 dynamically by using xmlMemSetup()</li>
3123 <li>The previously CVS only tool tester has been renamed
3124 <strong>xmllint</strong> and is now installed as part of the libxml2
3125 package</li>
3126 <li>The I/O interface has been revamped. There is now ways to plug in
3127 specific I/O modules, either at the URI scheme detection level using
3128 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
3129 parser context using xmlCreateIOParserCtxt()</li>
3130 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
3131 number of the libxml module in use</li>
3132 <li>a number of optional features of libxml can now be excluded at
3133 configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]3134</ul>
3135
3136<h3>2.0.0beta: Mar 14 2000</h3>
3137<ul>
3138 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3139 <li>It's available only from<a href="ftp://xmlsoft.org/libxml2/">xmlsoft.org
3140 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
3141 RPMs</li>
3142 <li>This version is now the head in the Gnome CVS base, the old one is
3143 available under the tag LIB_XML_1_X</li>
3144 <li>This includes a very large set of changes. From a programmatic point
3145 of view applications should not have to be modified too much, check the
3146 <a href="upgrade.html">upgrade page</a></li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]3147 <li>Some interfaces may changes (especially a bit about encoding).</li>
3148 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]3149 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3150 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
3151 handled now</li>
3152 <li>Better handling of entities, especially well-formedness checking
3153 and proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]3154 <li>DTD conditional sections</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3155 <li>Validation now correctly handle entities content</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3156 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
3157 structures to accommodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]3158 </ul>
3159 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]3160 <li>Serious progress were made toward compliance, <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3161 href="conf/result.html">here are the result of the test</a> against the
3162 OASIS testsuite (except the Japanese tests since I don't support that
3163 encoding yet). This URL is rebuilt every couple of hours using the CVS
3164 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]3165</ul>
3166
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]3167<h3>1.8.7: Mar 6 2000</h3>
3168<ul>
3169 <li>This is a bug fix release:</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3170 <li>It is possible to disable the ignorable blanks heuristic used by
3171 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
3172 that for adherence to XML spec, this behaviour will be disabled by
3173 default in 2.x . The same function will allow to keep compatibility for
3174 old code.</li>
3175 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
3176 avoiding heuristic is really the Right Way :-\</li>
3177 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
3178 compilation on some platforms has been fixed</li>
3179 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
3180 URIs</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]3181</ul>
3182
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]3183<h3>1.8.6: Jan 31 2000</h3>
3184<ul>
3185 <li>added a nanoFTP transport module, debugged until the new version of <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3186 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
3187 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000[diff] [blame]3188</ul>
3189
3190<h3>1.8.5: Jan 21 2000</h3>
3191<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]3192 <li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3193 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
3194 XML spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]3195 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3196 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
3197 to solve the zlib checks problems</li>
3198 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
3199 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]3200</ul>
3201
3202<h3>1.8.4: Jan 13 2000</h3>
3203<ul>
3204 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
3205 <li>all exit() call should have been removed from libxml</li>
3206 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
3207 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]3208</ul>
3209
3210<h3>1.8.3: Jan 5 2000</h3>
3211<ul>
3212 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]3213 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3214 <li>lots of bug fixes and improvement added over XMas holidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]3215 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]3216 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
3217 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3218 <li>External entity loading code has been revamped, now it uses
3219 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]3220 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]3221</ul>
3222
3223<h3>1.8.2: Dec 21 1999</h3>
3224<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3225 <li>I got another problem with includes and C++, I hope this issue is fixed
3226 for good this time</li>
3227 <li>Added a few tree modification functions: xmlReplaceNode,
3228 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
3229 xmlDocSetRootElement</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]3230 <li>Tried to improve the HTML output with help from <a
3231 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]3232</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]3233
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]3234<h3>1.8.1: Dec 18 1999</h3>
3235<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3236 <li>various patches to avoid troubles when using libxml with C++ compilers
3237 the "namespace" keyword and C escaping in include files</li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]3238 <li>a problem in one of the core macros IS_CHAR was corrected</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3239 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
3240 and more specifically the Dia application</li>
3241 <li>fixed a posteriori validation (validation after parsing, or by using a
3242 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]3243 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]3244</ul>
3245
3246<h3>1.8.0: Dec 12 1999</h3>
3247<ul>
3248 <li>cleanup, especially memory wise</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3249 <li>the parser should be more reliable, especially the HTML one, it should
3250 not crash, whatever the input !</li>
3251 <li>Integrated various patches, especially a speedup improvement for large
3252 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
3253 configure with --with-buffers to enable them.</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]3254 <li>attribute normalization, oops should have been added long ago !</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3255 <li>attributes defaulted from DTDs should be available, xmlSetProp() now
3256 does entities escaping by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]3257</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]3258
3259<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3260<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]3261 <li>Lots of HTML improvement</li>
3262 <li>Fixed some errors when saving both XML and HTML</li>
3263 <li>More examples, the regression tests should now look clean</li>
3264 <li>Fixed a bug with contiguous charref</li>
3265</ul>
3266
3267<h3>1.7.3: Sep 29 1999</h3>
3268<ul>
3269 <li>portability problems fixed</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3270 <li>snprintf was used unconditionally, leading to link problems on system
3271 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3272</ul>
3273
3274<h3>1.7.1: Sep 24 1999</h3>
3275<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3276 <li>The basic type for strings manipulated by libxml has been renamed in
3277 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
3278 is that CHAR was conflicting with a predefined type on Windows. However
3279 on non WIN32 environment, compatibility is provided by the way of a
3280 <strong>#define </strong>.</li>
3281 <li>Changed another error : the use of a structure field called errno, and
3282 leading to troubles on platforms where it's a macro</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3283</ul>
3284
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3285<h3>1.7.0: Sep 23 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3286<ul>
3287 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3288 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
3289 <li>Added an errno to report errors by another mean than a simple printf
3290 like callback</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3291 <li>Finished ID/IDREF support and checking when validation</li>
3292 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3293 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
3294 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
3295 implementation</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3296 <li>Added an HTML parser front-end</li>
3297</ul>
3298
3299<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3300
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3301<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
3302markup-based structured documents. Here is <a name="example">an example XML
3303document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]3304<pre>&lt;?xml version="1.0"?&gt;
3305&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
3306 &lt;head&gt;
3307 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
3308 &lt;/head&gt;
3309 &lt;chapter&gt;
3310 &lt;title&gt;The Linux adventure&lt;/title&gt;
3311 &lt;p&gt;bla bla bla ...&lt;/p&gt;
3312 &lt;image href="linus.gif"/&gt;
3313 &lt;p&gt;...&lt;/p&gt;
3314 &lt;/chapter&gt;
3315&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3316
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3317<p>The first line specifies that it is an XML document and gives useful
3318information about its encoding. Then the rest of the document is a text
3319format whose structure is specified by tags between brackets. <strong>Each
3320tag opened has to be closed</strong>. XML is pedantic about this. However, if
3321a tag is empty (no content), a single tag can serve as both the opening and
3322closing tag if it ends with <code>/&gt;</code> rather than with
3323<code>&gt;</code>. Note that, for example, the image tag has no content (just
3324an attribute) and is closed by ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3325
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3326<p>XML can be applied successfully to a wide range of tasks, ranging from
3327long term structured document maintenance (where it follows the steps of
3328SGML) to simple data encoding mechanisms like configuration file formatting
3329(glade), spreadsheets (gnumeric), or even shorter lived documents such as
3330WebDAV where it is used to encode remote calls between a client and a
3331server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3332
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]3333<h2><a name="XSLT">XSLT</a></h2>
3334
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]3335<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
3336
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3337<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
3338language for transforming XML documents into other XML documents (or
3339HTML/textual output).</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]3340
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3341<p>A separate library called libxslt is available implementing XSLT-1.0 for
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]3342libxml2. This module "libxslt" too can be found in the Gnome SVN base.</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]3343
Daniel Veillard29f61002005-08-06 09:07:15 +0000[diff] [blame]3344<p>You can check the progresses on the libxslt <a
3345href="http://xmlsoft.org/XSLT/ChangeLog.html">Changelog</a>.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3346
3347<h2><a name="Python">Python and bindings</a></h2>
3348
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3349<p>There are a number of language bindings and wrappers available for
3350libxml2, the list below is not exhaustive. Please contact the <a
3351href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
3352(<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
3353order to get updates to this list or to discuss the specific topic of libxml2
3354or libxslt wrappers or bindings:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3355<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3356 <li><a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the
3357 most up-to-date C++ bindings for libxml2, check the <a
3358 href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>
3359 and the <a
Daniel Veillardc14401e2002-11-20 14:28:17 +0000[diff] [blame]3360 href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3361 <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
3362 based on the gdome2 bindings</a> maintained by Tobias Peters.</li>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]3363 <li>and a third C++ wrapper by Peter Jones &lt;pjones@pmade.org&gt;
3364 <p>Website: <a
3365 href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
3366 </li>
Daniel Veillardd012f482007-08-22 17:36:57 +0000[diff] [blame]3367 <li>XML::LibXML <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXML">Perl
3368 bindings</a> are available on CPAN, as well as XML::LibXSLT
3369 <a href="http://cpan.uwinnipeg.ca/dist/XML-LibXSLT">Perl libxslt
3370 bindings</a>.</li>
Daniel Veillard4ac494b2003-09-18 15:08:00 +0000[diff] [blame]3371 <li>If you're interested into scripting XML processing, have a look at <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3372 href="http://xsh.sourceforge.net/">XSH</a> an XML editing shell based on
3373 Libxml2 Perl bindings.</li>
3374 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an
3375 earlier version of the libxml/libxslt <a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]3376 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li>
Daniel Veillard21473672002-06-17 07:29:22 +0000[diff] [blame]3377 <li>Gopal.V and Peter Minten develop <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3378 href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of
3379 C# libxml2 bindings.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3380 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3381 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
3382 libxml2</a> with Kylix, Delphi and other Pascal compilers.</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +0000[diff] [blame]3383 <li>Uwe Fechner also provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3384 href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2
3385 implementation for Kylix2/D5/D6 from Borland.</li>
3386 <li>There is <a href="http://libxml.rubyforge.org/">bindings for Ruby</a>
3387 and libxml2 bindings are also available in Ruby through the <a
3388 href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
3389 maintained by Tobias Peters.</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3390 <li>Steve Ball and contributors maintains <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3391 href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
3392 Tcl</a>.</li>
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]3393 <li>libxml2 and libxslt are the default XML libraries for PHP5.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3394 <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
3395 an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
3396 libxslt as part of GNU ClasspathX project.</li>
3397 <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for
3398 <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]3399 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3400 href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>
3401 provides <a
3402 href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib
3403 osax</a>. This is an osax for Mac OS X with a set of commands to
3404 implement in AppleScript the XML DOM, XPATH and XSLT. Also includes
3405 commands for Property-lists (Apple's fast lookup table XML format.)</li>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]3406 <li>Francesco Montorsi developped <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3407 href="https://sourceforge.net/project/showfiles.php?group_id=51305&amp;package_id=45182">wxXml2</a>
3408 wrappers that interface libxml2, allowing wxWidgets applications to
3409 load/save/edit XML instances.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3410</ul>
3411
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3412<p>The distribution includes a set of Python bindings, which are guaranteed
3413to be maintained as part of the library in the future, though the Python
3414interface have not yet reached the completeness of the C API.</p>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]3415
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3416<p>Note that some of the Python purist dislike the default set of Python
3417bindings, rather than complaining I suggest they have a look at <a
Daniel Veillard28fdf8b2011-03-07 08:12:39 +0800[diff] [blame]3418href="http://lxml.de/">lxml the more pythonic bindings for libxml2
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3419and libxslt</a> and <a
Daniel Veillard28fdf8b2011-03-07 08:12:39 +0800[diff] [blame]3420href="http://lxml.de/mailinglist/">check the mailing-list</a>.</p>
Daniel Veillard929746e2005-05-11 11:08:22 +0000[diff] [blame]3421
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]3422<p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3423maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
3424of the Python bindings</a>.</p>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3425
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3426<p>Note to people interested in building bindings, the API is formalized as
3427<a href="libxml2-api.xml">an XML API description file</a> which allows to
3428automate a large part of the Python bindings, this includes function
3429descriptions, enums, structures, typedefs, etc... The Python script used to
3430build the bindings is python/generator.py in the source distribution.</p>
Daniel Veillard7ef0fcb2002-12-14 10:38:55 +0000[diff] [blame]3431
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3432<p>To install the Python bindings there are 2 options:</p>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000[diff] [blame]3433<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3434 <li>If you use an RPM based distribution, simply install the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3435 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
3436 RPM</a> (and if needed the <a
3437 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
3438 RPM</a>).</li>
3439 <li>Otherwise use the <a href="ftp://xmlsoft.org/libxml2/python/">libxml2-python
3440 module distribution</a> corresponding to your installed version of
3441 libxml2 and libxslt. Note that to install it you will need both libxml2
3442 and libxslt installed and run "python setup.py build install" in the
3443 module tree.</li>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000[diff] [blame]3444</ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3445
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3446<p>The distribution includes a set of examples and regression tests for the
3447python bindings in the <code>python/tests</code> directory. Here are some
3448excerpts from those tests:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3449
3450<h3>tst.py:</h3>
3451
3452<p>This is a basic test of the file interface and DOM navigation:</p>
MST 2003 John Fleck2dffb762003-11-29 04:41:24 +0000[diff] [blame]3453<pre>import libxml2, sys
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3454
3455doc = libxml2.parseFile("tst.xml")
3456if doc.name != "tst.xml":
3457 print "doc.name failed"
3458 sys.exit(1)
3459root = doc.children
3460if root.name != "doc":
3461 print "root.name failed"
3462 sys.exit(1)
3463child = root.children
3464if child.name != "foo":
3465 print "child.name failed"
3466 sys.exit(1)
3467doc.freeDoc()</pre>
3468
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3469<p>The Python module is called libxml2; parseFile is the equivalent of
3470xmlParseFile (most of the bindings are automatically generated, and the xml
3471prefix is removed and the casing convention are kept). All node seen at the
3472binding level share the same subset of accessors:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3473<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3474 <li><code>name</code> : returns the node name</li>
3475 <li><code>type</code> : returns a string indicating the node type</li>
3476 <li><code>content</code> : returns the content of the node, it is based on
3477 xmlNodeGetContent() and hence is recursive.</li>
3478 <li><code>parent</code> , <code>children</code>, <code>last</code>,
3479 <code>next</code>, <code>prev</code>, <code>doc</code>,
3480 <code>properties</code>: pointing to the associated element in the tree,
3481 those may return None in case no such link exists.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3482</ul>
3483
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3484<p>Also note the need to explicitly deallocate documents with freeDoc() .
3485Reference counting for libxml2 trees would need quite a lot of work to
3486function properly, and rather than risk memory leaks if not implemented
3487correctly it sounds safer to have an explicit function to free a tree. The
3488wrapper python objects like doc, root or child are them automatically garbage
3489collected.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3490
3491<h3>validate.py:</h3>
3492
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3493<p>This test check the validation interfaces and redirection of error
3494messages:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3495<pre>import libxml2
3496
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3497#deactivate error messages from the validation
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3498def noerr(ctx, str):
3499 pass
3500
3501libxml2.registerErrorHandler(noerr, None)
3502
3503ctxt = libxml2.createFileParserCtxt("invalid.xml")
3504ctxt.validate(1)
3505ctxt.parseDocument()
3506doc = ctxt.doc()
3507valid = ctxt.isValid()
3508doc.freeDoc()
3509if valid != 0:
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3510 print "validity check failed"</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3511
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3512<p>The first thing to notice is the call to registerErrorHandler(), it
3513defines a new error handler global to the library. It is used to avoid seeing
3514the error messages when trying to validate the invalid document.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3515
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3516<p>The main interest of that test is the creation of a parser context with
3517createFileParserCtxt() and how the behaviour can be changed before calling
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]3518parseDocument() . Similarly the information resulting from the parsing phase
3519is also available using context methods.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3520
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3521<p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
3522C function interfaces in terms of objects method as much as possible. The
3523best to get a complete view of what methods are supported is to look at the
3524libxml2.py module containing all the wrappers.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3525
3526<h3>push.py:</h3>
3527
3528<p>This test show how to activate the push parser interface:</p>
3529<pre>import libxml2
3530
3531ctxt = libxml2.createPushParser(None, "&lt;foo", 4, "test.xml")
3532ctxt.parseChunk("/&gt;", 2, 1)
3533doc = ctxt.doc()
3534
3535doc.freeDoc()</pre>
3536
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3537<p>The context is created with a special call based on the
3538xmlCreatePushParser() from the C library. The first argument is an optional
3539SAX callback object, then the initial set of data, the length and the name of
3540the resource in case URI-References need to be computed by the parser.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3541
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3542<p>Then the data are pushed using the parseChunk() method, the last call
3543setting the third argument terminate to 1.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3544
3545<h3>pushSAX.py:</h3>
3546
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3547<p>this test show the use of the event based parsing interfaces. In this case
3548the parser does not build a document, but provides callback information as
3549the parser makes progresses analyzing the data being provided:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3550<pre>import libxml2
3551log = ""
3552
3553class callback:
3554 def startDocument(self):
3555 global log
3556 log = log + "startDocument:"
3557
3558 def endDocument(self):
3559 global log
3560 log = log + "endDocument:"
3561
3562 def startElement(self, tag, attrs):
3563 global log
3564 log = log + "startElement %s %s:" % (tag, attrs)
3565
3566 def endElement(self, tag):
3567 global log
3568 log = log + "endElement %s:" % (tag)
3569
3570 def characters(self, data):
3571 global log
3572 log = log + "characters: %s:" % (data)
3573
3574 def warning(self, msg):
3575 global log
3576 log = log + "warning: %s:" % (msg)
3577
3578 def error(self, msg):
3579 global log
3580 log = log + "error: %s:" % (msg)
3581
3582 def fatalError(self, msg):
3583 global log
3584 log = log + "fatalError: %s:" % (msg)
3585
3586handler = callback()
3587
3588ctxt = libxml2.createPushParser(handler, "&lt;foo", 4, "test.xml")
3589chunk = " url='tst'&gt;b"
3590ctxt.parseChunk(chunk, len(chunk), 0)
3591chunk = "ar&lt;/foo&gt;"
3592ctxt.parseChunk(chunk, len(chunk), 1)
3593
Daniel Veillardfcbfa2d2002-02-21 17:54:27 +0000[diff] [blame]3594reference = "startDocument:startElement foo {'url': 'tst'}:" + \
3595 "characters: bar:endElement foo:endDocument:"
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3596if log != reference:
3597 print "Error got: %s" % log
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3598 print "Expected: %s" % reference</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3599
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3600<p>The key object in that test is the handler, it provides a number of entry
3601points which can be called by the parser as it makes progresses to indicate
3602the information set obtained. The full set of callback is larger than what
3603the callback class in that specific example implements (see the SAX
3604definition for a complete list). The wrapper will only call those supplied by
3605the object when activated. The startElement receives the names of the element
3606and a dictionary containing the attributes carried by this element.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3607
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3608<p>Also note that the reference string generated from the callback shows a
3609single character call even though the string "bar" is passed to the parser
3610from 2 different call to parseChunk()</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3611
3612<h3>xpath.py:</h3>
3613
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3614<p>This is a basic test of XPath wrappers support</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3615<pre>import libxml2
3616
3617doc = libxml2.parseFile("tst.xml")
3618ctxt = doc.xpathNewContext()
3619res = ctxt.xpathEval("//*")
3620if len(res) != 2:
3621 print "xpath query: wrong node set size"
3622 sys.exit(1)
3623if res[0].name != "doc" or res[1].name != "foo":
3624 print "xpath query: wrong node set value"
3625 sys.exit(1)
3626doc.freeDoc()
3627ctxt.xpathFreeContext()</pre>
3628
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3629<p>This test parses a file, then create an XPath context to evaluate XPath
3630expression on it. The xpathEval() method execute an XPath query and returns
3631the result mapped in a Python way. String and numbers are natively converted,
3632and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
3633the document, the XPath context need to be freed explicitly, also not that
3634the result of the XPath query may point back to the document tree and hence
3635the document must be freed after the result of the query is used.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3636
3637<h3>xpathext.py:</h3>
3638
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3639<p>This test shows how to extend the XPath engine with functions written in
3640python:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3641<pre>import libxml2
3642
3643def foo(ctx, x):
3644 return x + 1
3645
3646doc = libxml2.parseFile("tst.xml")
3647ctxt = doc.xpathNewContext()
3648libxml2.registerXPathFunction(ctxt._o, "foo", None, foo)
3649res = ctxt.xpathEval("foo(1)")
3650if res != 2:
3651 print "xpath extension failure"
3652doc.freeDoc()
3653ctxt.xpathFreeContext()</pre>
3654
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3655<p>Note how the extension function is registered with the context (but that
3656part is not yet finalized, this may change slightly in the future).</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3657
3658<h3>tstxpath.py:</h3>
3659
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3660<p>This test is similar to the previous one but shows how the extension
3661function can access the XPath evaluation context:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3662<pre>def foo(ctx, x):
3663 global called
3664
3665 #
3666 # test that access to the XPath evaluation contexts
3667 #
3668 pctxt = libxml2.xpathParserContext(_obj=ctx)
3669 ctxt = pctxt.context()
3670 called = ctxt.function()
3671 return x + 1</pre>
3672
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3673<p>All the interfaces around the XPath parser(or rather evaluation) context
3674are not finalized, but it should be sufficient to do contextual work at the
3675evaluation point.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3676
3677<h3>Memory debugging:</h3>
3678
3679<p>last but not least, all tests starts with the following prologue:</p>
3680<pre>#memory debug specific
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3681libxml2.debugMemory(1)</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]3682
3683<p>and ends with the following epilogue:</p>
3684<pre>#memory debug specific
3685libxml2.cleanupParser()
3686if libxml2.debugMemory(1) == 0:
3687 print "OK"
3688else:
3689 print "Memory leak %d bytes" % (libxml2.debugMemory(1))
3690 libxml2.dumpMemory()</pre>
3691
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3692<p>Those activate the memory debugging interface of libxml2 where all
3693allocated block in the library are tracked. The prologue then cleans up the
3694library state and checks that all allocated memory has been freed. If not it
3695calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]3696
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3697<h2><a name="architecture">libxml2 architecture</a></h2>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]3698
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3699<p>Libxml2 is made of multiple components; some of them are optional, and
3700most of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]3701<ul>
3702 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]3703 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]3704 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]3705 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]3706 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]3707 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]3708 <li>a SAX tree module to build an in-memory DOM representation</li>
3709 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]3710 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3711 <li>an XPath module for global lookup in a DOM representation
3712 (optional)</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]3713 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]3714</ul>
3715
3716<p>Graphically this gives the following:</p>
3717
3718<p><img src="libxml.gif" alt="a graphical view of the various"></p>
3719
3720<p></p>
3721
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3722<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3723
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3724<p>The parser returns a tree built during the document analysis. The value
3725returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
3726<strong>xmlDoc</strong> structure). This structure contains information such
3727as the file name, the document type, and a <strong>children</strong> pointer
3728which is the root of the document (or more exactly the first child under the
3729root which is the document). The tree is made of <strong>xmlNode</strong>s,
3730chained in double-linked lists of siblings and with a children&lt;-&gt;parent
3731relationship. An xmlNode can also carry properties (a chain of xmlAttr
3732structures). An attribute may have a value which is a list of TEXT or
3733ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3734
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3735<p>Here is an example (erroneous with respect to the XML spec since there
3736should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3737
3738<p><img src="structure.gif" alt=" structure.gif "></p>
3739
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3740<p>In the source package there is a small program (not installed by default)
3741called <strong>xmllint</strong> which parses XML files given as argument and
3742prints them back as parsed. This is useful for detecting errors both in XML
3743code and in the XML parser itself. It has an option <strong>--debug</strong>
3744which prints the actual in-memory structure of the document; here is the
3745result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3746<pre>DOCUMENT
3747version=1.0
3748standalone=true
3749 ELEMENT EXAMPLE
3750 ATTRIBUTE prop1
3751 TEXT
3752 content=gnome is great
3753 ATTRIBUTE prop2
3754 ENTITY_REF
3755 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]3756 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]3757 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3758 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]3759 TEXT
3760 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3761 ELEMENT chapter
3762 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]3763 TEXT
3764 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3765 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]3766 TEXT
3767 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3768 ELEMENT image
3769 ATTRIBUTE href
3770 TEXT
3771 content=linus.gif
3772 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]3773 TEXT
3774 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3775
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3776<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3777
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]3778<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3779
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3780<p>Sometimes the DOM tree output is just too large to fit reasonably into
3781memory. In that case (and if you don't expect to save back the XML document
3782loaded using libxml), it's better to use the SAX interface of libxml. SAX is
3783a <strong>callback-based interface</strong> to the parser. Before parsing,
3784the application layer registers a customized set of callbacks which are
3785called by the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3786
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3787<p>To get more detailed step-by-step guidance on using the SAX interface of
3788libxml, see the <a
Daniel Veillard4e73bfa2014-07-12 17:46:46 +0800[diff] [blame]3789href="http://www.jamesh.id.au/articles/libxml-sax/libxml-sax.html">nice
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3790documentation</a>.written by <a href="mailto:james@daa.com.au">James
3791Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3792
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3793<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
3794program located in the gnome-xml module (it's usually not shipped in the
3795binary packages of libxml, but you can find it in the tar source
3796distribution). Here is the sequence of callbacks that would be reported by
3797testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3798<pre>SAX.setDocumentLocator()
3799SAX.startDocument()
3800SAX.getEntity(amp)
3801SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
3802SAX.characters( , 3)
3803SAX.startElement(head)
3804SAX.characters( , 4)
3805SAX.startElement(title)
3806SAX.characters(Welcome to Gnome, 16)
3807SAX.endElement(title)
3808SAX.characters( , 3)
3809SAX.endElement(head)
3810SAX.characters( , 3)
3811SAX.startElement(chapter)
3812SAX.characters( , 4)
3813SAX.startElement(title)
3814SAX.characters(The Linux adventure, 19)
3815SAX.endElement(title)
3816SAX.characters( , 4)
3817SAX.startElement(p)
3818SAX.characters(bla bla bla ..., 15)
3819SAX.endElement(p)
3820SAX.characters( , 4)
3821SAX.startElement(image, href='linus.gif')
3822SAX.endElement(image)
3823SAX.characters( , 4)
3824SAX.startElement(p)
3825SAX.characters(..., 3)
3826SAX.endElement(p)
3827SAX.characters( , 3)
3828SAX.endElement(chapter)
3829SAX.characters( , 1)
3830SAX.endElement(EXAMPLE)
3831SAX.endDocument()</pre>
3832
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3833<p>Most of the other interfaces of libxml2 are based on the DOM tree-building
3834facility, so nearly everything up to the end of this document presupposes the
3835use of the standard DOM tree build. Note that the DOM tree itself is built by
3836a set of registered default callbacks, without internal specific
3837interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]3838
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3839<h2><a name="Validation">Validation &amp; DTDs</a></h2>
3840
3841<p>Table of Content:</p>
3842<ol>
3843 <li><a href="#General5">General overview</a></li>
3844 <li><a href="#definition">The definition</a></li>
3845 <li><a href="#Simple">Simple rules</a>
3846 <ol>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]3847 <li><a href="#reference">How to reference a DTD from a document</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3848 <li><a href="#Declaring">Declaring elements</a></li>
3849 <li><a href="#Declaring1">Declaring attributes</a></li>
3850 </ol>
3851 </li>
3852 <li><a href="#Some">Some examples</a></li>
3853 <li><a href="#validate">How to validate</a></li>
3854 <li><a href="#Other">Other resources</a></li>
3855</ol>
3856
3857<h3><a name="General5">General overview</a></h3>
3858
3859<p>Well what is validation and what is a DTD ?</p>
3860
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3861<p>DTD is the acronym for Document Type Definition. This is a description of
3862the content for a family of XML files. This is part of the XML 1.0
3863specification, and allows one to describe and verify that a given document
3864instance conforms to the set of rules detailing its structure and content.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3865
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3866<p>Validation is the process of checking a document against a DTD (more
3867generally against a set of construction rules).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3868
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3869<p>The validation process and building DTDs are the two most difficult parts
3870of the XML life cycle. Briefly a DTD defines all the possible elements to be
3871found within your document, what is the formal shape of your document tree
3872(by defining the allowed content of an element; either text, a regular
3873expression for the allowed list of children, or mixed content i.e. both text
3874and children). The DTD also defines the valid attributes for all elements and
3875the types of those attributes.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3876
3877<h3><a name="definition1">The definition</a></h3>
3878
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3879<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a
3880href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
3881Rev1</a>):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3882<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3883 <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
3884 elements</a></li>
3885 <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
3886 attributes</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3887</ul>
3888
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3889<p>(unfortunately) all this is inherited from the SGML world, the syntax is
3890ancient...</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3891
3892<h3><a name="Simple1">Simple rules</a></h3>
3893
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3894<p>Writing DTDs can be done in many ways. The rules to build them if you need
3895something permanent or something which can evolve over time can be radically
3896different. Really complex DTDs like DocBook ones are flexible but quite
3897harder to design. I will just focus on DTDs for a formats with a fixed simple
3898structure. It is just a set of basic rules, and definitely not exhaustive nor
3899usable for complex DTD design.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3900
3901<h4><a name="reference1">How to reference a DTD from a document</a>:</h4>
3902
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3903<p>Assuming the top element of the document is <code>spec</code> and the dtd
3904is placed in the file <code>mydtd</code> in the subdirectory
3905<code>dtds</code> of the directory from where the document were loaded:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3906
3907<p><code>&lt;!DOCTYPE spec SYSTEM "dtds/mydtd"&gt;</code></p>
3908
3909<p>Notes:</p>
3910<ul>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]3911 <li>The system string is actually an URI-Reference (as defined in <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3912 href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
3913 full URL string indicating the location of your DTD on the Web. This is a
3914 really good thing to do if you want others to validate your document.</li>
3915 <li>It is also possible to associate a <code>PUBLIC</code> identifier (a
3916 magic string) so that the DTD is looked up in catalogs on the client side
3917 without having to locate it on the web.</li>
3918 <li>A DTD contains a set of element and attribute declarations, but they
3919 don't define what the root of the document should be. This is explicitly
3920 told to the parser/validator as the first element of the
3921 <code>DOCTYPE</code> declaration.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3922</ul>
3923
3924<h4><a name="Declaring2">Declaring elements</a>:</h4>
3925
3926<p>The following declares an element <code>spec</code>:</p>
3927
3928<p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
3929
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3930<p>It also expresses that the spec element contains one <code>front</code>,
3931one <code>body</code> and one optional <code>back</code> children elements in
3932this order. The declaration of one element of the structure and its content
3933are done in a single declaration. Similarly the following declares
3934<code>div1</code> elements:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3935
Daniel Veillard51737272002-01-23 23:10:38 +0000[diff] [blame]3936<p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3937
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3938<p>which means div1 contains one <code>head</code> then a series of optional
3939<code>p</code>, <code>list</code>s and <code>note</code>s and then an
3940optional <code>div2</code>. And last but not least an element can contain
3941text:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3942
3943<p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
3944
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3945<p><code>b</code> contains text or being of mixed content (text and elements
3946in no particular order):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3947
3948<p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
3949
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3950<p><code>p </code>can contain text or <code>a</code>, <code>ul</code>,
3951<code>b</code>, <code>i </code>or <code>em</code> elements in no particular
3952order.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3953
3954<h4><a name="Declaring1">Declaring attributes</a>:</h4>
3955
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]3956<p>Again the attributes declaration includes their content definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3957
3958<p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
3959
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3960<p>means that the element <code>termdef</code> can have a <code>name</code>
3961attribute containing text (<code>CDATA</code>) and which is optional
3962(<code>#IMPLIED</code>). The attribute value can also be defined within a
3963set:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3964
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3965<p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
3966"ordered"&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3967
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3968<p>means <code>list</code> element have a <code>type</code> attribute with 3
3969allowed values "bullets", "ordered" or "glossary" and which default to
3970"ordered" if the attribute is not explicitly specified.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3971
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3972<p>The content type of an attribute can be text (<code>CDATA</code>),
3973anchor/reference/references
3974(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
3975(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
3976(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
3977<code>chapter</code> element can have an optional <code>id</code> attribute
3978of type <code>ID</code>, usable for reference from attribute of type
3979IDREF:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3980
3981<p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
3982
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3983<p>The last value of an attribute definition can be <code>#REQUIRED
3984</code>meaning that the attribute has to be given, <code>#IMPLIED</code>
3985meaning that it is optional, or the default value (possibly prefixed by
3986<code>#FIXED</code> if it is the only allowed).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3987
3988<p>Notes:</p>
3989<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3990 <li>Usually the attributes pertaining to a given element are declared in a
3991 single expression, but it is just a convention adopted by a lot of DTD
3992 writers:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3993 <pre>&lt;!ATTLIST termdef
3994 id ID #REQUIRED
3995 name CDATA #IMPLIED&gt;</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]3996 <p>The previous construct defines both <code>id</code> and
3997 <code>name</code> attributes for the element <code>termdef</code>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3998 </li>
3999</ul>
4000
4001<h3><a name="Some1">Some examples</a></h3>
4002
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4003<p>The directory <code>test/valid/dtds/</code> in the libxml2 distribution
4004contains some complex DTD examples. The example in the file
4005<code>test/valid/dia.xml</code> shows an XML file where the simple DTD is
4006directly included within the document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4007
4008<h3><a name="validate1">How to validate</a></h3>
4009
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4010<p>The simplest way is to use the xmllint program included with libxml. The
4011<code>--valid</code> option turns-on validation of the files given as input.
4012For example the following validates a copy of the first revision of the XML
40131.0 specification:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4014
4015<p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
4016
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]4017<p>the -- noout is used to disable output of the resulting tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4018
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4019<p>The <code>--dtdvalid dtd</code> allows validation of the document(s)
4020against a given DTD.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4021
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4022<p>Libxml2 exports an API to handle DTDs and validation, check the <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4023href="http://xmlsoft.org/html/libxml-valid.html">associated
4024description</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4025
4026<h3><a name="Other1">Other resources</a></h3>
4027
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4028<p>DTDs are as old as SGML. So there may be a number of examples on-line, I
4029will just list one for now, others pointers welcome:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4030<ul>
4031 <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li>
4032</ul>
4033
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4034<p>I suggest looking at the examples found under test/valid/dtd and any of
4035the large number of books available on XML. The dia example in test/valid
4036should be both simple and complete enough to allow you to build your own.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4037
4038<p></p>
4039
4040<h2><a name="Memory">Memory Management</a></h2>
4041
4042<p>Table of Content:</p>
4043<ol>
4044 <li><a href="#General3">General overview</a></li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4045 <li><a href="#setting">Setting libxml2 set of memory routines</a></li>
Daniel Veillard05b37c62008-03-31 08:27:07 +0000[diff] [blame]4046 <li><a href="#cleanup">Cleaning up after using the library</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4047 <li><a href="#Debugging">Debugging routines</a></li>
4048 <li><a href="#General4">General memory requirements</a></li>
Daniel Veillardad87d5e2008-02-04 16:50:03 +0000[diff] [blame]4049 <li><a href="#Compacting">Returning memory to the kernel</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4050</ol>
4051
4052<h3><a name="General3">General overview</a></h3>
4053
4054<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4055href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
4056provides the interfaces to the libxml2 memory system:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4057<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4058 <li>libxml2 does not use the libc memory allocator directly but xmlFree(),
4059 xmlMalloc() and xmlRealloc()</li>
4060 <li>those routines can be reallocated to a specific set of routine, by
4061 default the libc ones i.e. free(), malloc() and realloc()</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4062 <li>the xmlmemory.c module includes a set of debugging routine</li>
4063</ul>
4064
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4065<h3><a name="setting">Setting libxml2 set of memory routines</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4066
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4067<p>It is sometimes useful to not use the default memory allocator, either for
4068debugging, analysis or to implement a specific behaviour on memory management
4069(like on embedded systems). Two function calls are available to do so:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4070<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4071 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet
4072 ()</a> which return the current set of functions in use by the parser</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4073 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4074 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
4075 which allow to set up a new set of memory allocation functions</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4076</ul>
4077
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4078<p>Of course a call to xmlMemSetup() should probably be done before calling
4079any other libxml2 routines (unless you are sure your allocations routines are
4080compatibles).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4081
Daniel Veillard05b37c62008-03-31 08:27:07 +0000[diff] [blame]4082<h3><a name="cleanup">Cleaning up after using the library</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4083
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4084<p>Libxml2 is not stateless, there is a few set of memory structures needing
4085allocation before the parser is fully functional (some encoding structures
4086for example). This also mean that once parsing is finished there is a tiny
4087amount of memory (a few hundred bytes) which can be recollected if you don't
Daniel Veillard05b37c62008-03-31 08:27:07 +0000[diff] [blame]4088reuse the library or any document built with it:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4089<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4090 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
Daniel Veillard05b37c62008-03-31 08:27:07 +0000[diff] [blame]4091 ()</a> is a centralized routine to free the library state and data. Note
4092 that it won't deallocate any produced tree if any (use the xmlFreeDoc()
4093 and related routines for this). This should be called only when the library
4094 is not used anymore.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4095 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
4096 ()</a> is the dual routine allowing to preallocate the parsing state
4097 which can be useful for example to avoid initialization reentrancy
4098 problems when using libxml2 in multithreaded applications</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4099</ul>
4100
Daniel Veillard05b37c62008-03-31 08:27:07 +0000[diff] [blame]4101<p>Generally xmlCleanupParser() is safe assuming no parsing is ongoing and
4102no document is still being used, if needed the state will be rebuild at the
4103next invocation of parser routines (or by xmlInitParser()), but be careful
4104of the consequences in multithreaded applications.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4105
4106<h3><a name="Debugging">Debugging routines</a></h3>
4107
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4108<p>When configured using --with-mem-debug flag (off by default), libxml2 uses
4109a set of memory allocation debugging routines keeping track of all allocated
4110blocks and the location in the code where the routine was called. A couple of
4111other debugging routines allow to dump the memory allocated infos to a file
4112or call a specific routine when a given block number is allocated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4113<ul>
4114 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4115 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a>
4116 <a
4117 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
4118 and <a
4119 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
4120 are the memory debugging replacement allocation routines</li>
4121 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]4122 ()</a> dumps all the information about the allocated memory block lefts
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4123 in the <code>.memdump</code> file</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4124</ul>
4125
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4126<p>When developing libxml2 memory debug is enabled, the tests programs call
4127xmlMemoryDump () and the "make test" regression tests will check for any
4128memory leak during the full regression test sequence, this helps a lot
4129ensuring that libxml2 does not leak memory and bullet proof memory
4130allocations use (some libc implementations are known to be far too permissive
4131resulting in major portability problems!).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4132
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4133<p>If the .memdump reports a leak, it displays the allocation function and
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]4134also tries to give some information about the content and structure of the
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4135allocated blocks left. This is sufficient in most cases to find the culprit,
4136but not always. Assuming the allocation problem is reproducible, it is
4137possible to find more easily:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4138<ol>
4139 <li>write down the block number xxxx not allocated</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4140 <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , the easiest
4141 when using GDB is to simply give the command
Daniel Veillard75794822002-04-11 16:24:32 +0000[diff] [blame]4142 <p><code>set environment XML_MEM_BREAKPOINT xxxx</code></p>
4143 <p>before running the program.</p>
4144 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4145 <li>run the program under a debugger and set a breakpoint on
4146 xmlMallocBreakpoint() a specific function called when this precise block
4147 is allocated</li>
4148 <li>when the breakpoint is reached you can then do a fine analysis of the
4149 allocation an step to see the condition resulting in the missing
4150 deallocation.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4151</ol>
4152
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4153<p>I used to use a commercial tool to debug libxml2 memory problems but after
4154noticing that it was not detecting memory leaks that simple mechanism was
4155used and proved extremely efficient until now. Lately I have also used <a
4156href="http://developer.kde.org/~sewardj/">valgrind</a> with quite some
4157success, it is tied to the i386 architecture since it works by emulating the
4158processor and instruction set, it is slow but extremely efficient, i.e. it
4159spot memory usage errors in a very precise way.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4160
4161<h3><a name="General4">General memory requirements</a></h3>
4162
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4163<p>How much libxml2 memory require ? It's hard to tell in average it depends
4164of a number of things:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4165<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4166 <li>the parser itself should work in a fixed amount of memory, except for
4167 information maintained about the stacks of names and entities locations.
4168 The I/O and encoding handlers will probably account for a few KBytes.
4169 This is true for both the XML and HTML parser (though the HTML parser
4170 need more state).</li>
4171 <li>If you are generating the DOM tree then memory requirements will grow
4172 nearly linear with the size of the data. In general for a balanced
4173 textual document the internal memory requirement is about 4 times the
4174 size of the UTF8 serialization of this document (example the XML-1.0
4175 recommendation is a bit more of 150KBytes and takes 650KBytes of main
4176 memory when parsed). Validation will add a amount of memory required for
4177 maintaining the external Dtd state which should be linear with the
4178 complexity of the content model defined by the Dtd</li>
4179 <li>If you need to work with fixed memory requirements or don't need the
4180 full DOM tree then using the <a href="xmlreader.html">xmlReader
4181 interface</a> is probably the best way to proceed, it still allows to
4182 validate or operate on subset of the tree if needed.</li>
4183 <li>If you don't care about the advanced features of libxml2 like
4184 validation, DOM, XPath or XPointer, don't use entities, need to work with
4185 fixed memory requirements, and try to get the fastest parsing possible
4186 then the SAX interface should be used, but it has known restrictions.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4187</ul>
4188
4189<p></p>
Daniel Veillardad87d5e2008-02-04 16:50:03 +0000[diff] [blame]4190<h3><a name="Compacting">Returning memory to the kernel</a></h3>
4191
4192<p>You may encounter that your process using libxml2 does not have a
4193reduced memory usage although you freed the trees. This is because
4194libxml2 allocates memory in a number of small chunks. When freeing one
4195of those chunks, the OS may decide that giving this little memory back
4196to the kernel will cause too much overhead and delay the operation. As
4197all chunks are this small, they get actually freed but not returned to
4198the kernel. On systems using glibc, there is a function call
4199"malloc_trim" from malloc.h which does this missing operation (note that
4200it is allowed to fail). Thus, after freeing your tree you may simply try
4201"malloc_trim(0);" to really get the memory back. If your OS does not
4202provide malloc_trim, try searching for a similar function.</p>
4203<p></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4204
4205<h2><a name="Encodings">Encodings support</a></h2>
4206
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4207<p>If you are not really familiar with Internationalization (usual shortcut
4208is I18N) , Unicode, characters and glyphs, I suggest you read a <a
4209href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a>
4210by Tim Bray on Unicode and why you should care about it.</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]4211
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4212<p>If you don't understand why <b>it does not make sense to have a string
4213without knowing what encoding it uses</b>, then as Joel Spolsky said <a
4214href="http://www.joelonsoftware.com/articles/Unicode.html">please do not
4215write another line of code until you finish reading that article.</a>. It is
4216a prerequisite to understand this page, and avoid a lot of problems with
4217libxml2, XML or text processing in general.</p>
Daniel Veillarde5d68de2005-03-10 15:03:40 +0000[diff] [blame]4218
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4219<p>Table of Content:</p>
4220<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4221 <li><a href="encoding.html#What">What does internationalization support
4222 mean ?</a></li>
4223 <li><a href="encoding.html#internal">The internal encoding, how and
4224 why</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4225 <li><a href="encoding.html#implemente">How is it implemented ?</a></li>
4226 <li><a href="encoding.html#Default">Default supported encodings</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4227 <li><a href="encoding.html#extend">How to extend the existing
4228 support</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4229</ol>
4230
4231<h3><a name="What">What does internationalization support mean ?</a></h3>
4232
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4233<p>XML was designed from the start to allow the support of any character set
4234by using Unicode. Any conformant XML parser has to support the UTF-8 and
4235UTF-16 default encodings which can both express the full unicode ranges. UTF8
4236is a variable length encoding whose greatest points are to reuse the same
4237encoding for ASCII and to save space for Western encodings, but it is a bit
4238more complex to handle in practice. UTF-16 use 2 bytes per character (and
4239sometimes combines two pairs), it makes implementation easier, but looks a
4240bit overkill for Western languages encoding. Moreover the XML specification
4241allows the document to be encoded in other encodings at the condition that
4242they are clearly labeled as such. For example the following is a wellformed
4243XML document encoded in ISO-8859-1 and using accentuated letters that we
4244French like for both markup and content:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4245<pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]4246&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;</pre>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4247
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4248<p>Having internationalization support in libxml2 means the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4249<ul>
4250 <li>the document is properly parsed</li>
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]4251 <li>information about it's encoding is saved</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4252 <li>it can be modified</li>
4253 <li>it can be saved in its original encoding</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4254 <li>it can also be saved in another encoding supported by libxml2 (for
4255 example straight UTF8 or even an ASCII form)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4256</ul>
4257
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4258<p>Another very important point is that the whole libxml2 API, with the
4259exception of a few routines to read with a specific encoding or save to a
4260specific encoding, is completely agnostic about the original encoding of the
4261document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4262
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4263<p>It should be noted too that the HTML parser embedded in libxml2 now obey
4264the same rules too, the following document will be (as of 2.2.2) handled in
4265an internationalized fashion by libxml2 too:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4266<pre>&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
4267 "http://www.w3.org/TR/REC-html40/loose.dtd"&gt;
4268&lt;html lang="fr"&gt;
4269&lt;head&gt;
4270 &lt;META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"&gt;
4271&lt;/head&gt;
4272&lt;body&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]4273&lt;p&gt;W3C cr&eacute;e des standards pour le Web.&lt;/body&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4274&lt;/html&gt;</pre>
4275
4276<h3><a name="internal">The internal encoding, how and why</a></h3>
4277
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4278<p>One of the core decisions was to force all documents to be converted to a
4279default internal encoding, and that encoding to be UTF-8, here are the
4280rationales for those choices:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4281<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4282 <li>keeping the native encoding in the internal form would force the libxml
4283 users (or the code associated) to be fully aware of the encoding of the
4284 original document, for examples when adding a text node to a document,
4285 the content would have to be provided in the document encoding, i.e. the
4286 client code would have to check it before hand, make sure it's conformant
4287 to the encoding, etc ... Very hard in practice, though in some specific
4288 cases this may make sense.</li>
4289 <li>the second decision was which encoding. From the XML spec only UTF8 and
4290 UTF16 really makes sense as being the two only encodings for which there
4291 is mandatory support. UCS-4 (32 bits fixed size encoding) could be
4292 considered an intelligent choice too since it's a direct Unicode mapping
4293 support. I selected UTF-8 on the basis of efficiency and compatibility
4294 with surrounding software:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4295 <ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4296 <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
4297 more costly to import and export CPU wise) is also far more compact
4298 than UTF-16 (and UCS-4) for a majority of the documents I see it used
4299 for right now (RPM RDF catalogs, advogato data, various configuration
4300 file formats, etc.) and the key point for today's computer
4301 architecture is efficient uses of caches. If one nearly double the
4302 memory requirement to store the same amount of data, this will trash
4303 caches (main memory/external caches/internal caches) and my take is
4304 that this harms the system far more than the CPU requirements needed
4305 for the conversion to UTF-8</li>
4306 <li>Most of libxml2 version 1 users were using it with straight ASCII
4307 most of the time, doing the conversion with an internal encoding
4308 requiring all their code to be rewritten was a serious show-stopper
4309 for using UTF-16 or UCS-4.</li>
4310 <li>UTF-8 is being used as the de-facto internal encoding standard for
4311 related code like the <a href="http://www.pango.org/">pango</a>
4312 upcoming Gnome text widget, and a lot of Unix code (yet another place
4313 where Unix programmer base takes a different approach from Microsoft
4314 - they are using UTF-16)</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4315 </ul>
4316 </li>
4317</ul>
4318
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4319<p>What does this mean in practice for the libxml2 user:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4320<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4321 <li>xmlChar, the libxml2 data type is a byte, those bytes must be assembled
4322 as UTF-8 valid strings. The proper way to terminate an xmlChar * string
4323 is simply to append 0 byte, as usual.</li>
4324 <li>One just need to make sure that when using chars outside the ASCII set,
4325 the values has been properly converted to UTF-8</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4326</ul>
4327
4328<h3><a name="implemente">How is it implemented ?</a></h3>
4329
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4330<p>Let's describe how all this works within libxml, basically the I18N
4331(internationalization) support get triggered only during I/O operation, i.e.
4332when reading a document or saving one. Let's look first at the reading
4333sequence:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4334<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4335 <li>when a document is processed, we usually don't know the encoding, a
4336 simple heuristic allows to detect UTF-16 and UCS-4 from encodings where
4337 the ASCII range (0-0x7F) maps with ASCII</li>
4338 <li>the xml declaration if available is parsed, including the encoding
4339 declaration. At that point, if the autodetected encoding is different
4340 from the one declared a call to xmlSwitchEncoding() is issued.</li>
4341 <li>If there is no encoding declaration, then the input has to be in either
4342 UTF-8 or UTF-16, if it is not then at some point when processing the
4343 input, the converter/checker of UTF-8 form will raise an encoding error.
4344 You may end-up with a garbled document, or no document at all ! Example:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4345 <pre>~/XML -&gt; ./xmllint err.xml
4346err.xml:1: error: Input is not proper UTF-8, indicate encoding !
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]4347&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4348 ^
4349err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]4350&lt;tr&egrave;s&gt;l&agrave; &lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4351 ^</pre>
4352 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4353 <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize it, and
4354 then search the default registered encoding converters for that encoding.
4355 If it's not within the default set and iconv() support has been compiled
4356 it, it will ask iconv for such an encoder. If this fails then the parser
4357 will report an error and stops processing:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4358 <pre>~/XML -&gt; ./xmllint err2.xml
4359err2.xml:1: error: Unsupported encoding UnsupportedEnc
4360&lt;?xml version="1.0" encoding="UnsupportedEnc"?&gt;
4361 ^</pre>
4362 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4363 <li>From that point the encoder processes progressively the input (it is
4364 plugged as a front-end to the I/O module) for that entity. It captures
4365 and converts on-the-fly the document to be parsed to UTF-8. The parser
4366 itself just does UTF-8 checking of this input and process it
4367 transparently. The only difference is that the encoding information has
4368 been added to the parsing context (more precisely to the input
4369 corresponding to this entity).</li>
4370 <li>The result (when using DOM) is an internal form completely in UTF-8
4371 with just an encoding information on the document node.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4372</ol>
4373
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4374<p>Ok then what happens when saving the document (assuming you
4375collected/built an xmlDoc DOM like structure) ? It depends on the function
4376called, xmlSaveFile() will just try to save in the original encoding, while
4377xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
4378encoding:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4379<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4380 <li>if no encoding is given, libxml2 will look for an encoding value
4381 associated to the document and if it exists will try to save to that
4382 encoding,
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4383 <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
4384 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4385 <li>so if an encoding was specified, either at the API level or on the
4386 document, libxml2 will again canonicalize the encoding name, lookup for a
4387 converter in the registered set or through iconv. If not found the
4388 function will return an error code</li>
4389 <li>the converter is placed before the I/O buffer layer, as another kind of
4390 buffer, then libxml2 will simply push the UTF-8 serialization to through
4391 that buffer, which will then progressively be converted and pushed onto
4392 the I/O layer.</li>
4393 <li>It is possible that the converter code fails on some input, for example
4394 trying to push an UTF-8 encoded Chinese character through the UTF-8 to
4395 ISO-8859-1 converter won't work. Since the encoders are progressive they
4396 will just report the error and the number of bytes converted, at that
4397 point libxml2 will decode the offending character, remove it from the
4398 buffer and replace it with the associated charRef encoding &amp;#123; and
4399 resume the conversion. This guarantees that any document will be saved
4400 without losses (except for markup names where this is not legal, this is
4401 a problem in the current version, in practice avoid using non-ascii
4402 characters for tag or attribute names). A special "ascii" encoding name
4403 is used to save documents to a pure ascii form can be used when
4404 portability is really crucial</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4405</ol>
4406
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]4407<p>Here are a few examples based on the same test document and assumin a
4408terminal using ISO-8859-1 as the text encoding:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4409<pre>~/XML -&gt; ./xmllint isolat1
4410&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
Daniel Veillardd2190fa2010-09-30 13:58:22 +0200[diff] [blame]4411&lt;tr&egrave;s&gt;là&lt;/tr&egrave;s&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4412~/XML -&gt; ./xmllint --encode UTF-8 isolat1
4413&lt;?xml version="1.0" encoding="UTF-8"?&gt;
Daniel Veillard29341682009-09-10 18:23:39 +0200[diff] [blame]4414&lt;très&gt;là &nbsp;&lt;/très&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4415~/XML -&gt; </pre>
4416
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4417<p>The same processing is applied (and reuse most of the code) for HTML I18N
4418processing. Looking up and modifying the content encoding is a bit more
4419difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
4420so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
4421been provided. The parser also attempts to switch encoding on the fly when
4422detecting such a tag on input. Except for that the processing is the same
4423(and again reuses the same code).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4424
4425<h3><a name="Default">Default supported encodings</a></h3>
4426
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4427<p>libxml2 has a set of default converters for the following encodings
4428(located in encoding.c):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4429<ol>
4430 <li>UTF-8 is supported by default (null handlers)</li>
4431 <li>UTF-16, both little and big endian</li>
4432 <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
4433 <li>ASCII, useful mostly for saving</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4434 <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
4435 predefined entities like &amp;copy; for the Copyright sign.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4436</ol>
4437
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4438<p>More over when compiled on an Unix platform with iconv support the full
4439set of encodings supported by iconv can be instantly be used by libxml. On a
4440linux machine with glibc-2.1 the list of supported encodings and aliases fill
44413 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
4442various Japanese ones.</p>
Daniel Veillard67952602006-01-05 15:29:44 +0000[diff] [blame]4443
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4444<p>To convert from the UTF-8 values returned from the API to another encoding
4445then it is possible to use the function provided from <a
4446href="html/libxml-encoding.html">the encoding module</a> like <a
4447href="html/libxml-encoding.html#UTF8Toisolat1">UTF8Toisolat1</a>, or use the
4448POSIX <a
4449href="http://www.opengroup.org/onlinepubs/009695399/functions/iconv.html">iconv()</a>
4450API directly.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4451
4452<h4>Encoding aliases</h4>
4453
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4454<p>From 2.2.3, libxml2 has support to register encoding names aliases. The
4455goal is to be able to parse document whose encoding is supported but where
4456the name differs (for example from the default set of names accepted by
4457iconv). The following functions allow to register and handle new aliases for
4458existing encodings. Once registered libxml2 will automatically lookup the
4459aliases when handling a document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4460<ul>
4461 <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
4462 <li>int xmlDelEncodingAlias(const char *alias);</li>
4463 <li>const char * xmlGetEncodingAlias(const char *alias);</li>
4464 <li>void xmlCleanupEncodingAliases(void);</li>
4465</ul>
4466
4467<h3><a name="extend">How to extend the existing support</a></h3>
4468
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4469<p>Well adding support for new encoding, or overriding one of the encoders
4470(assuming it is buggy) should not be hard, just write input and output
4471conversion routines to/from UTF-8, and register them using
4472xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be
4473called automatically if the parser(s) encounter such an encoding name
4474(register it uppercase, this will help). The description of the encoders,
4475their arguments and expected return values are described in the encoding.h
4476header.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4477
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4478<h2><a name="IO">I/O Interfaces</a></h2>
4479
4480<p>Table of Content:</p>
4481<ol>
4482 <li><a href="#General1">General overview</a></li>
4483 <li><a href="#basic">The basic buffer type</a></li>
4484 <li><a href="#Input">Input I/O handlers</a></li>
4485 <li><a href="#Output">Output I/O handlers</a></li>
4486 <li><a href="#entities">The entities loader</a></li>
4487 <li><a href="#Example2">Example of customized I/O</a></li>
4488</ol>
4489
4490<h3><a name="General1">General overview</a></h3>
4491
4492<p>The module <code><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4493href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
4494the interfaces to the libxml2 I/O system. This consists of 4 main parts:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4495<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4496 <li>Entities loader, this is a routine which tries to fetch the entities
4497 (files) based on their PUBLIC and SYSTEM identifiers. The default loader
4498 don't look at the public identifier since libxml2 do not maintain a
4499 catalog. You can redefine you own entity loader by using
4500 <code>xmlGetExternalEntityLoader()</code> and
4501 <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
4502 example</a>.</li>
4503 <li>Input I/O buffers which are a commodity structure used by the parser(s)
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]4504 input layer to handle fetching the information to feed the parser. This
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4505 provides buffering and is also a placeholder where the encoding
4506 converters to UTF8 are piggy-backed.</li>
4507 <li>Output I/O buffers are similar to the Input ones and fulfill similar
4508 task but when generating a serialization from a tree.</li>
4509 <li>A mechanism to register sets of I/O callbacks and associate them with
4510 specific naming schemes like the protocol part of the URIs.
4511 <p>This affect the default I/O operations and allows to use specific I/O
4512 handlers for certain names.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4513 </li>
4514</ul>
4515
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4516<p>The general mechanism used when loading http://rpmfind.net/xml.html for
4517example in the HTML parser is the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4518<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4519 <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
4520 the parsing context and the URI string.</li>
4521 <li>the URI string is checked against the existing registered handlers
4522 using their match() callback function, if the HTTP module was compiled
4523 in, it is registered and its match() function will succeeds</li>
4524 <li>the open() function of the handler is called and if successful will
4525 return an I/O Input buffer</li>
4526 <li>the parser will the start reading from this buffer and progressively
4527 fetch information from the resource, calling the read() function of the
4528 handler until the resource is exhausted</li>
4529 <li>if an encoding change is detected it will be installed on the input
4530 buffer, providing buffering and efficient use of the conversion
4531 routines</li>
4532 <li>once the parser has finished, the close() function of the handler is
4533 called once and the Input buffer and associated resources are
4534 deallocated.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4535</ol>
4536
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4537<p>The user defined callbacks are checked first to allow overriding of the
4538default libxml2 I/O routines.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4539
4540<h3><a name="basic">The basic buffer type</a></h3>
4541
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4542<p>All the buffer manipulation handling is done using the
4543<code>xmlBuffer</code> type define in <code><a
4544href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a
4545resizable memory buffer. The buffer allocation strategy can be selected to be
4546either best-fit or use an exponential doubling one (CPU vs. memory use
4547trade-off). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
4548<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
4549system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
4550of functions allows to manipulate buffers with names starting with the
4551<code>xmlBuffer...</code> prefix.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4552
4553<h3><a name="Input">Input I/O handlers</a></h3>
4554
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4555<p>An Input I/O handler is a simple structure
4556<code>xmlParserInputBuffer</code> containing a context associated to the
4557resource (file descriptor, or pointer to a protocol handler), the read() and
4558close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
4559encoding handler are also present to support charset conversion when
4560needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4561
4562<h3><a name="Output">Output I/O handlers</a></h3>
4563
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4564<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
4565Input one except the callbacks are write() and close().</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4566
4567<h3><a name="entities">The entities loader</a></h3>
4568
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4569<p>The entity loader resolves requests for new entities and create inputs for
4570the parser. Creating an input from a filename or an URI string is done
4571through the xmlNewInputFromFile() routine. The default entity loader do not
4572handle the PUBLIC identifier associated with an entity (if any). So it just
4573calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
4574XML).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4575
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4576<p>If you want to hook up a catalog mechanism then you simply need to
4577override the default entity loader, here is an example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4578<pre>#include &lt;libxml/xmlIO.h&gt;
4579
4580xmlExternalEntityLoader defaultLoader = NULL;
4581
4582xmlParserInputPtr
4583xmlMyExternalEntityLoader(const char *URL, const char *ID,
4584 xmlParserCtxtPtr ctxt) {
4585 xmlParserInputPtr ret;
4586 const char *fileID = NULL;
4587 /* lookup for the fileID depending on ID */
4588
4589 ret = xmlNewInputFromFile(ctxt, fileID);
4590 if (ret != NULL)
4591 return(ret);
4592 if (defaultLoader != NULL)
4593 ret = defaultLoader(URL, ID, ctxt);
4594 return(ret);
4595}
4596
4597int main(..) {
4598 ...
4599
4600 /*
4601 * Install our own entity loader
4602 */
4603 defaultLoader = xmlGetExternalEntityLoader();
4604 xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);
4605
4606 ...
4607}</pre>
4608
4609<h3><a name="Example2">Example of customized I/O</a></h3>
4610
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4611<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
4612real use case</a>, xmlDocDump() closes the FILE * passed by the application
4613and this was a problem. The <a
4614href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
4615new output handler with the closing call deactivated:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4616<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4617 <li>First define a new I/O output allocator where the output don't close
4618 the file:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4619 <pre>xmlOutputBufferPtr
4620xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4621&nbsp;&nbsp;&nbsp;&nbsp;xmlOutputBufferPtr ret;
4622&nbsp;&nbsp;&nbsp;&nbsp;
4623&nbsp;&nbsp;&nbsp;&nbsp;if (xmlOutputCallbackInitialized == 0)
4624&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlRegisterDefaultOutputCallbacks();
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4625
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4626&nbsp;&nbsp;&nbsp;&nbsp;if (file == NULL) return(NULL);
4627&nbsp;&nbsp;&nbsp;&nbsp;ret = xmlAllocOutputBuffer(encoder);
4628&nbsp;&nbsp;&nbsp;&nbsp;if (ret != NULL) {
4629&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;context = file;
4630&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;writecallback = xmlFileWrite;
4631&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ret-&gt;closecallback = NULL; /* No close callback */
4632&nbsp;&nbsp;&nbsp;&nbsp;}
4633&nbsp;&nbsp;&nbsp;&nbsp;return(ret);
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4634} </pre>
4635 </li>
4636 <li>And then use it to save the document:
4637 <pre>FILE *f;
4638xmlOutputBufferPtr output;
4639xmlDocPtr doc;
4640int res;
4641
4642f = ...
4643doc = ....
4644
4645output = xmlOutputBufferCreateOwn(f, NULL);
4646res = xmlSaveFileTo(output, doc, NULL);
4647 </pre>
4648 </li>
4649</ol>
4650
4651<h2><a name="Catalog">Catalog support</a></h2>
4652
4653<p>Table of Content:</p>
4654<ol>
4655 <li><a href="General2">General overview</a></li>
4656 <li><a href="#definition">The definition</a></li>
4657 <li><a href="#Simple">Using catalogs</a></li>
4658 <li><a href="#Some">Some examples</a></li>
4659 <li><a href="#reference">How to tune catalog usage</a></li>
4660 <li><a href="#validate">How to debug catalog processing</a></li>
4661 <li><a href="#Declaring">How to create and maintain catalogs</a></li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4662 <li><a href="#implemento">The implementor corner quick review of the
4663 API</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4664 <li><a href="#Other">Other resources</a></li>
4665</ol>
4666
4667<h3><a name="General2">General overview</a></h3>
4668
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4669<p>What is a catalog? Basically it's a lookup mechanism used when an entity
4670(a file or a remote resource) references another entity. The catalog lookup
4671is inserted between the moment the reference is recognized by the software
4672(XML parser, stylesheet processing, or even images referenced for inclusion
4673in a rendering) and the time where loading that resource is actually
4674started.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4675
4676<p>It is basically used for 3 things:</p>
4677<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4678 <li>mapping from "logical" names, the public identifiers and a more
4679 concrete name usable for download (and URI). For example it can associate
4680 the logical name
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4681 <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4682 <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be
4683 downloaded</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4684 <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p>
4685 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4686 <li>remapping from a given URL to another one, like an HTTP indirection
4687 saying that
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4688 <p>"http://www.oasis-open.org/committes/tr.xsl"</p>
4689 <p>should really be looked at</p>
4690 <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p>
4691 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4692 <li>providing a local cache mechanism allowing to load the entities
4693 associated to public identifiers or remote resources, this is a really
4694 important feature for any significant deployment of XML or SGML since it
4695 allows to avoid the aleas and delays associated to fetching remote
4696 resources.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4697</ul>
4698
4699<h3><a name="definition">The definitions</a></h3>
4700
4701<p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p>
4702<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4703 <li>the older SGML catalogs, the official spec is SGML Open Technical
4704 Resolution TR9401:1997, but is better understood by reading <a
4705 href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from
4706 James Clark. This is relatively old and not the preferred mode of
4707 operation of libxml.</li>
4708 <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML
4709 Catalogs</a> is far more flexible, more recent, uses an XML syntax and
4710 should scale quite better. This is the default option of libxml.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4711</ul>
4712
4713<p></p>
4714
4715<h3><a name="Simple">Using catalog</a></h3>
4716
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4717<p>In a normal environment libxml2 will by default check the presence of a
4718catalog in /etc/xml/catalog, and assuming it has been correctly populated,
4719the processing is completely transparent to the document user. To take a
4720concrete example, suppose you are authoring a DocBook document, this one
4721starts with the following DOCTYPE definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4722<pre>&lt;?xml version='1.0'?&gt;
4723&lt;!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
4724 "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"&gt;</pre>
4725
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4726<p>When validating the document with libxml, the catalog will be
4727automatically consulted to lookup the public identifier "-//Norman Walsh//DTD
4728DocBk XML V3.1.4//EN" and the system identifier
4729"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have
4730been installed on your system and the catalogs actually point to them, libxml
4731will fetch them from the local disk.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4732
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4733<p style="font-size: 10pt"><strong>Note</strong>: Really don't use this
4734DOCTYPE example it's a really old version, but is fine as an example.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4735
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4736<p>Libxml2 will check the catalog each time that it is requested to load an
4737entity, this includes DTD, external parsed entities, stylesheets, etc ... If
4738your system is correctly configured all the authoring phase and processing
4739should use only local files, even if your document stays portable because it
4740uses the canonical public and system ID, referencing the remote document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4741
4742<h3><a name="Some">Some examples:</a></h3>
4743
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4744<p>Here is a couple of fragments from XML Catalogs used in libxml2 early
4745regression tests in <code>test/catalogs</code> :</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4746<pre>&lt;?xml version="1.0"?&gt;
4747&lt;!DOCTYPE catalog PUBLIC
4748 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4749 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4750&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
4751 &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
4752 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
4753...</pre>
4754
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4755<p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are
4756written in XML, there is a specific namespace for catalog elements
4757"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this
4758catalog is a <code>public</code> mapping it allows to associate a Public
4759Identifier with an URI.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4760<pre>...
4761 &lt;rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/"
4762 rewritePrefix="file:///usr/share/xml/docbook/"/&gt;
4763...</pre>
4764
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4765<p>A <code>rewriteSystem</code> is a very powerful instruction, it says that
4766any URI starting with a given prefix should be looked at another URI
4767constructed by replacing the prefix with an new one. In effect this acts like
4768a cache system for a full area of the Web. In practice it is extremely useful
4769with a file prefix if you have installed a copy of those resources on your
4770local system.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4771<pre>...
4772&lt;delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //"
4773 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4774&lt;delegatePublic publicIdStartString="-//OASIS//ENTITIES DocBook XML"
4775 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4776&lt;delegatePublic publicIdStartString="-//OASIS//DTD DocBook XML"
4777 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4778&lt;delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/"
4779 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4780&lt;delegateURI uriStartString="http://www.oasis-open.org/docbook/"
4781 catalog="file:///usr/share/xml/docbook.xml"/&gt;
4782...</pre>
4783
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4784<p>Delegation is the core features which allows to build a tree of catalogs,
4785easier to maintain than a single catalog, based on Public Identifier, System
4786Identifier or URI prefixes it instructs the catalog software to look up
4787entries in another resource. This feature allow to build hierarchies of
4788catalogs, the set of entries presented should be sufficient to redirect the
4789resolution of all DocBook references to the specific catalog in
4790<code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all
4791references for DocBook 4.2.1 to a specific catalog installed at the same time
4792as the DocBook resources on the local machine.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4793
4794<h3><a name="reference">How to tune catalog usage:</a></h3>
4795
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4796<p>The user can change the default catalog behaviour by redirecting queries
4797to its own set of catalogs, this can be done by setting the
4798<code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an
4799empty one should deactivate loading the default <code>/etc/xml/catalog</code>
4800default catalog</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4801
4802<h3><a name="validate">How to debug catalog processing:</a></h3>
4803
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4804<p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]4805make libxml2 output debugging information for each catalog operations, for
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4806example:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4807<pre>orchis:~/XML -&gt; xmllint --memory --noout test/ent2
4808warning: failed to load external entity "title.xml"
4809orchis:~/XML -&gt; export XML_DEBUG_CATALOG=
4810orchis:~/XML -&gt; xmllint --memory --noout test/ent2
4811Failed to parse catalog /etc/xml/catalog
4812Failed to parse catalog /etc/xml/catalog
4813warning: failed to load external entity "title.xml"
4814Catalogs cleanup
4815orchis:~/XML -&gt; </pre>
4816
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4817<p>The test/ent2 references an entity, running the parser from memory makes
4818the base URI unavailable and the the "title.xml" entity cannot be loaded.
4819Setting up the debug environment variable allows to detect that an attempt is
4820made to load the <code>/etc/xml/catalog</code> but since it's not present the
4821resolution fails.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4822
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4823<p>But the most advanced way to debug XML catalog processing is to use the
4824<strong>xmlcatalog</strong> command shipped with libxml2, it allows to load
4825catalogs and make resolution queries to see what is going on. This is also
4826used for the regression tests:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4827<pre>orchis:~/XML -&gt; ./xmlcatalog test/catalogs/docbook.xml \
4828 "-//OASIS//DTD DocBook XML V4.1.2//EN"
4829http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4830orchis:~/XML -&gt; </pre>
4831
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4832<p>For debugging what is going on, adding one -v flags increase the verbosity
4833level to indicate the processing done (adding a second flag also indicate
4834what elements are recognized at parsing):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4835<pre>orchis:~/XML -&gt; ./xmlcatalog -v test/catalogs/docbook.xml \
4836 "-//OASIS//DTD DocBook XML V4.1.2//EN"
4837Parsing catalog test/catalogs/docbook.xml's content
4838Found public match -//OASIS//DTD DocBook XML V4.1.2//EN
4839http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4840Catalogs cleanup
4841orchis:~/XML -&gt; </pre>
4842
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4843<p>A shell interface is also available to debug and process multiple queries
4844(and for regression tests):</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4845<pre>orchis:~/XML -&gt; ./xmlcatalog -shell test/catalogs/docbook.xml \
4846 "-//OASIS//DTD DocBook XML V4.1.2//EN"
4847&gt; help
4848Commands available:
4849public PublicID: make a PUBLIC identifier lookup
4850system SystemID: make a SYSTEM identifier lookup
4851resolve PublicID SystemID: do a full resolver lookup
4852add 'type' 'orig' 'replace' : add an entry
4853del 'values' : remove values
4854dump: print the current catalog state
4855debug: increase the verbosity level
4856quiet: decrease the verbosity level
4857exit: quit the shell
4858&gt; public "-//OASIS//DTD DocBook XML V4.1.2//EN"
4859http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
4860&gt; quit
4861orchis:~/XML -&gt; </pre>
4862
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4863<p>This should be sufficient for most debugging purpose, this was actually
4864used heavily to debug the XML Catalog implementation itself.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4865
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4866<h3><a name="Declaring">How to create and maintain</a> catalogs:</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4867
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4868<p>Basically XML Catalogs are XML files, you can either use XML tools to
4869manage them or use <strong>xmlcatalog</strong> for this. The basic step is
4870to create a catalog the -create option provide this facility:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4871<pre>orchis:~/XML -&gt; ./xmlcatalog --create tst.xml
4872&lt;?xml version="1.0"?&gt;
4873&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4874 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4875&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4876orchis:~/XML -&gt; </pre>
4877
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4878<p>By default xmlcatalog does not overwrite the original catalog and save the
4879result on the standard output, this can be overridden using the -noout
4880option. The <code>-add</code> command allows to add entries in the
4881catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4882<pre>orchis:~/XML -&gt; ./xmlcatalog --noout --create --add "public" \
4883 "-//OASIS//DTD DocBook XML V4.1.2//EN" \
4884 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml
4885orchis:~/XML -&gt; cat tst.xml
4886&lt;?xml version="1.0"?&gt;
4887&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" \
4888 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4889&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
4890&lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
4891 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
4892&lt;/catalog&gt;
4893orchis:~/XML -&gt; </pre>
4894
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4895<p>The <code>-add</code> option will always take 3 parameters even if some of
4896the XML Catalog constructs (like nextCatalog) will have only a single
4897argument, just pass a third empty string, it will be ignored.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4898
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4899<p>Similarly the <code>-del</code> option remove matching entries from the
4900catalog:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4901<pre>orchis:~/XML -&gt; ./xmlcatalog --del \
4902 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml
4903&lt;?xml version="1.0"?&gt;
4904&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
4905 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
4906&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
4907orchis:~/XML -&gt; </pre>
4908
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4909<p>The catalog is now empty. Note that the matching of <code>-del</code> is
4910exact and would have worked in a similar fashion with the Public ID
4911string.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4912
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4913<p>This is rudimentary but should be sufficient to manage a not too complex
4914catalog tree of resources.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4915
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4916<h3><a name="implemento">The implementor corner quick review of the
4917API:</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4918
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4919<p>First, and like for every other module of libxml, there is an
4920automatically generated <a href="html/libxml-catalog.html">API page for
4921catalog support</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4922
4923<p>The header for the catalog interfaces should be included as:</p>
4924<pre>#include &lt;libxml/catalog.h&gt;</pre>
4925
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4926<p>The API is voluntarily kept very simple. First it is not obvious that
4927applications really need access to it since it is the default behaviour of
4928libxml2 (Note: it is possible to completely override libxml2 default catalog
4929by using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to
4930plug an application specific resolver).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4931
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4932<p>Basically libxml2 support 2 catalog lists:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4933<ul>
4934 <li>the default one, global shared by all the application</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4935 <li>a per-document catalog, this one is built if the document uses the
4936 <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is
4937 associated to the parser context and destroyed when the parsing context
4938 is destroyed.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4939</ul>
4940
4941<p>the document one will be used first if it exists.</p>
4942
4943<h4>Initialization routines:</h4>
4944
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4945<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be
4946used at startup to initialize the catalog, if the catalog should be
4947initialized with specific values xmlLoadCatalog() or xmlLoadCatalogs()
4948should be called before xmlInitializeCatalog() which would otherwise do a
4949default initialization first.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4950
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4951<p>The xmlCatalogAddLocal() call is used by the parser to grow the document
4952own catalog list if needed.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4953
4954<h4>Preferences setup:</h4>
4955
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4956<p>The XML Catalog spec requires the possibility to select default
4957preferences between public and system delegation,
4958xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and
4959xmlCatalogGetDefaults() allow to control if XML Catalogs resolution should
4960be forbidden, allowed for global catalog, for document catalog or both, the
4961default is to allow both.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4962
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4963<p>And of course xmlCatalogSetDebug() allows to generate debug messages
4964(through the xmlGenericError() mechanism).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4965
4966<h4>Querying routines:</h4>
4967
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4968<p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic()
4969and xmlCatalogResolveURI() are relatively explicit if you read the XML
4970Catalog specification they correspond to section 7 algorithms, they should
4971also work if you have loaded an SGML catalog with a simplified semantic.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4972
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4973<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but
4974operate on the document catalog list</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4975
4976<h4>Cleanup and Miscellaneous:</h4>
4977
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4978<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is
4979the per-document equivalent.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4980
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4981<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the
4982first catalog in the global list, and xmlCatalogDump() allows to dump a
4983catalog state, those routines are primarily designed for xmlcatalog, I'm not
4984sure that exposing more complex interfaces (like navigation ones) would be
4985really useful.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4986
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4987<p>The xmlParseCatalogFile() is a function used to load XML Catalog files,
4988it's similar as xmlParseFile() except it bypass all catalog lookups, it's
4989provided because this functionality may be useful for client tools.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4990
4991<h4>threaded environments:</h4>
4992
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]4993<p>Since the catalog tree is built progressively, some care has been taken to
4994try to avoid troubles in multithreaded environments. The code is now thread
4995safe assuming that the libxml2 library has been compiled with threads
4996support.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4997
4998<p></p>
4999
5000<h3><a name="Other">Other resources</a></h3>
5001
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5002<p>The XML Catalog specification is relatively recent so there isn't much
5003literature to point at:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5004<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]5005 <li>You can find a good rant from Norm Walsh about <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5006 href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]5007 need for catalogs</a>, it provides a lot of context information even if
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5008 I don't agree with everything presented. Norm also wrote a more recent
5009 article <a
5010 href="http://wwws.sun.com/software/xml/developers/resolver/article/">XML
5011 entities and URI resolvers</a> describing them.</li>
5012 <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML
5013 catalog proposal</a> from John Cowan</li>
5014 <li>The <a href="http://www.rddl.org/">Resource Directory Description
5015 Language</a> (RDDL) another catalog system but more oriented toward
5016 providing metadata for XML namespaces.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5017 <li>the page from the OASIS Technical <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5018 href="http://www.oasis-open.org/committees/entity/">Committee on Entity
5019 Resolution</a> who maintains XML Catalog, you will find pointers to the
5020 specification update, some background and pointers to others tools
5021 providing XML Catalog support</li>
5022 <li>There is a <a href="buildDocBookCatalog">shell script</a> to generate
5023 XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
5024 directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
5025 the resources found on the system. Otherwise it will just create
5026 ~/xmlcatalog and ~/dbkxmlcatalog and doing:
Daniel Veillard8594de92003-04-25 10:08:44 +0000[diff] [blame]5027 <p><code>export XML_CATALOG_FILES=$HOME/xmlcatalog</code></p>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5028 <p>should allow to process DocBook documentations without requiring
5029 network accesses for the DTD or stylesheets</p>
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]5030 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5031 <li>I have uploaded <a href="ftp://xmlsoft.org/libxml2/test/dbk412catalog.tar.gz">a
5032 small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
5033 to work fine for me too</li>
5034 <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog
5035 manual page</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5036</ul>
5037
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5038<p>If you have suggestions for corrections or additions, simply contact
5039me:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5040
5041<h2><a name="library">The parser interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5042
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5043<p>This section is directly intended to help programmers getting bootstrapped
5044using the XML tollkit from the C language. It is not intended to be
5045extensive. I hope the automatically generated documents will provide the
5046completeness required, but as a separate set of documents. The interfaces of
5047the XML parser are by principle low level, Those interested in a higher level
5048API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]5049
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5050<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
5051separated from the <a href="html/libxml-htmlparser.html">HTML parser
5052interfaces</a>. Let's have a look at how the XML parser can be called:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5053
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5054<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5055
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5056<p>Usually, the first thing to do is to read an XML input. The parser accepts
5057documents either from in-memory strings or from files. The functions are
5058defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]5059<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5060 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5061 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5062 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]5063</dl>
5064<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5065 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5066 <dd><p>Parse an XML document contained in a (possibly compressed)
5067 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5068 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]5069</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5070
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5071<p>The parser returns a pointer to the document structure (or NULL in case of
5072failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5073
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5074<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5075
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5076<p>In order for the application to keep the control when the document is
5077being fetched (which is common for GUI based programs) libxml2 provides a
5078push interface, too, as of version 1.8.3. Here are the interface
5079functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5080<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
5081 void *user_data,
5082 const char *chunk,
5083 int size,
5084 const char *filename);
5085int xmlParseChunk (xmlParserCtxtPtr ctxt,
5086 const char *chunk,
5087 int size,
5088 int terminate);</pre>
5089
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5090<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5091<pre> FILE *f;
5092
5093 f = fopen(filename, "r");
5094 if (f != NULL) {
5095 int res, size = 1024;
5096 char chars[1024];
5097 xmlParserCtxtPtr ctxt;
5098
5099 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5100 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5101 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
5102 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5103 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5104 xmlParseChunk(ctxt, chars, res, 0);
5105 }
5106 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5107 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5108 xmlFreeParserCtxt(ctxt);
5109 }
5110 }</pre>
5111
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5112<p>The HTML parser embedded into libxml2 also has a push interface; the
5113functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]5114
5115<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
5116
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5117<p>The tree-building interface makes the parser memory-hungry, first loading
5118the document in memory and then building the tree itself. Reading a document
5119without building the tree is possible using the SAX interfaces (see SAX.h and
5120<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
5121Henstridge's documentation</a>). Note also that the push interface can be
5122limited to SAX: just use the two first arguments of
5123<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]5124
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]5125<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5126
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5127<p>The other way to get an XML tree in memory is by building it. Basically
5128there is a set of functions dedicated to building new elements. (These are
5129also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
5130code that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5131<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]5132 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5133 xmlNodePtr tree, subtree;
5134
5135 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5136 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
5137 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
5138 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
5139 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5140 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5141 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5142 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
5143 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
5144 subtree = xmlNewChild(tree, NULL, "image", NULL);
5145 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5146
5147<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5148
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]5149<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5150
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5151<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
5152code has access to the internal structure of all the elements of the tree.
5153The names should be somewhat simple like <strong>parent</strong>,
5154<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
5155<strong>properties</strong>, etc... For example, still with the previous
5156example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5157<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5158
5159<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]5160<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5161
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5162<p>points to the text node containing the chapter title "The Linux
5163adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]5164
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5165<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
5166present before the document root, so <code>doc-&gt;children</code> may point
5167to an element which is not the document Root Element; a function
5168<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]5169
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]5170<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5171
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5172<p>Functions are provided for reading and writing the document content. Here
5173is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5174<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5175 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
5176 xmlChar *value);</code></dt>
5177 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
5178 The value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5179 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5180</dl>
5181<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5182 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
5183 *name);</code></dt>
5184 <dd><p>This function returns a pointer to new copy of the property
5185 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5186 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5187</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5188
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5189<p>Two functions are provided for reading and writing the text associated
5190with elements:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5191<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5192 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
5193 *value);</code></dt>
5194 <dd><p>This function takes an "external" string and converts it to one
5195 text node or possibly to a list of entity and text nodes. All
5196 non-predefined entity references like &amp;Gnome; will be stored
5197 internally as entity nodes, hence the result of the function may not be
5198 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5199 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5200</dl>
5201<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5202 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
5203 inLine);</code></dt>
5204 <dd><p>This function is the inverse of
5205 <code>xmlStringGetNodeList()</code>. It generates a new string
5206 containing the content of the text and entity nodes. Note the extra
5207 argument inLine. If this argument is set to 1, the function will expand
5208 entity references. For example, instead of returning the &amp;Gnome;
5209 XML encoding in the string, it will substitute it with its value (say,
5210 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5211 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5212</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]5213
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]5214<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5215
5216<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5217<dl>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5218 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
5219 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5220 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5221 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5222</dl>
5223<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5224 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5225 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5226 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5227</dl>
5228<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5229 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5230 <dd><p>Saves the document to a file. In this case, the compression
5231 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5232 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5233</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]5234
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]5235<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5236
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5237<p>The library transparently handles compression when doing file-based
5238accesses. The level of compression on saves can be turned on either globally
5239or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5240<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5241 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5242 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5243 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5244</dl>
5245<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5246 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5247 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5248 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5249</dl>
5250<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5251 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5252 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5253 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5254</dl>
5255<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5256 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]5257 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5258 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]5259</dl>
5260
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]5261<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5262
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5263<p>Entities in principle are similar to simple C macros. An entity defines an
5264abbreviation for a given string that you can reuse many times throughout the
5265content of your document. Entities are especially useful when a given string
5266may occur frequently within a document, or to confine the change needed to a
5267document to a restricted area in the internal subset of the document (at the
5268beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5269<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]52702 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]52713 &lt;!ENTITY xml "Extensible Markup Language"&gt;
52724 ]&gt;
52735 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]52746 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]52757 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5276
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5277<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
5278its name with '&amp;' and following it by ';' without any spaces added. There
5279are 5 predefined entities in libxml2 allowing you to escape characters with
5280predefined meaning in some parts of the xml document content:
5281<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
5282for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
5283<strong>&amp;quot;</strong> for the character '"', and
5284<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5285
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5286<p>One of the problems related to entities is that you may want the parser to
5287substitute an entity's content so that you can see the replacement text in
5288your application. Or you may prefer to keep entity references as such in the
5289content to be able to save the document back without losing this usually
5290precious information (if the user went through the pain of explicitly
5291defining entities, he may have a a rather negative attitude if you blindly
5292substitute them as saving time). The <a
5293href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a>
5294function allows you to check and change the behaviour, which is to not
5295substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5296
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5297<p>Here is the DOM tree built by libxml2 for the previous document in the
5298default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5299<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5300DOCUMENT
5301version=1.0
5302 ELEMENT EXAMPLE
5303 TEXT
5304 content=
5305 ENTITY_REF
5306 INTERNAL_GENERAL_ENTITY xml
5307 content=Extensible Markup Language
5308 TEXT
5309 content=</pre>
5310
5311<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5312<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5313DOCUMENT
5314version=1.0
5315 ELEMENT EXAMPLE
5316 TEXT
5317 content= Extensible Markup Language</pre>
5318
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5319<p>So, entities or no entities? Basically, it depends on your use case. I
5320suggest that you keep the non-substituting default behaviour and avoid using
5321entities in your XML document or data if you are not willing to handle the
5322entity references elements in the DOM tree.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5323
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5324<p>Note that at save time libxml2 enforces the conversion of the predefined
5325entities where necessary to prevent well-formedness problems, and will also
5326transparently replace those with chars (i.e. it will not generate entity
5327reference elements in the DOM tree or call the reference() SAX callback when
5328finding them in the input).</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5329
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5330<p><span style="background-color: #FF0000">WARNING</span>: handling entities
5331on top of the libxml2 SAX interface is difficult!!! If you plan to use
5332non-predefined entities in your documents, then the learning curve to handle
5333then using the SAX API may be long. If you plan to use complex documents, I
5334strongly suggest you consider using the DOM interface instead and let libxml
5335deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]5336
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]5337<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5338
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]5339<p>The libxml2 library implements <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5340href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
5341recognizing namespace constructs in the input, and does namespace lookup
5342automatically when building the DOM tree. A namespace declaration is
5343associated with an in-memory structure and all elements or attributes within
5344that namespace point to it. Hence testing the namespace is a simple and fast
5345equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5346
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5347<p>I suggest that people using libxml2 use a namespace, and declare it in the
5348root element of their document as the default namespace. Then they don't need
5349to use the prefix in the content but we will have a basis for future semantic
5350refinement and merging of data from different sources. This doesn't increase
5351the size of the XML output significantly, but significantly increases its
5352value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5353<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
5354 &lt;elem1&gt;...&lt;/elem1&gt;
5355 &lt;elem2&gt;...&lt;/elem2&gt;
5356&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5357
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5358<p>The namespace value has to be an absolute URL, but the URL doesn't have to
5359point to any existing resource on the Web. It will bind all the element and
5360attributes with that URL. I suggest to use an URL within a domain you
5361control, and that the URL should contain some kind of version information if
5362possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a
5363good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]5364
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5365<p>Then when you load a file, make sure that a namespace carrying the
5366version-independent prefix is installed on the root element of your document,
5367and if the version information don't match something you know, warn the user
5368and be liberal in what you accept as the input. Also do *not* try to base
5369namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
5370same as &lt;bar:text&gt; in another document. What really matters is the URI
5371associated with the element or the attribute, not the prefix string (which is
5372just a shortcut for the full URI). In libxml, element and attributes have an
5373<code>ns</code> field pointing to an xmlNs structure detailing the namespace
5374prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5375
5376<p>@@Interfaces@@</p>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]5377<pre>xmlNodePtr node;
Daniel Veillardfc8dc352003-10-18 09:07:46 +0000[diff] [blame]5378if(!strncmp(node-&gt;name,"mytag",5)
5379 &amp;&amp; node-&gt;ns
5380 &amp;&amp; !strcmp(node-&gt;ns-&gt;href,"http://www.mysite.com/myns/1.0")) {
5381 ...
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]5382}</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5383
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5384<p>Usually people object to using namespaces together with validity checking.
5385I will try to make sure that using namespaces won't break validity checking,
5386so even if you plan to use or currently are using validation I strongly
5387suggest adding namespaces to your document. A default namespace scheme
5388<code>xmlns="http://...."</code> should not break validity even on less
5389flexible parsers. Using namespaces to mix and differentiate content coming
5390from multiple DTDs will certainly break current validation schemes. To check
5391such documents one needs to use schema-validation, which is supported in
5392libxml2 as well. See <a href="http://www.relaxng.org/">relagx-ng</a> and <a
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]5393href="http://www.w3c.org/XML/Schema">w3c-schema</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5394
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5395<h2><a name="Upgrading">Upgrading 1.x code</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5396
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5397<p>Incompatible changes:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5398
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5399<p>Version 2 of libxml2 is the first version introducing serious backward
5400incompatible changes. The main goals were:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5401<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5402 <li>a general cleanup. A number of mistakes inherited from the very early
5403 versions couldn't be changed due to compatibility constraints. Example
5404 the "childs" element in the nodes.</li>
5405 <li>Uniformization of the various nodes, at least for their header and link
5406 parts (doc, parent, children, prev, next), the goal is a simpler
5407 programming model and simplifying the task of the DOM implementors.</li>
5408 <li>better conformances to the XML specification, for example version 1.x
5409 had an heuristic to try to detect ignorable white spaces. As a result the
5410 SAX event generated were ignorableWhitespace() while the spec requires
5411 character() in that case. This also mean that a number of DOM node
5412 containing blank text may populate the DOM tree which were not present
5413 before.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5414</ul>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5415
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5416<h3>How to fix libxml-1.x code:</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5417
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5418<p>So client code of libxml designed to run with version 1.x may have to be
5419changed to compile against version 2.x of libxml. Here is a list of changes
5420that I have collected, they may not be sufficient, so in case you find other
5421change which are required, <a href="mailto:Daniel.Veillard@w3.org">drop me a
5422mail</a>:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5423<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5424 <li>The package name have changed from libxml to libxml2, the library name
5425 is now -lxml2 . There is a new xml2-config script which should be used to
5426 select the right parameters libxml2</li>
5427 <li>Node <strong>childs</strong> field has been renamed
5428 <strong>children</strong> so s/childs/children/g should be applied
5429 (probability of having "childs" anywhere else is close to 0+</li>
5430 <li>The document don't have anymore a <strong>root</strong> element it has
5431 been replaced by <strong>children</strong> and usually you will get a
5432 list of element here. For example a Dtd element for the internal subset
5433 and it's declaration may be found in that list, as well as processing
5434 instructions or comments found before or after the document root element.
5435 Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of
5436 a document. Alternatively if you are sure to not reference DTDs nor have
5437 PIs or comments before or after the root element
5438 s/-&gt;root/-&gt;children/g will probably do it.</li>
5439 <li>The white space issue, this one is more complex, unless special case of
5440 validating parsing, the line breaks and spaces usually used for indenting
5441 and formatting the document content becomes significant. So they are
5442 reported by SAX and if your using the DOM tree, corresponding nodes are
5443 generated. Too approach can be taken:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5444 <ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5445 <li>lazy one, use the compatibility call
5446 <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are
5447 relying on a special (and possibly broken) set of heuristics of
5448 libxml to detect ignorable blanks. Don't complain if it breaks or
5449 make your application not 100% clean w.r.t. to it's input.</li>
5450 <li>the Right Way: change you code to accept possibly insignificant
5451 blanks characters, or have your tree populated with weird blank text
5452 nodes. You can spot them using the commodity function
5453 <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank
5454 nodes.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5455 </ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5456 <p>Note also that with the new default the output functions don't add any
5457 extra indentation when saving a tree in order to be able to round trip
5458 (read and save) without inflating the document with extra formatting
5459 chars.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5460 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5461 <li>The include path has changed to $prefix/libxml/ and the includes
5462 themselves uses this new prefix in includes instructions... If you are
5463 using (as expected) the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5464 <pre>xml2-config --cflags</pre>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5465 <p>output to generate you compile commands this will probably work out of
5466 the box</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5467 </li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5468 <li>xmlDetectCharEncoding takes an extra argument indicating the length in
5469 byte of the head of the document available for character detection.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5470</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5471
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5472<h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5473
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5474<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released
5475to allow smooth upgrade of existing libxml v1code while retaining
5476compatibility. They offers the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5477<ol>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5478 <li>similar include naming, one should use
5479 <strong>#include&lt;libxml/...&gt;</strong> in both cases.</li>
5480 <li>similar identifiers defined via macros for the child and root fields:
5481 respectively <strong>xmlChildrenNode</strong> and
5482 <strong>xmlRootNode</strong></li>
5483 <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be
5484 inserted once in the client code</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5485</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5486
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5487<p>So the roadmap to upgrade your existing libxml applications is the
5488following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5489<ol>
5490 <li>install the libxml-1.8.8 (and libxml-devel-1.8.8) packages</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5491 <li>find all occurrences where the xmlDoc <strong>root</strong> field is
5492 used and change it to <strong>xmlRootNode</strong></li>
5493 <li>similarly find all occurrences where the xmlNode
5494 <strong>childs</strong> field is used and change it to
5495 <strong>xmlChildrenNode</strong></li>
5496 <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your
5497 <strong>main()</strong> or in the library init entry point</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5498 <li>Recompile, check compatibility, it should still work</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5499 <li>Change your configure script to look first for xml2-config and fall
5500 back using xml-config . Use the --cflags and --libs output of the command
5501 as the Include and Linking parameters needed to use libxml.</li>
5502 <li>install libxml2-2.3.x and libxml2-devel-2.3.x (libxml-1.8.y and
5503 libxml-devel-1.8.y can be kept simultaneously)</li>
5504 <li>remove your config.cache, relaunch your configuration mechanism, and
5505 recompile, if steps 2 and 3 were done right it should compile as-is</li>
5506 <li>Test that your application is still running correctly, if not this may
5507 be due to extra empty nodes due to formating spaces being kept in libxml2
5508 contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your
5509 code before calling the parser (next to
5510 <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5511</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5512
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5513<p>Following those steps should work. It worked for some of my own code.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5514
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5515<p>Let me put some emphasis on the fact that there is far more changes from
5516libxml 1.x to 2.x than the ones you may have to patch for. The overall code
5517has been considerably cleaned up and the conformance to the XML specification
5518has been drastically improved too. Don't take those changes as an excuse to
5519not upgrade, it may cost a lot on the long term ...</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5520
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]5521<h2><a name="Thread">Thread safety</a></h2>
5522
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5523<p>Starting with 2.4.7, libxml2 makes provisions to ensure that concurrent
5524threads can safely work in parallel parsing different documents. There is
5525however a couple of things to do to ensure it:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]5526<ul>
5527 <li>configure the library accordingly using the --with-threads options</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5528 <li>call xmlInitParser() in the "main" thread before using any of the
5529 libxml2 API (except possibly selecting a different memory allocator)</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]5530</ul>
5531
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5532<p>Note that the thread safety cannot be ensured for multiple threads sharing
5533the same document, the locking must be done at the application level, libxml
5534exports a basic mutex and reentrant mutexes API in &lt;libxml/threads.h&gt;.
5535The parts of the library checked for thread safety are:</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]5536<ul>
5537 <li>concurrent loading</li>
5538 <li>file access resolution</li>
5539 <li>catalog access</li>
5540 <li>catalog building</li>
5541 <li>entities lookup/accesses</li>
5542 <li>validation</li>
5543 <li>global variables per-thread override</li>
5544 <li>memory handling</li>
5545</ul>
5546
Daniel Veillard28fdf8b2011-03-07 08:12:39 +0800[diff] [blame]5547<p>XPath has been tested for threaded usage on non-modified document
5548 for example when using libxslt, but make 100% sure the documents
5549 are accessed read-only !</p>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]5550
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]5551<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5552
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5553<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
5554Object Model</em>; this is an API for accessing XML or HTML structured
5555documents. Native support for DOM in Gnome is on the way (module gnome-dom),
5556and will be based on gnome-xml. This will be a far cleaner interface to
5557manipulate XML files within Gnome since it won't expose the internal
5558structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5559
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]5560<p>The current DOM implementation on top of libxml2 is the <a
Daniel Veillarda4f85b92009-03-25 10:45:20 +0000[diff] [blame]5561href="http://svn.gnome.org/viewvc/gdome2/trunk/">gdome2 Gnome module</a>, this
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5562is a full DOM interface, thanks to Paolo Casarini, check the <a
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]5563href="http://gdome2.cs.unibo.it/">Gdome2 homepage</a> for more
5564information.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5565
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]5566<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5567
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5568<p>Here is a real size example, where the actual content of the application
5569data is not kept in the DOM tree but uses internal structures. It is based on
5570a proposal to keep a database of jobs related to Gnome, with an XML based
5571storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
5572base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5573<pre>&lt;?xml version="1.0"?&gt;
5574&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
5575 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5576
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5577 &lt;gjob:Job&gt;
5578 &lt;gjob:Project ID="3"/&gt;
5579 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
5580 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5581
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5582 &lt;gjob:Update&gt;
5583 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
5584 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
5585 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
5586 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5587
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5588 &lt;gjob:Developers&gt;
5589 &lt;gjob:Developer&gt;
5590 &lt;/gjob:Developer&gt;
5591 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5592
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5593 &lt;gjob:Contact&gt;
5594 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
5595 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
5596 &lt;gjob:Company&gt;
5597 &lt;/gjob:Company&gt;
5598 &lt;gjob:Organisation&gt;
5599 &lt;/gjob:Organisation&gt;
5600 &lt;gjob:Webpage&gt;
5601 &lt;/gjob:Webpage&gt;
5602 &lt;gjob:Snailmail&gt;
5603 &lt;/gjob:Snailmail&gt;
5604 &lt;gjob:Phone&gt;
5605 &lt;/gjob:Phone&gt;
5606 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5607
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5608 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5609 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5610 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5611
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5612 &lt;gjob:Skills&gt;
5613 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5614
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5615 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5616 A GNOME based system that will allow a superuser to configure
5617 compressed and uncompressed files and/or file systems to be backed
5618 up with a supported media in the system. This should be able to
5619 perform via find commands generating a list of files that are passed
5620 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
5621 or via operations performed on the filesystem itself. Email
5622 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5623 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5624
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5625 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5626
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5627 &lt;/gjob:Jobs&gt;
5628&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5629
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5630<p>While loading the XML file into an internal DOM tree is a matter of
5631calling only a couple of functions, browsing the tree to gather the data and
5632generate the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5633
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5634<p>The suggested principle is to be tolerant with respect to the input
5635structure. For example, the ordering of the attributes is not significant,
5636the XML specification is clear about it. It's also usually a good idea not to
5637depend on the order of the children of a given node, unless it really makes
5638things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5639<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5640 * A person record
5641 */
5642typedef struct person {
5643 char *name;
5644 char *email;
5645 char *company;
5646 char *organisation;
5647 char *smail;
5648 char *webPage;
5649 char *phone;
5650} person, *personPtr;
5651
5652/*
5653 * And the code needed to parse it
5654 */
5655personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
5656 personPtr ret = NULL;
5657
5658DEBUG("parsePerson\n");
5659 /*
5660 * allocate the struct
5661 */
5662 ret = (personPtr) malloc(sizeof(person));
5663 if (ret == NULL) {
5664 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5665 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5666 }
5667 memset(ret, 0, sizeof(person));
5668
5669 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5670 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5671 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5672 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
5673 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5674 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
5675 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5676 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5677 }
5678
5679 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5680}</pre>
5681
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]5682<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5683<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5684 <li>Usually a recursive parsing style is the more convenient one: XML data
5685 is by nature subject to repetitive constructs and usually exhibits highly
5686 structured patterns.</li>
5687 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
5688 i.e. the pointer to the global XML document and the namespace reserved to
5689 the application. Document wide information are needed for example to
5690 decode entities and it's a good coding practice to define a namespace for
5691 your application set of data and test that the element and attributes
5692 you're analyzing actually pertains to your application space. This is
5693 done by a simple equality test (cur-&gt;ns == ns).</li>
5694 <li>To retrieve text and attributes value, you can use the function
5695 <em>xmlNodeListGetString</em> to gather all the text and entity reference
5696 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5697</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5698
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5699<p>Here is another piece of code used to parse another level of the
5700structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5701<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]5702/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5703 * a Description for a Job
5704 */
5705typedef struct job {
5706 char *projectID;
5707 char *application;
5708 char *category;
5709 personPtr contact;
5710 int nbDevelopers;
5711 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
5712} job, *jobPtr;
5713
5714/*
5715 * And the code needed to parse it
5716 */
5717jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
5718 jobPtr ret = NULL;
5719
5720DEBUG("parseJob\n");
5721 /*
5722 * allocate the struct
5723 */
5724 ret = (jobPtr) malloc(sizeof(job));
5725 if (ret == NULL) {
5726 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5727 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5728 }
5729 memset(ret, 0, sizeof(job));
5730
5731 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5732 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5733 while (cur != NULL) {
5734
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5735 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
5736 ret-&gt;projectID = xmlGetProp(cur, "ID");
5737 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5738 fprintf(stderr, "Project has no ID\n");
5739 }
5740 }
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]5741 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
5742 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5743 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
5744 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
5745 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
5746 ret-&gt;contact = parsePerson(doc, ns, cur);
5747 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5748 }
5749
5750 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5751}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]5752
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5753<p>Once you are used to it, writing this kind of code is quite simple, but
5754boring. Ultimately, it could be possible to write stubbers taking either C
5755data structure definitions, a set of XML examples or an XML DTD and produce
5756the code needed to import and export the content between C data and XML
5757storage. This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5758
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5759<p>Feel free to use <a href="example/gjobread.c">the code for the full C
5760parsing example</a> as a template, it is also available with Makefile in the
William M. Brack43a87292007-02-15 20:41:02 +0000[diff] [blame]5761Gnome SVN base under libxml2/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]5762
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]5763<h2><a name="Contributi">Contributions</a></h2>
5764<ul>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5765 <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of
5766 patches, Gary Pennington worked on the validation API, threading support
5767 and Solaris port.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]5768 <li>John Fleck helps maintaining the documentation and man pages.</li>
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5769 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
5770 maintainer of the Windows port, <a
5771 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
5772 binaries</a></li>
5773 <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a> provides
5774 <a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]5775 <li><a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5776 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
5777 Sergeant</a> developed <a
5778 href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
5779 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
5780 application server</a></li>
5781 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a
5782 href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
5783 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
5784 documentation</li>
5785 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]5786 href="http://xmlsoft.org/messages/0488.html">man pages</a></li>
Daniel Veillard5168dbf2001-07-07 00:18:23 +0000[diff] [blame]5787 <li>there is a module for <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5788 href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
5789 in OpenNSD/AOLServer</a></li>
5790 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provided the
5791 first version of libxml/libxslt <a
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]5792 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
Daniel Veillard1aadc442001-11-28 13:10:32 +0000[diff] [blame]5793 <li>Petr Kozelka provides <a
Daniel Veillardf781dba2006-06-09 13:34:49 +0000[diff] [blame]5794 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
5795 libxml2</a> with Kylix and Delphi and other Pascal compilers</li>
5796 <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a> implemented the
5797 <a href="http://www.w3.org/Signature/">XML Canonicalization and XML
5798 Digital Signature</a> <a
5799 href="http://www.aleksey.com/xmlsec/">implementations for libxml2</a></li>
5800 <li><a href="mailto:Steve.Ball@explain.com.au">Steve Ball</a> and
5801 contributors maintain <a href="http://tclxml.sourceforge.net/">tcl
5802 bindings for libxml2 and libxslt</a>, as well as <a
5803 href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for
5804 xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>
5805 a GUI for xsltproc.</li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]5806</ul>
5807
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]5808<p></p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]5809</body>
5810</html>