xmlio.html 11.4 KB
Newer Older
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2
3
<html>
<head>
4
5
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
<style type="text/css"><!--
6
7
8
9
10
TD {font-size: 14pt; font-family: Verdana,Arial,Helvetica}
BODY {font-size: 14pt; font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
H1 {font-size: 20pt; font-family: Verdana,Arial,Helvetica}
H2 {font-size: 18pt; font-family: Verdana,Arial,Helvetica}
H3 {font-size: 16pt; font-family: Verdana,Arial,Helvetica}
11
12
13
A:link, A:visited, A:active { text-decoration: underline }
--></style>
<title>I/O Interfaces</title>
14
</head>
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000">
<table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr>
<td width="180">
<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>
</td>
<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">
<h1>The XML C library for Gnome</h1>
<h2>I/O Interfaces</h2>
</td></tr></table></td></tr></table></td>
</tr></table>
<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>
<td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td>
<table width="100%" border="0" cellspacing="1" cellpadding="3">
<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr>
29
<tr><td bgcolor="#fffacd"><ul>
30
31
32
33
34
35
36
37
<li><a href="index.html">Home</a></li>
<li><a href="intro.html">Introduction</a></li>
<li><a href="FAQ.html">FAQ</a></li>
<li><a href="docs.html">Documentation</a></li>
<li><a href="bugs.html">Reporting bugs and getting help</a></li>
<li><a href="help.html">How to help</a></li>
<li><a href="downloads.html">Downloads</a></li>
<li><a href="news.html">News</a></li>
38
<li><a href="XMLinfo.html">XML</a></li>
39
40
41
42
43
44
45
46
47
48
49
50
51
<li><a href="XSLT.html">XSLT</a></li>
<li><a href="architecture.html">libxml architecture</a></li>
<li><a href="tree.html">The tree output</a></li>
<li><a href="interface.html">The SAX interface</a></li>
<li><a href="xmldtd.html">Validation &amp; DTDs</a></li>
<li><a href="xmlmem.html">Memory Management</a></li>
<li><a href="encoding.html">Encodings support</a></li>
<li><a href="xmlio.html">I/O Interfaces</a></li>
<li><a href="catalog.html">Catalog support</a></li>
<li><a href="library.html">The parser interfaces</a></li>
<li><a href="entities.html">Entities or no entities</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="upgrade.html">Upgrading 1.x code</a></li>
52
<li><a href="threads.html">Thread safety</a></li>
53
54
55
56
57
58
59
60
61
<li><a href="DOM.html">DOM Principles</a></li>
<li><a href="example.html">A real example</a></li>
<li><a href="contribs.html">Contributions</a></li>
<li>
<a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
</li>
</ul></td></tr>
</table>
<table width="100%" border="0" cellspacing="1" cellpadding="3">
62
63
<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr>
<tr><td bgcolor="#fffacd"><ul>
64
<li><a href="APIchunk0.html">Alphabetic</a></li>
65
66
67
68
69
70
71
<li><a href="APIconstructors.html">Constructors</a></li>
<li><a href="APIfunctions.html">Functions/Types</a></li>
<li><a href="APIfiles.html">Modules</a></li>
<li><a href="APIsymbols.html">Symbols</a></li>
</ul></td></tr>
</table>
<table width="100%" border="0" cellspacing="1" cellpadding="3">
72
<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
73
<tr><td bgcolor="#fffacd"><ul>
74
75
<li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li>
<li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li>
76
<li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li>
77
78
<li><a href="ftp://xmlsoft.org/">FTP</a></li>
<li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
Daniel Veillard's avatar
Daniel Veillard committed
79
<li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
80
<li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Bug Tracker</a></li>
81
82
83
84
</ul></td></tr>
</table>
</td></tr></table></td>
<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">
85
86
<p>Table of Content:</p>
<ol>
87
88
89
90
91
92
<li><a href="#General1">General overview</a></li>
<li><a href="#basic">The basic buffer type</a></li>
<li><a href="#Input">Input I/O handlers</a></li>
<li><a href="#Output">Output I/O handlers</a></li>
<li><a href="#entities">The entities loader</a></li>
<li><a href="#Example2">Example of customized I/O</a></li>
93
</ol>
94
95
96
<h3><a name="General1">General overview</a></h3>
<p>The module <code><a href="http://xmlsoft.org/html/libxml-xmlio.html">xmlIO.h</a></code> provides
the interfaces to the libxml I/O system. This consists of 4 main parts:</p>
97
<ul>
98
<li>Entities loader, this is a routine which tries to fetch the entities
99
100
101
102
    (files) based on their PUBLIC and SYSTEM identifiers. The default loader
    don't look at the public identifier since libxml do not maintain a
    catalog. You can redefine you own entity loader by using
    <code>xmlGetExternalEntityLoader()</code> and
103
104
    <code>xmlSetExternalEntityLoader()</code>. <a href="#entities">Check the
    example</a>.</li>
105
<li>Input I/O buffers which are a commodity structure used by the parser(s)
106
    input layer to handle fetching the informations to feed the parser. This
107
108
109
    provides buffering and is also a placeholder where the encoding
    convertors to UTF8 are piggy-backed.</li>
<li>Output I/O buffers are similar to the Input ones and fulfill similar
110
    task but when generating a serialization from a tree.</li>
111
<li>A mechanism to register sets of I/O callbacks and associate them with
112
113
114
    specific naming schemes like the protocol part of the URIs.
    <p>This affect the default I/O operations and allows to use specific I/O
    handlers for certain names.</p>
115
</li>
116
</ul>
117
<p>The general mechanism used when loading http://rpmfind.net/xml.html for
118
119
example in the HTML parser is the following:</p>
<ol>
120
<li>The default entity loader calls <code>xmlNewInputFromFile()</code> with
121
    the parsing context and the URI string.</li>
122
123
124
125
<li>the URI string is checked against the existing registered handlers
    using their match() callback function, if the HTTP module was compiled
    in, it is registered and its match() function will succeeds</li>
<li>the open() function of the handler is called and if successful will
126
    return an I/O Input buffer</li>
127
<li>the parser will the start reading from this buffer and progressively
128
129
    fetch information from the resource, calling the read() function of the
    handler until the resource is exhausted</li>
130
<li>if an encoding change is detected it will be installed on the input
131
132
    buffer, providing buffering and efficient use of the conversion
  routines</li>
133
<li>once the parser has finished, the close() function of the handler is
134
135
136
137
138
    called once and the Input buffer and associed resources are
  deallocated.</li>
</ol>
<p>The user defined callbacks are checked first to allow overriding of the
default libxml I/O routines.</p>
139
<h3><a name="basic">The basic buffer type</a></h3>
140
<p>All the buffer manipulation handling is done using the
141
142
143
<code>xmlBuffer</code> type define in <code><a href="http://xmlsoft.org/html/libxml-tree.html">tree.h</a></code>which is a
resizable memory buffer. The buffer allocation strategy can be selected to be
either best-fit or use an exponential doubling one (CPU vs. memory use
144
145
146
147
148
tradeoff). The values are <code>XML_BUFFER_ALLOC_EXACT</code> and
<code>XML_BUFFER_ALLOC_DOUBLEIT</code>, and can be set individually or on a
system wide basis using <code>xmlBufferSetAllocationScheme()</code>. A number
of functions allows to manipulate buffers with names starting with the
<code>xmlBuffer...</code> prefix.</p>
149
<h3><a name="Input">Input I/O handlers</a></h3>
150
151
152
153
154
155
<p>An Input I/O handler is a simple structure
<code>xmlParserInputBuffer</code> containing a context associated to the
resource (file descriptor, or pointer to a protocol handler), the read() and
close() callbacks to use and an xmlBuffer. And extra xmlBuffer and a charset
encoding handler are also present to support charset conversion when
needed.</p>
156
<h3><a name="Output">Output I/O handlers</a></h3>
157
158
<p>An Output handler <code>xmlOutputBuffer</code> is completely similar to an
Input one except the callbacks are write() and close().</p>
159
<h3><a name="entities">The entities loader</a></h3>
160
<p>The entity loader resolves requests for new entities and create inputs for
161
162
163
164
the parser. Creating an input from a filename or an URI string is done
through the xmlNewInputFromFile() routine.  The default entity loader do not
handle the PUBLIC identifier associated with an entity (if any). So it just
calls xmlNewInputFromFile() with the SYSTEM identifier (which is mandatory in
165
XML).</p>
166
167
<p>If you want to hook up a catalog mechanism then you simply need to
override the default entity loader, here is an example:</p>
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<pre>#include &lt;libxml/xmlIO.h&gt;

xmlExternalEntityLoader defaultLoader = NULL;

xmlParserInputPtr
xmlMyExternalEntityLoader(const char *URL, const char *ID,
                               xmlParserCtxtPtr ctxt) {
    xmlParserInputPtr ret;
    const char *fileID = NULL;
    /* lookup for the fileID depending on ID */

    ret = xmlNewInputFromFile(ctxt, fileID);
    if (ret != NULL)
        return(ret);
    if (defaultLoader != NULL)
        ret = defaultLoader(URL, ID, ctxt);
    return(ret);
}

int main(..) {
    ...

    /*
     * Install our own entity loader
     */
    defaultLoader = xmlGetExternalEntityLoader();
    xmlSetExternalEntityLoader(xmlMyExternalEntityLoader);

    ...
}</pre>
198
<h3><a name="Example2">Example of customized I/O</a></h3>
199
200
<p>This example come from <a href="http://xmlsoft.org/messages/0708.html">a
real use case</a>,  xmlDocDump() closes the FILE * passed by the application
201
and this was a problem. The <a href="http://xmlsoft.org/messages/0711.html">solution</a> was to redefine a
202
203
new output handler with the closing call deactivated:</p>
<ol>
204
<li>First define a new I/O ouput allocator where the output don't close the
205
    file:
Daniel Veillard's avatar
Daniel Veillard committed
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
    <pre>xmlOutputBufferPtr
xmlOutputBufferCreateOwn(FILE *file, xmlCharEncodingHandlerPtr encoder) {
xmlOutputBufferPtr ret;

if (xmlOutputCallbackInitialized == 0)
xmlRegisterDefaultOutputCallbacks();

if (file == NULL) return(NULL);
ret = xmlAllocOutputBuffer(encoder);
if (ret != NULL) {
ret-&gt;context = file;
ret-&gt;writecallback = xmlFileWrite;
ret-&gt;closecallback = NULL;  /* No close callback */
}
return(ret); <br>
221
222


223

224
225


226

Daniel Veillard's avatar
Daniel Veillard committed
227

228

229

230

231

232

233

234

235

236

237

238

239

240

241
} </pre>
242
243
</li>
<li>And then use it to save the document:
244
    <pre>FILE *f;
Daniel Veillard's avatar
Daniel Veillard committed
245
246
xmlOutputBufferPtr output;
xmlDocPtr doc;
247
int res;
Daniel Veillard's avatar
Daniel Veillard committed
248

249
250
f = ...
doc = ....
Daniel Veillard's avatar
Daniel Veillard committed
251

252
253
254
output = xmlOutputBufferCreateOwn(f, NULL);
res = xmlSaveFileTo(output, doc, NULL);
    </pre>
255
</li>
256
</ol>
257
<p><a href="mailto:daniel@veillard.com">Daniel Veillard</a></p>
258
259
</td></tr></table></td></tr></table></td></tr></table></td>
</tr></table></td></tr></table>
260
261
</body>
</html>