summaryrefslogtreecommitdiff
path: root/packages/libxml/src/debugXML.inc
blob: 1783265aaee521d02df95f9e797db20a98215998 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
(*
 * Summary: Tree debugging APIs
 * Description: Interfaces to a set of routines used for debugging the tree
 *              produced by the XML parser.
 *
 * Copy: See Copyright for the status of this software.
 *
 * Author: Daniel Veillard
 *)

#ifndef __DEBUG_XML__
#define __DEBUG_XML__
#include <stdio.h>
#include <libxml/xmlversion.h>
#include <libxml/tree.h>

{ LIBXML_DEBUG_ENABLED

#include <libxml/xpath.h>

{ __cplusplus
extern "C" {
#endif

(*
 * The standard Dump routines.
 *)
external xml2lib void EXTDECL	
	xmlDebugDumpString	(FILE *output,
				 xmlChar *str);
external xml2lib void EXTDECL	
	xmlDebugDumpAttr	(FILE *output,
				 xmlAttrPtr attr,
				 int depth);
external xml2lib void EXTDECL	
	xmlDebugDumpAttrList	(FILE *output,
				 xmlAttrPtr attr,
				 int depth);
external xml2lib void EXTDECL	
	xmlDebugDumpOneNode	(FILE *output,
				 xmlNodePtr node,
				 int depth);
external xml2lib void EXTDECL
	xmlDebugDumpNode	(FILE *output,
				 xmlNodePtr node,
				 int depth);
external xml2lib void EXTDECL
	xmlDebugDumpNodeList	(FILE *output,
				 xmlNodePtr node,
				 int depth);
external xml2lib void EXTDECL
	xmlDebugDumpDocumentHead(FILE *output,
				 xmlDocPtr doc);
external xml2lib void EXTDECL
	xmlDebugDumpDocument	(FILE *output,
				 xmlDocPtr doc);
external xml2lib void EXTDECL	
	xmlDebugDumpDTD		(FILE *output,
				 xmlDtdPtr dtd);
external xml2lib void EXTDECL	
	xmlDebugDumpEntities	(FILE *output,
				 xmlDocPtr doc);

(****************************************************************
 *								*
 *	 		Checking routines			*
 *								*
 ****************************************************************)

external xml2lib int EXTDECL
	xmlDebugCheckDocument	(FILE * output,
				 xmlDocPtr doc);

(****************************************************************
 *								*
 *	 		XML shell helpers			*
 *								*
 ****************************************************************)

external xml2lib void EXTDECL	
	xmlLsOneNode		(FILE *output, xmlNodePtr node);
external xml2lib int EXTDECL	
	xmlLsCountNode		(xmlNodePtr node);

external xml2lib char * EXTDECL 
	xmlBoolToText		(int boolval);

(****************************************************************
 *								*
 *	 The XML shell related structures and functions		*
 *								*
 ****************************************************************)

{ LIBXML_XPATH_ENABLED
(**
 * xmlShellReadlineFunc:
 * @prompt:  a string prompt
 *
 * This is a generic signature for the XML shell input function.
 *
 * Returns a string which will be freed by the Shell.
 *)
typedef char * (* xmlShellReadlineFunc)(char *prompt);

(**
 * xmlShellCtxt:
 *
 * A debugging shell context.
 * TODO: add the defined function tables.
 *)
typedef struct _xmlShellCtxt xmlShellCtxt;
typedef xmlShellCtxt *xmlShellCtxtPtr;
struct _xmlShellCtxt {
    char *filename;
    xmlDocPtr doc;
    xmlNodePtr node;
    xmlXPathContextPtr pctxt;
    int loaded;
    FILE *output;
    xmlShellReadlineFunc input;
};

(**
 * xmlShellCmd:
 * @ctxt:  a shell context
 * @arg:  a string argument
 * @node:  a first node
 * @node2:  a second node
 *
 * This is a generic signature for the XML shell functions.
 *
 * Returns an int, negative returns indicating errors.
 *)
typedef int (* xmlShellCmd) (xmlShellCtxtPtr ctxt,
                             char *arg,
			     xmlNodePtr node,
			     xmlNodePtr node2);

external xml2lib void EXTDECL	
	xmlShellPrintXPathError	(int errorType,
				 char *arg);
external xml2lib void EXTDECL	
	xmlShellPrintXPathResult(xmlXPathObjectPtr list);
external xml2lib int EXTDECL	
	xmlShellList		(xmlShellCtxtPtr ctxt,
				 char *arg,
				 xmlNodePtr node,
				 xmlNodePtr node2);
external xml2lib int EXTDECL	
	xmlShellBase		(xmlShellCtxtPtr ctxt,
				 char *arg,
				 xmlNodePtr node,
				 xmlNodePtr node2);
external xml2lib int EXTDECL	
	xmlShellDir		(xmlShellCtxtPtr ctxt,
				 char *arg,
				 xmlNodePtr node,
				 xmlNodePtr node2);
external xml2lib int EXTDECL	
	xmlShellLoad		(xmlShellCtxtPtr ctxt,
				 char *filename,
				 xmlNodePtr node,
				 xmlNodePtr node2);
{ LIBXML_OUTPUT_ENABLED
external xml2lib void EXTDECL	
	xmlShellPrintNode	(xmlNodePtr node);
external xml2lib int EXTDECL	
	xmlShellCat		(xmlShellCtxtPtr ctxt,
				 char *arg,
				 xmlNodePtr node,
				 xmlNodePtr node2);
external xml2lib int EXTDECL	
	xmlShellWrite		(xmlShellCtxtPtr ctxt,
				 char *filename,
				 xmlNodePtr node,
				 xmlNodePtr node2);
external xml2lib int EXTDECL	
	xmlShellSave		(xmlShellCtxtPtr ctxt,
				 char *filename,
				 xmlNodePtr node,
				 xmlNodePtr node2);
#endif (* LIBXML_OUTPUT_ENABLED *)
{ LIBXML_VALID_ENABLED
external xml2lib int EXTDECL	
	xmlShellValidate	(xmlShellCtxtPtr ctxt,
				 char *dtd,
				 xmlNodePtr node,
				 xmlNodePtr node2);
#endif (* LIBXML_VALID_ENABLED *)
external xml2lib int EXTDECL	
	xmlShellDu		(xmlShellCtxtPtr ctxt,
				 char *arg,
				 xmlNodePtr tree,
				 xmlNodePtr node2);
external xml2lib int EXTDECL	
	xmlShellPwd		(xmlShellCtxtPtr ctxt,
				 char *buffer,
				 xmlNodePtr node,
				 xmlNodePtr node2);

(*
 * The Shell interface.
 *)
external xml2lib void EXTDECL	
	xmlShell		(xmlDocPtr doc,
				 char *filename,
				 xmlShellReadlineFunc input,
				 FILE *output);
			 
#endif (* LIBXML_XPATH_ENABLED *)

{ __cplusplus
}
#endif

#endif (* LIBXML_DEBUG_ENABLED *)
#endif (* __DEBUG_XML__ *)