15bb6a25fSPoul-Henning Kamp<?xml version="1.0" encoding="iso-8859-1"?> 25bb6a25fSPoul-Henning Kamp<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 35bb6a25fSPoul-Henning Kamp "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 45bb6a25fSPoul-Henning Kamp<html> 55bb6a25fSPoul-Henning Kamp<head> 65bb6a25fSPoul-Henning Kamp<!-- Copyright 1999,2000 Clark Cooper <coopercc@netheaven.com> 75bb6a25fSPoul-Henning Kamp All rights reserved. 85bb6a25fSPoul-Henning Kamp This is free software. You may distribute or modify according to 95bb6a25fSPoul-Henning Kamp the terms of the MIT/X License --> 105bb6a25fSPoul-Henning Kamp <title>Expat XML Parser</title> 115bb6a25fSPoul-Henning Kamp <meta name="author" content="Clark Cooper, coopercc@netheaven.com" /> 125bb6a25fSPoul-Henning Kamp <meta http-equiv="Content-Style-Type" content="text/css" /> 135bb6a25fSPoul-Henning Kamp <link href="style.css" rel="stylesheet" type="text/css" /> 145bb6a25fSPoul-Henning Kamp</head> 155bb6a25fSPoul-Henning Kamp<body> 16220ed979SColeman Kane <table cellspacing="0" cellpadding="0" width="100%"> 17220ed979SColeman Kane <tr> 18220ed979SColeman Kane <td class="corner"><img src="expat.png" alt="(Expat logo)" /></td> 19220ed979SColeman Kane <td class="banner"><h1>The Expat XML Parser</h1></td> 20220ed979SColeman Kane </tr> 21220ed979SColeman Kane <tr> 22220ed979SColeman Kane <td class="releaseno">Release 2.0.1</td> 23220ed979SColeman Kane <td></td> 24220ed979SColeman Kane </tr> 25220ed979SColeman Kane </table> 26220ed979SColeman Kane<div class="content"> 275bb6a25fSPoul-Henning Kamp 285bb6a25fSPoul-Henning Kamp<p>Expat is a library, written in C, for parsing XML documents. It's 295bb6a25fSPoul-Henning Kampthe underlying XML parser for the open source Mozilla project, Perl's 305bb6a25fSPoul-Henning Kamp<code>XML::Parser</code>, Python's <code>xml.parsers.expat</code>, and 315bb6a25fSPoul-Henning Kampother open-source XML parsers.</p> 325bb6a25fSPoul-Henning Kamp 335bb6a25fSPoul-Henning Kamp<p>This library is the creation of James Clark, who's also given us 340a48773fSEric van Gyzengroff (an nroff look-alike), Jade (an implementation of ISO's DSSSL 355bb6a25fSPoul-Henning Kampstylesheet language for SGML), XP (a Java XML parser package), XT (a 365bb6a25fSPoul-Henning KampJava XSL engine). James was also the technical lead on the XML 375bb6a25fSPoul-Henning KampWorking Group at W3C that produced the XML specification.</p> 385bb6a25fSPoul-Henning Kamp 395bb6a25fSPoul-Henning Kamp<p>This is free software, licensed under the <a 405bb6a25fSPoul-Henning Kamphref="../COPYING">MIT/X Consortium license</a>. You may download it 415bb6a25fSPoul-Henning Kampfrom <a href="http://www.libexpat.org/">the Expat home page</a>. 425bb6a25fSPoul-Henning Kamp</p> 435bb6a25fSPoul-Henning Kamp 44220ed979SColeman Kane<p>The bulk of this document was originally commissioned as an article 45220ed979SColeman Kaneby <a href="http://www.xml.com/">XML.com</a>. They graciously allowed 46220ed979SColeman KaneClark Cooper to retain copyright and to distribute it with Expat. 47220ed979SColeman KaneThis version has been substantially extended to include documentation 48220ed979SColeman Kaneon features which have been added since the original article was 49220ed979SColeman Kanepublished, and additional information on using the original 50220ed979SColeman Kaneinterface.</p> 515bb6a25fSPoul-Henning Kamp 525bb6a25fSPoul-Henning Kamp<hr /> 535bb6a25fSPoul-Henning Kamp<h2>Table of Contents</h2> 545bb6a25fSPoul-Henning Kamp<ul> 555bb6a25fSPoul-Henning Kamp <li><a href="#overview">Overview</a></li> 565bb6a25fSPoul-Henning Kamp <li><a href="#building">Building and Installing</a></li> 575bb6a25fSPoul-Henning Kamp <li><a href="#using">Using Expat</a></li> 585bb6a25fSPoul-Henning Kamp <li><a href="#reference">Reference</a> 595bb6a25fSPoul-Henning Kamp <ul> 605bb6a25fSPoul-Henning Kamp <li><a href="#creation">Parser Creation Functions</a> 615bb6a25fSPoul-Henning Kamp <ul> 625bb6a25fSPoul-Henning Kamp <li><a href="#XML_ParserCreate">XML_ParserCreate</a></li> 635bb6a25fSPoul-Henning Kamp <li><a href="#XML_ParserCreateNS">XML_ParserCreateNS</a></li> 645bb6a25fSPoul-Henning Kamp <li><a href="#XML_ParserCreate_MM">XML_ParserCreate_MM</a></li> 655bb6a25fSPoul-Henning Kamp <li><a href="#XML_ExternalEntityParserCreate">XML_ExternalEntityParserCreate</a></li> 665bb6a25fSPoul-Henning Kamp <li><a href="#XML_ParserFree">XML_ParserFree</a></li> 675bb6a25fSPoul-Henning Kamp <li><a href="#XML_ParserReset">XML_ParserReset</a></li> 685bb6a25fSPoul-Henning Kamp </ul> 695bb6a25fSPoul-Henning Kamp </li> 705bb6a25fSPoul-Henning Kamp <li><a href="#parsing">Parsing Functions</a> 715bb6a25fSPoul-Henning Kamp <ul> 725bb6a25fSPoul-Henning Kamp <li><a href="#XML_Parse">XML_Parse</a></li> 735bb6a25fSPoul-Henning Kamp <li><a href="#XML_ParseBuffer">XML_ParseBuffer</a></li> 745bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetBuffer">XML_GetBuffer</a></li> 75220ed979SColeman Kane <li><a href="#XML_StopParser">XML_StopParser</a></li> 76220ed979SColeman Kane <li><a href="#XML_ResumeParser">XML_ResumeParser</a></li> 77220ed979SColeman Kane <li><a href="#XML_GetParsingStatus">XML_GetParsingStatus</a></li> 785bb6a25fSPoul-Henning Kamp </ul> 795bb6a25fSPoul-Henning Kamp </li> 805bb6a25fSPoul-Henning Kamp <li><a href="#setting">Handler Setting Functions</a> 815bb6a25fSPoul-Henning Kamp <ul> 825bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetStartElementHandler">XML_SetStartElementHandler</a></li> 835bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetEndElementHandler">XML_SetEndElementHandler</a></li> 845bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetElementHandler">XML_SetElementHandler</a></li> 855bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetCharacterDataHandler">XML_SetCharacterDataHandler</a></li> 865bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetProcessingInstructionHandler">XML_SetProcessingInstructionHandler</a></li> 875bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetCommentHandler">XML_SetCommentHandler</a></li> 885bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetStartCdataSectionHandler">XML_SetStartCdataSectionHandler</a></li> 895bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetEndCdataSectionHandler">XML_SetEndCdataSectionHandler</a></li> 905bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetCdataSectionHandler">XML_SetCdataSectionHandler</a></li> 915bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetDefaultHandler">XML_SetDefaultHandler</a></li> 925bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetDefaultHandlerExpand">XML_SetDefaultHandlerExpand</a></li> 935bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetExternalEntityRefHandler">XML_SetExternalEntityRefHandler</a></li> 94220ed979SColeman Kane <li><a href="#XML_SetExternalEntityRefHandlerArg">XML_SetExternalEntityRefHandlerArg</a></li> 955bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetSkippedEntityHandler">XML_SetSkippedEntityHandler</a></li> 965bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetUnknownEncodingHandler">XML_SetUnknownEncodingHandler</a></li> 975bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetStartNamespaceDeclHandler">XML_SetStartNamespaceDeclHandler</a></li> 985bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetEndNamespaceDeclHandler">XML_SetEndNamespaceDeclHandler</a></li> 995bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetNamespaceDeclHandler">XML_SetNamespaceDeclHandler</a></li> 1005bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetXmlDeclHandler">XML_SetXmlDeclHandler</a></li> 1015bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetStartDoctypeDeclHandler">XML_SetStartDoctypeDeclHandler</a></li> 1025bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetEndDoctypeDeclHandler">XML_SetEndDoctypeDeclHandler</a></li> 1035bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetDoctypeDeclHandler">XML_SetDoctypeDeclHandler</a></li> 1045bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetElementDeclHandler">XML_SetElementDeclHandler</a></li> 1055bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetAttlistDeclHandler">XML_SetAttlistDeclHandler</a></li> 1065bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetEntityDeclHandler">XML_SetEntityDeclHandler</a></li> 1075bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetUnparsedEntityDeclHandler">XML_SetUnparsedEntityDeclHandler</a></li> 1085bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetNotationDeclHandler">XML_SetNotationDeclHandler</a></li> 1095bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetNotStandaloneHandler">XML_SetNotStandaloneHandler</a></li> 1105bb6a25fSPoul-Henning Kamp </ul> 1115bb6a25fSPoul-Henning Kamp </li> 1125bb6a25fSPoul-Henning Kamp <li><a href="#position">Parse Position and Error Reporting Functions</a> 1135bb6a25fSPoul-Henning Kamp <ul> 1145bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetErrorCode">XML_GetErrorCode</a></li> 1155bb6a25fSPoul-Henning Kamp <li><a href="#XML_ErrorString">XML_ErrorString</a></li> 1165bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetCurrentByteIndex">XML_GetCurrentByteIndex</a></li> 1175bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetCurrentLineNumber">XML_GetCurrentLineNumber</a></li> 1185bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetCurrentColumnNumber">XML_GetCurrentColumnNumber</a></li> 1195bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetCurrentByteCount">XML_GetCurrentByteCount</a></li> 1205bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetInputContext">XML_GetInputContext</a></li> 1215bb6a25fSPoul-Henning Kamp </ul> 1225bb6a25fSPoul-Henning Kamp </li> 1235bb6a25fSPoul-Henning Kamp <li><a href="#miscellaneous">Miscellaneous Functions</a> 1245bb6a25fSPoul-Henning Kamp <ul> 1255bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetUserData">XML_SetUserData</a></li> 1265bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetUserData">XML_GetUserData</a></li> 1275bb6a25fSPoul-Henning Kamp <li><a href="#XML_UseParserAsHandlerArg">XML_UseParserAsHandlerArg</a></li> 1285bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetBase">XML_SetBase</a></li> 1295bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetBase">XML_GetBase</a></li> 1305bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetSpecifiedAttributeCount">XML_GetSpecifiedAttributeCount</a></li> 1315bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetIdAttributeIndex">XML_GetIdAttributeIndex</a></li> 132e3466a89SXin LI <li><a href="#XML_GetAttributeInfo">XML_GetAttributeInfo</a></li> 1335bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetEncoding">XML_SetEncoding</a></li> 1345bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetParamEntityParsing">XML_SetParamEntityParsing</a></li> 135e3466a89SXin LI <li><a href="#XML_SetHashSalt">XML_SetHashSalt</a></li> 1365bb6a25fSPoul-Henning Kamp <li><a href="#XML_UseForeignDTD">XML_UseForeignDTD</a></li> 1375bb6a25fSPoul-Henning Kamp <li><a href="#XML_SetReturnNSTriplet">XML_SetReturnNSTriplet</a></li> 1385bb6a25fSPoul-Henning Kamp <li><a href="#XML_DefaultCurrent">XML_DefaultCurrent</a></li> 1395bb6a25fSPoul-Henning Kamp <li><a href="#XML_ExpatVersion">XML_ExpatVersion</a></li> 1405bb6a25fSPoul-Henning Kamp <li><a href="#XML_ExpatVersionInfo">XML_ExpatVersionInfo</a></li> 1415bb6a25fSPoul-Henning Kamp <li><a href="#XML_GetFeatureList">XML_GetFeatureList</a></li> 142220ed979SColeman Kane <li><a href="#XML_FreeContentModel">XML_FreeContentModel</a></li> 143220ed979SColeman Kane <li><a href="#XML_MemMalloc">XML_MemMalloc</a></li> 144220ed979SColeman Kane <li><a href="#XML_MemRealloc">XML_MemRealloc</a></li> 145220ed979SColeman Kane <li><a href="#XML_MemFree">XML_MemFree</a></li> 1465bb6a25fSPoul-Henning Kamp </ul> 1475bb6a25fSPoul-Henning Kamp </li> 1485bb6a25fSPoul-Henning Kamp </ul> 1495bb6a25fSPoul-Henning Kamp </li> 1505bb6a25fSPoul-Henning Kamp</ul> 1515bb6a25fSPoul-Henning Kamp 1525bb6a25fSPoul-Henning Kamp<hr /> 1535bb6a25fSPoul-Henning Kamp<h2><a name="overview">Overview</a></h2> 1545bb6a25fSPoul-Henning Kamp 1555bb6a25fSPoul-Henning Kamp<p>Expat is a stream-oriented parser. You register callback (or 1565bb6a25fSPoul-Henning Kamphandler) functions with the parser and then start feeding it the 1575bb6a25fSPoul-Henning Kampdocument. As the parser recognizes parts of the document, it will 1585bb6a25fSPoul-Henning Kampcall the appropriate handler for that part (if you've registered one.) 1595bb6a25fSPoul-Henning KampThe document is fed to the parser in pieces, so you can start parsing 1605bb6a25fSPoul-Henning Kampbefore you have all the document. This also allows you to parse really 1615bb6a25fSPoul-Henning Kamphuge documents that won't fit into memory.</p> 1625bb6a25fSPoul-Henning Kamp 1635bb6a25fSPoul-Henning Kamp<p>Expat can be intimidating due to the many kinds of handlers and 1645bb6a25fSPoul-Henning Kampoptions you can set. But you only need to learn four functions in 1655bb6a25fSPoul-Henning Kamporder to do 90% of what you'll want to do with it:</p> 1665bb6a25fSPoul-Henning Kamp 1675bb6a25fSPoul-Henning Kamp<dl> 1685bb6a25fSPoul-Henning Kamp 1695bb6a25fSPoul-Henning Kamp<dt><code><a href= "#XML_ParserCreate" 1705bb6a25fSPoul-Henning Kamp >XML_ParserCreate</a></code></dt> 1715bb6a25fSPoul-Henning Kamp <dd>Create a new parser object.</dd> 1725bb6a25fSPoul-Henning Kamp 1735bb6a25fSPoul-Henning Kamp<dt><code><a href= "#XML_SetElementHandler" 1745bb6a25fSPoul-Henning Kamp >XML_SetElementHandler</a></code></dt> 1755bb6a25fSPoul-Henning Kamp <dd>Set handlers for start and end tags.</dd> 1765bb6a25fSPoul-Henning Kamp 1775bb6a25fSPoul-Henning Kamp<dt><code><a href= "#XML_SetCharacterDataHandler" 1785bb6a25fSPoul-Henning Kamp >XML_SetCharacterDataHandler</a></code></dt> 1795bb6a25fSPoul-Henning Kamp <dd>Set handler for text.</dd> 1805bb6a25fSPoul-Henning Kamp 1815bb6a25fSPoul-Henning Kamp<dt><code><a href= "#XML_Parse" 1825bb6a25fSPoul-Henning Kamp >XML_Parse</a></code></dt> 1835bb6a25fSPoul-Henning Kamp <dd>Pass a buffer full of document to the parser</dd> 1845bb6a25fSPoul-Henning Kamp</dl> 1855bb6a25fSPoul-Henning Kamp 1865bb6a25fSPoul-Henning Kamp<p>These functions and others are described in the <a 1875bb6a25fSPoul-Henning Kamphref="#reference">reference</a> part of this document. The reference 1885bb6a25fSPoul-Henning Kampsection also describes in detail the parameters passed to the 1895bb6a25fSPoul-Henning Kampdifferent types of handlers.</p> 1905bb6a25fSPoul-Henning Kamp 1915bb6a25fSPoul-Henning Kamp<p>Let's look at a very simple example program that only uses 3 of the 1925bb6a25fSPoul-Henning Kampabove functions (it doesn't need to set a character handler.) The 1935bb6a25fSPoul-Henning Kampprogram <a href="../examples/outline.c">outline.c</a> prints an 1945bb6a25fSPoul-Henning Kampelement outline, indenting child elements to distinguish them from the 1955bb6a25fSPoul-Henning Kampparent element that contains them. The start handler does all the 1965bb6a25fSPoul-Henning Kampwork. It prints two indenting spaces for every level of ancestor 1975bb6a25fSPoul-Henning Kampelements, then it prints the element and attribute 1985bb6a25fSPoul-Henning Kampinformation. Finally it increments the global <code>Depth</code> 1995bb6a25fSPoul-Henning Kampvariable.</p> 2005bb6a25fSPoul-Henning Kamp 2015bb6a25fSPoul-Henning Kamp<pre class="eg"> 2025bb6a25fSPoul-Henning Kampint Depth; 2035bb6a25fSPoul-Henning Kamp 204220ed979SColeman Kanevoid XMLCALL 2055bb6a25fSPoul-Henning Kampstart(void *data, const char *el, const char **attr) { 2065bb6a25fSPoul-Henning Kamp int i; 2075bb6a25fSPoul-Henning Kamp 2085bb6a25fSPoul-Henning Kamp for (i = 0; i < Depth; i++) 2095bb6a25fSPoul-Henning Kamp printf(" "); 2105bb6a25fSPoul-Henning Kamp 2115bb6a25fSPoul-Henning Kamp printf("%s", el); 2125bb6a25fSPoul-Henning Kamp 2135bb6a25fSPoul-Henning Kamp for (i = 0; attr[i]; i += 2) { 2145bb6a25fSPoul-Henning Kamp printf(" %s='%s'", attr[i], attr[i + 1]); 2155bb6a25fSPoul-Henning Kamp } 2165bb6a25fSPoul-Henning Kamp 2175bb6a25fSPoul-Henning Kamp printf("\n"); 2185bb6a25fSPoul-Henning Kamp Depth++; 2195bb6a25fSPoul-Henning Kamp} /* End of start handler */ 2205bb6a25fSPoul-Henning Kamp</pre> 2215bb6a25fSPoul-Henning Kamp 2225bb6a25fSPoul-Henning Kamp<p>The end tag simply does the bookkeeping work of decrementing 2235bb6a25fSPoul-Henning Kamp<code>Depth</code>.</p> 2245bb6a25fSPoul-Henning Kamp<pre class="eg"> 225220ed979SColeman Kanevoid XMLCALL 2265bb6a25fSPoul-Henning Kampend(void *data, const char *el) { 2275bb6a25fSPoul-Henning Kamp Depth--; 2285bb6a25fSPoul-Henning Kamp} /* End of end handler */ 2295bb6a25fSPoul-Henning Kamp</pre> 2305bb6a25fSPoul-Henning Kamp 231220ed979SColeman Kane<p>Note the <code>XMLCALL</code> annotation used for the callbacks. 232220ed979SColeman KaneThis is used to ensure that the Expat and the callbacks are using the 233220ed979SColeman Kanesame calling convention in case the compiler options used for Expat 234220ed979SColeman Kaneitself and the client code are different. Expat tries not to care 235220ed979SColeman Kanewhat the default calling convention is, though it may require that it 236220ed979SColeman Kanebe compiled with a default convention of "cdecl" on some platforms. 237220ed979SColeman KaneFor code which uses Expat, however, the calling convention is 238220ed979SColeman Kanespecified by the <code>XMLCALL</code> annotation on most platforms; 239220ed979SColeman Kanecallbacks should be defined using this annotation.</p> 240220ed979SColeman Kane 241220ed979SColeman Kane<p>The <code>XMLCALL</code> annotation was added in Expat 1.95.7, but 242220ed979SColeman Kaneexisting working Expat applications don't need to add it (since they 243220ed979SColeman Kaneare already using the "cdecl" calling convention, or they wouldn't be 244220ed979SColeman Kaneworking). The annotation is only needed if the default calling 245220ed979SColeman Kaneconvention may be something other than "cdecl". To use the annotation 246220ed979SColeman Kanesafely with older versions of Expat, you can conditionally define it 247220ed979SColeman Kane<em>after</em> including Expat's header file:</p> 248220ed979SColeman Kane 249220ed979SColeman Kane<pre class="eg"> 250220ed979SColeman Kane#include <expat.h> 251220ed979SColeman Kane 252220ed979SColeman Kane#ifndef XMLCALL 253220ed979SColeman Kane#if defined(_MSC_EXTENSIONS) && !defined(__BEOS__) && !defined(__CYGWIN__) 254220ed979SColeman Kane#define XMLCALL __cdecl 255220ed979SColeman Kane#elif defined(__GNUC__) 256220ed979SColeman Kane#define XMLCALL __attribute__((cdecl)) 257220ed979SColeman Kane#else 258220ed979SColeman Kane#define XMLCALL 259220ed979SColeman Kane#endif 260220ed979SColeman Kane#endif 261220ed979SColeman Kane</pre> 262220ed979SColeman Kane 2635bb6a25fSPoul-Henning Kamp<p>After creating the parser, the main program just has the job of 2645bb6a25fSPoul-Henning Kampshoveling the document to the parser so that it can do its work.</p> 2655bb6a25fSPoul-Henning Kamp 2665bb6a25fSPoul-Henning Kamp<hr /> 2675bb6a25fSPoul-Henning Kamp<h2><a name="building">Building and Installing Expat</a></h2> 2685bb6a25fSPoul-Henning Kamp 2695bb6a25fSPoul-Henning Kamp<p>The Expat distribution comes as a compressed (with GNU gzip) tar 2705bb6a25fSPoul-Henning Kampfile. You may download the latest version from <a href= 2715bb6a25fSPoul-Henning Kamp"http://sourceforge.net/projects/expat/" >Source Forge</a>. After 2725bb6a25fSPoul-Henning Kampunpacking this, cd into the directory. Then follow either the Win32 2735bb6a25fSPoul-Henning Kampdirections or Unix directions below.</p> 2745bb6a25fSPoul-Henning Kamp 2755bb6a25fSPoul-Henning Kamp<h3>Building under Win32</h3> 2765bb6a25fSPoul-Henning Kamp 2775bb6a25fSPoul-Henning Kamp<p>If you're using the GNU compiler under cygwin, follow the Unix 2785bb6a25fSPoul-Henning Kampdirections in the next section. Otherwise if you have Microsoft's 279*6b2c1e49SXin LIDeveloper Studio installed, 280*6b2c1e49SXin LIyou can use CMake to generate a <code>.sln</code> file, e.g. 281*6b2c1e49SXin LI<code> 282*6b2c1e49SXin LIcmake -G"Visual Studio 15 2017" -DCMAKE_BUILD_TYPE=RelWithDebInfo . 283*6b2c1e49SXin LI</code>, and build Expat using <code>msbuild /m expat.sln</code> after.</p> 2845bb6a25fSPoul-Henning Kamp 2855bb6a25fSPoul-Henning Kamp<p>Alternatively, you may download the Win32 binary package that 2865bb6a25fSPoul-Henning Kampcontains the "expat.h" include file and a pre-built DLL.</p> 2875bb6a25fSPoul-Henning Kamp 2885bb6a25fSPoul-Henning Kamp<h3>Building under Unix (or GNU)</h3> 2895bb6a25fSPoul-Henning Kamp 2905bb6a25fSPoul-Henning Kamp<p>First you'll need to run the configure shell script in order to 2915bb6a25fSPoul-Henning Kampconfigure the Makefiles and headers for your system.</p> 2925bb6a25fSPoul-Henning Kamp 2935bb6a25fSPoul-Henning Kamp<p>If you're happy with all the defaults that configure picks for you, 2945bb6a25fSPoul-Henning Kampand you have permission on your system to install into /usr/local, you 2955bb6a25fSPoul-Henning Kampcan install Expat with this sequence of commands:</p> 2965bb6a25fSPoul-Henning Kamp 2975bb6a25fSPoul-Henning Kamp<pre class="eg"> 2985bb6a25fSPoul-Henning Kamp./configure 2995bb6a25fSPoul-Henning Kampmake 3005bb6a25fSPoul-Henning Kampmake install 3015bb6a25fSPoul-Henning Kamp</pre> 3025bb6a25fSPoul-Henning Kamp 3035bb6a25fSPoul-Henning Kamp<p>There are some options that you can provide to this script, but the 3045bb6a25fSPoul-Henning Kamponly one we'll mention here is the <code>--prefix</code> option. You 3055bb6a25fSPoul-Henning Kampcan find out all the options available by running configure with just 3065bb6a25fSPoul-Henning Kampthe <code>--help</code> option.</p> 3075bb6a25fSPoul-Henning Kamp 3085bb6a25fSPoul-Henning Kamp<p>By default, the configure script sets things up so that the library 3095bb6a25fSPoul-Henning Kampgets installed in <code>/usr/local/lib</code> and the associated 3105bb6a25fSPoul-Henning Kampheader file in <code>/usr/local/include</code>. But if you were to 3115bb6a25fSPoul-Henning Kampgive the option, <code>--prefix=/home/me/mystuff</code>, then the 3125bb6a25fSPoul-Henning Kamplibrary and header would get installed in 3135bb6a25fSPoul-Henning Kamp<code>/home/me/mystuff/lib</code> and 3145bb6a25fSPoul-Henning Kamp<code>/home/me/mystuff/include</code> respectively.</p> 3155bb6a25fSPoul-Henning Kamp 316220ed979SColeman Kane<h3>Configuring Expat Using the Pre-Processor</h3> 317220ed979SColeman Kane 318220ed979SColeman Kane<p>Expat's feature set can be configured using a small number of 319220ed979SColeman Kanepre-processor definitions. The definition of this symbols does not 320220ed979SColeman Kaneaffect the set of entry points for Expat, only the behavior of the API 321220ed979SColeman Kaneand the definition of character types in the case of 322220ed979SColeman Kane<code>XML_UNICODE_WCHAR_T</code>. The symbols are:</p> 323220ed979SColeman Kane 324220ed979SColeman Kane<dl class="cpp-symbols"> 325220ed979SColeman Kane<dt>XML_DTD</dt> 326220ed979SColeman Kane<dd>Include support for using and reporting DTD-based content. If 327220ed979SColeman Kanethis is defined, default attribute values from an external DTD subset 328220ed979SColeman Kaneare reported and attribute value normalization occurs based on the 329220ed979SColeman Kanetype of attributes defined in the external subset. Without 330220ed979SColeman Kanethis, Expat has a smaller memory footprint and can be faster, but will 331220ed979SColeman Kanenot load external entities or process conditional sections. This does 332220ed979SColeman Kanenot affect the set of functions available in the API.</dd> 333220ed979SColeman Kane 334220ed979SColeman Kane<dt>XML_NS</dt> 335220ed979SColeman Kane<dd>When defined, support for the <cite><a href= 336220ed979SColeman Kane"http://www.w3.org/TR/REC-xml-names/" >Namespaces in XML</a></cite> 337220ed979SColeman Kanespecification is included.</dd> 338220ed979SColeman Kane 339220ed979SColeman Kane<dt>XML_UNICODE</dt> 340220ed979SColeman Kane<dd>When defined, character data reported to the application is 341220ed979SColeman Kaneencoded in UTF-16 using wide characters of the type 342220ed979SColeman Kane<code>XML_Char</code>. This is implied if 343220ed979SColeman Kane<code>XML_UNICODE_WCHAR_T</code> is defined.</dd> 344220ed979SColeman Kane 345220ed979SColeman Kane<dt>XML_UNICODE_WCHAR_T</dt> 346220ed979SColeman Kane<dd>If defined, causes the <code>XML_Char</code> character type to be 347220ed979SColeman Kanedefined using the <code>wchar_t</code> type; otherwise, <code>unsigned 348220ed979SColeman Kaneshort</code> is used. Defining this implies 349220ed979SColeman Kane<code>XML_UNICODE</code>.</dd> 350220ed979SColeman Kane 351220ed979SColeman Kane<dt>XML_LARGE_SIZE</dt> 352220ed979SColeman Kane<dd>If defined, causes the <code>XML_Size</code> and <code>XML_Index</code> 353220ed979SColeman Kaneinteger types to be at least 64 bits in size. This is intended to support 354220ed979SColeman Kaneprocessing of very large input streams, where the return values of 355220ed979SColeman Kane<code><a href="#XML_GetCurrentByteIndex" >XML_GetCurrentByteIndex</a></code>, 356220ed979SColeman Kane<code><a href="#XML_GetCurrentLineNumber" >XML_GetCurrentLineNumber</a></code> and 357220ed979SColeman Kane<code><a href="#XML_GetCurrentColumnNumber" >XML_GetCurrentColumnNumber</a></code> 358220ed979SColeman Kanecould overflow. It may not be supported by all compilers, and is turned 359220ed979SColeman Kaneoff by default.</dd> 360220ed979SColeman Kane 361220ed979SColeman Kane<dt>XML_CONTEXT_BYTES</dt> 362220ed979SColeman Kane<dd>The number of input bytes of markup context which the parser will 363220ed979SColeman Kaneensure are available for reporting via <code><a href= 364220ed979SColeman Kane"#XML_GetInputContext" >XML_GetInputContext</a></code>. This is 3650a48773fSEric van Gyzennormally set to 1024, and must be set to a positive integer. If this 366220ed979SColeman Kaneis not defined, the input context will not be available and <code><a 367220ed979SColeman Kanehref= "#XML_GetInputContext" >XML_GetInputContext</a></code> will 368220ed979SColeman Kanealways report NULL. Without this, Expat has a smaller memory 369220ed979SColeman Kanefootprint and can be faster.</dd> 370220ed979SColeman Kane 371220ed979SColeman Kane<dt>XML_STATIC</dt> 372220ed979SColeman Kane<dd>On Windows, this should be set if Expat is going to be linked 373220ed979SColeman Kanestatically with the code that calls it; this is required to get all 374220ed979SColeman Kanethe right MSVC magic annotations correct. This is ignored on other 375220ed979SColeman Kaneplatforms.</dd> 376e3466a89SXin LI 377e3466a89SXin LI<dt>XML_ATTR_INFO</dt> 3780a48773fSEric van Gyzen<dd>If defined, makes the additional function <code><a href= 379e3466a89SXin LI"#XML_GetAttributeInfo" >XML_GetAttributeInfo</a></code> available 380e3466a89SXin LIfor reporting attribute byte offsets.</dd> 381220ed979SColeman Kane</dl> 382220ed979SColeman Kane 3835bb6a25fSPoul-Henning Kamp<hr /> 3845bb6a25fSPoul-Henning Kamp<h2><a name="using">Using Expat</a></h2> 3855bb6a25fSPoul-Henning Kamp 3865bb6a25fSPoul-Henning Kamp<h3>Compiling and Linking Against Expat</h3> 3875bb6a25fSPoul-Henning Kamp 3885bb6a25fSPoul-Henning Kamp<p>Unless you installed Expat in a location not expected by your 3895bb6a25fSPoul-Henning Kampcompiler and linker, all you have to do to use Expat in your programs 3905bb6a25fSPoul-Henning Kampis to include the Expat header (<code>#include <expat.h></code>) 3915bb6a25fSPoul-Henning Kampin your files that make calls to it and to tell the linker that it 3925bb6a25fSPoul-Henning Kampneeds to link against the Expat library. On Unix systems, this would 3935bb6a25fSPoul-Henning Kampusually be done with the <code>-lexpat</code> argument. Otherwise, 3945bb6a25fSPoul-Henning Kampyou'll need to tell the compiler where to look for the Expat header 3955bb6a25fSPoul-Henning Kampand the linker where to find the Expat library. You may also need to 396220ed979SColeman Kanetake steps to tell the operating system where to find this library at 3975bb6a25fSPoul-Henning Kamprun time.</p> 3985bb6a25fSPoul-Henning Kamp 3995bb6a25fSPoul-Henning Kamp<p>On a Unix-based system, here's what a Makefile might look like when 4005bb6a25fSPoul-Henning KampExpat is installed in a standard location:</p> 4015bb6a25fSPoul-Henning Kamp 4025bb6a25fSPoul-Henning Kamp<pre class="eg"> 4035bb6a25fSPoul-Henning KampCC=cc 4045bb6a25fSPoul-Henning KampLDFLAGS= 4055bb6a25fSPoul-Henning KampLIBS= -lexpat 4065bb6a25fSPoul-Henning Kampxmlapp: xmlapp.o 4075bb6a25fSPoul-Henning Kamp $(CC) $(LDFLAGS) -o xmlapp xmlapp.o $(LIBS) 4085bb6a25fSPoul-Henning Kamp</pre> 4095bb6a25fSPoul-Henning Kamp 4105bb6a25fSPoul-Henning Kamp<p>If you installed Expat in, say, <code>/home/me/mystuff</code>, then 4115bb6a25fSPoul-Henning Kampthe Makefile would look like this:</p> 4125bb6a25fSPoul-Henning Kamp 4135bb6a25fSPoul-Henning Kamp<pre class="eg"> 4145bb6a25fSPoul-Henning KampCC=cc 4155bb6a25fSPoul-Henning KampCFLAGS= -I/home/me/mystuff/include 4165bb6a25fSPoul-Henning KampLDFLAGS= 4175bb6a25fSPoul-Henning KampLIBS= -L/home/me/mystuff/lib -lexpat 4185bb6a25fSPoul-Henning Kampxmlapp: xmlapp.o 4195bb6a25fSPoul-Henning Kamp $(CC) $(LDFLAGS) -o xmlapp xmlapp.o $(LIBS) 4205bb6a25fSPoul-Henning Kamp</pre> 4215bb6a25fSPoul-Henning Kamp 4225bb6a25fSPoul-Henning Kamp<p>You'd also have to set the environment variable 4235bb6a25fSPoul-Henning Kamp<code>LD_LIBRARY_PATH</code> to <code>/home/me/mystuff/lib</code> (or 4245bb6a25fSPoul-Henning Kampto <code>${LD_LIBRARY_PATH}:/home/me/mystuff/lib</code> if 4255bb6a25fSPoul-Henning KampLD_LIBRARY_PATH already has some directories in it) in order to run 4265bb6a25fSPoul-Henning Kampyour application.</p> 4275bb6a25fSPoul-Henning Kamp 4285bb6a25fSPoul-Henning Kamp<h3>Expat Basics</h3> 4295bb6a25fSPoul-Henning Kamp 4305bb6a25fSPoul-Henning Kamp<p>As we saw in the example in the overview, the first step in parsing 4315bb6a25fSPoul-Henning Kampan XML document with Expat is to create a parser object. There are <a 4325bb6a25fSPoul-Henning Kamphref="#creation">three functions</a> in the Expat API for creating a 4335bb6a25fSPoul-Henning Kampparser object. However, only two of these (<code><a href= 4345bb6a25fSPoul-Henning Kamp"#XML_ParserCreate" >XML_ParserCreate</a></code> and <code><a href= 4355bb6a25fSPoul-Henning Kamp"#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>) can be used for 4365bb6a25fSPoul-Henning Kampconstructing a parser for a top-level document. The object returned 4375bb6a25fSPoul-Henning Kampby these functions is an opaque pointer (i.e. "expat.h" declares it as 4385bb6a25fSPoul-Henning Kampvoid *) to data with further internal structure. In order to free the 4395bb6a25fSPoul-Henning Kampmemory associated with this object you must call <code><a href= 4405bb6a25fSPoul-Henning Kamp"#XML_ParserFree" >XML_ParserFree</a></code>. Note that if you have 441220ed979SColeman Kaneprovided any <a href="#userdata">user data</a> that gets stored in the 4425bb6a25fSPoul-Henning Kampparser, then your application is responsible for freeing it prior to 4435bb6a25fSPoul-Henning Kampcalling <code>XML_ParserFree</code>.</p> 4445bb6a25fSPoul-Henning Kamp 4455bb6a25fSPoul-Henning Kamp<p>The objects returned by the parser creation functions are good for 4465bb6a25fSPoul-Henning Kampparsing only one XML document or external parsed entity. If your 4475bb6a25fSPoul-Henning Kampapplication needs to parse many XML documents, then it needs to create 4485bb6a25fSPoul-Henning Kampa parser object for each one. The best way to deal with this is to 4495bb6a25fSPoul-Henning Kampcreate a higher level object that contains all the default 4505bb6a25fSPoul-Henning Kampinitialization you want for your parser objects.</p> 4515bb6a25fSPoul-Henning Kamp 4525bb6a25fSPoul-Henning Kamp<p>Walking through a document hierarchy with a stream oriented parser 4535bb6a25fSPoul-Henning Kampwill require a good stack mechanism in order to keep track of current 4545bb6a25fSPoul-Henning Kampcontext. For instance, to answer the simple question, "What element 4555bb6a25fSPoul-Henning Kampdoes this text belong to?" requires a stack, since the parser may have 4565bb6a25fSPoul-Henning Kampdescended into other elements that are children of the current one and 4575bb6a25fSPoul-Henning Kamphas encountered this text on the way out.</p> 4585bb6a25fSPoul-Henning Kamp 4595bb6a25fSPoul-Henning Kamp<p>The things you're likely to want to keep on a stack are the 4605bb6a25fSPoul-Henning Kampcurrently opened element and it's attributes. You push this 4615bb6a25fSPoul-Henning Kampinformation onto the stack in the start handler and you pop it off in 4625bb6a25fSPoul-Henning Kampthe end handler.</p> 4635bb6a25fSPoul-Henning Kamp 4645bb6a25fSPoul-Henning Kamp<p>For some tasks, it is sufficient to just keep information on what 4655bb6a25fSPoul-Henning Kampthe depth of the stack is (or would be if you had one.) The outline 4665bb6a25fSPoul-Henning Kampprogram shown above presents one example. Another such task would be 4675bb6a25fSPoul-Henning Kampskipping over a complete element. When you see the start tag for the 4685bb6a25fSPoul-Henning Kampelement you want to skip, you set a skip flag and record the depth at 4695bb6a25fSPoul-Henning Kampwhich the element started. When the end tag handler encounters the 4705bb6a25fSPoul-Henning Kampsame depth, the skipped element has ended and the flag may be 4715bb6a25fSPoul-Henning Kampcleared. If you follow the convention that the root element starts at 4725bb6a25fSPoul-Henning Kamp1, then you can use the same variable for skip flag and skip 4735bb6a25fSPoul-Henning Kampdepth.</p> 4745bb6a25fSPoul-Henning Kamp 4755bb6a25fSPoul-Henning Kamp<pre class="eg"> 4765bb6a25fSPoul-Henning Kampvoid 4775bb6a25fSPoul-Henning Kampinit_info(Parseinfo *info) { 4785bb6a25fSPoul-Henning Kamp info->skip = 0; 4795bb6a25fSPoul-Henning Kamp info->depth = 1; 4805bb6a25fSPoul-Henning Kamp /* Other initializations here */ 4815bb6a25fSPoul-Henning Kamp} /* End of init_info */ 4825bb6a25fSPoul-Henning Kamp 483220ed979SColeman Kanevoid XMLCALL 4845bb6a25fSPoul-Henning Kamprawstart(void *data, const char *el, const char **attr) { 4855bb6a25fSPoul-Henning Kamp Parseinfo *inf = (Parseinfo *) data; 4865bb6a25fSPoul-Henning Kamp 4875bb6a25fSPoul-Henning Kamp if (! inf->skip) { 4885bb6a25fSPoul-Henning Kamp if (should_skip(inf, el, attr)) { 4895bb6a25fSPoul-Henning Kamp inf->skip = inf->depth; 4905bb6a25fSPoul-Henning Kamp } 4915bb6a25fSPoul-Henning Kamp else 4925bb6a25fSPoul-Henning Kamp start(inf, el, attr); /* This does rest of start handling */ 4935bb6a25fSPoul-Henning Kamp } 4945bb6a25fSPoul-Henning Kamp 4955bb6a25fSPoul-Henning Kamp inf->depth++; 4965bb6a25fSPoul-Henning Kamp} /* End of rawstart */ 4975bb6a25fSPoul-Henning Kamp 498220ed979SColeman Kanevoid XMLCALL 4995bb6a25fSPoul-Henning Kamprawend(void *data, const char *el) { 5005bb6a25fSPoul-Henning Kamp Parseinfo *inf = (Parseinfo *) data; 5015bb6a25fSPoul-Henning Kamp 5025bb6a25fSPoul-Henning Kamp inf->depth--; 5035bb6a25fSPoul-Henning Kamp 5045bb6a25fSPoul-Henning Kamp if (! inf->skip) 5055bb6a25fSPoul-Henning Kamp end(inf, el); /* This does rest of end handling */ 5065bb6a25fSPoul-Henning Kamp 5075bb6a25fSPoul-Henning Kamp if (inf->skip == inf->depth) 5085bb6a25fSPoul-Henning Kamp inf->skip = 0; 5095bb6a25fSPoul-Henning Kamp} /* End rawend */ 5105bb6a25fSPoul-Henning Kamp</pre> 5115bb6a25fSPoul-Henning Kamp 5125bb6a25fSPoul-Henning Kamp<p>Notice in the above example the difference in how depth is 5135bb6a25fSPoul-Henning Kampmanipulated in the start and end handlers. The end tag handler should 5145bb6a25fSPoul-Henning Kampbe the mirror image of the start tag handler. This is necessary to 5155bb6a25fSPoul-Henning Kampproperly model containment. Since, in the start tag handler, we 5165bb6a25fSPoul-Henning Kampincremented depth <em>after</em> the main body of start tag code, then 5175bb6a25fSPoul-Henning Kampin the end handler, we need to manipulate it <em>before</em> the main 5185bb6a25fSPoul-Henning Kampbody. If we'd decided to increment it first thing in the start 5195bb6a25fSPoul-Henning Kamphandler, then we'd have had to decrement it last thing in the end 5205bb6a25fSPoul-Henning Kamphandler.</p> 5215bb6a25fSPoul-Henning Kamp 5225bb6a25fSPoul-Henning Kamp<h3 id="userdata">Communicating between handlers</h3> 5235bb6a25fSPoul-Henning Kamp 5245bb6a25fSPoul-Henning Kamp<p>In order to be able to pass information between different handlers 5255bb6a25fSPoul-Henning Kampwithout using globals, you'll need to define a data structure to hold 5265bb6a25fSPoul-Henning Kampthe shared variables. You can then tell Expat (with the <code><a href= 5275bb6a25fSPoul-Henning Kamp"#XML_SetUserData" >XML_SetUserData</a></code> function) to pass a 528220ed979SColeman Kanepointer to this structure to the handlers. This is the first 529220ed979SColeman Kaneargument received by most handlers. In the <a href="#reference" 530220ed979SColeman Kane>reference section</a>, an argument to a callback function is named 531220ed979SColeman Kane<code>userData</code> and have type <code>void *</code> if the user 532220ed979SColeman Kanedata is passed; it will have the type <code>XML_Parser</code> if the 533220ed979SColeman Kaneparser itself is passed. When the parser is passed, the user data may 534220ed979SColeman Kanebe retrieved using <code><a href="#XML_GetUserData" 535220ed979SColeman Kane>XML_GetUserData</a></code>.</p> 536220ed979SColeman Kane 537220ed979SColeman Kane<p>One common case where multiple calls to a single handler may need 538220ed979SColeman Kaneto communicate using an application data structure is the case when 539220ed979SColeman Kanecontent passed to the character data handler (set by <code><a href= 540220ed979SColeman Kane"#XML_SetCharacterDataHandler" 541220ed979SColeman Kane>XML_SetCharacterDataHandler</a></code>) needs to be accumulated. A 542220ed979SColeman Kanecommon first-time mistake with any of the event-oriented interfaces to 543220ed979SColeman Kanean XML parser is to expect all the text contained in an element to be 544220ed979SColeman Kanereported by a single call to the character data handler. Expat, like 545220ed979SColeman Kanemany other XML parsers, reports such data as a sequence of calls; 546220ed979SColeman Kanethere's no way to know when the end of the sequence is reached until a 547220ed979SColeman Kanedifferent callback is made. A buffer referenced by the user data 548220ed979SColeman Kanestructure proves both an effective and convenient place to accumulate 549220ed979SColeman Kanecharacter data.</p> 550220ed979SColeman Kane 551220ed979SColeman Kane<!-- XXX example needed here --> 552220ed979SColeman Kane 5535bb6a25fSPoul-Henning Kamp 5545bb6a25fSPoul-Henning Kamp<h3>XML Version</h3> 5555bb6a25fSPoul-Henning Kamp 5565bb6a25fSPoul-Henning Kamp<p>Expat is an XML 1.0 parser, and as such never complains based on 5575bb6a25fSPoul-Henning Kampthe value of the <code>version</code> pseudo-attribute in the XML 5585bb6a25fSPoul-Henning Kampdeclaration, if present.</p> 5595bb6a25fSPoul-Henning Kamp 5605bb6a25fSPoul-Henning Kamp<p>If an application needs to check the version number (to support 5615bb6a25fSPoul-Henning Kampalternate processing), it should use the <code><a href= 5625bb6a25fSPoul-Henning Kamp"#XML_SetXmlDeclHandler" >XML_SetXmlDeclHandler</a></code> function to 5635bb6a25fSPoul-Henning Kampset a handler that uses the information in the XML declaration to 5645bb6a25fSPoul-Henning Kampdetermine what to do. This example shows how to check that only a 5655bb6a25fSPoul-Henning Kampversion number of <code>"1.0"</code> is accepted:</p> 5665bb6a25fSPoul-Henning Kamp 5675bb6a25fSPoul-Henning Kamp<pre class="eg"> 5685bb6a25fSPoul-Henning Kampstatic int wrong_version; 5695bb6a25fSPoul-Henning Kampstatic XML_Parser parser; 5705bb6a25fSPoul-Henning Kamp 571220ed979SColeman Kanestatic void XMLCALL 5725bb6a25fSPoul-Henning Kampxmldecl_handler(void *userData, 5735bb6a25fSPoul-Henning Kamp const XML_Char *version, 5745bb6a25fSPoul-Henning Kamp const XML_Char *encoding, 5755bb6a25fSPoul-Henning Kamp int standalone) 5765bb6a25fSPoul-Henning Kamp{ 5775bb6a25fSPoul-Henning Kamp static const XML_Char Version_1_0[] = {'1', '.', '0', 0}; 5785bb6a25fSPoul-Henning Kamp 5795bb6a25fSPoul-Henning Kamp int i; 5805bb6a25fSPoul-Henning Kamp 5815bb6a25fSPoul-Henning Kamp for (i = 0; i < (sizeof(Version_1_0) / sizeof(Version_1_0[0])); ++i) { 5825bb6a25fSPoul-Henning Kamp if (version[i] != Version_1_0[i]) { 5835bb6a25fSPoul-Henning Kamp wrong_version = 1; 5845bb6a25fSPoul-Henning Kamp /* also clear all other handlers: */ 5855bb6a25fSPoul-Henning Kamp XML_SetCharacterDataHandler(parser, NULL); 5865bb6a25fSPoul-Henning Kamp ... 5875bb6a25fSPoul-Henning Kamp return; 5885bb6a25fSPoul-Henning Kamp } 5895bb6a25fSPoul-Henning Kamp } 5905bb6a25fSPoul-Henning Kamp ... 5915bb6a25fSPoul-Henning Kamp} 5925bb6a25fSPoul-Henning Kamp</pre> 5935bb6a25fSPoul-Henning Kamp 5945bb6a25fSPoul-Henning Kamp<h3>Namespace Processing</h3> 5955bb6a25fSPoul-Henning Kamp 5965bb6a25fSPoul-Henning Kamp<p>When the parser is created using the <code><a href= 5975bb6a25fSPoul-Henning Kamp"#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>, function, Expat 5985bb6a25fSPoul-Henning Kampperforms namespace processing. Under namespace processing, Expat 5995bb6a25fSPoul-Henning Kampconsumes <code>xmlns</code> and <code>xmlns:...</code> attributes, 6005bb6a25fSPoul-Henning Kampwhich declare namespaces for the scope of the element in which they 6015bb6a25fSPoul-Henning Kampoccur. This means that your start handler will not see these 6025bb6a25fSPoul-Henning Kampattributes. Your application can still be informed of these 6035bb6a25fSPoul-Henning Kampdeclarations by setting namespace declaration handlers with <a href= 6045bb6a25fSPoul-Henning Kamp"#XML_SetNamespaceDeclHandler" 6055bb6a25fSPoul-Henning Kamp><code>XML_SetNamespaceDeclHandler</code></a>.</p> 6065bb6a25fSPoul-Henning Kamp 6075bb6a25fSPoul-Henning Kamp<p>Element type and attribute names that belong to a given namespace 6085bb6a25fSPoul-Henning Kampare passed to the appropriate handler in expanded form. By default 6095bb6a25fSPoul-Henning Kampthis expanded form is a concatenation of the namespace URI, the 6105bb6a25fSPoul-Henning Kampseparator character (which is the 2nd argument to <code><a href= 6115bb6a25fSPoul-Henning Kamp"#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>), and the local 6125bb6a25fSPoul-Henning Kampname (i.e. the part after the colon). Names with undeclared prefixes 613220ed979SColeman Kaneare not well-formed when namespace processing is enabled, and will 614220ed979SColeman Kanetrigger an error. Unprefixed attribute names are never expanded, 6155bb6a25fSPoul-Henning Kampand unprefixed element names are only expanded when they are in the 6165bb6a25fSPoul-Henning Kampscope of a default namespace.</p> 6175bb6a25fSPoul-Henning Kamp 618220ed979SColeman Kane<p>However if <code><a href= "#XML_SetReturnNSTriplet" 6195bb6a25fSPoul-Henning Kamp>XML_SetReturnNSTriplet</a></code> has been called with a non-zero 6205bb6a25fSPoul-Henning Kamp<code>do_nst</code> parameter, then the expanded form for names with 6215bb6a25fSPoul-Henning Kampan explicit prefix is a concatenation of: URI, separator, local name, 6225bb6a25fSPoul-Henning Kampseparator, prefix.</p> 6235bb6a25fSPoul-Henning Kamp 6245bb6a25fSPoul-Henning Kamp<p>You can set handlers for the start of a namespace declaration and 6255bb6a25fSPoul-Henning Kampfor the end of a scope of a declaration with the <code><a href= 6265bb6a25fSPoul-Henning Kamp"#XML_SetNamespaceDeclHandler" >XML_SetNamespaceDeclHandler</a></code> 6275bb6a25fSPoul-Henning Kampfunction. The StartNamespaceDeclHandler is called prior to the start 628220ed979SColeman Kanetag handler and the EndNamespaceDeclHandler is called after the 6295bb6a25fSPoul-Henning Kampcorresponding end tag that ends the namespace's scope. The namespace 6305bb6a25fSPoul-Henning Kampstart handler gets passed the prefix and URI for the namespace. For a 6315bb6a25fSPoul-Henning Kampdefault namespace declaration (xmlns='...'), the prefix will be null. 6325bb6a25fSPoul-Henning KampThe URI will be null for the case where the default namespace is being 6335bb6a25fSPoul-Henning Kampunset. The namespace end handler just gets the prefix for the closing 6345bb6a25fSPoul-Henning Kampscope.</p> 6355bb6a25fSPoul-Henning Kamp 6365bb6a25fSPoul-Henning Kamp<p>These handlers are called for each declaration. So if, for 6375bb6a25fSPoul-Henning Kampinstance, a start tag had three namespace declarations, then the 6385bb6a25fSPoul-Henning KampStartNamespaceDeclHandler would be called three times before the start 6395bb6a25fSPoul-Henning Kamptag handler is called, once for each declaration.</p> 6405bb6a25fSPoul-Henning Kamp 6415bb6a25fSPoul-Henning Kamp<h3>Character Encodings</h3> 6425bb6a25fSPoul-Henning Kamp 6435bb6a25fSPoul-Henning Kamp<p>While XML is based on Unicode, and every XML processor is required 6445bb6a25fSPoul-Henning Kampto recognized UTF-8 and UTF-16 (1 and 2 byte encodings of Unicode), 6455bb6a25fSPoul-Henning Kampother encodings may be declared in XML documents or entities. For the 6465bb6a25fSPoul-Henning Kampmain document, an XML declaration may contain an encoding 6475bb6a25fSPoul-Henning Kampdeclaration:</p> 6485bb6a25fSPoul-Henning Kamp<pre> 6495bb6a25fSPoul-Henning Kamp<?xml version="1.0" encoding="ISO-8859-2"?> 6505bb6a25fSPoul-Henning Kamp</pre> 6515bb6a25fSPoul-Henning Kamp 6525bb6a25fSPoul-Henning Kamp<p>External parsed entities may begin with a text declaration, which 6535bb6a25fSPoul-Henning Kamplooks like an XML declaration with just an encoding declaration:</p> 6545bb6a25fSPoul-Henning Kamp<pre> 6555bb6a25fSPoul-Henning Kamp<?xml encoding="Big5"?> 6565bb6a25fSPoul-Henning Kamp</pre> 6575bb6a25fSPoul-Henning Kamp 6585bb6a25fSPoul-Henning Kamp<p>With Expat, you may also specify an encoding at the time of 6595bb6a25fSPoul-Henning Kampcreating a parser. This is useful when the encoding information may 6605bb6a25fSPoul-Henning Kampcome from a source outside the document itself (like a higher level 6615bb6a25fSPoul-Henning Kampprotocol.)</p> 6625bb6a25fSPoul-Henning Kamp 6635bb6a25fSPoul-Henning Kamp<p><a name="builtin_encodings"></a>There are four built-in encodings 6645bb6a25fSPoul-Henning Kampin Expat:</p> 6655bb6a25fSPoul-Henning Kamp<ul> 6665bb6a25fSPoul-Henning Kamp<li>UTF-8</li> 6675bb6a25fSPoul-Henning Kamp<li>UTF-16</li> 6685bb6a25fSPoul-Henning Kamp<li>ISO-8859-1</li> 6695bb6a25fSPoul-Henning Kamp<li>US-ASCII</li> 6705bb6a25fSPoul-Henning Kamp</ul> 6715bb6a25fSPoul-Henning Kamp 6725bb6a25fSPoul-Henning Kamp<p>Anything else discovered in an encoding declaration or in the 6735bb6a25fSPoul-Henning Kampprotocol encoding specified in the parser constructor, triggers a call 6745bb6a25fSPoul-Henning Kampto the <code>UnknownEncodingHandler</code>. This handler gets passed 6755bb6a25fSPoul-Henning Kampthe encoding name and a pointer to an <code>XML_Encoding</code> data 676220ed979SColeman Kanestructure. Your handler must fill in this structure and return 677220ed979SColeman Kane<code>XML_STATUS_OK</code> if it knows how to deal with the 678220ed979SColeman Kaneencoding. Otherwise the handler should return 679220ed979SColeman Kane<code>XML_STATUS_ERROR</code>. The handler also gets passed a pointer 680220ed979SColeman Kaneto an optional application data structure that you may indicate when 681220ed979SColeman Kaneyou set the handler.</p> 6825bb6a25fSPoul-Henning Kamp 6835bb6a25fSPoul-Henning Kamp<p>Expat places restrictions on character encodings that it can 6845bb6a25fSPoul-Henning Kampsupport by filling in the <code>XML_Encoding</code> structure. 6855bb6a25fSPoul-Henning Kampinclude file:</p> 6865bb6a25fSPoul-Henning Kamp<ol> 6875bb6a25fSPoul-Henning Kamp<li>Every ASCII character that can appear in a well-formed XML document 6885bb6a25fSPoul-Henning Kampmust be represented by a single byte, and that byte must correspond to 6895bb6a25fSPoul-Henning Kampit's ASCII encoding (except for the characters $@\^'{}~)</li> 6905bb6a25fSPoul-Henning Kamp<li>Characters must be encoded in 4 bytes or less.</li> 6915bb6a25fSPoul-Henning Kamp<li>All characters encoded must have Unicode scalar values less than or 6925bb6a25fSPoul-Henning Kampequal to 65535 (0xFFFF)<em>This does not apply to the built-in support 6935bb6a25fSPoul-Henning Kampfor UTF-16 and UTF-8</em></li> 6945bb6a25fSPoul-Henning Kamp<li>No character may be encoded by more that one distinct sequence of 6955bb6a25fSPoul-Henning Kampbytes</li> 6965bb6a25fSPoul-Henning Kamp</ol> 6975bb6a25fSPoul-Henning Kamp 6985bb6a25fSPoul-Henning Kamp<p><code>XML_Encoding</code> contains an array of integers that 6995bb6a25fSPoul-Henning Kampcorrespond to the 1st byte of an encoding sequence. If the value in 7005bb6a25fSPoul-Henning Kampthe array for a byte is zero or positive, then the byte is a single 7015bb6a25fSPoul-Henning Kampbyte encoding that encodes the Unicode scalar value contained in the 7025bb6a25fSPoul-Henning Kamparray. A -1 in this array indicates a malformed byte. If the value is 7035bb6a25fSPoul-Henning Kamp-2, -3, or -4, then the byte is the beginning of a 2, 3, or 4 byte 7045bb6a25fSPoul-Henning Kampsequence respectively. Multi-byte sequences are sent to the convert 7055bb6a25fSPoul-Henning Kampfunction pointed at in the <code>XML_Encoding</code> structure. This 7065bb6a25fSPoul-Henning Kampfunction should return the Unicode scalar value for the sequence or -1 7075bb6a25fSPoul-Henning Kampif the sequence is malformed.</p> 7085bb6a25fSPoul-Henning Kamp 7095bb6a25fSPoul-Henning Kamp<p>One pitfall that novice Expat users are likely to fall into is that 7105bb6a25fSPoul-Henning Kampalthough Expat may accept input in various encodings, the strings that 7115bb6a25fSPoul-Henning Kampit passes to the handlers are always encoded in UTF-8 or UTF-16 7125bb6a25fSPoul-Henning Kamp(depending on how Expat was compiled). Your application is responsible 7135bb6a25fSPoul-Henning Kampfor any translation of these strings into other encodings.</p> 7145bb6a25fSPoul-Henning Kamp 7155bb6a25fSPoul-Henning Kamp<h3>Handling External Entity References</h3> 7165bb6a25fSPoul-Henning Kamp 7175bb6a25fSPoul-Henning Kamp<p>Expat does not read or parse external entities directly. Note that 7185bb6a25fSPoul-Henning Kampany external DTD is a special case of an external entity. If you've 7195bb6a25fSPoul-Henning Kampset no <code>ExternalEntityRefHandler</code>, then external entity 7205bb6a25fSPoul-Henning Kampreferences are silently ignored. Otherwise, it calls your handler with 7215bb6a25fSPoul-Henning Kampthe information needed to read and parse the external entity.</p> 7225bb6a25fSPoul-Henning Kamp 7235bb6a25fSPoul-Henning Kamp<p>Your handler isn't actually responsible for parsing the entity, but 7245bb6a25fSPoul-Henning Kampit is responsible for creating a subsidiary parser with <code><a href= 7255bb6a25fSPoul-Henning Kamp"#XML_ExternalEntityParserCreate" 7265bb6a25fSPoul-Henning Kamp>XML_ExternalEntityParserCreate</a></code> that will do the job. This 7275bb6a25fSPoul-Henning Kampreturns an instance of <code>XML_Parser</code> that has handlers and 7285bb6a25fSPoul-Henning Kampother data structures initialized from the parent parser. You may then 7295bb6a25fSPoul-Henning Kampuse <code><a href= "#XML_Parse" >XML_Parse</a></code> or <code><a 7305bb6a25fSPoul-Henning Kamphref= "#XML_ParseBuffer">XML_ParseBuffer</a></code> calls against this 7315bb6a25fSPoul-Henning Kampparser. Since external entities my refer to other external entities, 7325bb6a25fSPoul-Henning Kampyour handler should be prepared to be called recursively.</p> 7335bb6a25fSPoul-Henning Kamp 7345bb6a25fSPoul-Henning Kamp<h3>Parsing DTDs</h3> 7355bb6a25fSPoul-Henning Kamp 7365bb6a25fSPoul-Henning Kamp<p>In order to parse parameter entities, before starting the parse, 7375bb6a25fSPoul-Henning Kampyou must call <code><a href= "#XML_SetParamEntityParsing" 7385bb6a25fSPoul-Henning Kamp>XML_SetParamEntityParsing</a></code> with one of the following 7395bb6a25fSPoul-Henning Kamparguments:</p> 7405bb6a25fSPoul-Henning Kamp<dl> 7415bb6a25fSPoul-Henning Kamp<dt><code>XML_PARAM_ENTITY_PARSING_NEVER</code></dt> 7425bb6a25fSPoul-Henning Kamp<dd>Don't parse parameter entities or the external subset</dd> 7435bb6a25fSPoul-Henning Kamp<dt><code>XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE</code></dt> 7440a48773fSEric van Gyzen<dd>Parse parameter entities and the external subset unless 7455bb6a25fSPoul-Henning Kamp<code>standalone</code> was set to "yes" in the XML declaration.</dd> 7465bb6a25fSPoul-Henning Kamp<dt><code>XML_PARAM_ENTITY_PARSING_ALWAYS</code></dt> 7475bb6a25fSPoul-Henning Kamp<dd>Always parse parameter entities and the external subset</dd> 7485bb6a25fSPoul-Henning Kamp</dl> 7495bb6a25fSPoul-Henning Kamp 7505bb6a25fSPoul-Henning Kamp<p>In order to read an external DTD, you also have to set an external 7515bb6a25fSPoul-Henning Kampentity reference handler as described above.</p> 7525bb6a25fSPoul-Henning Kamp 753220ed979SColeman Kane<h3 id="stop-resume">Temporarily Stopping Parsing</h3> 754220ed979SColeman Kane 755220ed979SColeman Kane<p>Expat 1.95.8 introduces a new feature: its now possible to stop 756220ed979SColeman Kaneparsing temporarily from within a handler function, even if more data 757220ed979SColeman Kanehas already been passed into the parser. Applications for this 758220ed979SColeman Kaneinclude</p> 759220ed979SColeman Kane 760220ed979SColeman Kane<ul> 761220ed979SColeman Kane <li>Supporting the <a href= "http://www.w3.org/TR/xinclude/" 762220ed979SColeman Kane >XInclude</a> specification.</li> 763220ed979SColeman Kane 764220ed979SColeman Kane <li>Delaying further processing until additional information is 765220ed979SColeman Kane available from some other source.</li> 766220ed979SColeman Kane 767220ed979SColeman Kane <li>Adjusting processor load as task priorities shift within an 768220ed979SColeman Kane application.</li> 769220ed979SColeman Kane 770220ed979SColeman Kane <li>Stopping parsing completely (simply free or reset the parser 771220ed979SColeman Kane instead of resuming in the outer parsing loop). This can be useful 7720a48773fSEric van Gyzen if an application-domain error is found in the XML being parsed or if 773220ed979SColeman Kane the result of the parse is determined not to be useful after 774220ed979SColeman Kane all.</li> 775220ed979SColeman Kane</ul> 776220ed979SColeman Kane 777220ed979SColeman Kane<p>To take advantage of this feature, the main parsing loop of an 778220ed979SColeman Kaneapplication needs to support this specifically. It cannot be 779220ed979SColeman Kanesupported with a parsing loop compatible with Expat 1.95.7 or 780220ed979SColeman Kaneearlier (though existing loops will continue to work without 781220ed979SColeman Kanesupporting the stop/resume feature).</p> 782220ed979SColeman Kane 783220ed979SColeman Kane<p>An application that uses this feature for a single parser will have 784220ed979SColeman Kanethe rough structure (in pseudo-code):</p> 785220ed979SColeman Kane 786220ed979SColeman Kane<pre class="pseudocode"> 787220ed979SColeman Kanefd = open_input() 788220ed979SColeman Kanep = create_parser() 789220ed979SColeman Kane 790220ed979SColeman Kaneif parse_xml(p, fd) { 791220ed979SColeman Kane /* suspended */ 792220ed979SColeman Kane 793220ed979SColeman Kane int suspended = 1; 794220ed979SColeman Kane 795220ed979SColeman Kane while (suspended) { 796220ed979SColeman Kane do_something_else() 797220ed979SColeman Kane if ready_to_resume() { 798220ed979SColeman Kane suspended = continue_parsing(p, fd); 799220ed979SColeman Kane } 800220ed979SColeman Kane } 801220ed979SColeman Kane} 802220ed979SColeman Kane</pre> 803220ed979SColeman Kane 804220ed979SColeman Kane<p>An application that may resume any of several parsers based on 805220ed979SColeman Kaneinput (either from the XML being parsed or some other source) will 806220ed979SColeman Kanecertainly have more interesting control structures.</p> 807220ed979SColeman Kane 808220ed979SColeman Kane<p>This C function could be used for the <code>parse_xml</code> 809220ed979SColeman Kanefunction mentioned in the pseudo-code above:</p> 810220ed979SColeman Kane 811220ed979SColeman Kane<pre class="eg"> 812220ed979SColeman Kane#define BUFF_SIZE 10240 813220ed979SColeman Kane 814220ed979SColeman Kane/* Parse a document from the open file descriptor 'fd' until the parse 815220ed979SColeman Kane is complete (the document has been completely parsed, or there's 816220ed979SColeman Kane been an error), or the parse is stopped. Return non-zero when 817220ed979SColeman Kane the parse is merely suspended. 818220ed979SColeman Kane*/ 819220ed979SColeman Kaneint 820220ed979SColeman Kaneparse_xml(XML_Parser p, int fd) 821220ed979SColeman Kane{ 822220ed979SColeman Kane for (;;) { 823220ed979SColeman Kane int last_chunk; 824220ed979SColeman Kane int bytes_read; 825220ed979SColeman Kane enum XML_Status status; 826220ed979SColeman Kane 827220ed979SColeman Kane void *buff = XML_GetBuffer(p, BUFF_SIZE); 828220ed979SColeman Kane if (buff == NULL) { 829220ed979SColeman Kane /* handle error... */ 830220ed979SColeman Kane return 0; 831220ed979SColeman Kane } 832220ed979SColeman Kane bytes_read = read(fd, buff, BUFF_SIZE); 833220ed979SColeman Kane if (bytes_read < 0) { 834220ed979SColeman Kane /* handle error... */ 835220ed979SColeman Kane return 0; 836220ed979SColeman Kane } 837220ed979SColeman Kane status = XML_ParseBuffer(p, bytes_read, bytes_read == 0); 838220ed979SColeman Kane switch (status) { 839220ed979SColeman Kane case XML_STATUS_ERROR: 840220ed979SColeman Kane /* handle error... */ 841220ed979SColeman Kane return 0; 842220ed979SColeman Kane case XML_STATUS_SUSPENDED: 843220ed979SColeman Kane return 1; 844220ed979SColeman Kane } 845220ed979SColeman Kane if (bytes_read == 0) 846220ed979SColeman Kane return 0; 847220ed979SColeman Kane } 848220ed979SColeman Kane} 849220ed979SColeman Kane</pre> 850220ed979SColeman Kane 851220ed979SColeman Kane<p>The corresponding <code>continue_parsing</code> function is 852220ed979SColeman Kanesomewhat simpler, since it only need deal with the return code from 853220ed979SColeman Kane<code><a href= "#XML_ResumeParser">XML_ResumeParser</a></code>; it can 854220ed979SColeman Kanedelegate the input handling to the <code>parse_xml</code> 855220ed979SColeman Kanefunction:</p> 856220ed979SColeman Kane 857220ed979SColeman Kane<pre class="eg"> 858220ed979SColeman Kane/* Continue parsing a document which had been suspended. The 'p' and 859220ed979SColeman Kane 'fd' arguments are the same as passed to parse_xml(). Return 860220ed979SColeman Kane non-zero when the parse is suspended. 861220ed979SColeman Kane*/ 862220ed979SColeman Kaneint 863220ed979SColeman Kanecontinue_parsing(XML_Parser p, int fd) 864220ed979SColeman Kane{ 865220ed979SColeman Kane enum XML_Status status = XML_ResumeParser(p); 866220ed979SColeman Kane switch (status) { 867220ed979SColeman Kane case XML_STATUS_ERROR: 868220ed979SColeman Kane /* handle error... */ 869220ed979SColeman Kane return 0; 870220ed979SColeman Kane case XML_ERROR_NOT_SUSPENDED: 871220ed979SColeman Kane /* handle error... */ 872220ed979SColeman Kane return 0;. 873220ed979SColeman Kane case XML_STATUS_SUSPENDED: 874220ed979SColeman Kane return 1; 875220ed979SColeman Kane } 876220ed979SColeman Kane return parse_xml(p, fd); 877220ed979SColeman Kane} 878220ed979SColeman Kane</pre> 879220ed979SColeman Kane 880220ed979SColeman Kane<p>Now that we've seen what a mess the top-level parsing loop can 881220ed979SColeman Kanebecome, what have we gained? Very simply, we can now use the <code><a 882220ed979SColeman Kanehref= "#XML_StopParser" >XML_StopParser</a></code> function to stop 883220ed979SColeman Kaneparsing, without having to go to great lengths to avoid additional 884220ed979SColeman Kaneprocessing that we're expecting to ignore. As a bonus, we get to stop 885220ed979SColeman Kaneparsing <em>temporarily</em>, and come back to it when we're 886220ed979SColeman Kaneready.</p> 887220ed979SColeman Kane 888220ed979SColeman Kane<p>To stop parsing from a handler function, use the <code><a href= 889220ed979SColeman Kane"#XML_StopParser" >XML_StopParser</a></code> function. This function 890220ed979SColeman Kanetakes two arguments; the parser being stopped and a flag indicating 891220ed979SColeman Kanewhether the parse can be resumed in the future.</p> 892220ed979SColeman Kane 893220ed979SColeman Kane<!-- XXX really need more here --> 894220ed979SColeman Kane 895220ed979SColeman Kane 8965bb6a25fSPoul-Henning Kamp<hr /> 8975bb6a25fSPoul-Henning Kamp<!-- ================================================================ --> 8985bb6a25fSPoul-Henning Kamp 8995bb6a25fSPoul-Henning Kamp<h2><a name="reference">Expat Reference</a></h2> 9005bb6a25fSPoul-Henning Kamp 9015bb6a25fSPoul-Henning Kamp<h3><a name="creation">Parser Creation</a></h3> 9025bb6a25fSPoul-Henning Kamp 9035bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ParserCreate"> 904220ed979SColeman KaneXML_Parser XMLCALL 9055bb6a25fSPoul-Henning KampXML_ParserCreate(const XML_Char *encoding); 9065bb6a25fSPoul-Henning Kamp</pre> 9075bb6a25fSPoul-Henning Kamp<div class="fcndef"> 9085bb6a25fSPoul-Henning KampConstruct a new parser. If encoding is non-null, it specifies a 9095bb6a25fSPoul-Henning Kampcharacter encoding to use for the document. This overrides the document 9105bb6a25fSPoul-Henning Kampencoding declaration. There are four built-in encodings: 9115bb6a25fSPoul-Henning Kamp<ul> 9125bb6a25fSPoul-Henning Kamp<li>US-ASCII</li> 9135bb6a25fSPoul-Henning Kamp<li>UTF-8</li> 9145bb6a25fSPoul-Henning Kamp<li>UTF-16</li> 9155bb6a25fSPoul-Henning Kamp<li>ISO-8859-1</li> 9165bb6a25fSPoul-Henning Kamp</ul> 9175bb6a25fSPoul-Henning KampAny other value will invoke a call to the UnknownEncodingHandler. 9185bb6a25fSPoul-Henning Kamp</div> 9195bb6a25fSPoul-Henning Kamp 9205bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ParserCreateNS"> 921220ed979SColeman KaneXML_Parser XMLCALL 9225bb6a25fSPoul-Henning KampXML_ParserCreateNS(const XML_Char *encoding, 9235bb6a25fSPoul-Henning Kamp XML_Char sep); 9245bb6a25fSPoul-Henning Kamp</pre> 9255bb6a25fSPoul-Henning Kamp<div class="fcndef"> 9265bb6a25fSPoul-Henning KampConstructs a new parser that has namespace processing in effect. Namespace 9275bb6a25fSPoul-Henning Kampexpanded element names and attribute names are returned as a concatenation 9285bb6a25fSPoul-Henning Kampof the namespace URI, <em>sep</em>, and the local part of the name. This 929e3466a89SXin LImeans that you should pick a character for <em>sep</em> that can't be part 930e3466a89SXin LIof an URI. Since Expat does not check namespace URIs for conformance, the 931e3466a89SXin LIonly safe choice for a namespace separator is a character that is illegal 932e3466a89SXin LIin XML. For instance, <code>'\xFF'</code> is not legal in UTF-8, and 933e3466a89SXin LI<code>'\xFFFF'</code> is not legal in UTF-16. There is a special case when 934e3466a89SXin LI<em>sep</em> is the null character <code>'\0'</code>: the namespace URI and 935e3466a89SXin LIthe local part will be concatenated without any separator - this is intended 936e3466a89SXin LIto support RDF processors. It is a programming error to use the null separator 937e3466a89SXin LIwith <a href= "#XML_SetReturnNSTriplet">namespace triplets</a>.</div> 9385bb6a25fSPoul-Henning Kamp 9395bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ParserCreate_MM"> 940220ed979SColeman KaneXML_Parser XMLCALL 9415bb6a25fSPoul-Henning KampXML_ParserCreate_MM(const XML_Char *encoding, 9425bb6a25fSPoul-Henning Kamp const XML_Memory_Handling_Suite *ms, 9435bb6a25fSPoul-Henning Kamp const XML_Char *sep); 9445bb6a25fSPoul-Henning Kamp</pre> 9455bb6a25fSPoul-Henning Kamp<pre class="signature"> 9465bb6a25fSPoul-Henning Kamptypedef struct { 947220ed979SColeman Kane void *(XMLCALL *malloc_fcn)(size_t size); 948220ed979SColeman Kane void *(XMLCALL *realloc_fcn)(void *ptr, size_t size); 949220ed979SColeman Kane void (XMLCALL *free_fcn)(void *ptr); 9505bb6a25fSPoul-Henning Kamp} XML_Memory_Handling_Suite; 9515bb6a25fSPoul-Henning Kamp</pre> 9525bb6a25fSPoul-Henning Kamp<div class="fcndef"> 9535bb6a25fSPoul-Henning Kamp<p>Construct a new parser using the suite of memory handling functions 9545bb6a25fSPoul-Henning Kampspecified in <code>ms</code>. If <code>ms</code> is NULL, then use the 9555bb6a25fSPoul-Henning Kampstandard set of memory management functions. If <code>sep</code> is 9565bb6a25fSPoul-Henning Kampnon NULL, then namespace processing is enabled in the created parser 9575bb6a25fSPoul-Henning Kampand the character pointed at by sep is used as the separator between 9585bb6a25fSPoul-Henning Kampthe namespace URI and the local part of the name.</p> 9595bb6a25fSPoul-Henning Kamp</div> 9605bb6a25fSPoul-Henning Kamp 9615bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ExternalEntityParserCreate"> 962220ed979SColeman KaneXML_Parser XMLCALL 9635bb6a25fSPoul-Henning KampXML_ExternalEntityParserCreate(XML_Parser p, 9645bb6a25fSPoul-Henning Kamp const XML_Char *context, 9655bb6a25fSPoul-Henning Kamp const XML_Char *encoding); 9665bb6a25fSPoul-Henning Kamp</pre> 9675bb6a25fSPoul-Henning Kamp<div class="fcndef"> 9685bb6a25fSPoul-Henning KampConstruct a new <code>XML_Parser</code> object for parsing an external 9695bb6a25fSPoul-Henning Kampgeneral entity. Context is the context argument passed in a call to a 9705bb6a25fSPoul-Henning KampExternalEntityRefHandler. Other state information such as handlers, 9715bb6a25fSPoul-Henning Kampuser data, namespace processing is inherited from the parser passed as 9725bb6a25fSPoul-Henning Kampthe 1st argument. So you shouldn't need to call any of the behavior 9735bb6a25fSPoul-Henning Kampchanging functions on this parser (unless you want it to act 9745bb6a25fSPoul-Henning Kampdifferently than the parent parser). 9755bb6a25fSPoul-Henning Kamp</div> 9765bb6a25fSPoul-Henning Kamp 9775bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ParserFree"> 978220ed979SColeman Kanevoid XMLCALL 9795bb6a25fSPoul-Henning KampXML_ParserFree(XML_Parser p); 9805bb6a25fSPoul-Henning Kamp</pre> 9815bb6a25fSPoul-Henning Kamp<div class="fcndef"> 9825bb6a25fSPoul-Henning KampFree memory used by the parser. Your application is responsible for 9835bb6a25fSPoul-Henning Kampfreeing any memory associated with <a href="#userdata">user data</a>. 9845bb6a25fSPoul-Henning Kamp</div> 9855bb6a25fSPoul-Henning Kamp 9865bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ParserReset"> 987220ed979SColeman KaneXML_Bool XMLCALL 988220ed979SColeman KaneXML_ParserReset(XML_Parser p, 989220ed979SColeman Kane const XML_Char *encoding); 9905bb6a25fSPoul-Henning Kamp</pre> 9915bb6a25fSPoul-Henning Kamp<div class="fcndef"> 9925bb6a25fSPoul-Henning KampClean up the memory structures maintained by the parser so that it may 9935bb6a25fSPoul-Henning Kampbe used again. After this has been called, <code>parser</code> is 994220ed979SColeman Kaneready to start parsing a new document. All handlers are cleared from 995220ed979SColeman Kanethe parser, except for the unknownEncodingHandler. The parser's external 996220ed979SColeman Kanestate is re-initialized except for the values of ns and ns_triplets. 997220ed979SColeman KaneThis function may not be used on a parser created using <code><a href= 9985bb6a25fSPoul-Henning Kamp"#XML_ExternalEntityParserCreate" >XML_ExternalEntityParserCreate</a 9995bb6a25fSPoul-Henning Kamp></code>; it will return <code>XML_FALSE</code> in that case. Returns 10005bb6a25fSPoul-Henning Kamp<code>XML_TRUE</code> on success. Your application is responsible for 10015bb6a25fSPoul-Henning Kampdealing with any memory associated with <a href="#userdata">user data</a>. 10025bb6a25fSPoul-Henning Kamp</div> 10035bb6a25fSPoul-Henning Kamp 10045bb6a25fSPoul-Henning Kamp<h3><a name="parsing">Parsing</a></h3> 10055bb6a25fSPoul-Henning Kamp 10065bb6a25fSPoul-Henning Kamp<p>To state the obvious: the three parsing functions <code><a href= 1007220ed979SColeman Kane"#XML_Parse" >XML_Parse</a></code>, <code><a href= "#XML_ParseBuffer"> 1008220ed979SColeman KaneXML_ParseBuffer</a></code> and <code><a href= "#XML_GetBuffer"> 1009220ed979SColeman KaneXML_GetBuffer</a></code> must not be called from within a handler 1010220ed979SColeman Kaneunless they operate on a separate parser instance, that is, one that 1011220ed979SColeman Kanedid not call the handler. For example, it is OK to call the parsing 1012220ed979SColeman Kanefunctions from within an <code>XML_ExternalEntityRefHandler</code>, 1013220ed979SColeman Kaneif they apply to the parser created by 1014220ed979SColeman Kane<code><a href= "#XML_ExternalEntityParserCreate" 10155bb6a25fSPoul-Henning Kamp>XML_ExternalEntityParserCreate</a></code>.</p> 10165bb6a25fSPoul-Henning Kamp 1017220ed979SColeman Kane<p>Note: the <code>len</code> argument passed to these functions 1018220ed979SColeman Kaneshould be considerably less than the maximum value for an integer, 1019220ed979SColeman Kaneas it could create an integer overflow situation if the added 1020220ed979SColeman Kanelengths of a buffer and the unprocessed portion of the previous buffer 1021220ed979SColeman Kaneexceed the maximum integer value. Input data at the end of a buffer 1022220ed979SColeman Kanewill remain unprocessed if it is part of an XML token for which the 1023220ed979SColeman Kaneend is not part of that buffer.</p> 1024220ed979SColeman Kane 10255bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_Parse"> 1026220ed979SColeman Kaneenum XML_Status XMLCALL 10275bb6a25fSPoul-Henning KampXML_Parse(XML_Parser p, 10285bb6a25fSPoul-Henning Kamp const char *s, 10295bb6a25fSPoul-Henning Kamp int len, 10305bb6a25fSPoul-Henning Kamp int isFinal); 10315bb6a25fSPoul-Henning Kamp</pre> 10325bb6a25fSPoul-Henning Kamp<pre class="signature"> 10335bb6a25fSPoul-Henning Kampenum XML_Status { 10345bb6a25fSPoul-Henning Kamp XML_STATUS_ERROR = 0, 10355bb6a25fSPoul-Henning Kamp XML_STATUS_OK = 1 10365bb6a25fSPoul-Henning Kamp}; 10375bb6a25fSPoul-Henning Kamp</pre> 10385bb6a25fSPoul-Henning Kamp<div class="fcndef"> 10395bb6a25fSPoul-Henning KampParse some more of the document. The string <code>s</code> is a buffer 10405bb6a25fSPoul-Henning Kampcontaining part (or perhaps all) of the document. The number of bytes of s 10415bb6a25fSPoul-Henning Kampthat are part of the document is indicated by <code>len</code>. This means 10425bb6a25fSPoul-Henning Kampthat <code>s</code> doesn't have to be null terminated. It also means that 10435bb6a25fSPoul-Henning Kampif <code>len</code> is larger than the number of bytes in the block of 10445bb6a25fSPoul-Henning Kampmemory that <code>s</code> points at, then a memory fault is likely. The 10455bb6a25fSPoul-Henning Kamp<code>isFinal</code> parameter informs the parser that this is the last 10465bb6a25fSPoul-Henning Kamppiece of the document. Frequently, the last piece is empty (i.e. 10475bb6a25fSPoul-Henning Kamp<code>len</code> is zero.) 10485bb6a25fSPoul-Henning KampIf a parse error occurred, it returns <code>XML_STATUS_ERROR</code>. 10495bb6a25fSPoul-Henning KampOtherwise it returns <code>XML_STATUS_OK</code> value. 10505bb6a25fSPoul-Henning Kamp</div> 10515bb6a25fSPoul-Henning Kamp 10525bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ParseBuffer"> 1053220ed979SColeman Kaneenum XML_Status XMLCALL 10545bb6a25fSPoul-Henning KampXML_ParseBuffer(XML_Parser p, 10555bb6a25fSPoul-Henning Kamp int len, 10565bb6a25fSPoul-Henning Kamp int isFinal); 10575bb6a25fSPoul-Henning Kamp</pre> 10585bb6a25fSPoul-Henning Kamp<div class="fcndef"> 10595bb6a25fSPoul-Henning KampThis is just like <code><a href= "#XML_Parse" >XML_Parse</a></code>, 10605bb6a25fSPoul-Henning Kampexcept in this case Expat provides the buffer. By obtaining the 10615bb6a25fSPoul-Henning Kampbuffer from Expat with the <code><a href= "#XML_GetBuffer" 10625bb6a25fSPoul-Henning Kamp>XML_GetBuffer</a></code> function, the application can avoid double 10635bb6a25fSPoul-Henning Kampcopying of the input. 10645bb6a25fSPoul-Henning Kamp</div> 10655bb6a25fSPoul-Henning Kamp 10665bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetBuffer"> 1067220ed979SColeman Kanevoid * XMLCALL 10685bb6a25fSPoul-Henning KampXML_GetBuffer(XML_Parser p, 10695bb6a25fSPoul-Henning Kamp int len); 10705bb6a25fSPoul-Henning Kamp</pre> 10715bb6a25fSPoul-Henning Kamp<div class="fcndef"> 10725bb6a25fSPoul-Henning KampObtain a buffer of size <code>len</code> to read a piece of the document 10735bb6a25fSPoul-Henning Kampinto. A NULL value is returned if Expat can't allocate enough memory for 10745bb6a25fSPoul-Henning Kampthis buffer. This has to be called prior to every call to 10755bb6a25fSPoul-Henning Kamp<code><a href= "#XML_ParseBuffer" >XML_ParseBuffer</a></code>. A 10765bb6a25fSPoul-Henning Kamptypical use would look like this: 10775bb6a25fSPoul-Henning Kamp 10785bb6a25fSPoul-Henning Kamp<pre class="eg"> 10795bb6a25fSPoul-Henning Kampfor (;;) { 10805bb6a25fSPoul-Henning Kamp int bytes_read; 10815bb6a25fSPoul-Henning Kamp void *buff = XML_GetBuffer(p, BUFF_SIZE); 10825bb6a25fSPoul-Henning Kamp if (buff == NULL) { 10835bb6a25fSPoul-Henning Kamp /* handle error */ 10845bb6a25fSPoul-Henning Kamp } 10855bb6a25fSPoul-Henning Kamp 10865bb6a25fSPoul-Henning Kamp bytes_read = read(docfd, buff, BUFF_SIZE); 10875bb6a25fSPoul-Henning Kamp if (bytes_read < 0) { 10885bb6a25fSPoul-Henning Kamp /* handle error */ 10895bb6a25fSPoul-Henning Kamp } 10905bb6a25fSPoul-Henning Kamp 10915bb6a25fSPoul-Henning Kamp if (! XML_ParseBuffer(p, bytes_read, bytes_read == 0)) { 10925bb6a25fSPoul-Henning Kamp /* handle parse error */ 10935bb6a25fSPoul-Henning Kamp } 10945bb6a25fSPoul-Henning Kamp 10955bb6a25fSPoul-Henning Kamp if (bytes_read == 0) 10965bb6a25fSPoul-Henning Kamp break; 10975bb6a25fSPoul-Henning Kamp} 10985bb6a25fSPoul-Henning Kamp</pre> 10995bb6a25fSPoul-Henning Kamp</div> 11005bb6a25fSPoul-Henning Kamp 1101220ed979SColeman Kane<pre class="fcndec" id="XML_StopParser"> 1102220ed979SColeman Kaneenum XML_Status XMLCALL 1103220ed979SColeman KaneXML_StopParser(XML_Parser p, 1104220ed979SColeman Kane XML_Bool resumable); 1105220ed979SColeman Kane</pre> 1106220ed979SColeman Kane<div class="fcndef"> 1107220ed979SColeman Kane 1108220ed979SColeman Kane<p>Stops parsing, causing <code><a href= "#XML_Parse" 1109220ed979SColeman Kane>XML_Parse</a></code> or <code><a href= "#XML_ParseBuffer" 1110220ed979SColeman Kane>XML_ParseBuffer</a></code> to return. Must be called from within a 1111220ed979SColeman Kanecall-back handler, except when aborting (when <code>resumable</code> 1112220ed979SColeman Kaneis <code>XML_FALSE</code>) an already suspended parser. Some 1113220ed979SColeman Kanecall-backs may still follow because they would otherwise get 1114220ed979SColeman Kanelost, including 1115220ed979SColeman Kane<ul> 1116220ed979SColeman Kane <li> the end element handler for empty elements when stopped in the 1117220ed979SColeman Kane start element handler,</li> 1118220ed979SColeman Kane <li> the end namespace declaration handler when stopped in the end 1119220ed979SColeman Kane element handler,</li> 1120220ed979SColeman Kane <li> the character data handler when stopped in the character data handler 1121220ed979SColeman Kane while making multiple call-backs on a contiguous chunk of characters,</li> 1122220ed979SColeman Kane</ul> 1123220ed979SColeman Kaneand possibly others.</p> 1124220ed979SColeman Kane 1125220ed979SColeman Kane<p>This can be called from most handlers, including DTD related 1126220ed979SColeman Kanecall-backs, except when parsing an external parameter entity and 1127220ed979SColeman Kane<code>resumable</code> is <code>XML_TRUE</code>. Returns 1128220ed979SColeman Kane<code>XML_STATUS_OK</code> when successful, 1129220ed979SColeman Kane<code>XML_STATUS_ERROR</code> otherwise. The possible error codes 1130220ed979SColeman Kaneare:</p> 1131220ed979SColeman Kane<dl> 1132220ed979SColeman Kane <dt><code>XML_ERROR_SUSPENDED</code></dt> 1133220ed979SColeman Kane <dd>when suspending an already suspended parser.</dd> 1134220ed979SColeman Kane <dt><code>XML_ERROR_FINISHED</code></dt> 1135220ed979SColeman Kane <dd>when the parser has already finished.</dd> 1136220ed979SColeman Kane <dt><code>XML_ERROR_SUSPEND_PE</code></dt> 1137220ed979SColeman Kane <dd>when suspending while parsing an external PE.</dd> 1138220ed979SColeman Kane</dl> 1139220ed979SColeman Kane 1140220ed979SColeman Kane<p>Since the stop/resume feature requires application support in the 1141220ed979SColeman Kaneouter parsing loop, it is an error to call this function for a parser 1142220ed979SColeman Kanenot being handled appropriately; see <a href= "#stop-resume" 1143220ed979SColeman Kane>Temporarily Stopping Parsing</a> for more information.</p> 1144220ed979SColeman Kane 1145220ed979SColeman Kane<p>When <code>resumable</code> is <code>XML_TRUE</code> then parsing 1146220ed979SColeman Kaneis <em>suspended</em>, that is, <code><a href= "#XML_Parse" 1147220ed979SColeman Kane>XML_Parse</a></code> and <code><a href= "#XML_ParseBuffer" 1148220ed979SColeman Kane>XML_ParseBuffer</a></code> return <code>XML_STATUS_SUSPENDED</code>. 1149220ed979SColeman KaneOtherwise, parsing is <em>aborted</em>, that is, <code><a href= 1150220ed979SColeman Kane"#XML_Parse" >XML_Parse</a></code> and <code><a href= 1151220ed979SColeman Kane"#XML_ParseBuffer" >XML_ParseBuffer</a></code> return 1152220ed979SColeman Kane<code>XML_STATUS_ERROR</code> with error code 1153220ed979SColeman Kane<code>XML_ERROR_ABORTED</code>.</p> 1154220ed979SColeman Kane 1155220ed979SColeman Kane<p><strong>Note:</strong> 1156220ed979SColeman KaneThis will be applied to the current parser instance only, that is, if 1157220ed979SColeman Kanethere is a parent parser then it will continue parsing when the 1158220ed979SColeman Kaneexternal entity reference handler returns. It is up to the 1159220ed979SColeman Kaneimplementation of that handler to call <code><a href= 1160220ed979SColeman Kane"#XML_StopParser" >XML_StopParser</a></code> on the parent parser 1161220ed979SColeman Kane(recursively), if one wants to stop parsing altogether.</p> 1162220ed979SColeman Kane 1163220ed979SColeman Kane<p>When suspended, parsing can be resumed by calling <code><a href= 1164220ed979SColeman Kane"#XML_ResumeParser" >XML_ResumeParser</a></code>.</p> 1165220ed979SColeman Kane 1166220ed979SColeman Kane<p>New in Expat 1.95.8.</p> 1167220ed979SColeman Kane</div> 1168220ed979SColeman Kane 1169220ed979SColeman Kane<pre class="fcndec" id="XML_ResumeParser"> 1170220ed979SColeman Kaneenum XML_Status XMLCALL 1171220ed979SColeman KaneXML_ResumeParser(XML_Parser p); 1172220ed979SColeman Kane</pre> 1173220ed979SColeman Kane<div class="fcndef"> 1174220ed979SColeman Kane<p>Resumes parsing after it has been suspended with <code><a href= 1175220ed979SColeman Kane"#XML_StopParser" >XML_StopParser</a></code>. Must not be called from 1176220ed979SColeman Kanewithin a handler call-back. Returns same status codes as <code><a 1177220ed979SColeman Kanehref= "#XML_Parse">XML_Parse</a></code> or <code><a href= 1178220ed979SColeman Kane"#XML_ParseBuffer" >XML_ParseBuffer</a></code>. An additional error 1179220ed979SColeman Kanecode, <code>XML_ERROR_NOT_SUSPENDED</code>, will be returned if the 1180220ed979SColeman Kaneparser was not currently suspended.</p> 1181220ed979SColeman Kane 1182220ed979SColeman Kane<p><strong>Note:</strong> 1183220ed979SColeman KaneThis must be called on the most deeply nested child parser instance 1184220ed979SColeman Kanefirst, and on its parent parser only after the child parser has 1185220ed979SColeman Kanefinished, to be applied recursively until the document entity's parser 1186220ed979SColeman Kaneis restarted. That is, the parent parser will not resume by itself 1187220ed979SColeman Kaneand it is up to the application to call <code><a href= 1188220ed979SColeman Kane"#XML_ResumeParser" >XML_ResumeParser</a></code> on it at the 1189220ed979SColeman Kaneappropriate moment.</p> 1190220ed979SColeman Kane 1191220ed979SColeman Kane<p>New in Expat 1.95.8.</p> 1192220ed979SColeman Kane</div> 1193220ed979SColeman Kane 1194220ed979SColeman Kane<pre class="fcndec" id="XML_GetParsingStatus"> 1195220ed979SColeman Kanevoid XMLCALL 1196220ed979SColeman KaneXML_GetParsingStatus(XML_Parser p, 1197220ed979SColeman Kane XML_ParsingStatus *status); 1198220ed979SColeman Kane</pre> 1199220ed979SColeman Kane<pre class="signature"> 1200220ed979SColeman Kaneenum XML_Parsing { 1201220ed979SColeman Kane XML_INITIALIZED, 1202220ed979SColeman Kane XML_PARSING, 1203220ed979SColeman Kane XML_FINISHED, 1204220ed979SColeman Kane XML_SUSPENDED 1205220ed979SColeman Kane}; 1206220ed979SColeman Kane 1207220ed979SColeman Kanetypedef struct { 1208220ed979SColeman Kane enum XML_Parsing parsing; 1209220ed979SColeman Kane XML_Bool finalBuffer; 1210220ed979SColeman Kane} XML_ParsingStatus; 1211220ed979SColeman Kane</pre> 1212220ed979SColeman Kane<div class="fcndef"> 1213220ed979SColeman Kane<p>Returns status of parser with respect to being initialized, 1214220ed979SColeman Kaneparsing, finished, or suspended, and whether the final buffer is being 1215220ed979SColeman Kaneprocessed. The <code>status</code> parameter <em>must not</em> be 1216220ed979SColeman KaneNULL.</p> 1217220ed979SColeman Kane 1218220ed979SColeman Kane<p>New in Expat 1.95.8.</p> 1219220ed979SColeman Kane</div> 1220220ed979SColeman Kane 1221220ed979SColeman Kane 12225bb6a25fSPoul-Henning Kamp<h3><a name="setting">Handler Setting</a></h3> 12235bb6a25fSPoul-Henning Kamp 12245bb6a25fSPoul-Henning Kamp<p>Although handlers are typically set prior to parsing and left alone, an 12255bb6a25fSPoul-Henning Kampapplication may choose to set or change the handler for a parsing event 12265bb6a25fSPoul-Henning Kampwhile the parse is in progress. For instance, your application may choose 12275bb6a25fSPoul-Henning Kampto ignore all text not descended from a <code>para</code> element. One 12285bb6a25fSPoul-Henning Kampway it could do this is to set the character handler when a para start tag 12295bb6a25fSPoul-Henning Kampis seen, and unset it for the corresponding end tag.</p> 12305bb6a25fSPoul-Henning Kamp 12315bb6a25fSPoul-Henning Kamp<p>A handler may be <em>unset</em> by providing a NULL pointer to the 12325bb6a25fSPoul-Henning Kampappropriate handler setter. None of the handler setting functions have 12335bb6a25fSPoul-Henning Kampa return value.</p> 12345bb6a25fSPoul-Henning Kamp 12355bb6a25fSPoul-Henning Kamp<p>Your handlers will be receiving strings in arrays of type 1236220ed979SColeman Kane<code>XML_Char</code>. This type is conditionally defined in expat.h as 1237220ed979SColeman Kaneeither <code>char</code>, <code>wchar_t</code> or <code>unsigned short</code>. 1238220ed979SColeman KaneThe former implies UTF-8 encoding, the latter two imply UTF-16 encoding. 1239220ed979SColeman KaneNote that you'll receive them in this form independent of the original 1240220ed979SColeman Kaneencoding of the document.</p> 12415bb6a25fSPoul-Henning Kamp 12425bb6a25fSPoul-Henning Kamp<div class="handler"> 12435bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetStartElementHandler"> 1244220ed979SColeman Kanevoid XMLCALL 12455bb6a25fSPoul-Henning KampXML_SetStartElementHandler(XML_Parser p, 12465bb6a25fSPoul-Henning Kamp XML_StartElementHandler start); 12475bb6a25fSPoul-Henning Kamp</pre> 12485bb6a25fSPoul-Henning Kamp<pre class="signature"> 12495bb6a25fSPoul-Henning Kamptypedef void 1250220ed979SColeman Kane(XMLCALL *XML_StartElementHandler)(void *userData, 12515bb6a25fSPoul-Henning Kamp const XML_Char *name, 12525bb6a25fSPoul-Henning Kamp const XML_Char **atts); 12535bb6a25fSPoul-Henning Kamp</pre> 12545bb6a25fSPoul-Henning Kamp<p>Set handler for start (and empty) tags. Attributes are passed to the start 12555bb6a25fSPoul-Henning Kamphandler as a pointer to a vector of char pointers. Each attribute seen in 12565bb6a25fSPoul-Henning Kampa start (or empty) tag occupies 2 consecutive places in this vector: the 12575bb6a25fSPoul-Henning Kampattribute name followed by the attribute value. These pairs are terminated 12585bb6a25fSPoul-Henning Kampby a null pointer.</p> 12595bb6a25fSPoul-Henning Kamp<p>Note that an empty tag generates a call to both start and end handlers 12605bb6a25fSPoul-Henning Kamp(in that order).</p> 12615bb6a25fSPoul-Henning Kamp</div> 12625bb6a25fSPoul-Henning Kamp 12635bb6a25fSPoul-Henning Kamp<div class="handler"> 12645bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetEndElementHandler"> 1265220ed979SColeman Kanevoid XMLCALL 12665bb6a25fSPoul-Henning KampXML_SetEndElementHandler(XML_Parser p, 12675bb6a25fSPoul-Henning Kamp XML_EndElementHandler); 12685bb6a25fSPoul-Henning Kamp</pre> 12695bb6a25fSPoul-Henning Kamp<pre class="signature"> 12705bb6a25fSPoul-Henning Kamptypedef void 1271220ed979SColeman Kane(XMLCALL *XML_EndElementHandler)(void *userData, 12725bb6a25fSPoul-Henning Kamp const XML_Char *name); 12735bb6a25fSPoul-Henning Kamp</pre> 12745bb6a25fSPoul-Henning Kamp<p>Set handler for end (and empty) tags. As noted above, an empty tag 12755bb6a25fSPoul-Henning Kampgenerates a call to both start and end handlers.</p> 12765bb6a25fSPoul-Henning Kamp</div> 12775bb6a25fSPoul-Henning Kamp 12785bb6a25fSPoul-Henning Kamp<div class="handler"> 12795bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetElementHandler"> 1280220ed979SColeman Kanevoid XMLCALL 12815bb6a25fSPoul-Henning KampXML_SetElementHandler(XML_Parser p, 12825bb6a25fSPoul-Henning Kamp XML_StartElementHandler start, 12835bb6a25fSPoul-Henning Kamp XML_EndElementHandler end); 12845bb6a25fSPoul-Henning Kamp</pre> 12855bb6a25fSPoul-Henning Kamp<p>Set handlers for start and end tags with one call.</p> 12865bb6a25fSPoul-Henning Kamp</div> 12875bb6a25fSPoul-Henning Kamp 12885bb6a25fSPoul-Henning Kamp<div class="handler"> 12895bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetCharacterDataHandler"> 1290220ed979SColeman Kanevoid XMLCALL 12915bb6a25fSPoul-Henning KampXML_SetCharacterDataHandler(XML_Parser p, 12925bb6a25fSPoul-Henning Kamp XML_CharacterDataHandler charhndl) 12935bb6a25fSPoul-Henning Kamp</pre> 12945bb6a25fSPoul-Henning Kamp<pre class="signature"> 12955bb6a25fSPoul-Henning Kamptypedef void 1296220ed979SColeman Kane(XMLCALL *XML_CharacterDataHandler)(void *userData, 12975bb6a25fSPoul-Henning Kamp const XML_Char *s, 12985bb6a25fSPoul-Henning Kamp int len); 12995bb6a25fSPoul-Henning Kamp</pre> 13005bb6a25fSPoul-Henning Kamp<p>Set a text handler. The string your handler receives 13015bb6a25fSPoul-Henning Kampis <em>NOT nul-terminated</em>. You have to use the length argument 13025bb6a25fSPoul-Henning Kampto deal with the end of the string. A single block of contiguous text 13035bb6a25fSPoul-Henning Kampfree of markup may still result in a sequence of calls to this handler. 13045bb6a25fSPoul-Henning KampIn other words, if you're searching for a pattern in the text, it may 1305220ed979SColeman Kanebe split across calls to this handler. Note: Setting this handler to NULL 1306220ed979SColeman Kanemay <em>NOT immediately</em> terminate call-backs if the parser is currently 1307220ed979SColeman Kaneprocessing such a single block of contiguous markup-free text, as the parser 1308220ed979SColeman Kanewill continue calling back until the end of the block is reached.</p> 13095bb6a25fSPoul-Henning Kamp</div> 13105bb6a25fSPoul-Henning Kamp 13115bb6a25fSPoul-Henning Kamp<div class="handler"> 13125bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetProcessingInstructionHandler"> 1313220ed979SColeman Kanevoid XMLCALL 13145bb6a25fSPoul-Henning KampXML_SetProcessingInstructionHandler(XML_Parser p, 13155bb6a25fSPoul-Henning Kamp XML_ProcessingInstructionHandler proc) 13165bb6a25fSPoul-Henning Kamp</pre> 13175bb6a25fSPoul-Henning Kamp<pre class="signature"> 13185bb6a25fSPoul-Henning Kamptypedef void 1319220ed979SColeman Kane(XMLCALL *XML_ProcessingInstructionHandler)(void *userData, 13205bb6a25fSPoul-Henning Kamp const XML_Char *target, 13215bb6a25fSPoul-Henning Kamp const XML_Char *data); 13225bb6a25fSPoul-Henning Kamp 13235bb6a25fSPoul-Henning Kamp</pre> 13245bb6a25fSPoul-Henning Kamp<p>Set a handler for processing instructions. The target is the first word 13255bb6a25fSPoul-Henning Kampin the processing instruction. The data is the rest of the characters in 13265bb6a25fSPoul-Henning Kampit after skipping all whitespace after the initial word.</p> 13275bb6a25fSPoul-Henning Kamp</div> 13285bb6a25fSPoul-Henning Kamp 13295bb6a25fSPoul-Henning Kamp<div class="handler"> 13305bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetCommentHandler"> 1331220ed979SColeman Kanevoid XMLCALL 13325bb6a25fSPoul-Henning KampXML_SetCommentHandler(XML_Parser p, 13335bb6a25fSPoul-Henning Kamp XML_CommentHandler cmnt) 13345bb6a25fSPoul-Henning Kamp</pre> 13355bb6a25fSPoul-Henning Kamp<pre class="signature"> 13365bb6a25fSPoul-Henning Kamptypedef void 1337220ed979SColeman Kane(XMLCALL *XML_CommentHandler)(void *userData, 13385bb6a25fSPoul-Henning Kamp const XML_Char *data); 13395bb6a25fSPoul-Henning Kamp</pre> 13405bb6a25fSPoul-Henning Kamp<p>Set a handler for comments. The data is all text inside the comment 13415bb6a25fSPoul-Henning Kampdelimiters.</p> 13425bb6a25fSPoul-Henning Kamp</div> 13435bb6a25fSPoul-Henning Kamp 13445bb6a25fSPoul-Henning Kamp<div class="handler"> 13455bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetStartCdataSectionHandler"> 1346220ed979SColeman Kanevoid XMLCALL 13475bb6a25fSPoul-Henning KampXML_SetStartCdataSectionHandler(XML_Parser p, 13485bb6a25fSPoul-Henning Kamp XML_StartCdataSectionHandler start); 13495bb6a25fSPoul-Henning Kamp</pre> 13505bb6a25fSPoul-Henning Kamp<pre class="signature"> 13515bb6a25fSPoul-Henning Kamptypedef void 1352220ed979SColeman Kane(XMLCALL *XML_StartCdataSectionHandler)(void *userData); 13535bb6a25fSPoul-Henning Kamp</pre> 13545bb6a25fSPoul-Henning Kamp<p>Set a handler that gets called at the beginning of a CDATA section.</p> 13555bb6a25fSPoul-Henning Kamp</div> 13565bb6a25fSPoul-Henning Kamp 13575bb6a25fSPoul-Henning Kamp<div class="handler"> 13585bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetEndCdataSectionHandler"> 1359220ed979SColeman Kanevoid XMLCALL 13605bb6a25fSPoul-Henning KampXML_SetEndCdataSectionHandler(XML_Parser p, 13615bb6a25fSPoul-Henning Kamp XML_EndCdataSectionHandler end); 13625bb6a25fSPoul-Henning Kamp</pre> 13635bb6a25fSPoul-Henning Kamp<pre class="signature"> 13645bb6a25fSPoul-Henning Kamptypedef void 1365220ed979SColeman Kane(XMLCALL *XML_EndCdataSectionHandler)(void *userData); 13665bb6a25fSPoul-Henning Kamp</pre> 13675bb6a25fSPoul-Henning Kamp<p>Set a handler that gets called at the end of a CDATA section.</p> 13685bb6a25fSPoul-Henning Kamp</div> 13695bb6a25fSPoul-Henning Kamp 13705bb6a25fSPoul-Henning Kamp<div class="handler"> 13715bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetCdataSectionHandler"> 1372220ed979SColeman Kanevoid XMLCALL 13735bb6a25fSPoul-Henning KampXML_SetCdataSectionHandler(XML_Parser p, 13745bb6a25fSPoul-Henning Kamp XML_StartCdataSectionHandler start, 13755bb6a25fSPoul-Henning Kamp XML_EndCdataSectionHandler end) 13765bb6a25fSPoul-Henning Kamp</pre> 13775bb6a25fSPoul-Henning Kamp<p>Sets both CDATA section handlers with one call.</p> 13785bb6a25fSPoul-Henning Kamp</div> 13795bb6a25fSPoul-Henning Kamp 13805bb6a25fSPoul-Henning Kamp<div class="handler"> 13815bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetDefaultHandler"> 1382220ed979SColeman Kanevoid XMLCALL 13835bb6a25fSPoul-Henning KampXML_SetDefaultHandler(XML_Parser p, 13845bb6a25fSPoul-Henning Kamp XML_DefaultHandler hndl) 13855bb6a25fSPoul-Henning Kamp</pre> 13865bb6a25fSPoul-Henning Kamp<pre class="signature"> 13875bb6a25fSPoul-Henning Kamptypedef void 1388220ed979SColeman Kane(XMLCALL *XML_DefaultHandler)(void *userData, 13895bb6a25fSPoul-Henning Kamp const XML_Char *s, 13905bb6a25fSPoul-Henning Kamp int len); 13915bb6a25fSPoul-Henning Kamp</pre> 13925bb6a25fSPoul-Henning Kamp 13935bb6a25fSPoul-Henning Kamp<p>Sets a handler for any characters in the document which wouldn't 13945bb6a25fSPoul-Henning Kampotherwise be handled. This includes both data for which no handlers 13955bb6a25fSPoul-Henning Kampcan be set (like some kinds of DTD declarations) and data which could 13965bb6a25fSPoul-Henning Kampbe reported but which currently has no handler set. The characters 13975bb6a25fSPoul-Henning Kampare passed exactly as they were present in the XML document except 13985bb6a25fSPoul-Henning Kampthat they will be encoded in UTF-8 or UTF-16. Line boundaries are not 13995bb6a25fSPoul-Henning Kampnormalized. Note that a byte order mark character is not passed to the 14005bb6a25fSPoul-Henning Kampdefault handler. There are no guarantees about how characters are 14015bb6a25fSPoul-Henning Kampdivided between calls to the default handler: for example, a comment 14025bb6a25fSPoul-Henning Kampmight be split between multiple calls. Setting the handler with 14035bb6a25fSPoul-Henning Kampthis call has the side effect of turning off expansion of references 14045bb6a25fSPoul-Henning Kampto internally defined general entities. Instead these references are 14055bb6a25fSPoul-Henning Kamppassed to the default handler.</p> 14065bb6a25fSPoul-Henning Kamp 14075bb6a25fSPoul-Henning Kamp<p>See also <code><a 14085bb6a25fSPoul-Henning Kamphref="#XML_DefaultCurrent">XML_DefaultCurrent</a></code>.</p> 14095bb6a25fSPoul-Henning Kamp</div> 14105bb6a25fSPoul-Henning Kamp 14115bb6a25fSPoul-Henning Kamp<div class="handler"> 14125bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetDefaultHandlerExpand"> 1413220ed979SColeman Kanevoid XMLCALL 14145bb6a25fSPoul-Henning KampXML_SetDefaultHandlerExpand(XML_Parser p, 14155bb6a25fSPoul-Henning Kamp XML_DefaultHandler hndl) 14165bb6a25fSPoul-Henning Kamp</pre> 14175bb6a25fSPoul-Henning Kamp<pre class="signature"> 14185bb6a25fSPoul-Henning Kamptypedef void 1419220ed979SColeman Kane(XMLCALL *XML_DefaultHandler)(void *userData, 14205bb6a25fSPoul-Henning Kamp const XML_Char *s, 14215bb6a25fSPoul-Henning Kamp int len); 14225bb6a25fSPoul-Henning Kamp</pre> 14235bb6a25fSPoul-Henning Kamp<p>This sets a default handler, but doesn't inhibit the expansion of 14245bb6a25fSPoul-Henning Kampinternal entity references. The entity reference will not be passed 14255bb6a25fSPoul-Henning Kampto the default handler.</p> 14265bb6a25fSPoul-Henning Kamp 14275bb6a25fSPoul-Henning Kamp<p>See also <code><a 14285bb6a25fSPoul-Henning Kamphref="#XML_DefaultCurrent">XML_DefaultCurrent</a></code>.</p> 14295bb6a25fSPoul-Henning Kamp</div> 14305bb6a25fSPoul-Henning Kamp 14315bb6a25fSPoul-Henning Kamp<div class="handler"> 14325bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetExternalEntityRefHandler"> 1433220ed979SColeman Kanevoid XMLCALL 14345bb6a25fSPoul-Henning KampXML_SetExternalEntityRefHandler(XML_Parser p, 14355bb6a25fSPoul-Henning Kamp XML_ExternalEntityRefHandler hndl) 14365bb6a25fSPoul-Henning Kamp</pre> 14375bb6a25fSPoul-Henning Kamp<pre class="signature"> 14385bb6a25fSPoul-Henning Kamptypedef int 1439220ed979SColeman Kane(XMLCALL *XML_ExternalEntityRefHandler)(XML_Parser p, 14405bb6a25fSPoul-Henning Kamp const XML_Char *context, 14415bb6a25fSPoul-Henning Kamp const XML_Char *base, 14425bb6a25fSPoul-Henning Kamp const XML_Char *systemId, 14435bb6a25fSPoul-Henning Kamp const XML_Char *publicId); 14445bb6a25fSPoul-Henning Kamp</pre> 14455bb6a25fSPoul-Henning Kamp<p>Set an external entity reference handler. This handler is also 14465bb6a25fSPoul-Henning Kampcalled for processing an external DTD subset if parameter entity parsing 14475bb6a25fSPoul-Henning Kampis in effect. (See <a href="#XML_SetParamEntityParsing"> 14485bb6a25fSPoul-Henning Kamp<code>XML_SetParamEntityParsing</code></a>.)</p> 14495bb6a25fSPoul-Henning Kamp 1450220ed979SColeman Kane<p>The <code>context</code> parameter specifies the parsing context in 1451220ed979SColeman Kanethe format expected by the <code>context</code> argument to <code><a 1452220ed979SColeman Kanehref="#XML_ExternalEntityParserCreate" 1453220ed979SColeman Kane>XML_ExternalEntityParserCreate</a></code>. <code>code</code> is 1454220ed979SColeman Kanevalid only until the handler returns, so if the referenced entity is 1455220ed979SColeman Kaneto be parsed later, it must be copied. <code>context</code> is NULL 1456220ed979SColeman Kaneonly when the entity is a parameter entity, which is how one can 1457220ed979SColeman Kanedifferentiate between general and parameter entities.</p> 14585bb6a25fSPoul-Henning Kamp 1459220ed979SColeman Kane<p>The <code>base</code> parameter is the base to use for relative 1460220ed979SColeman Kanesystem identifiers. It is set by <code><a 1461220ed979SColeman Kanehref="#XML_SetBase">XML_SetBase</a></code> and may be NULL. The 1462220ed979SColeman Kane<code>publicId</code> parameter is the public id given in the entity 1463220ed979SColeman Kanedeclaration and may be NULL. <code>systemId</code> is the system 1464220ed979SColeman Kaneidentifier specified in the entity declaration and is never NULL.</p> 14655bb6a25fSPoul-Henning Kamp 1466220ed979SColeman Kane<p>There are a couple of ways in which this handler differs from 1467220ed979SColeman Kaneothers. First, this handler returns a status indicator (an 1468220ed979SColeman Kaneinteger). <code>XML_STATUS_OK</code> should be returned for successful 1469220ed979SColeman Kanehandling of the external entity reference. Returning 1470220ed979SColeman Kane<code>XML_STATUS_ERROR</code> indicates failure, and causes the 1471220ed979SColeman Kanecalling parser to return an 1472220ed979SColeman Kane<code>XML_ERROR_EXTERNAL_ENTITY_HANDLING</code> error.</p> 14735bb6a25fSPoul-Henning Kamp 1474220ed979SColeman Kane<p>Second, instead of having the user data as its first argument, it 1475220ed979SColeman Kanereceives the parser that encountered the entity reference. This, along 1476220ed979SColeman Kanewith the context parameter, may be used as arguments to a call to 1477220ed979SColeman Kane<code><a href= "#XML_ExternalEntityParserCreate" 1478220ed979SColeman Kane>XML_ExternalEntityParserCreate</a></code>. Using the returned 1479220ed979SColeman Kaneparser, the body of the external entity can be recursively parsed.</p> 14805bb6a25fSPoul-Henning Kamp 14815bb6a25fSPoul-Henning Kamp<p>Since this handler may be called recursively, it should not be saving 14825bb6a25fSPoul-Henning Kampinformation into global or static variables.</p> 14835bb6a25fSPoul-Henning Kamp</div> 14845bb6a25fSPoul-Henning Kamp 1485220ed979SColeman Kane<pre class="fcndec" id="XML_SetExternalEntityRefHandlerArg"> 1486220ed979SColeman Kanevoid XMLCALL 1487220ed979SColeman KaneXML_SetExternalEntityRefHandlerArg(XML_Parser p, 1488220ed979SColeman Kane void *arg) 1489220ed979SColeman Kane</pre> 1490220ed979SColeman Kane<div class="fcndef"> 1491220ed979SColeman Kane<p>Set the argument passed to the ExternalEntityRefHandler. If 1492220ed979SColeman Kane<code>arg</code> is not NULL, it is the new value passed to the 1493220ed979SColeman Kanehandler set using <code><a href="#XML_SetExternalEntityRefHandler" 1494220ed979SColeman Kane>XML_SetExternalEntityRefHandler</a></code>; if <code>arg</code> is 1495220ed979SColeman KaneNULL, the argument passed to the handler function will be the parser 1496220ed979SColeman Kaneobject itself.</p> 1497220ed979SColeman Kane 1498220ed979SColeman Kane<p><strong>Note:</strong> 1499220ed979SColeman KaneThe type of <code>arg</code> and the type of the first argument to the 1500220ed979SColeman KaneExternalEntityRefHandler do not match. This function takes a 1501220ed979SColeman Kane<code>void *</code> to be passed to the handler, while the handler 1502220ed979SColeman Kaneaccepts an <code>XML_Parser</code>. This is a historical accident, 1503220ed979SColeman Kanebut will not be corrected before Expat 2.0 (at the earliest) to avoid 1504220ed979SColeman Kanecausing compiler warnings for code that's known to work with this 1505220ed979SColeman KaneAPI. It is the responsibility of the application code to know the 1506220ed979SColeman Kaneactual type of the argument passed to the handler and to manage it 1507220ed979SColeman Kaneproperly.</p> 1508220ed979SColeman Kane</div> 1509220ed979SColeman Kane 15105bb6a25fSPoul-Henning Kamp<div class="handler"> 15115bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetSkippedEntityHandler"> 1512220ed979SColeman Kanevoid XMLCALL 15135bb6a25fSPoul-Henning KampXML_SetSkippedEntityHandler(XML_Parser p, 15145bb6a25fSPoul-Henning Kamp XML_SkippedEntityHandler handler) 15155bb6a25fSPoul-Henning Kamp</pre> 15165bb6a25fSPoul-Henning Kamp<pre class="signature"> 15175bb6a25fSPoul-Henning Kamptypedef void 1518220ed979SColeman Kane(XMLCALL *XML_SkippedEntityHandler)(void *userData, 15195bb6a25fSPoul-Henning Kamp const XML_Char *entityName, 15205bb6a25fSPoul-Henning Kamp int is_parameter_entity); 15215bb6a25fSPoul-Henning Kamp</pre> 15225bb6a25fSPoul-Henning Kamp<p>Set a skipped entity handler. This is called in two situations:</p> 15235bb6a25fSPoul-Henning Kamp<ol> 15245bb6a25fSPoul-Henning Kamp <li>An entity reference is encountered for which no declaration 15255bb6a25fSPoul-Henning Kamp has been read <em>and</em> this is not an error.</li> 15265bb6a25fSPoul-Henning Kamp <li>An internal entity reference is read, but not expanded, because 15275bb6a25fSPoul-Henning Kamp <a href="#XML_SetDefaultHandler"><code>XML_SetDefaultHandler</code></a> 15285bb6a25fSPoul-Henning Kamp has been called.</li> 15295bb6a25fSPoul-Henning Kamp</ol> 15305bb6a25fSPoul-Henning Kamp<p>The <code>is_parameter_entity</code> argument will be non-zero for 15315bb6a25fSPoul-Henning Kampa parameter entity and zero for a general entity.</p> <p>Note: skipped 15325bb6a25fSPoul-Henning Kampparameter entities in declarations and skipped general entities in 15335bb6a25fSPoul-Henning Kampattribute values cannot be reported, because the event would be out of 15345bb6a25fSPoul-Henning Kampsync with the reporting of the declarations or attribute values</p> 15355bb6a25fSPoul-Henning Kamp</div> 15365bb6a25fSPoul-Henning Kamp 15375bb6a25fSPoul-Henning Kamp<div class="handler"> 15385bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetUnknownEncodingHandler"> 1539220ed979SColeman Kanevoid XMLCALL 15405bb6a25fSPoul-Henning KampXML_SetUnknownEncodingHandler(XML_Parser p, 15415bb6a25fSPoul-Henning Kamp XML_UnknownEncodingHandler enchandler, 15425bb6a25fSPoul-Henning Kamp void *encodingHandlerData) 15435bb6a25fSPoul-Henning Kamp</pre> 15445bb6a25fSPoul-Henning Kamp<pre class="signature"> 15455bb6a25fSPoul-Henning Kamptypedef int 1546220ed979SColeman Kane(XMLCALL *XML_UnknownEncodingHandler)(void *encodingHandlerData, 15475bb6a25fSPoul-Henning Kamp const XML_Char *name, 15485bb6a25fSPoul-Henning Kamp XML_Encoding *info); 15495bb6a25fSPoul-Henning Kamp 15505bb6a25fSPoul-Henning Kamptypedef struct { 15515bb6a25fSPoul-Henning Kamp int map[256]; 15525bb6a25fSPoul-Henning Kamp void *data; 1553220ed979SColeman Kane int (XMLCALL *convert)(void *data, const char *s); 1554220ed979SColeman Kane void (XMLCALL *release)(void *data); 15555bb6a25fSPoul-Henning Kamp} XML_Encoding; 15565bb6a25fSPoul-Henning Kamp</pre> 1557220ed979SColeman Kane<p>Set a handler to deal with encodings other than the <a 1558220ed979SColeman Kanehref="#builtin_encodings">built in set</a>. This should be done before 15595bb6a25fSPoul-Henning Kamp<code><a href= "#XML_Parse" >XML_Parse</a></code> or <code><a href= 15605bb6a25fSPoul-Henning Kamp"#XML_ParseBuffer" >XML_ParseBuffer</a></code> have been called on the 1561220ed979SColeman Kanegiven parser.</p> <p>If the handler knows how to deal with an encoding 1562220ed979SColeman Kanewith the given name, it should fill in the <code>info</code> data 1563220ed979SColeman Kanestructure and return <code>XML_STATUS_OK</code>. Otherwise it 1564220ed979SColeman Kaneshould return <code>XML_STATUS_ERROR</code>. The handler will be called 1565220ed979SColeman Kaneat most once per parsed (external) entity. The optional application 1566220ed979SColeman Kanedata pointer <code>encodingHandlerData</code> will be passed back to 1567220ed979SColeman Kanethe handler.</p> 15685bb6a25fSPoul-Henning Kamp 15690a48773fSEric van Gyzen<p>The map array contains information for every possible leading 15705bb6a25fSPoul-Henning Kampbyte in a byte sequence. If the corresponding value is >= 0, then it's 15715bb6a25fSPoul-Henning Kampa single byte sequence and the byte encodes that Unicode value. If the 15725bb6a25fSPoul-Henning Kampvalue is -1, then that byte is invalid as the initial byte in a sequence. 15735bb6a25fSPoul-Henning KampIf the value is -n, where n is an integer > 1, then n is the number of 15745bb6a25fSPoul-Henning Kampbytes in the sequence and the actual conversion is accomplished by a 15755bb6a25fSPoul-Henning Kampcall to the function pointed at by convert. This function may return -1 15765bb6a25fSPoul-Henning Kampif the sequence itself is invalid. The convert pointer may be null if 15775bb6a25fSPoul-Henning Kampthere are only single byte codes. The data parameter passed to the convert 15785bb6a25fSPoul-Henning Kampfunction is the data pointer from <code>XML_Encoding</code>. The 15795bb6a25fSPoul-Henning Kampstring s is <em>NOT</em> nul-terminated and points at the sequence of 15805bb6a25fSPoul-Henning Kampbytes to be converted.</p> 15815bb6a25fSPoul-Henning Kamp 15825bb6a25fSPoul-Henning Kamp<p>The function pointed at by <code>release</code> is called by the 15835bb6a25fSPoul-Henning Kampparser when it is finished with the encoding. It may be NULL.</p> 15845bb6a25fSPoul-Henning Kamp</div> 15855bb6a25fSPoul-Henning Kamp 15865bb6a25fSPoul-Henning Kamp<div class="handler"> 15875bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetStartNamespaceDeclHandler"> 1588220ed979SColeman Kanevoid XMLCALL 15895bb6a25fSPoul-Henning KampXML_SetStartNamespaceDeclHandler(XML_Parser p, 15905bb6a25fSPoul-Henning Kamp XML_StartNamespaceDeclHandler start); 15915bb6a25fSPoul-Henning Kamp</pre> 15925bb6a25fSPoul-Henning Kamp<pre class="signature"> 15935bb6a25fSPoul-Henning Kamptypedef void 1594220ed979SColeman Kane(XMLCALL *XML_StartNamespaceDeclHandler)(void *userData, 15955bb6a25fSPoul-Henning Kamp const XML_Char *prefix, 15965bb6a25fSPoul-Henning Kamp const XML_Char *uri); 15975bb6a25fSPoul-Henning Kamp</pre> 15985bb6a25fSPoul-Henning Kamp<p>Set a handler to be called when a namespace is declared. Namespace 15995bb6a25fSPoul-Henning Kampdeclarations occur inside start tags. But the namespace declaration start 16005bb6a25fSPoul-Henning Kamphandler is called before the start tag handler for each namespace declared 16015bb6a25fSPoul-Henning Kampin that start tag.</p> 16025bb6a25fSPoul-Henning Kamp</div> 16035bb6a25fSPoul-Henning Kamp 16045bb6a25fSPoul-Henning Kamp<div class="handler"> 16055bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetEndNamespaceDeclHandler"> 1606220ed979SColeman Kanevoid XMLCALL 16075bb6a25fSPoul-Henning KampXML_SetEndNamespaceDeclHandler(XML_Parser p, 16085bb6a25fSPoul-Henning Kamp XML_EndNamespaceDeclHandler end); 16095bb6a25fSPoul-Henning Kamp</pre> 16105bb6a25fSPoul-Henning Kamp<pre class="signature"> 16115bb6a25fSPoul-Henning Kamptypedef void 1612220ed979SColeman Kane(XMLCALL *XML_EndNamespaceDeclHandler)(void *userData, 16135bb6a25fSPoul-Henning Kamp const XML_Char *prefix); 16145bb6a25fSPoul-Henning Kamp</pre> 16155bb6a25fSPoul-Henning Kamp<p>Set a handler to be called when leaving the scope of a namespace 16165bb6a25fSPoul-Henning Kampdeclaration. This will be called, for each namespace declaration, 16175bb6a25fSPoul-Henning Kampafter the handler for the end tag of the element in which the 16185bb6a25fSPoul-Henning Kampnamespace was declared.</p> 16195bb6a25fSPoul-Henning Kamp</div> 16205bb6a25fSPoul-Henning Kamp 16215bb6a25fSPoul-Henning Kamp<div class="handler"> 16225bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetNamespaceDeclHandler"> 1623220ed979SColeman Kanevoid XMLCALL 16245bb6a25fSPoul-Henning KampXML_SetNamespaceDeclHandler(XML_Parser p, 16255bb6a25fSPoul-Henning Kamp XML_StartNamespaceDeclHandler start, 16265bb6a25fSPoul-Henning Kamp XML_EndNamespaceDeclHandler end) 16275bb6a25fSPoul-Henning Kamp</pre> 1628220ed979SColeman Kane<p>Sets both namespace declaration handlers with a single call.</p> 16295bb6a25fSPoul-Henning Kamp</div> 16305bb6a25fSPoul-Henning Kamp 16315bb6a25fSPoul-Henning Kamp<div class="handler"> 16325bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetXmlDeclHandler"> 1633220ed979SColeman Kanevoid XMLCALL 16345bb6a25fSPoul-Henning KampXML_SetXmlDeclHandler(XML_Parser p, 16355bb6a25fSPoul-Henning Kamp XML_XmlDeclHandler xmldecl); 16365bb6a25fSPoul-Henning Kamp</pre> 16375bb6a25fSPoul-Henning Kamp<pre class="signature"> 16385bb6a25fSPoul-Henning Kamptypedef void 1639220ed979SColeman Kane(XMLCALL *XML_XmlDeclHandler)(void *userData, 16405bb6a25fSPoul-Henning Kamp const XML_Char *version, 16415bb6a25fSPoul-Henning Kamp const XML_Char *encoding, 16425bb6a25fSPoul-Henning Kamp int standalone); 16435bb6a25fSPoul-Henning Kamp</pre> 16445bb6a25fSPoul-Henning Kamp<p>Sets a handler that is called for XML declarations and also for 16455bb6a25fSPoul-Henning Kamptext declarations discovered in external entities. The way to 16465bb6a25fSPoul-Henning Kampdistinguish is that the <code>version</code> parameter will be NULL 16475bb6a25fSPoul-Henning Kampfor text declarations. The <code>encoding</code> parameter may be NULL 16485bb6a25fSPoul-Henning Kampfor an XML declaration. The <code>standalone</code> argument will 16495bb6a25fSPoul-Henning Kampcontain -1, 0, or 1 indicating respectively that there was no 16505bb6a25fSPoul-Henning Kampstandalone parameter in the declaration, that it was given as no, or 16515bb6a25fSPoul-Henning Kampthat it was given as yes.</p> 16525bb6a25fSPoul-Henning Kamp</div> 16535bb6a25fSPoul-Henning Kamp 16545bb6a25fSPoul-Henning Kamp<div class="handler"> 16555bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetStartDoctypeDeclHandler"> 1656220ed979SColeman Kanevoid XMLCALL 16575bb6a25fSPoul-Henning KampXML_SetStartDoctypeDeclHandler(XML_Parser p, 16585bb6a25fSPoul-Henning Kamp XML_StartDoctypeDeclHandler start); 16595bb6a25fSPoul-Henning Kamp</pre> 16605bb6a25fSPoul-Henning Kamp<pre class="signature"> 16615bb6a25fSPoul-Henning Kamptypedef void 1662220ed979SColeman Kane(XMLCALL *XML_StartDoctypeDeclHandler)(void *userData, 16635bb6a25fSPoul-Henning Kamp const XML_Char *doctypeName, 16645bb6a25fSPoul-Henning Kamp const XML_Char *sysid, 16655bb6a25fSPoul-Henning Kamp const XML_Char *pubid, 16665bb6a25fSPoul-Henning Kamp int has_internal_subset); 16675bb6a25fSPoul-Henning Kamp</pre> 16685bb6a25fSPoul-Henning Kamp<p>Set a handler that is called at the start of a DOCTYPE declaration, 16695bb6a25fSPoul-Henning Kampbefore any external or internal subset is parsed. Both <code>sysid</code> 16705bb6a25fSPoul-Henning Kampand <code>pubid</code> may be NULL. The <code>has_internal_subset</code> 16715bb6a25fSPoul-Henning Kampwill be non-zero if the DOCTYPE declaration has an internal subset.</p> 16725bb6a25fSPoul-Henning Kamp</div> 16735bb6a25fSPoul-Henning Kamp 16745bb6a25fSPoul-Henning Kamp<div class="handler"> 16755bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetEndDoctypeDeclHandler"> 1676220ed979SColeman Kanevoid XMLCALL 16775bb6a25fSPoul-Henning KampXML_SetEndDoctypeDeclHandler(XML_Parser p, 16785bb6a25fSPoul-Henning Kamp XML_EndDoctypeDeclHandler end); 16795bb6a25fSPoul-Henning Kamp</pre> 16805bb6a25fSPoul-Henning Kamp<pre class="signature"> 16815bb6a25fSPoul-Henning Kamptypedef void 1682220ed979SColeman Kane(XMLCALL *XML_EndDoctypeDeclHandler)(void *userData); 16835bb6a25fSPoul-Henning Kamp</pre> 16845bb6a25fSPoul-Henning Kamp<p>Set a handler that is called at the end of a DOCTYPE declaration, 16855bb6a25fSPoul-Henning Kampafter parsing any external subset.</p> 16865bb6a25fSPoul-Henning Kamp</div> 16875bb6a25fSPoul-Henning Kamp 16885bb6a25fSPoul-Henning Kamp<div class="handler"> 16895bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetDoctypeDeclHandler"> 1690220ed979SColeman Kanevoid XMLCALL 16915bb6a25fSPoul-Henning KampXML_SetDoctypeDeclHandler(XML_Parser p, 16925bb6a25fSPoul-Henning Kamp XML_StartDoctypeDeclHandler start, 16935bb6a25fSPoul-Henning Kamp XML_EndDoctypeDeclHandler end); 16945bb6a25fSPoul-Henning Kamp</pre> 16955bb6a25fSPoul-Henning Kamp<p>Set both doctype handlers with one call.</p> 16965bb6a25fSPoul-Henning Kamp</div> 16975bb6a25fSPoul-Henning Kamp 16985bb6a25fSPoul-Henning Kamp<div class="handler"> 16995bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetElementDeclHandler"> 1700220ed979SColeman Kanevoid XMLCALL 17015bb6a25fSPoul-Henning KampXML_SetElementDeclHandler(XML_Parser p, 17025bb6a25fSPoul-Henning Kamp XML_ElementDeclHandler eldecl); 17035bb6a25fSPoul-Henning Kamp</pre> 17045bb6a25fSPoul-Henning Kamp<pre class="signature"> 17055bb6a25fSPoul-Henning Kamptypedef void 1706220ed979SColeman Kane(XMLCALL *XML_ElementDeclHandler)(void *userData, 17075bb6a25fSPoul-Henning Kamp const XML_Char *name, 17085bb6a25fSPoul-Henning Kamp XML_Content *model); 17095bb6a25fSPoul-Henning Kamp</pre> 17105bb6a25fSPoul-Henning Kamp<pre class="signature"> 17115bb6a25fSPoul-Henning Kampenum XML_Content_Type { 17125bb6a25fSPoul-Henning Kamp XML_CTYPE_EMPTY = 1, 17135bb6a25fSPoul-Henning Kamp XML_CTYPE_ANY, 17145bb6a25fSPoul-Henning Kamp XML_CTYPE_MIXED, 17155bb6a25fSPoul-Henning Kamp XML_CTYPE_NAME, 17165bb6a25fSPoul-Henning Kamp XML_CTYPE_CHOICE, 17175bb6a25fSPoul-Henning Kamp XML_CTYPE_SEQ 17185bb6a25fSPoul-Henning Kamp}; 17195bb6a25fSPoul-Henning Kamp 17205bb6a25fSPoul-Henning Kampenum XML_Content_Quant { 17215bb6a25fSPoul-Henning Kamp XML_CQUANT_NONE, 17225bb6a25fSPoul-Henning Kamp XML_CQUANT_OPT, 17235bb6a25fSPoul-Henning Kamp XML_CQUANT_REP, 17245bb6a25fSPoul-Henning Kamp XML_CQUANT_PLUS 17255bb6a25fSPoul-Henning Kamp}; 17265bb6a25fSPoul-Henning Kamp 17275bb6a25fSPoul-Henning Kamptypedef struct XML_cp XML_Content; 17285bb6a25fSPoul-Henning Kamp 17295bb6a25fSPoul-Henning Kampstruct XML_cp { 17305bb6a25fSPoul-Henning Kamp enum XML_Content_Type type; 17315bb6a25fSPoul-Henning Kamp enum XML_Content_Quant quant; 17325bb6a25fSPoul-Henning Kamp const XML_Char * name; 17335bb6a25fSPoul-Henning Kamp unsigned int numchildren; 17345bb6a25fSPoul-Henning Kamp XML_Content * children; 17355bb6a25fSPoul-Henning Kamp}; 17365bb6a25fSPoul-Henning Kamp</pre> 17375bb6a25fSPoul-Henning Kamp<p>Sets a handler for element declarations in a DTD. The handler gets 17385bb6a25fSPoul-Henning Kampcalled with the name of the element in the declaration and a pointer 17395bb6a25fSPoul-Henning Kampto a structure that contains the element model. It is the 1740220ed979SColeman Kaneapplication's responsibility to free this data structure using 1741220ed979SColeman Kane<code><a href="#XML_FreeContentModel" 1742220ed979SColeman Kane>XML_FreeContentModel</a></code>.</p> 17435bb6a25fSPoul-Henning Kamp 17445bb6a25fSPoul-Henning Kamp<p>The <code>model</code> argument is the root of a tree of 17455bb6a25fSPoul-Henning Kamp<code>XML_Content</code> nodes. If <code>type</code> equals 17465bb6a25fSPoul-Henning Kamp<code>XML_CTYPE_EMPTY</code> or <code>XML_CTYPE_ANY</code>, then 17475bb6a25fSPoul-Henning Kamp<code>quant</code> will be <code>XML_CQUANT_NONE</code>, and the other 17485bb6a25fSPoul-Henning Kampfields will be zero or NULL. If <code>type</code> is 17495bb6a25fSPoul-Henning Kamp<code>XML_CTYPE_MIXED</code>, then <code>quant</code> will be 17505bb6a25fSPoul-Henning Kamp<code>XML_CQUANT_NONE</code> or <code>XML_CQUANT_REP</code> and 17515bb6a25fSPoul-Henning Kamp<code>numchildren</code> will contain the number of elements that are 17525bb6a25fSPoul-Henning Kampallowed to be mixed in and <code>children</code> points to an array of 17535bb6a25fSPoul-Henning Kamp<code>XML_Content</code> structures that will all have type 17545bb6a25fSPoul-Henning KampXML_CTYPE_NAME with no quantification. Only the root node can be type 17555bb6a25fSPoul-Henning Kamp<code>XML_CTYPE_EMPTY</code>, <code>XML_CTYPE_ANY</code>, or 17565bb6a25fSPoul-Henning Kamp<code>XML_CTYPE_MIXED</code>.</p> 17575bb6a25fSPoul-Henning Kamp 17585bb6a25fSPoul-Henning Kamp<p>For type <code>XML_CTYPE_NAME</code>, the <code>name</code> field 17595bb6a25fSPoul-Henning Kamppoints to the name and the <code>numchildren</code> and 17605bb6a25fSPoul-Henning Kamp<code>children</code> fields will be zero and NULL. The 17615bb6a25fSPoul-Henning Kamp<code>quant</code> field will indicate any quantifiers placed on the 17625bb6a25fSPoul-Henning Kampname.</p> 17635bb6a25fSPoul-Henning Kamp 17645bb6a25fSPoul-Henning Kamp<p>Types <code>XML_CTYPE_CHOICE</code> and <code>XML_CTYPE_SEQ</code> 17655bb6a25fSPoul-Henning Kampindicate a choice or sequence respectively. The 17665bb6a25fSPoul-Henning Kamp<code>numchildren</code> field indicates how many nodes in the choice 17675bb6a25fSPoul-Henning Kampor sequence and <code>children</code> points to the nodes.</p> 17685bb6a25fSPoul-Henning Kamp</div> 17695bb6a25fSPoul-Henning Kamp 17705bb6a25fSPoul-Henning Kamp<div class="handler"> 17715bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetAttlistDeclHandler"> 1772220ed979SColeman Kanevoid XMLCALL 17735bb6a25fSPoul-Henning KampXML_SetAttlistDeclHandler(XML_Parser p, 17745bb6a25fSPoul-Henning Kamp XML_AttlistDeclHandler attdecl); 17755bb6a25fSPoul-Henning Kamp</pre> 17765bb6a25fSPoul-Henning Kamp<pre class="signature"> 17775bb6a25fSPoul-Henning Kamptypedef void 1778220ed979SColeman Kane(XMLCALL *XML_AttlistDeclHandler)(void *userData, 17795bb6a25fSPoul-Henning Kamp const XML_Char *elname, 17805bb6a25fSPoul-Henning Kamp const XML_Char *attname, 17815bb6a25fSPoul-Henning Kamp const XML_Char *att_type, 17825bb6a25fSPoul-Henning Kamp const XML_Char *dflt, 17835bb6a25fSPoul-Henning Kamp int isrequired); 17845bb6a25fSPoul-Henning Kamp</pre> 17855bb6a25fSPoul-Henning Kamp<p>Set a handler for attlist declarations in the DTD. This handler is 17865bb6a25fSPoul-Henning Kampcalled for <em>each</em> attribute. So a single attlist declaration 17875bb6a25fSPoul-Henning Kampwith multiple attributes declared will generate multiple calls to this 17885bb6a25fSPoul-Henning Kamphandler. The <code>elname</code> parameter returns the name of the 17895bb6a25fSPoul-Henning Kampelement for which the attribute is being declared. The attribute name 17905bb6a25fSPoul-Henning Kampis in the <code>attname</code> parameter. The attribute type is in the 17915bb6a25fSPoul-Henning Kamp<code>att_type</code> parameter. It is the string representing the 17925bb6a25fSPoul-Henning Kamptype in the declaration with whitespace removed.</p> 17935bb6a25fSPoul-Henning Kamp 17945bb6a25fSPoul-Henning Kamp<p>The <code>dflt</code> parameter holds the default value. It will be 17955bb6a25fSPoul-Henning KampNULL in the case of "#IMPLIED" or "#REQUIRED" attributes. You can 17965bb6a25fSPoul-Henning Kampdistinguish these two cases by checking the <code>isrequired</code> 17975bb6a25fSPoul-Henning Kampparameter, which will be true in the case of "#REQUIRED" attributes. 17985bb6a25fSPoul-Henning KampAttributes which are "#FIXED" will have also have a true 17995bb6a25fSPoul-Henning Kamp<code>isrequired</code>, but they will have the non-NULL fixed value 18005bb6a25fSPoul-Henning Kampin the <code>dflt</code> parameter.</p> 18015bb6a25fSPoul-Henning Kamp</div> 18025bb6a25fSPoul-Henning Kamp 18035bb6a25fSPoul-Henning Kamp<div class="handler"> 18045bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetEntityDeclHandler"> 1805220ed979SColeman Kanevoid XMLCALL 18065bb6a25fSPoul-Henning KampXML_SetEntityDeclHandler(XML_Parser p, 18075bb6a25fSPoul-Henning Kamp XML_EntityDeclHandler handler); 18085bb6a25fSPoul-Henning Kamp</pre> 18095bb6a25fSPoul-Henning Kamp<pre class="signature"> 18105bb6a25fSPoul-Henning Kamptypedef void 1811220ed979SColeman Kane(XMLCALL *XML_EntityDeclHandler)(void *userData, 18125bb6a25fSPoul-Henning Kamp const XML_Char *entityName, 18135bb6a25fSPoul-Henning Kamp int is_parameter_entity, 18145bb6a25fSPoul-Henning Kamp const XML_Char *value, 18155bb6a25fSPoul-Henning Kamp int value_length, 18165bb6a25fSPoul-Henning Kamp const XML_Char *base, 18175bb6a25fSPoul-Henning Kamp const XML_Char *systemId, 18185bb6a25fSPoul-Henning Kamp const XML_Char *publicId, 18195bb6a25fSPoul-Henning Kamp const XML_Char *notationName); 18205bb6a25fSPoul-Henning Kamp</pre> 18215bb6a25fSPoul-Henning Kamp<p>Sets a handler that will be called for all entity declarations. 18225bb6a25fSPoul-Henning KampThe <code>is_parameter_entity</code> argument will be non-zero in the 18235bb6a25fSPoul-Henning Kampcase of parameter entities and zero otherwise.</p> 18245bb6a25fSPoul-Henning Kamp 18255bb6a25fSPoul-Henning Kamp<p>For internal entities (<code><!ENTITY foo "bar"></code>), 18265bb6a25fSPoul-Henning Kamp<code>value</code> will be non-NULL and <code>systemId</code>, 18275bb6a25fSPoul-Henning Kamp<code>publicId</code>, and <code>notationName</code> will all be NULL. 18285bb6a25fSPoul-Henning KampThe value string is <em>not</em> NULL terminated; the length is 18295bb6a25fSPoul-Henning Kampprovided in the <code>value_length</code> parameter. Do not use 18305bb6a25fSPoul-Henning Kamp<code>value_length</code> to test for internal entities, since it is 18315bb6a25fSPoul-Henning Kamplegal to have zero-length values. Instead check for whether or not 18325bb6a25fSPoul-Henning Kamp<code>value</code> is NULL.</p> <p>The <code>notationName</code> 18335bb6a25fSPoul-Henning Kampargument will have a non-NULL value only for unparsed entity 18345bb6a25fSPoul-Henning Kampdeclarations.</p> 18355bb6a25fSPoul-Henning Kamp</div> 18365bb6a25fSPoul-Henning Kamp 18375bb6a25fSPoul-Henning Kamp<div class="handler"> 18385bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetUnparsedEntityDeclHandler"> 1839220ed979SColeman Kanevoid XMLCALL 18405bb6a25fSPoul-Henning KampXML_SetUnparsedEntityDeclHandler(XML_Parser p, 18415bb6a25fSPoul-Henning Kamp XML_UnparsedEntityDeclHandler h) 18425bb6a25fSPoul-Henning Kamp</pre> 18435bb6a25fSPoul-Henning Kamp<pre class="signature"> 18445bb6a25fSPoul-Henning Kamptypedef void 1845220ed979SColeman Kane(XMLCALL *XML_UnparsedEntityDeclHandler)(void *userData, 18465bb6a25fSPoul-Henning Kamp const XML_Char *entityName, 18475bb6a25fSPoul-Henning Kamp const XML_Char *base, 18485bb6a25fSPoul-Henning Kamp const XML_Char *systemId, 18495bb6a25fSPoul-Henning Kamp const XML_Char *publicId, 18505bb6a25fSPoul-Henning Kamp const XML_Char *notationName); 18515bb6a25fSPoul-Henning Kamp</pre> 18525bb6a25fSPoul-Henning Kamp<p>Set a handler that receives declarations of unparsed entities. These 18535bb6a25fSPoul-Henning Kampare entity declarations that have a notation (NDATA) field:</p> 18545bb6a25fSPoul-Henning Kamp 18555bb6a25fSPoul-Henning Kamp<div id="eg"><pre> 18565bb6a25fSPoul-Henning Kamp<!ENTITY logo SYSTEM "images/logo.gif" NDATA gif> 18575bb6a25fSPoul-Henning Kamp</pre></div> 18585bb6a25fSPoul-Henning Kamp<p>This handler is obsolete and is provided for backwards 18595bb6a25fSPoul-Henning Kampcompatibility. Use instead <a href= "#XML_SetEntityDeclHandler" 18605bb6a25fSPoul-Henning Kamp>XML_SetEntityDeclHandler</a>.</p> 18615bb6a25fSPoul-Henning Kamp</div> 18625bb6a25fSPoul-Henning Kamp 18635bb6a25fSPoul-Henning Kamp<div class="handler"> 18645bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetNotationDeclHandler"> 1865220ed979SColeman Kanevoid XMLCALL 18665bb6a25fSPoul-Henning KampXML_SetNotationDeclHandler(XML_Parser p, 18675bb6a25fSPoul-Henning Kamp XML_NotationDeclHandler h) 18685bb6a25fSPoul-Henning Kamp</pre> 18695bb6a25fSPoul-Henning Kamp<pre class="signature"> 18705bb6a25fSPoul-Henning Kamptypedef void 1871220ed979SColeman Kane(XMLCALL *XML_NotationDeclHandler)(void *userData, 18725bb6a25fSPoul-Henning Kamp const XML_Char *notationName, 18735bb6a25fSPoul-Henning Kamp const XML_Char *base, 18745bb6a25fSPoul-Henning Kamp const XML_Char *systemId, 18755bb6a25fSPoul-Henning Kamp const XML_Char *publicId); 18765bb6a25fSPoul-Henning Kamp</pre> 18775bb6a25fSPoul-Henning Kamp<p>Set a handler that receives notation declarations.</p> 18785bb6a25fSPoul-Henning Kamp</div> 18795bb6a25fSPoul-Henning Kamp 18805bb6a25fSPoul-Henning Kamp<div class="handler"> 18815bb6a25fSPoul-Henning Kamp<pre class="setter" id="XML_SetNotStandaloneHandler"> 1882220ed979SColeman Kanevoid XMLCALL 18835bb6a25fSPoul-Henning KampXML_SetNotStandaloneHandler(XML_Parser p, 18845bb6a25fSPoul-Henning Kamp XML_NotStandaloneHandler h) 18855bb6a25fSPoul-Henning Kamp</pre> 18865bb6a25fSPoul-Henning Kamp<pre class="signature"> 18875bb6a25fSPoul-Henning Kamptypedef int 1888220ed979SColeman Kane(XMLCALL *XML_NotStandaloneHandler)(void *userData); 18895bb6a25fSPoul-Henning Kamp</pre> 18905bb6a25fSPoul-Henning Kamp<p>Set a handler that is called if the document is not "standalone". 18915bb6a25fSPoul-Henning KampThis happens when there is an external subset or a reference to a 18925bb6a25fSPoul-Henning Kampparameter entity, but does not have standalone set to "yes" in an XML 1893220ed979SColeman Kanedeclaration. If this handler returns <code>XML_STATUS_ERROR</code>, 1894220ed979SColeman Kanethen the parser will throw an <code>XML_ERROR_NOT_STANDALONE</code> 1895220ed979SColeman Kaneerror.</p> 18965bb6a25fSPoul-Henning Kamp</div> 18975bb6a25fSPoul-Henning Kamp 18985bb6a25fSPoul-Henning Kamp<h3><a name="position">Parse position and error reporting functions</a></h3> 18995bb6a25fSPoul-Henning Kamp 19005bb6a25fSPoul-Henning Kamp<p>These are the functions you'll want to call when the parse 1901220ed979SColeman Kanefunctions return <code>XML_STATUS_ERROR</code> (a parse error has 1902220ed979SColeman Kaneoccurred), although the position reporting functions are useful outside 1903220ed979SColeman Kaneof errors. The position reported is the byte position (in the original 1904220ed979SColeman Kanedocument or entity encoding) of the first of the sequence of 1905220ed979SColeman Kanecharacters that generated the current event (or the error that caused 1906220ed979SColeman Kanethe parse functions to return <code>XML_STATUS_ERROR</code>.) The 1907220ed979SColeman Kaneexceptions are callbacks trigged by declarations in the document 1908220ed979SColeman Kaneprologue, in which case they exact position reported is somewhere in the 1909220ed979SColeman Kanerelevant markup, but not necessarily as meaningful as for other 1910220ed979SColeman Kaneevents.</p> 19115bb6a25fSPoul-Henning Kamp 19125bb6a25fSPoul-Henning Kamp<p>The position reporting functions are accurate only outside of the 19135bb6a25fSPoul-Henning KampDTD. In other words, they usually return bogus information when 19145bb6a25fSPoul-Henning Kampcalled from within a DTD declaration handler.</p> 19155bb6a25fSPoul-Henning Kamp 19165bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetErrorCode"> 1917220ed979SColeman Kaneenum XML_Error XMLCALL 19185bb6a25fSPoul-Henning KampXML_GetErrorCode(XML_Parser p); 19195bb6a25fSPoul-Henning Kamp</pre> 19205bb6a25fSPoul-Henning Kamp<div class="fcndef"> 19215bb6a25fSPoul-Henning KampReturn what type of error has occurred. 19225bb6a25fSPoul-Henning Kamp</div> 19235bb6a25fSPoul-Henning Kamp 19245bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ErrorString"> 1925220ed979SColeman Kaneconst XML_LChar * XMLCALL 1926220ed979SColeman KaneXML_ErrorString(enum XML_Error code); 19275bb6a25fSPoul-Henning Kamp</pre> 19285bb6a25fSPoul-Henning Kamp<div class="fcndef"> 19295bb6a25fSPoul-Henning KampReturn a string describing the error corresponding to code. 19305bb6a25fSPoul-Henning KampThe code should be one of the enums that can be returned from 19315bb6a25fSPoul-Henning Kamp<code><a href= "#XML_GetErrorCode" >XML_GetErrorCode</a></code>. 19325bb6a25fSPoul-Henning Kamp</div> 19335bb6a25fSPoul-Henning Kamp 19345bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetCurrentByteIndex"> 1935220ed979SColeman KaneXML_Index XMLCALL 19365bb6a25fSPoul-Henning KampXML_GetCurrentByteIndex(XML_Parser p); 19375bb6a25fSPoul-Henning Kamp</pre> 19385bb6a25fSPoul-Henning Kamp<div class="fcndef"> 1939220ed979SColeman KaneReturn the byte offset of the position. This always corresponds to 1940220ed979SColeman Kanethe values returned by <code><a href= "#XML_GetCurrentLineNumber" 1941220ed979SColeman Kane>XML_GetCurrentLineNumber</a></code> and <code><a href= 1942220ed979SColeman Kane"#XML_GetCurrentColumnNumber" >XML_GetCurrentColumnNumber</a></code>. 19435bb6a25fSPoul-Henning Kamp</div> 19445bb6a25fSPoul-Henning Kamp 19455bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetCurrentLineNumber"> 1946220ed979SColeman KaneXML_Size XMLCALL 19475bb6a25fSPoul-Henning KampXML_GetCurrentLineNumber(XML_Parser p); 19485bb6a25fSPoul-Henning Kamp</pre> 19495bb6a25fSPoul-Henning Kamp<div class="fcndef"> 1950220ed979SColeman KaneReturn the line number of the position. The first line is reported as 1951220ed979SColeman Kane<code>1</code>. 19525bb6a25fSPoul-Henning Kamp</div> 19535bb6a25fSPoul-Henning Kamp 19545bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetCurrentColumnNumber"> 1955220ed979SColeman KaneXML_Size XMLCALL 19565bb6a25fSPoul-Henning KampXML_GetCurrentColumnNumber(XML_Parser p); 19575bb6a25fSPoul-Henning Kamp</pre> 19585bb6a25fSPoul-Henning Kamp<div class="fcndef"> 19595bb6a25fSPoul-Henning KampReturn the offset, from the beginning of the current line, of 19605bb6a25fSPoul-Henning Kampthe position. 19615bb6a25fSPoul-Henning Kamp</div> 19625bb6a25fSPoul-Henning Kamp 19635bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetCurrentByteCount"> 1964220ed979SColeman Kaneint XMLCALL 19655bb6a25fSPoul-Henning KampXML_GetCurrentByteCount(XML_Parser p); 19665bb6a25fSPoul-Henning Kamp</pre> 19675bb6a25fSPoul-Henning Kamp<div class="fcndef"> 19685bb6a25fSPoul-Henning KampReturn the number of bytes in the current event. Returns 19695bb6a25fSPoul-Henning Kamp<code>0</code> if the event is inside a reference to an internal 19705bb6a25fSPoul-Henning Kampentity and for the end-tag event for empty element tags (the later can 19715bb6a25fSPoul-Henning Kampbe used to distinguish empty-element tags from empty elements using 19725bb6a25fSPoul-Henning Kampseparate start and end tags). 19735bb6a25fSPoul-Henning Kamp</div> 19745bb6a25fSPoul-Henning Kamp 19755bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetInputContext"> 1976220ed979SColeman Kaneconst char * XMLCALL 19775bb6a25fSPoul-Henning KampXML_GetInputContext(XML_Parser p, 19785bb6a25fSPoul-Henning Kamp int *offset, 19795bb6a25fSPoul-Henning Kamp int *size); 19805bb6a25fSPoul-Henning Kamp</pre> 19815bb6a25fSPoul-Henning Kamp<div class="fcndef"> 19825bb6a25fSPoul-Henning Kamp 19835bb6a25fSPoul-Henning Kamp<p>Returns the parser's input buffer, sets the integer pointed at by 19845bb6a25fSPoul-Henning Kamp<code>offset</code> to the offset within this buffer of the current 19855bb6a25fSPoul-Henning Kampparse position, and set the integer pointed at by <code>size</code> to 19865bb6a25fSPoul-Henning Kampthe size of the returned buffer.</p> 19875bb6a25fSPoul-Henning Kamp 19885bb6a25fSPoul-Henning Kamp<p>This should only be called from within a handler during an active 19895bb6a25fSPoul-Henning Kampparse and the returned buffer should only be referred to from within 19905bb6a25fSPoul-Henning Kampthe handler that made the call. This input buffer contains the 19915bb6a25fSPoul-Henning Kampuntranslated bytes of the input.</p> 19925bb6a25fSPoul-Henning Kamp 19935bb6a25fSPoul-Henning Kamp<p>Only a limited amount of context is kept, so if the event 19945bb6a25fSPoul-Henning Kamptriggering a call spans over a very large amount of input, the actual 19955bb6a25fSPoul-Henning Kampparse position may be before the beginning of the buffer.</p> 1996220ed979SColeman Kane 1997220ed979SColeman Kane<p>If <code>XML_CONTEXT_BYTES</code> is not defined, this will always 1998220ed979SColeman Kanereturn NULL.</p> 19995bb6a25fSPoul-Henning Kamp</div> 20005bb6a25fSPoul-Henning Kamp 20015bb6a25fSPoul-Henning Kamp<h3><a name="miscellaneous">Miscellaneous functions</a></h3> 20025bb6a25fSPoul-Henning Kamp 20035bb6a25fSPoul-Henning Kamp<p>The functions in this section either obtain state information from 20040a48773fSEric van Gyzenthe parser or can be used to dynamically set parser options.</p> 20055bb6a25fSPoul-Henning Kamp 20065bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_SetUserData"> 2007220ed979SColeman Kanevoid XMLCALL 20085bb6a25fSPoul-Henning KampXML_SetUserData(XML_Parser p, 20095bb6a25fSPoul-Henning Kamp void *userData); 20105bb6a25fSPoul-Henning Kamp</pre> 20115bb6a25fSPoul-Henning Kamp<div class="fcndef"> 20125bb6a25fSPoul-Henning KampThis sets the user data pointer that gets passed to handlers. It 20135bb6a25fSPoul-Henning Kampoverwrites any previous value for this pointer. Note that the 20145bb6a25fSPoul-Henning Kampapplication is responsible for freeing the memory associated with 20155bb6a25fSPoul-Henning Kamp<code>userData</code> when it is finished with the parser. So if you 20165bb6a25fSPoul-Henning Kampcall this when there's already a pointer there, and you haven't freed 20175bb6a25fSPoul-Henning Kampthe memory associated with it, then you've probably just leaked 20185bb6a25fSPoul-Henning Kampmemory. 20195bb6a25fSPoul-Henning Kamp</div> 20205bb6a25fSPoul-Henning Kamp 20215bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetUserData"> 2022220ed979SColeman Kanevoid * XMLCALL 20235bb6a25fSPoul-Henning KampXML_GetUserData(XML_Parser p); 20245bb6a25fSPoul-Henning Kamp</pre> 20255bb6a25fSPoul-Henning Kamp<div class="fcndef"> 20265bb6a25fSPoul-Henning KampThis returns the user data pointer that gets passed to handlers. 20275bb6a25fSPoul-Henning KampIt is actually implemented as a macro. 20285bb6a25fSPoul-Henning Kamp</div> 20295bb6a25fSPoul-Henning Kamp 20305bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_UseParserAsHandlerArg"> 2031220ed979SColeman Kanevoid XMLCALL 20325bb6a25fSPoul-Henning KampXML_UseParserAsHandlerArg(XML_Parser p); 20335bb6a25fSPoul-Henning Kamp</pre> 20345bb6a25fSPoul-Henning Kamp<div class="fcndef"> 2035220ed979SColeman KaneAfter this is called, handlers receive the parser in their 2036220ed979SColeman Kane<code>userData</code> arguments. The user data can still be obtained 2037220ed979SColeman Kaneusing the <code><a href= "#XML_GetUserData" 2038220ed979SColeman Kane>XML_GetUserData</a></code> function. 20395bb6a25fSPoul-Henning Kamp</div> 20405bb6a25fSPoul-Henning Kamp 20415bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_SetBase"> 2042220ed979SColeman Kaneenum XML_Status XMLCALL 20435bb6a25fSPoul-Henning KampXML_SetBase(XML_Parser p, 20445bb6a25fSPoul-Henning Kamp const XML_Char *base); 20455bb6a25fSPoul-Henning Kamp</pre> 20465bb6a25fSPoul-Henning Kamp<div class="fcndef"> 20475bb6a25fSPoul-Henning KampSet the base to be used for resolving relative URIs in system 2048220ed979SColeman Kaneidentifiers. The return value is <code>XML_STATUS_ERROR</code> if 2049220ed979SColeman Kanethere's no memory to store base, otherwise it's 2050220ed979SColeman Kane<code>XML_STATUS_OK</code>. 20515bb6a25fSPoul-Henning Kamp</div> 20525bb6a25fSPoul-Henning Kamp 20535bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetBase"> 2054220ed979SColeman Kaneconst XML_Char * XMLCALL 20555bb6a25fSPoul-Henning KampXML_GetBase(XML_Parser p); 20565bb6a25fSPoul-Henning Kamp</pre> 20575bb6a25fSPoul-Henning Kamp<div class="fcndef"> 20585bb6a25fSPoul-Henning KampReturn the base for resolving relative URIs. 20595bb6a25fSPoul-Henning Kamp</div> 20605bb6a25fSPoul-Henning Kamp 20615bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetSpecifiedAttributeCount"> 2062220ed979SColeman Kaneint XMLCALL 20635bb6a25fSPoul-Henning KampXML_GetSpecifiedAttributeCount(XML_Parser p); 20645bb6a25fSPoul-Henning Kamp</pre> 20655bb6a25fSPoul-Henning Kamp<div class="fcndef"> 20665bb6a25fSPoul-Henning KampWhen attributes are reported to the start handler in the atts vector, 20675bb6a25fSPoul-Henning Kampattributes that were explicitly set in the element occur before any 20685bb6a25fSPoul-Henning Kampattributes that receive their value from default information in an 20695bb6a25fSPoul-Henning KampATTLIST declaration. This function returns the number of attributes 20705bb6a25fSPoul-Henning Kampthat were explicitly set times two, thus giving the offset in the 20715bb6a25fSPoul-Henning Kamp<code>atts</code> array passed to the start tag handler of the first 20725bb6a25fSPoul-Henning Kampattribute set due to defaults. It supplies information for the last 20735bb6a25fSPoul-Henning Kampcall to a start handler. If called inside a start handler, then that 20745bb6a25fSPoul-Henning Kampmeans the current call. 20755bb6a25fSPoul-Henning Kamp</div> 20765bb6a25fSPoul-Henning Kamp 20775bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetIdAttributeIndex"> 2078220ed979SColeman Kaneint XMLCALL 20795bb6a25fSPoul-Henning KampXML_GetIdAttributeIndex(XML_Parser p); 20805bb6a25fSPoul-Henning Kamp</pre> 20815bb6a25fSPoul-Henning Kamp<div class="fcndef"> 20825bb6a25fSPoul-Henning KampReturns the index of the ID attribute passed in the atts array in the 20835bb6a25fSPoul-Henning Kamplast call to <code><a href= "#XML_StartElementHandler" 20845bb6a25fSPoul-Henning Kamp>XML_StartElementHandler</a></code>, or -1 if there is no ID 20855bb6a25fSPoul-Henning Kampattribute. If called inside a start handler, then that means the 20865bb6a25fSPoul-Henning Kampcurrent call. 20875bb6a25fSPoul-Henning Kamp</div> 20885bb6a25fSPoul-Henning Kamp 2089e3466a89SXin LI<pre class="fcndec" id="XML_GetAttributeInfo"> 2090e3466a89SXin LIconst XML_AttrInfo * XMLCALL 2091e3466a89SXin LIXML_GetAttributeInfo(XML_Parser parser); 2092e3466a89SXin LI</pre> 2093e3466a89SXin LI<pre class="signature"> 2094e3466a89SXin LItypedef struct { 2095e3466a89SXin LI XML_Index nameStart; /* Offset to beginning of the attribute name. */ 2096e3466a89SXin LI XML_Index nameEnd; /* Offset after the attribute name's last byte. */ 2097e3466a89SXin LI XML_Index valueStart; /* Offset to beginning of the attribute value. */ 2098e3466a89SXin LI XML_Index valueEnd; /* Offset after the attribute value's last byte. */ 2099e3466a89SXin LI} XML_AttrInfo; 2100e3466a89SXin LI</pre> 2101e3466a89SXin LI<div class="fcndef"> 2102e3466a89SXin LIReturns an array of <code>XML_AttrInfo</code> structures for the 2103e3466a89SXin LIattribute/value pairs passed in the last call to the 2104e3466a89SXin LI<code>XML_StartElementHandler</code> that were specified 2105e3466a89SXin LIin the start-tag rather than defaulted. Each attribute/value pair counts 2106e3466a89SXin LIas 1; thus the number of entries in the array is 2107e3466a89SXin LI<code>XML_GetSpecifiedAttributeCount(parser) / 2</code>. 2108e3466a89SXin LI</div> 2109e3466a89SXin LI 21105bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_SetEncoding"> 2111220ed979SColeman Kaneenum XML_Status XMLCALL 21125bb6a25fSPoul-Henning KampXML_SetEncoding(XML_Parser p, 21135bb6a25fSPoul-Henning Kamp const XML_Char *encoding); 21145bb6a25fSPoul-Henning Kamp</pre> 21155bb6a25fSPoul-Henning Kamp<div class="fcndef"> 21165bb6a25fSPoul-Henning KampSet the encoding to be used by the parser. It is equivalent to 21175bb6a25fSPoul-Henning Kamppassing a non-null encoding argument to the parser creation functions. 21185bb6a25fSPoul-Henning KampIt must not be called after <code><a href= "#XML_Parse" 21195bb6a25fSPoul-Henning Kamp>XML_Parse</a></code> or <code><a href= "#XML_ParseBuffer" 21205bb6a25fSPoul-Henning Kamp>XML_ParseBuffer</a></code> have been called on the given parser. 2121220ed979SColeman KaneReturns <code>XML_STATUS_OK</code> on success or 2122220ed979SColeman Kane<code>XML_STATUS_ERROR</code> on error. 21235bb6a25fSPoul-Henning Kamp</div> 21245bb6a25fSPoul-Henning Kamp 21255bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_SetParamEntityParsing"> 2126220ed979SColeman Kaneint XMLCALL 21275bb6a25fSPoul-Henning KampXML_SetParamEntityParsing(XML_Parser p, 21285bb6a25fSPoul-Henning Kamp enum XML_ParamEntityParsing code); 21295bb6a25fSPoul-Henning Kamp</pre> 21305bb6a25fSPoul-Henning Kamp<div class="fcndef"> 21315bb6a25fSPoul-Henning KampThis enables parsing of parameter entities, including the external 21325bb6a25fSPoul-Henning Kampparameter entity that is the external DTD subset, according to 21335bb6a25fSPoul-Henning Kamp<code>code</code>. 21345bb6a25fSPoul-Henning KampThe choices for <code>code</code> are: 21355bb6a25fSPoul-Henning Kamp<ul> 21365bb6a25fSPoul-Henning Kamp<li><code>XML_PARAM_ENTITY_PARSING_NEVER</code></li> 21375bb6a25fSPoul-Henning Kamp<li><code>XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE</code></li> 21385bb6a25fSPoul-Henning Kamp<li><code>XML_PARAM_ENTITY_PARSING_ALWAYS</code></li> 21395bb6a25fSPoul-Henning Kamp</ul> 2140e3466a89SXin LI<b>Note:</b> If <code>XML_SetParamEntityParsing</code> is called after 2141e3466a89SXin LI<code>XML_Parse</code> or <code>XML_ParseBuffer</code>, then it has 2142e3466a89SXin LIno effect and will always return 0. 2143e3466a89SXin LI</div> 2144e3466a89SXin LI 2145e3466a89SXin LI<pre class="fcndec" id="XML_SetHashSalt"> 2146e3466a89SXin LIint XMLCALL 2147e3466a89SXin LIXML_SetHashSalt(XML_Parser p, 2148e3466a89SXin LI unsigned long hash_salt); 2149e3466a89SXin LI</pre> 2150e3466a89SXin LI<div class="fcndef"> 2151e3466a89SXin LISets the hash salt to use for internal hash calculations. 2152e3466a89SXin LIHelps in preventing DoS attacks based on predicting hash 2153e3466a89SXin LIfunction behavior. In order to have an effect this must be called 2154e3466a89SXin LIbefore parsing has started. Returns 1 if successful, 0 when called 2155e3466a89SXin LIafter <code>XML_Parse</code> or <code>XML_ParseBuffer</code>. 2156be8aff81SXin LI<p><b>Note:</b>This call is optional, as the parser will auto-generate 2157*6b2c1e49SXin LIa new random salt value if no value has been set at the start of parsing.</p> 2158be8aff81SXin LI<p><b>Note:</b>One should not call <code>XML_SetHashSalt</code> with a 2159be8aff81SXin LIhash salt value of 0, as this value is used as sentinel value to indicate 2160be8aff81SXin LIthat <code>XML_SetHashSalt</code> has <b>not</b> been called. Consequently 2161be8aff81SXin LIsuch a call will have no effect, even if it returns 1.</p> 21625bb6a25fSPoul-Henning Kamp</div> 21635bb6a25fSPoul-Henning Kamp 21645bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_UseForeignDTD"> 2165220ed979SColeman Kaneenum XML_Error XMLCALL 21665bb6a25fSPoul-Henning KampXML_UseForeignDTD(XML_Parser parser, XML_Bool useDTD); 21675bb6a25fSPoul-Henning Kamp</pre> 21685bb6a25fSPoul-Henning Kamp<div class="fcndef"> 21695bb6a25fSPoul-Henning Kamp<p>This function allows an application to provide an external subset 21705bb6a25fSPoul-Henning Kampfor the document type declaration for documents which do not specify 21715bb6a25fSPoul-Henning Kampan external subset of their own. For documents which specify an 21725bb6a25fSPoul-Henning Kampexternal subset in their DOCTYPE declaration, the application-provided 21735bb6a25fSPoul-Henning Kampsubset will be ignored. If the document does not contain a DOCTYPE 21745bb6a25fSPoul-Henning Kampdeclaration at all and <code>useDTD</code> is true, the 21755bb6a25fSPoul-Henning Kampapplication-provided subset will be parsed, but the 21765bb6a25fSPoul-Henning Kamp<code>startDoctypeDeclHandler</code> and 21775bb6a25fSPoul-Henning Kamp<code>endDoctypeDeclHandler</code> functions, if set, will not be 21785bb6a25fSPoul-Henning Kampcalled. The setting of parameter entity parsing, controlled using 21795bb6a25fSPoul-Henning Kamp<code><a href= "#XML_SetParamEntityParsing" 21805bb6a25fSPoul-Henning Kamp>XML_SetParamEntityParsing</a></code>, will be honored.</p> 21815bb6a25fSPoul-Henning Kamp 21825bb6a25fSPoul-Henning Kamp<p>The application-provided external subset is read by calling the 21835bb6a25fSPoul-Henning Kampexternal entity reference handler set via <code><a href= 21845bb6a25fSPoul-Henning Kamp"#XML_SetExternalEntityRefHandler" 21855bb6a25fSPoul-Henning Kamp>XML_SetExternalEntityRefHandler</a></code> with both 21865bb6a25fSPoul-Henning Kamp<code>publicId</code> and <code>systemId</code> set to NULL.</p> 21875bb6a25fSPoul-Henning Kamp 21885bb6a25fSPoul-Henning Kamp<p>If this function is called after parsing has begun, it returns 21895bb6a25fSPoul-Henning Kamp<code>XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING</code> and ignores 21905bb6a25fSPoul-Henning Kamp<code>useDTD</code>. If called when Expat has been compiled without 21915bb6a25fSPoul-Henning KampDTD support, it returns 21925bb6a25fSPoul-Henning Kamp<code>XML_ERROR_FEATURE_REQUIRES_XML_DTD</code>. Otherwise, it 21935bb6a25fSPoul-Henning Kampreturns <code>XML_ERROR_NONE</code>.</p> 2194220ed979SColeman Kane 2195220ed979SColeman Kane<p><b>Note:</b> For the purpose of checking WFC: Entity Declared, passing 2196220ed979SColeman Kane<code>useDTD == XML_TRUE</code> will make the parser behave as if 2197220ed979SColeman Kanethe document had a DTD with an external subset. This holds true even if 2198220ed979SColeman Kanethe external entity reference handler returns without action.</p> 21995bb6a25fSPoul-Henning Kamp</div> 22005bb6a25fSPoul-Henning Kamp 22015bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_SetReturnNSTriplet"> 2202220ed979SColeman Kanevoid XMLCALL 22035bb6a25fSPoul-Henning KampXML_SetReturnNSTriplet(XML_Parser parser, 22045bb6a25fSPoul-Henning Kamp int do_nst); 22055bb6a25fSPoul-Henning Kamp</pre> 22065bb6a25fSPoul-Henning Kamp<div class="fcndef"> 22075bb6a25fSPoul-Henning Kamp<p> 22085bb6a25fSPoul-Henning KampThis function only has an effect when using a parser created with 22095bb6a25fSPoul-Henning Kamp<code><a href= "#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>, 22105bb6a25fSPoul-Henning Kampi.e. when namespace processing is in effect. The <code>do_nst</code> 22115bb6a25fSPoul-Henning Kampsets whether or not prefixes are returned with names qualified with a 22125bb6a25fSPoul-Henning Kampnamespace prefix. If this function is called with <code>do_nst</code> 22135bb6a25fSPoul-Henning Kampnon-zero, then afterwards namespace qualified names (that is qualified 22145bb6a25fSPoul-Henning Kampwith a prefix as opposed to belonging to a default namespace) are 22155bb6a25fSPoul-Henning Kampreturned as a triplet with the three parts separated by the namespace 22165bb6a25fSPoul-Henning Kampseparator specified when the parser was created. The order of 22175bb6a25fSPoul-Henning Kampreturned parts is URI, local name, and prefix.</p> <p>If 22185bb6a25fSPoul-Henning Kamp<code>do_nst</code> is zero, then namespaces are reported in the 22195bb6a25fSPoul-Henning Kampdefault manner, URI then local_name separated by the namespace 22205bb6a25fSPoul-Henning Kampseparator.</p> 22215bb6a25fSPoul-Henning Kamp</div> 22225bb6a25fSPoul-Henning Kamp 22235bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_DefaultCurrent"> 2224220ed979SColeman Kanevoid XMLCALL 22255bb6a25fSPoul-Henning KampXML_DefaultCurrent(XML_Parser parser); 22265bb6a25fSPoul-Henning Kamp</pre> 22275bb6a25fSPoul-Henning Kamp<div class="fcndef"> 22285bb6a25fSPoul-Henning KampThis can be called within a handler for a start element, end element, 22295bb6a25fSPoul-Henning Kampprocessing instruction or character data. It causes the corresponding 22305bb6a25fSPoul-Henning Kampmarkup to be passed to the default handler set by <code><a 22315bb6a25fSPoul-Henning Kamphref="#XML_SetDefaultHandler" >XML_SetDefaultHandler</a></code> or 22325bb6a25fSPoul-Henning Kamp<code><a href="#XML_SetDefaultHandlerExpand" 22335bb6a25fSPoul-Henning Kamp>XML_SetDefaultHandlerExpand</a></code>. It does nothing if there is 22345bb6a25fSPoul-Henning Kampnot a default handler. 22355bb6a25fSPoul-Henning Kamp</div> 22365bb6a25fSPoul-Henning Kamp 22375bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ExpatVersion"> 2238220ed979SColeman KaneXML_LChar * XMLCALL 22395bb6a25fSPoul-Henning KampXML_ExpatVersion(); 22405bb6a25fSPoul-Henning Kamp</pre> 22415bb6a25fSPoul-Henning Kamp<div class="fcndef"> 22425bb6a25fSPoul-Henning KampReturn the library version as a string (e.g. <code>"expat_1.95.1"</code>). 22435bb6a25fSPoul-Henning Kamp</div> 22445bb6a25fSPoul-Henning Kamp 22455bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_ExpatVersionInfo"> 2246220ed979SColeman Kanestruct XML_Expat_Version XMLCALL 22475bb6a25fSPoul-Henning KampXML_ExpatVersionInfo(); 22485bb6a25fSPoul-Henning Kamp</pre> 22495bb6a25fSPoul-Henning Kamp<pre class="signature"> 22505bb6a25fSPoul-Henning Kamptypedef struct { 22515bb6a25fSPoul-Henning Kamp int major; 22525bb6a25fSPoul-Henning Kamp int minor; 22535bb6a25fSPoul-Henning Kamp int micro; 22545bb6a25fSPoul-Henning Kamp} XML_Expat_Version; 22555bb6a25fSPoul-Henning Kamp</pre> 22565bb6a25fSPoul-Henning Kamp<div class="fcndef"> 22575bb6a25fSPoul-Henning KampReturn the library version information as a structure. 22585bb6a25fSPoul-Henning KampSome macros are also defined that support compile-time tests of the 22595bb6a25fSPoul-Henning Kamplibrary version: 22605bb6a25fSPoul-Henning Kamp<ul> 22615bb6a25fSPoul-Henning Kamp<li><code>XML_MAJOR_VERSION</code></li> 22625bb6a25fSPoul-Henning Kamp<li><code>XML_MINOR_VERSION</code></li> 22635bb6a25fSPoul-Henning Kamp<li><code>XML_MICRO_VERSION</code></li> 22645bb6a25fSPoul-Henning Kamp</ul> 22655bb6a25fSPoul-Henning KampTesting these constants is currently the best way to determine if 22665bb6a25fSPoul-Henning Kampparticular parts of the Expat API are available. 22675bb6a25fSPoul-Henning Kamp</div> 22685bb6a25fSPoul-Henning Kamp 22695bb6a25fSPoul-Henning Kamp<pre class="fcndec" id="XML_GetFeatureList"> 2270220ed979SColeman Kaneconst XML_Feature * XMLCALL 22715bb6a25fSPoul-Henning KampXML_GetFeatureList(); 22725bb6a25fSPoul-Henning Kamp</pre> 22735bb6a25fSPoul-Henning Kamp<pre class="signature"> 22745bb6a25fSPoul-Henning Kampenum XML_FeatureEnum { 22755bb6a25fSPoul-Henning Kamp XML_FEATURE_END = 0, 22765bb6a25fSPoul-Henning Kamp XML_FEATURE_UNICODE, 22775bb6a25fSPoul-Henning Kamp XML_FEATURE_UNICODE_WCHAR_T, 22785bb6a25fSPoul-Henning Kamp XML_FEATURE_DTD, 22795bb6a25fSPoul-Henning Kamp XML_FEATURE_CONTEXT_BYTES, 22805bb6a25fSPoul-Henning Kamp XML_FEATURE_MIN_SIZE, 22815bb6a25fSPoul-Henning Kamp XML_FEATURE_SIZEOF_XML_CHAR, 2282220ed979SColeman Kane XML_FEATURE_SIZEOF_XML_LCHAR, 2283220ed979SColeman Kane XML_FEATURE_NS, 2284220ed979SColeman Kane XML_FEATURE_LARGE_SIZE 22855bb6a25fSPoul-Henning Kamp}; 22865bb6a25fSPoul-Henning Kamp 22875bb6a25fSPoul-Henning Kamptypedef struct { 22885bb6a25fSPoul-Henning Kamp enum XML_FeatureEnum feature; 22895bb6a25fSPoul-Henning Kamp XML_LChar *name; 22905bb6a25fSPoul-Henning Kamp long int value; 22915bb6a25fSPoul-Henning Kamp} XML_Feature; 22925bb6a25fSPoul-Henning Kamp</pre> 22935bb6a25fSPoul-Henning Kamp<div class="fcndef"> 22945bb6a25fSPoul-Henning Kamp<p>Returns a list of "feature" records, providing details on how 22955bb6a25fSPoul-Henning KampExpat was configured at compile time. Most applications should not 22965bb6a25fSPoul-Henning Kampneed to worry about this, but this information is otherwise not 22975bb6a25fSPoul-Henning Kampavailable from Expat. This function allows code that does need to 22985bb6a25fSPoul-Henning Kampcheck these features to do so at runtime.</p> 22995bb6a25fSPoul-Henning Kamp 23005bb6a25fSPoul-Henning Kamp<p>The return value is an array of <code>XML_Feature</code>, 23015bb6a25fSPoul-Henning Kampterminated by a record with a <code>feature</code> of 23025bb6a25fSPoul-Henning Kamp<code>XML_FEATURE_END</code> and <code>name</code> of NULL, 23035bb6a25fSPoul-Henning Kampidentifying the feature-test macros Expat was compiled with. Since an 23045bb6a25fSPoul-Henning Kampapplication that requires this kind of information needs to determine 23055bb6a25fSPoul-Henning Kampthe type of character the <code>name</code> points to, records for the 23065bb6a25fSPoul-Henning Kamp<code>XML_FEATURE_SIZEOF_XML_CHAR</code> and 23075bb6a25fSPoul-Henning Kamp<code>XML_FEATURE_SIZEOF_XML_LCHAR</code> will be located at the 23085bb6a25fSPoul-Henning Kampbeginning of the list, followed by <code>XML_FEATURE_UNICODE</code> 23095bb6a25fSPoul-Henning Kampand <code>XML_FEATURE_UNICODE_WCHAR_T</code>, if they are present at 23105bb6a25fSPoul-Henning Kampall.</p> 23115bb6a25fSPoul-Henning Kamp 23125bb6a25fSPoul-Henning Kamp<p>Some features have an associated value. If there isn't an 23135bb6a25fSPoul-Henning Kampassociated value, the <code>value</code> field is set to 0. At this 23145bb6a25fSPoul-Henning Kamptime, the following features have been defined to have values:</p> 23155bb6a25fSPoul-Henning Kamp 23165bb6a25fSPoul-Henning Kamp<dl> 23175bb6a25fSPoul-Henning Kamp <dt><code>XML_FEATURE_SIZEOF_XML_CHAR</code></dt> 23185bb6a25fSPoul-Henning Kamp <dd>The number of bytes occupied by one <code>XML_Char</code> 23195bb6a25fSPoul-Henning Kamp character.</dd> 23205bb6a25fSPoul-Henning Kamp <dt><code>XML_FEATURE_SIZEOF_XML_LCHAR</code></dt> 23215bb6a25fSPoul-Henning Kamp <dd>The number of bytes occupied by one <code>XML_LChar</code> 23225bb6a25fSPoul-Henning Kamp character.</dd> 23235bb6a25fSPoul-Henning Kamp <dt><code>XML_FEATURE_CONTEXT_BYTES</code></dt> 23245bb6a25fSPoul-Henning Kamp <dd>The maximum number of characters of context which can be 23255bb6a25fSPoul-Henning Kamp reported by <code><a href= "#XML_GetInputContext" 23265bb6a25fSPoul-Henning Kamp >XML_GetInputContext</a></code>.</dd> 23275bb6a25fSPoul-Henning Kamp</dl> 23285bb6a25fSPoul-Henning Kamp</div> 23295bb6a25fSPoul-Henning Kamp 2330220ed979SColeman Kane<pre class="fcndec" id="XML_FreeContentModel"> 2331220ed979SColeman Kanevoid XMLCALL 2332220ed979SColeman KaneXML_FreeContentModel(XML_Parser parser, XML_Content *model); 2333220ed979SColeman Kane</pre> 2334220ed979SColeman Kane<div class="fcndef"> 2335220ed979SColeman KaneFunction to deallocate the <code>model</code> argument passed to the 2336220ed979SColeman Kane<code>XML_ElementDeclHandler</code> callback set using <code><a 2337220ed979SColeman Kanehref="#XML_SetElementDeclHandler" >XML_ElementDeclHandler</a></code>. 2338220ed979SColeman KaneThis function should not be used for any other purpose. 2339220ed979SColeman Kane</div> 2340220ed979SColeman Kane 2341220ed979SColeman Kane<p>The following functions allow external code to share the memory 2342220ed979SColeman Kaneallocator an <code>XML_Parser</code> has been configured to use. This 2343220ed979SColeman Kaneis especially useful for third-party libraries that interact with a 2344220ed979SColeman Kaneparser object created by application code, or heavily layered 2345220ed979SColeman Kaneapplications. This can be essential when using dynamically loaded 2346220ed979SColeman Kanelibraries which use different C standard libraries (this can happen on 2347220ed979SColeman KaneWindows, at least).</p> 2348220ed979SColeman Kane 2349220ed979SColeman Kane<pre class="fcndec" id="XML_MemMalloc"> 2350220ed979SColeman Kanevoid * XMLCALL 2351220ed979SColeman KaneXML_MemMalloc(XML_Parser parser, size_t size); 2352220ed979SColeman Kane</pre> 2353220ed979SColeman Kane<div class="fcndef"> 2354220ed979SColeman KaneAllocate <code>size</code> bytes of memory using the allocator the 2355220ed979SColeman Kane<code>parser</code> object has been configured to use. Returns a 2356220ed979SColeman Kanepointer to the memory or NULL on failure. Memory allocated in this 2357220ed979SColeman Kaneway must be freed using <code><a href="#XML_MemFree" 2358220ed979SColeman Kane>XML_MemFree</a></code>. 2359220ed979SColeman Kane</div> 2360220ed979SColeman Kane 2361220ed979SColeman Kane<pre class="fcndec" id="XML_MemRealloc"> 2362220ed979SColeman Kanevoid * XMLCALL 2363220ed979SColeman KaneXML_MemRealloc(XML_Parser parser, void *ptr, size_t size); 2364220ed979SColeman Kane</pre> 2365220ed979SColeman Kane<div class="fcndef"> 2366220ed979SColeman KaneAllocate <code>size</code> bytes of memory using the allocator the 2367220ed979SColeman Kane<code>parser</code> object has been configured to use. 2368220ed979SColeman Kane<code>ptr</code> must point to a block of memory allocated by <code><a 2369220ed979SColeman Kanehref="#XML_MemMalloc" >XML_MemMalloc</a></code> or 2370220ed979SColeman Kane<code>XML_MemRealloc</code>, or be NULL. This function tries to 2371220ed979SColeman Kaneexpand the block pointed to by <code>ptr</code> if possible. Returns 2372220ed979SColeman Kanea pointer to the memory or NULL on failure. On success, the original 2373220ed979SColeman Kaneblock has either been expanded or freed. On failure, the original 2374220ed979SColeman Kaneblock has not been freed; the caller is responsible for freeing the 2375220ed979SColeman Kaneoriginal block. Memory allocated in this way must be freed using 2376220ed979SColeman Kane<code><a href="#XML_MemFree" 2377220ed979SColeman Kane>XML_MemFree</a></code>. 2378220ed979SColeman Kane</div> 2379220ed979SColeman Kane 2380220ed979SColeman Kane<pre class="fcndec" id="XML_MemFree"> 2381220ed979SColeman Kanevoid XMLCALL 2382220ed979SColeman KaneXML_MemFree(XML_Parser parser, void *ptr); 2383220ed979SColeman Kane</pre> 2384220ed979SColeman Kane<div class="fcndef"> 2385220ed979SColeman KaneFree a block of memory pointed to by <code>ptr</code>. The block must 2386220ed979SColeman Kanehave been allocated by <code><a href="#XML_MemMalloc" 2387220ed979SColeman Kane>XML_MemMalloc</a></code> or <code>XML_MemRealloc</code>, or be NULL. 2388220ed979SColeman Kane</div> 2389220ed979SColeman Kane 23905bb6a25fSPoul-Henning Kamp<hr /> 23915bb6a25fSPoul-Henning Kamp<p><a href="http://validator.w3.org/check/referer"><img 23925bb6a25fSPoul-Henning Kamp src="valid-xhtml10.png" alt="Valid XHTML 1.0!" 23935bb6a25fSPoul-Henning Kamp height="31" width="88" class="noborder" /></a></p> 2394220ed979SColeman Kane</div> 23955bb6a25fSPoul-Henning Kamp</body> 23965bb6a25fSPoul-Henning Kamp</html> 2397
