blob: 19720a5d4a0cf61d28686eee6ac1d7618431e8ef [file] [log] [blame]
Daniel Veillardd4330462003-04-29 12:40:16 +00001<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>debugXML</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
3 .synopsis, .classsynopsis {
4 background: #eeeeee;
5 border: solid 1px #aaaaaa;
6 padding: 0.5em;
7 }
8 .programlisting {
9 background: #eeeeff;
10 border: solid 1px #aaaaff;
11 padding: 0.5em;
12 }
13 .variablelist {
14 padding: 4px;
15 margin-left: 3em;
16 }
17 .navigation {
18 background: #ffeeee;
19 border: solid 1px #ffaaaa;
20 margin-top: 0.5em;
21 margin-bottom: 0.5em;
22 }
23 .navigation a {
24 color: #770000;
25 }
26 .navigation a:visited {
27 color: #550000;
28 }
29 .navigation .title {
30 font-size: 200%;
31 }
32 </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-hash.html" title="hash"><link rel="next" href="libxml-xmlmemory.html" title="xmlmemory"></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-hash.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-xmlmemory.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-debugXML"></a><div class="titlepage"></div><div class="refnamediv"><h2>debugXML</h2><p>debugXML &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
33
34
35
36void <a href="libxml-debugXML.html#xmlDebugDumpString">xmlDebugDumpString</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
37 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);
38void <a href="libxml-debugXML.html#xmlDebugDumpAttr">xmlDebugDumpAttr</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
39 <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
40 int depth);
41void <a href="libxml-debugXML.html#xmlDebugDumpAttrList">xmlDebugDumpAttrList</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
42 <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
43 int depth);
44void <a href="libxml-debugXML.html#xmlDebugDumpOneNode">xmlDebugDumpOneNode</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
45 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
46 int depth);
47void <a href="libxml-debugXML.html#xmlDebugDumpNode">xmlDebugDumpNode</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
48 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
49 int depth);
50void <a href="libxml-debugXML.html#xmlDebugDumpNodeList">xmlDebugDumpNodeList</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
51 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
52 int depth);
53void <a href="libxml-debugXML.html#xmlDebugDumpDocumentHead">xmlDebugDumpDocumentHead</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
54 <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
55void <a href="libxml-debugXML.html#xmlDebugDumpDocument">xmlDebugDumpDocument</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
56 <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
57void <a href="libxml-debugXML.html#xmlDebugDumpDTD">xmlDebugDumpDTD</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
58 <a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd);
59void <a href="libxml-debugXML.html#xmlDebugDumpEntities">xmlDebugDumpEntities</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
60 <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
61void <a href="libxml-debugXML.html#xmlLsOneNode">xmlLsOneNode</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
62 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);
63int <a href="libxml-debugXML.html#xmlLsCountNode">xmlLsCountNode</a> (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);
64char* (<a href="libxml-debugXML.html#xmlShellReadlineFunc">*xmlShellReadlineFunc</a>) (char *prompt);
65struct <a href="libxml-debugXML.html#xmlShellCtxt">xmlShellCtxt</a>;
66typedef <a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a>;
67int (<a href="libxml-debugXML.html#xmlShellCmd">*xmlShellCmd</a>) (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
68 char *arg,
69 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
70 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
71void <a href="libxml-debugXML.html#xmlShellPrintXPathError">xmlShellPrintXPathError</a> (int errorType,
72 const char *arg);
73void <a href="libxml-debugXML.html#xmlShellPrintNode">xmlShellPrintNode</a> (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);
74void <a href="libxml-debugXML.html#xmlShellPrintXPathResult">xmlShellPrintXPathResult</a> (<a href="libxml-xpath.html#xmlXPathObjectPtr">xmlXPathObjectPtr</a> list);
75int <a href="libxml-debugXML.html#xmlShellList">xmlShellList</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
76 char *arg,
77 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
78 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
79int <a href="libxml-debugXML.html#xmlShellBase">xmlShellBase</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
80 char *arg,
81 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
82 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
83int <a href="libxml-debugXML.html#xmlShellDir">xmlShellDir</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
84 char *arg,
85 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
86 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
87int <a href="libxml-debugXML.html#xmlShellCat">xmlShellCat</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
88 char *arg,
89 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
90 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
91int <a href="libxml-debugXML.html#xmlShellLoad">xmlShellLoad</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
92 char *filename,
93 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
94 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
95int <a href="libxml-debugXML.html#xmlShellWrite">xmlShellWrite</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
96 char *filename,
97 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
98 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
99int <a href="libxml-debugXML.html#xmlShellSave">xmlShellSave</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
100 char *filename,
101 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
102 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
103int <a href="libxml-debugXML.html#xmlShellValidate">xmlShellValidate</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
104 char *dtd,
105 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
106 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
107int <a href="libxml-debugXML.html#xmlShellDu">xmlShellDu</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
108 char *arg,
109 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> tree,
110 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
111int <a href="libxml-debugXML.html#xmlShellPwd">xmlShellPwd</a> (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
112 char *buffer,
113 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
114 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
115void <a href="libxml-debugXML.html#xmlShell">xmlShell</a> (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,
116 char *filename,
117 <a href="libxml-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input,
118 <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output);
119</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
120
121</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpString"></a>xmlDebugDumpString ()</h3><pre class="programlisting">void xmlDebugDumpString (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
122 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);</pre><p>
123Dumps informations about the string, shorten it if necessary</p><p>
124
Daniel Veillard93d95252003-04-29 20:25:40 +0000125</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
126</td></tr><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td>
127
128
Daniel Veillardd4330462003-04-29 12:40:16 +0000129</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpAttr"></a>xmlDebugDumpAttr ()</h3><pre class="programlisting">void xmlDebugDumpAttr (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
130 <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
131 int depth);</pre><p>
132Dumps debug information for the attribute</p><p>
133
Daniel Veillard93d95252003-04-29 20:25:40 +0000134</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
135</td></tr><tr><td><span class="term"><i><tt>attr</tt></i> :</span></td><td>
136</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>
137
138
Daniel Veillardd4330462003-04-29 12:40:16 +0000139</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpAttrList"></a>xmlDebugDumpAttrList ()</h3><pre class="programlisting">void xmlDebugDumpAttrList (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
140 <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
141 int depth);</pre><p>
142Dumps debug information for the attribute list</p><p>
143
Daniel Veillard93d95252003-04-29 20:25:40 +0000144</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
145</td></tr><tr><td><span class="term"><i><tt>attr</tt></i> :</span></td><td>
146</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>
147
148
Daniel Veillardd4330462003-04-29 12:40:16 +0000149</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpOneNode"></a>xmlDebugDumpOneNode ()</h3><pre class="programlisting">void xmlDebugDumpOneNode (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
150 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
151 int depth);</pre><p>
152Dumps debug information for the element node, it is not recursive</p><p>
153
Daniel Veillard93d95252003-04-29 20:25:40 +0000154</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
155</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
156</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>
157
158
Daniel Veillardd4330462003-04-29 12:40:16 +0000159</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpNode"></a>xmlDebugDumpNode ()</h3><pre class="programlisting">void xmlDebugDumpNode (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
160 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
161 int depth);</pre><p>
162Dumps debug information for the element node, it is recursive</p><p>
163
Daniel Veillard93d95252003-04-29 20:25:40 +0000164</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
165</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
166</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>
167
168
Daniel Veillardd4330462003-04-29 12:40:16 +0000169</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpNodeList"></a>xmlDebugDumpNodeList ()</h3><pre class="programlisting">void xmlDebugDumpNodeList (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
170 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
171 int depth);</pre><p>
172Dumps debug information for the list of element node, it is recursive</p><p>
173
Daniel Veillard93d95252003-04-29 20:25:40 +0000174</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
175</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
176</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>
177
178
Daniel Veillardd4330462003-04-29 12:40:16 +0000179</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpDocumentHead"></a>xmlDebugDumpDocumentHead ()</h3><pre class="programlisting">void xmlDebugDumpDocumentHead (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
180 <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>
181Dumps debug information cncerning the document, not recursive</p><p>
182
Daniel Veillard93d95252003-04-29 20:25:40 +0000183</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
184</td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td>
185
186
Daniel Veillardd4330462003-04-29 12:40:16 +0000187</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpDocument"></a>xmlDebugDumpDocument ()</h3><pre class="programlisting">void xmlDebugDumpDocument (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
188 <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>
189Dumps debug information for the document, it's recursive</p><p>
190
Daniel Veillard93d95252003-04-29 20:25:40 +0000191</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
192</td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td>
193
194
Daniel Veillardd4330462003-04-29 12:40:16 +0000195</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpDTD"></a>xmlDebugDumpDTD ()</h3><pre class="programlisting">void xmlDebugDumpDTD (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
196 <a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd);</pre><p>
197Dumps debug information for the DTD</p><p>
198
Daniel Veillard93d95252003-04-29 20:25:40 +0000199</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
200</td></tr><tr><td><span class="term"><i><tt>dtd</tt></i> :</span></td><td>
201
202
Daniel Veillardd4330462003-04-29 12:40:16 +0000203</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlDebugDumpEntities"></a>xmlDebugDumpEntities ()</h3><pre class="programlisting">void xmlDebugDumpEntities (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
204 <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>
205Dumps debug information for all the entities in use by the document</p><p>
206
Daniel Veillard93d95252003-04-29 20:25:40 +0000207</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
208</td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td>
209
210
Daniel Veillardd4330462003-04-29 12:40:16 +0000211</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLsOneNode"></a>xmlLsOneNode ()</h3><pre class="programlisting">void xmlLsOneNode (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
212 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>
213Dump to <i><tt>output</tt></i> the type and name of <i><tt>node</tt></i>.</p><p>
214
Daniel Veillard93d95252003-04-29 20:25:40 +0000215</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
216</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
217
218
Daniel Veillardd4330462003-04-29 12:40:16 +0000219</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlLsCountNode"></a>xmlLsCountNode ()</h3><pre class="programlisting">int xmlLsCountNode (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>
220Count the children of <i><tt>node</tt></i>.</p><p>
221
Daniel Veillard93d95252003-04-29 20:25:40 +0000222</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
223</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
224
225
Daniel Veillardd4330462003-04-29 12:40:16 +0000226</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellReadlineFunc"></a>xmlShellReadlineFunc ()</h3><pre class="programlisting">char* (*xmlShellReadlineFunc) (char *prompt);</pre><p>
227This is a generic signature for the XML shell input function.</p><p>
228
Daniel Veillard93d95252003-04-29 20:25:40 +0000229</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>prompt</tt></i> :</span></td><td>
230</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
231
232
Daniel Veillardd4330462003-04-29 12:40:16 +0000233</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellCtxt"></a>struct xmlShellCtxt</h3><pre class="programlisting">struct xmlShellCtxt {
234 char *filename;
235 xmlDocPtr doc;
236 xmlNodePtr node;
237 xmlXPathContextPtr pctxt;
238 int loaded;
239 FILE *output;
240 xmlShellReadlineFunc input;
241};
242</pre><p>
243A debugging shell context.
244TODO: add the defined function tables.</p><p>
245
Daniel Veillard93d95252003-04-29 20:25:40 +0000246</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellCtxtPtr"></a>xmlShellCtxtPtr</h3><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000247
248</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellCmd"></a>xmlShellCmd ()</h3><pre class="programlisting">int (*xmlShellCmd) (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
249 char *arg,
250 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
251 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
252This is a generic signature for the XML shell functions.</p><p>
253
Daniel Veillard93d95252003-04-29 20:25:40 +0000254</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>
255</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
256</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
257</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
258</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
259
260
Daniel Veillardd4330462003-04-29 12:40:16 +0000261</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellPrintXPathError"></a>xmlShellPrintXPathError ()</h3><pre class="programlisting">void xmlShellPrintXPathError (int errorType,
262 const char *arg);</pre><p>
263Print the xpath error to libxml default error channel</p><p>
264
Daniel Veillard93d95252003-04-29 20:25:40 +0000265</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>errorType</tt></i> :</span></td><td>
266</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
267
268
Daniel Veillardd4330462003-04-29 12:40:16 +0000269</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellPrintNode"></a>xmlShellPrintNode ()</h3><pre class="programlisting">void xmlShellPrintNode (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>
270Print node to the output FILE</p><p>
271
Daniel Veillard93d95252003-04-29 20:25:40 +0000272</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
273
274
Daniel Veillardd4330462003-04-29 12:40:16 +0000275</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellPrintXPathResult"></a>xmlShellPrintXPathResult ()</h3><pre class="programlisting">void xmlShellPrintXPathResult (<a href="libxml-xpath.html#xmlXPathObjectPtr">xmlXPathObjectPtr</a> list);</pre><p>
276Prints result to the output FILE</p><p>
277
Daniel Veillard93d95252003-04-29 20:25:40 +0000278</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>list</tt></i> :</span></td><td>
279
280
Daniel Veillardd4330462003-04-29 12:40:16 +0000281</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellList"></a>xmlShellList ()</h3><pre class="programlisting">int xmlShellList (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
282 char *arg,
283 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
284 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
285Implements the XML shell function &quot;ls&quot;
286Does an Unix like listing of the given node (like a directory)</p><p>
287
Daniel Veillard93d95252003-04-29 20:25:40 +0000288</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>
289</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
290</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
291</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
292</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
293
294
Daniel Veillardd4330462003-04-29 12:40:16 +0000295</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellBase"></a>xmlShellBase ()</h3><pre class="programlisting">int xmlShellBase (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
296 char *arg,
297 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
298 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
299Implements the XML shell function &quot;base&quot;
300dumps the current XML base of the node</p><p>
301
Daniel Veillard93d95252003-04-29 20:25:40 +0000302</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>
303</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
304</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
305</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
306</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
307
308
Daniel Veillardd4330462003-04-29 12:40:16 +0000309</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellDir"></a>xmlShellDir ()</h3><pre class="programlisting">int xmlShellDir (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
310 char *arg,
311 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
312 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
313Implements the XML shell function &quot;dir&quot;
314dumps informations about the node (namespace, attributes, content).</p><p>
315
Daniel Veillard93d95252003-04-29 20:25:40 +0000316</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>
317</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
318</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
319</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
320</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
321
322
Daniel Veillardd4330462003-04-29 12:40:16 +0000323</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellCat"></a>xmlShellCat ()</h3><pre class="programlisting">int xmlShellCat (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
324 char *arg,
325 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
326 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
327Implements the XML shell function &quot;cat&quot;
328dumps the serialization node content (XML or HTML).</p><p>
329
Daniel Veillard93d95252003-04-29 20:25:40 +0000330</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>
331</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
332</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
333</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
334</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
335
336
Daniel Veillardd4330462003-04-29 12:40:16 +0000337</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellLoad"></a>xmlShellLoad ()</h3><pre class="programlisting">int xmlShellLoad (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
338 char *filename,
339 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
340 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
341Implements the XML shell function &quot;load&quot;
342loads a new document specified by the filename</p><p>
343
Daniel Veillard93d95252003-04-29 20:25:40 +0000344</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>
345</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>
346</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
347</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
348</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
349
350
Daniel Veillardd4330462003-04-29 12:40:16 +0000351</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellWrite"></a>xmlShellWrite ()</h3><pre class="programlisting">int xmlShellWrite (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
352 char *filename,
353 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
354 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
355Implements the XML shell function &quot;write&quot;
356Write the current node to the filename, it saves the serialization
357of the subtree under the <i><tt>node</tt></i> specified</p><p>
358
Daniel Veillard93d95252003-04-29 20:25:40 +0000359</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>
360</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>
361</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
362</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
363</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
364
365
Daniel Veillardd4330462003-04-29 12:40:16 +0000366</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellSave"></a>xmlShellSave ()</h3><pre class="programlisting">int xmlShellSave (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
367 char *filename,
368 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
369 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
370Implements the XML shell function &quot;save&quot;
371Write the current document to the filename, or it's original name</p><p>
372
Daniel Veillard93d95252003-04-29 20:25:40 +0000373</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>
374</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>
375</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
376</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
377</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
378
379
Daniel Veillardd4330462003-04-29 12:40:16 +0000380</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellValidate"></a>xmlShellValidate ()</h3><pre class="programlisting">int xmlShellValidate (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
381 char *dtd,
382 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
383 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
384Implements the XML shell function &quot;validate&quot;
385Validate the document, if a DTD path is provided, then the validation
386is done against the given DTD.</p><p>
387
Daniel Veillard93d95252003-04-29 20:25:40 +0000388</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>
389</td></tr><tr><td><span class="term"><i><tt>dtd</tt></i> :</span></td><td>
390</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
391</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
392</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
393
394
Daniel Veillardd4330462003-04-29 12:40:16 +0000395</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellDu"></a>xmlShellDu ()</h3><pre class="programlisting">int xmlShellDu (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
396 char *arg,
397 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> tree,
398 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
399Implements the XML shell function &quot;du&quot;
400show the structure of the subtree under node <i><tt>tree</tt></i>
401If <i><tt>tree</tt></i> is null, the command works on the current node.</p><p>
402
Daniel Veillard93d95252003-04-29 20:25:40 +0000403</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>
404</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>
405</td></tr><tr><td><span class="term"><i><tt>tree</tt></i> :</span></td><td>
406</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
407</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
408
409
Daniel Veillardd4330462003-04-29 12:40:16 +0000410</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellPwd"></a>xmlShellPwd ()</h3><pre class="programlisting">int xmlShellPwd (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
411 char *buffer,
412 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
413 <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
414Implements the XML shell function &quot;pwd&quot;
415Show the full path from the root to the node, if needed building
416thumblers when similar elements exists at a given ancestor level.
417The output is compatible with XPath commands.</p><p>
418
Daniel Veillard93d95252003-04-29 20:25:40 +0000419</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>
420</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td>
421</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>
422</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>
423</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
424
425
Daniel Veillardd4330462003-04-29 12:40:16 +0000426</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShell"></a>xmlShell ()</h3><pre class="programlisting">void xmlShell (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,
427 char *filename,
428 <a href="libxml-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input,
429 <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output);</pre><p>
430Implements the XML shell
431This allow to load, validate, view, modify and save a document
432using a environment similar to a UNIX commandline.</p><p>
433
Daniel Veillard93d95252003-04-29 20:25:40 +0000434</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td>
435</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>
436</td></tr><tr><td><span class="term"><i><tt>input</tt></i> :</span></td><td>
437</td></tr><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>
438
439
Daniel Veillardd4330462003-04-29 12:40:16 +0000440</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-hash.html"><b>&lt;&lt; hash</b></a></td><td align="right"><a accesskey="n" href="libxml-xmlmemory.html"><b>xmlmemory &gt;&gt;</b></a></td></tr></table></body></html>