ReactOS  0.4.14-dev-98-gb0d4763
valid.h
Go to the documentation of this file.
1 /*
2  * Summary: The DTD validation
3  * Description: API for the DTD handling and the validity checking
4  *
5  * Copy: See Copyright for the status of this software.
6  *
7  * Author: Daniel Veillard
8  */
9 
10 
11 #ifndef __XML_VALID_H__
12 #define __XML_VALID_H__
13 
14 #include <libxml/xmlversion.h>
15 #include <libxml/xmlerror.h>
16 #include <libxml/tree.h>
17 #include <libxml/list.h>
18 #include <libxml/xmlautomata.h>
19 #include <libxml/xmlregexp.h>
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif
24 
25 /*
26  * Validation state added for non-determinist content model.
27  */
28 typedef struct _xmlValidState xmlValidState;
30 
42 typedef void (XMLCDECL *xmlValidityErrorFunc) (void *ctx,
43  const char *msg,
44  ...) LIBXML_ATTR_FORMAT(2,3);
45 
57 typedef void (XMLCDECL *xmlValidityWarningFunc) (void *ctx,
58  const char *msg,
59  ...) LIBXML_ATTR_FORMAT(2,3);
60 
61 #ifdef IN_LIBXML
62 
67 #define XML_CTXT_FINISH_DTD_0 0xabcd1234
68 
73 #define XML_CTXT_FINISH_DTD_1 0xabcd1235
74 #endif
75 
76 /*
77  * xmlValidCtxt:
78  * An xmlValidCtxt is used for error reporting when validating.
79  */
80 typedef struct _xmlValidCtxt xmlValidCtxt;
82 struct _xmlValidCtxt {
83  void *userData; /* user specific data block */
84  xmlValidityErrorFunc error; /* the callback in case of errors */
85  xmlValidityWarningFunc warning; /* the callback in case of warning */
86 
87  /* Node analysis stack used when validating within entities */
88  xmlNodePtr node; /* Current parsed Node */
89  int nodeNr; /* Depth of the parsing stack */
90  int nodeMax; /* Max depth of the parsing stack */
91  xmlNodePtr *nodeTab; /* array of nodes */
92 
93  unsigned int finishDtd; /* finished validating the Dtd ? */
94  xmlDocPtr doc; /* the document */
95  int valid; /* temporary validity check result */
96 
97  /* state state used for non-determinist content validation */
98  xmlValidState *vstate; /* current state */
99  int vstateNr; /* Depth of the validation stack */
100  int vstateMax; /* Max depth of the validation stack */
101  xmlValidState *vstateTab; /* array of validation states */
102 
103 #ifdef LIBXML_REGEXP_ENABLED
104  xmlAutomataPtr am; /* the automata */
105  xmlAutomataStatePtr state; /* used to build the automata */
106 #else
107  void *am;
108  void *state;
109 #endif
110 };
111 
112 /*
113  * ALL notation declarations are stored in a table.
114  * There is one table per DTD.
115  */
116 
119 
120 /*
121  * ALL element declarations are stored in a table.
122  * There is one table per DTD.
123  */
124 
127 
128 /*
129  * ALL attribute declarations are stored in a table.
130  * There is one table per DTD.
131  */
132 
135 
136 /*
137  * ALL IDs attributes are stored in a table.
138  * There is one table per document.
139  */
140 
141 typedef struct _xmlHashTable xmlIDTable;
143 
144 /*
145  * ALL Refs attributes are stored in a table.
146  * There is one table per document.
147  */
148 
149 typedef struct _xmlHashTable xmlRefTable;
151 
152 /* Notation */
155  xmlDtdPtr dtd,
156  const xmlChar *name,
157  const xmlChar *PublicID,
158  const xmlChar *SystemID);
159 #ifdef LIBXML_TREE_ENABLED
161  xmlCopyNotationTable (xmlNotationTablePtr table);
162 #endif /* LIBXML_TREE_ENABLED */
163 XMLPUBFUN void XMLCALL
165 #ifdef LIBXML_OUTPUT_ENABLED
166 XMLPUBFUN void XMLCALL
167  xmlDumpNotationDecl (xmlBufferPtr buf,
168  xmlNotationPtr nota);
169 XMLPUBFUN void XMLCALL
170  xmlDumpNotationTable (xmlBufferPtr buf,
172 #endif /* LIBXML_OUTPUT_ENABLED */
173 
174 /* Element Content */
175 /* the non Doc version are being deprecated */
181 XMLPUBFUN void XMLCALL
183 /* the new versions with doc argument */
186  const xmlChar *name,
191 XMLPUBFUN void XMLCALL
194 XMLPUBFUN void XMLCALL
196  int size,
198  int englob);
199 #ifdef LIBXML_OUTPUT_ENABLED
200 /* DEPRECATED */
201 XMLPUBFUN void XMLCALL
202  xmlSprintfElementContent(char *buf,
204  int englob);
205 #endif /* LIBXML_OUTPUT_ENABLED */
206 /* DEPRECATED */
207 
208 /* Element */
211  xmlDtdPtr dtd,
212  const xmlChar *name,
215 #ifdef LIBXML_TREE_ENABLED
217  xmlCopyElementTable (xmlElementTablePtr table);
218 #endif /* LIBXML_TREE_ENABLED */
219 XMLPUBFUN void XMLCALL
221 #ifdef LIBXML_OUTPUT_ENABLED
222 XMLPUBFUN void XMLCALL
223  xmlDumpElementTable (xmlBufferPtr buf,
225 XMLPUBFUN void XMLCALL
226  xmlDumpElementDecl (xmlBufferPtr buf,
228 #endif /* LIBXML_OUTPUT_ENABLED */
229 
230 /* Enumeration */
233 XMLPUBFUN void XMLCALL
235 #ifdef LIBXML_TREE_ENABLED
237  xmlCopyEnumeration (xmlEnumerationPtr cur);
238 #endif /* LIBXML_TREE_ENABLED */
239 
240 /* Attribute */
243  xmlDtdPtr dtd,
244  const xmlChar *elem,
245  const xmlChar *name,
246  const xmlChar *ns,
249  const xmlChar *defaultValue,
251 #ifdef LIBXML_TREE_ENABLED
253  xmlCopyAttributeTable (xmlAttributeTablePtr table);
254 #endif /* LIBXML_TREE_ENABLED */
255 XMLPUBFUN void XMLCALL
257 #ifdef LIBXML_OUTPUT_ENABLED
258 XMLPUBFUN void XMLCALL
259  xmlDumpAttributeTable (xmlBufferPtr buf,
261 XMLPUBFUN void XMLCALL
262  xmlDumpAttributeDecl (xmlBufferPtr buf,
264 #endif /* LIBXML_OUTPUT_ENABLED */
265 
266 /* IDs */
269  xmlDocPtr doc,
270  const xmlChar *value,
271  xmlAttrPtr attr);
272 XMLPUBFUN void XMLCALL
275  xmlGetID (xmlDocPtr doc,
276  const xmlChar *ID);
277 XMLPUBFUN int XMLCALL
278  xmlIsID (xmlDocPtr doc,
280  xmlAttrPtr attr);
281 XMLPUBFUN int XMLCALL
282  xmlRemoveID (xmlDocPtr doc,
283  xmlAttrPtr attr);
284 
285 /* IDREFs */
288  xmlDocPtr doc,
289  const xmlChar *value,
290  xmlAttrPtr attr);
291 XMLPUBFUN void XMLCALL
293 XMLPUBFUN int XMLCALL
294  xmlIsRef (xmlDocPtr doc,
296  xmlAttrPtr attr);
297 XMLPUBFUN int XMLCALL
298  xmlRemoveRef (xmlDocPtr doc,
299  xmlAttrPtr attr);
301  xmlGetRefs (xmlDocPtr doc,
302  const xmlChar *ID);
303 
307 #ifdef LIBXML_VALID_ENABLED
308 /* Allocate/Release Validation Contexts */
310  xmlNewValidCtxt(void);
311 XMLPUBFUN void XMLCALL
312  xmlFreeValidCtxt(xmlValidCtxtPtr);
313 
314 XMLPUBFUN int XMLCALL
315  xmlValidateRoot (xmlValidCtxtPtr ctxt,
316  xmlDocPtr doc);
317 XMLPUBFUN int XMLCALL
318  xmlValidateElementDecl (xmlValidCtxtPtr ctxt,
319  xmlDocPtr doc,
322  xmlValidNormalizeAttributeValue(xmlDocPtr doc,
324  const xmlChar *name,
325  const xmlChar *value);
327  xmlValidCtxtNormalizeAttributeValue(xmlValidCtxtPtr ctxt,
328  xmlDocPtr doc,
330  const xmlChar *name,
331  const xmlChar *value);
332 XMLPUBFUN int XMLCALL
333  xmlValidateAttributeDecl(xmlValidCtxtPtr ctxt,
334  xmlDocPtr doc,
336 XMLPUBFUN int XMLCALL
337  xmlValidateAttributeValue(xmlAttributeType type,
338  const xmlChar *value);
339 XMLPUBFUN int XMLCALL
340  xmlValidateNotationDecl (xmlValidCtxtPtr ctxt,
341  xmlDocPtr doc,
342  xmlNotationPtr nota);
343 XMLPUBFUN int XMLCALL
344  xmlValidateDtd (xmlValidCtxtPtr ctxt,
345  xmlDocPtr doc,
346  xmlDtdPtr dtd);
347 XMLPUBFUN int XMLCALL
348  xmlValidateDtdFinal (xmlValidCtxtPtr ctxt,
349  xmlDocPtr doc);
350 XMLPUBFUN int XMLCALL
351  xmlValidateDocument (xmlValidCtxtPtr ctxt,
352  xmlDocPtr doc);
353 XMLPUBFUN int XMLCALL
354  xmlValidateElement (xmlValidCtxtPtr ctxt,
355  xmlDocPtr doc,
356  xmlNodePtr elem);
357 XMLPUBFUN int XMLCALL
358  xmlValidateOneElement (xmlValidCtxtPtr ctxt,
359  xmlDocPtr doc,
360  xmlNodePtr elem);
361 XMLPUBFUN int XMLCALL
362  xmlValidateOneAttribute (xmlValidCtxtPtr ctxt,
363  xmlDocPtr doc,
366  const xmlChar *value);
367 XMLPUBFUN int XMLCALL
368  xmlValidateOneNamespace (xmlValidCtxtPtr ctxt,
369  xmlDocPtr doc,
371  const xmlChar *prefix,
372  xmlNsPtr ns,
373  const xmlChar *value);
374 XMLPUBFUN int XMLCALL
375  xmlValidateDocumentFinal(xmlValidCtxtPtr ctxt,
376  xmlDocPtr doc);
377 #endif /* LIBXML_VALID_ENABLED */
378 
379 #if defined(LIBXML_VALID_ENABLED) || defined(LIBXML_SCHEMAS_ENABLED)
380 XMLPUBFUN int XMLCALL
381  xmlValidateNotationUse (xmlValidCtxtPtr ctxt,
382  xmlDocPtr doc,
383  const xmlChar *notationName);
384 #endif /* LIBXML_VALID_ENABLED or LIBXML_SCHEMAS_ENABLED */
385 
386 XMLPUBFUN int XMLCALL
388  const xmlChar *name);
391  const xmlChar *elem,
392  const xmlChar *name);
395  const xmlChar *elem,
396  const xmlChar *name,
397  const xmlChar *prefix);
400  const xmlChar *name);
403  const xmlChar *name,
404  const xmlChar *prefix);
407  const xmlChar *name);
408 
409 #ifdef LIBXML_VALID_ENABLED
410 
411 XMLPUBFUN int XMLCALL
412  xmlValidGetPotentialChildren(xmlElementContent *ctree,
413  const xmlChar **names,
414  int *len,
415  int max);
416 
417 XMLPUBFUN int XMLCALL
418  xmlValidGetValidElements(xmlNode *prev,
419  xmlNode *next,
420  const xmlChar **names,
421  int max);
422 XMLPUBFUN int XMLCALL
423  xmlValidateNameValue (const xmlChar *value);
424 XMLPUBFUN int XMLCALL
425  xmlValidateNamesValue (const xmlChar *value);
426 XMLPUBFUN int XMLCALL
427  xmlValidateNmtokenValue (const xmlChar *value);
428 XMLPUBFUN int XMLCALL
429  xmlValidateNmtokensValue(const xmlChar *value);
430 
431 #ifdef LIBXML_REGEXP_ENABLED
432 /*
433  * Validation based on the regexp support
434  */
435 XMLPUBFUN int XMLCALL
436  xmlValidBuildContentModel(xmlValidCtxtPtr ctxt,
438 
439 XMLPUBFUN int XMLCALL
440  xmlValidatePushElement (xmlValidCtxtPtr ctxt,
441  xmlDocPtr doc,
443  const xmlChar *qname);
444 XMLPUBFUN int XMLCALL
445  xmlValidatePushCData (xmlValidCtxtPtr ctxt,
446  const xmlChar *data,
447  int len);
448 XMLPUBFUN int XMLCALL
449  xmlValidatePopElement (xmlValidCtxtPtr ctxt,
450  xmlDocPtr doc,
452  const xmlChar *qname);
453 #endif /* LIBXML_REGEXP_ENABLED */
454 #endif /* LIBXML_VALID_ENABLED */
455 #ifdef __cplusplus
456 }
457 #endif
458 #endif /* __XML_VALID_H__ */
int nodeMax
Definition: valid.h:90
XMLPUBFUN int XMLCALL xmlRemoveID(xmlDocPtr doc, xmlAttrPtr attr)
Definition: valid.c:2765
int nodeNr
Definition: valid.h:89
#define max(a, b)
Definition: svc.c:63
void(XMLCDECL *) typede void)(XMLCDECL *xmlValidityWarningFunc)(void *ctx
Definition: valid.h:57
XMLPUBFUN xmlNotationPtr XMLCALL xmlAddNotationDecl(xmlValidCtxtPtr ctxt, xmlDtdPtr dtd, const xmlChar *name, const xmlChar *PublicID, const xmlChar *SystemID)
Definition: valid.c:2365
XMLPUBFUN void XMLCALL xmlFreeAttributeTable(xmlAttributeTablePtr table)
Definition: valid.c:2164
xmlValidState * xmlValidStatePtr
Definition: valid.h:29
unsigned int finishDtd
Definition: valid.h:93
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glext.h:7751
XMLPUBFUN void XMLCALL xmlFreeIDTable(xmlIDTablePtr table)
Definition: valid.c:2686
Definition: tree.h:389
GLuint GLuint GLsizei GLenum type
Definition: gl.h:1545
XMLPUBFUN int XMLCALL xmlIsRef(xmlDocPtr doc, xmlNodePtr elem, xmlAttrPtr attr)
Definition: valid.c:3045
xmlValidityErrorFunc error
Definition: valid.h:84
#define XMLPUBFUN
Definition: xmlexports.h:30
xmlElementTable * xmlElementTablePtr
Definition: valid.h:126
XMLPUBFUN xmlAttributePtr XMLCALL xmlGetDtdAttrDesc(xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name)
Definition: valid.c:3298
XMLPUBFUN xmlEnumerationPtr XMLCALL xmlCreateEnumeration(const xmlChar *name)
Definition: valid.c:1766
XMLPUBFUN xmlElementContentPtr XMLCALL xmlNewDocElementContent(xmlDocPtr doc, const xmlChar *name, xmlElementContentType type)
Definition: valid.c:921
xmlNodePtr * nodeTab
Definition: valid.h:91
XMLPUBFUN xmlElementContentPtr XMLCALL xmlCopyElementContent(xmlElementContentPtr content)
Definition: valid.c:1089
XMLPUBFUN xmlAttrPtr XMLCALL xmlGetID(xmlDocPtr doc, const xmlChar *ID)
Definition: valid.c:2803
Definition: tree.h:406
GLuint GLuint * names
Definition: glext.h:11545
xmlElementTypeVal
Definition: tree.h:322
void(XMLCDECL *) typedef const cha LIBXML_ATTR_FORMAT)(2, 3)
Definition: valid.h:59
Definition: tree.h:474
XMLPUBFUN void XMLCALL xmlSnprintfElementContent(char *buf, int size, xmlElementContentPtr content, int englob)
Definition: valid.c:1254
xmlNodePtr node
Definition: valid.h:88
void * am
Definition: valid.h:107
static size_t elem
Definition: string.c:68
xmlValidCtxt * xmlValidCtxtPtr
Definition: valid.h:81
content
Definition: atl_ax.c:994
XMLPUBFUN void XMLCALL xmlFreeNotationTable(xmlNotationTablePtr table)
Definition: valid.c:2442
xmlValidState * vstateTab
Definition: valid.h:101
xmlAttributeTable * xmlAttributeTablePtr
Definition: valid.h:134
XMLPUBFUN xmlListPtr XMLCALL xmlGetRefs(xmlDocPtr doc, const xmlChar *ID)
Definition: valid.c:3141
XMLPUBFUN xmlRefPtr XMLCALL xmlAddRef(xmlValidCtxtPtr ctxt, xmlDocPtr doc, const xmlChar *value, xmlAttrPtr attr)
Definition: valid.c:2930
XMLPUBFUN xmlNotationPtr XMLCALL xmlGetDtdNotationDesc(xmlDtdPtr dtd, const xmlChar *name)
Definition: valid.c:3357
GLsizeiptr size
Definition: glext.h:5919
xmlAttributeDefault
Definition: tree.h:225
XMLPUBFUN void XMLCALL xmlFreeDocElementContent(xmlDocPtr doc, xmlElementContentPtr cur)
Definition: valid.c:1101
XMLPUBFUN xmlElementContentPtr XMLCALL xmlCopyDocElementContent(xmlDocPtr doc, xmlElementContentPtr content)
Definition: valid.c:1008
Definition: cookie.c:170
GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * data
Definition: gl.h:1950
XMLPUBFUN xmlAttributePtr XMLCALL xmlGetDtdQAttrDesc(xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name, const xmlChar *prefix)
Definition: valid.c:3335
int vstateMax
Definition: valid.h:100
Definition: tree.h:489
void(XMLCDECL * xmlValidityErrorFunc)(void *ctx, const char *msg,...) LIBXML_ATTR_FORMAT(2
Definition: valid.h:42
XMLPUBFUN int XMLCALL xmlIsID(xmlDocPtr doc, xmlNodePtr elem, xmlAttrPtr attr)
Definition: valid.c:2704
Definition: mxnamespace.c:44
xmlNotationTable * xmlNotationTablePtr
Definition: valid.h:118
void(XMLCDECL *) typedef const char msg)
Definition: valid.h:58
XMLPUBFUN xmlElementPtr XMLCALL xmlGetDtdQElementDesc(xmlDtdPtr dtd, const xmlChar *name, const xmlChar *prefix)
Definition: valid.c:3274
unsigned char xmlChar
Definition: xmlstring.h:28
GLenum GLsizei len
Definition: glext.h:6722
XMLPUBFUN xmlIDPtr XMLCALL xmlAddID(xmlValidCtxtPtr ctxt, xmlDocPtr doc, const xmlChar *value, xmlAttrPtr attr)
Definition: valid.c:2602
#define ID
Definition: ruserpass.c:36
XMLPUBFUN xmlAttributePtr XMLCALL xmlAddAttributeDecl(xmlValidCtxtPtr ctxt, xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name, const xmlChar *ns, xmlAttributeType type, xmlAttributeDefault def, const xmlChar *defaultValue, xmlEnumerationPtr tree)
Definition: valid.c:1938
XMLPUBFUN xmlElementContentPtr XMLCALL xmlNewElementContent(const xmlChar *name, xmlElementContentType type)
Definition: valid.c:994
XMLPUBFUN xmlElementPtr XMLCALL xmlAddElementDecl(xmlValidCtxtPtr ctxt, xmlDtdPtr dtd, const xmlChar *name, xmlElementTypeVal type, xmlElementContentPtr content)
Definition: valid.c:1387
static unsigned __int64 next
Definition: rand_nt.c:6
Definition: list.c:38
xmlIDTable * xmlIDTablePtr
Definition: valid.h:142
xmlElementContentType
Definition: tree.h:278
XMLPUBFUN int XMLCALL xmlIsMixedElement(xmlDocPtr doc, const xmlChar *name)
Definition: valid.c:3413
#define XMLCDECL
Definition: xmlexports.h:49
Definition: tree.h:551
#define XMLCALL
Definition: tree.h:434
Definition: name.c:36
xmlRefTable * xmlRefTablePtr
Definition: valid.h:150
void * userData
Definition: valid.h:83
XMLPUBFUN int XMLCALL xmlRemoveRef(xmlDocPtr doc, xmlAttrPtr attr)
Definition: valid.c:3085
XMLPUBFUN void XMLCALL xmlFreeElementContent(xmlElementContentPtr cur)
Definition: valid.c:1145
int valid
Definition: valid.h:95
xmlDocPtr doc
Definition: valid.h:94
xmlValidState * vstate
Definition: valid.h:98
XMLPUBFUN void XMLCALL xmlFreeRefTable(xmlRefTablePtr table)
Definition: valid.c:3028
xmlValidityWarningFunc warning
Definition: valid.h:85
XMLPUBFUN void XMLCALL xmlFreeEnumeration(xmlEnumerationPtr cur)
Definition: valid.c:1788
xmlAttributeType
Definition: tree.h:206
Definition: tree.h:457
XMLPUBFUN xmlElementPtr XMLCALL xmlGetDtdElementDesc(xmlDtdPtr dtd, const xmlChar *name)
Definition: valid.c:3176
XMLPUBFUN void XMLCALL xmlFreeElementTable(xmlElementTablePtr table)
Definition: valid.c:1612
void * state
Definition: valid.h:108
int vstateNr
Definition: valid.h:99
struct _xmlValidState xmlValidState
Definition: valid.h:28