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