Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / libxml2 / d7cec926292b83b46af271285b0a305e99f66cd0 / . / doc / html / libxml-parserInternals.html
blob: 0053ba4635f95bce6d97dfb790117da9bc4649de [file] [log] [blame]
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>parserInternals</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
2 .synopsis, .classsynopsis {
3 background: #eeeeee;
4 border: solid 1px #aaaaaa;
5 padding: 0.5em;
6 }
7 .programlisting {
8 background: #eeeeff;
9 border: solid 1px #aaaaff;
10 padding: 0.5em;
11 }
12 .variablelist {
13 padding: 4px;
14 margin-left: 3em;
15 }
16 .navigation {
17 background: #ffeeee;
18 border: solid 1px #ffaaaa;
19 margin-top: 0.5em;
20 margin-bottom: 0.5em;
21 }
22 .navigation a {
23 color: #770000;
24 }
25 .navigation a:visited {
26 color: #550000;
27 }
28 .navigation .title {
29 font-size: 200%;
30 }
31 </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="libxml-lib.html" title="Libxml Library Reference"><link rel="previous" href="libxml-DOCBparser.html" title="DOCBparser"><link rel="next" href="libxml-encoding.html" title="encoding"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-DOCBparser.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="libxml-lib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-encoding.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-parserInternals"></a><div class="titlepage"></div><div class="refnamediv"><h2>parserInternals</h2><p>parserInternals &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
32
33
34
35#define <a href="libxml-parserInternals.html#XML-MAX-NAMELEN-CAPS">XML_MAX_NAMELEN</a>
36#define <a href="libxml-parserInternals.html#INPUT-CHUNK-CAPS">INPUT_CHUNK</a>
37#define <a href="libxml-parserInternals.html#IS-CHAR-CAPS">IS_CHAR</a> (c)
38#define <a href="libxml-parserInternals.html#IS-BLANK-CAPS">IS_BLANK</a> (c)
39#define <a href="libxml-parserInternals.html#IS-BASECHAR-CAPS">IS_BASECHAR</a> (c)
40#define <a href="libxml-parserInternals.html#IS-DIGIT-CAPS">IS_DIGIT</a> (c)
41#define <a href="libxml-parserInternals.html#IS-COMBINING-CAPS">IS_COMBINING</a> (c)
42#define <a href="libxml-parserInternals.html#IS-EXTENDER-CAPS">IS_EXTENDER</a> (c)
43#define <a href="libxml-parserInternals.html#IS-IDEOGRAPHIC-CAPS">IS_IDEOGRAPHIC</a> (c)
44#define <a href="libxml-parserInternals.html#IS-LETTER-CAPS">IS_LETTER</a> (c)
45#define <a href="libxml-parserInternals.html#IS-PUBIDCHAR-CAPS">IS_PUBIDCHAR</a> (c)
46#define <a href="libxml-parserInternals.html#SKIP-EOL-CAPS">SKIP_EOL</a> (p)
47#define <a href="libxml-parserInternals.html#MOVETO-ENDTAG-CAPS">MOVETO_ENDTAG</a> (p)
48#define <a href="libxml-parserInternals.html#MOVETO-STARTTAG-CAPS">MOVETO_STARTTAG</a> (p)
49int <a href="libxml-parserInternals.html#xmlIsBaseChar">xmlIsBaseChar</a> (int c);
50int <a href="libxml-parserInternals.html#xmlIsBlank">xmlIsBlank</a> (int c);
51int <a href="libxml-parserInternals.html#xmlIsPubidChar">xmlIsPubidChar</a> (int c);
52int <a href="libxml-parserInternals.html#xmlIsLetter">xmlIsLetter</a> (int c);
53int <a href="libxml-parserInternals.html#xmlIsDigit">xmlIsDigit</a> (int c);
54int <a href="libxml-parserInternals.html#xmlIsIdeographic">xmlIsIdeographic</a> (int c);
55int <a href="libxml-parserInternals.html#xmlIsExtender">xmlIsExtender</a> (int c);
56int <a href="libxml-parserInternals.html#xmlIsCombining">xmlIsCombining</a> (int c);
57int <a href="libxml-parserInternals.html#xmlIsChar">xmlIsChar</a> (int c);
58<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="libxml-parserInternals.html#xmlCreateFileParserCtxt">xmlCreateFileParserCtxt</a> (const char *filename);
59<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="libxml-parserInternals.html#xmlCreateMemoryParserCtxt">xmlCreateMemoryParserCtxt</a> (const char *buffer,
60 int size);
61<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="libxml-parserInternals.html#xmlNewParserCtxt">xmlNewParserCtxt</a> (void);
62<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> <a href="libxml-parserInternals.html#xmlCreateEntityParserCtxt">xmlCreateEntityParserCtxt</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL,
63 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ID,
64 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *base);
65int <a href="libxml-parserInternals.html#xmlSwitchEncoding">xmlSwitchEncoding</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
66 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);
67int <a href="libxml-parserInternals.html#xmlSwitchToEncoding">xmlSwitchToEncoding</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
68 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> handler);
69void <a href="libxml-parserInternals.html#xmlHandleEntity">xmlHandleEntity</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
70 <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity);
71<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-parserInternals.html#xmlNewStringInputStream">xmlNewStringInputStream</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
72 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *buffer);
73<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-parserInternals.html#xmlNewEntityInputStream">xmlNewEntityInputStream</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
74 <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity);
75void <a href="libxml-parserInternals.html#xmlPushInput">xmlPushInput</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
76 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> input);
77<a href="libxml-tree.html#xmlChar">xmlChar</a> <a href="libxml-parserInternals.html#xmlPopInput">xmlPopInput</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
78void <a href="libxml-parserInternals.html#xmlFreeInputStream">xmlFreeInputStream</a> (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> input);
79<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-parserInternals.html#xmlNewInputFromFile">xmlNewInputFromFile</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
80 const char *filename);
81<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-parserInternals.html#xmlNewInputStream">xmlNewInputStream</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
82<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlSplitQName">xmlSplitQName</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
83 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,
84 <a href="libxml-tree.html#xmlChar">xmlChar</a> **prefix);
85<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlNamespaceParseNCName">xmlNamespaceParseNCName</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
86<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlNamespaceParseQName">xmlNamespaceParseQName</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
87 <a href="libxml-tree.html#xmlChar">xmlChar</a> **prefix);
88<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlNamespaceParseNSDef">xmlNamespaceParseNSDef</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
89<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseQuotedString">xmlParseQuotedString</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
90void <a href="libxml-parserInternals.html#xmlParseNamespace">xmlParseNamespace</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
91<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlScanName">xmlScanName</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
92<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseName">xmlParseName</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
93<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseNmtoken">xmlParseNmtoken</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
94<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseEntityValue">xmlParseEntityValue</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
95 <a href="libxml-tree.html#xmlChar">xmlChar</a> **orig);
96<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseAttValue">xmlParseAttValue</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
97<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseSystemLiteral">xmlParseSystemLiteral</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
98<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParsePubidLiteral">xmlParsePubidLiteral</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
99void <a href="libxml-parserInternals.html#xmlParseCharData">xmlParseCharData</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
100 int cdata);
101<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseExternalID">xmlParseExternalID</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
102 <a href="libxml-tree.html#xmlChar">xmlChar</a> **publicID,
103 int strict);
104void <a href="libxml-parserInternals.html#xmlParseComment">xmlParseComment</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
105<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParsePITarget">xmlParsePITarget</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
106void <a href="libxml-parserInternals.html#xmlParsePI">xmlParsePI</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
107void <a href="libxml-parserInternals.html#xmlParseNotationDecl">xmlParseNotationDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
108void <a href="libxml-parserInternals.html#xmlParseEntityDecl">xmlParseEntityDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
109int <a href="libxml-parserInternals.html#xmlParseDefaultDecl">xmlParseDefaultDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
110 <a href="libxml-tree.html#xmlChar">xmlChar</a> **value);
111<a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> <a href="libxml-parserInternals.html#xmlParseNotationType">xmlParseNotationType</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
112<a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> <a href="libxml-parserInternals.html#xmlParseEnumerationType">xmlParseEnumerationType</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
113int <a href="libxml-parserInternals.html#xmlParseEnumeratedType">xmlParseEnumeratedType</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
114 <a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> *tree);
115int <a href="libxml-parserInternals.html#xmlParseAttributeType">xmlParseAttributeType</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
116 <a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> *tree);
117void <a href="libxml-parserInternals.html#xmlParseAttributeListDecl">xmlParseAttributeListDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
118<a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> <a href="libxml-parserInternals.html#xmlParseElementMixedContentDecl">xmlParseElementMixedContentDecl</a>
119 (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
120 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> inputchk);
121<a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> <a href="libxml-parserInternals.html#xmlParseElementChildrenContentDecl">xmlParseElementChildrenContentDecl</a>
122 (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
123 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> inputchk);
124int <a href="libxml-parserInternals.html#xmlParseElementContentDecl">xmlParseElementContentDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
125 <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,
126 <a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> *result);
127int <a href="libxml-parserInternals.html#xmlParseElementDecl">xmlParseElementDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
128void <a href="libxml-parserInternals.html#xmlParseMarkupDecl">xmlParseMarkupDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
129int <a href="libxml-parserInternals.html#xmlParseCharRef">xmlParseCharRef</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
130<a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> <a href="libxml-parserInternals.html#xmlParseEntityRef">xmlParseEntityRef</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
131void <a href="libxml-parserInternals.html#xmlParseReference">xmlParseReference</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
132void <a href="libxml-parserInternals.html#xmlParsePEReference">xmlParsePEReference</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
133void <a href="libxml-parserInternals.html#xmlParseDocTypeDecl">xmlParseDocTypeDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
134<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseAttribute">xmlParseAttribute</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
135 <a href="libxml-tree.html#xmlChar">xmlChar</a> **value);
136<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseStartTag">xmlParseStartTag</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
137void <a href="libxml-parserInternals.html#xmlParseEndTag">xmlParseEndTag</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
138void <a href="libxml-parserInternals.html#xmlParseCDSect">xmlParseCDSect</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
139void <a href="libxml-parserInternals.html#xmlParseContent">xmlParseContent</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
140void <a href="libxml-parserInternals.html#xmlParseElement">xmlParseElement</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
141<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseVersionNum">xmlParseVersionNum</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
142<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseVersionInfo">xmlParseVersionInfo</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
143<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseEncName">xmlParseEncName</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
144<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlParseEncodingDecl">xmlParseEncodingDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
145int <a href="libxml-parserInternals.html#xmlParseSDDecl">xmlParseSDDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
146void <a href="libxml-parserInternals.html#xmlParseXMLDecl">xmlParseXMLDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
147void <a href="libxml-parserInternals.html#xmlParseTextDecl">xmlParseTextDecl</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
148void <a href="libxml-parserInternals.html#xmlParseMisc">xmlParseMisc</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
149void <a href="libxml-parserInternals.html#xmlParseExternalSubset">xmlParseExternalSubset</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
150 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,
151 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);
152#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-NONE-CAPS">XML_SUBSTITUTE_NONE</a>
153#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-REF-CAPS">XML_SUBSTITUTE_REF</a>
154#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-PEREF-CAPS">XML_SUBSTITUTE_PEREF</a>
155#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-BOTH-CAPS">XML_SUBSTITUTE_BOTH</a>
156<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlDecodeEntities">xmlDecodeEntities</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
157 int len,
158 int what,
159 <a href="libxml-tree.html#xmlChar">xmlChar</a> end,
160 <a href="libxml-tree.html#xmlChar">xmlChar</a> end2,
161 <a href="libxml-tree.html#xmlChar">xmlChar</a> end3);
162<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#xmlStringDecodeEntities">xmlStringDecodeEntities</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
163 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,
164 int what,
165 <a href="libxml-tree.html#xmlChar">xmlChar</a> end,
166 <a href="libxml-tree.html#xmlChar">xmlChar</a> end2,
167 <a href="libxml-tree.html#xmlChar">xmlChar</a> end3);
168int <a href="libxml-parserInternals.html#nodePush">nodePush</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
169 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> value);
170<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> <a href="libxml-parserInternals.html#nodePop">nodePop</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
171int <a href="libxml-parserInternals.html#inputPush">inputPush</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
172 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> value);
173<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> <a href="libxml-parserInternals.html#inputPop">inputPop</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
174<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-parserInternals.html#namePop">namePop</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
175int <a href="libxml-parserInternals.html#namePush">namePush</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
176 <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);
177int <a href="libxml-parserInternals.html#xmlSkipBlankChars">xmlSkipBlankChars</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
178int <a href="libxml-parserInternals.html#xmlStringCurrentChar">xmlStringCurrentChar</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
179 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
180 int *len);
181void <a href="libxml-parserInternals.html#xmlParserHandlePEReference">xmlParserHandlePEReference</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
182void <a href="libxml-parserInternals.html#xmlParserHandleReference">xmlParserHandleReference</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
183int <a href="libxml-parserInternals.html#xmlCheckLanguageID">xmlCheckLanguageID</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *lang);
184int <a href="libxml-parserInternals.html#xmlCurrentChar">xmlCurrentChar</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
185 int *len);
186int <a href="libxml-parserInternals.html#xmlCopyCharMultiByte">xmlCopyCharMultiByte</a> (<a href="libxml-tree.html#xmlChar">xmlChar</a> *out,
187 int val);
188int <a href="libxml-parserInternals.html#xmlCopyChar">xmlCopyChar</a> (int len,
189 <a href="libxml-tree.html#xmlChar">xmlChar</a> *out,
190 int val);
191void <a href="libxml-parserInternals.html#xmlNextChar">xmlNextChar</a> (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);
192void <a href="libxml-parserInternals.html#xmlParserInputShrink">xmlParserInputShrink</a> (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> in);
193void <a href="libxml-parserInternals.html#htmlInitAutoClose">htmlInitAutoClose</a> (void);
194<a href="libxml-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> <a href="libxml-parserInternals.html#htmlCreateFileParserCtxt">htmlCreateFileParserCtxt</a> (const char *filename,
195 const char *encoding);
196void (<a href="libxml-parserInternals.html#xmlEntityReferenceFunc">*xmlEntityReferenceFunc</a>) (<a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent,
197 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> firstNode,
198 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> lastNode);
199void <a href="libxml-parserInternals.html#xmlSetEntityReferenceFunc">xmlSetEntityReferenceFunc</a> (<a href="libxml-parserInternals.html#xmlEntityReferenceFunc">xmlEntityReferenceFunc</a> func);
200</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
201
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]202</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="XML-MAX-NAMELEN-CAPS"></a>XML_MAX_NAMELEN</h3><pre class="programlisting">#define XML_MAX_NAMELEN 100
203</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]204Identifiers can be longer, but this will be more costly
205at runtime.</p><p>
206
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]207</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="INPUT-CHUNK-CAPS"></a>INPUT_CHUNK</h3><pre class="programlisting">#define INPUT_CHUNK 250
208</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]209The parser tries to always have that amount of input ready.
210One of the point is providing context when reporting errors.</p><p>
211
212</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-CHAR-CAPS"></a>IS_CHAR()</h3><pre class="programlisting">#define IS_CHAR(c)</pre><p>
213Macro to check the following production in the XML spec:
214</p><p>
215[2] Char ::= <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x9">x9</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK> | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20-">x20-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD7FF">xD7FF</GTKDOCLINK>] | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xE000-">xE000-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xFFFD">xFFFD</GTKDOCLINK>]
216 | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x10000-">x10000-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x10FFFF">x10FFFF</GTKDOCLINK>]
217any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.</p><p>
218
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]219</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]220</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-BLANK-CAPS"></a>IS_BLANK()</h3><pre class="programlisting">#define IS_BLANK(c)</pre><p>
221Macro to check the following production in the XML spec:
222</p><p>
223[3] S ::= (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x9">x9</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK>)+</p><p>
224
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]225</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
226</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-BASECHAR-CAPS"></a>IS_BASECHAR()</h3><pre class="programlisting">#define IS_BASECHAR(c) xmlIsBaseChar(c)
227</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]228Macro to check the following production in the XML spec:
229</p><p>
230[85] BaseChar ::= ... long list see REC ...</p><p>
231
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]232</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
233</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-DIGIT-CAPS"></a>IS_DIGIT()</h3><pre class="programlisting">#define IS_DIGIT(c) xmlIsDigit(c)
234</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]235Macro to check the following production in the XML spec:
236</p><p>
237[88] Digit ::= ... long list see REC ...</p><p>
238
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]239</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
240</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-COMBINING-CAPS"></a>IS_COMBINING()</h3><pre class="programlisting">#define IS_COMBINING(c) xmlIsCombining(c)
241</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]242Macro to check the following production in the XML spec:
243</p><p>
244[87] CombiningChar ::= ... long list see REC ...</p><p>
245
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]246</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
247</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-EXTENDER-CAPS"></a>IS_EXTENDER()</h3><pre class="programlisting">#define IS_EXTENDER(c) xmlIsExtender(c)
248</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]249Macro to check the following production in the XML spec:
250</p><p>
251[89] Extender ::= <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x00B7">x00B7</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x02D0">x02D0</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x02D1">x02D1</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0387">x0387</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0640">x0640</GTKDOCLINK> |
252 <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0E46">x0E46</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0EC6">x0EC6</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3005">x3005</GTKDOCLINK> | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3031-">x3031-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3035">x3035</GTKDOCLINK>] |
253 [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x309D-">x309D-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x309E">x309E</GTKDOCLINK>] | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x30FC-">x30FC-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x30FE">x30FE</GTKDOCLINK>]</p><p>
254
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]255</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
256</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-IDEOGRAPHIC-CAPS"></a>IS_IDEOGRAPHIC()</h3><pre class="programlisting">#define IS_IDEOGRAPHIC(c) xmlIsIdeographic(c)
257</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]258Macro to check the following production in the XML spec:
259</p><p>
260[86] Ideographic ::= [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x4E00-">x4E00-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x9FA5">x9FA5</GTKDOCLINK>] | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3007">x3007</GTKDOCLINK> | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3021-">x3021-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3029">x3029</GTKDOCLINK>]</p><p>
261
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]262</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
263</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-LETTER-CAPS"></a>IS_LETTER()</h3><pre class="programlisting">#define IS_LETTER(c) (IS_BASECHAR(c) || IS_IDEOGRAPHIC(c))
264</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]265Macro to check the following production in the XML spec:
266</p><p>
267[84] Letter ::= BaseChar | Ideographic</p><p>
268
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]269</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
270</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="IS-PUBIDCHAR-CAPS"></a>IS_PUBIDCHAR()</h3><pre class="programlisting">#define IS_PUBIDCHAR(c) xmlIsPubidChar(c)
271</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]272Macro to check the following production in the XML spec:
273</p><p>
274[13] PubidChar ::= <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK> | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]</p><p>
275
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]276</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an UNICODE value (int)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]277</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="SKIP-EOL-CAPS"></a>SKIP_EOL()</h3><pre class="programlisting">#define SKIP_EOL(p)</pre><p>
278Skips the end of line chars.</p><p>
279
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]280</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>p</tt></i> :</span></td><td> and UTF8 string pointer
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]281</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="MOVETO-ENDTAG-CAPS"></a>MOVETO_ENDTAG()</h3><pre class="programlisting">#define MOVETO_ENDTAG(p)</pre><p>
282Skips to the next '&gt;' char.</p><p>
283
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]284</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>p</tt></i> :</span></td><td> and UTF8 string pointer
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]285</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="MOVETO-STARTTAG-CAPS"></a>MOVETO_STARTTAG()</h3><pre class="programlisting">#define MOVETO_STARTTAG(p)</pre><p>
286Skips to the next '&lt;' char.</p><p>
287
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]288</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>p</tt></i> :</span></td><td> and UTF8 string pointer
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]289</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsBaseChar"></a>xmlIsBaseChar ()</h3><pre class="programlisting">int xmlIsBaseChar (int c);</pre><p>
290Check whether the character is allowed by the production
291[85] BaseChar ::= ... long list see REC ...
292</p><p>
293VI is your friend !
294:1,$ s/\[<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x">x</GTKDOCLINK>\([0-9A-Z]*\)-<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x">x</GTKDOCLINK>\([0-9A-Z]*\)\]/ (((c) &gt;= 0x\1) \&amp;\&amp; ((c) &lt;= 0x\2)) ||/
295and
296:1,$ s/<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x">x</GTKDOCLINK>\([0-9A-Z]*\)/ ((c) == 0x\1) ||/</p><p>
297
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]298</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
299</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]300</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsBlank"></a>xmlIsBlank ()</h3><pre class="programlisting">int xmlIsBlank (int c);</pre><p>
301Check whether the character is allowed by the production
302[3] S ::= (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x9">x9</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK>)+
303Also available as a macro <a href="libxml-parserInternals.html#IS-BLANK-CAPS">IS_BLANK</a>()</p><p>
304
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]305</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
306</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]307</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsPubidChar"></a>xmlIsPubidChar ()</h3><pre class="programlisting">int xmlIsPubidChar (int c);</pre><p>
308Check whether the character is allowed by the production
309[13] PubidChar ::= <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK> | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]</p><p>
310
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]311</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
312</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]313</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsLetter"></a>xmlIsLetter ()</h3><pre class="programlisting">int xmlIsLetter (int c);</pre><p>
314Check whether the character is allowed by the production
315[84] Letter ::= BaseChar | Ideographic</p><p>
316
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]317</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
318</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]319</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsDigit"></a>xmlIsDigit ()</h3><pre class="programlisting">int xmlIsDigit (int c);</pre><p>
320Check whether the character is allowed by the production
321[88] Digit ::= ... long list see REC ...</p><p>
322
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]323</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
324</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]325</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsIdeographic"></a>xmlIsIdeographic ()</h3><pre class="programlisting">int xmlIsIdeographic (int c);</pre><p>
326Check whether the character is allowed by the production
327[86] Ideographic ::= [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x4E00-">x4E00-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x9FA5">x9FA5</GTKDOCLINK>] | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3007">x3007</GTKDOCLINK> | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3021-">x3021-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3029">x3029</GTKDOCLINK>]</p><p>
328
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]329</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
330</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]331</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsExtender"></a>xmlIsExtender ()</h3><pre class="programlisting">int xmlIsExtender (int c);</pre><p>
332Check whether the character is allowed by the production
333[89] Extender ::= <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x00B7">x00B7</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x02D0">x02D0</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x02D1">x02D1</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0387">x0387</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0640">x0640</GTKDOCLINK> |
334 <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0E46">x0E46</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x0EC6">x0EC6</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3005">x3005</GTKDOCLINK> | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3031-">x3031-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x3035">x3035</GTKDOCLINK>] |
335 [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x309D-">x309D-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x309E">x309E</GTKDOCLINK>] | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x30FC-">x30FC-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x30FE">x30FE</GTKDOCLINK>]</p><p>
336
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]337</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
338</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]339</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsCombining"></a>xmlIsCombining ()</h3><pre class="programlisting">int xmlIsCombining (int c);</pre><p>
340Check whether the character is allowed by the production
341[87] CombiningChar ::= ... long list see REC ...</p><p>
342
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]343</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
344</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]345</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlIsChar"></a>xmlIsChar ()</h3><pre class="programlisting">int xmlIsChar (int c);</pre><p>
346Check whether the character is allowed by the production
347[2] Char ::= <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x9">x9</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK> | <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK> | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20-">x20-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD7FF">xD7FF</GTKDOCLINK>] | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xE000-">xE000-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xFFFD">xFFFD</GTKDOCLINK>]
348 | [<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x10000-">x10000-</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x10FFFF">x10FFFF</GTKDOCLINK>]
349any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.
350Also available as a macro <a href="libxml-parserInternals.html#IS-CHAR-CAPS">IS_CHAR</a>()</p><p>
351
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]352</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>c</tt></i> :</span></td><td> an unicode character (int)
353</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 if not, non-zero otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]354</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCreateFileParserCtxt"></a>xmlCreateFileParserCtxt ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlCreateFileParserCtxt (const char *filename);</pre><p>
355Create a parser context for a file content.
356Automatic support for ZLIB/Compress compressed document is provided
357by default if found at compile-time.</p><p>
358
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]359</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the filename
360</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]361</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCreateMemoryParserCtxt"></a>xmlCreateMemoryParserCtxt ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlCreateMemoryParserCtxt (const char *buffer,
362 int size);</pre><p>
363Create a parser context for an XML in-memory document.</p><p>
364
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]365</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> a pointer to a char array
366</td></tr><tr><td><span class="term"><i><tt>size</tt></i> :</span></td><td> the size of the array
367</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]368</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewParserCtxt"></a>xmlNewParserCtxt ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlNewParserCtxt (void);</pre><p>
369Allocate and initialize a new parser context.</p><p>
370
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]371</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlParserCtxtPtr or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]372</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCreateEntityParserCtxt"></a>xmlCreateEntityParserCtxt ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> xmlCreateEntityParserCtxt (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URL,
373 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ID,
374 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *base);</pre><p>
375Create a parser context for an external entity
376Automatic support for ZLIB/Compress compressed document is provided
377by default if found at compile-time.</p><p>
378
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]379</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>URL</tt></i> :</span></td><td> the entity URL
380</td></tr><tr><td><span class="term"><i><tt>ID</tt></i> :</span></td><td> the entity PUBLIC ID
381</td></tr><tr><td><span class="term"><i><tt>base</tt></i> :</span></td><td> a possible base for the target URI
382</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]383</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSwitchEncoding"></a>xmlSwitchEncoding ()</h3><pre class="programlisting">int xmlSwitchEncoding (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
384 <a href="libxml-encoding.html#xmlCharEncoding">xmlCharEncoding</a> enc);</pre><p>
385change the input functions when discovering the character encoding
386of a given entity.</p><p>
387
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]388</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the parser context
389</td></tr><tr><td><span class="term"><i><tt>enc</tt></i> :</span></td><td> the encoding value (number)
390</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of success, -1 otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]391</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSwitchToEncoding"></a>xmlSwitchToEncoding ()</h3><pre class="programlisting">int xmlSwitchToEncoding (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
392 <a href="libxml-encoding.html#xmlCharEncodingHandlerPtr">xmlCharEncodingHandlerPtr</a> handler);</pre><p>
393change the input functions when discovering the character encoding
394of a given entity.</p><p>
395
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]396</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the parser context
397</td></tr><tr><td><span class="term"><i><tt>handler</tt></i> :</span></td><td> the encoding handler
398</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of success, -1 otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]399</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlHandleEntity"></a>xmlHandleEntity ()</h3><pre class="programlisting">void xmlHandleEntity (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
400 <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity);</pre><p>
401Default handling of defined entities, when should we define a new input
402stream ? When do we just handle that as a set of chars ?
403</p><p>
404OBSOLETE: to be removed at some point.</p><p>
405
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]406</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
407</td></tr><tr><td><span class="term"><i><tt>entity</tt></i> :</span></td><td> an XML entity pointer.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]408</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewStringInputStream"></a>xmlNewStringInputStream ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlNewStringInputStream (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
409 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *buffer);</pre><p>
410Create a new input stream based on a memory buffer.</p><p>
411
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]412</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
413</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> an memory buffer
414</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new input stream
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]415</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewEntityInputStream"></a>xmlNewEntityInputStream ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlNewEntityInputStream (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
416 <a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> entity);</pre><p>
417Create a new input stream based on an xmlEntityPtr</p><p>
418
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]419</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
420</td></tr><tr><td><span class="term"><i><tt>entity</tt></i> :</span></td><td> an Entity pointer
421</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new input stream or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]422</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlPushInput"></a>xmlPushInput ()</h3><pre class="programlisting">void xmlPushInput (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
423 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> input);</pre><p>
424xmlPushInput: switch to a new input stream which is stacked on top
425 of the previous one(s).</p><p>
426
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]427</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
428</td></tr><tr><td><span class="term"><i><tt>input</tt></i> :</span></td><td> an XML parser input fragment (entity, XML fragment ...).
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]429</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlPopInput"></a>xmlPopInput ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a> xmlPopInput (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
430xmlPopInput: the current input pointed by ctxt-&gt;input came to an end
431 pop it and return the next char.</p><p>
432
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]433</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
434</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the current xmlChar in the parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]435</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeInputStream"></a>xmlFreeInputStream ()</h3><pre class="programlisting">void xmlFreeInputStream (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> input);</pre><p>
436Free up an input stream.</p><p>
437
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]438</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>input</tt></i> :</span></td><td> an xmlParserInputPtr
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]439</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewInputFromFile"></a>xmlNewInputFromFile ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlNewInputFromFile (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
440 const char *filename);</pre><p>
441Create a new input stream based on a file.</p><p>
442
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]443</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
444</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the filename to use as entity
445</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new input stream or NULL in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]446</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNewInputStream"></a>xmlNewInputStream ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> xmlNewInputStream (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
447Create a new input stream structure</p><p>
448
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]449</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
450</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new input stream or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]451</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSplitQName"></a>xmlSplitQName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlSplitQName (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
452 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,
453 <a href="libxml-tree.html#xmlChar">xmlChar</a> **prefix);</pre><p>
454parse an UTF8 encoded XML qualified name string
455</p><p>
456[NS 5] QName ::= (Prefix ':')? LocalPart
457</p><p>
458[NS 6] Prefix ::= NCName
459</p><p>
460[NS 7] LocalPart ::= NCName</p><p>
461
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]462</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
463</td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> an XML parser context
464</td></tr><tr><td><span class="term"><i><tt>prefix</tt></i> :</span></td><td> a xmlChar **
465</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the local part, and prefix is updated
466 to get the Prefix if any.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]467</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNamespaceParseNCName"></a>xmlNamespaceParseNCName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlNamespaceParseNCName (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
468parse an XML namespace name.
469</p><p>
470TODO: this seems not in use anymore, the namespace handling is done on
471 top of the SAX interfaces, i.e. not on raw input.
472</p><p>
473[NS 3] NCName ::= (Letter | '_') (NCNameChar)*
474</p><p>
475[NS 4] NCNameChar ::= Letter | Digit | '.' | '-' | '_' |
476 CombiningChar | Extender</p><p>
477
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]478</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
479</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the namespace name or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]480</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNamespaceParseQName"></a>xmlNamespaceParseQName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlNamespaceParseQName (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
481 <a href="libxml-tree.html#xmlChar">xmlChar</a> **prefix);</pre><p>
482TODO: this seems not in use anymore, the namespace handling is done on
483 top of the SAX interfaces, i.e. not on raw input.
484</p><p>
485parse an XML qualified name
486</p><p>
487[NS 5] QName ::= (Prefix ':')? LocalPart
488</p><p>
489[NS 6] Prefix ::= NCName
490</p><p>
491[NS 7] LocalPart ::= NCName</p><p>
492
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]493</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
494</td></tr><tr><td><span class="term"><i><tt>prefix</tt></i> :</span></td><td> a xmlChar **
495</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the local part, and prefix is updated
496 to get the Prefix if any.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]497</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNamespaceParseNSDef"></a>xmlNamespaceParseNSDef ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlNamespaceParseNSDef (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
498parse a namespace prefix declaration
499</p><p>
500TODO: this seems not in use anymore, the namespace handling is done on
501 top of the SAX interfaces, i.e. not on raw input.
502</p><p>
503[NS 1] NSDef ::= PrefixDef Eq SystemLiteral
504</p><p>
505[NS 2] PrefixDef ::= 'xmlns' (':' NCName)?</p><p>
506
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]507</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
508</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the namespace name
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]509</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseQuotedString"></a>xmlParseQuotedString ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseQuotedString (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
510Parse and return a string between quotes or doublequotes
511</p><p>
512TODO: Deprecated, to be removed at next drop of binary compatibility</p><p>
513
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]514</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
515</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the string parser or NULL.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]516</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseNamespace"></a>xmlParseNamespace ()</h3><pre class="programlisting">void xmlParseNamespace (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
517xmlParseNamespace: parse specific PI '&lt;?namespace ...' constructs.
518</p><p>
519This is what the older xml-name Working Draft specified, a bunch of
520other stuff may still rely on it, so support is still here as
521if it was declared on the root of the Tree:-(
522</p><p>
523TODO: remove from library
524</p><p>
525To be removed at next drop of binary compatibility</p><p>
526
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]527</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]528</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlScanName"></a>xmlScanName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlScanName (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
529Trickery: parse an XML name but without consuming the input flow
530Needed for rollback cases. Used only when parsing entities references.
531</p><p>
532TODO: seems deprecated now, only used in the default part of
533 xmlParserHandleReference
534</p><p>
535[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
536 CombiningChar | Extender
537</p><p>
538[5] Name ::= (Letter | '_' | ':') (NameChar)*
539</p><p>
540[6] Names ::= Name (S Name)*</p><p>
541
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]542</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
543</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the Name parsed or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]544</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseName"></a>xmlParseName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseName (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
545parse an XML name.
546</p><p>
547[4] NameChar ::= Letter | Digit | '.' | '-' | '_' | ':' |
548 CombiningChar | Extender
549</p><p>
550[5] Name ::= (Letter | '_' | ':') (NameChar)*
551</p><p>
552[6] Names ::= Name (S Name)*</p><p>
553
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]554</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
555</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the Name parsed or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]556</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseNmtoken"></a>xmlParseNmtoken ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseNmtoken (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
557parse an XML Nmtoken.
558</p><p>
559[7] Nmtoken ::= (NameChar)+
560</p><p>
561[8] Nmtokens ::= Nmtoken (S Nmtoken)*</p><p>
562
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]563</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
564</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the Nmtoken parsed or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]565</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEntityValue"></a>xmlParseEntityValue ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseEntityValue (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
566 <a href="libxml-tree.html#xmlChar">xmlChar</a> **orig);</pre><p>
567parse a value for ENTITY declarations
568</p><p>
569[9] EntityValue ::= '&quot;' ([^%&amp;&quot;] | PEReference | Reference)* '&quot;' |
570 &quot;'&quot; ([^%&amp;'] | PEReference | Reference)* &quot;'&quot;</p><p>
571
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]572</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
573</td></tr><tr><td><span class="term"><i><tt>orig</tt></i> :</span></td><td> if non-NULL store a copy of the original entity value
574</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the EntityValue parsed with reference substituted or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]575</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseAttValue"></a>xmlParseAttValue ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseAttValue (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
576parse a value for an attribute
577Note: the parser won't do substitution of entities here, this
578will be handled later in xmlStringGetNodeList
579</p><p>
580[10] AttValue ::= '&quot;' ([^&lt;&amp;&quot;] | Reference)* '&quot;' |
581 &quot;'&quot; ([^&lt;&amp;'] | Reference)* &quot;'&quot;
582</p><p>
5833.3.3 Attribute-Value Normalization:
584Before the value of an attribute is passed to the application or
585checked for validity, the XML processor must normalize it as follows:
586- a character reference is processed by appending the referenced
587 character to the attribute value
588- an entity reference is processed by recursively processing the
589 replacement text of the entity
590- a whitespace character (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK>, <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK>, <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK>, <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x9">x9</GTKDOCLINK>) is processed by
591 appending <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK> to the normalized value, except that only a single
592 <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK> is appended for a &quot;<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK>&quot; sequence that is part of an external
593 parsed entity or the literal entity value of an internal parsed entity
594- other characters are processed by appending them to the normalized value
595If the declared value is not CDATA, then the XML processor must further
596process the normalized attribute value by discarding any leading and
597trailing space (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK>) characters, and by replacing sequences of space
598(<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK>) characters by a single space (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x20">x20</GTKDOCLINK>) character.
599All attributes for which no declaration has been read should be treated
600by a non-validating parser as if declared CDATA.</p><p>
601
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]602</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
603</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the AttValue parsed or NULL. The value has to be freed by the caller.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]604</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseSystemLiteral"></a>xmlParseSystemLiteral ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseSystemLiteral (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
605parse an XML Literal
606</p><p>
607[11] SystemLiteral ::= ('&quot;' [^&quot;]* '&quot;') | (&quot;'&quot; [^']* &quot;'&quot;)</p><p>
608
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]609</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
610</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the SystemLiteral parsed or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]611</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParsePubidLiteral"></a>xmlParsePubidLiteral ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParsePubidLiteral (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
612parse an XML public literal
613</p><p>
614[12] PubidLiteral ::= '&quot;' PubidChar* '&quot;' | &quot;'&quot; (PubidChar - &quot;'&quot;)* &quot;'&quot;</p><p>
615
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]616</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
617</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the PubidLiteral parsed or NULL.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]618</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseCharData"></a>xmlParseCharData ()</h3><pre class="programlisting">void xmlParseCharData (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
619 int cdata);</pre><p>
620parse a CharData section.
621if we are within a CDATA section ']]&gt;' marks an end of section.
622</p><p>
623The right angle bracket (&gt;) may be represented using the string &quot;&amp;gt;&quot;,
624and must, for compatibility, be escaped using &quot;&amp;gt;&quot; or a character
625reference when it appears in the string &quot;]]&gt;&quot; in content, when that
626string is not marking the end of a CDATA section.
627</p><p>
628[14] CharData ::= [^&lt;&amp;]* - ([^&lt;&amp;]* ']]&gt;' [^&lt;&amp;]*)</p><p>
629
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]630</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
631</td></tr><tr><td><span class="term"><i><tt>cdata</tt></i> :</span></td><td> int indicating whether we are within a CDATA section
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]632</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseExternalID"></a>xmlParseExternalID ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseExternalID (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
633 <a href="libxml-tree.html#xmlChar">xmlChar</a> **publicID,
634 int strict);</pre><p>
635Parse an External ID or a Public ID
636</p><p>
637NOTE: Productions [75] and [83] interact badly since [75] can generate
638 'PUBLIC' S PubidLiteral S SystemLiteral
639</p><p>
640[75] ExternalID ::= 'SYSTEM' S SystemLiteral
641 | 'PUBLIC' S PubidLiteral S SystemLiteral
642</p><p>
643[83] PublicID ::= 'PUBLIC' S PubidLiteral</p><p>
644
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]645</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
646</td></tr><tr><td><span class="term"><i><tt>publicID</tt></i> :</span></td><td> a xmlChar** receiving PubidLiteral
647</td></tr><tr><td><span class="term"><i><tt>strict</tt></i> :</span></td><td> indicate whether we should restrict parsing to only
648 production [75], see NOTE below
649</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the function returns SystemLiteral and in the second
650 case publicID receives PubidLiteral, is strict is off
651 it is possible to return NULL and have publicID set.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]652</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseComment"></a>xmlParseComment ()</h3><pre class="programlisting">void xmlParseComment (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
653Skip an XML (SGML) comment &lt;!-- .... --&gt;
654 The spec says that &quot;For compatibility, the string &quot;--&quot; (double-hyphen)
655 must not occur within comments. &quot;
656</p><p>
657[15] Comment ::= '&lt;!--' ((Char - '-') | ('-' (Char - '-')))* '--&gt;'</p><p>
658
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]659</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]660</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParsePITarget"></a>xmlParsePITarget ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParsePITarget (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
661parse the name of a PI
662</p><p>
663[17] PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))</p><p>
664
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]665</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
666</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the PITarget name or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]667</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParsePI"></a>xmlParsePI ()</h3><pre class="programlisting">void xmlParsePI (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
668parse an XML Processing Instruction.
669</p><p>
670[16] PI ::= '&lt;?' PITarget (S (Char* - (Char* '?&gt;' Char*)))? '?&gt;'
671</p><p>
672The processing is transfered to SAX once parsed.</p><p>
673
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]674</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]675</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseNotationDecl"></a>xmlParseNotationDecl ()</h3><pre class="programlisting">void xmlParseNotationDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
676parse a notation declaration
677</p><p>
678[82] NotationDecl ::= '&lt;!NOTATION' S Name S (ExternalID | PublicID) S? '&gt;'
679</p><p>
680Hence there is actually 3 choices:
681 'PUBLIC' S PubidLiteral
682 'PUBLIC' S PubidLiteral S SystemLiteral
683and 'SYSTEM' S SystemLiteral
684</p><p>
685See the NOTE on <a href="libxml-parserInternals.html#xmlParseExternalID">xmlParseExternalID</a>().</p><p>
686
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]687</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]688</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEntityDecl"></a>xmlParseEntityDecl ()</h3><pre class="programlisting">void xmlParseEntityDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
689parse &lt;!ENTITY declarations
690</p><p>
691[70] EntityDecl ::= GEDecl | PEDecl
692</p><p>
693[71] GEDecl ::= '&lt;!ENTITY' S Name S EntityDef S? '&gt;'
694</p><p>
695[72] PEDecl ::= '&lt;!ENTITY' S '%' S Name S PEDef S? '&gt;'
696</p><p>
697[73] EntityDef ::= EntityValue | (ExternalID NDataDecl?)
698</p><p>
699[74] PEDef ::= EntityValue | ExternalID
700</p><p>
701[76] NDataDecl ::= S 'NDATA' S Name
702</p><p>
703[ VC: Notation Declared ]
704The Name must match the declared name of a notation.</p><p>
705
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]706</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]707</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseDefaultDecl"></a>xmlParseDefaultDecl ()</h3><pre class="programlisting">int xmlParseDefaultDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
708 <a href="libxml-tree.html#xmlChar">xmlChar</a> **value);</pre><p>
709Parse an attribute default declaration
710</p><p>
711[60] DefaultDecl ::= '<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="REQUIRED-CAPS">REQUIRED</GTKDOCLINK>' | '<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="IMPLIED-CAPS">IMPLIED</GTKDOCLINK>' | (('<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FIXED-CAPS">FIXED</GTKDOCLINK>' S)? AttValue)
712</p><p>
713[ VC: Required Attribute ]
714if the default declaration is the keyword <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="REQUIRED-CAPS">REQUIRED</GTKDOCLINK>, then the
715attribute must be specified for all elements of the type in the
716attribute-list declaration.
717</p><p>
718[ VC: Attribute Default Legal ]
719The declared default value must meet the lexical constraints of
720the declared attribute type c.f. <a href="libxml-valid.html#xmlValidateAttributeDecl">xmlValidateAttributeDecl</a>()
721</p><p>
722[ VC: Fixed Attribute Default ]
723if an attribute has a default value declared with the <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FIXED-CAPS">FIXED</GTKDOCLINK>
724keyword, instances of that attribute must match the default value.
725</p><p>
726[ WFC: No &lt; in Attribute Values ]
727handled in <a href="libxml-parserInternals.html#xmlParseAttValue">xmlParseAttValue</a>()</p><p>
728
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]729</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
730</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> Receive a possible fixed default value for the attribute
731</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> XML_ATTRIBUTE_NONE, XML_ATTRIBUTE_REQUIRED, XML_ATTRIBUTE_IMPLIED
732 or XML_ATTRIBUTE_FIXED.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]733</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseNotationType"></a>xmlParseNotationType ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> xmlParseNotationType (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
734parse an Notation attribute type.
735</p><p>
736Note: the leading 'NOTATION' S part has already being parsed...
737</p><p>
738[58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'
739</p><p>
740[ VC: Notation Attributes ]
741Values of this type must match one of the notation names included
742in the declaration; all notation names in the declaration must be declared.</p><p>
743
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]744</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
745</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the notation attribute tree built while parsing
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]746</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEnumerationType"></a>xmlParseEnumerationType ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> xmlParseEnumerationType (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
747parse an Enumeration attribute type.
748</p><p>
749[59] Enumeration ::= '(' S? Nmtoken (S? '|' S? Nmtoken)* S? ')'
750</p><p>
751[ VC: Enumeration ]
752Values of this type must match one of the Nmtoken tokens in
753the declaration</p><p>
754
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]755</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
756</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the enumeration attribute tree built while parsing
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]757</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEnumeratedType"></a>xmlParseEnumeratedType ()</h3><pre class="programlisting">int xmlParseEnumeratedType (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
758 <a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> *tree);</pre><p>
759parse an Enumerated attribute type.
760</p><p>
761[57] EnumeratedType ::= NotationType | Enumeration
762</p><p>
763[58] NotationType ::= 'NOTATION' S '(' S? Name (S? '|' S? Name)* S? ')'</p><p>
764
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]765</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
766</td></tr><tr><td><span class="term"><i><tt>tree</tt></i> :</span></td><td> the enumeration tree built while parsing
767</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> XML_ATTRIBUTE_ENUMERATION or XML_ATTRIBUTE_NOTATION
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]768</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseAttributeType"></a>xmlParseAttributeType ()</h3><pre class="programlisting">int xmlParseAttributeType (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
769 <a href="libxml-tree.html#xmlEnumerationPtr">xmlEnumerationPtr</a> *tree);</pre><p>
770parse the Attribute list def for an element
771</p><p>
772[54] AttType ::= StringType | TokenizedType | EnumeratedType
773</p><p>
774[55] StringType ::= 'CDATA'
775</p><p>
776[56] TokenizedType ::= 'ID' | 'IDREF' | 'IDREFS' | 'ENTITY' |
777 'ENTITIES' | 'NMTOKEN' | 'NMTOKENS'
778</p><p>
779Validity constraints for attribute values syntax are checked in
780<a href="libxml-valid.html#xmlValidateAttributeValue">xmlValidateAttributeValue</a>()
781</p><p>
782[ VC: ID ]
783Values of type ID must match the Name production. A name must not
784appear more than once in an XML document as a value of this type;
785i.e., ID values must uniquely identify the elements which bear them.
786</p><p>
787[ VC: One ID per Element Type ]
788No element type may have more than one ID attribute specified.
789</p><p>
790[ VC: ID Attribute Default ]
791An ID attribute must have a declared default of <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="IMPLIED-CAPS">IMPLIED</GTKDOCLINK> or <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="REQUIRED-CAPS">REQUIRED</GTKDOCLINK>.
792</p><p>
793[ VC: IDREF ]
794Values of type IDREF must match the Name production, and values
795of type IDREFS must match Names; each IDREF Name must match the value
796of an ID attribute on some element in the XML document; i.e. IDREF
797values must match the value of some ID attribute.
798</p><p>
799[ VC: Entity Name ]
800Values of type ENTITY must match the Name production, values
801of type ENTITIES must match Names; each Entity Name must match the
802name of an unparsed entity declared in the DTD.
803</p><p>
804[ VC: Name Token ]
805Values of type NMTOKEN must match the Nmtoken production; values
806of type NMTOKENS must match Nmtokens.</p><p>
807
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]808</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
809</td></tr><tr><td><span class="term"><i><tt>tree</tt></i> :</span></td><td> the enumeration tree built while parsing
810</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the attribute type
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]811</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseAttributeListDecl"></a>xmlParseAttributeListDecl ()</h3><pre class="programlisting">void xmlParseAttributeListDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
812: parse the Attribute list def for an element
813</p><p>
814[52] AttlistDecl ::= '&lt;!ATTLIST' S Name AttDef* S? '&gt;'
815</p><p>
816[53] AttDef ::= S Name S AttType S DefaultDecl</p><p>
817
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]818</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]819</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseElementMixedContentDecl"></a>xmlParseElementMixedContentDecl ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> xmlParseElementMixedContentDecl
820 (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
821 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> inputchk);</pre><p>
822parse the declaration for a Mixed Element content
823The leading '(' and spaces have been skipped in xmlParseElementContentDecl
824</p><p>
825[51] Mixed ::= '(' S? '<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="PCDATA-CAPS">PCDATA</GTKDOCLINK>' (S? '|' S? Name)* S? ')*' |
826 '(' S? '<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="PCDATA-CAPS">PCDATA</GTKDOCLINK>' S? ')'
827</p><p>
828[ VC: Proper Group/PE Nesting ] applies to [51] too (see [49])
829</p><p>
830[ VC: No Duplicate Types ]
831The same name must not appear more than once in a single
832mixed-content declaration.</p><p>
833
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]834</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
835</td></tr><tr><td><span class="term"><i><tt>inputchk</tt></i> :</span></td><td> the input used for the current entity, needed for boundary checks
836</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the list of the xmlElementContentPtr describing the element choices
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]837</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseElementChildrenContentDecl"></a>xmlParseElementChildrenContentDecl ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> xmlParseElementChildrenContentDecl
838 (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
839 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> inputchk);</pre><p>
840parse the declaration for a Mixed Element content
841The leading '(' and spaces have been skipped in xmlParseElementContentDecl
842</p><p>
843[47] children ::= (choice | seq) ('?' | '*' | '+')?
844</p><p>
845[48] cp ::= (Name | choice | seq) ('?' | '*' | '+')?
846</p><p>
847[49] choice ::= '(' S? cp ( S? '|' S? cp )* S? ')'
848</p><p>
849[50] seq ::= '(' S? cp ( S? ',' S? cp )* S? ')'
850</p><p>
851[ VC: Proper Group/PE Nesting ] applies to [49] and [50]
852TODO Parameter-entity replacement text must be properly nested
853with parenthesized groups. That is to say, if either of the
854opening or closing parentheses in a choice, seq, or Mixed
855construct is contained in the replacement text for a parameter
856entity, both must be contained in the same replacement text. For
857interoperability, if a parameter-entity reference appears in a
858choice, seq, or Mixed construct, its replacement text should not
859be empty, and neither the first nor last non-blank character of
860the replacement text should be a connector (| or ,).</p><p>
861
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]862</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
863</td></tr><tr><td><span class="term"><i><tt>inputchk</tt></i> :</span></td><td> the input used for the current entity, needed for boundary checks
864</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the tree of xmlElementContentPtr describing the element
865 hierarchy.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]866</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseElementContentDecl"></a>xmlParseElementContentDecl ()</h3><pre class="programlisting">int xmlParseElementContentDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
867 <a href="libxml-tree.html#xmlChar">xmlChar</a> *name,
868 <a href="libxml-tree.html#xmlElementContentPtr">xmlElementContentPtr</a> *result);</pre><p>
869parse the declaration for an Element content either Mixed or Children,
870the cases EMPTY and ANY are handled directly in xmlParseElementDecl
871</p><p>
872[46] contentspec ::= 'EMPTY' | 'ANY' | Mixed | children</p><p>
873
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]874</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
875</td></tr><tr><td><span class="term"><i><tt>name</tt></i> :</span></td><td> the name of the element being defined.
876</td></tr><tr><td><span class="term"><i><tt>result</tt></i> :</span></td><td> the Element Content pointer will be stored here if any
877</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the type of element content XML_ELEMENT_TYPE_xxx
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]878</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseElementDecl"></a>xmlParseElementDecl ()</h3><pre class="programlisting">int xmlParseElementDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
879parse an Element declaration.
880</p><p>
881[45] elementdecl ::= '&lt;!ELEMENT' S Name S contentspec S? '&gt;'
882</p><p>
883[ VC: Unique Element Type Declaration ]
884No element type may be declared more than once</p><p>
885
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]886</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
887</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the type of the element, or -1 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]888</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseMarkupDecl"></a>xmlParseMarkupDecl ()</h3><pre class="programlisting">void xmlParseMarkupDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
889parse Markup declarations
890</p><p>
891[29] markupdecl ::= elementdecl | AttlistDecl | EntityDecl |
892 NotationDecl | PI | Comment
893</p><p>
894[ VC: Proper Declaration/PE Nesting ]
895Parameter-entity replacement text must be properly nested with
896markup declarations. That is to say, if either the first character
897or the last character of a markup declaration (markupdecl above) is
898contained in the replacement text for a parameter-entity reference,
899both must be contained in the same replacement text.
900</p><p>
901[ WFC: PEs in Internal Subset ]
902In the internal DTD subset, parameter-entity references can occur
903only where markup declarations can occur, not within markup declarations.
904(This does not apply to references that occur in external parameter
905entities or to the external subset.)</p><p>
906
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]907</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]908</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseCharRef"></a>xmlParseCharRef ()</h3><pre class="programlisting">int xmlParseCharRef (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
909parse Reference declarations
910</p><p>
911[66] CharRef ::= '&amp;#' [0-9]+ ';' |
912 '&amp;<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x">x</GTKDOCLINK>' [0-9a-fA-F]+ ';'
913</p><p>
914[ WFC: Legal Character ]
915Characters referred to using character references must match the
916production for Char.</p><p>
917
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]918</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
919</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the value parsed (as an int), 0 in case of error
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]920</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEntityRef"></a>xmlParseEntityRef ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> xmlParseEntityRef (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
921parse ENTITY references declarations
922</p><p>
923[68] EntityRef ::= '&amp;' Name ';'
924</p><p>
925[ WFC: Entity Declared ]
926In a document without any DTD, a document with only an internal DTD
927subset which contains no parameter entity references, or a document
928with &quot;standalone='yes'&quot;, the Name given in the entity reference
929must match that in an entity declaration, except that well-formed
930documents need not declare any of the following entities: amp, lt,
931gt, apos, quot. The declaration of a parameter entity must precede
932any reference to it. Similarly, the declaration of a general entity
933must precede any reference to it which appears in a default value in an
934attribute-list declaration. Note that if entities are declared in the
935external subset or in external parameter entities, a non-validating
936processor is not obligated to read and process their declarations;
937for such documents, the rule that an entity must be declared is a
938well-formedness constraint only if standalone='yes'.
939</p><p>
940[ WFC: Parsed Entity ]
941An entity reference must not contain the name of an unparsed entity</p><p>
942
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]943</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
944</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the xmlEntityPtr if found, or NULL otherwise.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]945</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseReference"></a>xmlParseReference ()</h3><pre class="programlisting">void xmlParseReference (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
946parse and handle entity references in content, depending on the SAX
947interface, this may end-up in a call to <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="character">character</GTKDOCLINK>() if this is a
948CharRef, a predefined entity, if there is no <a href="libxml-SAX.html#reference">reference</a>() callback.
949or if the parser was asked to switch to that mode.
950</p><p>
951[67] Reference ::= EntityRef | CharRef</p><p>
952
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]953</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]954</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParsePEReference"></a>xmlParsePEReference ()</h3><pre class="programlisting">void xmlParsePEReference (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
955parse PEReference declarations
956The entity content is handled directly by pushing it's content as
957a new input stream.
958</p><p>
959[69] PEReference ::= '%' Name ';'
960</p><p>
961[ WFC: No Recursion ]
962A parsed entity must not contain a recursive
963reference to itself, either directly or indirectly.
964</p><p>
965[ WFC: Entity Declared ]
966In a document without any DTD, a document with only an internal DTD
967subset which contains no parameter entity references, or a document
968with &quot;standalone='yes'&quot;, ... ... The declaration of a parameter
969entity must precede any reference to it...
970</p><p>
971[ VC: Entity Declared ]
972In a document with an external subset or external parameter entities
973with &quot;standalone='no'&quot;, ... ... The declaration of a parameter entity
974must precede any reference to it...
975</p><p>
976[ WFC: In DTD ]
977Parameter-entity references may only appear in the DTD.
978NOTE: misleading but this is handled.</p><p>
979
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]980</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]981</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseDocTypeDecl"></a>xmlParseDocTypeDecl ()</h3><pre class="programlisting">void xmlParseDocTypeDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
982parse a DOCTYPE declaration
983</p><p>
984[28] doctypedecl ::= '&lt;!DOCTYPE' S Name (S ExternalID)? S?
985 ('[' (markupdecl | PEReference | S)* ']' S?)? '&gt;'
986</p><p>
987[ VC: Root Element Type ]
988The Name in the document type declaration must match the element
989type of the root element.</p><p>
990
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]991</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]992</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseAttribute"></a>xmlParseAttribute ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseAttribute (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
993 <a href="libxml-tree.html#xmlChar">xmlChar</a> **value);</pre><p>
994parse an attribute
995</p><p>
996[41] Attribute ::= Name Eq AttValue
997</p><p>
998[ WFC: No External Entity References ]
999Attribute values cannot contain direct or indirect entity references
1000to external entities.
1001</p><p>
1002[ WFC: No &lt; in Attribute Values ]
1003The replacement text of any entity referred to directly or indirectly in
1004an attribute value (other than &quot;&amp;lt;&quot;) must not contain a &lt;.
1005</p><p>
1006[ VC: Attribute Value Type ]
1007The attribute must have been declared; the value must be of the type
1008declared for it.
1009</p><p>
1010[25] Eq ::= S? '=' S?
1011</p><p>
1012With namespace:
1013</p><p>
1014[NS 11] Attribute ::= QName Eq AttValue
1015</p><p>
1016Also the case QName == xmlns:??? is handled independently as a namespace
1017definition.</p><p>
1018
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1019</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1020</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> a xmlChar ** used to store the value of the attribute
1021</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the attribute name, and the value in *value.
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1022</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseStartTag"></a>xmlParseStartTag ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseStartTag (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1023parse a start of tag either for rule element or
1024EmptyElement. In both case we don't parse the tag closing chars.
1025</p><p>
1026[40] STag ::= '&lt;' Name (S Attribute)* S? '&gt;'
1027</p><p>
1028[ WFC: Unique Att Spec ]
1029No attribute name may appear more than once in the same start-tag or
1030empty-element tag.
1031</p><p>
1032[44] EmptyElemTag ::= '&lt;' Name (S Attribute)* S? '/&gt;'
1033</p><p>
1034[ WFC: Unique Att Spec ]
1035No attribute name may appear more than once in the same start-tag or
1036empty-element tag.
1037</p><p>
1038With namespace:
1039</p><p>
1040[NS 8] STag ::= '&lt;' QName (S Attribute)* S? '&gt;'
1041</p><p>
1042[NS 10] EmptyElement ::= '&lt;' QName (S Attribute)* S? '/&gt;'</p><p>
1043
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1044</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1045</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the element name parsed
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1046</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEndTag"></a>xmlParseEndTag ()</h3><pre class="programlisting">void xmlParseEndTag (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1047parse an end of tag
1048</p><p>
1049[42] ETag ::= '&lt;/' Name S? '&gt;'
1050</p><p>
1051With namespace
1052</p><p>
1053[NS 9] ETag ::= '&lt;/' QName S? '&gt;'</p><p>
1054
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1055</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1056</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseCDSect"></a>xmlParseCDSect ()</h3><pre class="programlisting">void xmlParseCDSect (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1057Parse escaped pure raw content.
1058</p><p>
1059[18] CDSect ::= CDStart CData CDEnd
1060</p><p>
1061[19] CDStart ::= '&lt;![CDATA['
1062</p><p>
1063[20] Data ::= (Char* - (Char* ']]&gt;' Char*))
1064</p><p>
1065[21] CDEnd ::= ']]&gt;'</p><p>
1066
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1067</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1068</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseContent"></a>xmlParseContent ()</h3><pre class="programlisting">void xmlParseContent (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1069Parse a content:
1070</p><p>
1071[43] content ::= (element | CharData | Reference | CDSect | PI | Comment)*</p><p>
1072
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1073</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1074</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseElement"></a>xmlParseElement ()</h3><pre class="programlisting">void xmlParseElement (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1075parse an XML element, this is highly recursive
1076</p><p>
1077[39] element ::= EmptyElemTag | STag content ETag
1078</p><p>
1079[ WFC: Element Type Match ]
1080The Name in an element's end-tag must match the element type in the
1081start-tag.
1082</p><p>
1083[ VC: Element Valid ]
1084An element is valid if there is a declaration matching elementdecl
1085where the Name matches the element type and one of the following holds:
1086 - The declaration matches EMPTY and the element has no content.
1087 - The declaration matches children and the sequence of child elements
1088 belongs to the language generated by the regular expression in the
1089 content model, with optional white space (characters matching the
1090 nonterminal S) between each pair of child elements.
1091 - The declaration matches Mixed and the content consists of character
1092 data and child elements whose types match names in the content model.
1093 - The declaration matches ANY, and the types of any child elements have
1094 been declared.</p><p>
1095
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1096</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1097</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseVersionNum"></a>xmlParseVersionNum ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseVersionNum (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1098parse the XML version value.
1099</p><p>
1100[26] VersionNum ::= ([a-zA-Z0-9_.:] | '-')+</p><p>
1101
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1102</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1103</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the string giving the XML version number, or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1104</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseVersionInfo"></a>xmlParseVersionInfo ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseVersionInfo (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1105parse the XML version.
1106</p><p>
1107[24] VersionInfo ::= S 'version' Eq (' VersionNum ' | &quot; VersionNum &quot;)
1108</p><p>
1109[25] Eq ::= S? '=' S?</p><p>
1110
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1111</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1112</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the version string, e.g. &quot;1.0&quot;
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1113</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEncName"></a>xmlParseEncName ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseEncName (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1114parse the XML encoding name
1115</p><p>
1116[81] EncName ::= [A-Za-z] ([A-Za-z0-9._] | '-')*</p><p>
1117
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1118</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1119</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the encoding name value or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1120</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseEncodingDecl"></a>xmlParseEncodingDecl ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlParseEncodingDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1121parse the XML encoding declaration
1122</p><p>
1123[80] EncodingDecl ::= S 'encoding' Eq ('&quot;' EncName '&quot;' | &quot;'&quot; EncName &quot;'&quot;)
1124</p><p>
1125this setups the conversion filters.</p><p>
1126
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1127</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1128</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the encoding value or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1129</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseSDDecl"></a>xmlParseSDDecl ()</h3><pre class="programlisting">int xmlParseSDDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1130parse the XML standalone declaration
1131</p><p>
1132[32] SDDecl ::= S 'standalone' Eq
1133 ((&quot;'&quot; ('yes' | 'no') &quot;'&quot;) | ('&quot;' ('yes' | 'no')'&quot;'))
1134</p><p>
1135[ VC: Standalone Document Declaration ]
1136TODO The standalone document declaration must have the value &quot;no&quot;
1137if any external markup declarations contain declarations of:
1138 - attributes with default values, if elements to which these
1139 attributes apply appear in the document without specifications
1140 of values for these attributes, or
1141 - entities (other than amp, lt, gt, apos, quot), if references
1142 to those entities appear in the document, or
1143 - attributes with values subject to normalization, where the
1144 attribute appears in the document with a value which will change
1145 as a result of normalization, or
1146 - element types with element content, if white space occurs directly
1147 within any instance of those types.</p><p>
1148
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1149</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1150</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if standalone, 0 otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1151</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseXMLDecl"></a>xmlParseXMLDecl ()</h3><pre class="programlisting">void xmlParseXMLDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1152parse an XML declaration header
1153</p><p>
1154[23] XMLDecl ::= '&lt;?xml' VersionInfo EncodingDecl? SDDecl? S? '?&gt;'</p><p>
1155
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1156</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1157</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseTextDecl"></a>xmlParseTextDecl ()</h3><pre class="programlisting">void xmlParseTextDecl (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1158parse an XML declaration header for external entities
1159</p><p>
1160[77] TextDecl ::= '&lt;?xml' VersionInfo? EncodingDecl S? '?&gt;'
1161</p><p>
1162Question: Seems that EncodingDecl is mandatory ? Is that a typo ?</p><p>
1163
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1164</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1165</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseMisc"></a>xmlParseMisc ()</h3><pre class="programlisting">void xmlParseMisc (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1166parse an XML Misc* optional field.
1167</p><p>
1168[27] Misc ::= Comment | PI | S</p><p>
1169
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1170</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1171</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseExternalSubset"></a>xmlParseExternalSubset ()</h3><pre class="programlisting">void xmlParseExternalSubset (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1172 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *ExternalID,
1173 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *SystemID);</pre><p>
1174parse Markup declarations from an external subset
1175</p><p>
1176[30] extSubset ::= textDecl? extSubsetDecl
1177</p><p>
1178[31] extSubsetDecl ::= (markupdecl | conditionalSect | PEReference | S) *</p><p>
1179
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1180</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1181</td></tr><tr><td><span class="term"><i><tt>ExternalID</tt></i> :</span></td><td> the external identifier
1182</td></tr><tr><td><span class="term"><i><tt>SystemID</tt></i> :</span></td><td> the system identifier (or URL)
1183</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-SUBSTITUTE-NONE-CAPS"></a>XML_SUBSTITUTE_NONE</h3><pre class="programlisting">#define XML_SUBSTITUTE_NONE 0
1184</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1185If no entities need to be substituted.</p><p>
1186
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1187</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-SUBSTITUTE-REF-CAPS"></a>XML_SUBSTITUTE_REF</h3><pre class="programlisting">#define XML_SUBSTITUTE_REF 1
1188</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1189Whether general entities need to be substituted.</p><p>
1190
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1191</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-SUBSTITUTE-PEREF-CAPS"></a>XML_SUBSTITUTE_PEREF</h3><pre class="programlisting">#define XML_SUBSTITUTE_PEREF 2
1192</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1193Whether parameter entities need to be substituted.</p><p>
1194
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1195</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="XML-SUBSTITUTE-BOTH-CAPS"></a>XML_SUBSTITUTE_BOTH</h3><pre class="programlisting">#define XML_SUBSTITUTE_BOTH 3
1196</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1197Both general and parameter entities need to be substituted.</p><p>
1198
1199</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDecodeEntities"></a>xmlDecodeEntities ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlDecodeEntities (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1200 int len,
1201 int what,
1202 <a href="libxml-tree.html#xmlChar">xmlChar</a> end,
1203 <a href="libxml-tree.html#xmlChar">xmlChar</a> end2,
1204 <a href="libxml-tree.html#xmlChar">xmlChar</a> end3);</pre><p>
1205This function is deprecated, we now always process entities content
1206through xmlStringDecodeEntities
1207</p><p>
1208TODO: remove it in next major release.
1209</p><p>
1210[67] Reference ::= EntityRef | CharRef
1211</p><p>
1212[69] PEReference ::= '%' Name ';'</p><p>
1213
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1214</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the parser context
1215</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> the len to decode (in bytes !), -1 for no size limit
1216</td></tr><tr><td><span class="term"><i><tt>what</tt></i> :</span></td><td> combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
1217</td></tr><tr><td><span class="term"><i><tt>end</tt></i> :</span></td><td> an end marker xmlChar, 0 if none
1218</td></tr><tr><td><span class="term"><i><tt>end2</tt></i> :</span></td><td> an end marker xmlChar, 0 if none
1219</td></tr><tr><td><span class="term"><i><tt>end3</tt></i> :</span></td><td> an end marker xmlChar, 0 if none
1220</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>A newly allocated string with the substitution done. The caller
1221 must deallocate it !
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1222</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStringDecodeEntities"></a>xmlStringDecodeEntities ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlStringDecodeEntities (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1223 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,
1224 int what,
1225 <a href="libxml-tree.html#xmlChar">xmlChar</a> end,
1226 <a href="libxml-tree.html#xmlChar">xmlChar</a> end2,
1227 <a href="libxml-tree.html#xmlChar">xmlChar</a> end3);</pre><p>
1228Takes a entity string content and process to do the adequate substitutions.
1229</p><p>
1230[67] Reference ::= EntityRef | CharRef
1231</p><p>
1232[69] PEReference ::= '%' Name ';'</p><p>
1233
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1234</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the parser context
1235</td></tr><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td> the input string
1236</td></tr><tr><td><span class="term"><i><tt>what</tt></i> :</span></td><td> combination of XML_SUBSTITUTE_REF and XML_SUBSTITUTE_PEREF
1237</td></tr><tr><td><span class="term"><i><tt>end</tt></i> :</span></td><td> an end marker xmlChar, 0 if none
1238</td></tr><tr><td><span class="term"><i><tt>end2</tt></i> :</span></td><td> an end marker xmlChar, 0 if none
1239</td></tr><tr><td><span class="term"><i><tt>end3</tt></i> :</span></td><td> an end marker xmlChar, 0 if none
1240</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>A newly allocated string with the substitution done. The caller
1241 must deallocate it !
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1242</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="nodePush"></a>nodePush ()</h3><pre class="programlisting">int nodePush (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1243 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> value);</pre><p>
1244Pushes a new element node on top of the node stack</p><p>
1245
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1246</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1247</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> the element node
1248</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of error, the index in the stack otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1249</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="nodePop"></a>nodePop ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> nodePop (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1250Pops the top element node from the node stack</p><p>
1251
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1252</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1253</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the node just removed
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1254</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="inputPush"></a>inputPush ()</h3><pre class="programlisting">int inputPush (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1255 <a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> value);</pre><p>
1256Pushes a new parser input on top of the input stack</p><p>
1257
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1258</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1259</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> the parser input
1260</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of error, the index in the stack otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1261</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="inputPop"></a>inputPop ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> inputPop (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1262Pops the top parser input from the input stack</p><p>
1263
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1264</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1265</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the input just removed
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1266</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="namePop"></a>namePop ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* namePop (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1267Pops the top element name from the name stack</p><p>
1268
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1269</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1270</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the name just removed
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1271</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="namePush"></a>namePush ()</h3><pre class="programlisting">int namePush (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1272 <a href="libxml-tree.html#xmlChar">xmlChar</a> *value);</pre><p>
1273Pushes a new element name on top of the name stack</p><p>
1274
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1275</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> an XML parser context
1276</td></tr><tr><td><span class="term"><i><tt>value</tt></i> :</span></td><td> the element name
1277</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 in case of error, the index in the stack otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1278</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSkipBlankChars"></a>xmlSkipBlankChars ()</h3><pre class="programlisting">int xmlSkipBlankChars (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1279skip all blanks character found at that point in the input streams.
1280It pops up finished entities in the process if allowable at that point.</p><p>
1281
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1282</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the XML parser context
1283</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of space chars skipped
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1284</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlStringCurrentChar"></a>xmlStringCurrentChar ()</h3><pre class="programlisting">int xmlStringCurrentChar (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1285 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *cur,
1286 int *len);</pre><p>
1287The current char value, if using UTF-8 this may actually span multiple
1288bytes in the input buffer.</p><p>
1289
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1290</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the XML parser context
1291</td></tr><tr><td><span class="term"><i><tt>cur</tt></i> :</span></td><td> pointer to the beginning of the char
1292</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> pointer to the length of the char read
1293</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the current char value and its length
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1294</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserHandlePEReference"></a>xmlParserHandlePEReference ()</h3><pre class="programlisting">void xmlParserHandlePEReference (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1295[69] PEReference ::= '%' Name ';'
1296</p><p>
1297[ WFC: No Recursion ]
1298A parsed entity must not contain a recursive
1299reference to itself, either directly or indirectly.
1300</p><p>
1301[ WFC: Entity Declared ]
1302In a document without any DTD, a document with only an internal DTD
1303subset which contains no parameter entity references, or a document
1304with &quot;standalone='yes'&quot;, ... ... The declaration of a parameter
1305entity must precede any reference to it...
1306</p><p>
1307[ VC: Entity Declared ]
1308In a document with an external subset or external parameter entities
1309with &quot;standalone='no'&quot;, ... ... The declaration of a parameter entity
1310must precede any reference to it...
1311</p><p>
1312[ WFC: In DTD ]
1313Parameter-entity references may only appear in the DTD.
1314NOTE: misleading but this is handled.
1315</p><p>
1316A PEReference may have been detected in the current input stream
1317the handling is done accordingly to
1318 http://www.w3.org/TR/REC-xml<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="entproc">entproc</GTKDOCLINK>
1319i.e.
1320 - Included in literal in entity values
1321 - Included as Parameter Entity reference within DTDs</p><p>
1322
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1323</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1324</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserHandleReference"></a>xmlParserHandleReference ()</h3><pre class="programlisting">void xmlParserHandleReference (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1325TODO: Remove, now deprecated ... the test is done directly in the
1326 content parsing
1327routines.
1328</p><p>
1329[67] Reference ::= EntityRef | CharRef
1330</p><p>
1331[68] EntityRef ::= '&amp;' Name ';'
1332</p><p>
1333[ WFC: Entity Declared ]
1334the Name given in the entity reference must match that in an entity
1335declaration, except that well-formed documents need not declare any
1336of the following entities: amp, lt, gt, apos, quot.
1337</p><p>
1338[ WFC: Parsed Entity ]
1339An entity reference must not contain the name of an unparsed entity
1340</p><p>
1341[66] CharRef ::= '&amp;#' [0-9]+ ';' |
1342 '&amp;<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="x">x</GTKDOCLINK>' [0-9a-fA-F]+ ';'
1343</p><p>
1344A PEReference may have been detected in the current input stream
1345the handling is done accordingly to
1346 http://www.w3.org/TR/REC-xml<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="entproc">entproc</GTKDOCLINK></p><p>
1347
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1348</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1349</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCheckLanguageID"></a>xmlCheckLanguageID ()</h3><pre class="programlisting">int xmlCheckLanguageID (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *lang);</pre><p>
1350Checks that the value conforms to the LanguageID production:
1351</p><p>
1352NOTE: this is somewhat deprecated, those productions were removed from
1353 the XML Second edition.
1354</p><p>
1355[33] LanguageID ::= Langcode ('-' Subcode)*
1356[34] Langcode ::= ISO639Code | IanaCode | UserCode
1357[35] ISO639Code ::= ([a-z] | [A-Z]) ([a-z] | [A-Z])
1358[36] IanaCode ::= ('i' | 'I') '-' ([a-z] | [A-Z])+
1359[37] UserCode ::= ('x' | 'X') '-' ([a-z] | [A-Z])+
1360[38] Subcode ::= ([a-z] | [A-Z])+</p><p>
1361
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1362</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>lang</tt></i> :</span></td><td> pointer to the string value
1363</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>1 if correct 0 otherwise
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1364</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCurrentChar"></a>xmlCurrentChar ()</h3><pre class="programlisting">int xmlCurrentChar (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt,
1365 int *len);</pre><p>
1366The current char value, if using UTF-8 this may actually span multiple
1367bytes in the input buffer. Implement the end of line normalization:
13682.11 End-of-Line Handling
1369Wherever an external parsed entity or the literal entity value
1370of an internal parsed entity contains either the literal two-character
1371sequence &quot;<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK><GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK>&quot; or a standalone literal <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xD">xD</GTKDOCLINK>, an XML processor
1372must pass to the application the single character <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK>.
1373This behavior can conveniently be produced by normalizing all
1374line breaks to <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="xA">xA</GTKDOCLINK> on input, before parsing.)</p><p>
1375
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1376</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the XML parser context
1377</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> pointer to the length of the char read
1378</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the current char value and its length
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1379</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCopyCharMultiByte"></a>xmlCopyCharMultiByte ()</h3><pre class="programlisting">int xmlCopyCharMultiByte (<a href="libxml-tree.html#xmlChar">xmlChar</a> *out,
1380 int val);</pre><p>
1381append the char value in the array</p><p>
1382
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1383</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>out</tt></i> :</span></td><td> pointer to an array of xmlChar
1384</td></tr><tr><td><span class="term"><i><tt>val</tt></i> :</span></td><td> the char value
1385</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of xmlChar written
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1386</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCopyChar"></a>xmlCopyChar ()</h3><pre class="programlisting">int xmlCopyChar (int len,
1387 <a href="libxml-tree.html#xmlChar">xmlChar</a> *out,
1388 int val);</pre><p>
1389append the char value in the array</p><p>
1390
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1391</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td> Ignored, compatibility
1392</td></tr><tr><td><span class="term"><i><tt>out</tt></i> :</span></td><td> pointer to an array of xmlChar
1393</td></tr><tr><td><span class="term"><i><tt>val</tt></i> :</span></td><td> the char value
1394</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of xmlChar written
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1395</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNextChar"></a>xmlNextChar ()</h3><pre class="programlisting">void xmlNextChar (<a href="libxml-tree.html#xmlParserCtxtPtr">xmlParserCtxtPtr</a> ctxt);</pre><p>
1396Skip to the next char input char.</p><p>
1397
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1398</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ctxt</tt></i> :</span></td><td> the XML parser context
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1399</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParserInputShrink"></a>xmlParserInputShrink ()</h3><pre class="programlisting">void xmlParserInputShrink (<a href="libxml-tree.html#xmlParserInputPtr">xmlParserInputPtr</a> in);</pre><p>
1400This function removes used input for the parser.</p><p>
1401
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1402</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>in</tt></i> :</span></td><td> an XML parser input
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1403</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="htmlInitAutoClose"></a>htmlInitAutoClose ()</h3><pre class="programlisting">void htmlInitAutoClose (void);</pre><p>
1404Initialize the htmlStartCloseIndex for fast lookup of closing tags names.
1405This is not reentrant. Call <a href="libxml-parser.html#xmlInitParser">xmlInitParser</a>() once before processing in
1406case of use in multithreaded programs.</p><p>
1407
1408</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="htmlCreateFileParserCtxt"></a>htmlCreateFileParserCtxt ()</h3><pre class="programlisting"><a href="libxml-HTMLparser.html#htmlParserCtxtPtr">htmlParserCtxtPtr</a> htmlCreateFileParserCtxt (const char *filename,
1409 const char *encoding);</pre><p>
1410Create a parser context for a file content.
1411Automatic support for ZLIB/Compress compressed document is provided
1412by default if found at compile-time.</p><p>
1413
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1414</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the filename
1415</td></tr><tr><td><span class="term"><i><tt>encoding</tt></i> :</span></td><td> a free form C string describing the HTML document encoding, or NULL
1416</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the new parser context or NULL
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1417</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlEntityReferenceFunc"></a>xmlEntityReferenceFunc ()</h3><pre class="programlisting">void (*xmlEntityReferenceFunc) (<a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent,
1418 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> firstNode,
1419 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> lastNode);</pre><p>
1420Callback function used when one needs to be able to track back the
1421provenance of a chunk of nodes inherited from an entity replacement.</p><p>
1422
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1423</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>ent</tt></i> :</span></td><td> the entity
1424</td></tr><tr><td><span class="term"><i><tt>firstNode</tt></i> :</span></td><td> the fist node in the chunk
1425</td></tr><tr><td><span class="term"><i><tt>lastNode</tt></i> :</span></td><td> the last nod in the chunk
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1426</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSetEntityReferenceFunc"></a>xmlSetEntityReferenceFunc ()</h3><pre class="programlisting">void xmlSetEntityReferenceFunc (<a href="libxml-parserInternals.html#xmlEntityReferenceFunc">xmlEntityReferenceFunc</a> func);</pre><p>
1427Set the function to call call back when a xml reference has been made</p><p>
1428
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame^]1429</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>func</tt></i> :</span></td><td> A valid function
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1430</td></tr></tbody></table></div></div></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-DOCBparser.html"><b>&lt;&lt; DOCBparser</b></a></td><td align="right"><a accesskey="n" href="libxml-encoding.html"><b>encoding &gt;&gt;</b></a></td></tr></table></body></html>