Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / b8cfbd12680cbd28c9eaafea2642b8f1cbd52a48 / . / doc / encoding.html
blob: 41790acdb8e4585ce983f127d68fc8d932ed2bb1 [file] [log] [blame]
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]2<html>
3<head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]4<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
5<style type="text/css"><!--
6TD {font-size: 10pt; font-family: Verdana,Arial,Helvetica}
7BODY {font-size: 10pt; font-family: Verdana,Arial,Helvetica; margin-top: 5pt; margin-left: 0pt; margin-right: 0pt}
8H1 {font-size: 16pt; font-family: Verdana,Arial,Helvetica}
9H2 {font-size: 14pt; font-family: Verdana,Arial,Helvetica}
10H3 {font-size: 12pt; font-family: Verdana,Arial,Helvetica}
11A:link, A:visited, A:active { text-decoration: underline }
12--></style>
13<title>Encodings support</title>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]14</head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]15<body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000">
16<table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr>
17<td width="180">
18<a href="http://www.gnome.org/"><img src="smallfootonly.gif" alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png" alt="W3C Logo"></a><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo"></a>
19</td>
20<td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center">
21<h1>The XML C library for Gnome</h1>
22<h2>Encodings support</h2>
23</td></tr></table></td></tr></table></td>
24</tr></table>
25<table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr>
26<td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td>
27<table width="100%" border="0" cellspacing="1" cellpadding="3">
28<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr>
29<tr><td bgcolor="#fffacd"><ul style="margin-left: -2pt">
30<li><a href="index.html">Home</a></li>
31<li><a href="intro.html">Introduction</a></li>
32<li><a href="FAQ.html">FAQ</a></li>
33<li><a href="docs.html">Documentation</a></li>
34<li><a href="bugs.html">Reporting bugs and getting help</a></li>
35<li><a href="help.html">How to help</a></li>
36<li><a href="downloads.html">Downloads</a></li>
37<li><a href="news.html">News</a></li>
38<li><a href="XML.html">XML</a></li>
39<li><a href="XSLT.html">XSLT</a></li>
40<li><a href="architecture.html">libxml architecture</a></li>
41<li><a href="tree.html">The tree output</a></li>
42<li><a href="interface.html">The SAX interface</a></li>
43<li><a href="xmldtd.html">Validation &amp; DTDs</a></li>
44<li><a href="xmlmem.html">Memory Management</a></li>
45<li><a href="encoding.html">Encodings support</a></li>
46<li><a href="xmlio.html">I/O Interfaces</a></li>
47<li><a href="catalog.html">Catalog support</a></li>
48<li><a href="library.html">The parser interfaces</a></li>
49<li><a href="entities.html">Entities or no entities</a></li>
50<li><a href="namespaces.html">Namespaces</a></li>
51<li><a href="upgrade.html">Upgrading 1.x code</a></li>
52<li><a href="DOM.html">DOM Principles</a></li>
53<li><a href="example.html">A real example</a></li>
54<li><a href="contribs.html">Contributions</a></li>
55<li>
56<a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
57</li>
58</ul></td></tr>
59</table>
60<table width="100%" border="0" cellspacing="1" cellpadding="3">
61<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
62<tr><td bgcolor="#fffacd"><ul style="margin-left: -2pt">
63<li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li>
64<li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li>
65<li><a href="http://www.cs.unibo.it/~casarini/gdome2/">DOM gdome2</a></li>
66<li><a href="ftp://xmlsoft.org/">FTP</a></li>
67<li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
68<li><a href="http://pages.eidosnet.co.uk/~garypen/libxml/">Solaris binaries</a></li>
69</ul></td></tr>
70</table>
71</td></tr></table></td>
72<td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd">
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]73<p>Table of Content:</p>
74<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]75<li><a href="encoding.html#What">What does internationalization support
76 mean ?</a></li>
77<li><a href="encoding.html#internal">The internal encoding, how and
78 why</a></li>
79<li><a href="encoding.html#implemente">How is it implemented ?</a></li>
80<li><a href="encoding.html#Default">Default supported encodings</a></li>
81<li><a href="encoding.html#extend">How to extend the existing
82 support</a></li>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]83</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]84<h3><a name="What">What does internationalization support mean ?</a></h3>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]85<p>XML was designed from the start to allow the support of any character set
86by using Unicode. Any conformant XML parser has to support the UTF-8 and
87UTF-16 default encodings which can both express the full unicode ranges. UTF8
88is a variable length encoding whose greatest point are to resuse the same
89emcoding for ASCII and to save space for Western encodings, but it is a bit
90more complex to handle in practice. UTF-16 use 2 bytes per characters (and
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]91sometimes combines two pairs), it makes implementation easier, but looks a
92bit overkill for Western languages encoding. Moreover the XML specification
93allows document to be encoded in other encodings at the condition that they
94are clearly labelled as such. For example the following is a wellformed XML
Daniel Veillard0d6b1702000-08-22 23:52:16 +0000[diff] [blame]95document encoded in ISO-8859 1 and using accentuated letter that we French
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]96likes for both markup and content:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]97<pre>&lt;?xml version=&quot;1.0&quot; encoding=&quot;ISO-8859-1&quot;?&gt;
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]98&lt;très&gt;là&lt;/très&gt;</pre>
Daniel Veillard0d6b1702000-08-22 23:52:16 +0000[diff] [blame]99<p>Having internationalization support in libxml means the foolowing:</p>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]100<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]101<li>the document is properly parsed</li>
102<li>informations about it's encoding are saved</li>
103<li>it can be modified</li>
104<li>it can be saved in its original encoding</li>
105<li>it can also be saved in another encoding supported by libxml (for
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]106 example straight UTF8 or even an ASCII form)</li>
107</ul>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]108<p>Another very important point is that the whole libxml API, with the
109exception of a few routines to read with a specific encoding or save to a
110specific encoding, is completely agnostic about the original encoding of the
111document.</p>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]112<p>It should be noted too that the HTML parser embedded in libxml now obbey
113the same rules too, the following document will be (as of 2.2.2) handled in
114an internationalized fashion by libxml too:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]115<pre>&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.0 Transitional//EN&quot;
116 &quot;http://www.w3.org/TR/REC-html40/loose.dtd&quot;&gt;
117&lt;html lang=&quot;fr&quot;&gt;
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]118&lt;head&gt;
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]119 &lt;META HTTP-EQUIV=&quot;Content-Type&quot; CONTENT=&quot;text/html; charset=ISO-8859-1&quot;&gt;
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]120&lt;/head&gt;
121&lt;body&gt;
122&lt;p&gt;W3C crée des standards pour le Web.&lt;/body&gt;
123&lt;/html&gt;</pre>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]124<h3><a name="internal">The internal encoding, how and why</a></h3>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]125<p>One of the core decision was to force all documents to be converted to a
126default internal encoding, and that encoding to be UTF-8, here are the
127rationale for those choices:</p>
128<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]129<li>keeping the native encoding in the internal form would force the libxml
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]130 users (or the code associated) to be fully aware of the encoding of the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]131 original document, for examples when adding a text node to a document,
132 the content would have to be provided in the document encoding, i.e. the
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]133 client code would have to check it before hand, make sure it's conformant
134 to the encoding, etc ... Very hard in practice, though in some specific
135 cases this may make sense.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]136<li>the second decision was which encoding. From the XML spec only UTF8 and
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]137 UTF16 really makes sense as being the two only encodings for which there
138 is amndatory support. UCS-4 (32 bits fixed size encoding) could be
139 considered an intelligent choice too since it's a direct Unicode mapping
140 support. I selected UTF-8 on the basis of efficiency and compatibility
141 with surrounding software:
142 <ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]143<li>UTF-8 while a bit more complex to convert from/to (i.e. slightly
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]144 more costly to import and export CPU wise) is also far more compact
145 than UTF-16 (and UCS-4) for a majority of the documents I see it used
146 for right now (RPM RDF catalogs, advogato data, various configuration
147 file formats, etc.) and the key point for today's computer
148 architecture is efficient uses of caches. If one nearly double the
149 memory requirement to store the same amount of data, this will trash
150 caches (main memory/external caches/internal caches) and my take is
151 that this harms the system far more than the CPU requirements needed
152 for the conversion to UTF-8</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]153<li>Most of libxml version 1 users were using it with straight ASCII
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]154 most of the time, doing the conversion with an internal encoding
155 requiring all their code to be rewritten was a serious show-stopper
156 for using UTF-16 or UCS-4.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]157<li>UTF-8 is being used as the de-facto internal encoding standard for
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]158 related code like the <a href="http://www.pango.org/">pango</a>
159 upcoming Gnome text widget, and a lot of Unix code (yep another place
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]160 where Unix programmer base takes a different approach from Microsoft
161 - they are using UTF-16)</li>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]162</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]163</li>
164</ul>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]165<p>What does this mean in practice for the libxml user:</p>
166<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]167<li>xmlChar, the libxml data type is a byte, those bytes must be assembled
168 as UTF-8 valid strings. The proper way to terminate an xmlChar * string
169 is simply to append 0 byte, as usual.</li>
170<li>One just need to make sure that when using chars outside the ASCII set,
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]171 the values has been properly converted to UTF-8</li>
172</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]173<h3><a name="implemente">How is it implemented ?</a></h3>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]174<p>Let's describe how all this works within libxml, basically the I18N
175(internationalization) support get triggered only during I/O operation, i.e.
176when reading a document or saving one. Let's look first at the reading
177sequence:</p>
178<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]179<li>when a document is processed, we usually don't know the encoding, a
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]180 simple heuristic allows to detect UTF-18 and UCS-4 from whose where the
181 ASCII range (0-0x7F) maps with ASCII</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]182<li>the xml declaration if available is parsed, including the encoding
183 declaration. At that point, if the autodetected encoding is different
184 from the one declared a call to xmlSwitchEncoding() is issued.</li>
185<li>If there is no encoding declaration, then the input has to be in either
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]186 UTF-8 or UTF-16, if it is not then at some point when processing the
187 input, the converter/checker of UTF-8 form will raise an encoding error.
188 You may end-up with a garbled document, or no document at all ! Example:
189 <pre>~/XML -&gt; ./xmllint err.xml
190err.xml:1: error: Input is not proper UTF-8, indicate encoding !
191&lt;très&gt;là&lt;/très&gt;
192 ^
193err.xml:1: error: Bytes: 0xE8 0x73 0x3E 0x6C
194&lt;très&gt;là&lt;/très&gt;
195 ^</pre>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]196</li>
197<li>xmlSwitchEncoding() does an encoding name lookup, canonalize it, and
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]198 then search the default registered encoding converters for that encoding.
199 If it's not within the default set and iconv() support has been compiled
200 it, it will ask iconv for such an encoder. If this fails then the parser
201 will report an error and stops processing:
202 <pre>~/XML -&gt; ./xmllint err2.xml
203err2.xml:1: error: Unsupported encoding UnsupportedEnc
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]204&lt;?xml version=&quot;1.0&quot; encoding=&quot;UnsupportedEnc&quot;?&gt;
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]205 ^</pre>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]206</li>
207<li>From that point the encoder process progressingly the input (it is
208 plugged as a front-end to the I/O module) for that entity. It captures
209 and convert on-the-fly the document to be parsed to UTF-8. The parser
210 itself just does UTF-8 checking of this input and process it
211 transparently. The only difference is that the encoding information has
212 been added to the parsing context (more precisely to the input
213 corresponding to this entity).</li>
214<li>The result (when using DOM) is an internal form completely in UTF-8
215 with just an encoding information on the document node.</li>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]216</ol>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]217<p>Ok then what's happen when saving the document (assuming you
218colllected/built an xmlDoc DOM like structure) ? It depends on the function
219called, xmlSaveFile() will just try to save in the original encoding, while
220xmlSaveFileTo() and xmlSaveFileEnc() can optionally save to a given
221encoding:</p>
222<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]223<li>if no encoding is given, libxml will look for an encoding value
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]224 associated to the document and if it exists will try to save to that
225 encoding,
226 <p>otherwise everything is written in the internal form, i.e. UTF-8</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]227</li>
228<li>so if an encoding was specified, either at the API level or on the
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]229 document, libxml will again canonalize the encoding name, lookup for a
230 converter in the registered set or through iconv. If not found the
231 function will return an error code</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]232<li>the converter is placed before the I/O buffer layer, as another kind of
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]233 buffer, then libxml will simply push the UTF-8 serialization to through
234 that buffer, which will then progressively be converted and pushed onto
235 the I/O layer.</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]236<li>It is possible that the converter code fails on some input, for example
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]237 trying to push an UTF-8 encoded chinese character through the UTF-8 to
Daniel Veillard0d6b1702000-08-22 23:52:16 +0000[diff] [blame]238 ISO-8859-1 converter won't work. Since the encoders are progressive they
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]239 will just report the error and the number of bytes converted, at that
240 point libxml will decode the offending character, remove it from the
241 buffer and replace it with the associated charRef encoding &amp;#123; and
242 resume the convertion. This guarante that any document will be saved
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]243 without losses (except for markup names where this is not legal, this is
244 a problem in the current version, in pactice avoid using non-ascci
245 characters for tags or attributes names @@). A special &quot;ascii&quot; encoding
Daniel Veillard0d6b1702000-08-22 23:52:16 +0000[diff] [blame]246 name is used to save documents to a pure ascii form can be used when
247 portability is really crucial</li>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]248</ol>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]249<p>Here is a few examples based on the same test document:</p>
250<pre>~/XML -&gt; ./xmllint isolat1
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]251&lt;?xml version=&quot;1.0&quot; encoding=&quot;ISO-8859-1&quot;?&gt;
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]252&lt;très&gt;là&lt;/très&gt;
253~/XML -&gt; ./xmllint --encode UTF-8 isolat1
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]254&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]255&lt;très&gt;là  &lt;/très&gt;
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]256~/XML -&gt; </pre>
Daniel Veillard0d6b1702000-08-22 23:52:16 +0000[diff] [blame]257<p>The same processing is applied (and reuse most of the code) for HTML I18N
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]258processing. Looking up and modifying the content encoding is a bit more
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]259difficult since it is located in a &lt;meta&gt; tag under the &lt;head&gt;,
260so a couple of functions htmlGetMetaEncoding() and htmlSetMetaEncoding() have
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]261been provided. The parser also attempts to switch encoding on the fly when
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]262detecting such a tag on input. Except for that the processing is the same
263(and again reuses the same code).</p>
264<h3><a name="Default">Default supported encodings</a></h3>
265<p>libxml has a set of default converters for the following encodings
266(located in encoding.c):</p>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]267<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]268<li>UTF-8 is supported by default (null handlers)</li>
269<li>UTF-16, both little and big endian</li>
270<li>ISO-Latin-1 (ISO-8859-1) covering most western languages</li>
271<li>ASCII, useful mostly for saving</li>
272<li>HTML, a specific handler for the conversion of UTF-8 to ASCII with HTML
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]273 predefined entities like &amp;copy; for the Copyright sign.</li>
274</ol>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]275<p>More over when compiled on an Unix platfor with iconv support the full set
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]276of encodings supported by iconv can be instantly be used by libxml. On a
277linux machine with glibc-2.1 the list of supported encodings and aliases fill
2783 full pages, and include UCS-4, the full set of ISO-Latin encodings, and the
279various Japanese ones.</p>
280<h4>Encoding aliases</h4>
281<p>From 2.2.3, libxml has support to register encoding names aliases. The
282goal is to be able to parse document whose encoding is supported but where
283the name differs (for example from the default set of names accepted by
284iconv). The following functions allow to register and handle new aliases for
285existing encodings. Once registered libxml will automatically lookup the
286aliases when handling a document:</p>
Daniel Veillard088f4282000-08-25 23:46:50 +0000[diff] [blame]287<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]288<li>int xmlAddEncodingAlias(const char *name, const char *alias);</li>
289<li>int xmlDelEncodingAlias(const char *alias);</li>
290<li>const char * xmlGetEncodingAlias(const char *alias);</li>
291<li>void xmlCleanupEncodingAliases(void);</li>
Daniel Veillard088f4282000-08-25 23:46:50 +0000[diff] [blame]292</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]293<h3><a name="extend">How to extend the existing support</a></h3>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]294<p>Well adding support for new encoding, or overriding one of the encoders
295(assuming it is buggy) should not be hard, just write an input and output
296conversion routines to/from UTF-8, and register them using
297xmlNewCharEncodingHandler(name, xxxToUTF8, UTF8Toxxx), and they will be
298called automatically if the parser(s) encounter such an encoding name
299(register it uppercase, this will help). The description of the encoders,
300their arguments and expected return values are described in the encoding.h
301header.</p>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]302<p>A quick note on the topic of subverting the parser to use a different
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]303internal encoding than UTF-8, in some case people will absolutely want to
304keep the internal encoding different, I think it's still possible (but the
305encoding must be compliant with ASCII on the same subrange) though I didn't
306tried it. The key is to override the default conversion routines (by
307registering null encoders/decoders for your charsets), and bypass the UTF-8
308checking of the parser by setting the parser context charset
309(ctxt-&gt;charset) to something different than XML_CHAR_ENCODING_UTF8, but
310there is no guarantee taht this will work. You may also have some troubles
311saving back.</p>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]312<p>Basically proper I18N support is important, this requires at least
313libxml-2.0.0, but a lot of features and corrections are really available only
314starting 2.2.</p>
Daniel Veillardc5d64342001-06-24 12:13:24 +0000[diff] [blame]315<p><a href="mailto:daniel@veillard.com">Daniel Veillard</a></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]316</td></tr></table></td></tr></table></td></tr></table></td>
317</tr></table></td></tr></table>
Daniel Veillardbe40c8b2000-07-14 12:10:59 +0000[diff] [blame]318</body>
319</html>