libxml2/doc/html/libxml-debugxml.html

   1 <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">
   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-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">
  32
  33
  34
  35 void        <a href="libxml-debugXML.html#xmlDebugDumpString">xmlDebugDumpString</a>              (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  36                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);
  37 void        <a href="libxml-debugXML.html#xmlDebugDumpAttr">xmlDebugDumpAttr</a>                (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  38                                              <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
  39                                              int depth);
  40 void        <a href="libxml-debugXML.html#xmlDebugDumpAttrList">xmlDebugDumpAttrList</a>            (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  41                                              <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
  42                                              int depth);
  43 void        <a href="libxml-debugXML.html#xmlDebugDumpOneNode">xmlDebugDumpOneNode</a>             (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  44                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  45                                              int depth);
  46 void        <a href="libxml-debugXML.html#xmlDebugDumpNode">xmlDebugDumpNode</a>                (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  47                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  48                                              int depth);
  49 void        <a href="libxml-debugXML.html#xmlDebugDumpNodeList">xmlDebugDumpNodeList</a>            (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  50                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  51                                              int depth);
  52 void        <a href="libxml-debugXML.html#xmlDebugDumpDocumentHead">xmlDebugDumpDocumentHead</a>        (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  53                                              <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
  54 void        <a href="libxml-debugXML.html#xmlDebugDumpDocument">xmlDebugDumpDocument</a>            (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  55                                              <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
  56 void        <a href="libxml-debugXML.html#xmlDebugDumpDTD">xmlDebugDumpDTD</a>                 (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  57                                              <a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd);
  58 void        <a href="libxml-debugXML.html#xmlDebugDumpEntities">xmlDebugDumpEntities</a>            (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  59                                              <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);
  60 void        <a href="libxml-debugXML.html#xmlLsOneNode">xmlLsOneNode</a>                    (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output,
  61                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);
  62 int         <a href="libxml-debugXML.html#xmlLsCountNode">xmlLsCountNode</a>                  (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);
  63 char*       (<a href="libxml-debugXML.html#xmlShellReadlineFunc">*xmlShellReadlineFunc</a>)         (char *prompt);
  64 struct      <a href="libxml-debugXML.html#xmlShellCtxt">xmlShellCtxt</a>;
  65 typedef     <a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a>;
  66 int         (<a href="libxml-debugXML.html#xmlShellCmd">*xmlShellCmd</a>)                  (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  67                                              char *arg,
  68                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  69                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
  70 void        <a href="libxml-debugXML.html#xmlShellPrintXPathError">xmlShellPrintXPathError</a>         (int errorType,
  71                                              const char *arg);
  72 void        <a href="libxml-debugXML.html#xmlShellPrintNode">xmlShellPrintNode</a>               (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);
  73 void        <a href="libxml-debugXML.html#xmlShellPrintXPathResult">xmlShellPrintXPathResult</a>        (<a href="libxml-xpath.html#xmlXPathObjectPtr">xmlXPathObjectPtr</a> list);
  74 int         <a href="libxml-debugXML.html#xmlShellList">xmlShellList</a>                    (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  75                                              char *arg,
  76                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  77                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
  78 int         <a href="libxml-debugXML.html#xmlShellBase">xmlShellBase</a>                    (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  79                                              char *arg,
  80                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  81                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
  82 int         <a href="libxml-debugXML.html#xmlShellDir">xmlShellDir</a>                     (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  83                                              char *arg,
  84                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  85                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
  86 int         <a href="libxml-debugXML.html#xmlShellCat">xmlShellCat</a>                     (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  87                                              char *arg,
  88                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  89                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
  90 int         <a href="libxml-debugXML.html#xmlShellLoad">xmlShellLoad</a>                    (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  91                                              char *filename,
  92                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  93                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
  94 int         <a href="libxml-debugXML.html#xmlShellWrite">xmlShellWrite</a>                   (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  95                                              char *filename,
  96                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
  97                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
  98 int         <a href="libxml-debugXML.html#xmlShellSave">xmlShellSave</a>                    (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
  99                                              char *filename,
 100                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 101                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
 102 int         <a href="libxml-debugXML.html#xmlShellValidate">xmlShellValidate</a>                (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
 103                                              char *dtd,
 104                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 105                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
 106 int         <a href="libxml-debugXML.html#xmlShellDu">xmlShellDu</a>                      (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
 107                                              char *arg,
 108                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> tree,
 109                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
 110 int         <a href="libxml-debugXML.html#xmlShellPwd">xmlShellPwd</a>                     (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
 111                                              char *buffer,
 112                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 113                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);
 114 void        <a href="libxml-debugXML.html#xmlShell">xmlShell</a>                        (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,
 115                                              char *filename,
 116                                              <a href="libxml-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input,
 117                                              <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output);
 118 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
 119
 120 </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,
 121                                              const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);</pre><p>
 122 Dumps informations about the string, shorten it if necessary</p><p>
 123
 124 </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>  the FILE * for the output
 125 </td></tr><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td>  the string
 126 </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,
 127                                              <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
 128                                              int depth);</pre><p>
 129 Dumps debug information for the attribute</p><p>
 130
 131 </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>  the FILE * for the output
 132 </td></tr><tr><td><span class="term"><i><tt>attr</tt></i> :</span></td><td>  the attribute
 133 </td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>  the indentation level.
 134 </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,
 135                                              <a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,
 136                                              int depth);</pre><p>
 137 Dumps debug information for the attribute list</p><p>
 138
 139 </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>  the FILE * for the output
 140 </td></tr><tr><td><span class="term"><i><tt>attr</tt></i> :</span></td><td>  the attribute list
 141 </td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>  the indentation level.
 142 </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,
 143                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 144                                              int depth);</pre><p>
 145 Dumps debug information for the element node, it is not recursive</p><p>
 146
 147 </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>  the FILE * for the output
 148 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  the node
 149 </td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>  the indentation level.
 150 </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,
 151                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 152                                              int depth);</pre><p>
 153 Dumps debug information for the element node, it is recursive</p><p>
 154
 155 </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>  the FILE * for the output
 156 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  the node
 157 </td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>  the indentation level.
 158 </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,
 159                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 160                                              int depth);</pre><p>
 161 Dumps debug information for the list of element node, it is recursive</p><p>
 162
 163 </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>  the FILE * for the output
 164 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  the node list
 165 </td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td>  the indentation level.
 166 </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,
 167                                              <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>
 168 Dumps debug information cncerning the document, not recursive</p><p>
 169
 170 </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>  the FILE * for the output
 171 </td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td>  the document
 172 </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,
 173                                              <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>
 174 Dumps debug information for the document, it's recursive</p><p>
 175
 176 </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>  the FILE * for the output
 177 </td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td>  the document
 178 </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,
 179                                              <a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd);</pre><p>
 180 Dumps debug information for the DTD</p><p>
 181
 182 </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>  the FILE * for the output
 183 </td></tr><tr><td><span class="term"><i><tt>dtd</tt></i> :</span></td><td>  the DTD
 184 </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,
 185                                              <a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>
 186 Dumps debug information for all the entities in use by the document</p><p>
 187
 188 </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>  the FILE * for the output
 189 </td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td>  the document
 190 </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,
 191                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>
 192 Dump to <i><tt>output</tt></i> the type and name of <i><tt>node</tt></i>.</p><p>
 193
 194 </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>  the FILE * for the output
 195 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  the node to dump
 196 </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>
 197 Count the children of <i><tt>node</tt></i>.</p><p>
 198
 199 </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>  the node to count
 200 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the number of children of <i><tt>node</tt></i>.
 201 </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>
 202 This is a generic signature for the XML shell input function.</p><p>
 203
 204 </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>  a string prompt
 205 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a string which will be freed by the Shell.
 206 </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 {
 207     char *filename;
 208     xmlDocPtr doc;
 209     xmlNodePtr node;
 210     xmlXPathContextPtr pctxt;
 211     int loaded;
 212     FILE *output;
 213     xmlShellReadlineFunc input;
 214 };
 215 </pre><p>
 216 A debugging shell context.
 217 TODO: add the defined function tables.</p><p>
 218
 219 </p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlShellCtxtPtr"></a>xmlShellCtxtPtr</h3><pre class="programlisting">typedef xmlShellCtxt *xmlShellCtxtPtr;
 220 </pre><p>
 221
 222 </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,
 223                                              char *arg,
 224                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 225                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 226 This is a generic signature for the XML shell functions.</p><p>
 227
 228 </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>  a shell context
 229 </td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>  a string argument
 230 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  a first node
 231 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  a second node
 232 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>an int, negative returns indicating errors.
 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="xmlShellPrintXPathError"></a>xmlShellPrintXPathError ()</h3><pre class="programlisting">void        xmlShellPrintXPathError         (int errorType,
 234                                              const char *arg);</pre><p>
 235 Print the xpath error to libxml default error channel</p><p>
 236
 237 </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> valid xpath error id
 238 </td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> the argument that cause xpath to fail
 239 </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>
 240 Print node to the output FILE</p><p>
 241
 242 </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> a non-null node to print to the output FILE
 243 </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>
 244 Prints result to the output FILE</p><p>
 245
 246 </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> a valid result generated by an xpath evaluation
 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="xmlShellList"></a>xmlShellList ()</h3><pre class="programlisting">int         xmlShellList                    (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
 248                                              char *arg,
 249                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 250                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 251 Implements the XML shell function "ls"
 252 Does an Unix like listing of the given node (like a directory)</p><p>
 253
 254 </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 shell context
 255 </td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>  unused
 256 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  a node
 257 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 258 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0
 259 </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,
 260                                              char *arg,
 261                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 262                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 263 Implements the XML shell function "base"
 264 dumps the current XML base of the node</p><p>
 265
 266 </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 shell context
 267 </td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>  unused
 268 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  a node
 269 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 270 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0
 271 </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,
 272                                              char *arg,
 273                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 274                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 275 Implements the XML shell function "dir"
 276 dumps informations about the node (namespace, attributes, content).</p><p>
 277
 278 </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 shell context
 279 </td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>  unused
 280 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  a node
 281 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 282 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0
 283 </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,
 284                                              char *arg,
 285                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 286                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 287 Implements the XML shell function "cat"
 288 dumps the serialization node content (XML or HTML).</p><p>
 289
 290 </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 shell context
 291 </td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>  unused
 292 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  a node
 293 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 294 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0
 295 </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,
 296                                              char *filename,
 297                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 298                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 299 Implements the XML shell function "load"
 300 loads a new document specified by the filename</p><p>
 301
 302 </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 shell context
 303 </td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  the file name
 304 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  unused
 305 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 306 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 if loading failed
 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="xmlShellWrite"></a>xmlShellWrite ()</h3><pre class="programlisting">int         xmlShellWrite                   (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
 308                                              char *filename,
 309                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 310                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 311 Implements the XML shell function "write"
 312 Write the current node to the filename, it saves the serialization
 313 of the subtree under the <i><tt>node</tt></i> specified</p><p>
 314
 315 </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 shell context
 316 </td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  the file name
 317 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  a node in the tree
 318 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 319 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
 320 </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,
 321                                              char *filename,
 322                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 323                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 324 Implements the XML shell function "save"
 325 Write the current document to the filename, or it's original name</p><p>
 326
 327 </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 shell context
 328 </td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  the file name (optional)
 329 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  unused
 330 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 331 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
 332 </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,
 333                                              char *dtd,
 334                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 335                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 336 Implements the XML shell function "validate"
 337 Validate the document, if a DTD path is provided, then the validation
 338 is done against the given DTD.</p><p>
 339
 340 </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 shell context
 341 </td></tr><tr><td><span class="term"><i><tt>dtd</tt></i> :</span></td><td>  the DTD URI (optional)
 342 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  unused
 343 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 344 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
 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="xmlShellDu"></a>xmlShellDu ()</h3><pre class="programlisting">int         xmlShellDu                      (<a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a> ctxt,
 346                                              char *arg,
 347                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> tree,
 348                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 349 Implements the XML shell function "du"
 350 show the structure of the subtree under node <i><tt>tree</tt></i>
 351 If <i><tt>tree</tt></i> is null, the command works on the current node.</p><p>
 352
 353 </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 shell context
 354 </td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td>  unused
 355 </td></tr><tr><td><span class="term"><i><tt>tree</tt></i> :</span></td><td>  a node defining a subtree
 356 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 357 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
 358 </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,
 359                                              char *buffer,
 360                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,
 361                                              <a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>
 362 Implements the XML shell function "pwd"
 363 Show the full path from the root to the node, if needed building
 364 thumblers when similar elements exists at a given ancestor level.
 365 The output is compatible with XPath commands.</p><p>
 366
 367 </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 shell context
 368 </td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td>  the output buffer
 369 </td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td>  a node
 370 </td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td>  unused
 371 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error
 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="xmlShell"></a>xmlShell ()</h3><pre class="programlisting">void        xmlShell                        (<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc,
 373                                              char *filename,
 374                                              <a href="libxml-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input,
 375                                              <GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output);</pre><p>
 376 Implements the XML shell
 377 This allow to load, validate, view, modify and save a document
 378 using a environment similar to a UNIX commandline.</p><p>
 379
 380 </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>  the initial document
 381 </td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td>  the output buffer
 382 </td></tr><tr><td><span class="term"><i><tt>input</tt></i> :</span></td><td>  the line reading function
 383 </td></tr><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td>  the output FILE*, defaults to stdout if NULL
 384 </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>