| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>debugXML: Tree debugging APIs</title> |
| <meta name="generator" content="Libxml2 devhelp stylesheet"> |
| <link rel="start" href="index.html" title="libxml2 Reference Manual"> |
| <link rel="up" href="general.html" title="API"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| <link rel="chapter" href="general.html" title="API"> |
| </head> |
| <body bgcolor="white" 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="libxml2-chvalid.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| <td><a accesskey="u" href="general.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> |
| <td><a accesskey="n" href="libxml2-dict.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| <th width="100%" align="center">libxml2 Reference Manual</th> |
| </tr></table> |
| <h2><span class="refentrytitle">debugXML</span></h2> |
| <p>debugXML - Tree debugging APIs</p> |
| <p>Interfaces to a set of routines used for debugging the tree produced by the XML parser. </p> |
| <p>Author(s): Daniel Veillard </p> |
| <div class="refsynopsisdiv"> |
| <h2>Synopsis</h2> |
| <pre class="synopsis">int <a href="#xmlDebugCheckDocument">xmlDebugCheckDocument</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc); |
| void <a href="#xmlDebugDumpAttr">xmlDebugDumpAttr</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr, <br> int depth); |
| void <a href="#xmlDebugDumpAttrList">xmlDebugDumpAttrList</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr, <br> int depth); |
| void <a href="#xmlDebugDumpDTD">xmlDebugDumpDTD</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd); |
| void <a href="#xmlDebugDumpDocument">xmlDebugDumpDocument</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc); |
| void <a href="#xmlDebugDumpDocumentHead">xmlDebugDumpDocumentHead</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc); |
| void <a href="#xmlDebugDumpEntities">xmlDebugDumpEntities</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc); |
| void <a href="#xmlDebugDumpNode">xmlDebugDumpNode</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> int depth); |
| void <a href="#xmlDebugDumpNodeList">xmlDebugDumpNodeList</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> int depth); |
| void <a href="#xmlDebugDumpOneNode">xmlDebugDumpOneNode</a> (FILE * output, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> int depth); |
| void <a href="#xmlDebugDumpString">xmlDebugDumpString</a> (FILE * output, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str); |
| </pre> |
| </div> |
| <div class="refsect1" lang="en"><h2>Description</h2></div> |
| <div class="refsect1" lang="en"> |
| <h2>Details</h2> |
| <div class="refsect2" lang="en"> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugCheckDocument"></a>xmlDebugCheckDocument ()</h3> |
| <pre class="programlisting">int xmlDebugCheckDocument (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc)<br> |
| </pre> |
| <p>Check the document for potential content problems, and output the errors to @output</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>doc</tt></i>:</span></td> |
| <td>the document</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>Returns</tt></i>:</span></td> |
| <td>the number of errors found</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpAttr"></a>xmlDebugDumpAttr ()</h3> |
| <pre class="programlisting">void xmlDebugDumpAttr (FILE * output, <br> <a href="libxml2-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr, <br> int depth)<br> |
| </pre> |
| <p>Dumps debug information for the attribute</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>attr</tt></i>:</span></td> |
| <td>the attribute</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>depth</tt></i>:</span></td> |
| <td>the indentation level.</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpAttrList"></a>xmlDebugDumpAttrList ()</h3> |
| <pre class="programlisting">void xmlDebugDumpAttrList (FILE * output, <br> <a href="libxml2-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr, <br> int depth)<br> |
| </pre> |
| <p>Dumps debug information for the attribute list</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>attr</tt></i>:</span></td> |
| <td>the attribute list</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>depth</tt></i>:</span></td> |
| <td>the indentation level.</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpDTD"></a>xmlDebugDumpDTD ()</h3> |
| <pre class="programlisting">void xmlDebugDumpDTD (FILE * output, <br> <a href="libxml2-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd)<br> |
| </pre> |
| <p>Dumps debug information for the DTD</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>dtd</tt></i>:</span></td> |
| <td>the DTD</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpDocument"></a>xmlDebugDumpDocument ()</h3> |
| <pre class="programlisting">void xmlDebugDumpDocument (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc)<br> |
| </pre> |
| <p>Dumps debug information for the document, it's recursive</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>doc</tt></i>:</span></td> |
| <td>the document</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpDocumentHead"></a>xmlDebugDumpDocumentHead ()</h3> |
| <pre class="programlisting">void xmlDebugDumpDocumentHead (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc)<br> |
| </pre> |
| <p>Dumps debug information concerning the document, not recursive</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>doc</tt></i>:</span></td> |
| <td>the document</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpEntities"></a>xmlDebugDumpEntities ()</h3> |
| <pre class="programlisting">void xmlDebugDumpEntities (FILE * output, <br> <a href="libxml2-tree.html#xmlDocPtr">xmlDocPtr</a> doc)<br> |
| </pre> |
| <p>Dumps debug information for all the entities in use by the document</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>doc</tt></i>:</span></td> |
| <td>the document</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpNode"></a>xmlDebugDumpNode ()</h3> |
| <pre class="programlisting">void xmlDebugDumpNode (FILE * output, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> int depth)<br> |
| </pre> |
| <p>Dumps debug information for the element node, it is recursive</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>node</tt></i>:</span></td> |
| <td>the node</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>depth</tt></i>:</span></td> |
| <td>the indentation level.</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpNodeList"></a>xmlDebugDumpNodeList ()</h3> |
| <pre class="programlisting">void xmlDebugDumpNodeList (FILE * output, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> int depth)<br> |
| </pre> |
| <p>Dumps debug information for the list of element node, it is recursive</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>node</tt></i>:</span></td> |
| <td>the node list</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>depth</tt></i>:</span></td> |
| <td>the indentation level.</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpOneNode"></a>xmlDebugDumpOneNode ()</h3> |
| <pre class="programlisting">void xmlDebugDumpOneNode (FILE * output, <br> <a href="libxml2-tree.html#xmlNodePtr">xmlNodePtr</a> node, <br> int depth)<br> |
| </pre> |
| <p>Dumps debug information for the element node, it is not recursive</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>node</tt></i>:</span></td> |
| <td>the node</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>depth</tt></i>:</span></td> |
| <td>the indentation level.</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2" lang="en"> |
| <h3> |
| <a name="xmlDebugDumpString"></a>xmlDebugDumpString ()</h3> |
| <pre class="programlisting">void xmlDebugDumpString (FILE * output, <br> const <a href="libxml2-xmlstring.html#xmlChar">xmlChar</a> * str)<br> |
| </pre> |
| <p>Dumps information about the string, shorten it if necessary</p> |
| <div class="variablelist"><table border="0"> |
| <col align="left"> |
| <tbody> |
| <tr> |
| <td><span class="term"><i><tt>output</tt></i>:</span></td> |
| <td>the FILE * for the output</td> |
| </tr> |
| <tr> |
| <td><span class="term"><i><tt>str</tt></i>:</span></td> |
| <td>the string</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| </div> |
| </div> |
| </body> |
| </html> |
