MCL/sf/os/xmlsrv: xml/xmlexpatparser/src/expat-1.95.5/doc_pub/reference.html@604ca70b6235 (annotated)

15 6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1	<?xml version="1.0" encoding="iso-8859-1"?>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	3	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	4	<html>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	5	<head>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	6	<!-- Copyright 1999,2000 Clark Cooper <coopercc@netheaven.com>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	7	All rights reserved.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	8	This is free software. You may distribute or modify according to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	9	the terms of the MIT/X License -->
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	10	<title>Expat XML Parser</title>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	11	<meta name="author" content="Clark Cooper, coopercc@netheaven.com" />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	12	<meta http-equiv="Content-Style-Type" content="text/css" />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	13	<link href="style.css" rel="stylesheet" type="text/css" />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	14	</head>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	15	<body>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	16	<h1>Expat XML Parser</h1>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	17
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	18	<p>Expat is a library, written in C, for parsing XML documents. It's
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	19	the underlying XML parser for the open source Mozilla project, Perl's
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	20	<code>XML::Parser</code>, Python's <code>xml.parsers.expat</code>, and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	21	other open-source XML parsers.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	22
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	23	<p>This library is the creation of James Clark, who's also given us
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	24	groff (an nroff look-alike), Jade (an implemention of ISO's DSSSL
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	25	stylesheet language for SGML), XP (a Java XML parser package), XT (a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	26	Java XSL engine). James was also the technical lead on the XML
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	27	Working Group at W3C that produced the XML specification.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	28
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	29	<p>This is free software, licensed under the <a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	30	href="../COPYING">MIT/X Consortium license</a>. You may download it
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	31	from <a href="http://www.libexpat.org/">the Expat home page</a>.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	32	</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	33
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	34	<p>The bulk of this document was originally commissioned as an article by
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	35	<a href="http://www.xml.com/">XML.com</a>. They graciously allowed
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	36	Clark Cooper to retain copyright and to distribute it with Expat.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	37
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	38	<hr />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	39	<h2>Table of Contents</h2>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	40	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	41	<li><a href="#overview">Overview</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	42	<li><a href="#building">Building and Installing</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	43	<li><a href="#using">Using Expat</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	44	<li><a href="#reference">Reference</a>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	45	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	46	<li><a href="#creation">Parser Creation Functions</a>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	47	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	48	<li><a href="#XML_ParserCreate">XML_ParserCreate</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	49	<li><a href="#XML_ParserCreateNS">XML_ParserCreateNS</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	50	<li><a href="#XML_ParserCreate_MM">XML_ParserCreate_MM</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	51	<li><a href="#XML_ExternalEntityParserCreate">XML_ExternalEntityParserCreate</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	52	<li><a href="#XML_ParserFree">XML_ParserFree</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	53	<li><a href="#XML_ParserReset">XML_ParserReset</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	54	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	55	</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	56	<li><a href="#parsing">Parsing Functions</a>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	57	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	58	<li><a href="#XML_Parse">XML_Parse</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	59	<li><a href="#XML_ParseBuffer">XML_ParseBuffer</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	60	<li><a href="#XML_GetBuffer">XML_GetBuffer</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	61	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	62	</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	63	<li><a href="#setting">Handler Setting Functions</a>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	64	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	65	<li><a href="#XML_SetStartElementHandler">XML_SetStartElementHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	66	<li><a href="#XML_SetEndElementHandler">XML_SetEndElementHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	67	<li><a href="#XML_SetElementHandler">XML_SetElementHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	68	<li><a href="#XML_SetCharacterDataHandler">XML_SetCharacterDataHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	69	<li><a href="#XML_SetProcessingInstructionHandler">XML_SetProcessingInstructionHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	70	<li><a href="#XML_SetCommentHandler">XML_SetCommentHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	71	<li><a href="#XML_SetStartCdataSectionHandler">XML_SetStartCdataSectionHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	72	<li><a href="#XML_SetEndCdataSectionHandler">XML_SetEndCdataSectionHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	73	<li><a href="#XML_SetCdataSectionHandler">XML_SetCdataSectionHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	74	<li><a href="#XML_SetDefaultHandler">XML_SetDefaultHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	75	<li><a href="#XML_SetDefaultHandlerExpand">XML_SetDefaultHandlerExpand</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	76	<li><a href="#XML_SetExternalEntityRefHandler">XML_SetExternalEntityRefHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	77	<li><a href="#XML_SetSkippedEntityHandler">XML_SetSkippedEntityHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	78	<li><a href="#XML_SetUnknownEncodingHandler">XML_SetUnknownEncodingHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	79	<li><a href="#XML_SetStartNamespaceDeclHandler">XML_SetStartNamespaceDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	80	<li><a href="#XML_SetEndNamespaceDeclHandler">XML_SetEndNamespaceDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	81	<li><a href="#XML_SetNamespaceDeclHandler">XML_SetNamespaceDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	82	<li><a href="#XML_SetXmlDeclHandler">XML_SetXmlDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	83	<li><a href="#XML_SetStartDoctypeDeclHandler">XML_SetStartDoctypeDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	84	<li><a href="#XML_SetEndDoctypeDeclHandler">XML_SetEndDoctypeDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	85	<li><a href="#XML_SetDoctypeDeclHandler">XML_SetDoctypeDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	86	<li><a href="#XML_SetElementDeclHandler">XML_SetElementDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	87	<li><a href="#XML_SetAttlistDeclHandler">XML_SetAttlistDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	88	<li><a href="#XML_SetEntityDeclHandler">XML_SetEntityDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	89	<li><a href="#XML_SetUnparsedEntityDeclHandler">XML_SetUnparsedEntityDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	90	<li><a href="#XML_SetNotationDeclHandler">XML_SetNotationDeclHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	91	<li><a href="#XML_SetNotStandaloneHandler">XML_SetNotStandaloneHandler</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	92	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	93	</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	94	<li><a href="#position">Parse Position and Error Reporting Functions</a>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	95	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	96	<li><a href="#XML_GetErrorCode">XML_GetErrorCode</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	97	<li><a href="#XML_ErrorString">XML_ErrorString</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	98	<li><a href="#XML_GetCurrentByteIndex">XML_GetCurrentByteIndex</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	99	<li><a href="#XML_GetCurrentLineNumber">XML_GetCurrentLineNumber</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	100	<li><a href="#XML_GetCurrentColumnNumber">XML_GetCurrentColumnNumber</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	101	<li><a href="#XML_GetCurrentByteCount">XML_GetCurrentByteCount</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	102	<li><a href="#XML_GetInputContext">XML_GetInputContext</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	103	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	104	</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	105	<li><a href="#miscellaneous">Miscellaneous Functions</a>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	106	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	107	<li><a href="#XML_SetUserData">XML_SetUserData</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	108	<li><a href="#XML_GetUserData">XML_GetUserData</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	109	<li><a href="#XML_UseParserAsHandlerArg">XML_UseParserAsHandlerArg</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	110	<li><a href="#XML_SetBase">XML_SetBase</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	111	<li><a href="#XML_GetBase">XML_GetBase</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	112	<li><a href="#XML_GetSpecifiedAttributeCount">XML_GetSpecifiedAttributeCount</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	113	<li><a href="#XML_GetIdAttributeIndex">XML_GetIdAttributeIndex</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	114	<li><a href="#XML_SetEncoding">XML_SetEncoding</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	115	<li><a href="#XML_SetParamEntityParsing">XML_SetParamEntityParsing</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	116	<li><a href="#XML_UseForeignDTD">XML_UseForeignDTD</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	117	<li><a href="#XML_SetReturnNSTriplet">XML_SetReturnNSTriplet</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	118	<li><a href="#XML_DefaultCurrent">XML_DefaultCurrent</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	119	<li><a href="#XML_ExpatVersion">XML_ExpatVersion</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	120	<li><a href="#XML_ExpatVersionInfo">XML_ExpatVersionInfo</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	121	<li><a href="#XML_GetFeatureList">XML_GetFeatureList</a></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	122	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	123	</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	124	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	125	</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	126	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	127
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	128	<hr />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	129	<h2><a name="overview">Overview</a></h2>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	130
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	131	<p>Expat is a stream-oriented parser. You register callback (or
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	132	handler) functions with the parser and then start feeding it the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	133	document. As the parser recognizes parts of the document, it will
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	134	call the appropriate handler for that part (if you've registered one.)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	135	The document is fed to the parser in pieces, so you can start parsing
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	136	before you have all the document. This also allows you to parse really
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	137	huge documents that won't fit into memory.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	138
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	139	<p>Expat can be intimidating due to the many kinds of handlers and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	140	options you can set. But you only need to learn four functions in
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	141	order to do 90% of what you'll want to do with it:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	142
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	143	<dl>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	144
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	145	<dt><code><a href= "#XML_ParserCreate"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	146	>XML_ParserCreate</a></code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	147	<dd>Create a new parser object.</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	148
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	149	<dt><code><a href= "#XML_SetElementHandler"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	150	>XML_SetElementHandler</a></code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	151	<dd>Set handlers for start and end tags.</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	152
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	153	<dt><code><a href= "#XML_SetCharacterDataHandler"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	154	>XML_SetCharacterDataHandler</a></code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	155	<dd>Set handler for text.</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	156
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	157	<dt><code><a href= "#XML_Parse"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	158	>XML_Parse</a></code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	159	<dd>Pass a buffer full of document to the parser</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	160	</dl>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	161
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	162	<p>These functions and others are described in the <a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	163	href="#reference">reference</a> part of this document. The reference
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	164	section also describes in detail the parameters passed to the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	165	different types of handlers.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	166
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	167	<p>Let's look at a very simple example program that only uses 3 of the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	168	above functions (it doesn't need to set a character handler.) The
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	169	program <a href="../examples/outline.c">outline.c</a> prints an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	170	element outline, indenting child elements to distinguish them from the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	171	parent element that contains them. The start handler does all the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	172	work. It prints two indenting spaces for every level of ancestor
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	173	elements, then it prints the element and attribute
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	174	information. Finally it increments the global <code>Depth</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	175	variable.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	176
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	177	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	178	int Depth;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	179
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	180	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	181	start(void data, const char el, const char **attr) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	182	int i;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	183
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	184	for (i = 0; i < Depth; i++)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	185	printf(" ");
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	186
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	187	printf("%s", el);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	188
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	189	for (i = 0; attr[i]; i += 2) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	190	printf(" %s='%s'", attr[i], attr[i + 1]);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	191	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	192
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	193	printf("\n");
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	194	Depth++;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	195	} /* End of start handler */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	196	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	197
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	198	<p>The end tag simply does the bookkeeping work of decrementing
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	199	<code>Depth</code>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	200	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	201	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	202	end(void data, const char el) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	203	Depth--;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	204	} /* End of end handler */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	205	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	206
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	207	<p>After creating the parser, the main program just has the job of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	208	shoveling the document to the parser so that it can do its work.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	209
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	210	<hr />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	211	<h2><a name="building">Building and Installing Expat</a></h2>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	212
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	213	<p>The Expat distribution comes as a compressed (with GNU gzip) tar
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	214	file. You may download the latest version from <a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	215	"http://sourceforge.net/projects/expat/" >Source Forge</a>. After
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	216	unpacking this, cd into the directory. Then follow either the Win32
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	217	directions or Unix directions below.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	218
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	219	<h3>Building under Win32</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	220
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	221	<p>If you're using the GNU compiler under cygwin, follow the Unix
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	222	directions in the next section. Otherwise if you have Microsoft's
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	223	Developer Studio installed, then from Windows Explorer double-click on
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	224	"expat.dsp" in the lib directory and build and install in the usual
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	225	manner.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	226
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	227	<p>Alternatively, you may download the Win32 binary package that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	228	contains the "expat.h" include file and a pre-built DLL.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	229
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	230	<h3>Building under Unix (or GNU)</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	231
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	232	<p>First you'll need to run the configure shell script in order to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	233	configure the Makefiles and headers for your system.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	234
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	235	<p>If you're happy with all the defaults that configure picks for you,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	236	and you have permission on your system to install into /usr/local, you
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	237	can install Expat with this sequence of commands:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	238
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	239	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	240	./configure
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	241	make
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	242	make install
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	243	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	244
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	245	<p>There are some options that you can provide to this script, but the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	246	only one we'll mention here is the <code>--prefix</code> option. You
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	247	can find out all the options available by running configure with just
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	248	the <code>--help</code> option.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	249
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	250	<p>By default, the configure script sets things up so that the library
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	251	gets installed in <code>/usr/local/lib</code> and the associated
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	252	header file in <code>/usr/local/include</code>. But if you were to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	253	give the option, <code>--prefix=/home/me/mystuff</code>, then the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	254	library and header would get installed in
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	255	<code>/home/me/mystuff/lib</code> and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	256	<code>/home/me/mystuff/include</code> respectively.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	257
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	258	<hr />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	259	<h2><a name="using">Using Expat</a></h2>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	260
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	261	<h3>Compiling and Linking Against Expat</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	262
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	263	<p>Unless you installed Expat in a location not expected by your
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	264	compiler and linker, all you have to do to use Expat in your programs
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	265	is to include the Expat header (<code>#include <expat.h></code>)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	266	in your files that make calls to it and to tell the linker that it
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	267	needs to link against the Expat library. On Unix systems, this would
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	268	usually be done with the <code>-lexpat</code> argument. Otherwise,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	269	you'll need to tell the compiler where to look for the Expat header
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	270	and the linker where to find the Expat library. You may also need to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	271	take steps to tell the operating system where to find this libary at
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	272	run time.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	273
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	274	<p>On a Unix-based system, here's what a Makefile might look like when
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	275	Expat is installed in a standard location:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	276
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	277	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	278	CC=cc
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	279	LDFLAGS=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	280	LIBS= -lexpat
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	281	xmlapp: xmlapp.o
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	282	$(CC) $(LDFLAGS) -o xmlapp xmlapp.o $(LIBS)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	283	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	284
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	285	<p>If you installed Expat in, say, <code>/home/me/mystuff</code>, then
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	286	the Makefile would look like this:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	287
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	288	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	289	CC=cc
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	290	CFLAGS= -I/home/me/mystuff/include
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	291	LDFLAGS=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	292	LIBS= -L/home/me/mystuff/lib -lexpat
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	293	xmlapp: xmlapp.o
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	294	$(CC) $(LDFLAGS) -o xmlapp xmlapp.o $(LIBS)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	295	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	296
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	297	<p>You'd also have to set the environment variable
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	298	<code>LD_LIBRARY_PATH</code> to <code>/home/me/mystuff/lib</code> (or
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	299	to <code>${LD_LIBRARY_PATH}:/home/me/mystuff/lib</code> if
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	300	LD_LIBRARY_PATH already has some directories in it) in order to run
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	301	your application.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	302
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	303	<h3>Expat Basics</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	304
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	305	<p>As we saw in the example in the overview, the first step in parsing
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	306	an XML document with Expat is to create a parser object. There are <a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	307	href="#creation">three functions</a> in the Expat API for creating a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	308	parser object. However, only two of these (<code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	309	"#XML_ParserCreate" >XML_ParserCreate</a></code> and <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	310	"#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>) can be used for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	311	constructing a parser for a top-level document. The object returned
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	312	by these functions is an opaque pointer (i.e. "expat.h" declares it as
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	313	void *) to data with further internal structure. In order to free the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	314	memory associated with this object you must call <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	315	"#XML_ParserFree" >XML_ParserFree</a></code>. Note that if you have
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	316	provided any <a href="userdata">user data</a> that gets stored in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	317	parser, then your application is responsible for freeing it prior to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	318	calling <code>XML_ParserFree</code>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	319
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	320	<p>The objects returned by the parser creation functions are good for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	321	parsing only one XML document or external parsed entity. If your
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	322	application needs to parse many XML documents, then it needs to create
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	323	a parser object for each one. The best way to deal with this is to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	324	create a higher level object that contains all the default
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	325	initialization you want for your parser objects.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	326
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	327	<p>Walking through a document hierarchy with a stream oriented parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	328	will require a good stack mechanism in order to keep track of current
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	329	context. For instance, to answer the simple question, "What element
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	330	does this text belong to?" requires a stack, since the parser may have
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	331	descended into other elements that are children of the current one and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	332	has encountered this text on the way out.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	333
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	334	<p>The things you're likely to want to keep on a stack are the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	335	currently opened element and it's attributes. You push this
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	336	information onto the stack in the start handler and you pop it off in
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	337	the end handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	338
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	339	<p>For some tasks, it is sufficient to just keep information on what
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	340	the depth of the stack is (or would be if you had one.) The outline
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	341	program shown above presents one example. Another such task would be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	342	skipping over a complete element. When you see the start tag for the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	343	element you want to skip, you set a skip flag and record the depth at
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	344	which the element started. When the end tag handler encounters the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	345	same depth, the skipped element has ended and the flag may be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	346	cleared. If you follow the convention that the root element starts at
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	347	1, then you can use the same variable for skip flag and skip
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	348	depth.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	349
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	350	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	351	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	352	init_info(Parseinfo *info) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	353	info->skip = 0;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	354	info->depth = 1;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	355	/* Other initializations here */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	356	} /* End of init_info */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	357
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	358	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	359	rawstart(void data, const char el, const char **attr) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	360	Parseinfo inf = (Parseinfo ) data;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	361
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	362	if (! inf->skip) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	363	if (should_skip(inf, el, attr)) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	364	inf->skip = inf->depth;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	365	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	366	else
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	367	start(inf, el, attr); /* This does rest of start handling */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	368	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	369
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	370	inf->depth++;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	371	} /* End of rawstart */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	372
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	373	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	374	rawend(void data, const char el) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	375	Parseinfo inf = (Parseinfo ) data;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	376
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	377	inf->depth--;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	378
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	379	if (! inf->skip)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	380	end(inf, el); /* This does rest of end handling */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	381
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	382	if (inf->skip == inf->depth)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	383	inf->skip = 0;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	384	} /* End rawend */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	385	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	386
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	387	<p>Notice in the above example the difference in how depth is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	388	manipulated in the start and end handlers. The end tag handler should
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	389	be the mirror image of the start tag handler. This is necessary to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	390	properly model containment. Since, in the start tag handler, we
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	391	incremented depth <em>after</em> the main body of start tag code, then
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	392	in the end handler, we need to manipulate it <em>before</em> the main
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	393	body. If we'd decided to increment it first thing in the start
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	394	handler, then we'd have had to decrement it last thing in the end
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	395	handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	396
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	397	<h3 id="userdata">Communicating between handlers</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	398
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	399	<p>In order to be able to pass information between different handlers
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	400	without using globals, you'll need to define a data structure to hold
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	401	the shared variables. You can then tell Expat (with the <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	402	"#XML_SetUserData" >XML_SetUserData</a></code> function) to pass a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	403	pointer to this structure to the handlers. This is typically the first
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	404	argument received by most handlers.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	405
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	406	<h3>XML Version</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	407
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	408	<p>Expat is an XML 1.0 parser, and as such never complains based on
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	409	the value of the <code>version</code> pseudo-attribute in the XML
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	410	declaration, if present.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	411
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	412	<p>If an application needs to check the version number (to support
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	413	alternate processing), it should use the <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	414	"#XML_SetXmlDeclHandler" >XML_SetXmlDeclHandler</a></code> function to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	415	set a handler that uses the information in the XML declaration to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	416	determine what to do. This example shows how to check that only a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	417	version number of <code>"1.0"</code> is accepted:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	418
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	419	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	420	static int wrong_version;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	421	static XML_Parser parser;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	422
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	423	static void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	424	xmldecl_handler(void *userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	425	const XML_Char *version,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	426	const XML_Char *encoding,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	427	int standalone)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	428	{
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	429	static const XML_Char Version_1_0[] = {'1', '.', '0', 0};
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	430
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	431	int i;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	432
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	433	for (i = 0; i < (sizeof(Version_1_0) / sizeof(Version_1_0[0])); ++i) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	434	if (version[i] != Version_1_0[i]) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	435	wrong_version = 1;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	436	/* also clear all other handlers: */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	437	XML_SetCharacterDataHandler(parser, NULL);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	438	...
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	439	return;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	440	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	441	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	442	...
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	443	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	444	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	445
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	446	<h3>Namespace Processing</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	447
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	448	<p>When the parser is created using the <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	449	"#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>, function, Expat
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	450	performs namespace processing. Under namespace processing, Expat
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	451	consumes <code>xmlns</code> and <code>xmlns:...</code> attributes,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	452	which declare namespaces for the scope of the element in which they
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	453	occur. This means that your start handler will not see these
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	454	attributes. Your application can still be informed of these
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	455	declarations by setting namespace declaration handlers with <a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	456	"#XML_SetNamespaceDeclHandler"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	457	><code>XML_SetNamespaceDeclHandler</code></a>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	458
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	459	<p>Element type and attribute names that belong to a given namespace
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	460	are passed to the appropriate handler in expanded form. By default
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	461	this expanded form is a concatenation of the namespace URI, the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	462	separator character (which is the 2nd argument to <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	463	"#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>), and the local
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	464	name (i.e. the part after the colon). Names with undeclared prefixes
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	465	are passed through to the handlers unchanged, with the prefix and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	466	colon still attached. Unprefixed attribute names are never expanded,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	467	and unprefixed element names are only expanded when they are in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	468	scope of a default namespace.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	469
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	470	<p>However if <code><a href= "XML_SetReturnNSTriplet"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	471	>XML_SetReturnNSTriplet</a></code> has been called with a non-zero
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	472	<code>do_nst</code> parameter, then the expanded form for names with
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	473	an explicit prefix is a concatenation of: URI, separator, local name,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	474	separator, prefix.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	475
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	476	<p>You can set handlers for the start of a namespace declaration and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	477	for the end of a scope of a declaration with the <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	478	"#XML_SetNamespaceDeclHandler" >XML_SetNamespaceDeclHandler</a></code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	479	function. The StartNamespaceDeclHandler is called prior to the start
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	480	tag handler and the EndNamespaceDeclHandler is called before the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	481	corresponding end tag that ends the namespace's scope. The namespace
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	482	start handler gets passed the prefix and URI for the namespace. For a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	483	default namespace declaration (xmlns='...'), the prefix will be null.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	484	The URI will be null for the case where the default namespace is being
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	485	unset. The namespace end handler just gets the prefix for the closing
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	486	scope.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	487
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	488	<p>These handlers are called for each declaration. So if, for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	489	instance, a start tag had three namespace declarations, then the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	490	StartNamespaceDeclHandler would be called three times before the start
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	491	tag handler is called, once for each declaration.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	492
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	493	<h3>Character Encodings</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	494
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	495	<p>While XML is based on Unicode, and every XML processor is required
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	496	to recognized UTF-8 and UTF-16 (1 and 2 byte encodings of Unicode),
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	497	other encodings may be declared in XML documents or entities. For the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	498	main document, an XML declaration may contain an encoding
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	499	declaration:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	500	<pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	501	<?xml version="1.0" encoding="ISO-8859-2"?>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	502	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	503
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	504	<p>External parsed entities may begin with a text declaration, which
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	505	looks like an XML declaration with just an encoding declaration:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	506	<pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	507	<?xml encoding="Big5"?>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	508	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	509
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	510	<p>With Expat, you may also specify an encoding at the time of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	511	creating a parser. This is useful when the encoding information may
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	512	come from a source outside the document itself (like a higher level
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	513	protocol.)</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	514
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	515	<p><a name="builtin_encodings"></a>There are four built-in encodings
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	516	in Expat:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	517	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	518	<li>UTF-8</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	519	<li>UTF-16</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	520	<li>ISO-8859-1</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	521	<li>US-ASCII</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	522	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	523
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	524	<p>Anything else discovered in an encoding declaration or in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	525	protocol encoding specified in the parser constructor, triggers a call
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	526	to the <code>UnknownEncodingHandler</code>. This handler gets passed
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	527	the encoding name and a pointer to an <code>XML_Encoding</code> data
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	528	structure. Your handler must fill in this structure and return 1 if it
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	529	knows how to deal with the encoding. Otherwise the handler should
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	530	return 0. The handler also gets passed a pointer to an optional
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	531	application data structure that you may indicate when you set the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	532	handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	533
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	534	<p>Expat places restrictions on character encodings that it can
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	535	support by filling in the <code>XML_Encoding</code> structure.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	536	include file:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	537	<ol>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	538	<li>Every ASCII character that can appear in a well-formed XML document
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	539	must be represented by a single byte, and that byte must correspond to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	540	it's ASCII encoding (except for the characters $@\^'{}~)</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	541	<li>Characters must be encoded in 4 bytes or less.</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	542	<li>All characters encoded must have Unicode scalar values less than or
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	543	equal to 65535 (0xFFFF)<em>This does not apply to the built-in support
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	544	for UTF-16 and UTF-8</em></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	545	<li>No character may be encoded by more that one distinct sequence of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	546	bytes</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	547	</ol>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	548
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	549	<p><code>XML_Encoding</code> contains an array of integers that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	550	correspond to the 1st byte of an encoding sequence. If the value in
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	551	the array for a byte is zero or positive, then the byte is a single
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	552	byte encoding that encodes the Unicode scalar value contained in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	553	array. A -1 in this array indicates a malformed byte. If the value is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	554	-2, -3, or -4, then the byte is the beginning of a 2, 3, or 4 byte
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	555	sequence respectively. Multi-byte sequences are sent to the convert
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	556	function pointed at in the <code>XML_Encoding</code> structure. This
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	557	function should return the Unicode scalar value for the sequence or -1
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	558	if the sequence is malformed.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	559
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	560	<p>One pitfall that novice Expat users are likely to fall into is that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	561	although Expat may accept input in various encodings, the strings that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	562	it passes to the handlers are always encoded in UTF-8 or UTF-16
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	563	(depending on how Expat was compiled). Your application is responsible
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	564	for any translation of these strings into other encodings.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	565
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	566	<h3>Handling External Entity References</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	567
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	568	<p>Expat does not read or parse external entities directly. Note that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	569	any external DTD is a special case of an external entity. If you've
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	570	set no <code>ExternalEntityRefHandler</code>, then external entity
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	571	references are silently ignored. Otherwise, it calls your handler with
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	572	the information needed to read and parse the external entity.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	573
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	574	<p>Your handler isn't actually responsible for parsing the entity, but
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	575	it is responsible for creating a subsidiary parser with <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	576	"#XML_ExternalEntityParserCreate"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	577	>XML_ExternalEntityParserCreate</a></code> that will do the job. This
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	578	returns an instance of <code>XML_Parser</code> that has handlers and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	579	other data structures initialized from the parent parser. You may then
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	580	use <code><a href= "#XML_Parse" >XML_Parse</a></code> or <code><a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	581	href= "#XML_ParseBuffer">XML_ParseBuffer</a></code> calls against this
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	582	parser. Since external entities my refer to other external entities,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	583	your handler should be prepared to be called recursively.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	584
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	585	<h3>Parsing DTDs</h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	586
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	587	<p>In order to parse parameter entities, before starting the parse,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	588	you must call <code><a href= "#XML_SetParamEntityParsing"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	589	>XML_SetParamEntityParsing</a></code> with one of the following
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	590	arguments:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	591	<dl>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	592	<dt><code>XML_PARAM_ENTITY_PARSING_NEVER</code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	593	<dd>Don't parse parameter entities or the external subset</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	594	<dt><code>XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE</code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	595	<dd>Parse parameter entites and the external subset unless
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	596	<code>standalone</code> was set to "yes" in the XML declaration.</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	597	<dt><code>XML_PARAM_ENTITY_PARSING_ALWAYS</code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	598	<dd>Always parse parameter entities and the external subset</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	599	</dl>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	600
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	601	<p>In order to read an external DTD, you also have to set an external
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	602	entity reference handler as described above.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	603
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	604	<hr />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	605	<!-- ================================================================ -->
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	606
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	607	<h2><a name="reference">Expat Reference</a></h2>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	608
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	609	<h3><a name="creation">Parser Creation</a></h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	610
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	611	<pre class="fcndec" id="XML_ParserCreate">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	612	XML_Parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	613	XML_ParserCreate(const XML_Char *encoding);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	614	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	615	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	616	Construct a new parser. If encoding is non-null, it specifies a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	617	character encoding to use for the document. This overrides the document
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	618	encoding declaration. There are four built-in encodings:
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	619	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	620	<li>US-ASCII</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	621	<li>UTF-8</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	622	<li>UTF-16</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	623	<li>ISO-8859-1</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	624	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	625	Any other value will invoke a call to the UnknownEncodingHandler.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	626	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	627
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	628	<pre class="fcndec" id="XML_ParserCreateNS">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	629	XML_Parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	630	XML_ParserCreateNS(const XML_Char *encoding,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	631	XML_Char sep);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	632	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	633	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	634	Constructs a new parser that has namespace processing in effect. Namespace
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	635	expanded element names and attribute names are returned as a concatenation
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	636	of the namespace URI, <em>sep</em>, and the local part of the name. This
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	637	means that you should pick a character for <em>sep</em> that can't be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	638	part of a legal URI.</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	639
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	640	<pre class="fcndec" id="XML_ParserCreate_MM">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	641	XML_Parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	642	XML_ParserCreate_MM(const XML_Char *encoding,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	643	const XML_Memory_Handling_Suite *ms,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	644	const XML_Char *sep);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	645	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	646	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	647	typedef struct {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	648	void (malloc_fcn)(size_t size);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	649	void (realloc_fcn)(void *ptr, size_t size);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	650	void (free_fcn)(void ptr);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	651	} XML_Memory_Handling_Suite;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	652	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	653	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	654	<p>Construct a new parser using the suite of memory handling functions
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	655	specified in <code>ms</code>. If <code>ms</code> is NULL, then use the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	656	standard set of memory management functions. If <code>sep</code> is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	657	non NULL, then namespace processing is enabled in the created parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	658	and the character pointed at by sep is used as the separator between
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	659	the namespace URI and the local part of the name.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	660	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	661
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	662	<pre class="fcndec" id="XML_ExternalEntityParserCreate">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	663	XML_Parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	664	XML_ExternalEntityParserCreate(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	665	const XML_Char *context,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	666	const XML_Char *encoding);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	667	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	668	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	669	Construct a new <code>XML_Parser</code> object for parsing an external
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	670	general entity. Context is the context argument passed in a call to a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	671	ExternalEntityRefHandler. Other state information such as handlers,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	672	user data, namespace processing is inherited from the parser passed as
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	673	the 1st argument. So you shouldn't need to call any of the behavior
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	674	changing functions on this parser (unless you want it to act
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	675	differently than the parent parser).
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	676	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	677
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	678	<pre class="fcndec" id="XML_ParserFree">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	679	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	680	XML_ParserFree(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	681	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	682	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	683	Free memory used by the parser. Your application is responsible for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	684	freeing any memory associated with <a href="#userdata">user data</a>.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	685	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	686
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	687	<pre class="fcndec" id="XML_ParserReset">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	688	XML_Bool
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	689	XML_ParserReset(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	690	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	691	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	692	Clean up the memory structures maintained by the parser so that it may
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	693	be used again. After this has been called, <code>parser</code> is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	694	ready to start parsing a new document. This function may not be used
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	695	on a parser created using <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	696	"#XML_ExternalEntityParserCreate" >XML_ExternalEntityParserCreate</a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	697	></code>; it will return <code>XML_FALSE</code> in that case. Returns
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	698	<code>XML_TRUE</code> on success. Your application is responsible for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	699	dealing with any memory associated with <a href="#userdata">user data</a>.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	700	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	701
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	702	<h3><a name="parsing">Parsing</a></h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	703
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	704	<p>To state the obvious: the three parsing functions <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	705	"#XML_Parse" >XML_Parse</a></code>, <code><a href= "#XML_ParseBuffer"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	706	>XML_ParseBuffer</a></code> and <code><a href= "#XML_GetBuffer"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	707	>>XML_GetBuffer</a></code> must not be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	708	called from within a handler unless they operate on a separate parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	709	instance, that is, one that did not call the handler. For example, it
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	710	is OK to call the parsing functions from within an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	711	<code>XML_ExternalEntityRefHandler</code>, if they apply to the parser
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	712	created by <code><a href= "#XML_ExternalEntityParserCreate"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	713	>XML_ExternalEntityParserCreate</a></code>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	714
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	715	<pre class="fcndec" id="XML_Parse">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	716	XML_Status
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	717	XML_Parse(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	718	const char *s,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	719	int len,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	720	int isFinal);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	721	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	722	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	723	enum XML_Status {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	724	XML_STATUS_ERROR = 0,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	725	XML_STATUS_OK = 1
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	726	};
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	727	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	728	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	729	Parse some more of the document. The string <code>s</code> is a buffer
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	730	containing part (or perhaps all) of the document. The number of bytes of s
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	731	that are part of the document is indicated by <code>len</code>. This means
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	732	that <code>s</code> doesn't have to be null terminated. It also means that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	733	if <code>len</code> is larger than the number of bytes in the block of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	734	memory that <code>s</code> points at, then a memory fault is likely. The
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	735	<code>isFinal</code> parameter informs the parser that this is the last
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	736	piece of the document. Frequently, the last piece is empty (i.e.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	737	<code>len</code> is zero.)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	738	If a parse error occurred, it returns <code>XML_STATUS_ERROR</code>.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	739	Otherwise it returns <code>XML_STATUS_OK</code> value.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	740	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	741
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	742	<pre class="fcndec" id="XML_ParseBuffer">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	743	XML_Status
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	744	XML_ParseBuffer(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	745	int len,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	746	int isFinal);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	747	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	748	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	749	This is just like <code><a href= "#XML_Parse" >XML_Parse</a></code>,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	750	except in this case Expat provides the buffer. By obtaining the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	751	buffer from Expat with the <code><a href= "#XML_GetBuffer"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	752	>XML_GetBuffer</a></code> function, the application can avoid double
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	753	copying of the input.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	754	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	755
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	756	<pre class="fcndec" id="XML_GetBuffer">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	757	void *
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	758	XML_GetBuffer(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	759	int len);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	760	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	761	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	762	Obtain a buffer of size <code>len</code> to read a piece of the document
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	763	into. A NULL value is returned if Expat can't allocate enough memory for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	764	this buffer. This has to be called prior to every call to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	765	<code><a href= "#XML_ParseBuffer" >XML_ParseBuffer</a></code>. A
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	766	typical use would look like this:
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	767
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	768	<pre class="eg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	769	for (;;) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	770	int bytes_read;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	771	void *buff = XML_GetBuffer(p, BUFF_SIZE);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	772	if (buff == NULL) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	773	/* handle error */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	774	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	775
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	776	bytes_read = read(docfd, buff, BUFF_SIZE);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	777	if (bytes_read < 0) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	778	/* handle error */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	779	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	780
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	781	if (! XML_ParseBuffer(p, bytes_read, bytes_read == 0)) {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	782	/* handle parse error */
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	783	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	784
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	785	if (bytes_read == 0)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	786	break;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	787	}
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	788	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	789	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	790
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	791	<h3><a name="setting">Handler Setting</a></h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	792
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	793	<p>Although handlers are typically set prior to parsing and left alone, an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	794	application may choose to set or change the handler for a parsing event
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	795	while the parse is in progress. For instance, your application may choose
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	796	to ignore all text not descended from a <code>para</code> element. One
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	797	way it could do this is to set the character handler when a para start tag
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	798	is seen, and unset it for the corresponding end tag.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	799
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	800	<p>A handler may be <em>unset</em> by providing a NULL pointer to the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	801	appropriate handler setter. None of the handler setting functions have
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	802	a return value.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	803
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	804	<p>Your handlers will be receiving strings in arrays of type
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	805	<code>XML_Char</code>. This type is defined in expat.h as <code>char
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	806	*</code> and contains bytes encoding UTF-8. Note that you'll receive
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	807	them in this form independent of the original encoding of the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	808	document.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	809
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	810	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	811	<pre class="setter" id="XML_SetStartElementHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	812	XML_SetStartElementHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	813	XML_StartElementHandler start);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	814	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	815	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	816	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	817	(XML_StartElementHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	818	const XML_Char *name,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	819	const XML_Char **atts);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	820	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	821	<p>Set handler for start (and empty) tags. Attributes are passed to the start
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	822	handler as a pointer to a vector of char pointers. Each attribute seen in
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	823	a start (or empty) tag occupies 2 consecutive places in this vector: the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	824	attribute name followed by the attribute value. These pairs are terminated
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	825	by a null pointer.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	826	<p>Note that an empty tag generates a call to both start and end handlers
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	827	(in that order).</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	828	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	829
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	830	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	831	<pre class="setter" id="XML_SetEndElementHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	832	XML_SetEndElementHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	833	XML_EndElementHandler);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	834	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	835	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	836	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	837	(XML_EndElementHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	838	const XML_Char *name);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	839	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	840	<p>Set handler for end (and empty) tags. As noted above, an empty tag
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	841	generates a call to both start and end handlers.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	842	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	843
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	844	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	845	<pre class="setter" id="XML_SetElementHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	846	XML_SetElementHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	847	XML_StartElementHandler start,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	848	XML_EndElementHandler end);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	849	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	850	<p>Set handlers for start and end tags with one call.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	851	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	852
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	853	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	854	<pre class="setter" id="XML_SetCharacterDataHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	855	XML_SetCharacterDataHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	856	XML_CharacterDataHandler charhndl)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	857	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	858	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	859	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	860	(XML_CharacterDataHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	861	const XML_Char *s,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	862	int len);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	863	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	864	<p>Set a text handler. The string your handler receives
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	865	is <em>NOT nul-terminated</em>. You have to use the length argument
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	866	to deal with the end of the string. A single block of contiguous text
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	867	free of markup may still result in a sequence of calls to this handler.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	868	In other words, if you're searching for a pattern in the text, it may
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	869	be split across calls to this handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	870	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	871
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	872	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	873	<pre class="setter" id="XML_SetProcessingInstructionHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	874	XML_SetProcessingInstructionHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	875	XML_ProcessingInstructionHandler proc)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	876	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	877	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	878	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	879	(XML_ProcessingInstructionHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	880	const XML_Char *target,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	881	const XML_Char *data);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	882
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	883	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	884	<p>Set a handler for processing instructions. The target is the first word
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	885	in the processing instruction. The data is the rest of the characters in
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	886	it after skipping all whitespace after the initial word.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	887	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	888
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	889	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	890	<pre class="setter" id="XML_SetCommentHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	891	XML_SetCommentHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	892	XML_CommentHandler cmnt)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	893	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	894	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	895	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	896	(XML_CommentHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	897	const XML_Char *data);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	898	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	899	<p>Set a handler for comments. The data is all text inside the comment
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	900	delimiters.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	901	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	902
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	903	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	904	<pre class="setter" id="XML_SetStartCdataSectionHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	905	XML_SetStartCdataSectionHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	906	XML_StartCdataSectionHandler start);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	907	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	908	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	909	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	910	(XML_StartCdataSectionHandler)(void userData);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	911	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	912	<p>Set a handler that gets called at the beginning of a CDATA section.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	913	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	914
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	915	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	916	<pre class="setter" id="XML_SetEndCdataSectionHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	917	XML_SetEndCdataSectionHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	918	XML_EndCdataSectionHandler end);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	919	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	920	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	921	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	922	(XML_EndCdataSectionHandler)(void userData);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	923	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	924	<p>Set a handler that gets called at the end of a CDATA section.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	925	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	926
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	927	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	928	<pre class="setter" id="XML_SetCdataSectionHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	929	XML_SetCdataSectionHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	930	XML_StartCdataSectionHandler start,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	931	XML_EndCdataSectionHandler end)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	932	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	933	<p>Sets both CDATA section handlers with one call.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	934	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	935
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	936	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	937	<pre class="setter" id="XML_SetDefaultHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	938	XML_SetDefaultHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	939	XML_DefaultHandler hndl)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	940	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	941	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	942	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	943	(XML_DefaultHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	944	const XML_Char *s,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	945	int len);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	946	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	947
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	948	<p>Sets a handler for any characters in the document which wouldn't
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	949	otherwise be handled. This includes both data for which no handlers
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	950	can be set (like some kinds of DTD declarations) and data which could
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	951	be reported but which currently has no handler set. The characters
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	952	are passed exactly as they were present in the XML document except
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	953	that they will be encoded in UTF-8 or UTF-16. Line boundaries are not
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	954	normalized. Note that a byte order mark character is not passed to the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	955	default handler. There are no guarantees about how characters are
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	956	divided between calls to the default handler: for example, a comment
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	957	might be split between multiple calls. Setting the handler with
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	958	this call has the side effect of turning off expansion of references
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	959	to internally defined general entities. Instead these references are
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	960	passed to the default handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	961
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	962	<p>See also <code><a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	963	href="#XML_DefaultCurrent">XML_DefaultCurrent</a></code>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	964	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	965
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	966	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	967	<pre class="setter" id="XML_SetDefaultHandlerExpand">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	968	XML_SetDefaultHandlerExpand(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	969	XML_DefaultHandler hndl)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	970	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	971	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	972	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	973	(XML_DefaultHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	974	const XML_Char *s,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	975	int len);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	976	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	977	<p>This sets a default handler, but doesn't inhibit the expansion of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	978	internal entity references. The entity reference will not be passed
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	979	to the default handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	980
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	981	<p>See also <code><a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	982	href="#XML_DefaultCurrent">XML_DefaultCurrent</a></code>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	983	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	984
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	985	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	986	<pre class="setter" id="XML_SetExternalEntityRefHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	987	XML_SetExternalEntityRefHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	988	XML_ExternalEntityRefHandler hndl)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	989	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	990	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	991	typedef int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	992	(*XML_ExternalEntityRefHandler)(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	993	const XML_Char *context,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	994	const XML_Char *base,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	995	const XML_Char *systemId,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	996	const XML_Char *publicId);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	997	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	998	<p>Set an external entity reference handler. This handler is also
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	999	called for processing an external DTD subset if parameter entity parsing
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1000	is in effect. (See <a href="#XML_SetParamEntityParsing">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1001	<code>XML_SetParamEntityParsing</code></a>.)</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1002
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1003
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1004	<p>The base parameter is the base to use for relative system identifiers.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1005	It is set by <a href="#XML_SetBase">XML_SetBase</a> and may be null. The
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1006	public id parameter is the public id given in the entity declaration and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1007	may be null. The system id is the system identifier specified in the entity
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1008	declaration and is never null.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1009
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1010	<p>There are a couple of ways in which this handler differs from others.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1011	First, this handler returns an integer. A non-zero value should be returned
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1012	for successful handling of the external entity reference. Returning a zero
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1013	indicates failure, and causes the calling parser to return
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1014	an <code>XML_ERROR_EXTERNAL_ENTITY_HANDLING</code> error.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1015
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1016	<p>Second, instead of having userData as its first argument, it receives the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1017	parser that encountered the entity reference. This, along with the context
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1018	parameter, may be used as arguments to a call to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1019	<a href="#XML_ExternalEntityParserCreate">XML_ExternalEntityParserCreate</a>.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1020	Using the returned parser, the body of the external entity can be recursively
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1021	parsed.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1022
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1023	<p>Since this handler may be called recursively, it should not be saving
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1024	information into global or static variables.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1025	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1026
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1027	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1028	<pre class="setter" id="XML_SetSkippedEntityHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1029	XML_SetSkippedEntityHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1030	XML_SkippedEntityHandler handler)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1031	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1032	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1033	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1034	(XML_SkippedEntityHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1035	const XML_Char *entityName,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1036	int is_parameter_entity);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1037	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1038	<p>Set a skipped entity handler. This is called in two situations:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1039	<ol>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1040	<li>An entity reference is encountered for which no declaration
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1041	has been read <em>and</em> this is not an error.</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1042	<li>An internal entity reference is read, but not expanded, because
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1043	<a href="#XML_SetDefaultHandler"><code>XML_SetDefaultHandler</code></a>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1044	has been called.</li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1045	</ol>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1046	<p>The <code>is_parameter_entity</code> argument will be non-zero for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1047	a parameter entity and zero for a general entity.</p> <p>Note: skipped
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1048	parameter entities in declarations and skipped general entities in
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1049	attribute values cannot be reported, because the event would be out of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1050	sync with the reporting of the declarations or attribute values</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1051	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1052
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1053	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1054	<pre class="setter" id="XML_SetUnknownEncodingHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1055	XML_SetUnknownEncodingHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1056	XML_UnknownEncodingHandler enchandler,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1057	void *encodingHandlerData)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1058	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1059	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1060	typedef int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1061	(XML_UnknownEncodingHandler)(void encodingHandlerData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1062	const XML_Char *name,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1063	XML_Encoding *info);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1064
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1065	typedef struct {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1066	int map[256];
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1067	void *data;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1068	int (convert)(void data, const char *s);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1069	void (release)(void data);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1070	} XML_Encoding;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1071	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1072	<p>Set a handler to deal with encodings other than the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1073	<a href="#builtin_encodings">built in set</a>. This should be done before
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1074	<code><a href= "#XML_Parse" >XML_Parse</a></code> or <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1075	"#XML_ParseBuffer" >XML_ParseBuffer</a></code> have been called on the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1076	given parser.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1077	<p>If the handler knows how to deal with an encoding with the given
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1078	name, it should fill in the <code>info</code> data structure and return
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1079	1. Otherwise it should return 0. The handler will be called at most
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1080	once per parsed (external) entity. The optional application data
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1081	pointer <code>encodingHandlerData</code> will be passed back to the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1082	handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1083
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1084	<p>The map array contains information for every possible possible leading
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1085	byte in a byte sequence. If the corresponding value is >= 0, then it's
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1086	a single byte sequence and the byte encodes that Unicode value. If the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1087	value is -1, then that byte is invalid as the initial byte in a sequence.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1088	If the value is -n, where n is an integer > 1, then n is the number of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1089	bytes in the sequence and the actual conversion is accomplished by a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1090	call to the function pointed at by convert. This function may return -1
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1091	if the sequence itself is invalid. The convert pointer may be null if
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1092	there are only single byte codes. The data parameter passed to the convert
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1093	function is the data pointer from <code>XML_Encoding</code>. The
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1094	string s is <em>NOT</em> nul-terminated and points at the sequence of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1095	bytes to be converted.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1096
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1097	<p>The function pointed at by <code>release</code> is called by the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1098	parser when it is finished with the encoding. It may be NULL.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1099	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1100
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1101	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1102	<pre class="setter" id="XML_SetStartNamespaceDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1103	XML_SetStartNamespaceDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1104	XML_StartNamespaceDeclHandler start);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1105	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1106	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1107	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1108	(XML_StartNamespaceDeclHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1109	const XML_Char *prefix,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1110	const XML_Char *uri);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1111	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1112	<p>Set a handler to be called when a namespace is declared. Namespace
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1113	declarations occur inside start tags. But the namespace declaration start
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1114	handler is called before the start tag handler for each namespace declared
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1115	in that start tag.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1116	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1117
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1118	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1119	<pre class="setter" id="XML_SetEndNamespaceDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1120	XML_SetEndNamespaceDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1121	XML_EndNamespaceDeclHandler end);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1122	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1123	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1124	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1125	(XML_EndNamespaceDeclHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1126	const XML_Char *prefix);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1127	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1128	<p>Set a handler to be called when leaving the scope of a namespace
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1129	declaration. This will be called, for each namespace declaration,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1130	after the handler for the end tag of the element in which the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1131	namespace was declared.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1132	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1133
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1134	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1135	<pre class="setter" id="XML_SetNamespaceDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1136	XML_SetNamespaceDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1137	XML_StartNamespaceDeclHandler start,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1138	XML_EndNamespaceDeclHandler end)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1139	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1140	<p>Sets both namespace declaration handlers with a single call</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1141	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1142
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1143	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1144	<pre class="setter" id="XML_SetXmlDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1145	XML_SetXmlDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1146	XML_XmlDeclHandler xmldecl);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1147	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1148	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1149	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1150	(XML_XmlDeclHandler) (void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1151	const XML_Char *version,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1152	const XML_Char *encoding,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1153	int standalone);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1154	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1155	<p>Sets a handler that is called for XML declarations and also for
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1156	text declarations discovered in external entities. The way to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1157	distinguish is that the <code>version</code> parameter will be NULL
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1158	for text declarations. The <code>encoding</code> parameter may be NULL
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1159	for an XML declaration. The <code>standalone</code> argument will
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1160	contain -1, 0, or 1 indicating respectively that there was no
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1161	standalone parameter in the declaration, that it was given as no, or
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1162	that it was given as yes.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1163	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1164
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1165	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1166	<pre class="setter" id="XML_SetStartDoctypeDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1167	XML_SetStartDoctypeDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1168	XML_StartDoctypeDeclHandler start);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1169	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1170	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1171	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1172	(XML_StartDoctypeDeclHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1173	const XML_Char *doctypeName,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1174	const XML_Char *sysid,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1175	const XML_Char *pubid,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1176	int has_internal_subset);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1177	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1178	<p>Set a handler that is called at the start of a DOCTYPE declaration,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1179	before any external or internal subset is parsed. Both <code>sysid</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1180	and <code>pubid</code> may be NULL. The <code>has_internal_subset</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1181	will be non-zero if the DOCTYPE declaration has an internal subset.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1182	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1183
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1184	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1185	<pre class="setter" id="XML_SetEndDoctypeDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1186	XML_SetEndDoctypeDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1187	XML_EndDoctypeDeclHandler end);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1188	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1189	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1190	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1191	(XML_EndDoctypeDeclHandler)(void userData);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1192	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1193	<p>Set a handler that is called at the end of a DOCTYPE declaration,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1194	after parsing any external subset.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1195	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1196
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1197	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1198	<pre class="setter" id="XML_SetDoctypeDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1199	XML_SetDoctypeDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1200	XML_StartDoctypeDeclHandler start,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1201	XML_EndDoctypeDeclHandler end);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1202	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1203	<p>Set both doctype handlers with one call.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1204	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1205
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1206	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1207	<pre class="setter" id="XML_SetElementDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1208	XML_SetElementDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1209	XML_ElementDeclHandler eldecl);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1210	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1211	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1212	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1213	(XML_ElementDeclHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1214	const XML_Char *name,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1215	XML_Content *model);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1216	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1217	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1218	enum XML_Content_Type {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1219	XML_CTYPE_EMPTY = 1,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1220	XML_CTYPE_ANY,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1221	XML_CTYPE_MIXED,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1222	XML_CTYPE_NAME,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1223	XML_CTYPE_CHOICE,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1224	XML_CTYPE_SEQ
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1225	};
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1226
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1227	enum XML_Content_Quant {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1228	XML_CQUANT_NONE,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1229	XML_CQUANT_OPT,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1230	XML_CQUANT_REP,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1231	XML_CQUANT_PLUS
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1232	};
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1233
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1234	typedef struct XML_cp XML_Content;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1235
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1236	struct XML_cp {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1237	enum XML_Content_Type type;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1238	enum XML_Content_Quant quant;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1239	const XML_Char * name;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1240	unsigned int numchildren;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1241	XML_Content * children;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1242	};
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1243	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1244	<p>Sets a handler for element declarations in a DTD. The handler gets
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1245	called with the name of the element in the declaration and a pointer
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1246	to a structure that contains the element model. It is the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1247	application's responsibility to free this data structure.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1248
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1249	<p>The <code>model</code> argument is the root of a tree of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1250	<code>XML_Content</code> nodes. If <code>type</code> equals
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1251	<code>XML_CTYPE_EMPTY</code> or <code>XML_CTYPE_ANY</code>, then
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1252	<code>quant</code> will be <code>XML_CQUANT_NONE</code>, and the other
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1253	fields will be zero or NULL. If <code>type</code> is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1254	<code>XML_CTYPE_MIXED</code>, then <code>quant</code> will be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1255	<code>XML_CQUANT_NONE</code> or <code>XML_CQUANT_REP</code> and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1256	<code>numchildren</code> will contain the number of elements that are
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1257	allowed to be mixed in and <code>children</code> points to an array of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1258	<code>XML_Content</code> structures that will all have type
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1259	XML_CTYPE_NAME with no quantification. Only the root node can be type
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1260	<code>XML_CTYPE_EMPTY</code>, <code>XML_CTYPE_ANY</code>, or
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1261	<code>XML_CTYPE_MIXED</code>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1262
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1263	<p>For type <code>XML_CTYPE_NAME</code>, the <code>name</code> field
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1264	points to the name and the <code>numchildren</code> and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1265	<code>children</code> fields will be zero and NULL. The
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1266	<code>quant</code> field will indicate any quantifiers placed on the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1267	name.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1268
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1269	<p>Types <code>XML_CTYPE_CHOICE</code> and <code>XML_CTYPE_SEQ</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1270	indicate a choice or sequence respectively. The
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1271	<code>numchildren</code> field indicates how many nodes in the choice
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1272	or sequence and <code>children</code> points to the nodes.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1273	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1274
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1275	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1276	<pre class="setter" id="XML_SetAttlistDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1277	XML_SetAttlistDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1278	XML_AttlistDeclHandler attdecl);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1279	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1280	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1281	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1282	(XML_AttlistDeclHandler) (void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1283	const XML_Char *elname,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1284	const XML_Char *attname,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1285	const XML_Char *att_type,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1286	const XML_Char *dflt,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1287	int isrequired);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1288	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1289	<p>Set a handler for attlist declarations in the DTD. This handler is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1290	called for <em>each</em> attribute. So a single attlist declaration
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1291	with multiple attributes declared will generate multiple calls to this
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1292	handler. The <code>elname</code> parameter returns the name of the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1293	element for which the attribute is being declared. The attribute name
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1294	is in the <code>attname</code> parameter. The attribute type is in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1295	<code>att_type</code> parameter. It is the string representing the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1296	type in the declaration with whitespace removed.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1297
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1298	<p>The <code>dflt</code> parameter holds the default value. It will be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1299	NULL in the case of "#IMPLIED" or "#REQUIRED" attributes. You can
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1300	distinguish these two cases by checking the <code>isrequired</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1301	parameter, which will be true in the case of "#REQUIRED" attributes.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1302	Attributes which are "#FIXED" will have also have a true
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1303	<code>isrequired</code>, but they will have the non-NULL fixed value
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1304	in the <code>dflt</code> parameter.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1305	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1306
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1307	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1308	<pre class="setter" id="XML_SetEntityDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1309	XML_SetEntityDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1310	XML_EntityDeclHandler handler);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1311	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1312	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1313	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1314	(XML_EntityDeclHandler) (void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1315	const XML_Char *entityName,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1316	int is_parameter_entity,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1317	const XML_Char *value,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1318	int value_length,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1319	const XML_Char *base,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1320	const XML_Char *systemId,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1321	const XML_Char *publicId,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1322	const XML_Char *notationName);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1323	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1324	<p>Sets a handler that will be called for all entity declarations.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1325	The <code>is_parameter_entity</code> argument will be non-zero in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1326	case of parameter entities and zero otherwise.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1327
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1328	<p>For internal entities (<code><!ENTITY foo "bar"></code>),
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1329	<code>value</code> will be non-NULL and <code>systemId</code>,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1330	<code>publicId</code>, and <code>notationName</code> will all be NULL.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1331	The value string is <em>not</em> NULL terminated; the length is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1332	provided in the <code>value_length</code> parameter. Do not use
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1333	<code>value_length</code> to test for internal entities, since it is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1334	legal to have zero-length values. Instead check for whether or not
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1335	<code>value</code> is NULL.</p> <p>The <code>notationName</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1336	argument will have a non-NULL value only for unparsed entity
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1337	declarations.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1338	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1339
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1340	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1341	<pre class="setter" id="XML_SetUnparsedEntityDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1342	XML_SetUnparsedEntityDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1343	XML_UnparsedEntityDeclHandler h)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1344	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1345	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1346	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1347	(XML_UnparsedEntityDeclHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1348	const XML_Char *entityName,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1349	const XML_Char *base,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1350	const XML_Char *systemId,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1351	const XML_Char *publicId,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1352	const XML_Char *notationName);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1353	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1354	<p>Set a handler that receives declarations of unparsed entities. These
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1355	are entity declarations that have a notation (NDATA) field:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1356
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1357	<div id="eg"><pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1358	<!ENTITY logo SYSTEM "images/logo.gif" NDATA gif>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1359	</pre></div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1360	<p>This handler is obsolete and is provided for backwards
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1361	compatibility. Use instead <a href= "#XML_SetEntityDeclHandler"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1362	>XML_SetEntityDeclHandler</a>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1363	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1364
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1365	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1366	<pre class="setter" id="XML_SetNotationDeclHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1367	XML_SetNotationDeclHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1368	XML_NotationDeclHandler h)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1369	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1370	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1371	typedef void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1372	(XML_NotationDeclHandler)(void userData,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1373	const XML_Char *notationName,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1374	const XML_Char *base,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1375	const XML_Char *systemId,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1376	const XML_Char *publicId);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1377	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1378	<p>Set a handler that receives notation declarations.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1379	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1380
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1381	<div class="handler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1382	<pre class="setter" id="XML_SetNotStandaloneHandler">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1383	XML_SetNotStandaloneHandler(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1384	XML_NotStandaloneHandler h)
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1385	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1386	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1387	typedef int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1388	(XML_NotStandaloneHandler)(void userData);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1389	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1390	<p>Set a handler that is called if the document is not "standalone".
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1391	This happens when there is an external subset or a reference to a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1392	parameter entity, but does not have standalone set to "yes" in an XML
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1393	declaration. If this handler returns 0, then the parser will throw an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1394	<code>XML_ERROR_NOT_STANDALONE</code> error.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1395	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1396
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1397	<h3><a name="position">Parse position and error reporting functions</a></h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1398
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1399	<p>These are the functions you'll want to call when the parse
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1400	functions return 0 (i.e. a parse error has ocurred), although the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1401	position reporting functions are useful outside of errors. The
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1402	position reported is the byte position (in the original document or
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1403	entity encoding) of the first of the sequence of characters that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1404	generated the current event (or the error that caused the parse
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1405	functions to return 0.)</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1406
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1407	<p>The position reporting functions are accurate only outside of the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1408	DTD. In other words, they usually return bogus information when
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1409	called from within a DTD declaration handler.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1410
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1411	<pre class="fcndec" id="XML_GetErrorCode">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1412	enum XML_Error
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1413	XML_GetErrorCode(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1414	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1415	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1416	Return what type of error has occurred.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1417	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1418
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1419	<pre class="fcndec" id="XML_ErrorString">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1420	const XML_LChar *
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1421	XML_ErrorString(int code);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1422	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1423	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1424	Return a string describing the error corresponding to code.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1425	The code should be one of the enums that can be returned from
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1426	<code><a href= "#XML_GetErrorCode" >XML_GetErrorCode</a></code>.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1427	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1428
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1429	<pre class="fcndec" id="XML_GetCurrentByteIndex">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1430	long
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1431	XML_GetCurrentByteIndex(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1432	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1433	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1434	Return the byte offset of the position.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1435	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1436
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1437	<pre class="fcndec" id="XML_GetCurrentLineNumber">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1438	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1439	XML_GetCurrentLineNumber(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1440	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1441	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1442	Return the line number of the position.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1443	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1444
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1445	<pre class="fcndec" id="XML_GetCurrentColumnNumber">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1446	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1447	XML_GetCurrentColumnNumber(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1448	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1449	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1450	Return the offset, from the beginning of the current line, of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1451	the position.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1452	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1453
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1454	<pre class="fcndec" id="XML_GetCurrentByteCount">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1455	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1456	XML_GetCurrentByteCount(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1457	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1458	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1459	Return the number of bytes in the current event. Returns
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1460	<code>0</code> if the event is inside a reference to an internal
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1461	entity and for the end-tag event for empty element tags (the later can
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1462	be used to distinguish empty-element tags from empty elements using
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1463	separate start and end tags).
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1464	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1465
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1466	<pre class="fcndec" id="XML_GetInputContext">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1467	const char *
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1468	XML_GetInputContext(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1469	int *offset,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1470	int *size);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1471	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1472	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1473
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1474	<p>Returns the parser's input buffer, sets the integer pointed at by
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1475	<code>offset</code> to the offset within this buffer of the current
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1476	parse position, and set the integer pointed at by <code>size</code> to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1477	the size of the returned buffer.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1478
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1479	<p>This should only be called from within a handler during an active
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1480	parse and the returned buffer should only be referred to from within
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1481	the handler that made the call. This input buffer contains the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1482	untranslated bytes of the input.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1483
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1484	<p>Only a limited amount of context is kept, so if the event
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1485	triggering a call spans over a very large amount of input, the actual
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1486	parse position may be before the beginning of the buffer.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1487	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1488
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1489	<h3><a name="miscellaneous">Miscellaneous functions</a></h3>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1490
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1491	<p>The functions in this section either obtain state information from
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1492	the parser or can be used to dynamicly set parser options.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1493
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1494	<pre class="fcndec" id="XML_SetUserData">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1495	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1496	XML_SetUserData(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1497	void *userData);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1498	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1499	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1500	This sets the user data pointer that gets passed to handlers. It
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1501	overwrites any previous value for this pointer. Note that the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1502	application is responsible for freeing the memory associated with
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1503	<code>userData</code> when it is finished with the parser. So if you
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1504	call this when there's already a pointer there, and you haven't freed
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1505	the memory associated with it, then you've probably just leaked
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1506	memory.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1507	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1508
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1509	<pre class="fcndec" id="XML_GetUserData">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1510	void *
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1511	XML_GetUserData(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1512	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1513	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1514	This returns the user data pointer that gets passed to handlers.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1515	It is actually implemented as a macro.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1516	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1517
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1518	<pre class="fcndec" id="XML_UseParserAsHandlerArg">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1519	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1520	XML_UseParserAsHandlerArg(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1521	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1522	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1523	After this is called, handlers receive the parser in the userData
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1524	argument. The userData information can still be obtained using the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1525	<code><a href= "#XML_GetUserData" >XML_GetUserData</a></code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1526	function.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1527	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1528
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1529	<pre class="fcndec" id="XML_SetBase">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1530	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1531	XML_SetBase(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1532	const XML_Char *base);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1533	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1534	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1535	Set the base to be used for resolving relative URIs in system
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1536	identifiers. The return value is 0 if there's no memory to store
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1537	base, otherwise it's non-zero.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1538	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1539
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1540	<pre class="fcndec" id="XML_GetBase">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1541	const XML_Char *
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1542	XML_GetBase(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1543	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1544	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1545	Return the base for resolving relative URIs.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1546	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1547
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1548	<pre class="fcndec" id="XML_GetSpecifiedAttributeCount">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1549	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1550	XML_GetSpecifiedAttributeCount(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1551	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1552	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1553	When attributes are reported to the start handler in the atts vector,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1554	attributes that were explicitly set in the element occur before any
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1555	attributes that receive their value from default information in an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1556	ATTLIST declaration. This function returns the number of attributes
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1557	that were explicitly set times two, thus giving the offset in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1558	<code>atts</code> array passed to the start tag handler of the first
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1559	attribute set due to defaults. It supplies information for the last
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1560	call to a start handler. If called inside a start handler, then that
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1561	means the current call.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1562	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1563
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1564	<pre class="fcndec" id="XML_GetIdAttributeIndex">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1565	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1566	XML_GetIdAttributeIndex(XML_Parser p);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1567	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1568	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1569	Returns the index of the ID attribute passed in the atts array in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1570	last call to <code><a href= "#XML_StartElementHandler"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1571	>XML_StartElementHandler</a></code>, or -1 if there is no ID
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1572	attribute. If called inside a start handler, then that means the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1573	current call.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1574	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1575
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1576	<pre class="fcndec" id="XML_SetEncoding">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1577	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1578	XML_SetEncoding(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1579	const XML_Char *encoding);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1580	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1581	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1582	Set the encoding to be used by the parser. It is equivalent to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1583	passing a non-null encoding argument to the parser creation functions.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1584	It must not be called after <code><a href= "#XML_Parse"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1585	>XML_Parse</a></code> or <code><a href= "#XML_ParseBuffer"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1586	>XML_ParseBuffer</a></code> have been called on the given parser.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1587	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1588
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1589	<pre class="fcndec" id="XML_SetParamEntityParsing">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1590	int
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1591	XML_SetParamEntityParsing(XML_Parser p,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1592	enum XML_ParamEntityParsing code);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1593	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1594	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1595	This enables parsing of parameter entities, including the external
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1596	parameter entity that is the external DTD subset, according to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1597	<code>code</code>.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1598	The choices for <code>code</code> are:
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1599	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1600	<li><code>XML_PARAM_ENTITY_PARSING_NEVER</code></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1601	<li><code>XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE</code></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1602	<li><code>XML_PARAM_ENTITY_PARSING_ALWAYS</code></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1603	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1604	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1605
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1606	<pre class="fcndec" id="XML_UseForeignDTD">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1607	enum XML_Error
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1608	XML_UseForeignDTD(XML_Parser parser, XML_Bool useDTD);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1609	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1610	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1611	<p>This function allows an application to provide an external subset
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1612	for the document type declaration for documents which do not specify
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1613	an external subset of their own. For documents which specify an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1614	external subset in their DOCTYPE declaration, the application-provided
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1615	subset will be ignored. If the document does not contain a DOCTYPE
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1616	declaration at all and <code>useDTD</code> is true, the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1617	application-provided subset will be parsed, but the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1618	<code>startDoctypeDeclHandler</code> and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1619	<code>endDoctypeDeclHandler</code> functions, if set, will not be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1620	called. The setting of parameter entity parsing, controlled using
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1621	<code><a href= "#XML_SetParamEntityParsing"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1622	>XML_SetParamEntityParsing</a></code>, will be honored.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1623
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1624	<p>The application-provided external subset is read by calling the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1625	external entity reference handler set via <code><a href=
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1626	"#XML_SetExternalEntityRefHandler"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1627	>XML_SetExternalEntityRefHandler</a></code> with both
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1628	<code>publicId</code> and <code>systemId</code> set to NULL.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1629
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1630	<p>If this function is called after parsing has begun, it returns
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1631	<code>XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING</code> and ignores
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1632	<code>useDTD</code>. If called when Expat has been compiled without
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1633	DTD support, it returns
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1634	<code>XML_ERROR_FEATURE_REQUIRES_XML_DTD</code>. Otherwise, it
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1635	returns <code>XML_ERROR_NONE</code>.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1636	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1637
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1638	<pre class="fcndec" id="XML_SetReturnNSTriplet">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1639	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1640	XML_SetReturnNSTriplet(XML_Parser parser,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1641	int do_nst);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1642	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1643	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1644	<p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1645	This function only has an effect when using a parser created with
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1646	<code><a href= "#XML_ParserCreateNS" >XML_ParserCreateNS</a></code>,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1647	i.e. when namespace processing is in effect. The <code>do_nst</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1648	sets whether or not prefixes are returned with names qualified with a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1649	namespace prefix. If this function is called with <code>do_nst</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1650	non-zero, then afterwards namespace qualified names (that is qualified
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1651	with a prefix as opposed to belonging to a default namespace) are
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1652	returned as a triplet with the three parts separated by the namespace
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1653	separator specified when the parser was created. The order of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1654	returned parts is URI, local name, and prefix.</p> <p>If
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1655	<code>do_nst</code> is zero, then namespaces are reported in the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1656	default manner, URI then local_name separated by the namespace
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1657	separator.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1658	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1659
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1660	<pre class="fcndec" id="XML_DefaultCurrent">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1661	void
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1662	XML_DefaultCurrent(XML_Parser parser);
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1663	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1664	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1665	This can be called within a handler for a start element, end element,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1666	processing instruction or character data. It causes the corresponding
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1667	markup to be passed to the default handler set by <code><a
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1668	href="#XML_SetDefaultHandler" >XML_SetDefaultHandler</a></code> or
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1669	<code><a href="#XML_SetDefaultHandlerExpand"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1670	>XML_SetDefaultHandlerExpand</a></code>. It does nothing if there is
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1671	not a default handler.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1672	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1673
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1674	<pre class="fcndec" id="XML_ExpatVersion">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1675	XML_LChar *
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1676	XML_ExpatVersion();
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1677	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1678	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1679	Return the library version as a string (e.g. <code>"expat_1.95.1"</code>).
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1680	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1681
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1682	<pre class="fcndec" id="XML_ExpatVersionInfo">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1683	struct XML_Expat_Version
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1684	XML_ExpatVersionInfo();
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1685	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1686	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1687	typedef struct {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1688	int major;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1689	int minor;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1690	int micro;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1691	} XML_Expat_Version;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1692	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1693	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1694	Return the library version information as a structure.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1695	Some macros are also defined that support compile-time tests of the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1696	library version:
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1697	<ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1698	<li><code>XML_MAJOR_VERSION</code></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1699	<li><code>XML_MINOR_VERSION</code></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1700	<li><code>XML_MICRO_VERSION</code></li>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1701	</ul>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1702	Testing these constants is currently the best way to determine if
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1703	particular parts of the Expat API are available.
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1704	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1705
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1706	<pre class="fcndec" id="XML_GetFeatureList">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1707	const XML_Feature *
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1708	XML_GetFeatureList();
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1709	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1710	<pre class="signature">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1711	enum XML_FeatureEnum {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1712	XML_FEATURE_END = 0,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1713	XML_FEATURE_UNICODE,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1714	XML_FEATURE_UNICODE_WCHAR_T,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1715	XML_FEATURE_DTD,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1716	XML_FEATURE_CONTEXT_BYTES,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1717	XML_FEATURE_MIN_SIZE,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1718	XML_FEATURE_SIZEOF_XML_CHAR,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1719	XML_FEATURE_SIZEOF_XML_LCHAR
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1720	};
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1721
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1722	typedef struct {
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1723	enum XML_FeatureEnum feature;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1724	XML_LChar *name;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1725	long int value;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1726	} XML_Feature;
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1727	</pre>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1728	<div class="fcndef">
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1729	<p>Returns a list of "feature" records, providing details on how
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1730	Expat was configured at compile time. Most applications should not
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1731	need to worry about this, but this information is otherwise not
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1732	available from Expat. This function allows code that does need to
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1733	check these features to do so at runtime.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1734
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1735	<p>The return value is an array of <code>XML_Feature</code>,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1736	terminated by a record with a <code>feature</code> of
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1737	<code>XML_FEATURE_END</code> and <code>name</code> of NULL,
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1738	identifying the feature-test macros Expat was compiled with. Since an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1739	application that requires this kind of information needs to determine
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1740	the type of character the <code>name</code> points to, records for the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1741	<code>XML_FEATURE_SIZEOF_XML_CHAR</code> and
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1742	<code>XML_FEATURE_SIZEOF_XML_LCHAR</code> will be located at the
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1743	beginning of the list, followed by <code>XML_FEATURE_UNICODE</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1744	and <code>XML_FEATURE_UNICODE_WCHAR_T</code>, if they are present at
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1745	all.</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1746
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1747	<p>Some features have an associated value. If there isn't an
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1748	associated value, the <code>value</code> field is set to 0. At this
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1749	time, the following features have been defined to have values:</p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1750
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1751	<dl>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1752	<dt><code>XML_FEATURE_SIZEOF_XML_CHAR</code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1753	<dd>The number of bytes occupied by one <code>XML_Char</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1754	character.</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1755	<dt><code>XML_FEATURE_SIZEOF_XML_LCHAR</code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1756	<dd>The number of bytes occupied by one <code>XML_LChar</code>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1757	character.</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1758	<dt><code>XML_FEATURE_CONTEXT_BYTES</code></dt>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1759	<dd>The maximum number of characters of context which can be
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1760	reported by <code><a href= "#XML_GetInputContext"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1761	>XML_GetInputContext</a></code>.</dd>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1762	</dl>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1763	</div>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1764
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1765	<hr />
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1766	<p><a href="http://validator.w3.org/check/referer"><img
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1767	src="valid-xhtml10.png" alt="Valid XHTML 1.0!"
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1768	height="31" width="88" class="noborder" /></a></p>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1769	</body>
6b9cbc8ad81c Revision: 201014 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1770	</html>

author	Pat Downey <patd@symbian.org>
	Wed, 01 Sep 2010 12:37:34 +0100
branch	RCL_3
changeset 21	604ca70b6235
parent 15	6b9cbc8ad81c
permissions	-rw-r--r--