Blame - doc/html/libxml-debugXML.html - fp2-dev/platform/external/libxml2

Daniel Veillard

2003-04-29 12:40:16 +0000

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<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;

padding: 0.5em;

}

.programlisting {

background: #eeeeff;

border: solid 1px #aaaaff;

padding: 0.5em;

}

.variablelist {

padding: 4px;

margin-left: 3em;

}

.navigation {

background: #ffeeee;

border: solid 1px #ffaaaa;

20

margin-top: 0.5em;

21

margin-bottom: 0.5em;

}

.navigation a {

color: #770000;

}

.navigation a:visited {

color: #550000;

}

.navigation .title {

font-size: 200%;

}

</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 — </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">

void <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);

38

void <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);

41

void <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);

44

void <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);

47

void <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);

50

void <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);

53

void <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);

55

void <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);

57

void <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);

59

void <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);

61

void <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);

63

int <a href="libxml-debugXML.html#xmlLsCountNode">xmlLsCountNode</a> (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);

64

char* (<a href="libxml-debugXML.html#xmlShellReadlineFunc">*xmlShellReadlineFunc</a>) (char *prompt);

65

struct <a href="libxml-debugXML.html#xmlShellCtxt">xmlShellCtxt</a>;

66

typedef <a href="libxml-debugXML.html#xmlShellCtxtPtr">xmlShellCtxtPtr</a>;

67

int (<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);

71

void <a href="libxml-debugXML.html#xmlShellPrintXPathError">xmlShellPrintXPathError</a> (int errorType,

72

const char *arg);

73

void <a href="libxml-debugXML.html#xmlShellPrintNode">xmlShellPrintNode</a> (<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);

74

void <a href="libxml-debugXML.html#xmlShellPrintXPathResult">xmlShellPrintXPathResult</a> (<a href="libxml-xpath.html#xmlXPathObjectPtr">xmlXPathObjectPtr</a> list);

75

int <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);

79

int <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);

83

int <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);

87

int <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);

91

int <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);

95

int <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);

99

int <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);

103

int <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);

107

int <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);

111

int <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);

115

void <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>

123

Dumps informations about the string, shorten it if necessary</p><p>

124

125

</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

126

</td></tr><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td> the string

127

</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,

128

<a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,

129

int depth);</pre><p>

130

Dumps debug information for the attribute</p><p>

131

132

</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

133

</td></tr><tr><td><span class="term"><i><tt>attr</tt></i> :</span></td><td> the attribute

134

</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td> the indentation level.

135

</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,

136

<a href="libxml-tree.html#xmlAttrPtr">xmlAttrPtr</a> attr,

137

int depth);</pre><p>

138

Dumps debug information for the attribute list</p><p>

139

140

</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

141

</td></tr><tr><td><span class="term"><i><tt>attr</tt></i> :</span></td><td> the attribute list

142

</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td> the indentation level.

143

</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,

144

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

145

int depth);</pre><p>

146

Dumps debug information for the element node, it is not recursive</p><p>

147

148

</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

149

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> the node

150

</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td> the indentation level.

151

</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,

152

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

153

int depth);</pre><p>

154

Dumps debug information for the element node, it is recursive</p><p>

155

156

</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

157

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> the node

158

</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td> the indentation level.

159

</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,

160

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

161

int depth);</pre><p>

162

Dumps debug information for the list of element node, it is recursive</p><p>

163

164

</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

165

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> the node list

166

</td></tr><tr><td><span class="term"><i><tt>depth</tt></i> :</span></td><td> the indentation level.

167

</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,

168

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>

169

Dumps debug information cncerning the document, not recursive</p><p>

170

171

</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

172

</td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td> the document

173

</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,

174

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>

175

Dumps debug information for the document, it's recursive</p><p>

176

177

</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

178

</td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td> the document

179

</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,

180

<a href="libxml-tree.html#xmlDtdPtr">xmlDtdPtr</a> dtd);</pre><p>

181

Dumps debug information for the DTD</p><p>

182

183

</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

184

</td></tr><tr><td><span class="term"><i><tt>dtd</tt></i> :</span></td><td> the DTD

185

</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,

186

<a href="libxml-tree.html#xmlDocPtr">xmlDocPtr</a> doc);</pre><p>

187

Dumps debug information for all the entities in use by the document</p><p>

188

189

</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

190

</td></tr><tr><td><span class="term"><i><tt>doc</tt></i> :</span></td><td> the document

191

</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,

192

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node);</pre><p>

193

Dump to <i><tt>output</tt></i> the type and name of <i><tt>node</tt></i>.</p><p>

194

195

</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

196

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> the node to dump

197

</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>

198

Count the children of <i><tt>node</tt></i>.</p><p>

199

200

</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

201

</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>.

202

</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>

203

This is a generic signature for the XML shell input function.</p><p>

204

205

</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

206

</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.

207

</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 {

char *filename;

xmlDocPtr doc;

xmlNodePtr node;

xmlXPathContextPtr pctxt;

212

int loaded;

213

FILE *output;

214

xmlShellReadlineFunc input;

215

};

216

</pre><p>

217

A debugging shell context.

218

TODO: add the defined function tables.</p><p>

219

220

</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;

221

</pre><p>

222

223

</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,

224

char *arg,

225

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

226

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

227

This is a generic signature for the XML shell functions.</p><p>

228

229

</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

230

</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> a string argument

231

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> a first node

232

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> a second node

233

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>an int, negative returns indicating errors.

234

</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,

235

const char *arg);</pre><p>

236

Print the xpath error to libxml default error channel</p><p>

237

238

</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

239

</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> the argument that cause xpath to fail

240

</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>

241

Print node to the output FILE</p><p>

242

243

</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

244

</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>

245

Prints result to the output FILE</p><p>

246

247

</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

248

</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,

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>

252

Implements the XML shell function "ls"

253

Does an Unix like listing of the given node (like a directory)</p><p>

254

255

</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

256

</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> unused

257

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> a node

258

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

259

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0

260

</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,

261

char *arg,

262

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

263

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

264

Implements the XML shell function "base"

265

dumps the current XML base of the node</p><p>

266

267

</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

268

</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> unused

269

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> a node

270

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

271

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0

272

</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,

273

char *arg,

274

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

275

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

276

Implements the XML shell function "dir"

277

dumps informations about the node (namespace, attributes, content).</p><p>

278

279

</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

280

</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> unused

281

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> a node

282

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

283

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0

284

</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,

285

char *arg,

286

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

287

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

288

Implements the XML shell function "cat"

289

dumps the serialization node content (XML or HTML).</p><p>

290

291

</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

292

</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> unused

293

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> a node

294

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

295

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0

296

</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,

297

char *filename,

298

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

299

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

300

Implements the XML shell function "load"

301

loads a new document specified by the filename</p><p>

302

303

</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

304

</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the file name

305

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> unused

306

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

307

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 if loading failed

308

</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,

309

char *filename,

310

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

311

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

312

Implements the XML shell function "write"

313

Write the current node to the filename, it saves the serialization

314

of the subtree under the <i><tt>node</tt></i> specified</p><p>

315

316

</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

317

</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the file name

318

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> a node in the tree

319

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

320

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error

321

</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,

322

char *filename,

323

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

324

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

325

Implements the XML shell function "save"

326

Write the current document to the filename, or it's original name</p><p>

327

328

</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

329

</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the file name (optional)

330

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> unused

331

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

332

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error

333

</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,

334

char *dtd,

335

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

336

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

337

Implements the XML shell function "validate"

338

Validate the document, if a DTD path is provided, then the validation

339

is done against the given DTD.</p><p>

340

341

</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

342

</td></tr><tr><td><span class="term"><i><tt>dtd</tt></i> :</span></td><td> the DTD URI (optional)

343

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> unused

344

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

345

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error

346

</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,

347

char *arg,

348

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> tree,

349

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

350

Implements the XML shell function "du"

351

show the structure of the subtree under node <i><tt>tree</tt></i>

352

If <i><tt>tree</tt></i> is null, the command works on the current node.</p><p>

353

354

</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

355

</td></tr><tr><td><span class="term"><i><tt>arg</tt></i> :</span></td><td> unused

356

</td></tr><tr><td><span class="term"><i><tt>tree</tt></i> :</span></td><td> a node defining a subtree

357

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

358

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error

359

</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,

360

char *buffer,

361

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node,

362

<a href="libxml-tree.html#xmlNodePtr">xmlNodePtr</a> node2);</pre><p>

363

Implements the XML shell function "pwd"

364

Show the full path from the root to the node, if needed building

365

thumblers when similar elements exists at a given ancestor level.

366

The output is compatible with XPath commands.</p><p>

367

368

</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

369

</td></tr><tr><td><span class="term"><i><tt>buffer</tt></i> :</span></td><td> the output buffer

370

</td></tr><tr><td><span class="term"><i><tt>node</tt></i> :</span></td><td> a node

371

</td></tr><tr><td><span class="term"><i><tt>node2</tt></i> :</span></td><td> unused

372

</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>0 or -1 in case of error

373

</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,

374

char *filename,

375

<a href="libxml-debugXML.html#xmlShellReadlineFunc">xmlShellReadlineFunc</a> input,

376

<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *output);</pre><p>

377

Implements the XML shell

378

This allow to load, validate, view, modify and save a document

379

using a environment similar to a UNIX commandline.</p><p>

380

381

</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

382

</td></tr><tr><td><span class="term"><i><tt>filename</tt></i> :</span></td><td> the output buffer

383

</td></tr><tr><td><span class="term"><i><tt>input</tt></i> :</span></td><td> the line reading function

384

</td></tr><tr><td><span class="term"><i><tt>output</tt></i> :</span></td><td> the output FILE*, defaults to stdout if NULL

385

</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><< hash</b></a></td><td align="right"><a accesskey="n" href="libxml-xmlmemory.html"><b>xmlmemory >></b></a></td></tr></table></body></html>