diff options
Diffstat (limited to 'contrib/expat/doc/reference.html')
| -rw-r--r-- | contrib/expat/doc/reference.html | 977 |
1 files changed, 774 insertions, 203 deletions
diff --git a/contrib/expat/doc/reference.html b/contrib/expat/doc/reference.html index fda752f8e17a..a315870dd7cf 100644 --- a/contrib/expat/doc/reference.html +++ b/contrib/expat/doc/reference.html @@ -13,7 +13,17 @@ <link href="style.css" rel="stylesheet" type="text/css" /> </head> <body> -<h1>Expat XML Parser</h1> + <table cellspacing="0" cellpadding="0" width="100%"> + <tr> + <td class="corner"><img src="expat.png" alt="(Expat logo)" /></td> + <td class="banner"><h1>The Expat XML Parser</h1></td> + </tr> + <tr> + <td class="releaseno">Release 2.0.1</td> + <td></td> + </tr> + </table> +<div class="content"> <p>Expat is a library, written in C, for parsing XML documents. It's the underlying XML parser for the open source Mozilla project, Perl's @@ -31,9 +41,13 @@ href="../COPYING">MIT/X Consortium license</a>. You may download it from <a href="http://www.libexpat.org/">the Expat home page</a>. </p> -<p>The bulk of this document was originally commissioned as an article by -<a href="http://www.xml.com/">XML.com</a>. They graciously allowed -Clark Cooper to retain copyright and to distribute it with Expat.</p> +<p>The bulk of this document was originally commissioned as an article +by <a href="http://www.xml.com/">XML.com</a>. They graciously allowed +Clark Cooper to retain copyright and to distribute it with Expat. +This version has been substantially extended to include documentation +on features which have been added since the original article was +published, and additional information on using the original +interface.</p> <hr /> <h2>Table of Contents</h2> @@ -58,6 +72,9 @@ Clark Cooper to retain copyright and to distribute it with Expat.</p> <li><a href="#XML_Parse">XML_Parse</a></li> <li><a href="#XML_ParseBuffer">XML_ParseBuffer</a></li> <li><a href="#XML_GetBuffer">XML_GetBuffer</a></li> + <li><a href="#XML_StopParser">XML_StopParser</a></li> + <li><a href="#XML_ResumeParser">XML_ResumeParser</a></li> + <li><a href="#XML_GetParsingStatus">XML_GetParsingStatus</a></li> </ul> </li> <li><a href="#setting">Handler Setting Functions</a> @@ -74,6 +91,7 @@ Clark Cooper to retain copyright and to distribute it with Expat.</p> <li><a href="#XML_SetDefaultHandler">XML_SetDefaultHandler</a></li> <li><a href="#XML_SetDefaultHandlerExpand">XML_SetDefaultHandlerExpand</a></li> <li><a href="#XML_SetExternalEntityRefHandler">XML_SetExternalEntityRefHandler</a></li> + <li><a href="#XML_SetExternalEntityRefHandlerArg">XML_SetExternalEntityRefHandlerArg</a></li> <li><a href="#XML_SetSkippedEntityHandler">XML_SetSkippedEntityHandler</a></li> <li><a href="#XML_SetUnknownEncodingHandler">XML_SetUnknownEncodingHandler</a></li> <li><a href="#XML_SetStartNamespaceDeclHandler">XML_SetStartNamespaceDeclHandler</a></li> @@ -119,6 +137,10 @@ Clark Cooper to retain copyright and to distribute it with Expat.</p> <li><a href="#XML_ExpatVersion">XML_ExpatVersion</a></li> <li><a href="#XML_ExpatVersionInfo">XML_ExpatVersionInfo</a></li> <li><a href="#XML_GetFeatureList">XML_GetFeatureList</a></li> + <li><a href="#XML_FreeContentModel">XML_FreeContentModel</a></li> + <li><a href="#XML_MemMalloc">XML_MemMalloc</a></li> + <li><a href="#XML_MemRealloc">XML_MemRealloc</a></li> + <li><a href="#XML_MemFree">XML_MemFree</a></li> </ul> </li> </ul> @@ -177,7 +199,7 @@ variable.</p> <pre class="eg"> int Depth; -void +void XMLCALL start(void *data, const char *el, const char **attr) { int i; @@ -198,12 +220,44 @@ start(void *data, const char *el, const char **attr) { <p>The end tag simply does the bookkeeping work of decrementing <code>Depth</code>.</p> <pre class="eg"> -void +void XMLCALL end(void *data, const char *el) { Depth--; } /* End of end handler */ </pre> +<p>Note the <code>XMLCALL</code> annotation used for the callbacks. +This is used to ensure that the Expat and the callbacks are using the +same calling convention in case the compiler options used for Expat +itself and the client code are different. Expat tries not to care +what the default calling convention is, though it may require that it +be compiled with a default convention of "cdecl" on some platforms. +For code which uses Expat, however, the calling convention is +specified by the <code>XMLCALL</code> annotation on most platforms; +callbacks should be defined using this annotation.</p> + +<p>The <code>XMLCALL</code> annotation was added in Expat 1.95.7, but +existing working Expat applications don't need to add it (since they +are already using the "cdecl" calling convention, or they wouldn't be +working). The annotation is only needed if the default calling +convention may be something other than "cdecl". To use the annotation +safely with older versions of Expat, you can conditionally define it +<em>after</em> including Expat's header file:</p> + +<pre class="eg"> +#include <expat.h> + +#ifndef XMLCALL +#if defined(_MSC_EXTENSIONS) && !defined(__BEOS__) && !defined(__CYGWIN__) +#define XMLCALL __cdecl +#elif defined(__GNUC__) +#define XMLCALL __attribute__((cdecl)) +#else +#define XMLCALL +#endif +#endif +</pre> + <p>After creating the parser, the main program just has the job of shoveling the document to the parser so that it can do its work.</p> @@ -237,9 +291,9 @@ and you have permission on your system to install into /usr/local, you can install Expat with this sequence of commands:</p> <pre class="eg"> - ./configure - make - make install +./configure +make +make install </pre> <p>There are some options that you can provide to this script, but the @@ -255,6 +309,68 @@ library and header would get installed in <code>/home/me/mystuff/lib</code> and <code>/home/me/mystuff/include</code> respectively.</p> +<h3>Configuring Expat Using the Pre-Processor</h3> + +<p>Expat's feature set can be configured using a small number of +pre-processor definitions. The definition of this symbols does not +affect the set of entry points for Expat, only the behavior of the API +and the definition of character types in the case of +<code>XML_UNICODE_WCHAR_T</code>. The symbols are:</p> + +<dl class="cpp-symbols"> +<dt>XML_DTD</dt> +<dd>Include support for using and reporting DTD-based content. If +this is defined, default attribute values from an external DTD subset +are reported and attribute value normalization occurs based on the +type of attributes defined in the external subset. Without +this, Expat has a smaller memory footprint and can be faster, but will +not load external entities or process conditional sections. This does +not affect the set of functions available in the API.</dd> + +<dt>XML_NS</dt> +<dd>When defined, support for the <cite><a href= +"http://www.w3.org/TR/REC-xml-names/" >Namespaces in XML</a></cite> +specification is included.</dd> + +<dt>XML_UNICODE</dt> +<dd>When defined, character data reported to the application is +encoded in UTF-16 using wide characters of the type +<code>XML_Char</code>. This is implied if +<code>XML_UNICODE_WCHAR_T</code> is defined.</dd> + +<dt>XML_UNICODE_WCHAR_T</dt> +<dd>If defined, causes the <code>XML_Char</code> character type to be +defined using the <code>wchar_t</code> type; otherwise, <code>unsigned +short</code> is used. Defining this implies +<code>XML_UNICODE</code>.</dd> + +<dt>XML_LARGE_SIZE</dt> +<dd>If defined, causes the <code>XML_Size</code> and <code>XML_Index</code> +integer types to be at least 64 bits in size. This is intended to support +processing of very large input streams, where the return values of +<code><a href="#XML_GetCurrentByteIndex" >XML_GetCurrentByteIndex</a></code>, +<code><a href="#XML_GetCurrentLineNumber" >XML_GetCurrentLineNumber</a></code> and +<code><a href="#XML_GetCurrentColumnNumber" >XML_GetCurrentColumnNumber</a></code> +could overflow. It may not be supported by all compilers, and is turned +off by default.</dd> + +<dt>XML_CONTEXT_BYTES</dt> +<dd>The number of input bytes of markup context which the parser will +ensure are available for reporting via <code><a href= +"#XML_GetInputContext" >XML_GetInputContext</a></code>. This is +normally set to 1024, and must be set to a positive interger. If this +is not defined, the input context will not be available and <code><a +href= "#XML_GetInputContext" >XML_GetInputContext</a></code> will +always report NULL. Without this, Expat has a smaller memory +footprint and can be faster.</dd> + +<dt>XML_STATIC</dt> +<dd>On Windows, this should be set if Expat is going to be linked +statically with the code that calls it; this is required to get all +the right MSVC magic annotations correct. This is ignored on other +platforms.</dd> +</dl> + <hr /> <h2><a name="using">Using Expat</a></h2> @@ -268,7 +384,7 @@ needs to link against the Expat library. On Unix systems, this would usually be done with the <code>-lexpat</code> argument. Otherwise, you'll need to tell the compiler where to look for the Expat header and the linker where to find the Expat library. You may also need to -take steps to tell the operating system where to find this libary at +take steps to tell the operating system where to find this library at run time.</p> <p>On a Unix-based system, here's what a Makefile might look like when @@ -313,7 +429,7 @@ by these functions is an opaque pointer (i.e. "expat.h" declares it as void *) to data with further internal structure. In order to free the memory associated with this object you must call <code><a href= "#XML_ParserFree" >XML_ParserFree</a></code>. Note that if you have -provided any <a href="userdata">user data</a> that gets stored in the +provided any <a href="#userdata">user data</a> that gets stored in the parser, then your application is responsible for freeing it prior to calling <code>XML_ParserFree</code>.</p> @@ -355,7 +471,7 @@ init_info(Parseinfo *info) { /* Other initializations here */ } /* End of init_info */ -void +void XMLCALL rawstart(void *data, const char *el, const char **attr) { Parseinfo *inf = (Parseinfo *) data; @@ -370,7 +486,7 @@ rawstart(void *data, const char *el, const char **attr) { inf->depth++; } /* End of rawstart */ -void +void XMLCALL rawend(void *data, const char *el) { Parseinfo *inf = (Parseinfo *) data; @@ -400,8 +516,31 @@ handler.</p> without using globals, you'll need to define a data structure to hold the shared variables. You can then tell Expat (with the <code><a href= "#XML_SetUserData" >XML_SetUserData</a></code> function) to pass a -pointer to this structure to the handlers. This is typically the first -argument received by most handlers.</p> +pointer to this structure to the handlers. This is the first +argument received by most handlers. In the <a href="#reference" +>reference section</a>, an argument to a callback function is named +<code>userData</code> and have type <code>void *</code> if the user +data is passed; it will have the type <code>XML_Parser</code> if the +parser itself is passed. When the parser is passed, the user data may +be retrieved using <code><a href="#XML_GetUserData" +>XML_GetUserData</a></code>.</p> + +<p>One common case where multiple calls to a single handler may need +to communicate using an application data structure is the case when +content passed to the character data handler (set by <code><a href= +"#XML_SetCharacterDataHandler" +>XML_SetCharacterDataHandler</a></code>) needs to be accumulated. A +common first-time mistake with any of the event-oriented interfaces to +an XML parser is to expect all the text contained in an element to be +reported by a single call to the character data handler. Expat, like +many other XML parsers, reports such data as a sequence of calls; +there's no way to know when the end of the sequence is reached until a +different callback is made. A buffer referenced by the user data +structure proves both an effective and convenient place to accumulate +character data.</p> + +<!-- XXX example needed here --> + <h3>XML Version</h3> @@ -420,7 +559,7 @@ version number of <code>"1.0"</code> is accepted:</p> static int wrong_version; static XML_Parser parser; -static void +static void XMLCALL xmldecl_handler(void *userData, const XML_Char *version, const XML_Char *encoding, @@ -462,12 +601,12 @@ this expanded form is a concatenation of the namespace URI, the separator character (which is the 2nd argument to <code><a href= "#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>), and the local name (i.e. the part after the colon). Names with undeclared prefixes -are passed through to the handlers unchanged, with the prefix and -colon still attached. Unprefixed attribute names are never expanded, +are not well-formed when namespace processing is enabled, and will +trigger an error. Unprefixed attribute names are never expanded, and unprefixed element names are only expanded when they are in the scope of a default namespace.</p> -<p>However if <code><a href= "XML_SetReturnNSTriplet" +<p>However if <code><a href= "#XML_SetReturnNSTriplet" >XML_SetReturnNSTriplet</a></code> has been called with a non-zero <code>do_nst</code> parameter, then the expanded form for names with an explicit prefix is a concatenation of: URI, separator, local name, @@ -477,7 +616,7 @@ separator, prefix.</p> for the end of a scope of a declaration with the <code><a href= "#XML_SetNamespaceDeclHandler" >XML_SetNamespaceDeclHandler</a></code> function. The StartNamespaceDeclHandler is called prior to the start -tag handler and the EndNamespaceDeclHandler is called before the +tag handler and the EndNamespaceDeclHandler is called after the corresponding end tag that ends the namespace's scope. The namespace start handler gets passed the prefix and URI for the namespace. For a default namespace declaration (xmlns='...'), the prefix will be null. @@ -525,11 +664,12 @@ in Expat:</p> protocol encoding specified in the parser constructor, triggers a call to the <code>UnknownEncodingHandler</code>. This handler gets passed the encoding name and a pointer to an <code>XML_Encoding</code> data -structure. Your handler must fill in this structure and return 1 if it -knows how to deal with the encoding. Otherwise the handler should -return 0. The handler also gets passed a pointer to an optional -application data structure that you may indicate when you set the -handler.</p> +structure. Your handler must fill in this structure and return +<code>XML_STATUS_OK</code> if it knows how to deal with the +encoding. Otherwise the handler should return +<code>XML_STATUS_ERROR</code>. The handler also gets passed a pointer +to an optional application data structure that you may indicate when +you set the handler.</p> <p>Expat places restrictions on character encodings that it can support by filling in the <code>XML_Encoding</code> structure. @@ -601,6 +741,149 @@ arguments:</p> <p>In order to read an external DTD, you also have to set an external entity reference handler as described above.</p> +<h3 id="stop-resume">Temporarily Stopping Parsing</h3> + +<p>Expat 1.95.8 introduces a new feature: its now possible to stop +parsing temporarily from within a handler function, even if more data +has already been passed into the parser. Applications for this +include</p> + +<ul> + <li>Supporting the <a href= "http://www.w3.org/TR/xinclude/" + >XInclude</a> specification.</li> + + <li>Delaying further processing until additional information is + available from some other source.</li> + + <li>Adjusting processor load as task priorities shift within an + application.</li> + + <li>Stopping parsing completely (simply free or reset the parser + instead of resuming in the outer parsing loop). This can be useful + if a application-domain error is found in the XML being parsed or if + the result of the parse is determined not to be useful after + all.</li> +</ul> + +<p>To take advantage of this feature, the main parsing loop of an +application needs to support this specifically. It cannot be +supported with a parsing loop compatible with Expat 1.95.7 or +earlier (though existing loops will continue to work without +supporting the stop/resume feature).</p> + +<p>An application that uses this feature for a single parser will have +the rough structure (in pseudo-code):</p> + +<pre class="pseudocode"> +fd = open_input() +p = create_parser() + +if parse_xml(p, fd) { + /* suspended */ + + int suspended = 1; + + while (suspended) { + do_something_else() + if ready_to_resume() { + suspended = continue_parsing(p, fd); + } + } +} +</pre> + +<p>An application that may resume any of several parsers based on +input (either from the XML being parsed or some other source) will +certainly have more interesting control structures.</p> + +<p>This C function could be used for the <code>parse_xml</code> +function mentioned in the pseudo-code above:</p> + +<pre class="eg"> +#define BUFF_SIZE 10240 + +/* Parse a document from the open file descriptor 'fd' until the parse + is complete (the document has been completely parsed, or there's + been an error), or the parse is stopped. Return non-zero when + the parse is merely suspended. +*/ +int +parse_xml(XML_Parser p, int fd) +{ + for (;;) { + int last_chunk; + int bytes_read; + enum XML_Status status; + + void *buff = XML_GetBuffer(p, BUFF_SIZE); + if (buff == NULL) { + /* handle error... */ + return 0; + } + bytes_read = read(fd, buff, BUFF_SIZE); + if (bytes_read < 0) { + /* handle error... */ + return 0; + } + status = XML_ParseBuffer(p, bytes_read, bytes_read == 0); + switch (status) { + case XML_STATUS_ERROR: + /* handle error... */ + return 0; + case XML_STATUS_SUSPENDED: + return 1; + } + if (bytes_read == 0) + return 0; + } +} +</pre> + +<p>The corresponding <code>continue_parsing</code> function is +somewhat simpler, since it only need deal with the return code from +<code><a href= "#XML_ResumeParser">XML_ResumeParser</a></code>; it can +delegate the input handling to the <code>parse_xml</code> +function:</p> + +<pre class="eg"> +/* Continue parsing a document which had been suspended. The 'p' and + 'fd' arguments are the same as passed to parse_xml(). Return + non-zero when the parse is suspended. +*/ +int +continue_parsing(XML_Parser p, int fd) +{ + enum XML_Status status = XML_ResumeParser(p); + switch (status) { + case XML_STATUS_ERROR: + /* handle error... */ + return 0; + case XML_ERROR_NOT_SUSPENDED: + /* handle error... */ + return 0;. + case XML_STATUS_SUSPENDED: + return 1; + } + return parse_xml(p, fd); +} +</pre> + +<p>Now that we've seen what a mess the top-level parsing loop can +become, what have we gained? Very simply, we can now use the <code><a +href= "#XML_StopParser" >XML_StopParser</a></code> function to stop +parsing, without having to go to great lengths to avoid additional +processing that we're expecting to ignore. As a bonus, we get to stop +parsing <em>temporarily</em>, and come back to it when we're +ready.</p> + +<p>To stop parsing from a handler function, use the <code><a href= +"#XML_StopParser" >XML_StopParser</a></code> function. This function +takes two arguments; the parser being stopped and a flag indicating +whether the parse can be resumed in the future.</p> + +<!-- XXX really need more here --> + + <hr /> <!-- ================================================================ --> @@ -609,7 +892,7 @@ entity reference handler as described above.</p> <h3><a name="creation">Parser Creation</a></h3> <pre class="fcndec" id="XML_ParserCreate"> -XML_Parser +XML_Parser XMLCALL XML_ParserCreate(const XML_Char *encoding); </pre> <div class="fcndef"> @@ -626,7 +909,7 @@ Any other value will invoke a call to the UnknownEncodingHandler. </div> <pre class="fcndec" id="XML_ParserCreateNS"> -XML_Parser +XML_Parser XMLCALL XML_ParserCreateNS(const XML_Char *encoding, XML_Char sep); </pre> @@ -635,19 +918,23 @@ Constructs a new parser that has namespace processing in effect. Namespace expanded element names and attribute names are returned as a concatenation of the namespace URI, <em>sep</em>, and the local part of the name. This means that you should pick a character for <em>sep</em> that can't be -part of a legal URI.</div> +part of a legal URI. There is a special case when <em>sep</em> is the null +character <code>'\0'</code>: the namespace URI and the local part will be +concatenated without any separator - this is intended to support RDF processors. +It is a programming error to use the null separator with +<a href= "#XML_SetReturnNSTriplet">namespace triplets</a>.</div> <pre class="fcndec" id="XML_ParserCreate_MM"> -XML_Parser +XML_Parser XMLCALL XML_ParserCreate_MM(const XML_Char *encoding, const XML_Memory_Handling_Suite *ms, const XML_Char *sep); </pre> <pre class="signature"> typedef struct { - void *(*malloc_fcn)(size_t size); - void *(*realloc_fcn)(void *ptr, size_t size); - void (*free_fcn)(void *ptr); + void *(XMLCALL *malloc_fcn)(size_t size); + void *(XMLCALL *realloc_fcn)(void *ptr, size_t size); + void (XMLCALL *free_fcn)(void *ptr); } XML_Memory_Handling_Suite; </pre> <div class="fcndef"> @@ -660,7 +947,7 @@ the namespace URI and the local part of the name.</p> </div> <pre class="fcndec" id="XML_ExternalEntityParserCreate"> -XML_Parser +XML_Parser XMLCALL XML_ExternalEntityParserCreate(XML_Parser p, const XML_Char *context, const XML_Char *encoding); @@ -676,7 +963,7 @@ differently than the parent parser). </div> <pre class="fcndec" id="XML_ParserFree"> -void +void XMLCALL XML_ParserFree(XML_Parser p); </pre> <div class="fcndef"> @@ -685,14 +972,17 @@ freeing any memory associated with <a href="#userdata">user data</a>. </div> <pre class="fcndec" id="XML_ParserReset"> -XML_Bool -XML_ParserReset(XML_Parser p); +XML_Bool XMLCALL +XML_ParserReset(XML_Parser p, + const XML_Char *encoding); </pre> <div class="fcndef"> Clean up the memory structures maintained by the parser so that it may be used again. After this has been called, <code>parser</code> is -ready to start parsing a new document. This function may not be used -on a parser created using <code><a href= +ready to start parsing a new document. All handlers are cleared from +the parser, except for the unknownEncodingHandler. The parser's external +state is re-initialized except for the values of ns and ns_triplets. +This function may not be used on a parser created using <code><a href= "#XML_ExternalEntityParserCreate" >XML_ExternalEntityParserCreate</a ></code>; it will return <code>XML_FALSE</code> in that case. Returns <code>XML_TRUE</code> on success. Your application is responsible for @@ -702,18 +992,26 @@ dealing with any memory associated with <a href="#userdata">user data</a>. <h3><a name="parsing">Parsing</a></h3> <p>To state the obvious: the three parsing functions <code><a href= -"#XML_Parse" >XML_Parse</a></code>, <code><a href= "#XML_ParseBuffer" ->XML_ParseBuffer</a></code> and <code><a href= "#XML_GetBuffer" ->>XML_GetBuffer</a></code> must not be -called from within a handler unless they operate on a separate parser -instance, that is, one that did not call the handler. For example, it -is OK to call the parsing functions from within an -<code>XML_ExternalEntityRefHandler</code>, if they apply to the parser -created by <code><a href= "#XML_ExternalEntityParserCreate" +"#XML_Parse" >XML_Parse</a></code>, <code><a href= "#XML_ParseBuffer"> +XML_ParseBuffer</a></code> and <code><a href= "#XML_GetBuffer"> +XML_GetBuffer</a></code> must not be called from within a handler +unless they operate on a separate parser instance, that is, one that +did not call the handler. For example, it is OK to call the parsing +functions from within an <code>XML_ExternalEntityRefHandler</code>, +if they apply to the parser created by +<code><a href= "#XML_ExternalEntityParserCreate" >XML_ExternalEntityParserCreate</a></code>.</p> +<p>Note: the <code>len</code> argument passed to these functions +should be considerably less than the maximum value for an integer, +as it could create an integer overflow situation if the added +lengths of a buffer and the unprocessed portion of the previous buffer +exceed the maximum integer value. Input data at the end of a buffer +will remain unprocessed if it is part of an XML token for which the +end is not part of that buffer.</p> + <pre class="fcndec" id="XML_Parse"> -XML_Status +enum XML_Status XMLCALL XML_Parse(XML_Parser p, const char *s, int len, @@ -740,7 +1038,7 @@ Otherwise it returns <code>XML_STATUS_OK</code> value. </div> <pre class="fcndec" id="XML_ParseBuffer"> -XML_Status +enum XML_Status XMLCALL XML_ParseBuffer(XML_Parser p, int len, int isFinal); @@ -754,7 +1052,7 @@ copying of the input. </div> <pre class="fcndec" id="XML_GetBuffer"> -void * +void * XMLCALL XML_GetBuffer(XML_Parser p, int len); </pre> @@ -788,6 +1086,127 @@ for (;;) { </pre> </div> +<pre class="fcndec" id="XML_StopParser"> +enum XML_Status XMLCALL +XML_StopParser(XML_Parser p, + XML_Bool resumable); +</pre> +<div class="fcndef"> + +<p>Stops parsing, causing <code><a href= "#XML_Parse" +>XML_Parse</a></code> or <code><a href= "#XML_ParseBuffer" +>XML_ParseBuffer</a></code> to return. Must be called from within a +call-back handler, except when aborting (when <code>resumable</code> +is <code>XML_FALSE</code>) an already suspended parser. Some +call-backs may still follow because they would otherwise get +lost, including +<ul> + <li> the end element handler for empty elements when stopped in the + start element handler,</li> + <li> the end namespace declaration handler when stopped in the end + element handler,</li> + <li> the character data handler when stopped in the character data handler + while making multiple call-backs on a contiguous chunk of characters,</li> +</ul> +and possibly others.</p> + +<p>This can be called from most handlers, including DTD related +call-backs, except when parsing an external parameter entity and +<code>resumable</code> is <code>XML_TRUE</code>. Returns +<code>XML_STATUS_OK</code> when successful, +<code>XML_STATUS_ERROR</code> otherwise. The possible error codes +are:</p> +<dl> + <dt><code>XML_ERROR_SUSPENDED</code></dt> + <dd>when suspending an already suspended parser.</dd> + <dt><code>XML_ERROR_FINISHED</code></dt> + <dd>when the parser has already finished.</dd> + <dt><code>XML_ERROR_SUSPEND_PE</code></dt> + <dd>when suspending while parsing an external PE.</dd> +</dl> + +<p>Since the stop/resume feature requires application support in the +outer parsing loop, it is an error to call this function for a parser +not being handled appropriately; see <a href= "#stop-resume" +>Temporarily Stopping Parsing</a> for more information.</p> + +<p>When <code>resumable</code> is <code>XML_TRUE</code> then parsing +is <em>suspended</em>, that is, <code><a href= "#XML_Parse" +>XML_Parse</a></code> and <code><a href= "#XML_ParseBuffer" +>XML_ParseBuffer</a></code> return <code>XML_STATUS_SUSPENDED</code>. +Otherwise, parsing is <em>aborted</em>, that is, <code><a href= +"#XML_Parse" >XML_Parse</a></code> and <code><a href= +"#XML_ParseBuffer" >XML_ParseBuffer</a></code> return +<code>XML_STATUS_ERROR</code> with error code +<code>XML_ERROR_ABORTED</code>.</p> + +<p><strong>Note:</strong> +This will be applied to the current parser instance only, that is, if +there is a parent parser then it will continue parsing when the +external entity reference handler returns. It is up to the +implementation of that handler to call <code><a href= +"#XML_StopParser" >XML_StopParser</a></code> on the parent parser +(recursively), if one wants to stop parsing altogether.</p> + +<p>When suspended, parsing can be resumed by calling <code><a href= +"#XML_ResumeParser" >XML_ResumeParser</a></code>.</p> + +<p>New in Expat 1.95.8.</p> +</div> + +<pre class="fcndec" id="XML_ResumeParser"> +enum XML_Status XMLCALL +XML_ResumeParser(XML_Parser p); +</pre> +<div class="fcndef"> +<p>Resumes parsing after it has been suspended with <code><a href= +"#XML_StopParser" >XML_StopParser</a></code>. Must not be called from +within a handler call-back. Returns same status codes as <code><a +href= "#XML_Parse">XML_Parse</a></code> or <code><a href= +"#XML_ParseBuffer" >XML_ParseBuffer</a></code>. An additional error +code, <code>XML_ERROR_NOT_SUSPENDED</code>, will be returned if the +parser was not currently suspended.</p> + +<p><strong>Note:</strong> +This must be called on the most deeply nested child parser instance +first, and on its parent parser only after the child parser has +finished, to be applied recursively until the document entity's parser +is restarted. That is, the parent parser will not resume by itself +and it is up to the application to call <code><a href= +"#XML_ResumeParser" >XML_ResumeParser</a></code> on it at the +appropriate moment.</p> + +<p>New in Expat 1.95.8.</p> +</div> + +<pre class="fcndec" id="XML_GetParsingStatus"> +void XMLCALL +XML_GetParsingStatus(XML_Parser p, + XML_ParsingStatus *status); +</pre> +<pre class="signature"> +enum XML_Parsing { + XML_INITIALIZED, + XML_PARSING, + XML_FINISHED, + XML_SUSPENDED +}; + +typedef struct { + enum XML_Parsing parsing; + XML_Bool finalBuffer; +} XML_ParsingStatus; +</pre> +<div class="fcndef"> +<p>Returns status of parser with respect to being initialized, +parsing, finished, or suspended, and whether the final buffer is being +processed. The <code>status</code> parameter <em>must not</em> be +NULL.</p> + +<p>New in Expat 1.95.8.</p> +</div> + + <h3><a name="setting">Handler Setting</a></h3> <p>Although handlers are typically set prior to parsing and left alone, an @@ -802,21 +1221,23 @@ appropriate handler setter. None of the handler setting functions have a return value.</p> <p>Your handlers will be receiving strings in arrays of type -<code>XML_Char</code>. This type is defined in expat.h as <code>char -*</code> and contains bytes encoding UTF-8. Note that you'll receive -them in this form independent of the original encoding of the -document.</p> +<code>XML_Char</code>. This type is conditionally defined in expat.h as +either <code>char</code>, <code>wchar_t</code> or <code>unsigned short</code>. +The former implies UTF-8 encoding, the latter two imply UTF-16 encoding. +Note that you'll receive them in this form independent of the original +encoding of the document.</p> <div class="handler"> <pre class="setter" id="XML_SetStartElementHandler"> +void XMLCALL XML_SetStartElementHandler(XML_Parser p, XML_StartElementHandler start); </pre> <pre class="signature"> typedef void -(*XML_StartElementHandler)(void *userData, - const XML_Char *name, - const XML_Char **atts); +(XMLCALL *XML_StartElementHandler)(void *userData, + const XML_Char *name, + const XML_Char **atts); </pre> <p>Set handler for start (and empty) tags. Attributes are passed to the start handler as a pointer to a vector of char pointers. Each attribute seen in @@ -829,13 +1250,14 @@ by a null pointer.</p> <div class="handler"> <pre class="setter" id="XML_SetEndElementHandler"> +void XMLCALL XML_SetEndElementHandler(XML_Parser p, XML_EndElementHandler); </pre> <pre class="signature"> typedef void -(*XML_EndElementHandler)(void *userData, - const XML_Char *name); +(XMLCALL *XML_EndElementHandler)(void *userData, + const XML_Char *name); </pre> <p>Set handler for end (and empty) tags. As noted above, an empty tag generates a call to both start and end handlers.</p> @@ -843,6 +1265,7 @@ generates a call to both start and end handlers.</p> <div class="handler"> <pre class="setter" id="XML_SetElementHandler"> +void XMLCALL XML_SetElementHandler(XML_Parser p, XML_StartElementHandler start, XML_EndElementHandler end); @@ -852,33 +1275,38 @@ XML_SetElementHandler(XML_Parser p, <div class="handler"> <pre class="setter" id="XML_SetCharacterDataHandler"> +void XMLCALL XML_SetCharacterDataHandler(XML_Parser p, XML_CharacterDataHandler charhndl) </pre> <pre class="signature"> typedef void -(*XML_CharacterDataHandler)(void *userData, - const XML_Char *s, - int len); +(XMLCALL *XML_CharacterDataHandler)(void *userData, + const XML_Char *s, + int len); </pre> <p>Set a text handler. The string your handler receives is <em>NOT nul-terminated</em>. You have to use the length argument to deal with the end of the string. A single block of contiguous text free of markup may still result in a sequence of calls to this handler. In other words, if you're searching for a pattern in the text, it may -be split across calls to this handler.</p> +be split across calls to this handler. Note: Setting this handler to NULL +may <em>NOT immediately</em> terminate call-backs if the parser is currently +processing such a single block of contiguous markup-free text, as the parser +will continue calling back until the end of the block is reached.</p> </div> <div class="handler"> <pre class="setter" id="XML_SetProcessingInstructionHandler"> +void XMLCALL XML_SetProcessingInstructionHandler(XML_Parser p, XML_ProcessingInstructionHandler proc) </pre> <pre class="signature"> typedef void -(*XML_ProcessingInstructionHandler)(void *userData, - const XML_Char *target, - const XML_Char *data); +(XMLCALL *XML_ProcessingInstructionHandler)(void *userData, + const XML_Char *target, + const XML_Char *data); </pre> <p>Set a handler for processing instructions. The target is the first word @@ -888,13 +1316,14 @@ it after skipping all whitespace after the initial word.</p> <div class="handler"> <pre class="setter" id="XML_SetCommentHandler"> +void XMLCALL XML_SetCommentHandler(XML_Parser p, XML_CommentHandler cmnt) </pre> <pre class="signature"> typedef void -(*XML_CommentHandler)(void *userData, - const XML_Char *data); +(XMLCALL *XML_CommentHandler)(void *userData, + const XML_Char *data); </pre> <p>Set a handler for comments. The data is all text inside the comment delimiters.</p> @@ -902,30 +1331,33 @@ delimiters.</p> <div class="handler"> <pre class="setter" id="XML_SetStartCdataSectionHandler"> +void XMLCALL XML_SetStartCdataSectionHandler(XML_Parser p, XML_StartCdataSectionHandler start); </pre> <pre class="signature"> typedef void -(*XML_StartCdataSectionHandler)(void *userData); +(XMLCALL *XML_StartCdataSectionHandler)(void *userData); </pre> <p>Set a handler that gets called at the beginning of a CDATA section.</p> </div> <div class="handler"> <pre class="setter" id="XML_SetEndCdataSectionHandler"> +void XMLCALL XML_SetEndCdataSectionHandler(XML_Parser p, XML_EndCdataSectionHandler end); </pre> <pre class="signature"> typedef void -(*XML_EndCdataSectionHandler)(void *userData); +(XMLCALL *XML_EndCdataSectionHandler)(void *userData); </pre> <p>Set a handler that gets called at the end of a CDATA section.</p> </div> <div class="handler"> <pre class="setter" id="XML_SetCdataSectionHandler"> +void XMLCALL XML_SetCdataSectionHandler(XML_Parser p, XML_StartCdataSectionHandler start, XML_EndCdataSectionHandler end) @@ -935,14 +1367,15 @@ XML_SetCdataSectionHandler(XML_Parser p, <div class="handler"> <pre class="setter" id="XML_SetDefaultHandler"> +void XMLCALL XML_SetDefaultHandler(XML_Parser p, XML_DefaultHandler hndl) </pre> <pre class="signature"> typedef void -(*XML_DefaultHandler)(void *userData, - const XML_Char *s, - int len); +(XMLCALL *XML_DefaultHandler)(void *userData, + const XML_Char *s, + int len); </pre> <p>Sets a handler for any characters in the document which wouldn't @@ -965,14 +1398,15 @@ href="#XML_DefaultCurrent">XML_DefaultCurrent</a></code>.</p> <div class="handler"> <pre class="setter" id="XML_SetDefaultHandlerExpand"> +void XMLCALL XML_SetDefaultHandlerExpand(XML_Parser p, XML_DefaultHandler hndl) </pre> <pre class="signature"> typedef void -(*XML_DefaultHandler)(void *userData, - const XML_Char *s, - int len); +(XMLCALL *XML_DefaultHandler)(void *userData, + const XML_Char *s, + int len); </pre> <p>This sets a default handler, but doesn't inhibit the expansion of internal entity references. The entity reference will not be passed @@ -984,56 +1418,94 @@ href="#XML_DefaultCurrent">XML_DefaultCurrent</a></code>.</p> <div class="handler"> <pre class="setter" id="XML_SetExternalEntityRefHandler"> +void XMLCALL XML_SetExternalEntityRefHandler(XML_Parser p, XML_ExternalEntityRefHandler hndl) </pre> <pre class="signature"> typedef int -(*XML_ExternalEntityRefHandler)(XML_Parser p, - const XML_Char *context, - const XML_Char *base, - const XML_Char *systemId, - const XML_Char *publicId); +(XMLCALL *XML_ExternalEntityRefHandler)(XML_Parser p, + const XML_Char *context, + const XML_Char *base, + const XML_Char *systemId, + const XML_Char *publicId); </pre> <p>Set an external entity reference handler. This handler is also called for processing an external DTD subset if parameter entity parsing is in effect. (See <a href="#XML_SetParamEntityParsing"> <code>XML_SetParamEntityParsing</code></a>.)</p> - -<p>The base parameter is the base to use for relative system identifiers. -It is set by <a href="#XML_SetBase">XML_SetBase</a> and may be null. The -public id parameter is the public id given in the entity declaration and -may be null. The system id is the system identifier specified in the entity -declaration and is never null.</p> - -<p>There are a couple of ways in which this handler differs from others. -First, this handler returns an integer. A non-zero value should be returned -for successful handling of the external entity reference. Returning a zero -indicates failure, and causes the calling parser to return -an <code>XML_ERROR_EXTERNAL_ENTITY_HANDLING</code> error.</p> - -<p>Second, instead of having userData as its first argument, it receives the -parser that encountered the entity reference. This, along with the context -parameter, may be used as arguments to a call to -<a href="#XML_ExternalEntityParserCreate">XML_ExternalEntityParserCreate</a>. -Using the returned parser, the body of the external entity can be recursively -parsed.</p> +<p>The <code>context</code> parameter specifies the parsing context in +the format expected by the <code>context</code> argument to <code><a +href="#XML_ExternalEntityParserCreate" +>XML_ExternalEntityParserCreate</a></code>. <code>code</code> is +valid only until the handler returns, so if the referenced entity is +to be parsed later, it must be copied. <code>context</code> is NULL +only when the entity is a parameter entity, which is how one can +differentiate between general and parameter entities.</p> + +<p>The <code>base</code> parameter is the base to use for relative +system identifiers. It is set by <code><a +href="#XML_SetBase">XML_SetBase</a></code> and may be NULL. The +<code>publicId</code> parameter is the public id given in the entity +declaration and may be NULL. <code>systemId</code> is the system +identifier specified in the entity declaration and is never NULL.</p> + +<p>There are a couple of ways in which this handler differs from +others. First, this handler returns a status indicator (an +integer). <code>XML_STATUS_OK</code> should be returned for successful +handling of the external entity reference. Returning +<code>XML_STATUS_ERROR</code> indicates failure, and causes the +calling parser to return an +<code>XML_ERROR_EXTERNAL_ENTITY_HANDLING</code> error.</p> + +<p>Second, instead of having the user data as its first argument, it +receives the parser that encountered the entity reference. This, along +with the context parameter, may be used as arguments to a call to +<code><a href= "#XML_ExternalEntityParserCreate" +>XML_ExternalEntityParserCreate</a></code>. Using the returned +parser, the body of the external entity can be recursively parsed.</p> <p>Since this handler may be called recursively, it should not be saving information into global or static variables.</p> </div> +<pre class="fcndec" id="XML_SetExternalEntityRefHandlerArg"> +void XMLCALL +XML_SetExternalEntityRefHandlerArg(XML_Parser p, + void *arg) +</pre> +<div class="fcndef"> +<p>Set the argument passed to the ExternalEntityRefHandler. If +<code>arg</code> is not NULL, it is the new value passed to the +handler set using <code><a href="#XML_SetExternalEntityRefHandler" +>XML_SetExternalEntityRefHandler</a></code>; if <code>arg</code> is +NULL, the argument passed to the handler function will be the parser +object itself.</p> + +<p><strong>Note:</strong> +The type of <code>arg</code> and the type of the first argument to the +ExternalEntityRefHandler do not match. This function takes a +<code>void *</code> to be passed to the handler, while the handler +accepts an <code>XML_Parser</code>. This is a historical accident, +but will not be corrected before Expat 2.0 (at the earliest) to avoid +causing compiler warnings for code that's known to work with this +API. It is the responsibility of the application code to know the +actual type of the argument passed to the handler and to manage it +properly.</p> +</div> + <div class="handler"> <pre class="setter" id="XML_SetSkippedEntityHandler"> +void XMLCALL XML_SetSkippedEntityHandler(XML_Parser p, XML_SkippedEntityHandler handler) </pre> <pre class="signature"> typedef void -(*XML_SkippedEntityHandler)(void *userData, - const XML_Char *entityName, - int is_parameter_entity); +(XMLCALL *XML_SkippedEntityHandler)(void *userData, + const XML_Char *entityName, + int is_parameter_entity); </pre> <p>Set a skipped entity handler. This is called in two situations:</p> <ol> @@ -1052,34 +1524,35 @@ sync with the reporting of the declarations or attribute values</p> <div class="handler"> <pre class="setter" id="XML_SetUnknownEncodingHandler"> +void XMLCALL XML_SetUnknownEncodingHandler(XML_Parser p, XML_UnknownEncodingHandler enchandler, void *encodingHandlerData) </pre> <pre class="signature"> typedef int -(*XML_UnknownEncodingHandler)(void *encodingHandlerData, - const XML_Char *name, - XML_Encoding *info); +(XMLCALL *XML_UnknownEncodingHandler)(void *encodingHandlerData, + const XML_Char *name, + XML_Encoding *info); typedef struct { int map[256]; void *data; - int (*convert)(void *data, const char *s); - void (*release)(void *data); + int (XMLCALL *convert)(void *data, const char *s); + void (XMLCALL *release)(void *data); } XML_Encoding; </pre> -<p>Set a handler to deal with encodings other than the -<a href="#builtin_encodings">built in set</a>. This should be done before +<p>Set a handler to deal with encodings other than the <a +href="#builtin_encodings">built in set</a>. This should be done before <code><a href= "#XML_Parse" >XML_Parse</a></code> or <code><a href= "#XML_ParseBuffer" >XML_ParseBuffer</a></code> have been called on the -given parser.</p> -<p>If the handler knows how to deal with an encoding with the given -name, it should fill in the <code>info</code> data structure and return -1. Otherwise it should return 0. The handler will be called at most -once per parsed (external) entity. The optional application data -pointer <code>encodingHandlerData</code> will be passed back to the -handler.</p> +given parser.</p> <p>If the handler knows how to deal with an encoding +with the given name, it should fill in the <code>info</code> data +structure and return <code>XML_STATUS_OK</code>. Otherwise it +should return <code>XML_STATUS_ERROR</code>. The handler will be called +at most once per parsed (external) entity. The optional application +data pointer <code>encodingHandlerData</code> will be passed back to +the handler.</p> <p>The map array contains information for every possible possible leading byte in a byte sequence. If the corresponding value is >= 0, then it's @@ -1100,14 +1573,15 @@ parser when it is finished with the encoding. It may be NULL.</p> <div class="handler"> <pre class="setter" id="XML_SetStartNamespaceDeclHandler"> +void XMLCALL XML_SetStartNamespaceDeclHandler(XML_Parser p, XML_StartNamespaceDeclHandler start); </pre> <pre class="signature"> typedef void -(*XML_StartNamespaceDeclHandler)(void *userData, - const XML_Char *prefix, - const XML_Char *uri); +(XMLCALL *XML_StartNamespaceDeclHandler)(void *userData, + const XML_Char *prefix, + const XML_Char *uri); </pre> <p>Set a handler to be called when a namespace is declared. Namespace declarations occur inside start tags. But the namespace declaration start @@ -1117,13 +1591,14 @@ in that start tag.</p> <div class="handler"> <pre class="setter" id="XML_SetEndNamespaceDeclHandler"> +void XMLCALL XML_SetEndNamespaceDeclHandler(XML_Parser p, XML_EndNamespaceDeclHandler end); </pre> <pre class="signature"> typedef void -(*XML_EndNamespaceDeclHandler)(void *userData, - const XML_Char *prefix); +(XMLCALL *XML_EndNamespaceDeclHandler)(void *userData, + const XML_Char *prefix); </pre> <p>Set a handler to be called when leaving the scope of a namespace declaration. This will be called, for each namespace declaration, @@ -1133,24 +1608,26 @@ namespace was declared.</p> <div class="handler"> <pre class="setter" id="XML_SetNamespaceDeclHandler"> +void XMLCALL XML_SetNamespaceDeclHandler(XML_Parser p, XML_StartNamespaceDeclHandler start, XML_EndNamespaceDeclHandler end) </pre> -<p>Sets both namespace declaration handlers with a single call</p> +<p>Sets both namespace declaration handlers with a single call.</p> </div> <div class="handler"> <pre class="setter" id="XML_SetXmlDeclHandler"> +void XMLCALL XML_SetXmlDeclHandler(XML_Parser p, XML_XmlDeclHandler xmldecl); </pre> <pre class="signature"> typedef void -(*XML_XmlDeclHandler) (void *userData, - const XML_Char *version, - const XML_Char *encoding, - int standalone); +(XMLCALL *XML_XmlDeclHandler)(void *userData, + const XML_Char *version, + const XML_Char *encoding, + int standalone); </pre> <p>Sets a handler that is called for XML declarations and also for text declarations discovered in external entities. The way to @@ -1164,16 +1641,17 @@ that it was given as yes.</p> <div class="handler"> <pre class="setter" id="XML_SetStartDoctypeDeclHandler"> +void XMLCALL XML_SetStartDoctypeDeclHandler(XML_Parser p, XML_StartDoctypeDeclHandler start); </pre> <pre class="signature"> typedef void -(*XML_StartDoctypeDeclHandler)(void *userData, - const XML_Char *doctypeName, - const XML_Char *sysid, - const XML_Char *pubid, - int has_internal_subset); +(XMLCALL *XML_StartDoctypeDeclHandler)(void *userData, + const XML_Char *doctypeName, + const XML_Char *sysid, + const XML_Char *pubid, + int has_internal_subset); </pre> <p>Set a handler that is called at the start of a DOCTYPE declaration, before any external or internal subset is parsed. Both <code>sysid</code> @@ -1183,12 +1661,13 @@ will be non-zero if the DOCTYPE declaration has an internal subset.</p> <div class="handler"> <pre class="setter" id="XML_SetEndDoctypeDeclHandler"> +void XMLCALL XML_SetEndDoctypeDeclHandler(XML_Parser p, XML_EndDoctypeDeclHandler end); </pre> <pre class="signature"> typedef void -(*XML_EndDoctypeDeclHandler)(void *userData); +(XMLCALL *XML_EndDoctypeDeclHandler)(void *userData); </pre> <p>Set a handler that is called at the end of a DOCTYPE declaration, after parsing any external subset.</p> @@ -1196,6 +1675,7 @@ after parsing any external subset.</p> <div class="handler"> <pre class="setter" id="XML_SetDoctypeDeclHandler"> +void XMLCALL XML_SetDoctypeDeclHandler(XML_Parser p, XML_StartDoctypeDeclHandler start, XML_EndDoctypeDeclHandler end); @@ -1205,14 +1685,15 @@ XML_SetDoctypeDeclHandler(XML_Parser p, <div class="handler"> <pre class="setter" id="XML_SetElementDeclHandler"> +void XMLCALL XML_SetElementDeclHandler(XML_Parser p, XML_ElementDeclHandler eldecl); </pre> <pre class="signature"> typedef void -(*XML_ElementDeclHandler)(void *userData, - const XML_Char *name, - XML_Content *model); +(XMLCALL *XML_ElementDeclHandler)(void *userData, + const XML_Char *name, + XML_Content *model); </pre> <pre class="signature"> enum XML_Content_Type { @@ -1244,7 +1725,9 @@ struct XML_cp { <p>Sets a handler for element declarations in a DTD. The handler gets called with the name of the element in the declaration and a pointer to a structure that contains the element model. It is the -application's responsibility to free this data structure.</p> +application's responsibility to free this data structure using +<code><a href="#XML_FreeContentModel" +>XML_FreeContentModel</a></code>.</p> <p>The <code>model</code> argument is the root of a tree of <code>XML_Content</code> nodes. If <code>type</code> equals @@ -1274,17 +1757,18 @@ or sequence and <code>children</code> points to the nodes.</p> <div class="handler"> <pre class="setter" id="XML_SetAttlistDeclHandler"> +void XMLCALL XML_SetAttlistDeclHandler(XML_Parser p, XML_AttlistDeclHandler attdecl); </pre> <pre class="signature"> typedef void -(*XML_AttlistDeclHandler) (void *userData, - const XML_Char *elname, - const XML_Char *attname, - const XML_Char *att_type, - const XML_Char *dflt, - int isrequired); +(XMLCALL *XML_AttlistDeclHandler)(void *userData, + const XML_Char *elname, + const XML_Char *attname, + const XML_Char *att_type, + const XML_Char *dflt, + int isrequired); </pre> <p>Set a handler for attlist declarations in the DTD. This handler is called for <em>each</em> attribute. So a single attlist declaration @@ -1306,20 +1790,21 @@ in the <code>dflt</code> parameter.</p> <div class="handler"> <pre class="setter" id="XML_SetEntityDeclHandler"> +void XMLCALL XML_SetEntityDeclHandler(XML_Parser p, XML_EntityDeclHandler handler); </pre> <pre class="signature"> typedef void -(*XML_EntityDeclHandler) (void *userData, - const XML_Char *entityName, - int is_parameter_entity, - const XML_Char *value, - int value_length, - const XML_Char *base, - const XML_Char *systemId, - const XML_Char *publicId, - const XML_Char *notationName); +(XMLCALL *XML_EntityDeclHandler)(void *userData, + const XML_Char *entityName, + int is_parameter_entity, + const XML_Char *value, + int value_length, + const XML_Char *base, + const XML_Char *systemId, + const XML_Char *publicId, + const XML_Char *notationName); </pre> <p>Sets a handler that will be called for all entity declarations. The <code>is_parameter_entity</code> argument will be non-zero in the @@ -1339,17 +1824,18 @@ declarations.</p> <div class="handler"> <pre class="setter" id="XML_SetUnparsedEntityDeclHandler"> +void XMLCALL XML_SetUnparsedEntityDeclHandler(XML_Parser p, XML_UnparsedEntityDeclHandler h) </pre> <pre class="signature"> typedef void -(*XML_UnparsedEntityDeclHandler)(void *userData, - const XML_Char *entityName, - const XML_Char *base, - const XML_Char *systemId, - const XML_Char *publicId, - const XML_Char *notationName); +(XMLCALL *XML_UnparsedEntityDeclHandler)(void *userData, + const XML_Char *entityName, + const XML_Char *base, + const XML_Char *systemId, + const XML_Char *publicId, + const XML_Char *notationName); </pre> <p>Set a handler that receives declarations of unparsed entities. These are entity declarations that have a notation (NDATA) field:</p> @@ -1364,52 +1850,59 @@ compatibility. Use instead <a href= "#XML_SetEntityDeclHandler" <div class="handler"> <pre class="setter" id="XML_SetNotationDeclHandler"> +void XMLCALL XML_SetNotationDeclHandler(XML_Parser p, XML_NotationDeclHandler h) </pre> <pre class="signature"> typedef void -(*XML_NotationDeclHandler)(void *userData, - const XML_Char *notationName, - const XML_Char *base, - const XML_Char *systemId, - const XML_Char *publicId); +(XMLCALL *XML_NotationDeclHandler)(void *userData, + const XML_Char *notationName, + const XML_Char *base, + const XML_Char *systemId, + const XML_Char *publicId); </pre> <p>Set a handler that receives notation declarations.</p> </div> <div class="handler"> <pre class="setter" id="XML_SetNotStandaloneHandler"> +void XMLCALL XML_SetNotStandaloneHandler(XML_Parser p, XML_NotStandaloneHandler h) </pre> <pre class="signature"> typedef int -(*XML_NotStandaloneHandler)(void *userData); +(XMLCALL *XML_NotStandaloneHandler)(void *userData); </pre> <p>Set a handler that is called if the document is not "standalone". This happens when there is an external subset or a reference to a parameter entity, but does not have standalone set to "yes" in an XML -declaration. If this handler returns 0, then the parser will throw an -<code>XML_ERROR_NOT_STANDALONE</code> error.</p> +declaration. If this handler returns <code>XML_STATUS_ERROR</code>, +then the parser will throw an <code>XML_ERROR_NOT_STANDALONE</code> +error.</p> </div> <h3><a name="position">Parse position and error reporting functions</a></h3> <p>These are the functions you'll want to call when the parse -functions return 0 (i.e. a parse error has ocurred), although the -position reporting functions are useful outside of errors. The -position reported is the byte position (in the original document or -entity encoding) of the first of the sequence of characters that -generated the current event (or the error that caused the parse -functions to return 0.)</p> +functions return <code>XML_STATUS_ERROR</code> (a parse error has +occurred), although the position reporting functions are useful outside +of errors. The position reported is the byte position (in the original +document or entity encoding) of the first of the sequence of +characters that generated the current event (or the error that caused +the parse functions to return <code>XML_STATUS_ERROR</code>.) The +exceptions are callbacks trigged by declarations in the document +prologue, in which case they exact position reported is somewhere in the +relevant markup, but not necessarily as meaningful as for other +events.</p> <p>The position reporting functions are accurate only outside of the DTD. In other words, they usually return bogus information when called from within a DTD declaration handler.</p> <pre class="fcndec" id="XML_GetErrorCode"> -enum XML_Error +enum XML_Error XMLCALL XML_GetErrorCode(XML_Parser p); </pre> <div class="fcndef"> @@ -1417,8 +1910,8 @@ Return what type of error has occurred. </div> <pre class="fcndec" id="XML_ErrorString"> -const XML_LChar * -XML_ErrorString(int code); +const XML_LChar * XMLCALL +XML_ErrorString(enum XML_Error code); </pre> <div class="fcndef"> Return a string describing the error corresponding to code. @@ -1427,23 +1920,27 @@ The code should be one of the enums that can be returned from </div> <pre class="fcndec" id="XML_GetCurrentByteIndex"> -long +XML_Index XMLCALL XML_GetCurrentByteIndex(XML_Parser p); </pre> <div class="fcndef"> -Return the byte offset of the position. +Return the byte offset of the position. This always corresponds to +the values returned by <code><a href= "#XML_GetCurrentLineNumber" +>XML_GetCurrentLineNumber</a></code> and <code><a href= +"#XML_GetCurrentColumnNumber" >XML_GetCurrentColumnNumber</a></code>. </div> <pre class="fcndec" id="XML_GetCurrentLineNumber"> -int +XML_Size XMLCALL XML_GetCurrentLineNumber(XML_Parser p); </pre> <div class="fcndef"> -Return the line number of the position. +Return the line number of the position. The first line is reported as +<code>1</code>. </div> <pre class="fcndec" id="XML_GetCurrentColumnNumber"> -int +XML_Size XMLCALL XML_GetCurrentColumnNumber(XML_Parser p); </pre> <div class="fcndef"> @@ -1452,7 +1949,7 @@ the position. </div> <pre class="fcndec" id="XML_GetCurrentByteCount"> -int +int XMLCALL XML_GetCurrentByteCount(XML_Parser p); </pre> <div class="fcndef"> @@ -1464,7 +1961,7 @@ separate start and end tags). </div> <pre class="fcndec" id="XML_GetInputContext"> -const char * +const char * XMLCALL XML_GetInputContext(XML_Parser p, int *offset, int *size); @@ -1484,6 +1981,9 @@ untranslated bytes of the input.</p> <p>Only a limited amount of context is kept, so if the event triggering a call spans over a very large amount of input, the actual parse position may be before the beginning of the buffer.</p> + +<p>If <code>XML_CONTEXT_BYTES</code> is not defined, this will always +return NULL.</p> </div> <h3><a name="miscellaneous">Miscellaneous functions</a></h3> @@ -1492,7 +1992,7 @@ parse position may be before the beginning of the buffer.</p> the parser or can be used to dynamicly set parser options.</p> <pre class="fcndec" id="XML_SetUserData"> -void +void XMLCALL XML_SetUserData(XML_Parser p, void *userData); </pre> @@ -1507,7 +2007,7 @@ memory. </div> <pre class="fcndec" id="XML_GetUserData"> -void * +void * XMLCALL XML_GetUserData(XML_Parser p); </pre> <div class="fcndef"> @@ -1516,29 +2016,30 @@ It is actually implemented as a macro. </div> <pre class="fcndec" id="XML_UseParserAsHandlerArg"> -void +void XMLCALL XML_UseParserAsHandlerArg(XML_Parser p); </pre> <div class="fcndef"> -After this is called, handlers receive the parser in the userData -argument. The userData information can still be obtained using the -<code><a href= "#XML_GetUserData" >XML_GetUserData</a></code> -function. +After this is called, handlers receive the parser in their +<code>userData</code> arguments. The user data can still be obtained +using the <code><a href= "#XML_GetUserData" +>XML_GetUserData</a></code> function. </div> <pre class="fcndec" id="XML_SetBase"> -int +enum XML_Status XMLCALL XML_SetBase(XML_Parser p, const XML_Char *base); </pre> <div class="fcndef"> Set the base to be used for resolving relative URIs in system -identifiers. The return value is 0 if there's no memory to store -base, otherwise it's non-zero. +identifiers. The return value is <code>XML_STATUS_ERROR</code> if +there's no memory to store base, otherwise it's +<code>XML_STATUS_OK</code>. </div> <pre class="fcndec" id="XML_GetBase"> -const XML_Char * +const XML_Char * XMLCALL XML_GetBase(XML_Parser p); </pre> <div class="fcndef"> @@ -1546,7 +2047,7 @@ Return the base for resolving relative URIs. </div> <pre class="fcndec" id="XML_GetSpecifiedAttributeCount"> -int +int XMLCALL XML_GetSpecifiedAttributeCount(XML_Parser p); </pre> <div class="fcndef"> @@ -1562,7 +2063,7 @@ means the current call. </div> <pre class="fcndec" id="XML_GetIdAttributeIndex"> -int +int XMLCALL XML_GetIdAttributeIndex(XML_Parser p); </pre> <div class="fcndef"> @@ -1574,7 +2075,7 @@ current call. </div> <pre class="fcndec" id="XML_SetEncoding"> -int +enum XML_Status XMLCALL XML_SetEncoding(XML_Parser p, const XML_Char *encoding); </pre> @@ -1584,10 +2085,12 @@ passing a non-null encoding argument to the parser creation functions. It must not be called after <code><a href= "#XML_Parse" >XML_Parse</a></code> or <code><a href= "#XML_ParseBuffer" >XML_ParseBuffer</a></code> have been called on the given parser. +Returns <code>XML_STATUS_OK</code> on success or +<code>XML_STATUS_ERROR</code> on error. </div> <pre class="fcndec" id="XML_SetParamEntityParsing"> -int +int XMLCALL XML_SetParamEntityParsing(XML_Parser p, enum XML_ParamEntityParsing code); </pre> @@ -1604,7 +2107,7 @@ The choices for <code>code</code> are: </div> <pre class="fcndec" id="XML_UseForeignDTD"> -enum XML_Error +enum XML_Error XMLCALL XML_UseForeignDTD(XML_Parser parser, XML_Bool useDTD); </pre> <div class="fcndef"> @@ -1633,10 +2136,15 @@ external entity reference handler set via <code><a href= DTD support, it returns <code>XML_ERROR_FEATURE_REQUIRES_XML_DTD</code>. Otherwise, it returns <code>XML_ERROR_NONE</code>.</p> + +<p><b>Note:</b> For the purpose of checking WFC: Entity Declared, passing +<code>useDTD == XML_TRUE</code> will make the parser behave as if +the document had a DTD with an external subset. This holds true even if +the external entity reference handler returns without action.</p> </div> <pre class="fcndec" id="XML_SetReturnNSTriplet"> -void +void XMLCALL XML_SetReturnNSTriplet(XML_Parser parser, int do_nst); </pre> @@ -1658,7 +2166,7 @@ separator.</p> </div> <pre class="fcndec" id="XML_DefaultCurrent"> -void +void XMLCALL XML_DefaultCurrent(XML_Parser parser); </pre> <div class="fcndef"> @@ -1672,7 +2180,7 @@ not a default handler. </div> <pre class="fcndec" id="XML_ExpatVersion"> -XML_LChar * +XML_LChar * XMLCALL XML_ExpatVersion(); </pre> <div class="fcndef"> @@ -1680,7 +2188,7 @@ Return the library version as a string (e.g. <code>"expat_1.95.1"</code>). </div> <pre class="fcndec" id="XML_ExpatVersionInfo"> -struct XML_Expat_Version +struct XML_Expat_Version XMLCALL XML_ExpatVersionInfo(); </pre> <pre class="signature"> @@ -1704,7 +2212,7 @@ particular parts of the Expat API are available. </div> <pre class="fcndec" id="XML_GetFeatureList"> -const XML_Feature * +const XML_Feature * XMLCALL XML_GetFeatureList(); </pre> <pre class="signature"> @@ -1716,7 +2224,9 @@ enum XML_FeatureEnum { XML_FEATURE_CONTEXT_BYTES, XML_FEATURE_MIN_SIZE, XML_FEATURE_SIZEOF_XML_CHAR, - XML_FEATURE_SIZEOF_XML_LCHAR + XML_FEATURE_SIZEOF_XML_LCHAR, + XML_FEATURE_NS, + XML_FEATURE_LARGE_SIZE }; typedef struct { @@ -1762,9 +2272,70 @@ time, the following features have been defined to have values:</p> </dl> </div> +<pre class="fcndec" id="XML_FreeContentModel"> +void XMLCALL +XML_FreeContentModel(XML_Parser parser, XML_Content *model); +</pre> +<div class="fcndef"> +Function to deallocate the <code>model</code> argument passed to the +<code>XML_ElementDeclHandler</code> callback set using <code><a +href="#XML_SetElementDeclHandler" >XML_ElementDeclHandler</a></code>. +This function should not be used for any other purpose. +</div> + +<p>The following functions allow external code to share the memory +allocator an <code>XML_Parser</code> has been configured to use. This +is especially useful for third-party libraries that interact with a +parser object created by application code, or heavily layered +applications. This can be essential when using dynamically loaded +libraries which use different C standard libraries (this can happen on +Windows, at least).</p> + +<pre class="fcndec" id="XML_MemMalloc"> +void * XMLCALL +XML_MemMalloc(XML_Parser parser, size_t size); +</pre> +<div class="fcndef"> +Allocate <code>size</code> bytes of memory using the allocator the +<code>parser</code> object has been configured to use. Returns a +pointer to the memory or NULL on failure. Memory allocated in this +way must be freed using <code><a href="#XML_MemFree" +>XML_MemFree</a></code>. +</div> + +<pre class="fcndec" id="XML_MemRealloc"> +void * XMLCALL +XML_MemRealloc(XML_Parser parser, void *ptr, size_t size); +</pre> +<div class="fcndef"> +Allocate <code>size</code> bytes of memory using the allocator the +<code>parser</code> object has been configured to use. +<code>ptr</code> must point to a block of memory allocated by <code><a +href="#XML_MemMalloc" >XML_MemMalloc</a></code> or +<code>XML_MemRealloc</code>, or be NULL. This function tries to +expand the block pointed to by <code>ptr</code> if possible. Returns +a pointer to the memory or NULL on failure. On success, the original +block has either been expanded or freed. On failure, the original +block has not been freed; the caller is responsible for freeing the +original block. Memory allocated in this way must be freed using +<code><a href="#XML_MemFree" +>XML_MemFree</a></code>. +</div> + +<pre class="fcndec" id="XML_MemFree"> +void XMLCALL +XML_MemFree(XML_Parser parser, void *ptr); +</pre> +<div class="fcndef"> +Free a block of memory pointed to by <code>ptr</code>. The block must +have been allocated by <code><a href="#XML_MemMalloc" +>XML_MemMalloc</a></code> or <code>XML_MemRealloc</code>, or be NULL. +</div> + <hr /> <p><a href="http://validator.w3.org/check/referer"><img src="valid-xhtml10.png" alt="Valid XHTML 1.0!" height="31" width="88" class="noborder" /></a></p> +</div> </body> </html> |