7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
10 TITLE="Gnome XML Library Reference Manual"
11 HREF="book1.html"><LINK
13 TITLE="Libxml Library Reference"
14 HREF="libxml-lib.html"><LINK
17 HREF="libxml-hash.html"><LINK
20 HREF="libxml-xmlmemory.html"></HEAD
43 >Gnome XML Library Reference Manual</FONT
52 HREF="libxml-hash.html"
57 ><<< Previous Page</B
90 HREF="libxml-lib.html"
106 HREF="libxml-xmlmemory.html"
111 >Next Page >>></B
120 NAME="LIBXML-DEBUGXML">debugXML</H1
128 >debugXML -- </DIV
130 CLASS="REFSYNOPSISDIV"
146 HREF="libxml-debugxml.html#XMLDEBUGDUMPSTRING"
147 >xmlDebugDumpString</A
153 HREF="libxml-tree.html#XMLCHAR"
157 HREF="libxml-debugxml.html#XMLDEBUGDUMPATTR"
164 HREF="libxml-tree.html#XMLATTRPTR"
169 HREF="libxml-debugxml.html#XMLDEBUGDUMPATTRLIST"
170 >xmlDebugDumpAttrList</A
176 HREF="libxml-tree.html#XMLATTRPTR"
181 HREF="libxml-debugxml.html#XMLDEBUGDUMPONENODE"
182 >xmlDebugDumpOneNode</A
188 HREF="libxml-tree.html#XMLNODEPTR"
193 HREF="libxml-debugxml.html#XMLDEBUGDUMPNODE"
200 HREF="libxml-tree.html#XMLNODEPTR"
205 HREF="libxml-debugxml.html#XMLDEBUGDUMPNODELIST"
206 >xmlDebugDumpNodeList</A
212 HREF="libxml-tree.html#XMLNODEPTR"
217 HREF="libxml-debugxml.html#XMLDEBUGDUMPDOCUMENTHEAD"
218 >xmlDebugDumpDocumentHead</A
224 HREF="libxml-tree.html#XMLDOCPTR"
228 HREF="libxml-debugxml.html#XMLDEBUGDUMPDOCUMENT"
229 >xmlDebugDumpDocument</A
235 HREF="libxml-tree.html#XMLDOCPTR"
239 HREF="libxml-debugxml.html#XMLDEBUGDUMPDTD"
246 HREF="libxml-tree.html#XMLDTDPTR"
250 HREF="libxml-debugxml.html#XMLDEBUGDUMPENTITIES"
251 >xmlDebugDumpEntities</A
257 HREF="libxml-tree.html#XMLDOCPTR"
261 HREF="libxml-debugxml.html#XMLLSONENODE"
268 HREF="libxml-tree.html#XMLNODEPTR"
272 HREF="libxml-debugxml.html#XMLLSCOUNTNODE"
275 HREF="libxml-tree.html#XMLNODEPTR"
279 HREF="libxml-debugxml.html#XMLSHELLREADLINEFUNC"
280 >*xmlShellReadlineFunc</A
283 HREF="libxml-debugxml.html#XMLSHELLCTXT"
287 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
291 HREF="libxml-debugxml.html#XMLSHELLCMD"
294 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
299 HREF="libxml-tree.html#XMLNODEPTR"
303 HREF="libxml-tree.html#XMLNODEPTR"
307 HREF="libxml-debugxml.html#XMLSHELLPRINTXPATHERROR"
308 >xmlShellPrintXPathError</A
312 HREF="libxml-debugxml.html#XMLSHELLPRINTNODE"
313 >xmlShellPrintNode</A
315 HREF="libxml-tree.html#XMLNODEPTR"
319 HREF="libxml-debugxml.html#XMLSHELLPRINTXPATHRESULT"
320 >xmlShellPrintXPathResult</A
322 HREF="libxml-xpath.html#XMLXPATHOBJECTPTR"
323 >xmlXPathObjectPtr</A
326 HREF="libxml-debugxml.html#XMLSHELLLIST"
329 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
334 HREF="libxml-tree.html#XMLNODEPTR"
338 HREF="libxml-tree.html#XMLNODEPTR"
342 HREF="libxml-debugxml.html#XMLSHELLBASE"
345 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
350 HREF="libxml-tree.html#XMLNODEPTR"
354 HREF="libxml-tree.html#XMLNODEPTR"
358 HREF="libxml-debugxml.html#XMLSHELLDIR"
361 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
366 HREF="libxml-tree.html#XMLNODEPTR"
370 HREF="libxml-tree.html#XMLNODEPTR"
374 HREF="libxml-debugxml.html#XMLSHELLCAT"
377 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
382 HREF="libxml-tree.html#XMLNODEPTR"
386 HREF="libxml-tree.html#XMLNODEPTR"
390 HREF="libxml-debugxml.html#XMLSHELLLOAD"
393 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
398 HREF="libxml-tree.html#XMLNODEPTR"
402 HREF="libxml-tree.html#XMLNODEPTR"
406 HREF="libxml-debugxml.html#XMLSHELLWRITE"
409 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
414 HREF="libxml-tree.html#XMLNODEPTR"
418 HREF="libxml-tree.html#XMLNODEPTR"
422 HREF="libxml-debugxml.html#XMLSHELLSAVE"
425 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
430 HREF="libxml-tree.html#XMLNODEPTR"
434 HREF="libxml-tree.html#XMLNODEPTR"
438 HREF="libxml-debugxml.html#XMLSHELLVALIDATE"
441 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
446 HREF="libxml-tree.html#XMLNODEPTR"
450 HREF="libxml-tree.html#XMLNODEPTR"
454 HREF="libxml-debugxml.html#XMLSHELLDU"
457 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
462 HREF="libxml-tree.html#XMLNODEPTR"
466 HREF="libxml-tree.html#XMLNODEPTR"
470 HREF="libxml-debugxml.html#XMLSHELLPWD"
473 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
478 HREF="libxml-tree.html#XMLNODEPTR"
482 HREF="libxml-tree.html#XMLNODEPTR"
486 HREF="libxml-debugxml.html#XMLSHELL"
489 HREF="libxml-tree.html#XMLDOCPTR"
494 HREF="libxml-debugxml.html#XMLSHELLREADLINEFUNC"
495 >xmlShellReadlineFunc</A
529 NAME="XMLDEBUGDUMPSTRING"
531 >xmlDebugDumpString ()</H3
540 CLASS="PROGRAMLISTING"
541 >void xmlDebugDumpString (<GTKDOCLINK
546 HREF="libxml-tree.html#XMLCHAR"
553 >Dumps informations about the string, shorten it if necessary</P
557 CLASS="INFORMALTABLE"
584 > the FILE * for the output</TD
616 NAME="XMLDEBUGDUMPATTR"
618 >xmlDebugDumpAttr ()</H3
627 CLASS="PROGRAMLISTING"
628 >void xmlDebugDumpAttr (<GTKDOCLINK
633 HREF="libxml-tree.html#XMLATTRPTR"
641 >Dumps debug information for the attribute</P
645 CLASS="INFORMALTABLE"
672 > the FILE * for the output</TD
706 > the indentation level.</TD
721 NAME="XMLDEBUGDUMPATTRLIST"
723 >xmlDebugDumpAttrList ()</H3
732 CLASS="PROGRAMLISTING"
733 >void xmlDebugDumpAttrList (<GTKDOCLINK
738 HREF="libxml-tree.html#XMLATTRPTR"
746 >Dumps debug information for the attribute list</P
750 CLASS="INFORMALTABLE"
777 > the FILE * for the output</TD
794 > the attribute list</TD
811 > the indentation level.</TD
826 NAME="XMLDEBUGDUMPONENODE"
828 >xmlDebugDumpOneNode ()</H3
837 CLASS="PROGRAMLISTING"
838 >void xmlDebugDumpOneNode (<GTKDOCLINK
843 HREF="libxml-tree.html#XMLNODEPTR"
851 >Dumps debug information for the element node, it is not recursive</P
855 CLASS="INFORMALTABLE"
882 > the FILE * for the output</TD
916 > the indentation level.</TD
931 NAME="XMLDEBUGDUMPNODE"
933 >xmlDebugDumpNode ()</H3
942 CLASS="PROGRAMLISTING"
943 >void xmlDebugDumpNode (<GTKDOCLINK
948 HREF="libxml-tree.html#XMLNODEPTR"
956 >Dumps debug information for the element node, it is recursive</P
960 CLASS="INFORMALTABLE"
987 > the FILE * for the output</TD
1021 > the indentation level.</TD
1036 NAME="XMLDEBUGDUMPNODELIST"
1038 >xmlDebugDumpNodeList ()</H3
1047 CLASS="PROGRAMLISTING"
1048 >void xmlDebugDumpNodeList (<GTKDOCLINK
1053 HREF="libxml-tree.html#XMLNODEPTR"
1061 >Dumps debug information for the list of element node, it is recursive</P
1065 CLASS="INFORMALTABLE"
1092 > the FILE * for the output</TD
1126 > the indentation level.</TD
1141 NAME="XMLDEBUGDUMPDOCUMENTHEAD"
1143 >xmlDebugDumpDocumentHead ()</H3
1152 CLASS="PROGRAMLISTING"
1153 >void xmlDebugDumpDocumentHead (<GTKDOCLINK
1158 HREF="libxml-tree.html#XMLDOCPTR"
1165 >Dumps debug information cncerning the document, not recursive</P
1169 CLASS="INFORMALTABLE"
1196 > the FILE * for the output</TD
1228 NAME="XMLDEBUGDUMPDOCUMENT"
1230 >xmlDebugDumpDocument ()</H3
1239 CLASS="PROGRAMLISTING"
1240 >void xmlDebugDumpDocument (<GTKDOCLINK
1245 HREF="libxml-tree.html#XMLDOCPTR"
1252 >Dumps debug information for the document, it's recursive</P
1256 CLASS="INFORMALTABLE"
1283 > the FILE * for the output</TD
1315 NAME="XMLDEBUGDUMPDTD"
1317 >xmlDebugDumpDTD ()</H3
1326 CLASS="PROGRAMLISTING"
1327 >void xmlDebugDumpDTD (<GTKDOCLINK
1332 HREF="libxml-tree.html#XMLDTDPTR"
1339 >Dumps debug information for the DTD</P
1343 CLASS="INFORMALTABLE"
1370 > the FILE * for the output</TD
1402 NAME="XMLDEBUGDUMPENTITIES"
1404 >xmlDebugDumpEntities ()</H3
1413 CLASS="PROGRAMLISTING"
1414 >void xmlDebugDumpEntities (<GTKDOCLINK
1419 HREF="libxml-tree.html#XMLDOCPTR"
1426 >Dumps debug information for all the entities in use by the document</P
1430 CLASS="INFORMALTABLE"
1457 > the FILE * for the output</TD
1491 >xmlLsOneNode ()</H3
1500 CLASS="PROGRAMLISTING"
1501 >void xmlLsOneNode (<GTKDOCLINK
1506 HREF="libxml-tree.html#XMLNODEPTR"
1518 > the type and name of <TT
1527 CLASS="INFORMALTABLE"
1554 > the FILE * for the output</TD
1571 > the node to dump</TD
1586 NAME="XMLLSCOUNTNODE"
1588 >xmlLsCountNode ()</H3
1597 CLASS="PROGRAMLISTING"
1598 >int xmlLsCountNode (<A
1599 HREF="libxml-tree.html#XMLNODEPTR"
1606 >Count the children of <TT
1615 CLASS="INFORMALTABLE"
1642 > the node to count</TD
1660 >the number of children of <TT
1680 NAME="XMLSHELLREADLINEFUNC"
1682 >xmlShellReadlineFunc ()</H3
1691 CLASS="PROGRAMLISTING"
1692 >char* (*xmlShellReadlineFunc) (char *prompt);</PRE
1697 >This is a generic signature for the XML shell input function.</P
1701 CLASS="INFORMALTABLE"
1728 > a string prompt</TD
1746 >a string which will be freed by the Shell.</TD
1763 >struct xmlShellCtxt</H3
1772 CLASS="PROGRAMLISTING"
1773 >struct xmlShellCtxt {
1777 xmlXPathContextPtr pctxt;
1780 xmlShellReadlineFunc input;
1786 >A debugging shell context.
1787 TODO: add the defined function tables.</P
1798 NAME="XMLSHELLCTXTPTR"
1800 >xmlShellCtxtPtr</H3
1809 CLASS="PROGRAMLISTING"
1810 >typedef xmlShellCtxt *xmlShellCtxtPtr;</PRE
1835 CLASS="PROGRAMLISTING"
1836 >int (*xmlShellCmd) (<A
1837 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
1842 HREF="libxml-tree.html#XMLNODEPTR"
1846 HREF="libxml-tree.html#XMLNODEPTR"
1853 >This is a generic signature for the XML shell functions.</P
1857 CLASS="INFORMALTABLE"
1884 > a shell context</TD
1901 > a string argument</TD
1953 >an int, negative returns indicating errors.</TD
1968 NAME="XMLSHELLPRINTXPATHERROR"
1970 >xmlShellPrintXPathError ()</H3
1979 CLASS="PROGRAMLISTING"
1980 >void xmlShellPrintXPathError (int errorType,
1981 const char *arg);</PRE
1986 >Print the xpath error to libxml default error channel</P
1990 CLASS="INFORMALTABLE"
2017 > valid xpath error id</TD
2034 > the argument that cause xpath to fail</TD
2049 NAME="XMLSHELLPRINTNODE"
2051 >xmlShellPrintNode ()</H3
2060 CLASS="PROGRAMLISTING"
2061 >void xmlShellPrintNode (<A
2062 HREF="libxml-tree.html#XMLNODEPTR"
2069 >Print node to the output FILE</P
2073 CLASS="INFORMALTABLE"
2100 > a non-null node to print to the output FILE</TD
2115 NAME="XMLSHELLPRINTXPATHRESULT"
2117 >xmlShellPrintXPathResult ()</H3
2126 CLASS="PROGRAMLISTING"
2127 >void xmlShellPrintXPathResult (<A
2128 HREF="libxml-xpath.html#XMLXPATHOBJECTPTR"
2129 >xmlXPathObjectPtr</A
2135 >Prints result to the output FILE</P
2139 CLASS="INFORMALTABLE"
2166 > a valid result generated by an xpath evaluation</TD
2183 >xmlShellList ()</H3
2192 CLASS="PROGRAMLISTING"
2193 >int xmlShellList (<A
2194 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
2199 HREF="libxml-tree.html#XMLNODEPTR"
2203 HREF="libxml-tree.html#XMLNODEPTR"
2210 >Implements the XML shell function "ls"
2211 Does an Unix like listing of the given node (like a directory)</P
2215 CLASS="INFORMALTABLE"
2242 > the shell context</TD
2328 >xmlShellBase ()</H3
2337 CLASS="PROGRAMLISTING"
2338 >int xmlShellBase (<A
2339 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
2344 HREF="libxml-tree.html#XMLNODEPTR"
2348 HREF="libxml-tree.html#XMLNODEPTR"
2355 >Implements the XML shell function "base"
2356 dumps the current XML base of the node</P
2360 CLASS="INFORMALTABLE"
2387 > the shell context</TD
2482 CLASS="PROGRAMLISTING"
2483 >int xmlShellDir (<A
2484 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
2489 HREF="libxml-tree.html#XMLNODEPTR"
2493 HREF="libxml-tree.html#XMLNODEPTR"
2500 >Implements the XML shell function "dir"
2501 dumps informations about the node (namespace, attributes, content).</P
2505 CLASS="INFORMALTABLE"
2532 > the shell context</TD
2627 CLASS="PROGRAMLISTING"
2628 >int xmlShellCat (<A
2629 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
2634 HREF="libxml-tree.html#XMLNODEPTR"
2638 HREF="libxml-tree.html#XMLNODEPTR"
2645 >Implements the XML shell function "cat"
2646 dumps the serialization node content (XML or HTML).</P
2650 CLASS="INFORMALTABLE"
2677 > the shell context</TD
2763 >xmlShellLoad ()</H3
2772 CLASS="PROGRAMLISTING"
2773 >int xmlShellLoad (<A
2774 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
2779 HREF="libxml-tree.html#XMLNODEPTR"
2783 HREF="libxml-tree.html#XMLNODEPTR"
2790 >Implements the XML shell function "load"
2791 loads a new document specified by the filename</P
2795 CLASS="INFORMALTABLE"
2822 > the shell context</TD
2891 >0 or -1 if loading failed</TD
2906 NAME="XMLSHELLWRITE"
2908 >xmlShellWrite ()</H3
2917 CLASS="PROGRAMLISTING"
2918 >int xmlShellWrite (<A
2919 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
2924 HREF="libxml-tree.html#XMLNODEPTR"
2928 HREF="libxml-tree.html#XMLNODEPTR"
2935 >Implements the XML shell function "write"
2936 Write the current node to the filename, it saves the serialization
2937 of the subtree under the <TT
2946 CLASS="INFORMALTABLE"
2973 > the shell context</TD
3007 > a node in the tree</TD
3042 >0 or -1 in case of error</TD
3059 >xmlShellSave ()</H3
3068 CLASS="PROGRAMLISTING"
3069 >int xmlShellSave (<A
3070 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
3075 HREF="libxml-tree.html#XMLNODEPTR"
3079 HREF="libxml-tree.html#XMLNODEPTR"
3086 >Implements the XML shell function "save"
3087 Write the current document to the filename, or it's original name</P
3091 CLASS="INFORMALTABLE"
3118 > the shell context</TD
3135 > the file name (optional)</TD
3187 >0 or -1 in case of error</TD
3202 NAME="XMLSHELLVALIDATE"
3204 >xmlShellValidate ()</H3
3213 CLASS="PROGRAMLISTING"
3214 >int xmlShellValidate (<A
3215 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
3220 HREF="libxml-tree.html#XMLNODEPTR"
3224 HREF="libxml-tree.html#XMLNODEPTR"
3231 >Implements the XML shell function "validate"
3232 Validate the document, if a DTD path is provided, then the validation
3233 is done against the given DTD.</P
3237 CLASS="INFORMALTABLE"
3264 > the shell context</TD
3281 > the DTD URI (optional)</TD
3333 >0 or -1 in case of error</TD
3359 CLASS="PROGRAMLISTING"
3361 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
3366 HREF="libxml-tree.html#XMLNODEPTR"
3370 HREF="libxml-tree.html#XMLNODEPTR"
3377 >Implements the XML shell function "du"
3378 show the structure of the subtree under node <TT
3389 > is null, the command works on the current node.</P
3393 CLASS="INFORMALTABLE"
3420 > the shell context</TD
3454 > a node defining a subtree</TD
3489 >0 or -1 in case of error</TD
3515 CLASS="PROGRAMLISTING"
3516 >int xmlShellPwd (<A
3517 HREF="libxml-debugxml.html#XMLSHELLCTXTPTR"
3522 HREF="libxml-tree.html#XMLNODEPTR"
3526 HREF="libxml-tree.html#XMLNODEPTR"
3533 >Implements the XML shell function "pwd"
3534 Show the full path from the root to the node, if needed building
3535 thumblers when similar elements exists at a given ancestor level.
3536 The output is compatible with XPath commands.</P
3540 CLASS="INFORMALTABLE"
3567 > the shell context</TD
3584 > the output buffer</TD
3636 >0 or -1 in case of error</TD
3662 CLASS="PROGRAMLISTING"
3664 HREF="libxml-tree.html#XMLDOCPTR"
3669 HREF="libxml-debugxml.html#XMLSHELLREADLINEFUNC"
3670 >xmlShellReadlineFunc</A
3680 >Implements the XML shell
3681 This allow to load, validate, view, modify and save a document
3682 using a environment similar to a UNIX commandline.</P
3686 CLASS="INFORMALTABLE"
3713 > the initial document</TD
3730 > the output buffer</TD
3747 > the line reading function</TD
3764 > the output FILE*, defaults to stdout if NULL</TD
3776 CLEAR="all"><BR><TABLE
3788 HREF="libxml-hash.html"
3793 ><<< Previous Page</B
3826 HREF="libxml-lib.html"
3842 HREF="libxml-xmlmemory.html"
3847 >Next Page >>></B