Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / libxml2 / 8d7b5c7ecdebc775257495bcdaa855916f2dfbb0 / . / doc / html / libxml-parserInternals.html
blob: 6ba857b4c9600253809878f377a26051850bd688 [file] [log] [blame]
William M. Brack2ad1dff2003-11-15 10:35:20 +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.48"><meta name="generator" content="GTK-Doc V1.1 (XML mode)"><style type="text/css">
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]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 }
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]31 </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual "><link rel="up" href="ch01.html" title="Libxml Programming Notes"><link rel="previous" href="libxml-HTMLtree.html" title="HTMLtree"><link rel="next" href="libxml-entities.html" title="entities"></head><body text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-HTMLtree.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">Gnome XML Library Reference Manual </th><td><a accesskey="n" href="libxml-entities.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry"><a name="libxml-parserInternals"></a><div class="titlepage"></div><div class="refnamediv"><h2>parserInternals</h2><p>parserInternals &#8212; </p></div><div class="refsynopsisdiv"><h2><h1 class="title"><a name="id2597309"></a>Synopsis</h1></h2><pre class="synopsis">
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]32
33
34
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]35extern unsigned int <a href="libxml-parserInternals.html#xmlParserMaxDepth">xmlParserMaxDepth</a>;
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]36#define <a href="libxml-parserInternals.html#XML-MAX-NAMELEN-CAPS">XML_MAX_NAMELEN</a>
37#define <a href="libxml-parserInternals.html#INPUT-CHUNK-CAPS">INPUT_CHUNK</a>
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]38#define <a href="libxml-parserInternals.html#IS-BYTE-CHAR-CAPS">IS_BYTE_CHAR</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]39#define <a href="libxml-parserInternals.html#IS-CHAR-CAPS">IS_CHAR</a> (c)
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]40#define <a href="libxml-parserInternals.html#IS-CHAR-CH-CAPS">IS_CHAR_CH</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]41#define <a href="libxml-parserInternals.html#IS-BLANK-CAPS">IS_BLANK</a> (c)
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]42#define <a href="libxml-parserInternals.html#IS-BLANK-CH-CAPS">IS_BLANK_CH</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]43#define <a href="libxml-parserInternals.html#IS-BASECHAR-CAPS">IS_BASECHAR</a> (c)
44#define <a href="libxml-parserInternals.html#IS-DIGIT-CAPS">IS_DIGIT</a> (c)
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]45#define <a href="libxml-parserInternals.html#IS-DIGIT-CH-CAPS">IS_DIGIT_CH</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]46#define <a href="libxml-parserInternals.html#IS-COMBINING-CAPS">IS_COMBINING</a> (c)
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]47#define <a href="libxml-parserInternals.html#IS-COMBINING-CH-CAPS">IS_COMBINING_CH</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]48#define <a href="libxml-parserInternals.html#IS-EXTENDER-CAPS">IS_EXTENDER</a> (c)
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]49#define <a href="libxml-parserInternals.html#IS-EXTENDER-CH-CAPS">IS_EXTENDER_CH</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]50#define <a href="libxml-parserInternals.html#IS-IDEOGRAPHIC-CAPS">IS_IDEOGRAPHIC</a> (c)
51#define <a href="libxml-parserInternals.html#IS-LETTER-CAPS">IS_LETTER</a> (c)
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]52#define <a href="libxml-parserInternals.html#IS-LETTER-CH-CAPS">IS_LETTER_CH</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]53#define <a href="libxml-parserInternals.html#IS-PUBIDCHAR-CAPS">IS_PUBIDCHAR</a> (c)
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]54#define <a href="libxml-parserInternals.html#IS-PUBIDCHAR-CH-CAPS">IS_PUBIDCHAR_CH</a> (c)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]55#define <a href="libxml-parserInternals.html#SKIP-EOL-CAPS">SKIP_EOL</a> (p)
56#define <a href="libxml-parserInternals.html#MOVETO-ENDTAG-CAPS">MOVETO_ENDTAG</a> (p)
57#define <a href="libxml-parserInternals.html#MOVETO-STARTTAG-CAPS">MOVETO_STARTTAG</a> (p)
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]58#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-NONE-CAPS">XML_SUBSTITUTE_NONE</a>
59#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-REF-CAPS">XML_SUBSTITUTE_REF</a>
60#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-PEREF-CAPS">XML_SUBSTITUTE_PEREF</a>
61#define <a href="libxml-parserInternals.html#XML-SUBSTITUTE-BOTH-CAPS">XML_SUBSTITUTE_BOTH</a>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]62void (<a href="libxml-parserInternals.html#xmlEntityReferenceFunc">*xmlEntityReferenceFunc</a>) (<a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent,
63 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> firstNode,
64 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> lastNode);
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]65</pre></div><div class="refsect1"><h2>Description</h2><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]66
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]67</p></div><div class="refsect1"><h2>Details</h2><div class="refsect2"><h3><a name="xmlParserMaxDepth"></a>xmlParserMaxDepth</h3><pre class="programlisting">extern unsigned int xmlParserMaxDepth;
68</pre><p>
69arbitrary depth limit for the XML documents that we allow to
70process. This is not a limitation of the parser but a safety
71boundary feature.</p><p>
72
73</p></div><hr><div class="refsect2"><h3><a name="XML-MAX-NAMELEN-CAPS"></a>XML_MAX_NAMELEN</h3><pre class="programlisting">#define XML_MAX_NAMELEN 100
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]74</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]75Identifiers can be longer, but this will be more costly
76at runtime.</p><p>
77
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]78</p></div><hr><div class="refsect2"><h3><a name="INPUT-CHUNK-CAPS"></a>INPUT_CHUNK</h3><pre class="programlisting">#define INPUT_CHUNK 250
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]79</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]80The parser tries to always have that amount of input ready.
81One of the point is providing context when reporting errors.</p><p>
82
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]83</p></div><hr><div class="refsect2"><h3><a name="IS-BYTE-CHAR-CAPS"></a>IS_BYTE_CHAR()</h3><pre class="programlisting">#define IS_BYTE_CHAR(c) xmlIsChar_ch(c)
84</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]85Macro to check the following production in the XML spec:
86</p><p>
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]87[2] Char ::= <GTKDOCLINK HREF="x9">x9</GTKDOCLINK> | <GTKDOCLINK HREF="xA">xA</GTKDOCLINK> | <GTKDOCLINK HREF="xD">xD</GTKDOCLINK> | [<GTKDOCLINK HREF="x20">x20</GTKDOCLINK>...]
88any byte character in the accepted range</p><p>
89
90</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an byte value (int)
91</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-CHAR-CAPS"></a>IS_CHAR()</h3><pre class="programlisting">#define IS_CHAR(c) xmlIsCharQ(c)
92</pre><p>
93Macro to check the following production in the XML spec:
94</p><p>
95[2] Char ::= <GTKDOCLINK HREF="x9">x9</GTKDOCLINK> | <GTKDOCLINK HREF="xA">xA</GTKDOCLINK> | <GTKDOCLINK HREF="xD">xD</GTKDOCLINK> | [<GTKDOCLINK HREF="x20-">x20-</GTKDOCLINK><GTKDOCLINK HREF="xD7FF">xD7FF</GTKDOCLINK>] | [<GTKDOCLINK HREF="xE000-">xE000-</GTKDOCLINK><GTKDOCLINK HREF="xFFFD">xFFFD</GTKDOCLINK>]
96 | [<GTKDOCLINK HREF="x10000-">x10000-</GTKDOCLINK><GTKDOCLINK HREF="x10FFFF">x10FFFF</GTKDOCLINK>]
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]97any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.</p><p>
98
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]99</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
100</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-CHAR-CH-CAPS"></a>IS_CHAR_CH()</h3><pre class="programlisting">#define IS_CHAR_CH(c) xmlIsChar_ch(c)
101</pre><p>
102Behaves like IS_CHAR on single-byte value</p><p>
103
104</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an xmlChar (usually an unsigned char)
105</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-BLANK-CAPS"></a>IS_BLANK()</h3><pre class="programlisting">#define IS_BLANK(c) xmlIsBlankQ(c)
106</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]107Macro to check the following production in the XML spec:
108</p><p>
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]109[3] S ::= (<GTKDOCLINK HREF="x20">x20</GTKDOCLINK> | <GTKDOCLINK HREF="x9">x9</GTKDOCLINK> | <GTKDOCLINK HREF="xD">xD</GTKDOCLINK> | <GTKDOCLINK HREF="xA">xA</GTKDOCLINK>)+</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]110
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]111</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
112</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-BLANK-CH-CAPS"></a>IS_BLANK_CH()</h3><pre class="programlisting">#define IS_BLANK_CH(c) xmlIsBlank_ch(c)
113</pre><p>
114Behaviour same as IS_BLANK</p><p>
115
116</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an xmlChar value (normally unsigned char)
117</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-BASECHAR-CAPS"></a>IS_BASECHAR()</h3><pre class="programlisting">#define IS_BASECHAR(c) xmlIsBaseCharQ(c)
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]118</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]119Macro to check the following production in the XML spec:
120</p><p>
121[85] BaseChar ::= ... long list see REC ...</p><p>
122
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]123</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
124</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-DIGIT-CAPS"></a>IS_DIGIT()</h3><pre class="programlisting">#define IS_DIGIT(c) xmlIsDigitQ(c)
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]125</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]126Macro to check the following production in the XML spec:
127</p><p>
128[88] Digit ::= ... long list see REC ...</p><p>
129
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]130</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
131</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-DIGIT-CH-CAPS"></a>IS_DIGIT_CH()</h3><pre class="programlisting">#define IS_DIGIT_CH(c) xmlIsDigit_ch(c)
132</pre><p>
133Behaves like IS_DIGIT but with a single byte argument</p><p>
134
135</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an xmlChar value (usually an unsigned char)
136</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-COMBINING-CAPS"></a>IS_COMBINING()</h3><pre class="programlisting">#define IS_COMBINING(c) xmlIsCombiningQ(c)
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]137</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]138Macro to check the following production in the XML spec:
139</p><p>
140[87] CombiningChar ::= ... long list see REC ...</p><p>
141
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]142</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
143</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-COMBINING-CH-CAPS"></a>IS_COMBINING_CH()</h3><pre class="programlisting">#define IS_COMBINING_CH(c) 0
144</pre><p>
145Always false (all combining chars &gt; 0xff)</p><p>
146
147</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an xmlChar (usually an unsigned char)
148</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-EXTENDER-CAPS"></a>IS_EXTENDER()</h3><pre class="programlisting">#define IS_EXTENDER(c) xmlIsExtenderQ(c)
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]149</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]150Macro to check the following production in the XML spec:
151</p><p>
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]152[89] Extender ::= <GTKDOCLINK HREF="x00B7">x00B7</GTKDOCLINK> | <GTKDOCLINK HREF="x02D0">x02D0</GTKDOCLINK> | <GTKDOCLINK HREF="x02D1">x02D1</GTKDOCLINK> | <GTKDOCLINK HREF="x0387">x0387</GTKDOCLINK> | <GTKDOCLINK HREF="x0640">x0640</GTKDOCLINK> |
153 <GTKDOCLINK HREF="x0E46">x0E46</GTKDOCLINK> | <GTKDOCLINK HREF="x0EC6">x0EC6</GTKDOCLINK> | <GTKDOCLINK HREF="x3005">x3005</GTKDOCLINK> | [<GTKDOCLINK HREF="x3031-">x3031-</GTKDOCLINK><GTKDOCLINK HREF="x3035">x3035</GTKDOCLINK>] |
154 [<GTKDOCLINK HREF="x309D-">x309D-</GTKDOCLINK><GTKDOCLINK HREF="x309E">x309E</GTKDOCLINK>] | [<GTKDOCLINK HREF="x30FC-">x30FC-</GTKDOCLINK><GTKDOCLINK HREF="x30FE">x30FE</GTKDOCLINK>]</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]155
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]156</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
157</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-EXTENDER-CH-CAPS"></a>IS_EXTENDER_CH()</h3><pre class="programlisting">#define IS_EXTENDER_CH(c) xmlIsExtender_ch(c)
158</pre><p>
159Behaves like IS_EXTENDER but with a single-byte argument</p><p>
160
161</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an xmlChar value (usually an unsigned char)
162</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-IDEOGRAPHIC-CAPS"></a>IS_IDEOGRAPHIC()</h3><pre class="programlisting">#define IS_IDEOGRAPHIC(c) xmlIsIdeographicQ(c)
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]163</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]164Macro to check the following production in the XML spec:
165</p><p>
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]166[86] Ideographic ::= [<GTKDOCLINK HREF="x4E00-">x4E00-</GTKDOCLINK><GTKDOCLINK HREF="x9FA5">x9FA5</GTKDOCLINK>] | <GTKDOCLINK HREF="x3007">x3007</GTKDOCLINK> | [<GTKDOCLINK HREF="x3021-">x3021-</GTKDOCLINK><GTKDOCLINK HREF="x3029">x3029</GTKDOCLINK>]</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]167
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]168</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
169</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-LETTER-CAPS"></a>IS_LETTER()</h3><pre class="programlisting">#define IS_LETTER(c) (IS_BASECHAR(c) || IS_IDEOGRAPHIC(c))
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]170</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]171Macro to check the following production in the XML spec:
172</p><p>
173[84] Letter ::= BaseChar | Ideographic</p><p>
174
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]175</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
176</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-LETTER-CH-CAPS"></a>IS_LETTER_CH()</h3><pre class="programlisting">#define IS_LETTER_CH(c) xmlIsBaseChar_ch(c)
177</pre><p>
178Macro behaves like IS_LETTER, but only check base chars</p><p>
179
180</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an xmlChar value (normally unsigned char)
181</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-PUBIDCHAR-CAPS"></a>IS_PUBIDCHAR()</h3><pre class="programlisting">#define IS_PUBIDCHAR(c) xmlIsPubidCharQ(c)
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]182</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]183Macro to check the following production in the XML spec:
184</p><p>
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]185[13] PubidChar ::= <GTKDOCLINK HREF="x20">x20</GTKDOCLINK> | <GTKDOCLINK HREF="xD">xD</GTKDOCLINK> | <GTKDOCLINK HREF="xA">xA</GTKDOCLINK> | [a-zA-Z0-9] | [-'()+,./:=?;!*#@$_%]</p><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]186
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]187</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an UNICODE value (int)
188</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="IS-PUBIDCHAR-CH-CAPS"></a>IS_PUBIDCHAR_CH()</h3><pre class="programlisting">#define IS_PUBIDCHAR_CH(c) xmlIsPubidChar_ch(c)
189</pre><p>
190Same as IS_PUBIDCHAR but for single-byte value</p><p>
191
192</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>c</tt></i>:</span></td><td> an xmlChar value (normally unsigned char)
193</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="SKIP-EOL-CAPS"></a>SKIP_EOL()</h3><pre class="programlisting">#define SKIP_EOL(p)</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]194Skips the end of line chars.</p><p>
195
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]196</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>p</tt></i>:</span></td><td> and UTF8 string pointer
197</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="MOVETO-ENDTAG-CAPS"></a>MOVETO_ENDTAG()</h3><pre class="programlisting">#define MOVETO_ENDTAG(p)</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]198Skips to the next '&gt;' char.</p><p>
199
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]200</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>p</tt></i>:</span></td><td> and UTF8 string pointer
201</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="MOVETO-STARTTAG-CAPS"></a>MOVETO_STARTTAG()</h3><pre class="programlisting">#define MOVETO_STARTTAG(p)</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]202Skips to the next '&lt;' char.</p><p>
203
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]204</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>p</tt></i>:</span></td><td> and UTF8 string pointer
205</td></tr></tbody></table></div></div><hr><div class="refsect2"><h3><a name="XML-SUBSTITUTE-NONE-CAPS"></a>XML_SUBSTITUTE_NONE</h3><pre class="programlisting">#define XML_SUBSTITUTE_NONE 0
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]206</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]207If no entities need to be substituted.</p><p>
208
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]209</p></div><hr><div class="refsect2"><h3><a name="XML-SUBSTITUTE-REF-CAPS"></a>XML_SUBSTITUTE_REF</h3><pre class="programlisting">#define XML_SUBSTITUTE_REF 1
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]210</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]211Whether general entities need to be substituted.</p><p>
212
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]213</p></div><hr><div class="refsect2"><h3><a name="XML-SUBSTITUTE-PEREF-CAPS"></a>XML_SUBSTITUTE_PEREF</h3><pre class="programlisting">#define XML_SUBSTITUTE_PEREF 2
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]214</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]215Whether parameter entities need to be substituted.</p><p>
216
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]217</p></div><hr><div class="refsect2"><h3><a name="XML-SUBSTITUTE-BOTH-CAPS"></a>XML_SUBSTITUTE_BOTH</h3><pre class="programlisting">#define XML_SUBSTITUTE_BOTH 3
Daniel Veillardd7cec922003-06-13 12:30:10 +0000[diff] [blame]218</pre><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]219Both general and parameter entities need to be substituted.</p><p>
220
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]221</p></div><hr><div class="refsect2"><h3><a name="xmlEntityReferenceFunc"></a>xmlEntityReferenceFunc ()</h3><pre class="programlisting">void (*xmlEntityReferenceFunc) (<a href="libxml-tree.html#xmlEntityPtr">xmlEntityPtr</a> ent,
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]222 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> firstNode,
223 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> lastNode);</pre><p>
224Callback function used when one needs to be able to track back the
225provenance of a chunk of nodes inherited from an entity replacement.</p><p>
226
William M. Brack2ad1dff2003-11-15 10:35:20 +0000[diff] [blame]227</p><div class="variablelist"><table border="0"><col align="left"><tbody><tr><td><span class="term"><i><tt>ent</tt></i>:</span></td><td> the entity
228</td></tr><tr><td><span class="term"><i><tt>firstNode</tt></i>:</span></td><td> the fist node in the chunk
229</td></tr><tr><td><span class="term"><i><tt>lastNode</tt></i>:</span></td><td> the last nod in the chunk
230</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-HTMLtree.html"><b>&lt;&lt; HTMLtree</b></a></td><td align="right"><a accesskey="n" href="libxml-entities.html"><b>entities &gt;&gt;</b></a></td></tr></table></body></html>