Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / e5d68dee3ab6468bf01886ba1b0b41a319be3f15 / . / doc / xml.html
blob: 41a66365c1f7c5993a528c20dbb0cf38a7cacfaa [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 Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]6 <meta name="GENERATOR" content="amaya 5.1">
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]7 <meta http-equiv="Content-Type" content="text/html">
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]8</head>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]9
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]10<body bgcolor="#ffffff">
Daniel Veillard598bec32003-07-06 10:02:03 +0000[diff] [blame]11<h1 align="center">The XML C parser and toolkit of Gnome</h1>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]12
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]13<h1>Note: this is the flat content of the <a href="index.html">web
14site</a></h1>
15
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]16<h1 style="text-align: center">libxml, a.k.a. gnome-xml</h1>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]17
18<p></p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]19
Daniel Veillard7ebac022004-02-25 22:36:35 +0000[diff] [blame]20<p
21style="text-align: right; font-style: italic; font-size: 10pt">"Programming
22with libxml2 is like the thrilling embrace of an exotic stranger." <a
23href="http://diveintomark.org/archives/2004/02/18/libxml2">Mark
24Pilgrim</a></p>
25
Daniel Veillard598bec32003-07-06 10:02:03 +0000[diff] [blame]26<p>Libxml2 is the XML C parser and toolkit developed for the Gnome project
Daniel Veillard23a52c52003-08-18 10:01:18 +0000[diff] [blame]27(but usable outside of the Gnome platform), it is free software available
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]28under the <a href="http://www.opensource.org/licenses/mit-license.html">MIT
29License</a>. XML itself is a metalanguage to design markup languages, i.e.
30text language where semantic and structure are added to the content using
31extra "markup" information enclosed between angle brackets. HTML is the most
32well-known markup language. Though the library is written in C <a
33href="python.html">a variety of language bindings</a> make it available in
34other environments.</p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]35
Daniel Veillard710823b2003-03-04 10:05:52 +0000[diff] [blame]36<p>Libxml2 is known to be very portable, the library should build and work
37without serious troubles on a variety of systems (Linux, Unix, Windows,
38CygWin, MacOS, MacOS X, RISC Os, OS/2, VMS, QNX, MVS, ...)</p>
39
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]40<p>Libxml2 implements a number of existing standards related to markup
41languages:</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]42<ul>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]43 <li>the XML standard: <a
44 href="http://www.w3.org/TR/REC-xml">http://www.w3.org/TR/REC-xml</a></li>
45 <li>Namespaces in XML: <a
46 href="http://www.w3.org/TR/REC-xml-names/">http://www.w3.org/TR/REC-xml-names/</a></li>
47 <li>XML Base: <a
48 href="http://www.w3.org/TR/xmlbase/">http://www.w3.org/TR/xmlbase/</a></li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]49 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc2396.txt">RFC 2396</a> :
50 Uniform Resource Identifiers <a
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]51 href="http://www.ietf.org/rfc/rfc2396.txt">http://www.ietf.org/rfc/rfc2396.txt</a></li>
52 <li>XML Path Language (XPath) 1.0: <a
53 href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</a></li>
54 <li>HTML4 parser: <a
55 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]56 <li>XML Pointer Language (XPointer) Version 1.0: <a
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]57 href="http://www.w3.org/TR/xptr">http://www.w3.org/TR/xptr</a></li>
58 <li>XML Inclusions (XInclude) Version 1.0: <a
59 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]60 <li>ISO-8859-x encodings, as well as <a
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]61 href="http://www.cis.ohio-state.edu/rfc/rfc2044.txt">rfc2044</a> [UTF-8]
62 and <a href="http://www.cis.ohio-state.edu/rfc/rfc2781.txt">rfc2781</a>
Daniel Veillard23a52c52003-08-18 10:01:18 +0000[diff] [blame]63 [UTF-16] Unicode encodings, and more if using iconv support</li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]64 <li>part of SGML Open Technical Resolution TR9401:1997</li>
65 <li>XML Catalogs Working Draft 06 August 2001: <a
66 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]67 <li>Canonical XML Version 1.0: <a
68 href="http://www.w3.org/TR/xml-c14n">http://www.w3.org/TR/xml-c14n</a>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]69 and the Exclusive XML Canonicalization CR draft <a
70 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]71 <li>Relax NG, ISO/IEC 19757-2:2003, <a
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]72 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]73 <li>W3C XML Schemas Part 2: Datatypes <a
74 href="http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/">REC 02 May
Daniel Veillard7ecced52003-12-18 14:22:09 +0000[diff] [blame]75 2001</a></li>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]76 <li>W3C <a href="http://www.w3.org/TR/xml-id/">xml:id</a> Working Draft 7
77 April 2004</li>
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]78</ul>
79
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]80<p>In most cases libxml2 tries to implement the specifications in a
Daniel Veillard7c4eb632004-04-19 21:29:12 +0000[diff] [blame]81relatively strictly compliant way. As of release 2.4.16, libxml2 passed all
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]821800+ tests from the <a
Daniel Veillarda5393562002-02-20 11:40:49 +0000[diff] [blame]83href="http://www.oasis-open.org/committees/xml-conformance/">OASIS XML Tests
84Suite</a>.</p>
Daniel Veillard5b16f582002-02-20 11:38:46 +0000[diff] [blame]85
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]86<p>To some extent libxml2 provides support for the following additional
87specifications but doesn't claim to implement them completely:</p>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]88<ul>
89 <li>Document Object Model (DOM) <a
90 href="http://www.w3.org/TR/DOM-Level-2-Core/">http://www.w3.org/TR/DOM-Level-2-Core/</a>
Daniel Veillardd4cfcef2004-05-06 18:55:27 +0000[diff] [blame]91 the document model, but it doesn't implement the API itself, gdome2 does
92 this on top of libxml2</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]93 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc959.txt">RFC 959</a> :
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]94 libxml2 implements a basic FTP client code</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]95 <li><a href="http://www.cis.ohio-state.edu/rfc/rfc1945.txt">RFC 1945</a> :
96 HTTP/1.0, again a basic HTTP client code</li>
Daniel Veillard7c4eb632004-04-19 21:29:12 +0000[diff] [blame]97 <li>SAX: a SAX2 like interface and a minimal SAX1 implementation compatible
98 with early expat versions</li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]99</ul>
100
Daniel Veillardf83a2c72003-04-08 13:48:40 +0000[diff] [blame]101<p>A partial implementation of <a
102href="http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/">XML Schemas Part
1031: Structure</a> is being worked on but it would be far too early to make any
104conformance statement about it at the moment.</p>
Daniel Veillarde6d8e202002-05-02 06:11:10 +0000[diff] [blame]105
Daniel Veillard96984452000-08-31 13:50:12 +0000[diff] [blame]106<p>Separate documents:</p>
107<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]108 <li><a href="http://xmlsoft.org/XSLT/">the libxslt page</a> providing an
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]109 implementation of XSLT 1.0 and common extensions like EXSLT for
110 libxml2</li>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]111 <li><a href="http://www.cs.unibo.it/~casarini/gdome2/">the gdome2 page</a>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]112 : a standard DOM2 implementation for libxml2</li>
113 <li><a href="http://www.aleksey.com/xmlsec/">the XMLSec page</a>: an
114 implementation of <a href="http://www.w3.org/TR/xmldsig-core/">W3C XML
115 Digital Signature</a> for libxml2</li>
Daniel Veillarde6d8e202002-05-02 06:11:10 +0000[diff] [blame]116 <li>also check the related links section below for more related and active
117 projects.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]118</ul>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]119<!----------------<p>Results of the <a
Daniel Veillard806cada2003-03-19 21:58:59 +0000[diff] [blame]120href="http://xmlbench.sourceforge.net/results/benchmark/index.html">xmlbench
Daniel Veillard31ae4622004-02-16 07:45:44 +0000[diff] [blame]121benchmark</a> on sourceforge February 2004 (smaller is better):</p>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]122
Daniel Veillard31ae4622004-02-16 07:45:44 +0000[diff] [blame]123<p align="center"><img src="benchmark.png"
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]124alt="benchmark results for Expat Xerces libxml2 Oracle and Sun toolkits"></p>
Daniel Veillardcf80b782004-03-07 19:32:19 +0000[diff] [blame]125-------------->
Daniel Veillard806cada2003-03-19 21:58:59 +0000[diff] [blame]126
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]127
Daniel Veillarde1662542002-08-28 11:50:59 +0000[diff] [blame]128<p>Logo designed by <a href="mailto:liyanage@access.ch">Marc Liyanage</a>.</p>
129
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]130<h2><a name="Introducti">Introduction</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]131
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]132<p>This document describes libxml, the <a
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]133href="http://www.w3.org/XML/">XML</a> C parser and toolkit developed for the
134<a href="http://www.gnome.org/">Gnome</a> project. <a
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]135href="http://www.w3.org/XML/">XML is a standard</a> for building tag-based
136structured documents/data.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]137
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]138<p>Here are some key points about libxml:</p>
139<ul>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]140 <li>Libxml2 exports Push (progressive) and Pull (blocking) type parser
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]141 interfaces for both XML and HTML.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]142 <li>Libxml2 can do DTD validation at parse time, using a parsed document
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]143 instance, or with an arbitrary DTD.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]144 <li>Libxml2 includes complete <a
Daniel Veillard8c2ecaf2001-07-10 17:53:07 +0000[diff] [blame]145 href="http://www.w3.org/TR/xpath">XPath</a>, <a
146 href="http://www.w3.org/TR/xptr">XPointer</a> and <a
147 href="http://www.w3.org/TR/xinclude">XInclude</a> implementations.</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]148 <li>It is written in plain C, making as few assumptions as possible, and
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]149 sticking closely to ANSI C/POSIX for easy embedding. Works on
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]150 Linux/Unix/Windows, ported to a number of other platforms.</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]151 <li>Basic support for HTTP and FTP client allowing applications to fetch
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]152 remote resources.</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]153 <li>The design is modular, most of the extensions can be compiled out.</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]154 <li>The internal document representation is as close as possible to the <a
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]155 href="http://www.w3.org/DOM/">DOM</a> interfaces.</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]156 <li>Libxml2 also has a <a
157 href="http://www.megginson.com/SAX/index.html">SAX like interface</a>;
158 the interface is designed to be compatible with <a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]159 href="http://www.jclark.com/xml/expat.html">Expat</a>.</li>
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]160 <li>This library is released under the <a
161 href="http://www.opensource.org/licenses/mit-license.html">MIT
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]162 License</a>. See the Copyright file in the distribution for the precise
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]163 wording.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]164</ul>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]165
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000[diff] [blame]166<p>Warning: unless you are forced to because your application links with a
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]167Gnome-1.X library requiring it, <strong><span
Daniel Veillarde0c1d722001-03-21 10:28:36 +0000[diff] [blame]168style="background-color: #FF0000">Do Not Use libxml1</span></strong>, use
169libxml2</p>
170
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]171<h2><a name="FAQ">FAQ</a></h2>
172
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]173<p>Table of Contents:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]174<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]175 <li><a href="FAQ.html#License">License(s)</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]176 <li><a href="FAQ.html#Installati">Installation</a></li>
177 <li><a href="FAQ.html#Compilatio">Compilation</a></li>
178 <li><a href="FAQ.html#Developer">Developer corner</a></li>
179</ul>
180
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]181<h3><a name="License">License</a>(s)</h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]182<ol>
183 <li><em>Licensing Terms for libxml</em>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]184 <p>libxml2 is released under the <a
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]185 href="http://www.opensource.org/licenses/mit-license.html">MIT
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]186 License</a>; see the file Copyright in the distribution for the precise
Daniel Veillardc575b992002-02-08 13:28:40 +0000[diff] [blame]187 wording</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]188 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]189 <li><em>Can I embed libxml2 in a proprietary application ?</em>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]190 <p>Yes. The MIT License allows you to keep proprietary the changes you
191 made to libxml, but it would be graceful to send-back bug fixes and
192 improvements as patches for possible incorporation in the main
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]193 development tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]194 </li>
195</ol>
196
197<h3><a name="Installati">Installation</a></h3>
198<ol>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]199 <li><strong><span style="background-color: #FF0000">Do Not Use
200 libxml1</span></strong>, use libxml2</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]201 <li><em>Where can I get libxml</em> ?
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]202 <p>The original distribution comes from <a
203 href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> or <a
Daniel Veillard024f1992003-12-10 16:43:49 +0000[diff] [blame]204 href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">gnome.org</a></p>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]205 <p>Most Linux and BSD distributions include libxml, this is probably the
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]206 safer way for end-users to use libxml.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]207 <p>David Doolin provides precompiled Windows versions at <a
208 href="http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/ ">http://www.ce.berkeley.edu/~doolin/code/libxmlwin32/</a></p>
209 </li>
210 <li><em>I see libxml and libxml2 releases, which one should I install ?</em>
211 <ul>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]212 <li>If you are not constrained by backward compatibility issues with
213 existing applications, install libxml2 only</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]214 <li>If you are not doing development, you can safely install both.
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]215 Usually the packages <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]216 href="http://rpmfind.net/linux/RPM/libxml.html">libxml</a> and <a
217 href="http://rpmfind.net/linux/RPM/libxml2.html">libxml2</a> are
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]218 compatible (this is not the case for development packages).</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]219 <li>If you are a developer and your system provides separate packaging
220 for shared libraries and the development components, it is possible
221 to install libxml and libxml2, and also <a
222 href="http://rpmfind.net/linux/RPM/libxml-devel.html">libxml-devel</a>
223 and <a
224 href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml2-devel</a>
225 too for libxml2 &gt;= 2.3.0</li>
226 <li>If you are developing a new application, please develop against
227 libxml2(-devel)</li>
228 </ul>
229 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]230 <li><em>I can't install the libxml package, it conflicts with libxml0</em>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]231 <p>You probably have an old libxml0 package used to provide the shared
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]232 library for libxml.so.0, you can probably safely remove it. The libxml
233 packages provided on <a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]234 href="ftp://rpmfind.net/pub/libxml/">rpmfind.net</a> provide
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]235 libxml.so.0</p>
236 </li>
237 <li><em>I can't install the libxml(2) RPM package due to failed
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]238 dependencies</em>
239 <p>The most generic solution is to re-fetch the latest src.rpm , and
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]240 rebuild it locally with</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]241 <p><code>rpm --rebuild libxml(2)-xxx.src.rpm</code>.</p>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]242 <p>If everything goes well it will generate two binary rpm packages (one
243 providing the shared libs and xmllint, and the other one, the -devel
244 package, providing includes, static libraries and scripts needed to build
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]245 applications with libxml(2)) that you can install locally.</p>
246 </li>
247</ol>
248
249<h3><a name="Compilatio">Compilation</a></h3>
250<ol>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]251 <li><em>What is the process to compile libxml2 ?</em>
252 <p>As most UNIX libraries libxml2 follows the "standard":</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]253 <p><code>gunzip -c xxx.tar.gz | tar xvf -</code></p>
254 <p><code>cd libxml-xxxx</code></p>
255 <p><code>./configure --help</code></p>
256 <p>to see the options, then the compilation/installation proper</p>
257 <p><code>./configure [possible options]</code></p>
258 <p><code>make</code></p>
259 <p><code>make install</code></p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]260 <p>At that point you may have to rerun ldconfig or a similar utility to
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]261 update your list of installed shared libs.</p>
262 </li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]263 <li><em>What other libraries are needed to compile/install libxml2 ?</em>
264 <p>Libxml2 does not require any other library, the normal C ANSI API
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]265 should be sufficient (please report any violation to this rule you may
266 find).</p>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]267 <p>However if found at configuration time libxml2 will detect and use the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]268 following libs:</p>
269 <ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]270 <li><a href="http://www.info-zip.org/pub/infozip/zlib/">libz</a> : a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]271 highly portable and available widely compression library.</li>
272 <li>iconv: a powerful character encoding conversion library. It is
273 included by default in recent glibc libraries, so it doesn't need to
274 be installed specifically on Linux. It now seems a <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]275 href="http://www.opennc.org/onlinepubs/7908799/xsh/iconv.html">part
276 of the official UNIX</a> specification. Here is one <a
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]277 href="http://www.gnu.org/software/libiconv/">implementation of the
278 library</a> which source can be found <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]279 href="ftp://ftp.ilog.fr/pub/Users/haible/gnu/">here</a>.</li>
280 </ul>
281 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]282 <li><em>Make check fails on some platforms</em>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]283 <p>Sometimes the regression tests' results don't completely match the
284 value produced by the parser, and the makefile uses diff to print the
285 delta. On some platforms the diff return breaks the compilation process;
286 if the diff is small this is probably not a serious problem.</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]287 <p>Sometimes (especially on Solaris) make checks fail due to limitations
Daniel Veillarde46182c2002-02-12 14:29:11 +0000[diff] [blame]288 in make. Try using GNU-make instead.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]289 </li>
290 <li><em>I use the CVS version and there is no configure script</em>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]291 <p>The configure script (and other Makefiles) are generated. Use the
292 autogen.sh script to regenerate the configure script and Makefiles,
293 like:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]294 <p><code>./autogen.sh --prefix=/usr --disable-shared</code></p>
295 </li>
296 <li><em>I have troubles when running make tests with gcc-3.0</em>
297 <p>It seems the initial release of gcc-3.0 has a problem with the
298 optimizer which miscompiles the URI module. Please use another
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]299 compiler.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]300 </li>
301</ol>
302
303<h3><a name="Developer">Developer</a> corner</h3>
304<ol>
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]305 <li><em>Troubles compiling or linking programs using libxml2</em>
306 <p>Usually the problem comes from the fact that the compiler doesn't get
307 the right compilation or linking flags. There is a small shell script
308 <code>xml2-config</code> which is installed as part of libxml2 usual
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]309 install process which provides those flags. Use</p>
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]310 <p><code>xml2-config --cflags</code></p>
311 <p>to get the compilation flags and</p>
312 <p><code>xml2-config --libs</code></p>
313 <p>to get the linker flags. Usually this is done directly from the
314 Makefile as:</p>
315 <p><code>CFLAGS=`xml2-config --cflags`</code></p>
316 <p><code>LIBS=`xml2-config --libs`</code></p>
317 </li>
William M. Brack99906ad2005-01-09 17:02:42 +0000[diff] [blame]318 <li><em>I want to install my own copy of libxml2 in my home directory and link
319 my programs against it, but it doesn't work</em>
320 <p>There are many different ways to accomplish this. Here is one way to
321 do this under Linux. Suppose your home directory is <code>/home/user.
322 </code>Then:</p>
323 <ul><li>Create a subdirectory, let's call it <code>myxml</code></li>
324 <li>unpack the libxml2 distribution into that subdirectory</li>
325 <li>chdir into the unpacked distribution (<code>/home/user/myxml/libxml2
326 </code>)</li>
327 <li>configure the library using the "<code>--prefix</code>" switch,
328 specifying an installation subdirectory in <code>/home/user/myxml</code>,
329 e.g.
330 <p><code>./configure --prefix /home/user/myxml/xmlinst</code> {other
331 configuration options}</p></li>
332 <li>now run <code>make</code> followed by <code>make install</code></li>
333 <li>At this point, the installation subdirectory contains the complete
334 "private" include files, library files and binary program files (e.g.
335 xmllint), located in
336 <p> <code>/home/user/myxml/xmlinst/lib, /home/user/myxml/xmlinst/include
337 </code> and <code> /home/user/myxml/xmlinst/bin</code></p>
338 respectively.</li>
339 <li>In order to use this "private" library, you should first add it
340 to the beginning of your default PATH (so that your own private
341 program files such as xmllint will be used instead of the normal
342 system ones). To do this, the Bash command would be
343 <p><code>export PATH=/home/user/myxml/xmlinst/bin:$PATH</code></p></li>
344 <li>Now suppose you have a program <code>test1.c</code> that you would
345 like to compile with your "private" library. Simply compile it
346 using the command <p><code>gcc `xml2-config --cflags --libs` -o test
347 test.c</code></p> Note that, because your PATH has been set with <code>
348 /home/user/myxml/xmlinst/bin</code> at the beginning, the
349 xml2-config program which you just installed will be used instead of
350 the system default one, and this will <em>automatically</em> get the
351 correct libraries linked with your program.</li></ul>
352 </li><p/>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]353 <li><em>xmlDocDump() generates output on one line.</em>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]354 <p>Libxml2 will not <strong>invent</strong> spaces in the content of a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]355 document since <strong>all spaces in the content of a document are
356 significant</strong>. If you build a tree from the API and want
357 indentation:</p>
358 <ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]359 <li>the correct way is to generate those yourself too.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]360 <li>the dangerous way is to ask libxml2 to add those blanks to your
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]361 content <strong>modifying the content of your document in the
362 process</strong>. The result may not be what you expect. There is
363 <strong>NO</strong> way to guarantee that such a modification won't
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]364 affect other parts of the content of your document. See <a
Daniel Veillard5373ea12003-07-24 13:09:13 +0000[diff] [blame]365 href="http://xmlsoft.org/html/libxml-parser.html#xmlKeepBlanksDefault">xmlKeepBlanksDefault
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]366 ()</a> and <a
Daniel Veillard5373ea12003-07-24 13:09:13 +0000[diff] [blame]367 href="http://xmlsoft.org/html/libxml-tree.html#xmlSaveFormatFile">xmlSaveFormatFile
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]368 ()</a></li>
369 </ol>
370 </li>
371 <li>Extra nodes in the document:
372 <p><em>For a XML file as below:</em></p>
373 <pre>&lt;?xml version="1.0"?&gt;
374&lt;PLAN xmlns="http://www.argus.ca/autotest/1.0/"&gt;
375&lt;NODE CommFlag="0"/&gt;
376&lt;NODE CommFlag="1"/&gt;
377&lt;/PLAN&gt;</pre>
378 <p><em>after parsing it with the function
379 pxmlDoc=xmlParseFile(...);</em></p>
380 <p><em>I want to the get the content of the first node (node with the
381 CommFlag="0")</em></p>
382 <p><em>so I did it as following;</em></p>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]383 <pre>xmlNodePtr pnode;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]384pnode=pxmlDoc-&gt;children-&gt;children;</pre>
385 <p><em>but it does not work. If I change it to</em></p>
386 <pre>pnode=pxmlDoc-&gt;children-&gt;children-&gt;next;</pre>
387 <p><em>then it works. Can someone explain it to me.</em></p>
388 <p></p>
389 <p>In XML all characters in the content of the document are significant
390 <strong>including blanks and formatting line breaks</strong>.</p>
391 <p>The extra nodes you are wondering about are just that, text nodes with
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]392 the formatting spaces which are part of the document but that people tend
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]393 to forget. There is a function <a
394 href="http://xmlsoft.org/html/libxml-parser.html">xmlKeepBlanksDefault
395 ()</a> to remove those at parse time, but that's an heuristic, and its
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]396 use should be limited to cases where you are certain there is no
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]397 mixed-content in the document.</p>
398 </li>
399 <li><em>I get compilation errors of existing code like when accessing
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]400 <strong>root</strong> or <strong>child fields</strong> of nodes.</em>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]401 <p>You are compiling code developed for libxml version 1 and using a
402 libxml2 development environment. Either switch back to libxml v1 devel or
403 even better fix the code to compile with libxml2 (or both) by <a
404 href="upgrade.html">following the instructions</a>.</p>
405 </li>
406 <li><em>I get compilation errors about non existing
407 <strong>xmlRootNode</strong> or <strong>xmlChildrenNode</strong>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]408 fields.</em>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]409 <p>The source code you are using has been <a
410 href="upgrade.html">upgraded</a> to be able to compile with both libxml
411 and libxml2, but you need to install a more recent version:
412 libxml(-devel) &gt;= 1.8.8 or libxml2(-devel) &gt;= 2.1.0</p>
413 </li>
414 <li><em>XPath implementation looks seriously broken</em>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]415 <p>XPath implementation prior to 2.3.0 was really incomplete. Upgrade to
416 a recent version, there are no known bugs in the current version.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]417 </li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]418 <li><em>The example provided in the web page does not compile.</em>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]419 <p>It's hard to maintain the documentation in sync with the code
420 &lt;grin/&gt; ...</p>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]421 <p>Check the previous points 1/ and 2/ raised before, and please send
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]422 patches.</p>
423 </li>
Daniel Veillard8d7b5c72003-11-15 18:24:36 +0000[diff] [blame]424 <li><em>Where can I get more examples and information than provided on the
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]425 web page?</em>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]426 <p>Ideally a libxml2 book would be nice. I have no such plan ... But you
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]427 can:</p>
428 <ul>
429 <li>check more deeply the <a href="html/libxml-lib.html">existing
430 generated doc</a></li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]431 <li>have a look at <a href="examples/index.html">the set of
432 examples</a>.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]433 <li>look for examples of use for libxml2 function using the Gnome code.
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]434 For example the following will query the full Gnome CVS base for the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]435 use of the <strong>xmlAddChild()</strong> function:
436 <p><a
437 href="http://cvs.gnome.org/lxr/search?string=xmlAddChild">http://cvs.gnome.org/lxr/search?string=xmlAddChild</a></p>
438 <p>This may be slow, a large hardware donation to the gnome project
439 could cure this :-)</p>
440 </li>
441 <li><a
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]442 href="http://cvs.gnome.org/bonsai/rview.cgi?cvsroot=/cvs/gnome&amp;dir=gnome-xml">Browse
443 the libxml2 source</a> , I try to write code as clean and documented
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]444 as possible, so looking at it may be helpful. In particular the code
445 of xmllint.c and of the various testXXX.c test programs should
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>
449 <li>What about C++ ?
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]450 <p>libxml2 is written in pure C in order to allow easy reuse on a number
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]451 of platforms, including embedded systems. I don't intend to convert to
452 C++.</p>
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]453 <p>There is however a C++ wrapper which may fulfill your needs:</p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]454 <ul>
455 <li>by Ari Johnson &lt;ari@btigate.com&gt;:
456 <p>Website: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]457 href="http://libxmlplusplus.sourceforge.net/">http://libxmlplusplus.sourceforge.net/</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]458 <p>Download: <a
Daniel Veillard91e69c52003-08-04 01:43:07 +0000[diff] [blame]459 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]460 </li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]461 <!-- Website is currently unavailable as of 2003-08-02
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]462 <li>by Peter Jones &lt;pjones@pmade.org&gt;
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]463 <p>Website: <a
464 href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]465 </li>
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]466 -->
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]467 </ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]468 </li>
469 <li>How to validate a document a posteriori ?
470 <p>It is possible to validate documents which had not been validated at
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]471 initial parsing time or documents which have been built from scratch
472 using the API. Use the <a
Daniel Veillard5373ea12003-07-24 13:09:13 +0000[diff] [blame]473 href="http://xmlsoft.org/html/libxml-valid.html#xmlValidateDtd">xmlValidateDtd()</a>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]474 function. It is also possible to simply add a DTD to an existing
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]475 document:</p>
476 <pre>xmlDocPtr doc; /* your existing document */
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]477xmlDtdPtr dtd = xmlParseDTD(NULL, filename_of_dtd); /* parse the DTD */
478
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]479 dtd-&gt;name = xmlStrDup((xmlChar*)"root_name"); /* use the given root */
480
481 doc-&gt;intSubset = dtd;
482 if (doc-&gt;children == NULL) xmlAddChild((xmlNodePtr)doc, (xmlNodePtr)dtd);
483 else xmlAddPrevSibling(doc-&gt;children, (xmlNodePtr)dtd);
484 </pre>
485 </li>
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]486 <li>So what is this funky "xmlChar" used all the time?
487 <p>It is a null terminated sequence of utf-8 characters. And only utf-8!
488 You need to convert strings encoded in different ways to utf-8 before
489 passing them to the API. This can be accomplished with the iconv library
490 for instance.</p>
John Fleck61f6fb62002-10-31 15:23:29 +0000[diff] [blame]491 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]492 <li>etc ...</li>
493</ol>
494
495<p></p>
496
Daniel Veillard66f68e72003-08-18 16:39:51 +0000[diff] [blame]497<h2><a name="Documentat">Developer Menu</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]498
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]499<p>There are several on-line resources related to using libxml:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]500<ol>
MST 2003 John Fleck2b7142a2003-11-22 03:55:27 +0000[diff] [blame]501 <li>Use the <a href="search.php">search engine</a> to look up
502 information.</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]503 <li>Check the <a href="FAQ.html">FAQ.</a></li>
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]504 <li>Check the <a href="http://xmlsoft.org/html/libxml-lib.html">extensive
MST 2003 John Fleck2b7142a2003-11-22 03:55:27 +0000[diff] [blame]505 documentation</a> automatically extracted from code comments.</li>
Daniel Veillard8d869642000-07-14 12:12:59 +0000[diff] [blame]506 <li>Look at the documentation about <a href="encoding.html">libxml
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]507 internationalization support</a>.</li>
Daniel Veillardbc66f852002-01-14 09:49:20 +0000[diff] [blame]508 <li>This page provides a global overview and <a href="example.html">some
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]509 examples</a> on how to use libxml.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]510 <li><a href="examples/index.html">Code examples</a></li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]511 <li>John Fleck's libxml2 tutorial: <a href="tutorial/index.html">html</a>
512 or <a href="tutorial/xmltutorial.pdf">pdf</a>.</li>
Daniel Veillard1177ca42003-04-26 22:29:54 +0000[diff] [blame]513 <li>If you need to parse large files, check the <a
514 href="xmlreader.html">xmlReader</a> API tutorial</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]515 <li><a href="mailto:james@daa.com.au">James Henstridge</a> wrote <a
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]516 href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">some nice
517 documentation</a> explaining how to use the libxml SAX interface.</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]518 <li>George Lebl wrote <a
MST 2003 John Fleck2b7142a2003-11-22 03:55:27 +0000[diff] [blame]519 href="http://www-106.ibm.com/developerworks/library/l-gnome3/">an article
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]520 for IBM developerWorks</a> about using libxml.</li>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]521 <li>Check <a href="http://cvs.gnome.org/lxr/source/gnome-xml/TODO">the TODO
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]522 file</a>.</li>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]523 <li>Read the <a href="upgrade.html">1.x to 2.x upgrade path</a>
524 description. If you are starting a new project using libxml you should
525 really use the 2.x version.</li>
Daniel Veillard845cce42002-01-09 11:51:37 +0000[diff] [blame]526 <li>And don't forget to look at the <a
527 href="http://mail.gnome.org/archives/xml/">mailing-list archive</a>.</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]528</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]529
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]530<h2><a name="Reporting">Reporting bugs and getting help</a></h2>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]531
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]532<p>Well, bugs or missing features are always possible, and I will make a
533point of fixing them in a timely fashion. The best way to report a bug is to
Daniel Veillardccf996f2003-08-14 10:48:38 +0000[diff] [blame]534use the <a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]535bug tracking database</a> (make sure to use the "libxml2" module name). I
536look at reports there regularly and it's good to have a reminder when a bug
537is 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]538
Daniel Veillard4ac494b2003-09-18 15:08:00 +0000[diff] [blame]539<p>For small problems you can try to get help on IRC, the #xml channel on
540irc.gnome.org (port 6667) usually have a few person subscribed which may help
541(but there is no garantee and if a real issue is raised it should go on the
542mailing-list for archival).</p>
Daniel Veillard9582d6c2003-09-16 11:40:04 +0000[diff] [blame]543
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]544<p>There is also a mailing-list <a
Daniel Veillard3197f162001-04-04 00:40:08 +0000[diff] [blame]545href="mailto:xml@gnome.org">xml@gnome.org</a> for libxml, with an <a
546href="http://mail.gnome.org/archives/xml/">on-line archive</a> (<a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]547href="http://xmlsoft.org/messages">old</a>). To subscribe to this list,
548please visit the <a
549href="http://mail.gnome.org/mailman/listinfo/xml">associated Web</a> page and
550follow the instructions. <strong>Do not send code, I won't debug it</strong>
551(but patches are really appreciated!).</p>
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]552
553<p>Please note that with the current amount of virus and SPAM, sending mail
554to the list without being subscribed won't work. There is *far too many
555bounces* (in the order of a thousand a day !) I cannot approve them manually
556anymore. If your mail to the list bounced waiting for administrator approval,
557it is LOST ! Repost it and fix the problem triggering the error.</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]558
Daniel Veillard008186f2001-09-13 14:24:44 +0000[diff] [blame]559<p>Check the following <strong><span style="color: #FF0000">before
560posting</span></strong>:</p>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]561<ul>
Daniel Veillard321be0c2002-10-08 21:26:42 +0000[diff] [blame]562 <li>Read the <a href="FAQ.html">FAQ</a> and <a href="search.php">use the
Daniel Veillarda37aab82003-06-09 09:10:36 +0000[diff] [blame]563 search engine</a> to get information related to your problem.</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]564 <li>Make sure you are <a href="ftp://xmlsoft.org/">using a recent
565 version</a>, and that the problem still shows up in a recent version.</li>
566 <li>Check the <a href="http://mail.gnome.org/archives/xml/">list
567 archives</a> to see if the problem was reported already. In this case
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]568 there is probably a fix available, similarly check the <a
Daniel Veillardccf996f2003-08-14 10:48:38 +0000[diff] [blame]569 href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">registered
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]570 open bugs</a>.</li>
571 <li>Make sure you can reproduce the bug with xmllint or one of the test
572 programs found in source in the distribution.</li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]573 <li>Please send the command showing the error as well as the input (as an
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]574 attachment)</li>
Daniel Veillard234547b2001-07-05 09:46:10 +0000[diff] [blame]575</ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]576
Daniel Veillarda37aab82003-06-09 09:10:36 +0000[diff] [blame]577<p>Then send the bug with associated information to reproduce it to the <a
Daniel Veillard33a67802001-03-07 09:44:02 +0000[diff] [blame]578href="mailto:xml@gnome.org">xml@gnome.org</a> list; if it's really libxml
Daniel Veillard98d071d2003-01-10 09:22:44 +0000[diff] [blame]579related I will approve it. Please do not send mail to me directly, it makes
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]580things really hard to track and in some cases I am not the best person to
Daniel Veillard98d071d2003-01-10 09:22:44 +0000[diff] [blame]581answer a given question, ask on the list.</p>
582
583<p>To <span style="color: #E50000">be really clear about support</span>:</p>
584<ul>
Daniel Veillarda37aab82003-06-09 09:10:36 +0000[diff] [blame]585 <li>Support or help <span style="color: #E50000">requests MUST be sent to
Daniel Veillard98d071d2003-01-10 09:22:44 +0000[diff] [blame]586 the list or on bugzilla</span> in case of problems, so that the Question
587 and Answers can be shared publicly. Failing to do so carries the implicit
588 message "I want free support but I don't want to share the benefits with
Daniel Veillard831e8fd2003-01-25 11:45:34 +0000[diff] [blame]589 others" and is not welcome. I will automatically Carbon-Copy the
590 xml@gnome.org mailing list for any technical reply made about libxml2 or
591 libxslt.</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]592 <li>There is <span style="color: #E50000">no garantee of support</span>, if
593 your question remains unanswered after a week, repost it, making sure you
594 gave all the detail needed and the information requested.</li>
Daniel Veillarda37aab82003-06-09 09:10:36 +0000[diff] [blame]595 <li>Failing to provide information as requested or double checking first
Daniel Veillard98d071d2003-01-10 09:22:44 +0000[diff] [blame]596 for prior feedback also carries the implicit message "the time of the
597 library maintainers is less valuable than my time" and might not be
598 welcome.</li>
599</ul>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]600
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]601<p>Of course, bugs reported with a suggested patch for fixing them will
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]602probably be processed faster than those without.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]603
604<p>If you're looking for help, a quick look at <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]605href="http://mail.gnome.org/archives/xml/">the list archive</a> may actually
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]606provide the answer. I usually send source samples when answering libxml2
607usage questions. The <a
608href="http://xmlsoft.org/html/book1.html">auto-generated documentation</a> is
609not as polished as I would like (i need to learn more about DocBook), but
610it's a good starting point.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]611
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]612<h2><a name="help">How to help</a></h2>
613
614<p>You can help the project in various ways, the best thing to do first is to
615subscribe to the mailing-list as explained before, check the <a
Daniel Veillardf7ed3362001-08-17 12:01:21 +0000[diff] [blame]616href="http://mail.gnome.org/archives/xml/">archives </a>and the <a
Daniel Veillardccf996f2003-08-14 10:48:38 +0000[diff] [blame]617href="http://bugzilla.gnome.org/buglist.cgi?product=libxml2">Gnome bug
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]618database</a>:</p>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]619<ol>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]620 <li>Provide patches when you find problems.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]621 <li>Provide the diffs when you port libxml2 to a new platform. They may not
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]622 be integrated in all cases but help pinpointing portability problems
623 and</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]624 <li>Provide documentation fixes (either as patches to the code comments or
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]625 as HTML diffs).</li>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]626 <li>Provide new documentations pieces (translations, examples, etc
627 ...).</li>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]628 <li>Check the TODO file and try to close one of the items.</li>
629 <li>Take one of the points raised in the archive or the bug database and
Daniel Veillarde7ead2d2001-08-22 23:44:09 +0000[diff] [blame]630 provide a fix. <a href="mailto:daniel@veillard.com">Get in touch with me
631 </a>before to avoid synchronization problems and check that the suggested
632 fix will fit in nicely :-)</li>
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]633</ol>
634
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]635<h2><a name="Downloads">Downloads</a></h2>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]636
Daniel Veillard688f6692004-03-26 10:57:38 +0000[diff] [blame]637<p>The latest versions of libxml2 can be found on the <a
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]638href="ftp://xmlsoft.org/">xmlsoft.org</a> server ( <a
639href="http://xmlsoft.org/sources/">HTTP</a>, <a
640href="ftp://xmlsoft.org/">FTP</a> and rsync are available), there is also
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]641mirrors (<a href="ftp://ftp.planetmirror.com/pub/xmlsoft/">Australia</a>( <a
642href="http://xmlsoft.planetmirror.com/">Web</a>), <a
Daniel Veillard20c8cf22001-06-26 22:47:36 +0000[diff] [blame]643href="ftp://fr.rpmfind.net/pub/libxml/">France</a>) or on the <a
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]644href="ftp://ftp.gnome.org/pub/GNOME/MIRRORS.html">Gnome FTP server</a> as <a
645href="ftp://ftp.gnome.org/pub/GNOME/sources/libxml2/2.6/">source archive</a>
Daniel Veillard688f6692004-03-26 10:57:38 +0000[diff] [blame]646, Antonin Sprinzl also provide <a href="ftp://gd.tuwien.ac.at/pub/libxml/">a
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]647mirror in Austria</a>. (NOTE that you need both the <a
Daniel Veillardc19fccc2000-07-03 11:52:01 +0000[diff] [blame]648href="http://rpmfind.net/linux/RPM/libxml2.html">libxml(2)</a> and <a
649href="http://rpmfind.net/linux/RPM/libxml2-devel.html">libxml(2)-devel</a>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000[diff] [blame]650packages installed to compile applications using libxml.)</p>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]651
652<p>You can find all the history of libxml(2) and libxslt releases in the <a
Daniel Veillardd4cfcef2004-05-06 18:55:27 +0000[diff] [blame]653href="http://xmlsoft.org/sources/old/">old</a> directory. The precompiled
Daniel Veillardf81a8e82004-08-03 21:58:41 +0000[diff] [blame]654Windows binaries made by Igor Zlatovic are available in the <a
655href="http://xmlsoft.org/sources/win32/">win32</a> directory.</p>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000[diff] [blame]656
657<p>Binary ports:</p>
658<ul>
659 <li>Red Hat RPMs for i386 are available directly on <a
660 href="ftp://xmlsoft.org/">xmlsoft.org</a>, the source RPM will compile on
661 any architecture supported by Red Hat.</li>
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]662 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
663 maintainer of the Windows port, <a
Daniel Veillardb46a5732003-04-08 13:35:48 +0000[diff] [blame]664 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
Daniel Veillardb11f5b92004-08-03 22:09:36 +0000[diff] [blame]665 binaries</a>.</li>
MST 2004 John Fleckb759b302004-12-21 15:14:08 +0000[diff] [blame]666 <li>Blastwave provides
667 <a href="http://www.blastwave.org/packages.php/libxml2">Solaris binaries</a>.</li>
Daniel Veillardb46a5732003-04-08 13:35:48 +0000[diff] [blame]668 <li><a href="mailto:Steve.Ball@zveno.com">Steve Ball</a> provides <a
669 href="http://www.zveno.com/open_source/libxml2xslt.html">Mac Os X
670 binaries</a>.</li>
671 <li>The HP-UX porting center provides <a
672 href="http://hpux.connect.org.uk/hppd/hpux/Gnome/">HP-UX binaries</a></li>
673</ul>
674
675<p>If you know other supported binary ports, please <a
676href="http://veillard.com/">contact me</a>.</p>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]677
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]678<p><a name="Snapshot">Snapshot:</a></p>
679<ul>
Daniel Veillard3cef1192004-08-18 09:30:31 +0000[diff] [blame]680 <li>Code from the W3C cvs base libxml2 module, updated hourly <a
Daniel Veillardfc263f12004-08-31 07:02:04 +0000[diff] [blame]681 href="ftp://xmlsoft.org/libxml2-cvs-snapshot.tar.gz">libxml2-cvs-snapshot.tar.gz</a>.</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]682 <li>Docs, content of the web site, the list archive included <a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]683 href="ftp://xmlsoft.org/libxml-docs.tar.gz">libxml-docs.tar.gz</a>.</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]684</ul>
685
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]686<p><a name="Contribs">Contributions:</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]687
688<p>I do accept external contributions, especially if compiling on another
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]689platform, get in touch with the list to upload the package, wrappers for
690various languages have been provided, and can be found in the <a
691href="python.html">bindings section</a></p>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]692
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]693<p>Libxml2 is also available from CVS:</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]694<ul>
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]695 <li><p>The <a href="http://cvs.gnome.org/viewcvs/libxml2/">Gnome CVS
696 base</a>. Check the <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]697 href="http://developer.gnome.org/tools/cvs.html">Gnome CVS Tools</a>
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]698 page; the CVS module is <b>libxml2</b>.</p>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]699 </li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]700 <li>The <strong>libxslt</strong> module is also present there</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]701</ul>
702
Daniel Veillard78fed532004-10-09 19:44:48 +0000[diff] [blame]703<h2><a name="News">Releases</a></h2>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]704
Daniel Veillarde6d8e202002-05-02 06:11:10 +0000[diff] [blame]705<p>Items not finished and worked on, get in touch with the list if you want
Daniel Veillard688f6692004-03-26 10:57:38 +0000[diff] [blame]706to help those</p>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]707<ul>
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]708 <li>More testing on RelaxNG</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]709 <li>Finishing up <a href="http://www.w3.org/TR/xmlschema-1/">XML
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]710 Schemas</a></li>
711</ul>
712
Daniel Veillard2d908032004-08-10 10:16:36 +0000[diff] [blame]713<p>The <a href="ChangeLog.html">change log</a> describes the recents commits
714to the <a href="http://cvs.gnome.org/viewcvs/libxml2/">CVS</a> code base.</p>
715
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]716<p>There is the list of public releases:</p>
717
Daniel Veillard298d9642005-01-16 20:01:55 +0000[diff] [blame]718<h3>2.6.17: Jan 16 2005</h3>
719<ul>
720 <li>build fixes: Windows, warnings removal (William Brack),
721 maintainer-clean dependency(William), build in a different directory
722 (William), fixing --with-minimum configure build (William), BeOS
723 build (Marcin Konicki), Python-2.4 detection (William), compilation
724 on AIX (Dan McNichol)</li>
725 <li>bug fixes: xmlTextReaderHasAttributes (Rob Richards), xmlCtxtReadFile()
726 to use the catalog(s), loop on output (William Brack), XPath memory leak,
727 ID deallocation problem (Steve Shepard), debugDumpNode crash (William),
728 warning not using error callback (William), xmlStopParser bug (William),
729 UTF-16 with BOM on DTDs (William), namespace bug on empty elements
730 in push mode (Rob Richards), line and col computations fixups (Aleksey
731 Sanin), xmlURIEscape fix (William), xmlXPathErr on bad range (William),
732 patterns with too many steps, bug in RNG choice optimization, line
733 number sometimes missing.
734 </li>
735 <li>improvements: XSD Schemas (Kasimier Buchcik), python generator (William),
736 xmlUTF8Strpos speedup (William), unicode Python strings (William),
737 XSD error reports (Kasimier Buchcik), Python __str__ call serialize().
738 </li>
739 <li>new APIs: added xmlDictExists(), GetLineNumber and GetColumnNumber
740 for the xmlReader (Aleksey Sanin), Dynamic Shared Libraries APIs
741 (mostly Joel Reed), error extraction API from regexps, new XMLSave
742 option for format (Phil Shafer)</li>
743 <li>documentation: site improvement (John Fleck), FAQ entries (William).</li>
744</ul>
745
Daniel Veillardc3d7cb42004-11-10 14:34:45 +0000[diff] [blame]746<h3>2.6.16: Nov 10 2004</h3>
747<ul>
748 <li>general hardening and bug fixing crossing all the API based on new
749 automated regression testing</li>
750 <li>build fix: IPv6 build and test on AIX (Dodji Seketeli)</li>
751 <li>bug fixes: problem with XML::Libxml reported by Petr Pajas, encoding
752 conversion functions return values, UTF-8 bug affecting XPath reported by
753 Markus Bertheau, catalog problem with NULL entries (William Brack)</li>
754 <li>documentation: fix to xmllint man page, some API function descritpion
755 were updated.</li>
756 <li>improvements: DTD validation APIs provided at the Python level (Brent
757 Hendricks) </li>
758</ul>
759
Daniel Veillardc2f83d12004-10-27 22:59:21 +0000[diff] [blame]760<h3>2.6.15: Oct 27 2004</h3>
Daniel Veillard6927b102004-10-27 17:29:04 +0000[diff] [blame]761<ul>
762 <li>security fixes on the nanoftp and nanohttp modules</li>
763 <li>build fixes: xmllint detection bug in configure, building outside the
764 source tree (Thomas Fitzsimmons)</li>
765 <li>bug fixes: HTML parser on broken ASCII chars in names (William), Python
766 paths (Malcolm Tredinnick), xmlHasNsProp and default namespace (William),
767 saving to python file objects (Malcolm Tredinnick), DTD lookup fix
768 (Malcolm), save back &lt;group&gt; in catalogs (William), tree build
769 fixes (DV and Rob Richards), Schemas memory bug, structured error handler
770 on Python 64bits, thread local memory deallocation, memory leak reported
771 by Volker Roth, xmlValidateDtd in the presence of an internal subset,
772 entities and _private problem (William), xmlBuildRelativeURI error
773 (William).</li>
774 <li>improvements: better XInclude error reports (William), tree debugging
775 module and tests, convenience functions at the Reader API (Graham
776 Bennett), add support for PI in the HTML parser.</li>
777</ul>
778
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]779<h3>2.6.14: Sep 29 2004</h3>
780<ul>
781 <li>build fixes: configure paths for xmllint and xsltproc, compilation
782 without HTML parser, compilation warning cleanups (William Brack &amp;
Daniel Veillard6927b102004-10-27 17:29:04 +0000[diff] [blame]783 Malcolm Tredinnick), VMS makefile update (Craig Berry),</li>
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]784 <li>bug fixes: xmlGetUTF8Char (William Brack), QName properties (Kasimier
785 Buchcik), XInclude testing, Notation serialization, UTF8ToISO8859x
786 transcoding (Mark Itzcovitz), lots of XML Schemas cleanup and fixes
787 (Kasimier), ChangeLog cleanup (Stepan Kasal), memory fixes (Mark Vakoc),
788 handling of failed realloc(), out of bound array adressing in Schemas
789 date handling, Python space/tabs cleanups (Malcolm Tredinnick), NMTOKENS
Daniel Veillard6927b102004-10-27 17:29:04 +0000[diff] [blame]790 E20 validation fix (Malcolm),</li>
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]791 <li>improvements: added W3C XML Schemas testsuite (Kasimier Buchcik), add
792 xmlSchemaValidateOneElement (Kasimier), Python exception hierearchy
793 (Malcolm Tredinnick), Python libxml2 driver improvement (Malcolm
794 Tredinnick), Schemas support for xsi:schemaLocation,
795 xsi:noNamespaceSchemaLocation, xsi:type (Kasimier Buchcik)</li>
796</ul>
797
Daniel Veillardd1de4a32004-08-31 13:43:07 +0000[diff] [blame]798<h3>2.6.13: Aug 31 2004</h3>
799<ul>
800 <li>build fixes: Windows and zlib (Igor Zlatkovic), -O flag with gcc,
Daniel Veillard210818b2004-09-29 15:50:37 +0000[diff] [blame]801 Solaris compiler warning, fixing RPM BuildRequires,</li>
Daniel Veillardd1de4a32004-08-31 13:43:07 +0000[diff] [blame]802 <li>fixes: DTD loading on Windows (Igor), Schemas error reports APIs
803 (Kasimier Buchcik), Schemas validation crash, xmlCheckUTF8 (William Brack
804 and Julius Mittenzwei), Schemas facet check (Kasimier), default namespace
805 problem (William), Schemas hexbinary empty values, encoding error could
806 genrate a serialization loop.</li>
807 <li>Improvements: Schemas validity improvements (Kasimier), added --path
808 and --load-trace options to xmllint</li>
809 <li>documentation: tutorial update (John Fleck)</li>
810</ul>
811
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]812<h3>2.6.12: Aug 22 2004</h3>
813<ul>
814 <li>build fixes: fix --with-minimum, elfgcchack.h fixes (Peter
815 Breitenlohner), perl path lookup (William), diff on Solaris (Albert
816 Chin), some 64bits cleanups.</li>
817 <li>Python: avoid a warning with 2.3 (William Brack), tab and space mixes
818 (William), wrapper generator fixes (William), Cygwin support (Gerrit P.
819 Haase), node wrapper fix (Marc-Antoine Parent), XML Schemas support
820 (Torkel Lyng)</li>
821 <li>Schemas: a lot of bug fixes and improvements from Kasimier Buchcik</li>
822 <li>fixes: RVT fixes (William), XPath context resets bug (William), memory
823 debug (Steve Hay), catalog white space handling (Peter Breitenlohner),
824 xmlReader state after attribute reading (William), structured error
825 handler (William), XInclude generated xml:base fixup (William), Windows
826 memory reallocation problem (Steve Hay), Out of Memory conditions
827 handling (William and Olivier Andrieu), htmlNewDoc() charset bug,
828 htmlReadMemory init (William), a posteriori validation DTD base
829 (William), notations serialization missing, xmlGetNodePath (Dodji),
830 xmlCheckUTF8 (Diego Tartara), missing line numbers on entity
831 (William)</li>
832 <li>improvements: DocBook catalog build scrip (William), xmlcatalog tool
833 (Albert Chin), xmllint --c14n option, no_proxy environment (Mike Hommey),
834 xmlParseInNodeContext() addition, extend xmllint --shell, allow XInclude
835 to not generate start/end nodes, extend xmllint --version to include CVS
836 tag (William)</li>
837 <li>documentation: web pages fixes, validity API docs fixes (William)
838 schemas API fix (Eric Haszlakiewicz), xmllint man page (John Fleck)</li>
839</ul>
840
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]841<h3>2.6.11: July 5 2004</h3>
842<ul>
843 <li>Schemas: a lot of changes and improvements by Kasimier Buchcik for
844 attributes, namespaces and simple types.</li>
845 <li>build fixes: --with-minimum (William Brack), some gcc cleanup
846 (William), --with-thread-alloc (William)</li>
847 <li>portability: Windows binary package change (Igor Zlatkovic), Catalog
848 path on Windows</li>
849 <li>documentation: update to the tutorial (John Fleck), xmllint return code
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]850 (John Fleck), man pages (Ville Skytta),</li>
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]851 <li>bug fixes: C14N bug serializing namespaces (Aleksey Sanin), testSAX
852 properly initialize the library (William), empty node set in XPath
853 (William), xmlSchemas errors (William), invalid charref problem pointed
854 by Morus Walter, XInclude xml:base generation (William), Relax-NG bug
Daniel Veillardb331fff2004-08-22 14:21:57 +0000[diff] [blame]855 with div processing (William), XPointer and xml:base problem(William),
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]856 Reader and entities, xmllint return code for schemas (William), reader
857 streaming problem (Steve Ball), DTD serialization problem (William),
858 libxml.m4 fixes (Mike Hommey), do not provide destructors as methods on
859 Python classes, xmlReader buffer bug, Python bindings memory interfaces
860 improvement (with Stéphane Bidoul), Fixed the push parser to be back to
861 synchronous behaviour.</li>
862 <li>improvement: custom per-thread I/O enhancement (Rob Richards), register
863 namespace in debug shell (Stefano Debenedetti), Python based regression
864 test for non-Unix users (William), dynamically increase the number of
865 XPath extension functions in Python and fix a memory leak (Marc-Antoine
866 Parent and William)</li>
867 <li>performance: hack done with Arjan van de Ven to reduce ELF footprint
868 and generated code on Linux, plus use gcc runtime profiling to optimize
869 the code generated in the RPM packages.</li>
870</ul>
871
Daniel Veillard81205012004-05-18 03:06:41 +0000[diff] [blame]872<h3>2.6.10: May 17 2004</h3>
873<ul>
874 <li>Web page generated for ChangeLog</li>
875 <li>build fixes: --without-html problems, make check without make all</li>
876 <li>portability: problem with xpath.c on Windows (MSC and Borland), memcmp
877 vs. strncmp on Solaris, XPath tests on Windows (Mark Vakoc), C++ do not
878 use "list" as parameter name, make tests work with Python 1.5 (Ed
879 Davis),</li>
880 <li>improvements: made xmlTextReaderMode public, small buffers resizing
881 (Morten Welinder), add --maxmem option to xmllint, add
882 xmlPopInputCallback() for Matt Sergeant, refactoring of serialization
Daniel Veillard45cb0f42004-07-05 17:45:35 +0000[diff] [blame]883 escaping, added escaping customization</li>
Daniel Veillard81205012004-05-18 03:06:41 +0000[diff] [blame]884 <li>bugfixes: xsd:extension (Taihei Goi), assorted regexp bugs (William
885 Brack), xmlReader end of stream problem, node deregistration with reader,
886 URI escaping and filemanes, XHTML1 formatting (Nick Wellnhofer), regexp
887 transition reduction (William), various XSD Schemas fixes (Kasimier
888 Buchcik), XInclude fallback problem (William), weird problems with DTD
889 (William), structured error handler callback context (William), reverse
890 xmlEncodeSpecialChars() behaviour back to escaping '"'</li>
891</ul>
892
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]893<h3>2.6.9: Apr 18 2004</h3>
894<ul>
895 <li>implement xml:id Working Draft, relaxed XPath id() checking</li>
896 <li>bugfixes: xmlCtxtReset (Brent Hendricks), line number and CDATA (Dave
897 Beckett), Relax-NG compilation (William Brack), Regexp patches (with
898 William), xmlUriEscape (Mark Vakoc), a Relax-NG notAllowed problem (with
899 William), Relax-NG name classes compares (William), XInclude duplicate
900 fallback (William), external DTD encoding detection (William), a DTD
901 validation bug (William), xmlReader Close() fix, recusive extention
902 schemas</li>
903 <li>improvements: use xmlRead* APIs in test tools (Mark Vakoc), indenting
904 save optimization, better handle IIS broken HTTP redirect behaviour (Ian
905 Hummel), HTML parser frameset (James Bursa), libxml2-python RPM
906 dependancy, XML Schemas union support (Kasimier Buchcik), warning removal
907 clanup (William), keep ChangeLog compressed when installing from RPMs</li>
908 <li>documentation: examples and xmlDocDumpMemory docs (John Fleck), new
Daniel Veillardd4cfcef2004-05-06 18:55:27 +0000[diff] [blame]909 example (load, xpath, modify, save), xmlCatalogDump() comments,</li>
Daniel Veillardeca726d2004-04-18 21:47:34 +0000[diff] [blame]910 <li>Windows: Borland C++ builder (Eric Zurcher), work around Microsoft
911 compiler NaN handling bug (Mark Vakoc)</li>
912</ul>
913
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]914<h3>2.6.8: Mar 23 2004</h3>
915<ul>
916 <li>First step of the cleanup of the serialization code and APIs</li>
917 <li>XML Schemas: mixed content (Adam Dickmeiss), QName handling fixes (Adam
918 Dickmeiss), anyURI for "" (John Belmonte)</li>
919 <li>Python: Canonicalization C14N support added (Anthony Carrico)</li>
920 <li>xmlDocCopyNode() extension (William)</li>
921 <li>Relax-NG: fix when processing XInclude results (William), external
922 reference in interleave (William), missing error on &lt;choice&gt;
923 failure (William), memory leak in schemas datatype facets.</li>
924 <li>xmlWriter: patch for better DTD support (Alfred Mickautsch)</li>
925 <li>bug fixes: xmlXPathLangFunction memory leak (Mike Hommey and William
926 Brack), no ID errors if using HTML_PARSE_NOERROR, xmlcatalog fallbacks to
927 URI on SYSTEM lookup failure, XInclude parse flags inheritance (William),
928 XInclude and XPointer fixes for entities (William), XML parser bug
929 reported by Holger Rauch, nanohttp fd leak (William), regexps char
930 groups '-' handling (William), dictionnary reference counting problems,
Daniel Veillardd99224d2004-04-06 10:04:16 +0000[diff] [blame]931 do not close stderr.</li>
Daniel Veillard252004d2004-03-23 12:32:32 +0000[diff] [blame]932 <li>performance patches from Petr Pajas</li>
933 <li>Documentation fixes: XML_CATALOG_FILES in man pages (Mike Hommey)</li>
934 <li>compilation and portability fixes: --without-valid, catalog cleanups
935 (Peter Breitenlohner), MingW patch (Roland Schwingel), cross-compilation
936 to Windows (Christophe de Vienne), --with-html-dir fixup (Julio Merino
937 Vidal), Windows build (Eric Zurcher)</li>
938</ul>
939
Daniel Veillard92914492004-02-23 16:33:21 +0000[diff] [blame]940<h3>2.6.7: Feb 23 2004</h3>
941<ul>
942 <li>documentation: tutorial updates (John Fleck), benchmark results</li>
943 <li>xmlWriter: updates and fixes (Alfred Mickautsch, Lucas Brasilino)</li>
944 <li>XPath optimization (Petr Pajas)</li>
945 <li>DTD ID handling optimization</li>
946 <li>bugfixes: xpath number with &gt; 19 fractional (William Brack), push
947 mode with unescaped '&gt;' characters, fix xmllint --stream --timing, fix
948 xmllint --memory --stream memory usage, xmlAttrSerializeTxtContent
949 handling NULL, trying to fix Relax-NG/Perl interface.</li>
950 <li>python: 2.3 compatibility, whitespace fixes (Malcolm Tredinnick)</li>
951 <li>Added relaxng option to xmllint --shell</li>
952</ul>
953
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]954<h3>2.6.6: Feb 12 2004</h3>
955<ul>
956 <li>nanohttp and nanoftp: buffer overflow error on URI parsing (Igor and
957 William) reported by Yuuichi Teranishi</li>
958 <li>bugfixes: make test and path issues, xmlWriter attribute serialization
959 (William Brack), xmlWriter indentation (William), schemas validation
960 (Eric Haszlakiewicz), XInclude dictionnaries issues (William and Oleg
961 Paraschenko), XInclude empty fallback (William), HTML warnings (William),
962 XPointer in XInclude (William), Python namespace serialization,
963 isolat1ToUTF8 bound error (Alfred Mickautsch), output of parameter
964 entities in internal subset (William), internal subset bug in push mode,
965 &lt;xs:all&gt; fix (Alexey Sarytchev)</li>
966 <li>Build: fix for automake-1.8 (Alexander Winston), warnings removal
967 (Philip Ludlam), SOCKLEN_T detection fixes (Daniel Richard), fix
968 --with-minimum configuration.</li>
969 <li>XInclude: allow the 2001 namespace without warning.</li>
970 <li>Documentation: missing example/index.html (John Fleck), version
971 dependancies (John Fleck)</li>
972 <li>reader API: structured error reporting (Steve Ball)</li>
973 <li>Windows compilation: mingw, msys (Mikhail Grushinskiy), function
974 prototype (Cameron Johnson), MSVC6 compiler warnings, _WINSOCKAPI_
975 patch</li>
976 <li>Parsers: added xmlByteConsumed(ctxt) API to get the byte offest in
977 input.</li>
978</ul>
979
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]980<h3>2.6.5: Jan 25 2004</h3>
981<ul>
982 <li>Bugfixes: dictionnaries for schemas (William Brack), regexp segfault
983 (William), xs:all problem (William), a number of XPointer bugfixes
984 (William), xmllint error go to stderr, DTD validation problem with
985 namespace, memory leak (William), SAX1 cleanup and minimal options fixes
986 (Mark Vadoc), parser context reset on error (Shaun McCance), XPath union
987 evaluation problem (William) , xmlReallocLoc with NULL (Aleksey Sanin),
988 XML Schemas double free (Steve Ball), XInclude with no href, argument
989 callbacks order for XPath callbacks (Frederic Peters)</li>
990 <li>Documentation: python scripts (William Brack), xslt stylesheets (John
991 Fleck), doc (Sven Zimmerman), I/O example.</li>
992 <li>Python bindings: fixes (William), enum support (Stéphane Bidoul),
993 structured error reporting (Stéphane Bidoul)</li>
994 <li>XInclude: various fixes for conformance, problem related to dictionnary
995 references (William &amp; me), recursion (William)</li>
996 <li>xmlWriter: indentation (Lucas Brasilino), memory leaks (Alfred
Daniel Veillard5c9547e2004-02-12 15:31:49 +0000[diff] [blame]997 Mickautsch),</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]998 <li>xmlSchemas: normalizedString datatype (John Belmonte)</li>
999 <li>code cleanup for strings functions (William)</li>
1000 <li>Windows: compiler patches (Mark Vakoc)</li>
1001 <li>Parser optimizations, a few new XPath and dictionnary APIs for future
1002 XSLT optimizations.</li>
1003</ul>
1004
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]1005<h3>2.6.4: Dec 24 2003</h3>
1006<ul>
1007 <li>Windows build fixes (Igor Zlatkovic)</li>
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]1008 <li>Some serious XInclude problems reported by Oleg Paraschenko and</li>
1009 <li>Unix and Makefile packaging fixes (me, William Brack,</li>
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]1010 <li>Documentation improvements (John Fleck, William Brack), example fix
1011 (Lucas Brasilino)</li>
1012 <li>bugfixes: xmlTextReaderExpand() with xmlReaderWalker, XPath handling of
1013 NULL strings (William Brack) , API building reader or parser from
1014 filedescriptor should not close it, changed XPath sorting to be stable
1015 again (William Brack), xmlGetNodePath() generating '(null)' (William
1016 Brack), DTD validation and namespace bug (William Brack), XML Schemas
1017 double inclusion behaviour</li>
1018</ul>
1019
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1020<h3>2.6.3: Dec 10 2003</h3>
1021<ul>
1022 <li>documentation updates and cleanup (DV, William Brack, John Fleck)</li>
1023 <li>added a repository of examples, examples from Aleksey Sanin, Dodji
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]1024 Seketeli, Alfred Mickautsch</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1025 <li>Windows updates: Mark Vakoc, Igor Zlatkovic, Eric Zurcher, Mingw
1026 (Kenneth Haley)</li>
1027 <li>Unicode range checking (William Brack)</li>
1028 <li>code cleanup (William Brack)</li>
1029 <li>Python bindings: doc (John Fleck), bug fixes</li>
1030 <li>UTF-16 cleanup and BOM issues (William Brack)</li>
1031 <li>bug fixes: ID and xmlReader validation, XPath (William Brack),
1032 xmlWriter (Alfred Mickautsch), hash.h inclusion problem, HTML parser
1033 (James Bursa), attribute defaulting and validation, some serialization
1034 cleanups, XML_GET_LINE macro, memory debug when using threads (William
1035 Brack), serialization of attributes and entities content, xmlWriter
1036 (Daniel Schulman)</li>
1037 <li>XInclude bugfix, new APIs and update to the last version including the
1038 namespace change.</li>
1039 <li>XML Schemas improvements: include (Robert Stepanek), import and
1040 namespace handling, fixed the regression tests troubles, added examples
Daniel Veillarde6e59cd2003-12-24 11:56:44 +0000[diff] [blame]1041 based on Eric van der Vlist book, regexp fixes</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1042 <li>preliminary pattern support for streaming (needed for schemas
1043 constraints), added xmlTextReaderPreservePattern() to collect subdocument
1044 when streaming.</li>
1045 <li>various fixes in the structured error handling</li>
1046</ul>
1047
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]1048<h3>2.6.2: Nov 4 2003</h3>
1049<ul>
1050 <li>XPath context unregistration fixes</li>
1051 <li>text node coalescing fixes (Mark Lilback)</li>
1052 <li>API to screate a W3C Schemas from an existing document (Steve Ball)</li>
1053 <li>BeOS patches (Marcin 'Shard' Konicki)</li>
1054 <li>xmlStrVPrintf function added (Aleksey Sanin)</li>
1055 <li>compilation fixes (Mark Vakoc)</li>
1056 <li>stdin parsing fix (William Brack)</li>
1057 <li>a posteriori DTD validation fixes</li>
Daniel Veillardc480c4e2003-12-10 13:24:38 +0000[diff] [blame]1058 <li>xmlReader bug fixes: Walker fixes, python bindings</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]1059 <li>fixed xmlStopParser() to really stop the parser and errors</li>
1060 <li>always generate line numbers when using the new xmlReadxxx
1061 functions</li>
1062 <li>added XInclude support to the xmlReader interface</li>
1063 <li>implemented XML_PARSE_NONET parser option</li>
1064 <li>DocBook XSLT processing bug fixed</li>
1065 <li>HTML serialization for &lt;p&gt; elements (William Brack and me)</li>
1066 <li>XPointer failure in XInclude are now handled as resource errors</li>
1067 <li>fixed xmllint --html to use the HTML serializer on output (added
1068 --xmlout to implement the previous behaviour of saving it using the XML
1069 serializer)</li>
1070</ul>
1071
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]1072<h3>2.6.1: Oct 28 2003</h3>
1073<ul>
1074 <li>Mostly bugfixes after the big 2.6.0 changes</li>
1075 <li>Unix compilation patches: libxml.m4 (Patrick Welche), warnings cleanup
1076 (William Brack)</li>
1077 <li>Windows compilation patches (Joachim Bauch, Stephane Bidoul, Igor
1078 Zlatkovic)</li>
1079 <li>xmlWriter bugfix (Alfred Mickautsch)</li>
1080 <li>chvalid.[ch]: couple of fixes from Stephane Bidoul</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]1081 <li>context reset: error state reset, push parser reset (Graham
1082 Bennett)</li>
Daniel Veillarde4e3f5d2003-10-28 23:06:32 +0000[diff] [blame]1083 <li>context reuse: generate errors if file is not readable</li>
1084 <li>defaulted attributes for element coming from internal entities
1085 (Stephane Bidoul)</li>
1086 <li>Python: tab and spaces mix (William Brack)</li>
1087 <li>Error handler could crash in DTD validation in 2.6.0</li>
1088 <li>xmlReader: do not use the document or element _private field</li>
1089 <li>testSAX.c: avoid a problem with some PIs (Massimo Morara)</li>
1090 <li>general bug fixes: mandatory encoding in text decl, serializing
1091 Document Fragment nodes, xmlSearchNs 2.6.0 problem (Kasimier Buchcik),
1092 XPath errors not reported, slow HTML parsing of large documents.</li>
1093</ul>
1094
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]1095<h3>2.6.0: Oct 20 2003</h3>
1096<ul>
1097 <li>Major revision release: should be API and ABI compatible but got a lot
1098 of change</li>
1099 <li>Increased the library modularity, far more options can be stripped out,
1100 a --with-minimum configuration will weight around 160KBytes</li>
1101 <li>Use per parser and per document dictionnary, allocate names and small
1102 text nodes from the dictionnary</li>
1103 <li>Switch to a SAX2 like parser rewrote most of the XML parser core,
1104 provides namespace resolution and defaulted attributes, minimize memory
1105 allocations and copies, namespace checking and specific error handling,
1106 immutable buffers, make predefined entities static structures, etc...</li>
1107 <li>rewrote all the error handling in the library, all errors can be
1108 intercepted at a structured level, with precise information
1109 available.</li>
1110 <li>New simpler and more generic XML and HTML parser APIs, allowing to
1111 easilly modify the parsing options and reuse parser context for multiple
1112 consecutive documents.</li>
1113 <li>Similar new APIs for the xmlReader, for options and reuse, provided new
1114 functions to access content as const strings, use them for Python
1115 bindings</li>
1116 <li>a lot of other smaller API improvements: xmlStrPrintf (Aleksey Sanin),
1117 Walker i.e. reader on a document tree based on Alfred Mickautsch code,
1118 make room in nodes for line numbers, reference counting and future PSVI
1119 extensions, generation of character ranges to be checked with faster
1120 algorithm (William), xmlParserMaxDepth (Crutcher Dunnavant), buffer
1121 access</li>
1122 <li>New xmlWriter API provided by Alfred Mickautsch</li>
1123 <li>Schemas: base64 support by Anthony Carrico</li>
1124 <li>Parser&lt;-&gt;HTTP integration fix, proper processing of the Mime-Type
1125 and charset informations if available.</li>
1126 <li>Relax-NG: bug fixes including the one reported by Martijn Faassen and
1127 zeroOrMore, better error reporting.</li>
1128 <li>Python bindings (Stéphane Bidoul), never use stdout for errors
1129 output</li>
1130 <li>Portability: all the headers have macros for export and calling
1131 convention definitions (Igor Zlatkovic), VMS update (Craig A. Berry),
1132 Windows: threads (Jesse Pelton), Borland compiler (Eric Zurcher, Igor),
1133 Mingw (Igor), typos (Mark Vakoc), beta version (Stephane Bidoul),
1134 warning cleanups on AIX and MIPS compilers (William Brack), BeOS (Marcin
1135 'Shard' Konicki)</li>
1136 <li>Documentation fixes and README (William Brack), search fix (William),
1137 tutorial updates (John Fleck), namespace docs (Stefan Kost)</li>
1138 <li>Bug fixes: xmlCleanupParser (Dave Beckett), threading uninitialized
1139 mutexes, HTML doctype lowercase, SAX/IO (William), compression detection
1140 and restore (William), attribute declaration in DTDs (William), namespace
1141 on attribute in HTML output (William), input filename (Rob Richards),
1142 namespace DTD validation, xmlReplaceNode (Chris Ryland), I/O callbacks
1143 (Markus Keim), CDATA serialization (Shaun McCance), xmlReader (Peter
1144 Derr), high codepoint charref like &amp;#x10FFFF;, buffer access in push
1145 mode (Justin Fletcher), TLS threads on Windows (Jesse Pelton), XPath bug
1146 (William), xmlCleanupParser (Marc Liyanage), CDATA output (William), HTTP
1147 error handling.</li>
1148 <li>xmllint options: --dtdvalidfpi for Tobias Reif, --sax1 for compat
1149 testing, --nodict for building without tree dictionnary, --nocdata to
1150 replace CDATA by text, --nsclean to remove surperfluous namespace
1151 declarations</li>
1152 <li>added xml2-config --libtool-libs option from Kevin P. Fleming</li>
1153 <li>a lot of profiling and tuning of the code, speedup patch for
1154 xmlSearchNs() by Luca Padovani. The xmlReader should do far less
1155 allocation and it speed should get closer to SAX. Chris Anderson worked
1156 on speeding and cleaning up repetitive checking code.</li>
1157 <li>cleanup of "make tests"</li>
1158 <li>libxml-2.0-uninstalled.pc from Malcolm Tredinnick</li>
1159 <li>deactivated the broken docBook SGML parser code and plugged the XML
1160 parser instead.</li>
1161</ul>
1162
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]1163<h3>2.5.11: Sep 9 2003</h3>
1164
1165<p>A bugfix only release:</p>
1166<ul>
1167 <li>risk of crash in Relax-NG</li>
1168 <li>risk of crash when using multithreaded programs</li>
1169</ul>
1170
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]1171<h3>2.5.10: Aug 15 2003</h3>
1172
1173<p>A bugfixes only release</p>
1174<ul>
1175 <li>Windows Makefiles (William Brack)</li>
1176 <li>UTF-16 support fixes (Mark Itzcovitz)</li>
1177 <li>Makefile and portability (William Brack) automake, Linux alpha, Mingw
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]1178 on Windows (Mikhail Grushinskiy)</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]1179 <li>HTML parser (Oliver Stoeneberg)</li>
1180 <li>XInclude performance problem reported by Kevin Ruscoe</li>
1181 <li>XML parser performance problem reported by Grant Goodale</li>
1182 <li>xmlSAXParseDTD() bug fix from Malcolm Tredinnick</li>
Daniel Veillardeec1ae92003-09-09 13:11:01 +0000[diff] [blame]1183 <li>and a couple other cleanup</li>
Daniel Veillardcfba2fe2003-08-15 00:33:43 +0000[diff] [blame]1184</ul>
1185
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]1186<h3>2.5.9: Aug 9 2003</h3>
1187<ul>
1188 <li>bugfixes: IPv6 portability, xmlHasNsProp (Markus Keim), Windows build
1189 (Wiliam Brake, Jesse Pelton, Igor), Schemas (Peter Sobisch), threading
1190 (Rob Richards), hexBinary type (), UTF-16 BOM (Dodji Seketeli),
1191 xmlReader, Relax-NG schemas compilation, namespace handling, EXSLT (Sean
1192 Griffin), HTML parsing problem (William Brack), DTD validation for mixed
1193 content + namespaces, HTML serialization, library initialization,
1194 progressive HTML parser</li>
1195 <li>better interfaces for Relax-NG error handling (Joachim Bauch, )</li>
1196 <li>adding xmlXIncludeProcessTree() for XInclud'ing in a subtree</li>
1197 <li>doc fixes and improvements (John Fleck)</li>
1198 <li>configure flag for -with-fexceptions when embedding in C++</li>
1199 <li>couple of new UTF-8 helper functions (William Brack)</li>
1200 <li>general encoding cleanup + ISO-8859-x without iconv (Peter Jacobi)</li>
1201 <li>xmlTextReader cleanup + enum for node types (Bjorn Reese)</li>
1202 <li>general compilation/warning cleanup Solaris/HP-UX/... (William
1203 Brack)</li>
1204</ul>
1205
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]1206<h3>2.5.8: Jul 6 2003</h3>
1207<ul>
1208 <li>bugfixes: XPath, XInclude, file/URI mapping, UTF-16 save (Mark
1209 Itzcovitz), UTF-8 checking, URI saving, error printing (William Brack),
1210 PI related memleak, compilation without schemas or without xpath (Joerg
1211 Schmitz-Linneweber/Garry Pennington), xmlUnlinkNode problem with DTDs,
1212 rpm problem on , i86_64, removed a few compilation problems from 2.5.7,
1213 xmlIOParseDTD, and xmlSAXParseDTD (Malcolm Tredinnick)</li>
1214 <li>portability: DJGPP (MsDos) , OpenVMS (Craig A. Berry)</li>
1215 <li>William Brack fixed multithreading lock problems</li>
1216 <li>IPv6 patch for FTP and HTTP accesses (Archana Shah/Wipro)</li>
1217 <li>Windows fixes (Igor Zlatkovic, Eric Zurcher), threading (Stéphane
1218 Bidoul)</li>
1219 <li>A few W3C Schemas Structure improvements</li>
1220 <li>W3C Schemas Datatype improvements (Charlie Bozeman)</li>
1221 <li>Python bindings for thread globals (Stéphane Bidoul), and method/class
Daniel Veillard83ee40d2003-08-09 22:24:09 +0000[diff] [blame]1222 generator</li>
1223 <li>added --nonet option to xmllint</li>
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]1224 <li>documentation improvements (John Fleck)</li>
1225</ul>
1226
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]1227<h3>2.5.7: Apr 25 2003</h3>
1228<ul>
1229 <li>Relax-NG: Compiling to regexp and streaming validation on top of the
1230 xmlReader interface, added to xmllint --stream</li>
1231 <li>xmlReader: Expand(), Next() and DOM access glue, bug fixes</li>
1232 <li>Support for large files: RGN validated a 4.5GB instance</li>
1233 <li>Thread support is now configured in by default</li>
1234 <li>Fixes: update of the Trio code (Bjorn), WXS Date and Duration fixes
1235 (Charles Bozeman), DTD and namespaces (Brent Hendricks), HTML push parser
1236 and zero bytes handling, some missing Windows file path conversions,
1237 behaviour of the parser and validator in the presence of "out of memory"
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]1238 error conditions</li>
Daniel Veillard92fc02c2003-04-24 23:12:35 +0000[diff] [blame]1239 <li>extended the API to be able to plug a garbage collecting memory
1240 allocator, added xmlMallocAtomic() and modified the allocations
1241 accordingly.</li>
1242 <li>Performances: removed excessive malloc() calls, speedup of the push and
1243 xmlReader interfaces, removed excessive thread locking</li>
1244 <li>Documentation: man page (John Fleck), xmlReader documentation</li>
1245 <li>Python: adding binding for xmlCatalogAddLocal (Brent M Hendricks)</li>
1246</ul>
1247
Daniel Veillardc2d4a932003-04-01 11:13:05 +0000[diff] [blame]1248<h3>2.5.6: Apr 1 2003</h3>
1249<ul>
1250 <li>Fixed W3C XML Schemas datatype, should be compliant now except for
1251 binHex and base64 which are not supported yet.</li>
1252 <li>bug fixes: non-ASCII IDs, HTML output, XInclude on large docs and
1253 XInclude entities handling, encoding detection on external subsets, XML
1254 Schemas bugs and memory leaks, HTML parser (James Bursa)</li>
1255 <li>portability: python/trio (Albert Chin), Sun compiler warnings</li>
1256 <li>documentation: added --relaxng option to xmllint man page (John)</li>
1257 <li>improved error reporting: xml:space, start/end tag mismatches, Relax NG
1258 errors</li>
1259</ul>
1260
1261<h3>2.5.5: Mar 24 2003</h3>
Daniel Veillardd8da01c2003-03-24 15:58:23 +0000[diff] [blame]1262<ul>
1263 <li>Lot of fixes on the Relax NG implementation. More testing including
1264 DocBook and TEI examples.</li>
1265 <li>Increased the support for W3C XML Schemas datatype</li>
1266 <li>Several bug fixes in the URI handling layer</li>
1267 <li>Bug fixes: HTML parser, xmlReader, DTD validation, XPath, encoding
1268 conversion, line counting in the parser.</li>
1269 <li>Added support for $XMLLINT_INDENT environment variable, FTP delete</li>
1270 <li>Fixed the RPM spec file name</li>
1271</ul>
1272
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]1273<h3>2.5.4: Feb 20 2003</h3>
1274<ul>
1275 <li>Conformance testing and lot of fixes on Relax NG and XInclude
1276 implementation</li>
1277 <li>Implementation of XPointer element() scheme</li>
1278 <li>Bug fixes: XML parser, XInclude entities merge, validity checking on
1279 namespaces,
1280 <p>2 serialization bugs, node info generation problems, a DTD regexp
1281 generation problem.</p>
1282 </li>
1283 <li>Portability: windows updates and path canonicalization (Igor)</li>
1284 <li>A few typo fixes (Kjartan Maraas)</li>
1285 <li>Python bindings generator fixes (Stephane Bidoul)</li>
1286</ul>
1287
Daniel Veillard1d788d22003-02-10 16:21:58 +0000[diff] [blame]1288<h3>2.5.3: Feb 10 2003</h3>
1289<ul>
1290 <li>RelaxNG and XML Schemas datatypes improvements, and added a first
1291 version of RelaxNG Python bindings</li>
1292 <li>Fixes: XLink (Sean Chittenden), XInclude (Sean Chittenden), API fix for
1293 serializing namespace nodes, encoding conversion bug, XHTML1
1294 serialization</li>
1295 <li>Portability fixes: Windows (Igor), AMD 64bits RPM spec file</li>
1296</ul>
1297
Daniel Veillard72fef162003-02-05 14:31:19 +0000[diff] [blame]1298<h3>2.5.2: Feb 5 2003</h3>
1299<ul>
1300 <li>First implementation of RelaxNG, added --relaxng flag to xmllint</li>
1301 <li>Schemas support now compiled in by default.</li>
1302 <li>Bug fixes: DTD validation, namespace checking, XInclude and entities,
1303 delegateURI in XML Catalogs, HTML parser, XML reader (Stéphane Bidoul),
1304 XPath parser and evaluation, UTF8ToUTF8 serialization, XML reader memory
1305 consumption, HTML parser, HTML serialization in the presence of
1306 namespaces</li>
1307 <li>added an HTML API to check elements and attributes.</li>
1308 <li>Documentation improvement, PDF for the tutorial (John Fleck), doc
1309 patches (Stefan Kost)</li>
1310 <li>Portability fixes: NetBSD (Julio Merino), Windows (Igor Zlatkovic)</li>
1311 <li>Added python bindings for XPointer, contextual error reporting
1312 (Stéphane Bidoul)</li>
1313 <li>URI/file escaping problems (Stefano Zacchiroli)</li>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]1314</ul>
1315
Daniel Veillarde2830f12003-01-08 17:47:49 +0000[diff] [blame]1316<h3>2.5.1: Jan 8 2003</h3>
1317<ul>
1318 <li>Fixes a memory leak and configuration/compilation problems in 2.5.0</li>
1319 <li>documentation updates (John)</li>
1320 <li>a couple of XmlTextReader fixes</li>
1321</ul>
1322
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]1323<h3>2.5.0: Jan 6 2003</h3>
1324<ul>
1325 <li>New <a href="xmlreader.html">XmltextReader interface</a> based on C#
1326 API (with help of Stéphane Bidoul)</li>
1327 <li>Windows: more exports, including the new API (Igor)</li>
1328 <li>XInclude fallback fix</li>
1329 <li>Python: bindings for the new API, packaging (Stéphane Bidoul),
1330 drv_libxml2.py Python xml.sax driver (Stéphane Bidoul), fixes, speedup
1331 and iterators for Python-2.2 (Hannu Krosing)</li>
1332 <li>Tutorial fixes (john Fleck and Niraj Tolia) xmllint man update
1333 (John)</li>
1334 <li>Fix an XML parser bug raised by Vyacheslav Pindyura</li>
1335 <li>Fix for VMS serialization (Nigel Hall) and config (Craig A. Berry)</li>
1336 <li>Entities handling fixes</li>
1337 <li>new API to optionally track node creation and deletion (Lukas
1338 Schroeder)</li>
1339 <li>Added documentation for the XmltextReader interface and some <a
1340 href="guidelines.html">XML guidelines</a></li>
1341</ul>
1342
Daniel Veillardc1eed322002-12-12 11:01:32 +0000[diff] [blame]1343<h3>2.4.30: Dec 12 2002</h3>
1344<ul>
1345 <li>2.4.29 broke the python bindings, rereleasing</li>
1346 <li>Improvement/fixes of the XML API generator, and couple of minor code
1347 fixes.</li>
1348</ul>
1349
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]1350<h3>2.4.29: Dec 11 2002</h3>
1351<ul>
1352 <li>Windows fixes (Igor): Windows CE port, pthread linking, python bindings
1353 (Stéphane Bidoul), Mingw (Magnus Henoch), and export list updates</li>
1354 <li>Fix for prev in python bindings (ERDI Gergo)</li>
1355 <li>Fix for entities handling (Marcus Clarke)</li>
1356 <li>Refactored the XML and HTML dumps to a single code path, fixed XHTML1
1357 dump</li>
1358 <li>Fix for URI parsing when handling URNs with fragment identifiers</li>
1359 <li>Fix for HTTP URL escaping problem</li>
1360 <li>added an TextXmlReader (C#) like API (work in progress)</li>
1361 <li>Rewrote the API in XML generation script, includes a C parser and saves
1362 more informations needed for C# bindings</li>
1363</ul>
1364
Daniel Veillardf9c4cad2002-11-22 15:57:07 +0000[diff] [blame]1365<h3>2.4.28: Nov 22 2002</h3>
1366<ul>
1367 <li>a couple of python binding fixes</li>
1368 <li>2 bug fixes in the XML push parser</li>
1369 <li>potential memory leak removed (Martin Stoilov)</li>
1370 <li>fix to the configure script for Unix (Dimitri Papadopoulos)</li>
1371 <li>added encoding support for XInclude parse="text"</li>
1372 <li>autodetection of XHTML1 and specific serialization rules added</li>
Daniel Veillard9b4bb4d2002-12-11 19:28:47 +0000[diff] [blame]1373 <li>nasty threading bug fixed (William Brack)</li>
Daniel Veillardf9c4cad2002-11-22 15:57:07 +0000[diff] [blame]1374</ul>
1375
Daniel Veillarddad3f682002-11-17 16:47:27 +0000[diff] [blame]1376<h3>2.4.27: Nov 17 2002</h3>
1377<ul>
1378 <li>fixes for the Python bindings</li>
1379 <li>a number of bug fixes: SGML catalogs, xmlParseBalancedChunkMemory(),
1380 HTML parser, Schemas (Charles Bozeman), document fragment support
1381 (Christian Glahn), xmlReconciliateNs (Brian Stafford), XPointer,
1382 xmlFreeNode(), xmlSAXParseMemory (Peter Jones), xmlGetNodePath (Petr
1383 Pajas), entities processing</li>
1384 <li>added grep to xmllint --shell</li>
1385 <li>VMS update patch from Craig A. Berry</li>
1386 <li>cleanup of the Windows build with support for more compilers (Igor),
1387 better thread support on Windows</li>
1388 <li>cleanup of Unix Makefiles and spec file</li>
1389 <li>Improvements to the documentation (John Fleck)</li>
1390</ul>
1391
Daniel Veillard48267432002-10-18 11:21:38 +0000[diff] [blame]1392<h3>2.4.26: Oct 18 2002</h3>
1393<ul>
1394 <li>Patches for Windows CE port, improvements on Windows paths handling</li>
1395 <li>Fixes to the validation code (DTD and Schemas), xmlNodeGetPath() ,
1396 HTML serialization, Namespace compliance, and a number of small
1397 problems</li>
1398</ul>
1399
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]1400<h3>2.4.25: Sep 26 2002</h3>
1401<ul>
1402 <li>A number of bug fixes: XPath, validation, Python bindings, DOM and
1403 tree, xmlI/O, Html</li>
1404 <li>Serious rewrite of XInclude</li>
1405 <li>Made XML Schemas regexp part of the default build and APIs, small fix
1406 and improvement of the regexp core</li>
1407 <li>Changed the validation code to reuse XML Schemas regexp APIs</li>
1408 <li>Better handling of Windows file paths, improvement of Makefiles (Igor,
1409 Daniel Gehriger, Mark Vakoc)</li>
1410 <li>Improved the python I/O bindings, the tests, added resolver and regexp
Daniel Veillard321be0c2002-10-08 21:26:42 +0000[diff] [blame]1411 APIs</li>
Daniel Veillarde16b5742002-09-26 17:50:03 +0000[diff] [blame]1412 <li>New logos from Marc Liyanage</li>
1413 <li>Tutorial improvements: John Fleck, Christopher Harris</li>
1414 <li>Makefile: Fixes for AMD x86_64 (Mandrake), DESTDIR (Christophe
1415 Merlet)</li>
1416 <li>removal of all stderr/perror use for error reporting</li>
1417 <li>Better error reporting: XPath and DTD validation</li>
1418 <li>update of the trio portability layer (Bjorn Reese)</li>
1419</ul>
1420
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]1421<p><strong>2.4.24: Aug 22 2002</strong></p>
1422<ul>
1423 <li>XPath fixes (William), xf:escape-uri() (Wesley Terpstra)</li>
1424 <li>Python binding fixes: makefiles (William), generator, rpm build, x86-64
1425 (fcrozat)</li>
1426 <li>HTML &lt;style&gt; and boolean attributes serializer fixes</li>
1427 <li>C14N improvements by Aleksey</li>
Daniel Veillarde1662542002-08-28 11:50:59 +0000[diff] [blame]1428 <li>doc cleanups: Rick Jones</li>
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]1429 <li>Windows compiler makefile updates: Igor and Elizabeth Barham</li>
1430 <li>XInclude: implementation of fallback and xml:base fixup added</li>
1431</ul>
1432
Daniel Veillard782afda2002-07-08 15:12:49 +0000[diff] [blame]1433<h3>2.4.23: July 6 2002</h3>
1434<ul>
1435 <li>performances patches: Peter Jacobi</li>
1436 <li>c14n fixes, testsuite and performances: Aleksey Sanin</li>
1437 <li>added xmlDocFormatDump: Chema Celorio</li>
1438 <li>new tutorial: John Fleck</li>
1439 <li>new hash functions and performances: Sander Vesik, portability fix from
1440 Peter Jacobi</li>
1441 <li>a number of bug fixes: XPath (William Brack, Richard Jinks), XML and
1442 HTML parsers, ID lookup function</li>
1443 <li>removal of all remaining sprintf: Aleksey Sanin</li>
1444</ul>
1445
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]1446<h3>2.4.22: May 27 2002</h3>
1447<ul>
1448 <li>a number of bug fixes: configure scripts, base handling, parser, memory
1449 usage, HTML parser, XPath, documentation (Christian Cornelssen),
Daniel Veillard21473672002-06-17 07:29:22 +0000[diff] [blame]1450 indentation, URI parsing</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]1451 <li>Optimizations for XMLSec, fixing and making public some of the network
1452 protocol handlers (Aleksey)</li>
1453 <li>performance patch from Gary Pennington</li>
1454 <li>Charles Bozeman provided date and time support for XML Schemas
1455 datatypes</li>
1456</ul>
1457
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]1458<h3>2.4.21: Apr 29 2002</h3>
1459
1460<p>This release is both a bug fix release and also contains the early XML
1461Schemas <a href="http://www.w3.org/TR/xmlschema-1/">structures</a> and <a
1462href="http://www.w3.org/TR/xmlschema-2/">datatypes</a> code, beware, all
1463interfaces are likely to change, there is huge holes, it is clearly a work in
1464progress and don't even think of putting this code in a production system,
Daniel Veillarde6d8e202002-05-02 06:11:10 +0000[diff] [blame]1465it's actually not compiled in by default. The real fixes are:</p>
Daniel Veillardcf27f7c2002-04-30 07:12:39 +0000[diff] [blame]1466<ul>
1467 <li>a couple of bugs or limitations introduced in 2.4.20</li>
1468 <li>patches for Borland C++ and MSC by Igor</li>
1469 <li>some fixes on XPath strings and conformance patches by Richard
1470 Jinks</li>
1471 <li>patch from Aleksey for the ExcC14N specification</li>
1472 <li>OSF/1 bug fix by Bjorn</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]1473</ul>
1474
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]1475<h3>2.4.20: Apr 15 2002</h3>
1476<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1477 <li>bug fixes: file descriptor leak, XPath, HTML output, DTD validation</li>
Daniel Veillarda7084cd2002-04-15 17:12:47 +0000[diff] [blame]1478 <li>XPath conformance testing by Richard Jinks</li>
1479 <li>Portability fixes: Solaris, MPE/iX, Windows, OSF/1, python bindings,
1480 libxml.m4</li>
1481</ul>
1482
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]1483<h3>2.4.19: Mar 25 2002</h3>
1484<ul>
1485 <li>bug fixes: half a dozen XPath bugs, Validation, ISO-Latin to UTF8
1486 encoder</li>
1487 <li>portability fixes in the HTTP code</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +0000[diff] [blame]1488 <li>memory allocation checks using valgrind, and profiling tests</li>
Daniel Veillard19274092002-03-25 16:48:03 +0000[diff] [blame]1489 <li>revamp of the Windows build and Makefiles</li>
1490</ul>
1491
Daniel Veillard34ce8be2002-03-18 19:37:11 +0000[diff] [blame]1492<h3>2.4.18: Mar 18 2002</h3>
1493<ul>
1494 <li>bug fixes: tree, SAX, canonicalization, validation, portability,
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1495 XPath</li>
Daniel Veillard34ce8be2002-03-18 19:37:11 +0000[diff] [blame]1496 <li>removed the --with-buffer option it was becoming unmaintainable</li>
1497 <li>serious cleanup of the Python makefiles</li>
1498 <li>speedup patch to XPath very effective for DocBook stylesheets</li>
1499 <li>Fixes for Windows build, cleanup of the documentation</li>
1500</ul>
1501
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]1502<h3>2.4.17: Mar 8 2002</h3>
1503<ul>
1504 <li>a lot of bug fixes, including "namespace nodes have no parents in
1505 XPath"</li>
1506 <li>fixed/improved the Python wrappers, added more examples and more
1507 regression tests, XPath extension functions can now return node-sets</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1508 <li>added the XML Canonicalization support from Aleksey Sanin</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1509</ul>
1510
Daniel Veillard5f4b5992002-02-20 10:22:49 +0000[diff] [blame]1511<h3>2.4.16: Feb 20 2002</h3>
1512<ul>
1513 <li>a lot of bug fixes, most of them were triggered by the XML Testsuite
1514 from OASIS and W3C. Compliance has been significantly improved.</li>
1515 <li>a couple of portability fixes too.</li>
1516</ul>
1517
Daniel Veillard397ff112002-02-11 18:27:20 +0000[diff] [blame]1518<h3>2.4.15: Feb 11 2002</h3>
1519<ul>
1520 <li>Fixed the Makefiles, especially the python module ones</li>
1521 <li>A few bug fixes and cleanup</li>
1522 <li>Includes cleanup</li>
1523</ul>
1524
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame]1525<h3>2.4.14: Feb 8 2002</h3>
1526<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1527 <li>Change of License to the <a
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame]1528 href="http://www.opensource.org/licenses/mit-license.html">MIT
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1529 License</a> basically for integration in XFree86 codebase, and removing
1530 confusion around the previous dual-licensing</li>
Daniel Veillardb6c1e2f2002-02-08 14:52:52 +0000[diff] [blame]1531 <li>added Python bindings, beta software but should already be quite
1532 complete</li>
1533 <li>a large number of fixes and cleanups, especially for all tree
1534 manipulations</li>
1535 <li>cleanup of the headers, generation of a reference API definition in
1536 XML</li>
1537</ul>
1538
1539<h3>2.4.13: Jan 14 2002</h3>
Daniel Veillard744683d2002-01-14 17:30:20 +0000[diff] [blame]1540<ul>
1541 <li>update of the documentation: John Fleck and Charlie Bozeman</li>
1542 <li>cleanup of timing code from Justin Fletcher</li>
1543 <li>fixes for Windows and initial thread support on Win32: Igor and Serguei
1544 Narojnyi</li>
1545 <li>Cygwin patch from Robert Collins</li>
1546 <li>added xmlSetEntityReferenceFunc() for Keith Isdale work on xsldbg</li>
1547</ul>
1548
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]1549<h3>2.4.12: Dec 7 2001</h3>
1550<ul>
1551 <li>a few bug fixes: thread (Gary Pennington), xmllint (Geert Kloosterman),
1552 XML parser (Robin Berjon), XPointer (Danny Jamshy), I/O cleanups
1553 (robert)</li>
1554 <li>Eric Lavigne contributed project files for MacOS</li>
1555 <li>some makefiles cleanups</li>
1556</ul>
1557
Daniel Veillarda4871052001-11-26 13:19:48 +0000[diff] [blame]1558<h3>2.4.11: Nov 26 2001</h3>
1559<ul>
1560 <li>fixed a couple of errors in the includes, fixed a few bugs, some code
1561 cleanups</li>
1562 <li>xmllint man pages improvement by Heiko Rupp</li>
1563 <li>updated VMS build instructions from John A Fotheringham</li>
1564 <li>Windows Makefiles updates from Igor</li>
1565</ul>
1566
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]1567<h3>2.4.10: Nov 10 2001</h3>
1568<ul>
1569 <li>URI escaping fix (Joel Young)</li>
1570 <li>added xmlGetNodePath() (for paths or XPointers generation)</li>
1571 <li>Fixes namespace handling problems when using DTD and validation</li>
1572 <li>improvements on xmllint: Morus Walter patches for --format and
1573 --encode, Stefan Kost and Heiko Rupp improvements on the --shell</li>
1574 <li>fixes for xmlcatalog linking pointed by Weiqi Gao</li>
1575 <li>fixes to the HTML parser</li>
1576</ul>
1577
1578<h3>2.4.9: Nov 6 2001</h3>
1579<ul>
1580 <li>fixes more catalog bugs</li>
1581 <li>avoid a compilation problem, improve xmlGetLineNo()</li>
1582</ul>
1583
Daniel Veillarded421aa2001-11-04 21:22:45 +0000[diff] [blame]1584<h3>2.4.8: Nov 4 2001</h3>
1585<ul>
1586 <li>fixed SGML catalogs broken in previous release, updated xmlcatalog
1587 tool</li>
1588 <li>fixed a compile errors and some includes troubles.</li>
1589</ul>
1590
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]1591<h3>2.4.7: Oct 30 2001</h3>
1592<ul>
1593 <li>exported some debugging interfaces</li>
1594 <li>serious rewrite of the catalog code</li>
1595 <li>integrated Gary Pennington thread safety patch, added configure option
1596 and regression tests</li>
1597 <li>removed an HTML parser bug</li>
1598 <li>fixed a couple of potentially serious validation bugs</li>
1599 <li>integrated the SGML DocBook support in xmllint</li>
1600 <li>changed the nanoftp anonymous login passwd</li>
1601 <li>some I/O cleanup and a couple of interfaces for Perl wrapper</li>
1602 <li>general bug fixes</li>
1603 <li>updated xmllint man page by John Fleck</li>
1604 <li>some VMS and Windows updates</li>
1605</ul>
1606
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]1607<h3>2.4.6: Oct 10 2001</h3>
1608<ul>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]1609 <li>added an updated man pages by John Fleck</li>
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]1610 <li>portability and configure fixes</li>
1611 <li>an infinite loop on the HTML parser was removed (William)</li>
1612 <li>Windows makefile patches from Igor</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1613 <li>fixed half a dozen bugs reported for libxml or libxslt</li>
Daniel Veillard60087f32001-10-10 09:45:09 +0000[diff] [blame]1614 <li>updated xmlcatalog to be able to modify SGML super catalogs</li>
1615</ul>
1616
Daniel Veillarddadd0872001-09-15 09:21:44 +0000[diff] [blame]1617<h3>2.4.5: Sep 14 2001</h3>
1618<ul>
1619 <li>Remove a few annoying bugs in 2.4.4</li>
1620 <li>forces the HTML serializer to output decimal charrefs since some
1621 version of Netscape can't handle hexadecimal ones</li>
1622</ul>
1623
1624<h3>1.8.16: Sep 14 2001</h3>
1625<ul>
1626 <li>maintenance release of the old libxml1 branch, couple of bug and
1627 portability fixes</li>
1628</ul>
1629
Daniel Veillard04382ae2001-09-12 18:51:30 +0000[diff] [blame]1630<h3>2.4.4: Sep 12 2001</h3>
1631<ul>
1632 <li>added --convert to xmlcatalog, bug fixes and cleanups of XML
1633 Catalog</li>
1634 <li>a few bug fixes and some portability changes</li>
1635 <li>some documentation cleanups</li>
1636</ul>
1637
Daniel Veillard39936902001-08-24 00:49:01 +0000[diff] [blame]1638<h3>2.4.3: Aug 23 2001</h3>
1639<ul>
1640 <li>XML Catalog support see the doc</li>
1641 <li>New NaN/Infinity floating point code</li>
1642 <li>A few bug fixes</li>
1643</ul>
1644
1645<h3>2.4.2: Aug 15 2001</h3>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1646<ul>
1647 <li>adds xmlLineNumbersDefault() to control line number generation</li>
1648 <li>lot of bug fixes</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1649 <li>the Microsoft MSC projects files should now be up to date</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1650 <li>inheritance of namespaces from DTD defaulted attributes</li>
1651 <li>fixes a serious potential security bug</li>
1652 <li>added a --format option to xmllint</li>
1653</ul>
1654
1655<h3>2.4.1: July 24 2001</h3>
1656<ul>
1657 <li>possibility to keep line numbers in the tree</li>
1658 <li>some computation NaN fixes</li>
1659 <li>extension of the XPath API</li>
1660 <li>cleanup for alpha and ia64 targets</li>
1661 <li>patch to allow saving through HTTP PUT or POST</li>
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]1662</ul>
1663
1664<h3>2.4.0: July 10 2001</h3>
1665<ul>
1666 <li>Fixed a few bugs in XPath, validation, and tree handling.</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1667 <li>Fixed XML Base implementation, added a couple of examples to the
Daniel Veillard09ab7e12001-07-10 15:49:44 +0000[diff] [blame]1668 regression tests</li>
1669 <li>A bit of cleanup</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]1670</ul>
1671
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]1672<h3>2.3.14: July 5 2001</h3>
1673<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1674 <li>fixed some entities problems and reduce memory requirement when
1675 substituting them</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]1676 <li>lots of improvements in the XPath queries interpreter can be
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1677 substantially faster</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]1678 <li>Makefiles and configure cleanups</li>
1679 <li>Fixes to XPath variable eval, and compare on empty node set</li>
1680 <li>HTML tag closing bug fixed</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1681 <li>Fixed an URI reference computation problem when validating</li>
Daniel Veillard5b43fde2001-07-05 23:31:40 +0000[diff] [blame]1682</ul>
1683
Daniel Veillard2adbb512001-06-28 16:20:36 +0000[diff] [blame]1684<h3>2.3.13: June 28 2001</h3>
1685<ul>
1686 <li>2.3.12 configure.in was broken as well as the push mode XML parser</li>
1687 <li>a few more fixes for compilation on Windows MSC by Yon Derek</li>
1688</ul>
1689
1690<h3>1.8.14: June 28 2001</h3>
1691<ul>
1692 <li>Zbigniew Chyla gave a patch to use the old XML parser in push mode</li>
1693 <li>Small Makefile fix</li>
1694</ul>
1695
Daniel Veillard11648102001-06-26 16:08:24 +0000[diff] [blame]1696<h3>2.3.12: June 26 2001</h3>
1697<ul>
1698 <li>lots of cleanup</li>
1699 <li>a couple of validation fix</li>
1700 <li>fixed line number counting</li>
1701 <li>fixed serious problems in the XInclude processing</li>
1702 <li>added support for UTF8 BOM at beginning of entities</li>
1703 <li>fixed a strange gcc optimizer bugs in xpath handling of float, gcc-3.0
1704 miscompile uri.c (William), Thomas Leitner provided a fix for the
1705 optimizer on Tru64</li>
1706 <li>incorporated Yon Derek and Igor Zlatkovic fixes and improvements for
1707 compilation on Windows MSC</li>
1708 <li>update of libxml-doc.el (Felix Natter)</li>
1709 <li>fixed 2 bugs in URI normalization code</li>
1710</ul>
1711
Daniel Veillarde3c81b52001-06-17 14:50:34 +0000[diff] [blame]1712<h3>2.3.11: June 17 2001</h3>
1713<ul>
1714 <li>updates to trio, Makefiles and configure should fix some portability
1715 problems (alpha)</li>
1716 <li>fixed some HTML serialization problems (pre, script, and block/inline
1717 handling), added encoding aware APIs, cleanup of this code</li>
1718 <li>added xmlHasNsProp()</li>
1719 <li>implemented a specific PI for encoding support in the DocBook SGML
1720 parser</li>
1721 <li>some XPath fixes (-Infinity, / as a function parameter and namespaces
1722 node selection)</li>
1723 <li>fixed a performance problem and an error in the validation code</li>
1724 <li>fixed XInclude routine to implement the recursive behaviour</li>
1725 <li>fixed xmlFreeNode problem when libxml is included statically twice</li>
1726 <li>added --version to xmllint for bug reports</li>
1727</ul>
1728
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]1729<h3>2.3.10: June 1 2001</h3>
1730<ul>
1731 <li>fixed the SGML catalog support</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1732 <li>a number of reported bugs got fixed, in XPath, iconv detection,
1733 XInclude processing</li>
Daniel Veillard2e4f1882001-06-01 10:11:57 +0000[diff] [blame]1734 <li>XPath string function should now handle unicode correctly</li>
1735</ul>
1736
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]1737<h3>2.3.9: May 19 2001</h3>
1738
1739<p>Lots of bugfixes, and added a basic SGML catalog support:</p>
1740<ul>
1741 <li>HTML push bugfix #54891 and another patch from Jonas Borgström</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1742 <li>some serious speed optimization again</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]1743 <li>some documentation cleanups</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1744 <li>trying to get better linking on Solaris (-R)</li>
Daniel Veillard4623acd2001-05-19 15:13:15 +0000[diff] [blame]1745 <li>XPath API cleanup from Thomas Broyer</li>
1746 <li>Validation bug fixed #54631, added a patch from Gary Pennington, fixed
1747 xmlValidGetValidElements()</li>
1748 <li>Added an INSTALL file</li>
1749 <li>Attribute removal added to API: #54433</li>
1750 <li>added a basic support for SGML catalogs</li>
1751 <li>fixed xmlKeepBlanksDefault(0) API</li>
1752 <li>bugfix in xmlNodeGetLang()</li>
1753 <li>fixed a small configure portability problem</li>
1754 <li>fixed an inversion of SYSTEM and PUBLIC identifier in HTML document</li>
1755</ul>
1756
Daniel Veillarda265af72001-05-14 11:13:58 +0000[diff] [blame]1757<h3>1.8.13: May 14 2001</h3>
1758<ul>
1759 <li>bugfixes release of the old libxml1 branch used by Gnome</li>
1760</ul>
1761
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]1762<h3>2.3.8: May 3 2001</h3>
1763<ul>
1764 <li>Integrated an SGML DocBook parser for the Gnome project</li>
1765 <li>Fixed a few things in the HTML parser</li>
1766 <li>Fixed some XPath bugs raised by XSLT use, tried to fix the floating
1767 point portability issue</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1768 <li>Speed improvement (8M/s for SAX, 3M/s for DOM, 1.5M/s for
1769 DOM+validation using the XML REC as input and a 700MHz celeron).</li>
Daniel Veillard3bbbe6f2001-05-03 11:15:37 +0000[diff] [blame]1770 <li>incorporated more Windows cleanup</li>
1771 <li>added xmlSaveFormatFile()</li>
1772 <li>fixed problems in copying nodes with entities references (gdome)</li>
1773 <li>removed some troubles surrounding the new validation module</li>
1774</ul>
1775
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]1776<h3>2.3.7: April 22 2001</h3>
1777<ul>
1778 <li>lots of small bug fixes, corrected XPointer</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1779 <li>Non deterministic content model validation support</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]1780 <li>added xmlDocCopyNode for gdome2</li>
1781 <li>revamped the way the HTML parser handles end of tags</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1782 <li>XPath: corrections of namespaces support and number formatting</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]1783 <li>Windows: Igor Zlatkovic patches for MSC compilation</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1784 <li>HTML output fixes from P C Chow and William M. Brack</li>
Daniel Veillarda41123c2001-04-22 19:31:20 +0000[diff] [blame]1785 <li>Improved validation speed sensible for DocBook</li>
1786 <li>fixed a big bug with ID declared in external parsed entities</li>
1787 <li>portability fixes, update of Trio from Bjorn Reese</li>
1788</ul>
1789
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]1790<h3>2.3.6: April 8 2001</h3>
1791<ul>
1792 <li>Code cleanup using extreme gcc compiler warning options, found and
1793 cleared half a dozen potential problem</li>
1794 <li>the Eazel team found an XML parser bug</li>
1795 <li>cleaned up the user of some of the string formatting function. used the
1796 trio library code to provide the one needed when the platform is missing
1797 them</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1798 <li>xpath: removed a memory leak and fixed the predicate evaluation
1799 problem, extended the testsuite and cleaned up the result. XPointer seems
1800 broken ...</li>
Daniel Veillardafc73112001-04-11 11:51:41 +0000[diff] [blame]1801</ul>
1802
Daniel Veillard56a4cb82001-03-24 17:00:36 +0000[diff] [blame]1803<h3>2.3.5: Mar 23 2001</h3>
1804<ul>
1805 <li>Biggest change is separate parsing and evaluation of XPath expressions,
1806 there is some new APIs for this too</li>
1807 <li>included a number of bug fixes(XML push parser, 51876, notations,
1808 52299)</li>
1809 <li>Fixed some portability issues</li>
1810</ul>
1811
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]1812<h3>2.3.4: Mar 10 2001</h3>
1813<ul>
1814 <li>Fixed bugs #51860 and #51861</li>
1815 <li>Added a global variable xmlDefaultBufferSize to allow default buffer
1816 size to be application tunable.</li>
1817 <li>Some cleanup in the validation code, still a bug left and this part
1818 should probably be rewritten to support ambiguous content model :-\</li>
1819 <li>Fix a couple of serious bugs introduced or raised by changes in 2.3.3
1820 parser</li>
1821 <li>Fixed another bug in xmlNodeGetContent()</li>
1822 <li>Bjorn fixed XPath node collection and Number formatting</li>
1823 <li>Fixed a loop reported in the HTML parsing</li>
1824 <li>blank space are reported even if the Dtd content model proves that they
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1825 are formatting spaces, this is for XML conformance</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]1826</ul>
1827
Daniel Veillardb402c072001-03-01 17:28:58 +0000[diff] [blame]1828<h3>2.3.3: Mar 1 2001</h3>
1829<ul>
1830 <li>small change in XPath for XSLT</li>
1831 <li>documentation cleanups</li>
1832 <li>fix in validation by Gary Pennington</li>
1833 <li>serious parsing performances improvements</li>
1834</ul>
1835
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1836<h3>2.3.2: Feb 24 2001</h3>
Daniel Veillard71681102001-02-24 17:48:53 +0000[diff] [blame]1837<ul>
1838 <li>chasing XPath bugs, found a bunch, completed some TODO</li>
1839 <li>fixed a Dtd parsing bug</li>
1840 <li>fixed a bug in xmlNodeGetContent</li>
1841 <li>ID/IDREF support partly rewritten by Gary Pennington</li>
1842</ul>
1843
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1844<h3>2.3.1: Feb 15 2001</h3>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]1845<ul>
1846 <li>some XPath and HTML bug fixes for XSLT</li>
1847 <li>small extension of the hash table interfaces for DOM gdome2
1848 implementation</li>
1849 <li>A few bug fixes</li>
1850</ul>
1851
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1852<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]1853<ul>
1854 <li>Lots of XPath bug fixes</li>
1855 <li>Add a mode with Dtd lookup but without validation error reporting for
1856 XSLT</li>
1857 <li>Add support for text node without escaping (XSLT)</li>
1858 <li>bug fixes for xmlCheckFilename</li>
1859 <li>validation code bug fixes from Gary Pennington</li>
1860 <li>Patch from Paul D. Smith correcting URI path normalization</li>
1861 <li>Patch to allow simultaneous install of libxml-devel and
1862 libxml2-devel</li>
1863 <li>the example Makefile is now fixed</li>
1864 <li>added HTML to the RPM packages</li>
1865 <li>tree copying bugfixes</li>
1866 <li>updates to Windows makefiles</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1867 <li>optimization patch from Bjorn Reese</li>
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]1868</ul>
1869
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]1870<h3>2.2.11: Jan 4 2001</h3>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]1871<ul>
1872 <li>bunch of bug fixes (memory I/O, xpath, ftp/http, ...)</li>
1873 <li>added htmlHandleOmittedElem()</li>
1874 <li>Applied Bjorn Reese's IPV6 first patch</li>
1875 <li>Applied Paul D. Smith patches for validation of XInclude results</li>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]1876 <li>added XPointer xmlns() new scheme support</li>
Daniel Veillard503b8932001-01-05 06:36:31 +0000[diff] [blame]1877</ul>
1878
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]1879<h3>2.2.10: Nov 25 2000</h3>
Daniel Veillard9d343c42000-11-25 10:12:43 +0000[diff] [blame]1880<ul>
1881 <li>Fix the Windows problems of 2.2.8</li>
1882 <li>integrate OpenVMS patches</li>
1883 <li>better handling of some nasty HTML input</li>
1884 <li>Improved the XPointer implementation</li>
1885 <li>integrate a number of provided patches</li>
1886</ul>
1887
Daniel Veillard2ddd23d2000-11-25 10:42:19 +0000[diff] [blame]1888<h3>2.2.9: Nov 25 2000</h3>
1889<ul>
1890 <li>erroneous release :-(</li>
1891</ul>
1892
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]1893<h3>2.2.8: Nov 13 2000</h3>
1894<ul>
1895 <li>First version of <a href="http://www.w3.org/TR/xinclude">XInclude</a>
1896 support</li>
1897 <li>Patch in conditional section handling</li>
1898 <li>updated MS compiler project</li>
1899 <li>fixed some XPath problems</li>
1900 <li>added an URI escaping function</li>
1901 <li>some other bug fixes</li>
1902</ul>
1903
1904<h3>2.2.7: Oct 31 2000</h3>
1905<ul>
1906 <li>added message redirection</li>
1907 <li>XPath improvements (thanks TOM !)</li>
1908 <li>xmlIOParseDTD() added</li>
1909 <li>various small fixes in the HTML, URI, HTTP and XPointer support</li>
1910 <li>some cleanup of the Makefile, autoconf and the distribution content</li>
1911</ul>
1912
Daniel Veillard29a11cc2000-10-25 13:32:39 +0000[diff] [blame]1913<h3>2.2.6: Oct 25 2000:</h3>
1914<ul>
1915 <li>Added an hash table module, migrated a number of internal structure to
1916 those</li>
1917 <li>Fixed a posteriori validation problems</li>
1918 <li>HTTP module cleanups</li>
1919 <li>HTML parser improvements (tag errors, script/style handling, attribute
1920 normalization)</li>
1921 <li>coalescing of adjacent text nodes</li>
1922 <li>couple of XPath bug fixes, exported the internal API</li>
1923</ul>
1924
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]1925<h3>2.2.5: Oct 15 2000:</h3>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]1926<ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]1927 <li>XPointer implementation and testsuite</li>
1928 <li>Lot of XPath fixes, added variable and functions registration, more
1929 tests</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1930 <li>Portability fixes, lots of enhancements toward an easy Windows build
1931 and release</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]1932 <li>Late validation fixes</li>
1933 <li>Integrated a lot of contributed patches</li>
1934 <li>added memory management docs</li>
Daniel Veillardab8500d2000-10-15 21:06:19 +0000[diff] [blame]1935 <li>a performance problem when using large buffer seems fixed</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]1936</ul>
1937
1938<h3>2.2.4: Oct 1 2000:</h3>
1939<ul>
1940 <li>main XPath problem fixed</li>
1941 <li>Integrated portability patches for Windows</li>
1942 <li>Serious bug fixes on the URI and HTML code</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]1943</ul>
1944
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]1945<h3>2.2.3: Sep 17 2000</h3>
1946<ul>
1947 <li>bug fixes</li>
1948 <li>cleanup of entity handling code</li>
1949 <li>overall review of all loops in the parsers, all sprintf usage has been
1950 checked too</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]1951 <li>Far better handling of larges Dtd. Validating against DocBook XML Dtd
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]1952 works smoothly now.</li>
1953</ul>
1954
1955<h3>1.8.10: Sep 6 2000</h3>
1956<ul>
1957 <li>bug fix release for some Gnome projects</li>
1958</ul>
1959
1960<h3>2.2.2: August 12 2000</h3>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]1961<ul>
1962 <li>mostly bug fixes</li>
Daniel Veillardec78c0f2000-08-25 10:25:23 +0000[diff] [blame]1963 <li>started adding routines to access xml parser context options</li>
Daniel Veillard786d7c82000-08-12 23:38:57 +0000[diff] [blame]1964</ul>
1965
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]1966<h3>2.2.1: July 21 2000</h3>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]1967<ul>
1968 <li>a purely bug fixes release</li>
1969 <li>fixed an encoding support problem when parsing from a memory block</li>
1970 <li>fixed a DOCTYPE parsing problem</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]1971 <li>removed a bug in the function allowing to override the memory
1972 allocation routines</li>
Daniel Veillarda2679fa2000-07-22 02:38:15 +0000[diff] [blame]1973</ul>
1974
Daniel Veillardd5f97f82000-09-17 16:38:14 +0000[diff] [blame]1975<h3>2.2.0: July 14 2000</h3>
Daniel Veillard94e90602000-07-17 14:38:19 +0000[diff] [blame]1976<ul>
1977 <li>applied a lot of portability fixes</li>
1978 <li>better encoding support/cleanup and saving (content is now always
1979 encoded in UTF-8)</li>
1980 <li>the HTML parser now correctly handles encodings</li>
1981 <li>added xmlHasProp()</li>
1982 <li>fixed a serious problem with &amp;#38;</li>
1983 <li>propagated the fix to FTP client</li>
1984 <li>cleanup, bugfixes, etc ...</li>
1985 <li>Added a page about <a href="encoding.html">libxml Internationalization
1986 support</a></li>
1987</ul>
1988
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]1989<h3>1.8.9: July 9 2000</h3>
1990<ul>
1991 <li>fixed the spec the RPMs should be better</li>
1992 <li>fixed a serious bug in the FTP implementation, released 1.8.9 to solve
1993 rpmfind users problem</li>
1994</ul>
1995
Daniel Veillard6388e172000-07-03 16:07:19 +0000[diff] [blame]1996<h3>2.1.1: July 1 2000</h3>
1997<ul>
1998 <li>fixes a couple of bugs in the 2.1.0 packaging</li>
1999 <li>improvements on the HTML parser</li>
2000</ul>
2001
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]2002<h3>2.1.0 and 1.8.8: June 29 2000</h3>
2003<ul>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2004 <li>1.8.8 is mostly a commodity package for upgrading to libxml2 according
2005 to <a href="upgrade.html">new instructions</a>. It fixes a nasty problem
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]2006 about &amp;#38; charref parsing</li>
2007 <li>2.1.0 also ease the upgrade from libxml v1 to the recent version. it
2008 also contains numerous fixes and enhancements:
2009 <ul>
2010 <li>added xmlStopParser() to stop parsing</li>
2011 <li>improved a lot parsing speed when there is large CDATA blocs</li>
2012 <li>includes XPath patches provided by Picdar Technology</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2013 <li>tried to fix as much as possible DTD validation and namespace
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]2014 related problems</li>
2015 <li>output to a given encoding has been added/tested</li>
2016 <li>lot of various fixes</li>
2017 </ul>
2018 </li>
2019</ul>
2020
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]2021<h3>2.0.0: Apr 12 2000</h3>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2022<ul>
2023 <li>First public release of libxml2. If you are using libxml, it's a good
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2024 idea to check the 1.x to 2.x upgrade instructions. NOTE: while initially
2025 scheduled for Apr 3 the release occurred only on Apr 12 due to massive
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]2026 workload.</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2027 <li>The include are now located under $prefix/include/libxml (instead of
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]2028 $prefix/include/gnome-xml), they also are referenced by
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2029 <pre>#include &lt;libxml/xxx.h&gt;</pre>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]2030 <p>instead of</p>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2031 <pre>#include "xxx.h"</pre>
2032 </li>
Daniel Veillard8f621982000-03-20 13:07:15 +0000[diff] [blame]2033 <li>a new URI module for parsing URIs and following strictly RFC 2396</li>
2034 <li>the memory allocation routines used by libxml can now be overloaded
2035 dynamically by using xmlMemSetup()</li>
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2036 <li>The previously CVS only tool tester has been renamed
2037 <strong>xmllint</strong> and is now installed as part of the libxml2
2038 package</li>
Daniel Veillarde0aed302000-04-16 08:52:20 +0000[diff] [blame]2039 <li>The I/O interface has been revamped. There is now ways to plug in
2040 specific I/O modules, either at the URI scheme detection level using
2041 xmlRegisterInputCallbacks() or by passing I/O functions when creating a
2042 parser context using xmlCreateIOParserCtxt()</li>
2043 <li>there is a C preprocessor macro LIBXML_VERSION providing the version
2044 number of the libxml module in use</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2045 <li>a number of optional features of libxml can now be excluded at
2046 configure time (FTP/HTTP/HTML/XPath/Debug)</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2047</ul>
2048
2049<h3>2.0.0beta: Mar 14 2000</h3>
2050<ul>
2051 <li>This is a first Beta release of libxml version 2</li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]2052 <li>It's available only from<a href="ftp://xmlsoft.org/">xmlsoft.org
2053 FTP</a>, it's packaged as libxml2-2.0.0beta and available as tar and
2054 RPMs</li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2055 <li>This version is now the head in the Gnome CVS base, the old one is
2056 available under the tag LIB_XML_1_X</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2057 <li>This includes a very large set of changes. From a programmatic point
2058 of view applications should not have to be modified too much, check the
2059 <a href="upgrade.html">upgrade page</a></li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2060 <li>Some interfaces may changes (especially a bit about encoding).</li>
2061 <li>the updates includes:
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]2062 <ul>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2063 <li>fix I18N support. ISO-Latin-x/UTF-8/UTF-16 (nearly) seems correctly
2064 handled now</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2065 <li>Better handling of entities, especially well-formedness checking
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2066 and proper PEref extensions in external subsets</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]2067 <li>DTD conditional sections</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2068 <li>Validation now correctly handle entities content</li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]2069 <li><a href="http://rpmfind.net/tools/gdome/messages/0039.html">change
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2070 structures to accommodate DOM</a></li>
Daniel Veillard6c8b1172000-03-01 00:40:41 +0000[diff] [blame]2071 </ul>
2072 </li>
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2073 <li>Serious progress were made toward compliance, <a
2074 href="conf/result.html">here are the result of the test</a> against the
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2075 OASIS testsuite (except the Japanese tests since I don't support that
Daniel Veillardedfb29b2000-03-14 19:59:05 +0000[diff] [blame]2076 encoding yet). This URL is rebuilt every couple of hours using the CVS
2077 head version.</li>
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]2078</ul>
2079
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2080<h3>1.8.7: Mar 6 2000</h3>
2081<ul>
2082 <li>This is a bug fix release:</li>
2083 <li>It is possible to disable the ignorable blanks heuristic used by
2084 libxml-1.x, a new function xmlKeepBlanksDefault(0) will allow this. Note
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2085 that for adherence to XML spec, this behaviour will be disabled by
2086 default in 2.x . The same function will allow to keep compatibility for
2087 old code.</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2088 <li>Blanks in &lt;a&gt; &lt;/a&gt; constructs are not ignored anymore,
2089 avoiding heuristic is really the Right Way :-\</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2090 <li>The unchecked use of snprintf which was breaking libxml-1.8.6
2091 compilation on some platforms has been fixed</li>
2092 <li>nanoftp.c nanohttp.c: Fixed '#' and '?' stripping when processing
2093 URIs</li>
2094</ul>
2095
Daniel Veillarde41f2b72000-01-30 20:00:07 +0000[diff] [blame]2096<h3>1.8.6: Jan 31 2000</h3>
2097<ul>
2098 <li>added a nanoFTP transport module, debugged until the new version of <a
2099 href="http://rpmfind.net/linux/rpm2html/rpmfind.html">rpmfind</a> can use
2100 it without troubles</li>
Daniel Veillardda07c342000-01-25 18:31:22 +0000[diff] [blame]2101</ul>
2102
2103<h3>1.8.5: Jan 21 2000</h3>
2104<ul>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2105 <li>adding APIs to parse a well balanced chunk of XML (production <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2106 href="http://www.w3.org/TR/REC-xml#NT-content">[43] content</a> of the
2107 XML spec)</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]2108 <li>fixed a hideous bug in xmlGetProp pointed by Rune.Djurhuus@fast.no</li>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2109 <li>Jody Goldberg &lt;jgoldberg@home.com&gt; provided another patch trying
2110 to solve the zlib checks problems</li>
Daniel Veillard461a66c2000-01-18 18:01:01 +0000[diff] [blame]2111 <li>The current state in gnome CVS base is expected to ship as 1.8.5 with
2112 gnumeric soon</li>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2113</ul>
2114
2115<h3>1.8.4: Jan 13 2000</h3>
2116<ul>
2117 <li>bug fixes, reintroduced xmlNewGlobalNs(), fixed xmlNewNs()</li>
2118 <li>all exit() call should have been removed from libxml</li>
2119 <li>fixed a problem with INCLUDE_WINSOCK on WIN32 platform</li>
2120 <li>added newDocFragment()</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]2121</ul>
2122
2123<h3>1.8.3: Jan 5 2000</h3>
2124<ul>
2125 <li>a Push interface for the XML and HTML parsers</li>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2126 <li>a shell-like interface to the document tree (try tester --shell :-)</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2127 <li>lots of bug fixes and improvement added over XMas holidays</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]2128 <li>fixed the DTD parsing code to work with the xhtml DTD</li>
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]2129 <li>added xmlRemoveProp(), xmlRemoveID() and xmlRemoveRef()</li>
2130 <li>Fixed bugs in xmlNewNs()</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]2131 <li>External entity loading code has been revamped, now it uses
Daniel Veillardf84f71f2000-01-05 19:54:23 +0000[diff] [blame]2132 xmlLoadExternalEntity(), some fix on entities processing were added</li>
Daniel Veillard437b87b2000-01-03 17:30:46 +0000[diff] [blame]2133 <li>cleaned up WIN32 includes of socket stuff</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]2134</ul>
2135
2136<h3>1.8.2: Dec 21 1999</h3>
2137<ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]2138 <li>I got another problem with includes and C++, I hope this issue is fixed
2139 for good this time</li>
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]2140 <li>Added a few tree modification functions: xmlReplaceNode,
2141 xmlAddPrevSibling, xmlAddNextSibling, xmlNodeSetName and
2142 xmlDocSetRootElement</li>
2143 <li>Tried to improve the HTML output with help from <a
2144 href="mailto:clahey@umich.edu">Chris Lahey</a></li>
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]2145</ul>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]2146
Daniel Veillarde4e51311999-12-18 15:32:46 +0000[diff] [blame]2147<h3>1.8.1: Dec 18 1999</h3>
2148<ul>
2149 <li>various patches to avoid troubles when using libxml with C++ compilers
2150 the "namespace" keyword and C escaping in include files</li>
2151 <li>a problem in one of the core macros IS_CHAR was corrected</li>
2152 <li>fixed a bug introduced in 1.8.0 breaking default namespace processing,
2153 and more specifically the Dia application</li>
Daniel Veillard944b5ff1999-12-15 19:08:24 +0000[diff] [blame]2154 <li>fixed a posteriori validation (validation after parsing, or by using a
2155 Dtd not specified in the original document)</li>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]2156 <li>fixed a bug in</li>
Daniel Veillard10a2c651999-12-12 13:03:50 +0000[diff] [blame]2157</ul>
2158
2159<h3>1.8.0: Dec 12 1999</h3>
2160<ul>
2161 <li>cleanup, especially memory wise</li>
2162 <li>the parser should be more reliable, especially the HTML one, it should
2163 not crash, whatever the input !</li>
2164 <li>Integrated various patches, especially a speedup improvement for large
2165 dataset from <a href="mailto:cnygard@bellatlantic.net">Carl Nygard</a>,
2166 configure with --with-buffers to enable them.</li>
2167 <li>attribute normalization, oops should have been added long ago !</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2168 <li>attributes defaulted from DTDs should be available, xmlSetProp() now
2169 does entities escaping by default.</li>
Daniel Veillard4c3a2031999-11-19 17:46:26 +0000[diff] [blame]2170</ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]2171
2172<h3>1.7.4: Oct 25 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2173<ul>
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]2174 <li>Lots of HTML improvement</li>
2175 <li>Fixed some errors when saving both XML and HTML</li>
2176 <li>More examples, the regression tests should now look clean</li>
2177 <li>Fixed a bug with contiguous charref</li>
2178</ul>
2179
2180<h3>1.7.3: Sep 29 1999</h3>
2181<ul>
2182 <li>portability problems fixed</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2183 <li>snprintf was used unconditionally, leading to link problems on system
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]2184 were it's not available, fixed</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2185</ul>
2186
2187<h3>1.7.1: Sep 24 1999</h3>
2188<ul>
2189 <li>The basic type for strings manipulated by libxml has been renamed in
2190 1.7.1 from <strong>CHAR</strong> to <strong>xmlChar</strong>. The reason
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2191 is that CHAR was conflicting with a predefined type on Windows. However
2192 on non WIN32 environment, compatibility is provided by the way of a
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2193 <strong>#define </strong>.</li>
2194 <li>Changed another error : the use of a structure field called errno, and
2195 leading to troubles on platforms where it's a macro</li>
2196</ul>
2197
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2198<h3>1.7.0: Sep 23 1999</h3>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2199<ul>
2200 <li>Added the ability to fetch remote DTD or parsed entities, see the <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]2201 href="html/libxml-nanohttp.html">nanohttp</a> module.</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2202 <li>Added an errno to report errors by another mean than a simple printf
2203 like callback</li>
2204 <li>Finished ID/IDREF support and checking when validation</li>
2205 <li>Serious memory leaks fixed (there is now a <a
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]2206 href="html/libxml-xmlmemory.html">memory wrapper</a> module)</li>
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2207 <li>Improvement of <a href="http://www.w3.org/TR/xpath">XPath</a>
2208 implementation</li>
2209 <li>Added an HTML parser front-end</li>
2210</ul>
2211
2212<h2><a name="XML">XML</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2213
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]2214<p><a href="http://www.w3.org/TR/REC-xml">XML is a standard</a> for
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2215markup-based structured documents. Here is <a name="example">an example XML
2216document</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]2217<pre>&lt;?xml version="1.0"?&gt;
2218&lt;EXAMPLE prop1="gnome is great" prop2="&amp;amp; linux too"&gt;
2219 &lt;head&gt;
2220 &lt;title&gt;Welcome to Gnome&lt;/title&gt;
2221 &lt;/head&gt;
2222 &lt;chapter&gt;
2223 &lt;title&gt;The Linux adventure&lt;/title&gt;
2224 &lt;p&gt;bla bla bla ...&lt;/p&gt;
2225 &lt;image href="linus.gif"/&gt;
2226 &lt;p&gt;...&lt;/p&gt;
2227 &lt;/chapter&gt;
2228&lt;/EXAMPLE&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2229
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2230<p>The first line specifies that it is an XML document and gives useful
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2231information about its encoding. Then the rest of the document is a text
2232format whose structure is specified by tags between brackets. <strong>Each
2233tag opened has to be closed</strong>. XML is pedantic about this. However, if
2234a tag is empty (no content), a single tag can serve as both the opening and
2235closing tag if it ends with <code>/&gt;</code> rather than with
2236<code>&gt;</code>. Note that, for example, the image tag has no content (just
2237an attribute) and is closed by ending the tag with <code>/&gt;</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]2238
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2239<p>XML can be applied successfully to a wide range of tasks, ranging from
2240long term structured document maintenance (where it follows the steps of
2241SGML) to simple data encoding mechanisms like configuration file formatting
2242(glade), spreadsheets (gnumeric), or even shorter lived documents such as
2243WebDAV where it is used to encode remote calls between a client and a
2244server.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2245
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2246<h2><a name="XSLT">XSLT</a></h2>
2247
Daniel Veillard6e6a6cc2001-02-15 15:55:44 +0000[diff] [blame]2248<p>Check <a href="http://xmlsoft.org/XSLT">the separate libxslt page</a></p>
2249
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2250<p><a href="http://www.w3.org/TR/xslt">XSL Transformations</a>, is a
2251language for transforming XML documents into other XML documents (or
2252HTML/textual output).</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2253
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]2254<p>A separate library called libxslt is available implementing XSLT-1.0 for
2255libxml2. This module "libxslt" too can be found in the Gnome CVS base.</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2256
Daniel Veillard383b1472001-01-23 11:39:52 +0000[diff] [blame]2257<p>You can check the <a
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2258href="http://cvs.gnome.org/lxr/source/libxslt/FEATURES">features</a>
2259supported and the progresses on the <a
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2260href="http://cvs.gnome.org/lxr/source/libxslt/ChangeLog"
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2261name="Changelog">Changelog</a>.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2262
2263<h2><a name="Python">Python and bindings</a></h2>
2264
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2265<p>There are a number of language bindings and wrappers available for
2266libxml2, the list below is not exhaustive. Please contact the <a
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2267href="http://mail.gnome.org/mailman/listinfo/xml-bindings">xml-bindings@gnome.org</a>
2268(<a href="http://mail.gnome.org/archives/xml-bindings/">archives</a>) in
2269order to get updates to this list or to discuss the specific topic of libxml2
2270or libxslt wrappers or bindings:</p>
2271<ul>
Daniel Veillardc14401e2002-11-20 14:28:17 +0000[diff] [blame]2272 <li><a href="http://libxmlplusplus.sourceforge.net/">Libxml++</a> seems the
2273 most up-to-date C++ bindings for libxml2, check the <a
2274 href="http://libxmlplusplus.sourceforge.net/reference/html/hierarchy.html">documentation</a>
2275 and the <a
2276 href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/libxmlplusplus/libxml%2b%2b/examples/">examples</a>.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2277 <li>There is another <a href="http://libgdome-cpp.berlios.de/">C++ wrapper
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2278 based on the gdome2 bindings</a> maintained by Tobias Peters.</li>
Daniel Veillard9b6fd302002-05-13 12:06:47 +0000[diff] [blame]2279 <li>and a third C++ wrapper by Peter Jones &lt;pjones@pmade.org&gt;
2280 <p>Website: <a
2281 href="http://pmade.org/pjones/software/xmlwrapp/">http://pmade.org/pjones/software/xmlwrapp/</a></p>
2282 </li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2283 <li><a
2284 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2285 Sergeant</a> developed <a
2286 href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2287 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2288 application server</a>.</li>
Daniel Veillard4ac494b2003-09-18 15:08:00 +0000[diff] [blame]2289 <li>If you're interested into scripting XML processing, have a look at <a
2290 href="http://xsh.sourceforge.net/">XSH</a> an XML editing shell based on
2291 Libxml2 Perl bindings.</li>
Daniel Veillard21473672002-06-17 07:29:22 +0000[diff] [blame]2292 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provides an
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2293 earlier version of the libxml/libxslt <a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2294 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a>.</li>
Daniel Veillard21473672002-06-17 07:29:22 +0000[diff] [blame]2295 <li>Gopal.V and Peter Minten develop <a
2296 href="http://savannah.gnu.org/projects/libxmlsharp">libxml#</a>, a set of
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2297 C# libxml2 bindings.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2298 <li>Petr Kozelka provides <a
2299 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2300 libxml2</a> with Kylix, Delphi and other Pascal compilers.</li>
Daniel Veillardb2fb8ed2002-04-01 09:33:12 +0000[diff] [blame]2301 <li>Uwe Fechner also provides <a
2302 href="http://sourceforge.net/projects/idom2-pas/">idom2</a>, a DOM2
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2303 implementation for Kylix2/D5/D6 from Borland.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2304 <li>Wai-Sun "Squidster" Chia provides <a
2305 href="http://www.rubycolor.org/arc/redist/">bindings for Ruby</a> and
2306 libxml2 bindings are also available in Ruby through the <a
2307 href="http://libgdome-ruby.berlios.de/">libgdome-ruby</a> module
2308 maintained by Tobias Peters.</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2309 <li>Steve Ball and contributors maintains <a
2310 href="http://tclxml.sourceforge.net/">libxml2 and libxslt bindings for
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2311 Tcl</a>.</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2312 <li>There is support for libxml2 in the DOM module of PHP.</li>
Daniel Veillard41b01a82003-02-27 11:09:06 +0000[diff] [blame]2313 <li><a href="http://savannah.gnu.org/projects/classpathx/">LibxmlJ</a> is
Daniel Veillard806cada2003-03-19 21:58:59 +0000[diff] [blame]2314 an effort to create a 100% JAXP-compatible Java wrapper for libxml2 and
2315 libxslt as part of GNU ClasspathX project.</li>
Daniel Veillard6d373a22003-11-04 10:26:43 +0000[diff] [blame]2316 <li>Patrick McPhee provides Rexx bindings fof libxml2 and libxslt, look for
2317 <a href="http://www.interlog.com/~ptjm/software.html">RexxXML</a>.</li>
Daniel Veillardb78757b2004-12-30 21:30:23 +0000[diff] [blame]2318 <li><a href="http://www.satimage.fr/software/en/xml_suite.html">Satimage</a>
2319 provides <a
2320 href="http://www.satimage.fr/software/en/downloads_osaxen.html">XMLLib
2321 osax</a>. This is an osax for Mac OS X with a set of commands to
2322 implement in AppleScript the XML DOM, XPATH and XSLT. Also includes
Daniel Veillardc7426092005-01-05 15:11:41 +0000[diff] [blame]2323 commands for Property-lists (Apple's fast lookup table XML format.)</li>
2324 <li>Francesco Montorsi developped
2325<a href="https://sourceforge.net/project/showfiles.php?group_id=51305&amp;package_id=45182">wxXml2</a>
2326 wrappers that interface libxml2, allowing wxWidgets applications to
2327 load/save/edit XML instances.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2328</ul>
2329
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2330<p>The distribution includes a set of Python bindings, which are guaranteed
2331to be maintained as part of the library in the future, though the Python
Daniel Veillard41b01a82003-02-27 11:09:06 +0000[diff] [blame]2332interface have not yet reached the completeness of the C API.</p>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2333
Daniel Veillard27907c72002-12-16 16:05:58 +0000[diff] [blame]2334<p><a href="mailto:stephane.bidoul@softwareag.com">Stéphane Bidoul</a>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2335maintains <a href="http://users.skynet.be/sbi/libxml-python/">a Windows port
2336of the Python bindings</a>.</p>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2337
Daniel Veillard7ef0fcb2002-12-14 10:38:55 +0000[diff] [blame]2338<p>Note to people interested in building bindings, the API is formalized as
2339<a href="libxml2-api.xml">an XML API description file</a> which allows to
2340automate a large part of the Python bindings, this includes function
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]2341descriptions, enums, structures, typedefs, etc... The Python script used to
2342build the bindings is python/generator.py in the source distribution.</p>
Daniel Veillard7ef0fcb2002-12-14 10:38:55 +0000[diff] [blame]2343
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2344<p>To install the Python bindings there are 2 options:</p>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000[diff] [blame]2345<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2346 <li>If you use an RPM based distribution, simply install the <a
2347 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxml2-python">libxml2-python
2348 RPM</a> (and if needed the <a
2349 href="http://rpmfind.net/linux/rpm2html/search.php?query=libxslt-python">libxslt-python
2350 RPM</a>).</li>
2351 <li>Otherwise use the <a href="ftp://xmlsoft.org/python/">libxml2-python
2352 module distribution</a> corresponding to your installed version of
2353 libxml2 and libxslt. Note that to install it you will need both libxml2
2354 and libxslt installed and run "python setup.py build install" in the
2355 module tree.</li>
Daniel Veillard0b79dfe2002-02-23 13:02:31 +0000[diff] [blame]2356</ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2357
2358<p>The distribution includes a set of examples and regression tests for the
2359python bindings in the <code>python/tests</code> directory. Here are some
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2360excerpts from those tests:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2361
2362<h3>tst.py:</h3>
2363
2364<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]2365<pre>import libxml2, sys
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2366
2367doc = libxml2.parseFile("tst.xml")
2368if doc.name != "tst.xml":
2369 print "doc.name failed"
2370 sys.exit(1)
2371root = doc.children
2372if root.name != "doc":
2373 print "root.name failed"
2374 sys.exit(1)
2375child = root.children
2376if child.name != "foo":
2377 print "child.name failed"
2378 sys.exit(1)
2379doc.freeDoc()</pre>
2380
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2381<p>The Python module is called libxml2; parseFile is the equivalent of
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2382xmlParseFile (most of the bindings are automatically generated, and the xml
2383prefix is removed and the casing convention are kept). All node seen at the
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2384binding level share the same subset of accessors:</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2385<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2386 <li><code>name</code> : returns the node name</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2387 <li><code>type</code> : returns a string indicating the node type</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2388 <li><code>content</code> : returns the content of the node, it is based on
2389 xmlNodeGetContent() and hence is recursive.</li>
2390 <li><code>parent</code> , <code>children</code>, <code>last</code>,
2391 <code>next</code>, <code>prev</code>, <code>doc</code>,
2392 <code>properties</code>: pointing to the associated element in the tree,
2393 those may return None in case no such link exists.</li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2394</ul>
2395
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2396<p>Also note the need to explicitly deallocate documents with freeDoc() .
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2397Reference counting for libxml2 trees would need quite a lot of work to
2398function properly, and rather than risk memory leaks if not implemented
2399correctly it sounds safer to have an explicit function to free a tree. The
2400wrapper python objects like doc, root or child are them automatically garbage
2401collected.</p>
2402
2403<h3>validate.py:</h3>
2404
2405<p>This test check the validation interfaces and redirection of error
2406messages:</p>
2407<pre>import libxml2
2408
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2409#deactivate error messages from the validation
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2410def noerr(ctx, str):
2411 pass
2412
2413libxml2.registerErrorHandler(noerr, None)
2414
2415ctxt = libxml2.createFileParserCtxt("invalid.xml")
2416ctxt.validate(1)
2417ctxt.parseDocument()
2418doc = ctxt.doc()
2419valid = ctxt.isValid()
2420doc.freeDoc()
2421if valid != 0:
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2422 print "validity check failed"</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2423
2424<p>The first thing to notice is the call to registerErrorHandler(), it
2425defines a new error handler global to the library. It is used to avoid seeing
2426the error messages when trying to validate the invalid document.</p>
2427
2428<p>The main interest of that test is the creation of a parser context with
2429createFileParserCtxt() and how the behaviour can be changed before calling
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2430parseDocument() . Similarly the informations resulting from the parsing phase
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2431are also available using context methods.</p>
2432
2433<p>Contexts like nodes are defined as class and the libxml2 wrappers maps the
2434C function interfaces in terms of objects method as much as possible. The
2435best to get a complete view of what methods are supported is to look at the
2436libxml2.py module containing all the wrappers.</p>
2437
2438<h3>push.py:</h3>
2439
2440<p>This test show how to activate the push parser interface:</p>
2441<pre>import libxml2
2442
2443ctxt = libxml2.createPushParser(None, "&lt;foo", 4, "test.xml")
2444ctxt.parseChunk("/&gt;", 2, 1)
2445doc = ctxt.doc()
2446
2447doc.freeDoc()</pre>
2448
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2449<p>The context is created with a special call based on the
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2450xmlCreatePushParser() from the C library. The first argument is an optional
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2451SAX callback object, then the initial set of data, the length and the name of
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2452the resource in case URI-References need to be computed by the parser.</p>
2453
2454<p>Then the data are pushed using the parseChunk() method, the last call
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2455setting the third argument terminate to 1.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2456
2457<h3>pushSAX.py:</h3>
2458
2459<p>this test show the use of the event based parsing interfaces. In this case
2460the parser does not build a document, but provides callback information as
2461the parser makes progresses analyzing the data being provided:</p>
2462<pre>import libxml2
2463log = ""
2464
2465class callback:
2466 def startDocument(self):
2467 global log
2468 log = log + "startDocument:"
2469
2470 def endDocument(self):
2471 global log
2472 log = log + "endDocument:"
2473
2474 def startElement(self, tag, attrs):
2475 global log
2476 log = log + "startElement %s %s:" % (tag, attrs)
2477
2478 def endElement(self, tag):
2479 global log
2480 log = log + "endElement %s:" % (tag)
2481
2482 def characters(self, data):
2483 global log
2484 log = log + "characters: %s:" % (data)
2485
2486 def warning(self, msg):
2487 global log
2488 log = log + "warning: %s:" % (msg)
2489
2490 def error(self, msg):
2491 global log
2492 log = log + "error: %s:" % (msg)
2493
2494 def fatalError(self, msg):
2495 global log
2496 log = log + "fatalError: %s:" % (msg)
2497
2498handler = callback()
2499
2500ctxt = libxml2.createPushParser(handler, "&lt;foo", 4, "test.xml")
2501chunk = " url='tst'&gt;b"
2502ctxt.parseChunk(chunk, len(chunk), 0)
2503chunk = "ar&lt;/foo&gt;"
2504ctxt.parseChunk(chunk, len(chunk), 1)
2505
Daniel Veillardfcbfa2d2002-02-21 17:54:27 +0000[diff] [blame]2506reference = "startDocument:startElement foo {'url': 'tst'}:" + \
2507 "characters: bar:endElement foo:endDocument:"
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2508if log != reference:
2509 print "Error got: %s" % log
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2510 print "Expected: %s" % reference</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2511
2512<p>The key object in that test is the handler, it provides a number of entry
2513points which can be called by the parser as it makes progresses to indicate
2514the information set obtained. The full set of callback is larger than what
2515the callback class in that specific example implements (see the SAX
2516definition for a complete list). The wrapper will only call those supplied by
2517the object when activated. The startElement receives the names of the element
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2518and a dictionary containing the attributes carried by this element.</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2519
2520<p>Also note that the reference string generated from the callback shows a
2521single character call even though the string "bar" is passed to the parser
2522from 2 different call to parseChunk()</p>
2523
2524<h3>xpath.py:</h3>
2525
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2526<p>This is a basic test of XPath wrappers support</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2527<pre>import libxml2
2528
2529doc = libxml2.parseFile("tst.xml")
2530ctxt = doc.xpathNewContext()
2531res = ctxt.xpathEval("//*")
2532if len(res) != 2:
2533 print "xpath query: wrong node set size"
2534 sys.exit(1)
2535if res[0].name != "doc" or res[1].name != "foo":
2536 print "xpath query: wrong node set value"
2537 sys.exit(1)
2538doc.freeDoc()
2539ctxt.xpathFreeContext()</pre>
2540
2541<p>This test parses a file, then create an XPath context to evaluate XPath
2542expression on it. The xpathEval() method execute an XPath query and returns
2543the result mapped in a Python way. String and numbers are natively converted,
2544and node sets are returned as a tuple of libxml2 Python nodes wrappers. Like
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2545the document, the XPath context need to be freed explicitly, also not that
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2546the result of the XPath query may point back to the document tree and hence
2547the document must be freed after the result of the query is used.</p>
2548
2549<h3>xpathext.py:</h3>
2550
2551<p>This test shows how to extend the XPath engine with functions written in
2552python:</p>
2553<pre>import libxml2
2554
2555def foo(ctx, x):
2556 return x + 1
2557
2558doc = libxml2.parseFile("tst.xml")
2559ctxt = doc.xpathNewContext()
2560libxml2.registerXPathFunction(ctxt._o, "foo", None, foo)
2561res = ctxt.xpathEval("foo(1)")
2562if res != 2:
2563 print "xpath extension failure"
2564doc.freeDoc()
2565ctxt.xpathFreeContext()</pre>
2566
2567<p>Note how the extension function is registered with the context (but that
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2568part is not yet finalized, this may change slightly in the future).</p>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2569
2570<h3>tstxpath.py:</h3>
2571
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2572<p>This test is similar to the previous one but shows how the extension
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2573function can access the XPath evaluation context:</p>
2574<pre>def foo(ctx, x):
2575 global called
2576
2577 #
2578 # test that access to the XPath evaluation contexts
2579 #
2580 pctxt = libxml2.xpathParserContext(_obj=ctx)
2581 ctxt = pctxt.context()
2582 called = ctxt.function()
2583 return x + 1</pre>
2584
2585<p>All the interfaces around the XPath parser(or rather evaluation) context
2586are not finalized, but it should be sufficient to do contextual work at the
2587evaluation point.</p>
2588
2589<h3>Memory debugging:</h3>
2590
2591<p>last but not least, all tests starts with the following prologue:</p>
2592<pre>#memory debug specific
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2593libxml2.debugMemory(1)</pre>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2594
2595<p>and ends with the following epilogue:</p>
2596<pre>#memory debug specific
2597libxml2.cleanupParser()
2598if libxml2.debugMemory(1) == 0:
2599 print "OK"
2600else:
2601 print "Memory leak %d bytes" % (libxml2.debugMemory(1))
2602 libxml2.dumpMemory()</pre>
2603
2604<p>Those activate the memory debugging interface of libxml2 where all
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2605allocated block in the library are tracked. The prologue then cleans up the
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]2606library state and checks that all allocated memory has been freed. If not it
2607calls dumpMemory() which saves that list in a <code>.memdump</code> file.</p>
Daniel Veillard82687162001-01-22 15:32:01 +0000[diff] [blame]2608
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2609<h2><a name="architecture">libxml2 architecture</a></h2>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2610
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]2611<p>Libxml2 is made of multiple components; some of them are optional, and
2612most of the block interfaces are public. The main components are:</p>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2613<ul>
2614 <li>an Input/Output layer</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2615 <li>FTP and HTTP client layers (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2616 <li>an Internationalization layer managing the encodings support</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2617 <li>a URI module</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2618 <li>the XML parser and its basic SAX interface</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2619 <li>an HTML parser using the same SAX interface (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2620 <li>a SAX tree module to build an in-memory DOM representation</li>
2621 <li>a tree module to manipulate the DOM representation</li>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2622 <li>a validation module using the DOM representation (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2623 <li>an XPath module for global lookup in a DOM representation
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2624 (optional)</li>
2625 <li>a debug module (optional)</li>
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2626</ul>
2627
2628<p>Graphically this gives the following:</p>
2629
2630<p><img src="libxml.gif" alt="a graphical view of the various"></p>
2631
2632<p></p>
2633
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2634<h2><a name="tree">The tree output</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2635
2636<p>The parser returns a tree built during the document analysis. The value
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]2637returned is an <strong>xmlDocPtr</strong> (i.e., a pointer to an
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2638<strong>xmlDoc</strong> structure). This structure contains information such
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]2639as the file name, the document type, and a <strong>children</strong> pointer
2640which is the root of the document (or more exactly the first child under the
2641root which is the document). The tree is made of <strong>xmlNode</strong>s,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2642chained in double-linked lists of siblings and with a children&lt;-&gt;parent
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]2643relationship. An xmlNode can also carry properties (a chain of xmlAttr
2644structures). An attribute may have a value which is a list of TEXT or
2645ENTITY_REF nodes.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2646
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2647<p>Here is an example (erroneous with respect to the XML spec since there
2648should be only one ELEMENT under the root):</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2649
2650<p><img src="structure.gif" alt=" structure.gif "></p>
2651
2652<p>In the source package there is a small program (not installed by default)
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]2653called <strong>xmllint</strong> which parses XML files given as argument and
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2654prints them back as parsed. This is useful for detecting errors both in XML
2655code and in the XML parser itself. It has an option <strong>--debug</strong>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]2656which prints the actual in-memory structure of the document; here is the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]2657result with the <a href="#example">example</a> given before:</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2658<pre>DOCUMENT
2659version=1.0
2660standalone=true
2661 ELEMENT EXAMPLE
2662 ATTRIBUTE prop1
2663 TEXT
2664 content=gnome is great
2665 ATTRIBUTE prop2
2666 ENTITY_REF
2667 TEXT
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]2668 content= linux too
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]2669 ELEMENT head
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2670 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2671 TEXT
2672 content=Welcome to Gnome
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2673 ELEMENT chapter
2674 ELEMENT title
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2675 TEXT
2676 content=The Linux adventure
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2677 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2678 TEXT
2679 content=bla bla bla ...
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]2680 ELEMENT image
2681 ATTRIBUTE href
2682 TEXT
2683 content=linus.gif
2684 ELEMENT p
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]2685 TEXT
2686 content=...</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]2687
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2688<p>This should be useful for learning the internal representation model.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]2689
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]2690<h2><a name="interface">The SAX interface</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2691
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]2692<p>Sometimes the DOM tree output is just too large to fit reasonably into
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2693memory. In that case (and if you don't expect to save back the XML document
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]2694loaded using libxml), it's better to use the SAX interface of libxml. SAX is
2695a <strong>callback-based interface</strong> to the parser. Before parsing,
2696the application layer registers a customized set of callbacks which are
2697called by the library as it progresses through the XML input.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2698
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2699<p>To get more detailed step-by-step guidance on using the SAX interface of
Daniel Veillard4540be42000-08-19 16:40:28 +0000[diff] [blame]2700libxml, see the <a
2701href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
2702documentation</a>.written by <a href="mailto:james@daa.com.au">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2703Henstridge</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2704
2705<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
2706program located in the gnome-xml module (it's usually not shipped in the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2707binary packages of libxml, but you can find it in the tar source
Daniel Veillard402e8c82000-02-29 22:57:47 +0000[diff] [blame]2708distribution). Here is the sequence of callbacks that would be reported by
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]2709testSAX when parsing the example XML document shown earlier:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2710<pre>SAX.setDocumentLocator()
2711SAX.startDocument()
2712SAX.getEntity(amp)
2713SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
2714SAX.characters( , 3)
2715SAX.startElement(head)
2716SAX.characters( , 4)
2717SAX.startElement(title)
2718SAX.characters(Welcome to Gnome, 16)
2719SAX.endElement(title)
2720SAX.characters( , 3)
2721SAX.endElement(head)
2722SAX.characters( , 3)
2723SAX.startElement(chapter)
2724SAX.characters( , 4)
2725SAX.startElement(title)
2726SAX.characters(The Linux adventure, 19)
2727SAX.endElement(title)
2728SAX.characters( , 4)
2729SAX.startElement(p)
2730SAX.characters(bla bla bla ..., 15)
2731SAX.endElement(p)
2732SAX.characters( , 4)
2733SAX.startElement(image, href='linus.gif')
2734SAX.endElement(image)
2735SAX.characters( , 4)
2736SAX.startElement(p)
2737SAX.characters(..., 3)
2738SAX.endElement(p)
2739SAX.characters( , 3)
2740SAX.endElement(chapter)
2741SAX.characters( , 1)
2742SAX.endElement(EXAMPLE)
2743SAX.endDocument()</pre>
2744
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2745<p>Most of the other interfaces of libxml2 are based on the DOM tree-building
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]2746facility, so nearly everything up to the end of this document presupposes the
2747use of the standard DOM tree build. Note that the DOM tree itself is built by
2748a set of registered default callbacks, without internal specific
2749interface.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]2750
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2751<h2><a name="Validation">Validation &amp; DTDs</a></h2>
2752
2753<p>Table of Content:</p>
2754<ol>
2755 <li><a href="#General5">General overview</a></li>
2756 <li><a href="#definition">The definition</a></li>
2757 <li><a href="#Simple">Simple rules</a>
2758 <ol>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]2759 <li><a href="#reference">How to reference a DTD from a document</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2760 <li><a href="#Declaring">Declaring elements</a></li>
2761 <li><a href="#Declaring1">Declaring attributes</a></li>
2762 </ol>
2763 </li>
2764 <li><a href="#Some">Some examples</a></li>
2765 <li><a href="#validate">How to validate</a></li>
2766 <li><a href="#Other">Other resources</a></li>
2767</ol>
2768
2769<h3><a name="General5">General overview</a></h3>
2770
2771<p>Well what is validation and what is a DTD ?</p>
2772
2773<p>DTD is the acronym for Document Type Definition. This is a description of
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2774the content for a family of XML files. This is part of the XML 1.0
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2775specification, and allows one to describe and verify that a given document
2776instance conforms to the set of rules detailing its structure and content.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2777
2778<p>Validation is the process of checking a document against a DTD (more
2779generally against a set of construction rules).</p>
2780
2781<p>The validation process and building DTDs are the two most difficult parts
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2782of the XML life cycle. Briefly a DTD defines all the possible elements to be
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2783found within your document, what is the formal shape of your document tree
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2784(by defining the allowed content of an element; either text, a regular
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2785expression for the allowed list of children, or mixed content i.e. both text
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2786and children). The DTD also defines the valid attributes for all elements and
2787the types of those attributes.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2788
2789<h3><a name="definition1">The definition</a></h3>
2790
2791<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a
2792href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
2793Rev1</a>):</p>
2794<ul>
2795 <li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
2796 elements</a></li>
2797 <li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
2798 attributes</a></li>
2799</ul>
2800
2801<p>(unfortunately) all this is inherited from the SGML world, the syntax is
2802ancient...</p>
2803
2804<h3><a name="Simple1">Simple rules</a></h3>
2805
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2806<p>Writing DTDs can be done in many ways. The rules to build them if you need
2807something permanent or something which can evolve over time can be radically
2808different. Really complex DTDs like DocBook ones are flexible but quite
2809harder to design. I will just focus on DTDs for a formats with a fixed simple
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2810structure. It is just a set of basic rules, and definitely not exhaustive nor
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2811usable for complex DTD design.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2812
2813<h4><a name="reference1">How to reference a DTD from a document</a>:</h4>
2814
2815<p>Assuming the top element of the document is <code>spec</code> and the dtd
2816is placed in the file <code>mydtd</code> in the subdirectory
2817<code>dtds</code> of the directory from where the document were loaded:</p>
2818
2819<p><code>&lt;!DOCTYPE spec SYSTEM "dtds/mydtd"&gt;</code></p>
2820
2821<p>Notes:</p>
2822<ul>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2823 <li>The system string is actually an URI-Reference (as defined in <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2824 href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2825 full URL string indicating the location of your DTD on the Web. This is a
2826 really good thing to do if you want others to validate your document.</li>
2827 <li>It is also possible to associate a <code>PUBLIC</code> identifier (a
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2828 magic string) so that the DTD is looked up in catalogs on the client side
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2829 without having to locate it on the web.</li>
2830 <li>A DTD contains a set of element and attribute declarations, but they
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2831 don't define what the root of the document should be. This is explicitly
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2832 told to the parser/validator as the first element of the
2833 <code>DOCTYPE</code> declaration.</li>
2834</ul>
2835
2836<h4><a name="Declaring2">Declaring elements</a>:</h4>
2837
2838<p>The following declares an element <code>spec</code>:</p>
2839
2840<p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
2841
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2842<p>It also expresses that the spec element contains one <code>front</code>,
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]2843one <code>body</code> and one optional <code>back</code> children elements in
2844this order. The declaration of one element of the structure and its content
2845are done in a single declaration. Similarly the following declares
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2846<code>div1</code> elements:</p>
2847
Daniel Veillard51737272002-01-23 23:10:38 +0000[diff] [blame]2848<p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2849
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2850<p>which means div1 contains one <code>head</code> then a series of optional
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2851<code>p</code>, <code>list</code>s and <code>note</code>s and then an
2852optional <code>div2</code>. And last but not least an element can contain
2853text:</p>
2854
2855<p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
2856
2857<p><code>b</code> contains text or being of mixed content (text and elements
2858in no particular order):</p>
2859
2860<p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
2861
2862<p><code>p </code>can contain text or <code>a</code>, <code>ul</code>,
2863<code>b</code>, <code>i </code>or <code>em</code> elements in no particular
2864order.</p>
2865
2866<h4><a name="Declaring1">Declaring attributes</a>:</h4>
2867
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2868<p>Again the attributes declaration includes their content definition:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2869
2870<p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
2871
2872<p>means that the element <code>termdef</code> can have a <code>name</code>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2873attribute containing text (<code>CDATA</code>) and which is optional
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2874(<code>#IMPLIED</code>). The attribute value can also be defined within a
2875set:</p>
2876
2877<p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
2878"ordered"&gt;</code></p>
2879
2880<p>means <code>list</code> element have a <code>type</code> attribute with 3
2881allowed values "bullets", "ordered" or "glossary" and which default to
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2882"ordered" if the attribute is not explicitly specified.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2883
2884<p>The content type of an attribute can be text (<code>CDATA</code>),
2885anchor/reference/references
2886(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
2887(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
2888(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
2889<code>chapter</code> element can have an optional <code>id</code> attribute
2890of type <code>ID</code>, usable for reference from attribute of type
2891IDREF:</p>
2892
2893<p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
2894
2895<p>The last value of an attribute definition can be <code>#REQUIRED
2896</code>meaning that the attribute has to be given, <code>#IMPLIED</code>
2897meaning that it is optional, or the default value (possibly prefixed by
2898<code>#FIXED</code> if it is the only allowed).</p>
2899
2900<p>Notes:</p>
2901<ul>
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2902 <li>Usually the attributes pertaining to a given element are declared in a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2903 single expression, but it is just a convention adopted by a lot of DTD
2904 writers:
2905 <pre>&lt;!ATTLIST termdef
2906 id ID #REQUIRED
2907 name CDATA #IMPLIED&gt;</pre>
2908 <p>The previous construct defines both <code>id</code> and
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2909 <code>name</code> attributes for the element <code>termdef</code>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2910 </li>
2911</ul>
2912
2913<h3><a name="Some1">Some examples</a></h3>
2914
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2915<p>The directory <code>test/valid/dtds/</code> in the libxml2 distribution
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2916contains some complex DTD examples. The example in the file
2917<code>test/valid/dia.xml</code> shows an XML file where the simple DTD is
2918directly included within the document.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2919
2920<h3><a name="validate1">How to validate</a></h3>
2921
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2922<p>The simplest way is to use the xmllint program included with libxml. The
2923<code>--valid</code> option turns-on validation of the files given as input.
2924For example the following validates a copy of the first revision of the XML
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]29251.0 specification:</p>
2926
2927<p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
2928
Daniel Veillard0b28e882002-07-24 23:47:05 +0000[diff] [blame]2929<p>the -- noout is used to disable output of the resulting tree.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2930
Daniel Veillard42766c02002-08-22 20:52:17 +0000[diff] [blame]2931<p>The <code>--dtdvalid dtd</code> allows validation of the document(s)
2932against a given DTD.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2933
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2934<p>Libxml2 exports an API to handle DTDs and validation, check the <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2935href="http://xmlsoft.org/html/libxml-valid.html">associated
2936description</a>.</p>
2937
2938<h3><a name="Other1">Other resources</a></h3>
2939
2940<p>DTDs are as old as SGML. So there may be a number of examples on-line, I
2941will just list one for now, others pointers welcome:</p>
2942<ul>
2943 <li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li>
2944</ul>
2945
2946<p>I suggest looking at the examples found under test/valid/dtd and any of
2947the large number of books available on XML. The dia example in test/valid
2948should be both simple and complete enough to allow you to build your own.</p>
2949
2950<p></p>
2951
2952<h2><a name="Memory">Memory Management</a></h2>
2953
2954<p>Table of Content:</p>
2955<ol>
2956 <li><a href="#General3">General overview</a></li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2957 <li><a href="#setting">Setting libxml2 set of memory routines</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2958 <li><a href="#cleanup">Cleaning up after parsing</a></li>
2959 <li><a href="#Debugging">Debugging routines</a></li>
2960 <li><a href="#General4">General memory requirements</a></li>
2961</ol>
2962
2963<h3><a name="General3">General overview</a></h3>
2964
2965<p>The module <code><a
2966href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2967provides the interfaces to the libxml2 memory system:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2968<ul>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2969 <li>libxml2 does not use the libc memory allocator directly but xmlFree(),
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2970 xmlMalloc() and xmlRealloc()</li>
2971 <li>those routines can be reallocated to a specific set of routine, by
2972 default the libc ones i.e. free(), malloc() and realloc()</li>
2973 <li>the xmlmemory.c module includes a set of debugging routine</li>
2974</ul>
2975
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2976<h3><a name="setting">Setting libxml2 set of memory routines</a></h3>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2977
2978<p>It is sometimes useful to not use the default memory allocator, either for
2979debugging, analysis or to implement a specific behaviour on memory management
2980(like on embedded systems). Two function calls are available to do so:</p>
2981<ul>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2982 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet
2983 ()</a> which return the current set of functions in use by the parser</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2984 <li><a
2985 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]2986 which allow to set up a new set of memory allocation functions</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2987</ul>
2988
2989<p>Of course a call to xmlMemSetup() should probably be done before calling
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2990any other libxml2 routines (unless you are sure your allocations routines are
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2991compatibles).</p>
2992
2993<h3><a name="cleanup">Cleaning up after parsing</a></h3>
2994
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]2995<p>Libxml2 is not stateless, there is a few set of memory structures needing
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]2996allocation before the parser is fully functional (some encoding structures
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]2997for example). This also mean that once parsing is finished there is a tiny
2998amount of memory (a few hundred bytes) which can be recollected if you don't
2999reuse the parser immediately:</p>
3000<ul>
3001 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3002 ()</a> is a centralized routine to free the parsing states. Note that it
3003 won't deallocate any produced tree if any (use the xmlFreeDoc() and
3004 related routines for this).</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3005 <li><a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3006 ()</a> is the dual routine allowing to preallocate the parsing state
3007 which can be useful for example to avoid initialization reentrancy
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3008 problems when using libxml2 in multithreaded applications</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3009</ul>
3010
3011<p>Generally xmlCleanupParser() is safe, if needed the state will be rebuild
3012at the next invocation of parser routines, but be careful of the consequences
3013in multithreaded applications.</p>
3014
3015<h3><a name="Debugging">Debugging routines</a></h3>
3016
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3017<p>When configured using --with-mem-debug flag (off by default), libxml2 uses
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3018a set of memory allocation debugging routines keeping track of all allocated
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3019blocks and the location in the code where the routine was called. A couple of
3020other debugging routines allow to dump the memory allocated infos to a file
3021or call a specific routine when a given block number is allocated:</p>
3022<ul>
3023 <li><a
3024 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3025 <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3026 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
3027 and <a
3028 href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
3029 are the memory debugging replacement allocation routines</li>
3030 <li><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3031 ()</a> dumps all the informations about the allocated memory block lefts
3032 in the <code>.memdump</code> file</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3033</ul>
3034
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3035<p>When developing libxml2 memory debug is enabled, the tests programs call
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3036xmlMemoryDump () and the "make test" regression tests will check for any
3037memory leak during the full regression test sequence, this helps a lot
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3038ensuring that libxml2 does not leak memory and bullet proof memory
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3039allocations use (some libc implementations are known to be far too permissive
3040resulting in major portability problems!).</p>
3041
3042<p>If the .memdump reports a leak, it displays the allocation function and
3043also tries to give some informations about the content and structure of the
3044allocated blocks left. This is sufficient in most cases to find the culprit,
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3045but not always. Assuming the allocation problem is reproducible, it is
3046possible to find more easily:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3047<ol>
3048 <li>write down the block number xxxx not allocated</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3049 <li>export the environment variable XML_MEM_BREAKPOINT=xxxx , the easiest
Daniel Veillard75794822002-04-11 16:24:32 +0000[diff] [blame]3050 when using GDB is to simply give the command
3051 <p><code>set environment XML_MEM_BREAKPOINT xxxx</code></p>
3052 <p>before running the program.</p>
3053 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3054 <li>run the program under a debugger and set a breakpoint on
3055 xmlMallocBreakpoint() a specific function called when this precise block
3056 is allocated</li>
3057 <li>when the breakpoint is reached you can then do a fine analysis of the
3058 allocation an step to see the condition resulting in the missing
3059 deallocation.</li>
3060</ol>
3061
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3062<p>I used to use a commercial tool to debug libxml2 memory problems but after
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3063noticing that it was not detecting memory leaks that simple mechanism was
Daniel Veillard75794822002-04-11 16:24:32 +0000[diff] [blame]3064used and proved extremely efficient until now. Lately I have also used <a
3065href="http://developer.kde.org/~sewardj/">valgrind</a> with quite some
3066success, it is tied to the i386 architecture since it works by emulating the
3067processor and instruction set, it is slow but extremely efficient, i.e. it
3068spot memory usage errors in a very precise way.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3069
3070<h3><a name="General4">General memory requirements</a></h3>
3071
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3072<p>How much libxml2 memory require ? It's hard to tell in average it depends
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3073of a number of things:</p>
3074<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3075 <li>the parser itself should work in a fixed amount of memory, except for
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3076 information maintained about the stacks of names and entities locations.
3077 The I/O and encoding handlers will probably account for a few KBytes.
3078 This is true for both the XML and HTML parser (though the HTML parser
3079 need more state).</li>
3080 <li>If you are generating the DOM tree then memory requirements will grow
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3081 nearly linear with the size of the data. In general for a balanced
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3082 textual document the internal memory requirement is about 4 times the
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3083 size of the UTF8 serialization of this document (example the XML-1.0
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3084 recommendation is a bit more of 150KBytes and takes 650KBytes of main
3085 memory when parsed). Validation will add a amount of memory required for
3086 maintaining the external Dtd state which should be linear with the
3087 complexity of the content model defined by the Dtd</li>
Daniel Veillardce192eb2003-04-16 15:58:05 +0000[diff] [blame]3088 <li>If you need to work with fixed memory requirements or don't need the
3089 full DOM tree then using the <a href="xmlreader.html">xmlReader
3090 interface</a> is probably the best way to proceed, it still allows to
3091 validate or operate on subset of the tree if needed.</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3092 <li>If you don't care about the advanced features of libxml2 like
Daniel Veillardce192eb2003-04-16 15:58:05 +0000[diff] [blame]3093 validation, DOM, XPath or XPointer, don't use entities, need to work with
3094 fixed memory requirements, and try to get the fastest parsing possible
3095 then the SAX interface should be used, but it has known restrictions.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3096</ul>
3097
3098<p></p>
3099
3100<h2><a name="Encodings">Encodings support</a></h2>
3101
Daniel Veillarde5d68de2005-03-10 15:03:40 +0000[diff] [blame^]3102<p>If you are not really familiar with Internationalization (usual shortcut
3103is I18N) , Unicode, characters and glyphs, I suggest you read a <a
3104href="http://www.tbray.org/ongoing/When/200x/2003/04/06/Unicode">presentation</a>
3105by Tim Bray on Unicode and why you should care about it.</p>
3106<p>If you don't understand why <b>it does not make sense to have a string
3107without knowing what encoding it uses</b>, then as Joel Spolsky said
3108<a href="http://www.joelonsoftware.com/articles/Unicode.html">please do
3109not write another line of code until you finish reading that article.</a>.
3110It is a prerequisite to understand this page, and avoid a lot of problems
3111with libxml2, XML or text processing in general.</p>
3112
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3113<p>Table of Content:</p>
3114<ol>
3115 <li><a href="encoding.html#What">What does internationalization support
3116 mean ?</a></li>
3117 <li><a href="encoding.html#internal">The internal encoding, how and
3118 why</a></li>
3119 <li><a href="encoding.html#implemente">How is it implemented ?</a></li>
3120 <li><a href="encoding.html#Default">Default supported encodings</a></li>
3121 <li><a href="encoding.html#extend">How to extend the existing
3122 support</a></li>
3123</ol>
3124
3125<h3><a name="What">What does internationalization support mean ?</a></h3>
3126
3127<p>XML was designed from the start to allow the support of any character set
3128by using Unicode. Any conformant XML parser has to support the UTF-8 and
3129UTF-16 default encodings which can both express the full unicode ranges. UTF8
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3130is a variable length encoding whose greatest points are to reuse the same
3131encoding for ASCII and to save space for Western encodings, but it is a bit
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3132more complex to handle in practice. UTF-16 use 2 bytes per character (and
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3133sometimes combines two pairs), it makes implementation easier, but looks a
3134bit overkill for Western languages encoding. Moreover the XML specification
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]3135allows the document to be encoded in other encodings at the condition that
3136they are clearly labeled as such. For example the following is a wellformed
3137XML document encoded in ISO-8859-1 and using accentuated letters that we
3138French like for both markup and content:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3139<pre>&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
3140&lt;très&gt;là&lt;/très&gt;</pre>
3141
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3142<p>Having internationalization support in libxml2 means the following:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3143<ul>
3144 <li>the document is properly parsed</li>
3145 <li>informations about it's encoding are saved</li>
3146 <li>it can be modified</li>
3147 <li>it can be saved in its original encoding</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3148 <li>it can also be saved in another encoding supported by libxml2 (for
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3149 example straight UTF8 or even an ASCII form)</li>
3150</ul>
3151
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3152<p>Another very important point is that the whole libxml2 API, with the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3153exception of a few routines to read with a specific encoding or save to a
3154specific encoding, is completely agnostic about the original encoding of the
3155document.</p>
3156
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3157<p>It should be noted too that the HTML parser embedded in libxml2 now obey
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3158the same rules too, the following document will be (as of 2.2.2) handled in
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3159an internationalized fashion by libxml2 too:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3160<pre>&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
3161 "http://www.w3.org/TR/REC-html40/loose.dtd"&gt;
3162&lt;html lang="fr"&gt;
3163&lt;head&gt;
3164 &lt;META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"&gt;
3165&lt;/head&gt;
3166&lt;body&gt;
3167&lt;p&gt;W3C crée des standards pour le Web.&lt;/body&gt;
3168&lt;/html&gt;</pre>
3169
3170<h3><a name="internal">The internal encoding, how and why</a></h3>
3171
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3172<p>One of the core decisions was to force all documents to be converted to a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3173default internal encoding, and that encoding to be UTF-8, here are the
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3174rationales for those choices:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3175<ul>
3176 <li>keeping the native encoding in the internal form would force the libxml
3177 users (or the code associated) to be fully aware of the encoding of the
3178 original document, for examples when adding a text node to a document,
3179 the content would have to be provided in the document encoding, i.e. the
3180 client code would have to check it before hand, make sure it's conformant
3181 to the encoding, etc ... Very hard in practice, though in some specific
3182 cases this may make sense.</li>
3183 <li>the second decision was which encoding. From the XML spec only UTF8 and
3184 UTF16 really makes sense as being the two only encodings for which there
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3185 is mandatory support. UCS-4 (32 bits fixed size encoding) could be
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3186 considered an intelligent choice too since it's a direct Unicode mapping
3187 support. I selected UTF-8 on the basis of efficiency and compatibility
3188 with surrounding software:
3189 <ul>
3190 <li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
3191 more costly to import and export CPU wise) is also far more compact
3192 than UTF-16 (and UCS-4) for a majority of the documents I see it used
3193 for right now (RPM RDF catalogs, advogato data, various configuration
3194 file formats, etc.) and the key point for today's computer
3195 architecture is efficient uses of caches. If one nearly double the
3196 memory requirement to store the same amount of data, this will trash
3197 caches (main memory/external caches/internal caches) and my take is
3198 that this harms the system far more than the CPU requirements needed
3199 for the conversion to UTF-8</li>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3200 <li>Most of libxml2 version 1 users were using it with straight ASCII
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3201 most of the time, doing the conversion with an internal encoding
3202 requiring all their code to be rewritten was a serious show-stopper
3203 for using UTF-16 or UCS-4.</li>
3204 <li>UTF-8 is being used as the de-facto internal encoding standard for
3205 related code like the <a href="http://www.pango.org/">pango</a>
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3206 upcoming Gnome text widget, and a lot of Unix code (yet another place
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3207 where Unix programmer base takes a different approach from Microsoft
3208 - they are using UTF-16)</li>
3209 </ul>
3210 </li>
3211</ul>
3212
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3213<p>What does this mean in practice for the libxml2 user:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3214<ul>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3215 <li>xmlChar, the libxml2 data type is a byte, those bytes must be assembled
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3216 as UTF-8 valid strings. The proper way to terminate an xmlChar * string
3217 is simply to append 0 byte, as usual.</li>
3218 <li>One just need to make sure that when using chars outside the ASCII set,
3219 the values has been properly converted to UTF-8</li>
3220</ul>
3221
3222<h3><a name="implemente">How is it implemented ?</a></h3>
3223
3224<p>Let's describe how all this works within libxml, basically the I18N
3225(internationalization) support get triggered only during I/O operation, i.e.
3226when reading a document or saving one. Let's look first at the reading
3227sequence:</p>
3228<ol>
3229 <li>when a document is processed, we usually don't know the encoding, a
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]3230 simple heuristic allows to detect UTF-16 and UCS-4 from encodings where
3231 the ASCII range (0-0x7F) maps with ASCII</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3232 <li>the xml declaration if available is parsed, including the encoding
3233 declaration. At that point, if the autodetected encoding is different
3234 from the one declared a call to xmlSwitchEncoding() is issued.</li>
3235 <li>If there is no encoding declaration, then the input has to be in either
3236 UTF-8 or UTF-16, if it is not then at some point when processing the
3237 input, the converter/checker of UTF-8 form will raise an encoding error.
3238 You may end-up with a garbled document, or no document at all ! Example:
3239 <pre>~/XML -&gt; ./xmllint err.xml
3240err.xml:1: error: Input is not proper UTF-8, indicate encoding !
3241&lt;très&gt;là&lt;/très&gt;
3242 ^
3243err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
3244&lt;très&gt;là&lt;/très&gt;
3245 ^</pre>
3246 </li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3247 <li>xmlSwitchEncoding() does an encoding name lookup, canonicalize it, and
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3248 then search the default registered encoding converters for that encoding.
3249 If it's not within the default set and iconv() support has been compiled
3250 it, it will ask iconv for such an encoder. If this fails then the parser
3251 will report an error and stops processing:
3252 <pre>~/XML -&gt; ./xmllint err2.xml
3253err2.xml:1: error: Unsupported encoding UnsupportedEnc
3254&lt;?xml version="1.0" encoding="UnsupportedEnc"?&gt;
3255 ^</pre>
3256 </li>
Daniel Veillard46c5c1d2002-05-20 07:15:54 +0000[diff] [blame]3257 <li>From that point the encoder processes progressively the input (it is
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3258 plugged as a front-end to the I/O module) for that entity. It captures
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3259 and converts on-the-fly the document to be parsed to UTF-8. The parser
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3260 itself just does UTF-8 checking of this input and process it
3261 transparently. The only difference is that the encoding information has
3262 been added to the parsing context (more precisely to the input
3263 corresponding to this entity).</li>
3264 <li>The result (when using DOM) is an internal form completely in UTF-8
3265 with just an encoding information on the document node.</li>
3266</ol>
3267
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3268<p>Ok then what happens when saving the document (assuming you
3269collected/built an xmlDoc DOM like structure) ? It depends on the function
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3270called, xmlSaveFile() will just try to save in the original encoding, while
3271xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
3272encoding:</p>
3273<ol>
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3274 <li>if no encoding is given, libxml2 will look for an encoding value
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3275 associated to the document and if it exists will try to save to that
3276 encoding,
3277 <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
3278 </li>
3279 <li>so if an encoding was specified, either at the API level or on the
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3280 document, libxml2 will again canonicalize the encoding name, lookup for a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3281 converter in the registered set or through iconv. If not found the
3282 function will return an error code</li>
3283 <li>the converter is placed before the I/O buffer layer, as another kind of
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3284 buffer, then libxml2 will simply push the UTF-8 serialization to through
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3285 that buffer, which will then progressively be converted and pushed onto
3286 the I/O layer.</li>
3287 <li>It is possible that the converter code fails on some input, for example
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3288 trying to push an UTF-8 encoded Chinese character through the UTF-8 to
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3289 ISO-8859-1 converter won't work. Since the encoders are progressive they
3290 will just report the error and the number of bytes converted, at that
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3291 point libxml2 will decode the offending character, remove it from the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3292 buffer and replace it with the associated charRef encoding &amp;#123; and
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3293 resume the conversion. This guarantees that any document will be saved
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3294 without losses (except for markup names where this is not legal, this is
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3295 a problem in the current version, in practice avoid using non-ascii
Daniel Veillard189f46b2004-01-25 21:03:04 +0000[diff] [blame]3296 characters for tag or attribute names). A special "ascii" encoding name
3297 is used to save documents to a pure ascii form can be used when
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3298 portability is really crucial</li>
3299</ol>
3300
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3301<p>Here are a few examples based on the same test document:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3302<pre>~/XML -&gt; ./xmllint isolat1
3303&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;
3304&lt;très&gt;là&lt;/très&gt;
3305~/XML -&gt; ./xmllint --encode UTF-8 isolat1
3306&lt;?xml version="1.0" encoding="UTF-8"?&gt;
3307&lt;très&gt;là  &lt;/très&gt;
3308~/XML -&gt; </pre>
3309
3310<p>The same processing is applied (and reuse most of the code) for HTML I18N
3311processing. Looking up and modifying the content encoding is a bit more
3312difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
3313so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
3314been provided. The parser also attempts to switch encoding on the fly when
3315detecting such a tag on input. Except for that the processing is the same
3316(and again reuses the same code).</p>
3317
3318<h3><a name="Default">Default supported encodings</a></h3>
3319
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3320<p>libxml2 has a set of default converters for the following encodings
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3321(located in encoding.c):</p>
3322<ol>
3323 <li>UTF-8 is supported by default (null handlers)</li>
3324 <li>UTF-16, both little and big endian</li>
3325 <li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
3326 <li>ASCII, useful mostly for saving</li>
3327 <li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
3328 predefined entities like &amp;copy; for the Copyright sign.</li>
3329</ol>
3330
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]3331<p>More over when compiled on an Unix platform with iconv support the full
3332set of encodings supported by iconv can be instantly be used by libxml. On a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3333linux machine with glibc-2.1 the list of supported encodings and aliases fill
33343 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
3335various Japanese ones.</p>
3336
3337<h4>Encoding aliases</h4>
3338
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3339<p>From 2.2.3, libxml2 has support to register encoding names aliases. The
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3340goal is to be able to parse document whose encoding is supported but where
3341the name differs (for example from the default set of names accepted by
3342iconv). The following functions allow to register and handle new aliases for
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3343existing encodings. Once registered libxml2 will automatically lookup the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3344aliases when handling a document:</p>
3345<ul>
3346 <li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
3347 <li>int xmlDelEncodingAlias(const char *alias);</li>
3348 <li>const char * xmlGetEncodingAlias(const char *alias);</li>
3349 <li>void xmlCleanupEncodingAliases(void);</li>
3350</ul>
3351
3352<h3><a name="extend">How to extend the existing support</a></h3>
3353
3354<p>Well adding support for new encoding, or overriding one of the encoders
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3355(assuming it is buggy) should not be hard, just write input and output
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3356conversion routines to/from UTF-8, and register them using
3357xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be
3358called automatically if the parser(s) encounter such an encoding name
3359(register it uppercase, this will help). The description of the encoders,
3360their arguments and expected return values are described in the encoding.h
3361header.</p>
3362
3363<p>A quick note on the topic of subverting the parser to use a different
3364internal encoding than UTF-8, in some case people will absolutely want to
3365keep the internal encoding different, I think it's still possible (but the
3366encoding must be compliant with ASCII on the same subrange) though I didn't
3367tried it. The key is to override the default conversion routines (by
3368registering null encoders/decoders for your charsets), and bypass the UTF-8
3369checking of the parser by setting the parser context charset
3370(ctxt-&gt;charset) to something different than XML_CHAR_ENCODING_UTF8, but
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3371there is no guarantee that this will work. You may also have some troubles
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3372saving back.</p>
3373
3374<p>Basically proper I18N support is important, this requires at least
3375libxml-2.0.0, but a lot of features and corrections are really available only
3376starting 2.2.</p>
3377
3378<h2><a name="IO">I/O Interfaces</a></h2>
3379
3380<p>Table of Content:</p>
3381<ol>
3382 <li><a href="#General1">General overview</a></li>
3383 <li><a href="#basic">The basic buffer type</a></li>
3384 <li><a href="#Input">Input I/O handlers</a></li>
3385 <li><a href="#Output">Output I/O handlers</a></li>
3386 <li><a href="#entities">The entities loader</a></li>
3387 <li><a href="#Example2">Example of customized I/O</a></li>
3388</ol>
3389
3390<h3><a name="General1">General overview</a></h3>
3391
3392<p>The module <code><a
3393href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3394the interfaces to the libxml2 I/O system. This consists of 4 main parts:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3395<ul>
3396 <li>Entities loader, this is a routine which tries to fetch the entities
3397 (files) based on their PUBLIC and SYSTEM identifiers. The default loader
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3398 don't look at the public identifier since libxml2 do not maintain a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3399 catalog. You can redefine you own entity loader by using
3400 <code>xmlGetExternalEntityLoader()</code> and
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]3401 <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
3402 example</a>.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3403 <li>Input I/O buffers which are a commodity structure used by the parser(s)
3404 input layer to handle fetching the informations to feed the parser. This
3405 provides buffering and is also a placeholder where the encoding
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3406 converters to UTF8 are piggy-backed.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3407 <li>Output I/O buffers are similar to the Input ones and fulfill similar
3408 task but when generating a serialization from a tree.</li>
3409 <li>A mechanism to register sets of I/O callbacks and associate them with
3410 specific naming schemes like the protocol part of the URIs.
3411 <p>This affect the default I/O operations and allows to use specific I/O
3412 handlers for certain names.</p>
3413 </li>
3414</ul>
3415
3416<p>The general mechanism used when loading http://rpmfind.net/xml.html for
3417example in the HTML parser is the following:</p>
3418<ol>
3419 <li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
3420 the parsing context and the URI string.</li>
3421 <li>the URI string is checked against the existing registered handlers
3422 using their match() callback function, if the HTTP module was compiled
3423 in, it is registered and its match() function will succeeds</li>
3424 <li>the open() function of the handler is called and if successful will
3425 return an I/O Input buffer</li>
3426 <li>the parser will the start reading from this buffer and progressively
3427 fetch information from the resource, calling the read() function of the
3428 handler until the resource is exhausted</li>
3429 <li>if an encoding change is detected it will be installed on the input
3430 buffer, providing buffering and efficient use of the conversion
3431 routines</li>
3432 <li>once the parser has finished, the close() function of the handler is
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3433 called once and the Input buffer and associated resources are
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3434 deallocated.</li>
3435</ol>
3436
3437<p>The user defined callbacks are checked first to allow overriding of the
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3438default libxml2 I/O routines.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3439
3440<h3><a name="basic">The basic buffer type</a></h3>
3441
3442<p>All the buffer manipulation handling is done using the
3443<code>xmlBuffer</code> type define in <code><a
3444href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a> </code>which is a
3445resizable memory buffer. The buffer allocation strategy can be selected to be
3446either best-fit or use an exponential doubling one (CPU vs. memory use
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3447trade-off). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3448<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
3449system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
3450of functions allows to manipulate buffers with names starting with the
3451<code>xmlBuffer...</code> prefix.</p>
3452
3453<h3><a name="Input">Input I/O handlers</a></h3>
3454
3455<p>An Input I/O handler is a simple structure
3456<code>xmlParserInputBuffer</code> containing a context associated to the
3457resource (file descriptor, or pointer to a protocol handler), the read() and
3458close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
3459encoding handler are also present to support charset conversion when
3460needed.</p>
3461
3462<h3><a name="Output">Output I/O handlers</a></h3>
3463
3464<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
3465Input one except the callbacks are write() and close().</p>
3466
3467<h3><a name="entities">The entities loader</a></h3>
3468
3469<p>The entity loader resolves requests for new entities and create inputs for
3470the parser. Creating an input from a filename or an URI string is done
3471through the xmlNewInputFromFile() routine. The default entity loader do not
3472handle the PUBLIC identifier associated with an entity (if any). So it just
3473calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
3474XML).</p>
3475
3476<p>If you want to hook up a catalog mechanism then you simply need to
3477override the default entity loader, here is an example:</p>
3478<pre>#include &lt;libxml/xmlIO.h&gt;
3479
3480xmlExternalEntityLoader defaultLoader = NULL;
3481
3482xmlParserInputPtr
3483xmlMyExternalEntityLoader(const char *URL, const char *ID,
3484 xmlParserCtxtPtr ctxt) {
3485 xmlParserInputPtr ret;
3486 const char *fileID = NULL;
3487 /* lookup for the fileID depending on ID */
3488
3489 ret = xmlNewInputFromFile(ctxt, fileID);
3490 if (ret != NULL)
3491 return(ret);
3492 if (defaultLoader != NULL)
3493 ret = defaultLoader(URL, ID, ctxt);
3494 return(ret);
3495}
3496
3497int main(..) {
3498 ...
3499
3500 /*
3501 * Install our own entity loader
3502 */
3503 defaultLoader = xmlGetExternalEntityLoader();
3504 xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);
3505
3506 ...
3507}</pre>
3508
3509<h3><a name="Example2">Example of customized I/O</a></h3>
3510
3511<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
3512real use case</a>, xmlDocDump() closes the FILE * passed by the application
3513and this was a problem. The <a
3514href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
3515new output handler with the closing call deactivated:</p>
3516<ol>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]3517 <li>First define a new I/O output allocator where the output don't close
3518 the file:
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3519 <pre>xmlOutputBufferPtr
3520xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
3521    xmlOutputBufferPtr ret;
3522    
3523    if (xmlOutputCallbackInitialized == 0)
3524        xmlRegisterDefaultOutputCallbacks();
3525
3526    if (file == NULL) return(NULL);
3527    ret = xmlAllocOutputBuffer(encoder);
3528    if (ret != NULL) {
3529        ret-&gt;context = file;
3530        ret-&gt;writecallback = xmlFileWrite;
3531        ret-&gt;closecallback = NULL; /* No close callback */
3532    }
Daniel Veillardf83a2c72003-04-08 13:48:40 +0000[diff] [blame]3533    return(ret);
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3534} </pre>
3535 </li>
3536 <li>And then use it to save the document:
3537 <pre>FILE *f;
3538xmlOutputBufferPtr output;
3539xmlDocPtr doc;
3540int res;
3541
3542f = ...
3543doc = ....
3544
3545output = xmlOutputBufferCreateOwn(f, NULL);
3546res = xmlSaveFileTo(output, doc, NULL);
3547 </pre>
3548 </li>
3549</ol>
3550
3551<h2><a name="Catalog">Catalog support</a></h2>
3552
3553<p>Table of Content:</p>
3554<ol>
3555 <li><a href="General2">General overview</a></li>
3556 <li><a href="#definition">The definition</a></li>
3557 <li><a href="#Simple">Using catalogs</a></li>
3558 <li><a href="#Some">Some examples</a></li>
3559 <li><a href="#reference">How to tune catalog usage</a></li>
3560 <li><a href="#validate">How to debug catalog processing</a></li>
3561 <li><a href="#Declaring">How to create and maintain catalogs</a></li>
3562 <li><a href="#implemento">The implementor corner quick review of the
3563 API</a></li>
3564 <li><a href="#Other">Other resources</a></li>
3565</ol>
3566
3567<h3><a name="General2">General overview</a></h3>
3568
3569<p>What is a catalog? Basically it's a lookup mechanism used when an entity
3570(a file or a remote resource) references another entity. The catalog lookup
3571is inserted between the moment the reference is recognized by the software
3572(XML parser, stylesheet processing, or even images referenced for inclusion
3573in a rendering) and the time where loading that resource is actually
3574started.</p>
3575
3576<p>It is basically used for 3 things:</p>
3577<ul>
3578 <li>mapping from "logical" names, the public identifiers and a more
3579 concrete name usable for download (and URI). For example it can associate
3580 the logical name
3581 <p>"-//OASIS//DTD DocBook XML V4.1.2//EN"</p>
3582 <p>of the DocBook 4.1.2 XML DTD with the actual URL where it can be
3583 downloaded</p>
3584 <p>http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd</p>
3585 </li>
3586 <li>remapping from a given URL to another one, like an HTTP indirection
3587 saying that
3588 <p>"http://www.oasis-open.org/committes/tr.xsl"</p>
3589 <p>should really be looked at</p>
3590 <p>"http://www.oasis-open.org/committes/entity/stylesheets/base/tr.xsl"</p>
3591 </li>
3592 <li>providing a local cache mechanism allowing to load the entities
3593 associated to public identifiers or remote resources, this is a really
3594 important feature for any significant deployment of XML or SGML since it
3595 allows to avoid the aleas and delays associated to fetching remote
3596 resources.</li>
3597</ul>
3598
3599<h3><a name="definition">The definitions</a></h3>
3600
3601<p>Libxml, as of 2.4.3 implements 2 kind of catalogs:</p>
3602<ul>
3603 <li>the older SGML catalogs, the official spec is SGML Open Technical
3604 Resolution TR9401:1997, but is better understood by reading <a
3605 href="http://www.jclark.com/sp/catalog.htm">the SP Catalog page</a> from
3606 James Clark. This is relatively old and not the preferred mode of
3607 operation of libxml.</li>
3608 <li><a href="http://www.oasis-open.org/committees/entity/spec.html">XML
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]3609 Catalogs</a> is far more flexible, more recent, uses an XML syntax and
3610 should scale quite better. This is the default option of libxml.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3611</ul>
3612
3613<p></p>
3614
3615<h3><a name="Simple">Using catalog</a></h3>
3616
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3617<p>In a normal environment libxml2 will by default check the presence of a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3618catalog in /etc/xml/catalog, and assuming it has been correctly populated,
3619the processing is completely transparent to the document user. To take a
3620concrete example, suppose you are authoring a DocBook document, this one
3621starts with the following DOCTYPE definition:</p>
3622<pre>&lt;?xml version='1.0'?&gt;
3623&lt;!DOCTYPE book PUBLIC "-//Norman Walsh//DTD DocBk XML V3.1.4//EN"
3624 "http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd"&gt;</pre>
3625
3626<p>When validating the document with libxml, the catalog will be
3627automatically consulted to lookup the public identifier "-//Norman Walsh//DTD
3628DocBk XML V3.1.4//EN" and the system identifier
3629"http://nwalsh.com/docbook/xml/3.1.4/db3xml.dtd", and if these entities have
3630been installed on your system and the catalogs actually point to them, libxml
3631will fetch them from the local disk.</p>
3632
3633<p style="font-size: 10pt"><strong>Note</strong>: Really don't use this
3634DOCTYPE example it's a really old version, but is fine as an example.</p>
3635
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3636<p>Libxml2 will check the catalog each time that it is requested to load an
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3637entity, this includes DTD, external parsed entities, stylesheets, etc ... If
3638your system is correctly configured all the authoring phase and processing
3639should use only local files, even if your document stays portable because it
3640uses the canonical public and system ID, referencing the remote document.</p>
3641
3642<h3><a name="Some">Some examples:</a></h3>
3643
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3644<p>Here is a couple of fragments from XML Catalogs used in libxml2 early
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3645regression tests in <code>test/catalogs</code> :</p>
3646<pre>&lt;?xml version="1.0"?&gt;
3647&lt;!DOCTYPE catalog PUBLIC
3648 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
3649 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
3650&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
3651 &lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
3652 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
3653...</pre>
3654
3655<p>This is the beginning of a catalog for DocBook 4.1.2, XML Catalogs are
3656written in XML, there is a specific namespace for catalog elements
3657"urn:oasis:names:tc:entity:xmlns:xml:catalog". The first entry in this
3658catalog is a <code>public</code> mapping it allows to associate a Public
3659Identifier with an URI.</p>
3660<pre>...
3661 &lt;rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/"
3662 rewritePrefix="file:///usr/share/xml/docbook/"/&gt;
3663...</pre>
3664
3665<p>A <code>rewriteSystem</code> is a very powerful instruction, it says that
3666any URI starting with a given prefix should be looked at another URI
3667constructed by replacing the prefix with an new one. In effect this acts like
3668a cache system for a full area of the Web. In practice it is extremely useful
3669with a file prefix if you have installed a copy of those resources on your
3670local system.</p>
3671<pre>...
3672&lt;delegatePublic publicIdStartString="-//OASIS//DTD XML Catalog //"
3673 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3674&lt;delegatePublic publicIdStartString="-//OASIS//ENTITIES DocBook XML"
3675 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3676&lt;delegatePublic publicIdStartString="-//OASIS//DTD DocBook XML"
3677 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3678&lt;delegateSystem systemIdStartString="http://www.oasis-open.org/docbook/"
3679 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3680&lt;delegateURI uriStartString="http://www.oasis-open.org/docbook/"
3681 catalog="file:///usr/share/xml/docbook.xml"/&gt;
3682...</pre>
3683
3684<p>Delegation is the core features which allows to build a tree of catalogs,
3685easier to maintain than a single catalog, based on Public Identifier, System
3686Identifier or URI prefixes it instructs the catalog software to look up
3687entries in another resource. This feature allow to build hierarchies of
3688catalogs, the set of entries presented should be sufficient to redirect the
3689resolution of all DocBook references to the specific catalog in
3690<code>/usr/share/xml/docbook.xml</code> this one in turn could delegate all
3691references for DocBook 4.2.1 to a specific catalog installed at the same time
3692as the DocBook resources on the local machine.</p>
3693
3694<h3><a name="reference">How to tune catalog usage:</a></h3>
3695
3696<p>The user can change the default catalog behaviour by redirecting queries
3697to its own set of catalogs, this can be done by setting the
3698<code>XML_CATALOG_FILES</code> environment variable to a list of catalogs, an
3699empty one should deactivate loading the default <code>/etc/xml/catalog</code>
3700default catalog</p>
3701
3702<h3><a name="validate">How to debug catalog processing:</a></h3>
3703
3704<p>Setting up the <code>XML_DEBUG_CATALOG</code> environment variable will
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3705make libxml2 output debugging informations for each catalog operations, for
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3706example:</p>
3707<pre>orchis:~/XML -&gt; xmllint --memory --noout test/ent2
3708warning: failed to load external entity "title.xml"
3709orchis:~/XML -&gt; export XML_DEBUG_CATALOG=
3710orchis:~/XML -&gt; xmllint --memory --noout test/ent2
3711Failed to parse catalog /etc/xml/catalog
3712Failed to parse catalog /etc/xml/catalog
3713warning: failed to load external entity "title.xml"
3714Catalogs cleanup
3715orchis:~/XML -&gt; </pre>
3716
3717<p>The test/ent2 references an entity, running the parser from memory makes
3718the base URI unavailable and the the "title.xml" entity cannot be loaded.
3719Setting up the debug environment variable allows to detect that an attempt is
3720made to load the <code>/etc/xml/catalog</code> but since it's not present the
3721resolution fails.</p>
3722
3723<p>But the most advanced way to debug XML catalog processing is to use the
3724<strong>xmlcatalog</strong> command shipped with libxml2, it allows to load
3725catalogs and make resolution queries to see what is going on. This is also
3726used for the regression tests:</p>
3727<pre>orchis:~/XML -&gt; ./xmlcatalog test/catalogs/docbook.xml \
3728 "-//OASIS//DTD DocBook XML V4.1.2//EN"
3729http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
3730orchis:~/XML -&gt; </pre>
3731
3732<p>For debugging what is going on, adding one -v flags increase the verbosity
3733level to indicate the processing done (adding a second flag also indicate
3734what elements are recognized at parsing):</p>
3735<pre>orchis:~/XML -&gt; ./xmlcatalog -v test/catalogs/docbook.xml \
3736 "-//OASIS//DTD DocBook XML V4.1.2//EN"
3737Parsing catalog test/catalogs/docbook.xml's content
3738Found public match -//OASIS//DTD DocBook XML V4.1.2//EN
3739http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
3740Catalogs cleanup
3741orchis:~/XML -&gt; </pre>
3742
3743<p>A shell interface is also available to debug and process multiple queries
3744(and for regression tests):</p>
3745<pre>orchis:~/XML -&gt; ./xmlcatalog -shell test/catalogs/docbook.xml \
3746 "-//OASIS//DTD DocBook XML V4.1.2//EN"
3747&gt; help
3748Commands available:
3749public PublicID: make a PUBLIC identifier lookup
3750system SystemID: make a SYSTEM identifier lookup
3751resolve PublicID SystemID: do a full resolver lookup
3752add 'type' 'orig' 'replace' : add an entry
3753del 'values' : remove values
3754dump: print the current catalog state
3755debug: increase the verbosity level
3756quiet: decrease the verbosity level
3757exit: quit the shell
3758&gt; public "-//OASIS//DTD DocBook XML V4.1.2//EN"
3759http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd
3760&gt; quit
3761orchis:~/XML -&gt; </pre>
3762
3763<p>This should be sufficient for most debugging purpose, this was actually
3764used heavily to debug the XML Catalog implementation itself.</p>
3765
3766<h3><a name="Declaring">How to create and maintain</a> catalogs:</h3>
3767
3768<p>Basically XML Catalogs are XML files, you can either use XML tools to
3769manage them or use <strong>xmlcatalog</strong> for this. The basic step is
3770to create a catalog the -create option provide this facility:</p>
3771<pre>orchis:~/XML -&gt; ./xmlcatalog --create tst.xml
3772&lt;?xml version="1.0"?&gt;
3773&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
3774 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
3775&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
3776orchis:~/XML -&gt; </pre>
3777
3778<p>By default xmlcatalog does not overwrite the original catalog and save the
3779result on the standard output, this can be overridden using the -noout
3780option. The <code>-add</code> command allows to add entries in the
3781catalog:</p>
3782<pre>orchis:~/XML -&gt; ./xmlcatalog --noout --create --add "public" \
3783 "-//OASIS//DTD DocBook XML V4.1.2//EN" \
3784 http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd tst.xml
3785orchis:~/XML -&gt; cat tst.xml
3786&lt;?xml version="1.0"?&gt;
3787&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" \
3788 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
3789&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"&gt;
3790&lt;public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
3791 uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/&gt;
3792&lt;/catalog&gt;
3793orchis:~/XML -&gt; </pre>
3794
3795<p>The <code>-add</code> option will always take 3 parameters even if some of
3796the XML Catalog constructs (like nextCatalog) will have only a single
3797argument, just pass a third empty string, it will be ignored.</p>
3798
3799<p>Similarly the <code>-del</code> option remove matching entries from the
3800catalog:</p>
3801<pre>orchis:~/XML -&gt; ./xmlcatalog --del \
3802 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" tst.xml
3803&lt;?xml version="1.0"?&gt;
3804&lt;!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
3805 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"&gt;
3806&lt;catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"/&gt;
3807orchis:~/XML -&gt; </pre>
3808
3809<p>The catalog is now empty. Note that the matching of <code>-del</code> is
3810exact and would have worked in a similar fashion with the Public ID
3811string.</p>
3812
3813<p>This is rudimentary but should be sufficient to manage a not too complex
3814catalog tree of resources.</p>
3815
3816<h3><a name="implemento">The implementor corner quick review of the
3817API:</a></h3>
3818
3819<p>First, and like for every other module of libxml, there is an
3820automatically generated <a href="html/libxml-catalog.html">API page for
3821catalog support</a>.</p>
3822
3823<p>The header for the catalog interfaces should be included as:</p>
3824<pre>#include &lt;libxml/catalog.h&gt;</pre>
3825
3826<p>The API is voluntarily kept very simple. First it is not obvious that
3827applications really need access to it since it is the default behaviour of
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]3828libxml2 (Note: it is possible to completely override libxml2 default catalog
3829by using <a href="html/libxml-parser.html">xmlSetExternalEntityLoader</a> to
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3830plug an application specific resolver).</p>
3831
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3832<p>Basically libxml2 support 2 catalog lists:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3833<ul>
3834 <li>the default one, global shared by all the application</li>
3835 <li>a per-document catalog, this one is built if the document uses the
3836 <code>oasis-xml-catalog</code> PIs to specify its own catalog list, it is
3837 associated to the parser context and destroyed when the parsing context
3838 is destroyed.</li>
3839</ul>
3840
3841<p>the document one will be used first if it exists.</p>
3842
3843<h4>Initialization routines:</h4>
3844
3845<p>xmlInitializeCatalog(), xmlLoadCatalog() and xmlLoadCatalogs() should be
3846used at startup to initialize the catalog, if the catalog should be
3847initialized with specific values xmlLoadCatalog() or xmlLoadCatalogs()
3848should be called before xmlInitializeCatalog() which would otherwise do a
3849default initialization first.</p>
3850
3851<p>The xmlCatalogAddLocal() call is used by the parser to grow the document
3852own catalog list if needed.</p>
3853
3854<h4>Preferences setup:</h4>
3855
3856<p>The XML Catalog spec requires the possibility to select default
3857preferences between public and system delegation,
3858xmlCatalogSetDefaultPrefer() allows this, xmlCatalogSetDefaults() and
3859xmlCatalogGetDefaults() allow to control if XML Catalogs resolution should
3860be forbidden, allowed for global catalog, for document catalog or both, the
3861default is to allow both.</p>
3862
3863<p>And of course xmlCatalogSetDebug() allows to generate debug messages
3864(through the xmlGenericError() mechanism).</p>
3865
3866<h4>Querying routines:</h4>
3867
3868<p>xmlCatalogResolve(), xmlCatalogResolveSystem(), xmlCatalogResolvePublic()
3869and xmlCatalogResolveURI() are relatively explicit if you read the XML
3870Catalog specification they correspond to section 7 algorithms, they should
3871also work if you have loaded an SGML catalog with a simplified semantic.</p>
3872
3873<p>xmlCatalogLocalResolve() and xmlCatalogLocalResolveURI() are the same but
3874operate on the document catalog list</p>
3875
3876<h4>Cleanup and Miscellaneous:</h4>
3877
3878<p>xmlCatalogCleanup() free-up the global catalog, xmlCatalogFreeLocal() is
3879the per-document equivalent.</p>
3880
3881<p>xmlCatalogAdd() and xmlCatalogRemove() are used to dynamically modify the
3882first catalog in the global list, and xmlCatalogDump() allows to dump a
3883catalog state, those routines are primarily designed for xmlcatalog, I'm not
3884sure that exposing more complex interfaces (like navigation ones) would be
3885really useful.</p>
3886
3887<p>The xmlParseCatalogFile() is a function used to load XML Catalog files,
3888it's similar as xmlParseFile() except it bypass all catalog lookups, it's
3889provided because this functionality may be useful for client tools.</p>
3890
3891<h4>threaded environments:</h4>
3892
3893<p>Since the catalog tree is built progressively, some care has been taken to
3894try to avoid troubles in multithreaded environments. The code is now thread
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3895safe assuming that the libxml2 library has been compiled with threads
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3896support.</p>
3897
3898<p></p>
3899
3900<h3><a name="Other">Other resources</a></h3>
3901
3902<p>The XML Catalog specification is relatively recent so there isn't much
3903literature to point at:</p>
3904<ul>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3905 <li>You can find a good rant from Norm Walsh about <a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3906 href="http://www.arbortext.com/Think_Tank/XML_Resources/Issue_Three/issue_three.html">the
3907 need for catalogs</a>, it provides a lot of context informations even if
Daniel Veillard93d3a472002-04-26 14:04:55 +0000[diff] [blame]3908 I don't agree with everything presented. Norm also wrote a more recent
3909 article <a
3910 href="http://wwws.sun.com/software/xml/developers/resolver/article/">XML
3911 entities and URI resolvers</a> describing them.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3912 <li>An <a href="http://home.ccil.org/~cowan/XML/XCatalog.html">old XML
3913 catalog proposal</a> from John Cowan</li>
3914 <li>The <a href="http://www.rddl.org/">Resource Directory Description
3915 Language</a> (RDDL) another catalog system but more oriented toward
3916 providing metadata for XML namespaces.</li>
3917 <li>the page from the OASIS Technical <a
3918 href="http://www.oasis-open.org/committees/entity/">Committee on Entity
3919 Resolution</a> who maintains XML Catalog, you will find pointers to the
3920 specification update, some background and pointers to others tools
3921 providing XML Catalog support</li>
Daniel Veillardabfca612004-01-07 23:38:02 +0000[diff] [blame]3922 <li>There is a <a href="buildDocBookCatalog">shell script</a> to generate
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]3923 XML Catalogs for DocBook 4.1.2 . If it can write to the /etc/xml/
3924 directory, it will set-up /etc/xml/catalog and /etc/xml/docbook based on
3925 the resources found on the system. Otherwise it will just create
3926 ~/xmlcatalog and ~/dbkxmlcatalog and doing:
Daniel Veillard8594de92003-04-25 10:08:44 +0000[diff] [blame]3927 <p><code>export XML_CATALOG_FILES=$HOME/xmlcatalog</code></p>
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]3928 <p>should allow to process DocBook documentations without requiring
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]3929 network accesses for the DTD or stylesheets</p>
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]3930 </li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3931 <li>I have uploaded <a href="ftp://xmlsoft.org/test/dbk412catalog.tar.gz">a
Daniel Veillard35e937a2002-01-19 22:21:54 +0000[diff] [blame]3932 small tarball</a> containing XML Catalogs for DocBook 4.1.2 which seems
3933 to work fine for me too</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]3934 <li>The <a href="http://www.xmlsoft.org/xmlcatalog_man.html">xmlcatalog
3935 manual page</a></li>
3936</ul>
3937
3938<p>If you have suggestions for corrections or additions, simply contact
3939me:</p>
3940
3941<h2><a name="library">The parser interfaces</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3942
3943<p>This section is directly intended to help programmers getting bootstrapped
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]3944using the XML tollkit from the C language. It is not intended to be
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3945extensive. I hope the automatically generated documents will provide the
3946completeness required, but as a separate set of documents. The interfaces of
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]3947the XML parser are by principle low level, Those interested in a higher level
3948API should <a href="#DOM">look at DOM</a>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]3949
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]3950<p>The <a href="html/libxml-parser.html">parser interfaces for XML</a> are
3951separated from the <a href="html/libxml-htmlparser.html">HTML parser
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3952interfaces</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]3953
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3954<h3><a name="Invoking">Invoking the parser : the pull method</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3955
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3956<p>Usually, the first thing to do is to read an XML input. The parser accepts
3957documents either from in-memory strings or from files. The functions are
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3958defined in "parser.h":</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3959<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3960 <dt><code>xmlDocPtr xmlParseMemory(char *buffer, int size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3961 <dd><p>Parse a null-terminated string containing the document.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3962 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3963</dl>
3964<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3965 <dt><code>xmlDocPtr xmlParseFile(const char *filename);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]3966 <dd><p>Parse an XML document contained in a (possibly compressed)
3967 file.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3968 </dd>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3969</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3970
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3971<p>The parser returns a pointer to the document structure (or NULL in case of
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]3972failure).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]3973
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3974<h3 id="Invoking1">Invoking the parser: the push method</h3>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]3975
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]3976<p>In order for the application to keep the control when the document is
Daniel Veillard560c2a42003-07-06 21:13:49 +0000[diff] [blame]3977being fetched (which is common for GUI based programs) libxml2 provides a
3978push interface, too, as of version 1.8.3. Here are the interface
3979functions:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]3980<pre>xmlParserCtxtPtr xmlCreatePushParserCtxt(xmlSAXHandlerPtr sax,
3981 void *user_data,
3982 const char *chunk,
3983 int size,
3984 const char *filename);
3985int xmlParseChunk (xmlParserCtxtPtr ctxt,
3986 const char *chunk,
3987 int size,
3988 int terminate);</pre>
3989
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]3990<p>and here is a simple example showing how to use the interface:</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]3991<pre> FILE *f;
3992
3993 f = fopen(filename, "r");
3994 if (f != NULL) {
3995 int res, size = 1024;
3996 char chars[1024];
3997 xmlParserCtxtPtr ctxt;
3998
3999 res = fread(chars, 1, 4, f);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4000 if (res &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4001 ctxt = xmlCreatePushParserCtxt(NULL, NULL,
4002 chars, res, filename);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4003 while ((res = fread(chars, 1, size, f)) &gt; 0) {
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4004 xmlParseChunk(ctxt, chars, res, 0);
4005 }
4006 xmlParseChunk(ctxt, chars, 0, 1);
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4007 doc = ctxt-&gt;myDoc;
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4008 xmlFreeParserCtxt(ctxt);
4009 }
4010 }</pre>
4011
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4012<p>The HTML parser embedded into libxml2 also has a push interface; the
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4013functions are just prefixed by "html" rather than "xml".</p>
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4014
4015<h3 id="Invoking2">Invoking the parser: the SAX interface</h3>
4016
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4017<p>The tree-building interface makes the parser memory-hungry, first loading
4018the document in memory and then building the tree itself. Reading a document
4019without building the tree is possible using the SAX interfaces (see SAX.h and
4020<a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">James
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4021Henstridge's documentation</a>). Note also that the push interface can be
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4022limited to SAX: just use the two first arguments of
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4023<code>xmlCreatePushParserCtxt()</code>.</p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]4024
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4025<h3><a name="Building">Building a tree from scratch</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4026
4027<p>The other way to get an XML tree in memory is by building it. Basically
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4028there is a set of functions dedicated to building new elements. (These are
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4029also described in &lt;libxml/tree.h&gt;.) For example, here is a piece of
4030code that produces the XML document used in the previous examples:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4031<pre> #include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]4032 xmlDocPtr doc;
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4033 xmlNodePtr tree, subtree;
4034
4035 doc = xmlNewDoc("1.0");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4036 doc-&gt;children = xmlNewDocNode(doc, NULL, "EXAMPLE", NULL);
4037 xmlSetProp(doc-&gt;children, "prop1", "gnome is great");
4038 xmlSetProp(doc-&gt;children, "prop2", "&amp; linux too");
4039 tree = xmlNewChild(doc-&gt;children, NULL, "head", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4040 subtree = xmlNewChild(tree, NULL, "title", "Welcome to Gnome");
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4041 tree = xmlNewChild(doc-&gt;children, NULL, "chapter", NULL);
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4042 subtree = xmlNewChild(tree, NULL, "title", "The Linux adventure");
4043 subtree = xmlNewChild(tree, NULL, "p", "bla bla bla ...");
4044 subtree = xmlNewChild(tree, NULL, "image", NULL);
4045 xmlSetProp(subtree, "href", "linus.gif");</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4046
4047<p>Not really rocket science ...</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4048
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4049<h3><a name="Traversing">Traversing the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4050
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]4051<p>Basically by <a href="html/libxml-tree.html">including "tree.h"</a> your
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4052code has access to the internal structure of all the elements of the tree.
4053The names should be somewhat simple like <strong>parent</strong>,
Daniel Veillard306be992000-07-03 12:38:45 +0000[diff] [blame]4054<strong>children</strong>, <strong>next</strong>, <strong>prev</strong>,
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4055<strong>properties</strong>, etc... For example, still with the previous
Daniel Veillard0142b842000-01-14 14:45:24 +0000[diff] [blame]4056example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4057<pre><code>doc-&gt;children-&gt;children-&gt;children</code></pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4058
4059<p>points to the title element,</p>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4060<pre>doc-&gt;children-&gt;children-&gt;next-&gt;children-&gt;children</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4061
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4062<p>points to the text node containing the chapter title "The Linux
4063adventure".</p>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4064
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]4065<p><strong>NOTE</strong>: XML allows <em>PI</em>s and <em>comments</em> to be
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4066present before the document root, so <code>doc-&gt;children</code> may point
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4067to an element which is not the document Root Element; a function
Daniel Veillard5cb5ab81999-12-21 15:35:29 +0000[diff] [blame]4068<code>xmlDocGetRootElement()</code> was added for this purpose.</p>
Daniel Veillardb24054a1999-12-18 15:32:46 +0000[diff] [blame]4069
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4070<h3><a name="Modifying">Modifying the tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4071
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4072<p>Functions are provided for reading and writing the document content. Here
Daniel Veillard9cb5ff42001-01-29 08:22:21 +0000[diff] [blame]4073is an excerpt from the <a href="html/libxml-tree.html">tree API</a>:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4074<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]4075 <dt><code>xmlAttrPtr xmlSetProp(xmlNodePtr node, const xmlChar *name, const
4076 xmlChar *value);</code></dt>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4077 <dd><p>This sets (or changes) an attribute carried by an ELEMENT node.
4078 The value can be NULL.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4079 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4080</dl>
4081<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]4082 <dt><code>const xmlChar *xmlGetProp(xmlNodePtr node, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4083 *name);</code></dt>
Daniel Veillardc92c3042000-09-29 02:42:04 +0000[diff] [blame]4084 <dd><p>This function returns a pointer to new copy of the property
4085 content. Note that the user must deallocate the result.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4086 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4087</dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4088
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4089<p>Two functions are provided for reading and writing the text associated
4090with elements:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4091<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]4092 <dt><code>xmlNodePtr xmlStringGetNodeList(xmlDocPtr doc, const xmlChar
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4093 *value);</code></dt>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4094 <dd><p>This function takes an "external" string and converts it to one
4095 text node or possibly to a list of entity and text nodes. All
4096 non-predefined entity references like &amp;Gnome; will be stored
4097 internally as entity nodes, hence the result of the function may not be
4098 a single node.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4099 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4100</dl>
4101<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]4102 <dt><code>xmlChar *xmlNodeListGetString(xmlDocPtr doc, xmlNodePtr list, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4103 inLine);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4104 <dd><p>This function is the inverse of
4105 <code>xmlStringGetNodeList()</code>. It generates a new string
4106 containing the content of the text and entity nodes. Note the extra
4107 argument inLine. If this argument is set to 1, the function will expand
4108 entity references. For example, instead of returning the &amp;Gnome;
4109 XML encoding in the string, it will substitute it with its value (say,
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4110 "GNU Network Object Model Environment").</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4111 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4112</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4113
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4114<h3><a name="Saving">Saving a tree</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4115
4116<p>Basically 3 options are possible:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4117<dl>
Daniel Veillarddd6b3671999-09-23 22:19:22 +0000[diff] [blame]4118 <dt><code>void xmlDocDumpMemory(xmlDocPtr cur, xmlChar**mem, int
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4119 *size);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4120 <dd><p>Returns a buffer into which the document has been saved.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4121 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4122</dl>
4123<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4124 <dt><code>extern void xmlDocDump(FILE *f, xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4125 <dd><p>Dumps a document to an open file descriptor.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4126 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4127</dl>
4128<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4129 <dt><code>int xmlSaveFile(const char *filename, xmlDocPtr cur);</code></dt>
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4130 <dd><p>Saves the document to a file. In this case, the compression
4131 interface is triggered if it has been turned on.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4132 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4133</dl>
Daniel Veillard10c6a8f1998-10-28 01:00:12 +0000[diff] [blame]4134
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4135<h3><a name="Compressio">Compression</a></h3>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4136
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4137<p>The library transparently handles compression when doing file-based
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4138accesses. The level of compression on saves can be turned on either globally
4139or individually for one file:</p>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4140<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4141 <dt><code>int xmlGetDocCompressMode (xmlDocPtr doc);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4142 <dd><p>Gets the document compression ratio (0-9).</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4143 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4144</dl>
4145<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4146 <dt><code>void xmlSetDocCompressMode (xmlDocPtr doc, int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4147 <dd><p>Sets the document compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4148 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4149</dl>
4150<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4151 <dt><code>int xmlGetCompressMode(void);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4152 <dd><p>Gets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4153 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4154</dl>
4155<dl>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4156 <dt><code>void xmlSetCompressMode(int mode);</code></dt>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4157 <dd><p>Sets the default compression ratio.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4158 </dd>
Daniel Veillard25940b71998-10-29 05:51:30 +0000[diff] [blame]4159</dl>
4160
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4161<h2><a name="Entities">Entities or no entities</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4162
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4163<p>Entities in principle are similar to simple C macros. An entity defines an
4164abbreviation for a given string that you can reuse many times throughout the
4165content of your document. Entities are especially useful when a given string
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4166may occur frequently within a document, or to confine the change needed to a
4167document to a restricted area in the internal subset of the document (at the
4168beginning). Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4169<pre>1 &lt;?xml version="1.0"?&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]41702 &lt;!DOCTYPE EXAMPLE SYSTEM "example.dtd" [
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]41713 &lt;!ENTITY xml "Extensible Markup Language"&gt;
41724 ]&gt;
41735 &lt;EXAMPLE&gt;
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]41746 &amp;xml;
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]41757 &lt;/EXAMPLE&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4176
4177<p>Line 3 declares the xml entity. Line 6 uses the xml entity, by prefixing
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4178its name with '&amp;' and following it by ';' without any spaces added. There
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4179are 5 predefined entities in libxml2 allowing you to escape characters with
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4180predefined meaning in some parts of the xml document content:
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4181<strong>&amp;lt;</strong> for the character '&lt;', <strong>&amp;gt;</strong>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4182for the character '&gt;', <strong>&amp;apos;</strong> for the character ''',
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4183<strong>&amp;quot;</strong> for the character '"', and
4184<strong>&amp;amp;</strong> for the character '&amp;'.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4185
4186<p>One of the problems related to entities is that you may want the parser to
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4187substitute an entity's content so that you can see the replacement text in
4188your application. Or you may prefer to keep entity references as such in the
4189content to be able to save the document back without losing this usually
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4190precious information (if the user went through the pain of explicitly
4191defining entities, he may have a a rather negative attitude if you blindly
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4192substitute them as saving time). The <a
Daniel Veillard5373ea12003-07-24 13:09:13 +0000[diff] [blame]4193href="html/libxml-parser.html#xmlSubstituteEntitiesDefault">xmlSubstituteEntitiesDefault()</a>
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4194function allows you to check and change the behaviour, which is to not
4195substitute entities by default.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4196
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4197<p>Here is the DOM tree built by libxml2 for the previous document in the
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4198default case:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4199<pre>/gnome/src/gnome-xml -&gt; ./xmllint --debug test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4200DOCUMENT
4201version=1.0
4202 ELEMENT EXAMPLE
4203 TEXT
4204 content=
4205 ENTITY_REF
4206 INTERNAL_GENERAL_ENTITY xml
4207 content=Extensible Markup Language
4208 TEXT
4209 content=</pre>
4210
4211<p>And here is the result when substituting entities:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4212<pre>/gnome/src/gnome-xml -&gt; ./tester --debug --noent test/ent1
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4213DOCUMENT
4214version=1.0
4215 ELEMENT EXAMPLE
4216 TEXT
4217 content= Extensible Markup Language</pre>
4218
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4219<p>So, entities or no entities? Basically, it depends on your use case. I
4220suggest that you keep the non-substituting default behaviour and avoid using
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4221entities in your XML document or data if you are not willing to handle the
4222entity references elements in the DOM tree.</p>
4223
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4224<p>Note that at save time libxml2 enforces the conversion of the predefined
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4225entities where necessary to prevent well-formedness problems, and will also
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4226transparently replace those with chars (i.e. it will not generate entity
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4227reference elements in the DOM tree or call the reference() SAX callback when
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4228finding them in the input).</p>
4229
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]4230<p><span style="background-color: #FF0000">WARNING</span>: handling entities
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4231on top of the libxml2 SAX interface is difficult!!! If you plan to use
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4232non-predefined entities in your documents, then the learning curve to handle
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4233then using the SAX API may be long. If you plan to use complex documents, I
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]4234strongly suggest you consider using the DOM interface instead and let libxml
Daniel Veillard8c6d6af2000-08-25 17:14:13 +0000[diff] [blame]4235deal with the complexity rather than trying to do it yourself.</p>
Daniel Veillard7b9c4b72000-08-25 16:26:50 +0000[diff] [blame]4236
Daniel Veillard2f4dfc41999-09-24 14:03:48 +0000[diff] [blame]4237<h2><a name="Namespaces">Namespaces</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4238
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4239<p>The libxml2 library implements <a
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]4240href="http://www.w3.org/TR/REC-xml-names/">XML namespaces</a> support by
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4241recognizing namespace constructs in the input, and does namespace lookup
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]4242automatically when building the DOM tree. A namespace declaration is
4243associated with an in-memory structure and all elements or attributes within
4244that namespace point to it. Hence testing the namespace is a simple and fast
4245equality operation at the user level.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4246
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4247<p>I suggest that people using libxml2 use a namespace, and declare it in the
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4248root element of their document as the default namespace. Then they don't need
4249to use the prefix in the content but we will have a basis for future semantic
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4250refinement and merging of data from different sources. This doesn't increase
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4251the size of the XML output significantly, but significantly increases its
4252value in the long-term. Example:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4253<pre>&lt;mydoc xmlns="http://mydoc.example.org/schemas/"&gt;
4254 &lt;elem1&gt;...&lt;/elem1&gt;
4255 &lt;elem2&gt;...&lt;/elem2&gt;
4256&lt;/mydoc&gt;</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4257
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4258<p>The namespace value has to be an absolute URL, but the URL doesn't have to
4259point to any existing resource on the Web. It will bind all the element and
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]4260attributes with that URL. I suggest to use an URL within a domain you
4261control, and that the URL should contain some kind of version information if
4262possible. For example, <code>"http://www.gnome.org/gnumeric/1.0/"</code> is a
4263good namespace scheme.</p>
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]4264
4265<p>Then when you load a file, make sure that a namespace carrying the
Daniel Veillard88f00ae2000-03-02 00:15:55 +0000[diff] [blame]4266version-independent prefix is installed on the root element of your document,
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4267and if the version information don't match something you know, warn the user
4268and be liberal in what you accept as the input. Also do *not* try to base
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4269namespace checking on the prefix value. &lt;foo:text&gt; may be exactly the
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4270same as &lt;bar:text&gt; in another document. What really matters is the URI
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4271associated with the element or the attribute, not the prefix string (which is
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4272just a shortcut for the full URI). In libxml, element and attributes have an
Daniel Veillardec303412000-03-24 13:41:54 +0000[diff] [blame]4273<code>ns</code> field pointing to an xmlNs structure detailing the namespace
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4274prefix and its URI.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4275
4276<p>@@Interfaces@@</p>
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]4277<pre>xmlNodePtr node;
Daniel Veillardfc8dc352003-10-18 09:07:46 +0000[diff] [blame]4278if(!strncmp(node-&gt;name,"mytag",5)
4279 &amp;&amp; node-&gt;ns
4280 &amp;&amp; !strcmp(node-&gt;ns-&gt;href,"http://www.mysite.com/myns/1.0")) {
4281 ...
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]4282}</pre>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4283
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4284<p>Usually people object to using namespaces together with validity checking.
4285I will try to make sure that using namespaces won't break validity checking,
4286so even if you plan to use or currently are using validation I strongly
Daniel Veillardf13e1ed2000-03-06 07:41:49 +0000[diff] [blame]4287suggest adding namespaces to your document. A default namespace scheme
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4288<code>xmlns="http://...."</code> should not break validity even on less
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4289flexible parsers. Using namespaces to mix and differentiate content coming
Daniel Veillard3e35f8e2003-10-21 00:05:38 +0000[diff] [blame]4290from multiple DTDs will certainly break current validation schemes. To check
4291such documents one needs to use schema-validation, which is supported in
4292libxml2 as well. See <a href="http://www.relaxng.org/">relagx-ng</a> and <a
4293href="http://www.w3c.org/XML/Schema">w3c-schema</a>.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4294
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4295<h2><a name="Upgrading">Upgrading 1.x code</a></h2>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4296
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4297<p>Incompatible changes:</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4298
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4299<p>Version 2 of libxml2 is the first version introducing serious backward
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4300incompatible changes. The main goals were:</p>
4301<ul>
4302 <li>a general cleanup. A number of mistakes inherited from the very early
4303 versions couldn't be changed due to compatibility constraints. Example
4304 the "childs" element in the nodes.</li>
4305 <li>Uniformization of the various nodes, at least for their header and link
4306 parts (doc, parent, children, prev, next), the goal is a simpler
4307 programming model and simplifying the task of the DOM implementors.</li>
4308 <li>better conformances to the XML specification, for example version 1.x
4309 had an heuristic to try to detect ignorable white spaces. As a result the
4310 SAX event generated were ignorableWhitespace() while the spec requires
4311 character() in that case. This also mean that a number of DOM node
4312 containing blank text may populate the DOM tree which were not present
4313 before.</li>
4314</ul>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4315
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4316<h3>How to fix libxml-1.x code:</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4317
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4318<p>So client code of libxml designed to run with version 1.x may have to be
4319changed to compile against version 2.x of libxml. Here is a list of changes
4320that I have collected, they may not be sufficient, so in case you find other
Daniel Veillardfc8dc352003-10-18 09:07:46 +0000[diff] [blame]4321change which are required, <a href="mailto:Daniel.Veillard@w3.org">drop me a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4322mail</a>:</p>
4323<ol>
4324 <li>The package name have changed from libxml to libxml2, the library name
4325 is now -lxml2 . There is a new xml2-config script which should be used to
4326 select the right parameters libxml2</li>
4327 <li>Node <strong>childs</strong> field has been renamed
4328 <strong>children</strong> so s/childs/children/g should be applied
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4329 (probability of having "childs" anywhere else is close to 0+</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4330 <li>The document don't have anymore a <strong>root</strong> element it has
4331 been replaced by <strong>children</strong> and usually you will get a
4332 list of element here. For example a Dtd element for the internal subset
4333 and it's declaration may be found in that list, as well as processing
4334 instructions or comments found before or after the document root element.
4335 Use <strong>xmlDocGetRootElement(doc)</strong> to get the root element of
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4336 a document. Alternatively if you are sure to not reference DTDs nor have
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4337 PIs or comments before or after the root element
4338 s/-&gt;root/-&gt;children/g will probably do it.</li>
4339 <li>The white space issue, this one is more complex, unless special case of
4340 validating parsing, the line breaks and spaces usually used for indenting
4341 and formatting the document content becomes significant. So they are
4342 reported by SAX and if your using the DOM tree, corresponding nodes are
4343 generated. Too approach can be taken:
4344 <ol>
4345 <li>lazy one, use the compatibility call
4346 <strong>xmlKeepBlanksDefault(0)</strong> but be aware that you are
4347 relying on a special (and possibly broken) set of heuristics of
4348 libxml to detect ignorable blanks. Don't complain if it breaks or
4349 make your application not 100% clean w.r.t. to it's input.</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4350 <li>the Right Way: change you code to accept possibly insignificant
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4351 blanks characters, or have your tree populated with weird blank text
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4352 nodes. You can spot them using the commodity function
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4353 <strong>xmlIsBlankNode(node)</strong> returning 1 for such blank
4354 nodes.</li>
4355 </ol>
4356 <p>Note also that with the new default the output functions don't add any
4357 extra indentation when saving a tree in order to be able to round trip
4358 (read and save) without inflating the document with extra formatting
4359 chars.</p>
4360 </li>
4361 <li>The include path has changed to $prefix/libxml/ and the includes
4362 themselves uses this new prefix in includes instructions... If you are
4363 using (as expected) the
4364 <pre>xml2-config --cflags</pre>
4365 <p>output to generate you compile commands this will probably work out of
4366 the box</p>
4367 </li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4368 <li>xmlDetectCharEncoding takes an extra argument indicating the length in
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4369 byte of the head of the document available for character detection.</li>
4370</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4371
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4372<h3>Ensuring both libxml-1.x and libxml-2.x compatibility</h3>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4373
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4374<p>Two new version of libxml (1.8.11) and libxml2 (2.3.4) have been released
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4375to allow smooth upgrade of existing libxml v1code while retaining
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4376compatibility. They offers the following:</p>
4377<ol>
4378 <li>similar include naming, one should use
4379 <strong>#include&lt;libxml/...&gt;</strong> in both cases.</li>
4380 <li>similar identifiers defined via macros for the child and root fields:
4381 respectively <strong>xmlChildrenNode</strong> and
4382 <strong>xmlRootNode</strong></li>
4383 <li>a new macro <strong>LIBXML_TEST_VERSION</strong> which should be
4384 inserted once in the client code</li>
4385</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4386
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4387<p>So the roadmap to upgrade your existing libxml applications is the
4388following:</p>
4389<ol>
4390 <li>install the libxml-1.8.8 (and libxml-devel-1.8.8) packages</li>
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4391 <li>find all occurrences where the xmlDoc <strong>root</strong> field is
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4392 used and change it to <strong>xmlRootNode</strong></li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]4393 <li>similarly find all occurrences where the xmlNode
4394 <strong>childs</strong> field is used and change it to
4395 <strong>xmlChildrenNode</strong></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4396 <li>add a <strong>LIBXML_TEST_VERSION</strong> macro somewhere in your
4397 <strong>main()</strong> or in the library init entry point</li>
4398 <li>Recompile, check compatibility, it should still work</li>
Daniel Veillardc0801af2002-05-28 16:28:42 +0000[diff] [blame]4399 <li>Change your configure script to look first for xml2-config and fall
4400 back using xml-config . Use the --cflags and --libs output of the command
4401 as the Include and Linking parameters needed to use libxml.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4402 <li>install libxml2-2.3.x and libxml2-devel-2.3.x (libxml-1.8.y and
4403 libxml-devel-1.8.y can be kept simultaneously)</li>
4404 <li>remove your config.cache, relaunch your configuration mechanism, and
4405 recompile, if steps 2 and 3 were done right it should compile as-is</li>
4406 <li>Test that your application is still running correctly, if not this may
4407 be due to extra empty nodes due to formating spaces being kept in libxml2
4408 contrary to libxml1, in that case insert xmlKeepBlanksDefault(1) in your
4409 code before calling the parser (next to
4410 <strong>LIBXML_TEST_VERSION</strong> is a fine place).</li>
4411</ol>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4412
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4413<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]4414
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4415<p>Let me put some emphasis on the fact that there is far more changes from
4416libxml 1.x to 2.x than the ones you may have to patch for. The overall code
4417has been considerably cleaned up and the conformance to the XML specification
4418has been drastically improved too. Don't take those changes as an excuse to
4419not upgrade, it may cost a lot on the long term ...</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4420
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4421<h2><a name="Thread">Thread safety</a></h2>
4422
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4423<p>Starting with 2.4.7, libxml2 makes provisions to ensure that concurrent
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4424threads can safely work in parallel parsing different documents. There is
4425however a couple of things to do to ensure it:</p>
4426<ul>
4427 <li>configure the library accordingly using the --with-threads options</li>
4428 <li>call xmlInitParser() in the "main" thread before using any of the
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4429 libxml2 API (except possibly selecting a different memory allocator)</li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]4430</ul>
4431
4432<p>Note that the thread safety cannot be ensured for multiple threads sharing
4433the same document, the locking must be done at the application level, libxml
4434exports a basic mutex and reentrant mutexes API in &lt;libxml/threads.h&gt;.
4435The parts of the library checked for thread safety are:</p>
4436<ul>
4437 <li>concurrent loading</li>
4438 <li>file access resolution</li>
4439 <li>catalog access</li>
4440 <li>catalog building</li>
4441 <li>entities lookup/accesses</li>
4442 <li>validation</li>
4443 <li>global variables per-thread override</li>
4444 <li>memory handling</li>
4445</ul>
4446
4447<p>XPath is supposed to be thread safe now, but this wasn't tested
4448seriously.</p>
4449
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]4450<h2><a name="DOM"></a><a name="Principles">DOM Principles</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4451
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4452<p><a href="http://www.w3.org/DOM/">DOM</a> stands for the <em>Document
4453Object Model</em>; this is an API for accessing XML or HTML structured
4454documents. Native support for DOM in Gnome is on the way (module gnome-dom),
4455and will be based on gnome-xml. This will be a far cleaner interface to
4456manipulate XML files within Gnome since it won't expose the internal
4457structure.</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4458
Daniel Veillard8a469172003-06-12 16:05:07 +0000[diff] [blame]4459<p>The current DOM implementation on top of libxml2 is the <a
Daniel Veillarda47fb3d2001-03-25 17:23:49 +0000[diff] [blame]4460href="http://cvs.gnome.org/lxr/source/gdome2/">gdome2 Gnome module</a>, this
4461is a full DOM interface, thanks to Paolo Casarini, check the <a
4462href="http://www.cs.unibo.it/~casarini/gdome2/">Gdome2 homepage</a> for more
4463informations.</p>
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4464
Daniel Veillard35008381999-10-25 13:15:52 +0000[diff] [blame]4465<h2><a name="Example"></a><a name="real">A real example</a></h2>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4466
4467<p>Here is a real size example, where the actual content of the application
4468data is not kept in the DOM tree but uses internal structures. It is based on
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4469a proposal to keep a database of jobs related to Gnome, with an XML based
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4470storage structure. Here is an <a href="gjobs.xml">XML encoded jobs
4471base</a>:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4472<pre>&lt;?xml version="1.0"?&gt;
4473&lt;gjob:Helping xmlns:gjob="http://www.gnome.org/some-location"&gt;
4474 &lt;gjob:Jobs&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4475
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4476 &lt;gjob:Job&gt;
4477 &lt;gjob:Project ID="3"/&gt;
4478 &lt;gjob:Application&gt;GBackup&lt;/gjob:Application&gt;
4479 &lt;gjob:Category&gt;Development&lt;/gjob:Category&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4480
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4481 &lt;gjob:Update&gt;
4482 &lt;gjob:Status&gt;Open&lt;/gjob:Status&gt;
4483 &lt;gjob:Modified&gt;Mon, 07 Jun 1999 20:27:45 -0400 MET DST&lt;/gjob:Modified&gt;
4484 &lt;gjob:Salary&gt;USD 0.00&lt;/gjob:Salary&gt;
4485 &lt;/gjob:Update&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4486
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4487 &lt;gjob:Developers&gt;
4488 &lt;gjob:Developer&gt;
4489 &lt;/gjob:Developer&gt;
4490 &lt;/gjob:Developers&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4491
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4492 &lt;gjob:Contact&gt;
4493 &lt;gjob:Person&gt;Nathan Clemons&lt;/gjob:Person&gt;
4494 &lt;gjob:Email&gt;nathan@windsofstorm.net&lt;/gjob:Email&gt;
4495 &lt;gjob:Company&gt;
4496 &lt;/gjob:Company&gt;
4497 &lt;gjob:Organisation&gt;
4498 &lt;/gjob:Organisation&gt;
4499 &lt;gjob:Webpage&gt;
4500 &lt;/gjob:Webpage&gt;
4501 &lt;gjob:Snailmail&gt;
4502 &lt;/gjob:Snailmail&gt;
4503 &lt;gjob:Phone&gt;
4504 &lt;/gjob:Phone&gt;
4505 &lt;/gjob:Contact&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4506
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4507 &lt;gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4508 The program should be released as free software, under the GPL.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4509 &lt;/gjob:Requirements&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4510
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4511 &lt;gjob:Skills&gt;
4512 &lt;/gjob:Skills&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4513
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4514 &lt;gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4515 A GNOME based system that will allow a superuser to configure
4516 compressed and uncompressed files and/or file systems to be backed
4517 up with a supported media in the system. This should be able to
4518 perform via find commands generating a list of files that are passed
4519 to tar, dd, cpio, cp, gzip, etc., to be directed to the tape machine
4520 or via operations performed on the filesystem itself. Email
4521 notification and GUI status display very important.
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4522 &lt;/gjob:Details&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4523
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4524 &lt;/gjob:Job&gt;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4525
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4526 &lt;/gjob:Jobs&gt;
4527&lt;/gjob:Helping&gt;</pre>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4528
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4529<p>While loading the XML file into an internal DOM tree is a matter of
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4530calling only a couple of functions, browsing the tree to gather the data and
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4531generate the internal structures is harder, and more error prone.</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4532
4533<p>The suggested principle is to be tolerant with respect to the input
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4534structure. For example, the ordering of the attributes is not significant,
4535the XML specification is clear about it. It's also usually a good idea not to
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4536depend on the order of the children of a given node, unless it really makes
4537things harder. Here is some code to parse the information for a person:</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4538<pre>/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4539 * A person record
4540 */
4541typedef struct person {
4542 char *name;
4543 char *email;
4544 char *company;
4545 char *organisation;
4546 char *smail;
4547 char *webPage;
4548 char *phone;
4549} person, *personPtr;
4550
4551/*
4552 * And the code needed to parse it
4553 */
4554personPtr parsePerson(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
4555 personPtr ret = NULL;
4556
4557DEBUG("parsePerson\n");
4558 /*
4559 * allocate the struct
4560 */
4561 ret = (personPtr) malloc(sizeof(person));
4562 if (ret == NULL) {
4563 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4564 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4565 }
4566 memset(ret, 0, sizeof(person));
4567
4568 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4569 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4570 while (cur != NULL) {
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4571 if ((!strcmp(cur-&gt;name, "Person")) &amp;&amp; (cur-&gt;ns == ns))
4572 ret-&gt;name = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4573 if ((!strcmp(cur-&gt;name, "Email")) &amp;&amp; (cur-&gt;ns == ns))
4574 ret-&gt;email = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4575 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4576 }
4577
4578 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4579}</pre>
4580
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4581<p>Here are a couple of things to notice:</p>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4582<ul>
Daniel Veillard91e9d582001-02-26 07:31:12 +0000[diff] [blame]4583 <li>Usually a recursive parsing style is the more convenient one: XML data
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4584 is by nature subject to repetitive constructs and usually exhibits highly
4585 structured patterns.</li>
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4586 <li>The two arguments of type <em>xmlDocPtr</em> and <em>xmlNsPtr</em>,
4587 i.e. the pointer to the global XML document and the namespace reserved to
4588 the application. Document wide information are needed for example to
4589 decode entities and it's a good coding practice to define a namespace for
4590 your application set of data and test that the element and attributes
4591 you're analyzing actually pertains to your application space. This is
4592 done by a simple equality test (cur-&gt;ns == ns).</li>
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4593 <li>To retrieve text and attributes value, you can use the function
4594 <em>xmlNodeListGetString</em> to gather all the text and entity reference
4595 nodes generated by the DOM output and produce an single text string.</li>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4596</ul>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4597
4598<p>Here is another piece of code used to parse another level of the
4599structure:</p>
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4600<pre>#include &lt;libxml/tree.h&gt;
Daniel Veillard361d8452000-04-03 19:48:13 +0000[diff] [blame]4601/*
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4602 * a Description for a Job
4603 */
4604typedef struct job {
4605 char *projectID;
4606 char *application;
4607 char *category;
4608 personPtr contact;
4609 int nbDevelopers;
4610 personPtr developers[100]; /* using dynamic alloc is left as an exercise */
4611} job, *jobPtr;
4612
4613/*
4614 * And the code needed to parse it
4615 */
4616jobPtr parseJob(xmlDocPtr doc, xmlNsPtr ns, xmlNodePtr cur) {
4617 jobPtr ret = NULL;
4618
4619DEBUG("parseJob\n");
4620 /*
4621 * allocate the struct
4622 */
4623 ret = (jobPtr) malloc(sizeof(job));
4624 if (ret == NULL) {
4625 fprintf(stderr,"out of memory\n");
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4626 return(NULL);
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4627 }
4628 memset(ret, 0, sizeof(job));
4629
4630 /* We don't care what the top level element name is */
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4631 cur = cur-&gt;xmlChildrenNode;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4632 while (cur != NULL) {
4633
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4634 if ((!strcmp(cur-&gt;name, "Project")) &amp;&amp; (cur-&gt;ns == ns)) {
4635 ret-&gt;projectID = xmlGetProp(cur, "ID");
4636 if (ret-&gt;projectID == NULL) {
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4637 fprintf(stderr, "Project has no ID\n");
4638 }
4639 }
Daniel Veillard60979bd2000-07-10 12:17:33 +0000[diff] [blame]4640 if ((!strcmp(cur-&gt;name, "Application")) &amp;&amp; (cur-&gt;ns == ns))
4641 ret-&gt;application = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4642 if ((!strcmp(cur-&gt;name, "Category")) &amp;&amp; (cur-&gt;ns == ns))
4643 ret-&gt;category = xmlNodeListGetString(doc, cur-&gt;xmlChildrenNode, 1);
4644 if ((!strcmp(cur-&gt;name, "Contact")) &amp;&amp; (cur-&gt;ns == ns))
4645 ret-&gt;contact = parsePerson(doc, ns, cur);
4646 cur = cur-&gt;next;
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4647 }
4648
4649 return(ret);
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4650}</pre>
Daniel Veillard14fff061999-06-22 21:49:07 +0000[diff] [blame]4651
Daniel Veillardec70e912001-02-26 20:10:45 +0000[diff] [blame]4652<p>Once you are used to it, writing this kind of code is quite simple, but
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4653boring. Ultimately, it could be possible to write stubbers taking either C
Daniel Veillard3d6ae1c2001-08-15 13:12:39 +0000[diff] [blame]4654data structure definitions, a set of XML examples or an XML DTD and produce
4655the code needed to import and export the content between C data and XML
4656storage. This is left as an exercise to the reader :-)</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4657
Daniel Veillard6f0adb52000-07-03 11:41:26 +0000[diff] [blame]4658<p>Feel free to use <a href="example/gjobread.c">the code for the full C
4659parsing example</a> as a template, it is also available with Makefile in the
4660Gnome CVS base under gnome-xml/example</p>
Daniel Veillardb05deb71999-08-10 19:04:08 +0000[diff] [blame]4661
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]4662<h2><a name="Contributi">Contributions</a></h2>
4663<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4664 <li>Bjorn Reese, William Brack and Thomas Broyer have provided a number of
4665 patches, Gary Pennington worked on the validation API, threading support
4666 and Solaris port.</li>
4667 <li>John Fleck helps maintaining the documentation and man pages.</li>
Daniel Veillard7b4b2f92003-01-06 13:11:20 +0000[diff] [blame]4668 <li><a href="mailto:igor@zlatkovic.com">Igor Zlatkovic</a> is now the
4669 maintainer of the Windows port, <a
4670 href="http://www.zlatkovic.com/projects/libxml/index.html">he provides
4671 binaries</a></li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]4672 <li><a href="mailto:Gary.Pennington@sun.com">Gary Pennington</a> provides
4673 <a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillarde356c282001-03-10 12:32:04 +0000[diff] [blame]4674 <li><a
4675 href="http://mail.gnome.org/archives/xml/2001-March/msg00014.html">Matt
Daniel Veillard63d83142002-05-20 06:51:05 +0000[diff] [blame]4676 Sergeant</a> developed <a
4677 href="http://axkit.org/download/">XML::LibXSLT</a>, a Perl wrapper for
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]4678 libxml2/libxslt as part of the <a href="http://axkit.com/">AxKit XML
4679 application server</a></li>
4680 <li><a href="mailto:fnatter@gmx.net">Felix Natter</a> and <a
4681 href="mailto:geertk@ai.rug.nl">Geert Kloosterman</a> provide <a
Daniel Veillardca989762001-06-23 17:39:29 +0000[diff] [blame]4682 href="libxml-doc.el">an emacs module</a> to lookup libxml(2) functions
Daniel Veillard3f6f7f62000-06-30 17:58:25 +0000[diff] [blame]4683 documentation</li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]4684 <li><a href="mailto:sherwin@nlm.nih.gov">Ziying Sherwin</a> provided <a
4685 href="http://xmlsoft.org/messages/0488.html">man pages</a></li>
Daniel Veillard5168dbf2001-07-07 00:18:23 +0000[diff] [blame]4686 <li>there is a module for <a
4687 href="http://acs-misc.sourceforge.net/nsxml.html">libxml/libxslt support
4688 in OpenNSD/AOLServer</a></li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]4689 <li><a href="mailto:dkuhlman@cutter.rexx.com">Dave Kuhlman</a> provided the
4690 first version of libxml/libxslt <a
4691 href="http://www.rexx.com/~dkuhlman">wrappers for Python</a></li>
Daniel Veillard1aadc442001-11-28 13:10:32 +0000[diff] [blame]4692 <li>Petr Kozelka provides <a
4693 href="http://sourceforge.net/projects/libxml2-pas">Pascal units to glue
4694 libxml2</a> with Kylix and Delphi and other Pascal compilers</li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]4695 <li><a href="mailto:aleksey@aleksey.com">Aleksey Sanin</a> implemented the
4696 <a href="http://www.w3.org/Signature/">XML Canonicalization and XML
4697 Digital Signature</a> <a
4698 href="http://www.aleksey.com/xmlsec/">implementations for libxml2</a></li>
Daniel Veillard17bed982003-02-24 20:11:43 +0000[diff] [blame]4699 <li><a href="mailto:Steve.Ball@zveno.com">Steve Ball</a>, <a
4700 href="http://www.zveno.com/">Zveno</a> and contributors maintain <a
4701 href="http://tclxml.sourceforge.net/">tcl bindings for libxml2 and
4702 libxslt</a>, as well as <a
4703 href="http://tclxml.sf.net/tkxmllint.html">tkxmllint</a> a GUI for
4704 xmllint and <a href="http://tclxml.sf.net/tkxsltproc.html">tkxsltproc</a>
4705 a GUI for xsltproc.</li>
Daniel Veillardc310d562000-06-23 18:32:15 +0000[diff] [blame]4706</ul>
4707
Daniel Veillardc8eab3a1999-09-04 18:27:23 +0000[diff] [blame]4708<p></p>
Daniel Veillardccb09631998-10-27 06:21:04 +0000[diff] [blame]4709</body>
4710</html>