Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 1 | /* |
| 2 | * valid.h : interface to the DTD handling and the validity checking |
| 3 | * |
| 4 | * See Copyright for the status of this software. |
| 5 | * |
| 6 | * Daniel.Veillard@w3.org |
| 7 | */ |
| 8 | |
| 9 | |
| 10 | #ifndef __XML_VALID_H__ |
| 11 | #define __XML_VALID_H__ |
Daniel Veillard | c26087b | 1999-08-30 11:23:51 +0000 | [diff] [blame] | 12 | |
Daniel Veillard | 361d845 | 2000-04-03 19:48:13 +0000 | [diff] [blame] | 13 | #include <libxml/tree.h> |
Daniel Veillard | 10cb900 | 1999-11-12 17:02:31 +0000 | [diff] [blame] | 14 | |
Daniel Veillard | c26087b | 1999-08-30 11:23:51 +0000 | [diff] [blame] | 15 | #ifdef __cplusplus |
| 16 | extern "C" { |
| 17 | #endif |
| 18 | |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 19 | /** |
| 20 | * an xmlValidCtxt is used for error reporting when validating |
| 21 | */ |
| 22 | |
| 23 | typedef void (*xmlValidityErrorFunc) (void *ctx, const char *msg, ...); |
| 24 | typedef void (*xmlValidityWarningFunc) (void *ctx, const char *msg, ...); |
| 25 | |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 26 | typedef struct _xmlValidCtxt xmlValidCtxt; |
| 27 | typedef xmlValidCtxt *xmlValidCtxtPtr; |
| 28 | struct _xmlValidCtxt { |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 29 | void *userData; /* user specific data block */ |
| 30 | xmlValidityErrorFunc error; /* the callback in case of errors */ |
| 31 | xmlValidityWarningFunc warning; /* the callback in case of warning */ |
Daniel Veillard | cf46199 | 2000-03-14 18:30:20 +0000 | [diff] [blame] | 32 | |
| 33 | /* Node analysis stack used when validating within entities */ |
| 34 | xmlNodePtr node; /* Current parsed Node */ |
| 35 | int nodeNr; /* Depth of the parsing stack */ |
| 36 | int nodeMax; /* Max depth of the parsing stack */ |
| 37 | xmlNodePtr *nodeTab; /* array of nodes */ |
| 38 | |
| 39 | int finishDtd; /* finished validating the Dtd ? */ |
Daniel Veillard | 126f279 | 2000-10-24 17:10:12 +0000 | [diff] [blame] | 40 | xmlDocPtr doc; /* the document */ |
| 41 | int valid; /* temporary validity check result */ |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 42 | }; |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 43 | |
Daniel Veillard | 3b9def1 | 1999-01-31 22:15:06 +0000 | [diff] [blame] | 44 | /* |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 45 | * ALl notation declarations are stored in a table |
| 46 | * there is one table per DTD |
| 47 | */ |
| 48 | |
Daniel Veillard | 126f279 | 2000-10-24 17:10:12 +0000 | [diff] [blame] | 49 | typedef struct _xmlHashTable xmlNotationTable; |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 50 | typedef xmlNotationTable *xmlNotationTablePtr; |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 51 | |
| 52 | /* |
Daniel Veillard | 3b9def1 | 1999-01-31 22:15:06 +0000 | [diff] [blame] | 53 | * ALl element declarations are stored in a table |
| 54 | * there is one table per DTD |
| 55 | */ |
| 56 | |
Daniel Veillard | 126f279 | 2000-10-24 17:10:12 +0000 | [diff] [blame] | 57 | typedef struct _xmlHashTable xmlElementTable; |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 58 | typedef xmlElementTable *xmlElementTablePtr; |
Daniel Veillard | 3b9def1 | 1999-01-31 22:15:06 +0000 | [diff] [blame] | 59 | |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 60 | /* |
| 61 | * ALl attribute declarations are stored in a table |
| 62 | * there is one table per DTD |
| 63 | */ |
| 64 | |
Daniel Veillard | 126f279 | 2000-10-24 17:10:12 +0000 | [diff] [blame] | 65 | typedef struct _xmlHashTable xmlAttributeTable; |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 66 | typedef xmlAttributeTable *xmlAttributeTablePtr; |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 67 | |
Daniel Veillard | 991e63d | 1999-08-15 23:32:28 +0000 | [diff] [blame] | 68 | /* |
| 69 | * ALl IDs attributes are stored in a table |
| 70 | * there is one table per document |
| 71 | */ |
| 72 | |
Daniel Veillard | 126f279 | 2000-10-24 17:10:12 +0000 | [diff] [blame] | 73 | typedef struct _xmlHashTable xmlIDTable; |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 74 | typedef xmlIDTable *xmlIDTablePtr; |
Daniel Veillard | 991e63d | 1999-08-15 23:32:28 +0000 | [diff] [blame] | 75 | |
Daniel Veillard | c08a2c6 | 1999-09-08 21:35:25 +0000 | [diff] [blame] | 76 | /* |
| 77 | * ALl Refs attributes are stored in a table |
| 78 | * there is one table per document |
| 79 | */ |
| 80 | |
Daniel Veillard | 126f279 | 2000-10-24 17:10:12 +0000 | [diff] [blame] | 81 | typedef struct _xmlHashTable xmlRefTable; |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 82 | typedef xmlRefTable *xmlRefTablePtr; |
Daniel Veillard | c08a2c6 | 1999-09-08 21:35:25 +0000 | [diff] [blame] | 83 | |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 84 | /* Notation */ |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 85 | xmlNotationPtr xmlAddNotationDecl (xmlValidCtxtPtr ctxt, |
| 86 | xmlDtdPtr dtd, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 87 | const xmlChar *name, |
| 88 | const xmlChar *PublicID, |
| 89 | const xmlChar *SystemID); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 90 | xmlNotationTablePtr xmlCopyNotationTable(xmlNotationTablePtr table); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 91 | void xmlFreeNotationTable(xmlNotationTablePtr table); |
Daniel Veillard | cf46199 | 2000-03-14 18:30:20 +0000 | [diff] [blame] | 92 | void xmlDumpNotationDecl (xmlBufferPtr buf, |
| 93 | xmlNotationPtr nota); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 94 | void xmlDumpNotationTable(xmlBufferPtr buf, |
| 95 | xmlNotationTablePtr table); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 96 | |
| 97 | /* Element Content */ |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 98 | xmlElementContentPtr xmlNewElementContent (xmlChar *name, |
Daniel Veillard | c26087b | 1999-08-30 11:23:51 +0000 | [diff] [blame] | 99 | xmlElementContentType type); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 100 | xmlElementContentPtr xmlCopyElementContent(xmlElementContentPtr content); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 101 | void xmlFreeElementContent(xmlElementContentPtr cur); |
Daniel Veillard | cf46199 | 2000-03-14 18:30:20 +0000 | [diff] [blame] | 102 | void xmlSprintfElementContent(char *buf, |
| 103 | xmlElementContentPtr content, |
| 104 | int glob); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 105 | |
| 106 | /* Element */ |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 107 | xmlElementPtr xmlAddElementDecl (xmlValidCtxtPtr ctxt, |
| 108 | xmlDtdPtr dtd, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 109 | const xmlChar *name, |
Daniel Veillard | 51e3b15 | 1999-11-12 17:02:31 +0000 | [diff] [blame] | 110 | xmlElementTypeVal type, |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 111 | xmlElementContentPtr content); |
| 112 | xmlElementTablePtr xmlCopyElementTable (xmlElementTablePtr table); |
| 113 | void xmlFreeElementTable (xmlElementTablePtr table); |
| 114 | void xmlDumpElementTable (xmlBufferPtr buf, |
| 115 | xmlElementTablePtr table); |
Daniel Veillard | cf46199 | 2000-03-14 18:30:20 +0000 | [diff] [blame] | 116 | void xmlDumpElementDecl (xmlBufferPtr buf, |
| 117 | xmlElementPtr elem); |
Daniel Veillard | 3b9def1 | 1999-01-31 22:15:06 +0000 | [diff] [blame] | 118 | |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 119 | /* Enumeration */ |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 120 | xmlEnumerationPtr xmlCreateEnumeration (xmlChar *name); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 121 | void xmlFreeEnumeration (xmlEnumerationPtr cur); |
| 122 | xmlEnumerationPtr xmlCopyEnumeration (xmlEnumerationPtr cur); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 123 | |
| 124 | /* Attribute */ |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 125 | xmlAttributePtr xmlAddAttributeDecl (xmlValidCtxtPtr ctxt, |
| 126 | xmlDtdPtr dtd, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 127 | const xmlChar *elem, |
| 128 | const xmlChar *name, |
Daniel Veillard | 0604743 | 2000-04-24 11:33:38 +0000 | [diff] [blame] | 129 | const xmlChar *ns, |
Daniel Veillard | c26087b | 1999-08-30 11:23:51 +0000 | [diff] [blame] | 130 | xmlAttributeType type, |
| 131 | xmlAttributeDefault def, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 132 | const xmlChar *defaultValue, |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 133 | xmlEnumerationPtr tree); |
| 134 | xmlAttributeTablePtr xmlCopyAttributeTable (xmlAttributeTablePtr table); |
| 135 | void xmlFreeAttributeTable (xmlAttributeTablePtr table); |
| 136 | void xmlDumpAttributeTable (xmlBufferPtr buf, |
| 137 | xmlAttributeTablePtr table); |
Daniel Veillard | cf46199 | 2000-03-14 18:30:20 +0000 | [diff] [blame] | 138 | void xmlDumpAttributeDecl (xmlBufferPtr buf, |
| 139 | xmlAttributePtr attr); |
Daniel Veillard | 1e346af | 1999-02-22 10:33:01 +0000 | [diff] [blame] | 140 | |
Daniel Veillard | 991e63d | 1999-08-15 23:32:28 +0000 | [diff] [blame] | 141 | /* IDs */ |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 142 | xmlIDPtr xmlAddID (xmlValidCtxtPtr ctxt, |
| 143 | xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 144 | const xmlChar *value, |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 145 | xmlAttrPtr attr); |
| 146 | xmlIDTablePtr xmlCopyIDTable (xmlIDTablePtr table); |
| 147 | void xmlFreeIDTable (xmlIDTablePtr table); |
| 148 | xmlAttrPtr xmlGetID (xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 149 | const xmlChar *ID); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 150 | int xmlIsID (xmlDocPtr doc, |
| 151 | xmlNodePtr elem, |
| 152 | xmlAttrPtr attr); |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 153 | int xmlRemoveID (xmlDocPtr doc, xmlAttrPtr attr); |
Daniel Veillard | 991e63d | 1999-08-15 23:32:28 +0000 | [diff] [blame] | 154 | |
Daniel Veillard | c08a2c6 | 1999-09-08 21:35:25 +0000 | [diff] [blame] | 155 | /* IDREFs */ |
| 156 | xmlRefPtr xmlAddRef (xmlValidCtxtPtr ctxt, |
| 157 | xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 158 | const xmlChar *value, |
Daniel Veillard | c08a2c6 | 1999-09-08 21:35:25 +0000 | [diff] [blame] | 159 | xmlAttrPtr attr); |
| 160 | xmlRefTablePtr xmlCopyRefTable (xmlRefTablePtr table); |
| 161 | void xmlFreeRefTable (xmlRefTablePtr table); |
| 162 | int xmlIsRef (xmlDocPtr doc, |
| 163 | xmlNodePtr elem, |
| 164 | xmlAttrPtr attr); |
Daniel Veillard | 71b656e | 2000-01-05 14:46:17 +0000 | [diff] [blame] | 165 | int xmlRemoveRef (xmlDocPtr doc, xmlAttrPtr attr); |
Daniel Veillard | c08a2c6 | 1999-09-08 21:35:25 +0000 | [diff] [blame] | 166 | |
Daniel Veillard | b05deb7 | 1999-08-10 19:04:08 +0000 | [diff] [blame] | 167 | /** |
| 168 | * The public function calls related to validity checking |
| 169 | */ |
| 170 | |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 171 | int xmlValidateRoot (xmlValidCtxtPtr ctxt, |
| 172 | xmlDocPtr doc); |
| 173 | int xmlValidateElementDecl (xmlValidCtxtPtr ctxt, |
| 174 | xmlDocPtr doc, |
| 175 | xmlElementPtr elem); |
Daniel Veillard | cf46199 | 2000-03-14 18:30:20 +0000 | [diff] [blame] | 176 | xmlChar * xmlValidNormalizeAttributeValue(xmlDocPtr doc, |
| 177 | xmlNodePtr elem, |
| 178 | const xmlChar *name, |
| 179 | const xmlChar *value); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 180 | int xmlValidateAttributeDecl(xmlValidCtxtPtr ctxt, |
| 181 | xmlDocPtr doc, |
| 182 | xmlAttributePtr attr); |
| 183 | int xmlValidateAttributeValue(xmlAttributeType type, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 184 | const xmlChar *value); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 185 | int xmlValidateNotationDecl (xmlValidCtxtPtr ctxt, |
| 186 | xmlDocPtr doc, |
| 187 | xmlNotationPtr nota); |
| 188 | int xmlValidateDtd (xmlValidCtxtPtr ctxt, |
| 189 | xmlDocPtr doc, |
| 190 | xmlDtdPtr dtd); |
Daniel Veillard | cf46199 | 2000-03-14 18:30:20 +0000 | [diff] [blame] | 191 | int xmlValidateDtdFinal (xmlValidCtxtPtr ctxt, |
| 192 | xmlDocPtr doc); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 193 | int xmlValidateDocument (xmlValidCtxtPtr ctxt, |
| 194 | xmlDocPtr doc); |
| 195 | int xmlValidateElement (xmlValidCtxtPtr ctxt, |
| 196 | xmlDocPtr doc, |
| 197 | xmlNodePtr elem); |
| 198 | int xmlValidateOneElement (xmlValidCtxtPtr ctxt, |
| 199 | xmlDocPtr doc, |
| 200 | xmlNodePtr elem); |
| 201 | int xmlValidateOneAttribute (xmlValidCtxtPtr ctxt, |
| 202 | xmlDocPtr doc, |
| 203 | xmlNodePtr elem, |
| 204 | xmlAttrPtr attr, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 205 | const xmlChar *value); |
Daniel Veillard | c08a2c6 | 1999-09-08 21:35:25 +0000 | [diff] [blame] | 206 | int xmlValidateDocumentFinal(xmlValidCtxtPtr ctxt, |
| 207 | xmlDocPtr doc); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 208 | int xmlValidateNotationUse (xmlValidCtxtPtr ctxt, |
| 209 | xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 210 | const xmlChar *notationName); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 211 | int xmlIsMixedElement (xmlDocPtr doc, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 212 | const xmlChar *name); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 213 | xmlAttributePtr xmlGetDtdAttrDesc (xmlDtdPtr dtd, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 214 | const xmlChar *elem, |
| 215 | const xmlChar *name); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 216 | xmlNotationPtr xmlGetDtdNotationDesc (xmlDtdPtr dtd, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 217 | const xmlChar *name); |
Daniel Veillard | b96e643 | 1999-08-29 21:02:19 +0000 | [diff] [blame] | 218 | xmlElementPtr xmlGetDtdElementDesc (xmlDtdPtr dtd, |
Daniel Veillard | dd6b367 | 1999-09-23 22:19:22 +0000 | [diff] [blame] | 219 | const xmlChar *name); |
Daniel Veillard | c26087b | 1999-08-30 11:23:51 +0000 | [diff] [blame] | 220 | |
Daniel Veillard | 7c1206f | 1999-10-14 09:10:25 +0000 | [diff] [blame] | 221 | int xmlValidGetValidElements(xmlNode *prev, |
| 222 | xmlNode *next, |
| 223 | const xmlChar **list, |
| 224 | int max); |
| 225 | int xmlValidGetPotentialChildren(xmlElementContent *ctree, |
| 226 | const xmlChar **list, |
| 227 | int *len, |
| 228 | int max); |
Daniel Veillard | c26087b | 1999-08-30 11:23:51 +0000 | [diff] [blame] | 229 | #ifdef __cplusplus |
| 230 | } |
| 231 | #endif |
Daniel Veillard | 39a1f9a | 1999-01-17 19:11:59 +0000 | [diff] [blame] | 232 | #endif /* __XML_VALID_H__ */ |