Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / b8cfbd12680cbd28c9eaafea2642b8f1cbd52a48 / . / doc / interface.html
blob: 64e32e91a9564ccb59c33ed0209173ce4ff02b2e [file] [log] [blame]
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
2<html>
3<head>
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}
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]11A:link, A:visited, A:active { text-decoration: underline }
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]12--></style>
13<title>The SAX interface</title>
14</head>
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>The SAX interface</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>
Daniel Veillard594cf0b2001-10-25 08:09:12 +0000[diff] [blame]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">
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]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>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]31<li><a href="intro.html">Introduction</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]32<li><a href="FAQ.html">FAQ</a></li>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]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>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]40<li><a href="architecture.html">libxml architecture</a></li>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]41<li><a href="tree.html">The tree output</a></li>
42<li><a href="interface.html">The SAX interface</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]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>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]49<li><a href="entities.html">Entities or no entities</a></li>
50<li><a href="namespaces.html">Namespaces</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame^]51<li><a href="upgrade.html">Upgrading 1.x code</a></li>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]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>
Daniel Veillard594cf0b2001-10-25 08:09:12 +0000[diff] [blame]55<li>
56<a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
57</li>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]58</ul></td></tr>
Daniel Veillard594cf0b2001-10-25 08:09:12 +0000[diff] [blame]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>
Daniel Veillardc9484202001-10-24 12:35:52 +0000[diff] [blame]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">
73<p>Sometimes the DOM tree output is just too large to fit reasonably into
74memory. In that case (and if you don't expect to save back the XML document
75loaded using libxml), it's better to use the SAX interface of libxml. SAX is
76a <strong>callback-based interface</strong> to the parser. Before parsing,
77the application layer registers a customized set of callbacks which are
78called by the library as it progresses through the XML input.</p>
79<p>To get more detailed step-by-step guidance on using the SAX interface of
80libxml, see the <a href="http://www.daa.com.au/~james/gnome/xml-sax/xml-sax.html">nice
81documentation</a>.written by <a href="mailto:james@daa.com.au">James
82Henstridge</a>.</p>
83<p>You can debug the SAX behaviour by using the <strong>testSAX</strong>
84program located in the gnome-xml module (it's usually not shipped in the
85binary packages of libxml, but you can find it in the tar source
86distribution). Here is the sequence of callbacks that would be reported by
87testSAX when parsing the example XML document shown earlier:</p>
88<pre>SAX.setDocumentLocator()
89SAX.startDocument()
90SAX.getEntity(amp)
91SAX.startElement(EXAMPLE, prop1='gnome is great', prop2='&amp;amp; linux too')
92SAX.characters( , 3)
93SAX.startElement(head)
94SAX.characters( , 4)
95SAX.startElement(title)
96SAX.characters(Welcome to Gnome, 16)
97SAX.endElement(title)
98SAX.characters( , 3)
99SAX.endElement(head)
100SAX.characters( , 3)
101SAX.startElement(chapter)
102SAX.characters( , 4)
103SAX.startElement(title)
104SAX.characters(The Linux adventure, 19)
105SAX.endElement(title)
106SAX.characters( , 4)
107SAX.startElement(p)
108SAX.characters(bla bla bla ..., 15)
109SAX.endElement(p)
110SAX.characters( , 4)
111SAX.startElement(image, href='linus.gif')
112SAX.endElement(image)
113SAX.characters( , 4)
114SAX.startElement(p)
115SAX.characters(..., 3)
116SAX.endElement(p)
117SAX.characters( , 3)
118SAX.endElement(chapter)
119SAX.characters( , 1)
120SAX.endElement(EXAMPLE)
121SAX.endDocument()</pre>
122<p>Most of the other interfaces of libxml are based on the DOM tree-building
123facility, so nearly everything up to the end of this document presupposes the
124use of the standard DOM tree build. Note that the DOM tree itself is built by
125a set of registered default callbacks, without internal specific
126interface.</p>
127<p><a href="mailto:daniel@veillard.com">Daniel Veillard</a></p>
128</td></tr></table></td></tr></table></td></tr></table></td>
129</tr></table></td></tr></table>
130</body>
131</html>