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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
|
/**
* @file
*
* @brief DTD validator
*
* API to handle XML Document Type Definitions and validate
* documents.
*
* @copyright See Copyright for the status of this software.
*
* @author Daniel Veillard
*/
#ifndef __XML_VALID_H__
#define __XML_VALID_H__
#include <libxml/xmlversion.h>
#include <libxml/xmlerror.h>
#define XML_TREE_INTERNALS
#include <libxml/tree.h>
#undef XML_TREE_INTERNALS
#include <libxml/list.h>
#include <libxml/xmlautomata.h>
#include <libxml/xmlregexp.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Validation state added for non-deterministic content model.
*/
typedef struct _xmlValidState xmlValidState;
typedef xmlValidState *xmlValidStatePtr;
/**
* Report a validity error.
*
* @param ctx user data (usually an xmlValidCtxt)
* @param msg printf-like format string
* @param ... arguments to format
*/
typedef void (*xmlValidityErrorFunc) (void *ctx,
const char *msg,
...) LIBXML_ATTR_FORMAT(2,3);
/**
* Report a validity warning.
*
* @param ctx user data (usually an xmlValidCtxt)
* @param msg printf-like format string
* @param ... arguments to format
*/
typedef void (*xmlValidityWarningFunc) (void *ctx,
const char *msg,
...) LIBXML_ATTR_FORMAT(2,3);
typedef struct _xmlValidCtxt xmlValidCtxt;
typedef xmlValidCtxt *xmlValidCtxtPtr;
/**
* An xmlValidCtxt is used for error reporting when validating.
*/
struct _xmlValidCtxt {
void *userData; /* user specific data block */
xmlValidityErrorFunc error; /* the callback in case of errors */
xmlValidityWarningFunc warning; /* the callback in case of warning */
/* Node analysis stack used when validating within entities */
xmlNode *node; /* Current parsed Node */
int nodeNr; /* Depth of the parsing stack */
int nodeMax; /* Max depth of the parsing stack */
xmlNode **nodeTab; /* array of nodes */
unsigned int flags; /* internal flags */
xmlDoc *doc; /* the document */
int valid; /* temporary validity check result */
/* state state used for non-determinist content validation */
xmlValidState *vstate; /* current state */
int vstateNr; /* Depth of the validation stack */
int vstateMax; /* Max depth of the validation stack */
xmlValidState *vstateTab; /* array of validation states */
#ifdef LIBXML_REGEXP_ENABLED
xmlAutomata *am; /* the automata */
xmlAutomataState *state; /* used to build the automata */
#else
void *am;
void *state;
#endif
};
typedef struct _xmlHashTable xmlNotationTable;
typedef xmlNotationTable *xmlNotationTablePtr;
typedef struct _xmlHashTable xmlElementTable;
typedef xmlElementTable *xmlElementTablePtr;
typedef struct _xmlHashTable xmlAttributeTable;
typedef xmlAttributeTable *xmlAttributeTablePtr;
typedef struct _xmlHashTable xmlIDTable;
typedef xmlIDTable *xmlIDTablePtr;
typedef struct _xmlHashTable xmlRefTable;
typedef xmlRefTable *xmlRefTablePtr;
/* Notation */
XMLPUBFUN xmlNotation *
xmlAddNotationDecl (xmlValidCtxt *ctxt,
xmlDtd *dtd,
const xmlChar *name,
const xmlChar *publicId,
const xmlChar *systemId);
XML_DEPRECATED
XMLPUBFUN xmlNotationTable *
xmlCopyNotationTable (xmlNotationTable *table);
XML_DEPRECATED
XMLPUBFUN void
xmlFreeNotationTable (xmlNotationTable *table);
#ifdef LIBXML_OUTPUT_ENABLED
XML_DEPRECATED
XMLPUBFUN void
xmlDumpNotationDecl (xmlBuffer *buf,
xmlNotation *nota);
/* XML_DEPRECATED, still used in lxml */
XMLPUBFUN void
xmlDumpNotationTable (xmlBuffer *buf,
xmlNotationTable *table);
#endif /* LIBXML_OUTPUT_ENABLED */
/* Element Content */
XML_DEPRECATED
XMLPUBFUN xmlElementContent *
xmlNewElementContent (const xmlChar *name,
xmlElementContentType type);
XML_DEPRECATED
XMLPUBFUN xmlElementContent *
xmlCopyElementContent (xmlElementContent *content);
XML_DEPRECATED
XMLPUBFUN void
xmlFreeElementContent (xmlElementContent *cur);
XML_DEPRECATED
XMLPUBFUN xmlElementContent *
xmlNewDocElementContent (xmlDoc *doc,
const xmlChar *name,
xmlElementContentType type);
XML_DEPRECATED
XMLPUBFUN xmlElementContent *
xmlCopyDocElementContent(xmlDoc *doc,
xmlElementContent *content);
XML_DEPRECATED
XMLPUBFUN void
xmlFreeDocElementContent(xmlDoc *doc,
xmlElementContent *cur);
XML_DEPRECATED
XMLPUBFUN void
xmlSnprintfElementContent(char *buf,
int size,
xmlElementContent *content,
int englob);
#ifdef LIBXML_OUTPUT_ENABLED
XML_DEPRECATED
XMLPUBFUN void
xmlSprintfElementContent(char *buf,
xmlElementContent *content,
int englob);
#endif /* LIBXML_OUTPUT_ENABLED */
/* Element */
XMLPUBFUN xmlElement *
xmlAddElementDecl (xmlValidCtxt *ctxt,
xmlDtd *dtd,
const xmlChar *name,
xmlElementTypeVal type,
xmlElementContent *content);
XML_DEPRECATED
XMLPUBFUN xmlElementTable *
xmlCopyElementTable (xmlElementTable *table);
XML_DEPRECATED
XMLPUBFUN void
xmlFreeElementTable (xmlElementTable *table);
#ifdef LIBXML_OUTPUT_ENABLED
XML_DEPRECATED
XMLPUBFUN void
xmlDumpElementTable (xmlBuffer *buf,
xmlElementTable *table);
XML_DEPRECATED
XMLPUBFUN void
xmlDumpElementDecl (xmlBuffer *buf,
xmlElement *elem);
#endif /* LIBXML_OUTPUT_ENABLED */
/* Enumeration */
XML_DEPRECATED
XMLPUBFUN xmlEnumeration *
xmlCreateEnumeration (const xmlChar *name);
/* XML_DEPRECATED, needed for custom attributeDecl SAX handler */
XMLPUBFUN void
xmlFreeEnumeration (xmlEnumeration *cur);
XML_DEPRECATED
XMLPUBFUN xmlEnumeration *
xmlCopyEnumeration (xmlEnumeration *cur);
/* Attribute */
XMLPUBFUN xmlAttribute *
xmlAddAttributeDecl (xmlValidCtxt *ctxt,
xmlDtd *dtd,
const xmlChar *elem,
const xmlChar *name,
const xmlChar *ns,
xmlAttributeType type,
xmlAttributeDefault def,
const xmlChar *defaultValue,
xmlEnumeration *tree);
XML_DEPRECATED
XMLPUBFUN xmlAttributeTable *
xmlCopyAttributeTable (xmlAttributeTable *table);
XML_DEPRECATED
XMLPUBFUN void
xmlFreeAttributeTable (xmlAttributeTable *table);
#ifdef LIBXML_OUTPUT_ENABLED
XML_DEPRECATED
XMLPUBFUN void
xmlDumpAttributeTable (xmlBuffer *buf,
xmlAttributeTable *table);
XML_DEPRECATED
XMLPUBFUN void
xmlDumpAttributeDecl (xmlBuffer *buf,
xmlAttribute *attr);
#endif /* LIBXML_OUTPUT_ENABLED */
/* IDs */
XMLPUBFUN int
xmlAddIDSafe (xmlAttr *attr,
const xmlChar *value);
XMLPUBFUN xmlID *
xmlAddID (xmlValidCtxt *ctxt,
xmlDoc *doc,
const xmlChar *value,
xmlAttr *attr);
XMLPUBFUN void
xmlFreeIDTable (xmlIDTable *table);
XMLPUBFUN xmlAttr *
xmlGetID (xmlDoc *doc,
const xmlChar *ID);
XMLPUBFUN int
xmlIsID (xmlDoc *doc,
xmlNode *elem,
xmlAttr *attr);
XMLPUBFUN int
xmlRemoveID (xmlDoc *doc,
xmlAttr *attr);
/* IDREFs */
XML_DEPRECATED
XMLPUBFUN xmlRef *
xmlAddRef (xmlValidCtxt *ctxt,
xmlDoc *doc,
const xmlChar *value,
xmlAttr *attr);
XML_DEPRECATED
XMLPUBFUN void
xmlFreeRefTable (xmlRefTable *table);
XML_DEPRECATED
XMLPUBFUN int
xmlIsRef (xmlDoc *doc,
xmlNode *elem,
xmlAttr *attr);
XML_DEPRECATED
XMLPUBFUN int
xmlRemoveRef (xmlDoc *doc,
xmlAttr *attr);
XML_DEPRECATED
XMLPUBFUN xmlList *
xmlGetRefs (xmlDoc *doc,
const xmlChar *ID);
/**
* The public function calls related to validity checking.
*/
#ifdef LIBXML_VALID_ENABLED
/* Allocate/Release Validation Contexts */
XMLPUBFUN xmlValidCtxt *
xmlNewValidCtxt(void);
XMLPUBFUN void
xmlFreeValidCtxt(xmlValidCtxt *);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateRoot (xmlValidCtxt *ctxt,
xmlDoc *doc);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateElementDecl (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlElement *elem);
XML_DEPRECATED
XMLPUBFUN xmlChar *
xmlValidNormalizeAttributeValue(xmlDoc *doc,
xmlNode *elem,
const xmlChar *name,
const xmlChar *value);
XML_DEPRECATED
XMLPUBFUN xmlChar *
xmlValidCtxtNormalizeAttributeValue(xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNode *elem,
const xmlChar *name,
const xmlChar *value);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateAttributeDecl(xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlAttribute *attr);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateAttributeValue(xmlAttributeType type,
const xmlChar *value);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateNotationDecl (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNotation *nota);
XMLPUBFUN int
xmlValidateDtd (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlDtd *dtd);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateDtdFinal (xmlValidCtxt *ctxt,
xmlDoc *doc);
XMLPUBFUN int
xmlValidateDocument (xmlValidCtxt *ctxt,
xmlDoc *doc);
XMLPUBFUN int
xmlValidateElement (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNode *elem);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateOneElement (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNode *elem);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateOneAttribute (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNode *elem,
xmlAttr *attr,
const xmlChar *value);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateOneNamespace (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNode *elem,
const xmlChar *prefix,
xmlNs *ns,
const xmlChar *value);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateDocumentFinal(xmlValidCtxt *ctxt,
xmlDoc *doc);
XML_DEPRECATED
XMLPUBFUN int
xmlValidateNotationUse (xmlValidCtxt *ctxt,
xmlDoc *doc,
const xmlChar *notationName);
#endif /* LIBXML_VALID_ENABLED */
XML_DEPRECATED
XMLPUBFUN int
xmlIsMixedElement (xmlDoc *doc,
const xmlChar *name);
XMLPUBFUN xmlAttribute *
xmlGetDtdAttrDesc (xmlDtd *dtd,
const xmlChar *elem,
const xmlChar *name);
XMLPUBFUN xmlAttribute *
xmlGetDtdQAttrDesc (xmlDtd *dtd,
const xmlChar *elem,
const xmlChar *name,
const xmlChar *prefix);
XMLPUBFUN xmlNotation *
xmlGetDtdNotationDesc (xmlDtd *dtd,
const xmlChar *name);
XMLPUBFUN xmlElement *
xmlGetDtdQElementDesc (xmlDtd *dtd,
const xmlChar *name,
const xmlChar *prefix);
XMLPUBFUN xmlElement *
xmlGetDtdElementDesc (xmlDtd *dtd,
const xmlChar *name);
#ifdef LIBXML_VALID_ENABLED
XMLPUBFUN int
xmlValidGetPotentialChildren(xmlElementContent *ctree,
const xmlChar **names,
int *len,
int max);
/* only needed for `xmllint --insert` */
XMLPUBFUN int
xmlValidGetValidElements(xmlNode *prev,
xmlNode *next,
const xmlChar **names,
int max);
XMLPUBFUN int
xmlValidateNameValue (const xmlChar *value);
XMLPUBFUN int
xmlValidateNamesValue (const xmlChar *value);
XMLPUBFUN int
xmlValidateNmtokenValue (const xmlChar *value);
XMLPUBFUN int
xmlValidateNmtokensValue(const xmlChar *value);
#ifdef LIBXML_REGEXP_ENABLED
/*
* Validation based on the regexp support
*/
XML_DEPRECATED
XMLPUBFUN int
xmlValidBuildContentModel(xmlValidCtxt *ctxt,
xmlElement *elem);
XML_DEPRECATED
XMLPUBFUN int
xmlValidatePushElement (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNode *elem,
const xmlChar *qname);
XML_DEPRECATED
XMLPUBFUN int
xmlValidatePushCData (xmlValidCtxt *ctxt,
const xmlChar *data,
int len);
XML_DEPRECATED
XMLPUBFUN int
xmlValidatePopElement (xmlValidCtxt *ctxt,
xmlDoc *doc,
xmlNode *elem,
const xmlChar *qname);
#endif /* LIBXML_REGEXP_ENABLED */
#endif /* LIBXML_VALID_ENABLED */
#ifdef __cplusplus
}
#endif
#endif /* __XML_VALID_H__ */
|
