Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 1 | /* |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 2 | * Summary: incomplete XML Schemas structure implementation |
| 3 | * Description: interface to the XML Schemas handling and schema validity |
| 4 | * checking, it is incomplete right now. |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 5 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 6 | * Copy: See Copyright for the status of this software. |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 7 | * |
Daniel Veillard | be58697 | 2003-11-18 20:56:51 +0000 | [diff] [blame] | 8 | * Author: Daniel Veillard |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
| 11 | |
| 12 | #ifndef __XML_SCHEMA_H__ |
| 13 | #define __XML_SCHEMA_H__ |
| 14 | |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 15 | #include <libxml/xmlversion.h> |
Igor Zlatkovic | 7ae91bc | 2002-11-08 17:18:52 +0000 | [diff] [blame] | 16 | |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 17 | #ifdef LIBXML_SCHEMAS_ENABLED |
| 18 | |
| 19 | #include <libxml/tree.h> |
| 20 | |
| 21 | #ifdef __cplusplus |
| 22 | extern "C" { |
| 23 | #endif |
| 24 | |
Kasimier T. Buchcik | bea2354 | 2004-08-25 20:35:45 +0000 | [diff] [blame] | 25 | /** |
| 26 | * This error codes are obsolete; not used any more. |
| 27 | */ |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 28 | typedef enum { |
| 29 | XML_SCHEMAS_ERR_OK = 0, |
| 30 | XML_SCHEMAS_ERR_NOROOT = 1, |
| 31 | XML_SCHEMAS_ERR_UNDECLAREDELEM, |
| 32 | XML_SCHEMAS_ERR_NOTTOPLEVEL, |
| 33 | XML_SCHEMAS_ERR_MISSING, |
| 34 | XML_SCHEMAS_ERR_WRONGELEM, |
| 35 | XML_SCHEMAS_ERR_NOTYPE, |
| 36 | XML_SCHEMAS_ERR_NOROLLBACK, |
| 37 | XML_SCHEMAS_ERR_ISABSTRACT, |
| 38 | XML_SCHEMAS_ERR_NOTEMPTY, |
Daniel Veillard | 8651f53 | 2002-04-17 09:06:27 +0000 | [diff] [blame] | 39 | XML_SCHEMAS_ERR_ELEMCONT, |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 40 | XML_SCHEMAS_ERR_HAVEDEFAULT, |
| 41 | XML_SCHEMAS_ERR_NOTNILLABLE, |
| 42 | XML_SCHEMAS_ERR_EXTRACONTENT, |
| 43 | XML_SCHEMAS_ERR_INVALIDATTR, |
| 44 | XML_SCHEMAS_ERR_INVALIDELEM, |
Daniel Veillard | e19fc23 | 2002-04-22 16:01:24 +0000 | [diff] [blame] | 45 | XML_SCHEMAS_ERR_NOTDETERMINIST, |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 46 | XML_SCHEMAS_ERR_CONSTRUCT, |
| 47 | XML_SCHEMAS_ERR_INTERNAL, |
| 48 | XML_SCHEMAS_ERR_NOTSIMPLE, |
| 49 | XML_SCHEMAS_ERR_ATTRUNKNOWN, |
| 50 | XML_SCHEMAS_ERR_ATTRINVALID, |
Daniel Veillard | 91a1325 | 2003-03-27 23:44:43 +0000 | [diff] [blame] | 51 | XML_SCHEMAS_ERR_VALUE, |
Daniel Veillard | d3b9cd8 | 2003-04-09 11:24:17 +0000 | [diff] [blame] | 52 | XML_SCHEMAS_ERR_FACET, |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 53 | XML_SCHEMAS_ERR_, |
| 54 | XML_SCHEMAS_ERR_XXX |
| 55 | } xmlSchemaValidError; |
| 56 | |
Kasimier T. Buchcik | 8787640 | 2004-09-29 13:29:03 +0000 | [diff] [blame] | 57 | /* |
| 58 | * ATTENTION: Change xmlSchemaSetValidOptions's check |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 59 | * for invalid values, if adding to the validation |
Kasimier T. Buchcik | 8787640 | 2004-09-29 13:29:03 +0000 | [diff] [blame] | 60 | * options below. |
| 61 | */ |
| 62 | /** |
| 63 | * xmlSchemaValidOption: |
| 64 | * |
| 65 | * This is the set of XML Schema validation options. |
| 66 | */ |
| 67 | typedef enum { |
| 68 | XML_SCHEMA_VAL_VC_I_CREATE = 1<<0 |
| 69 | /* Default/fixed: create an attribute node |
| 70 | * or an element's text node on the instance. |
| 71 | */ |
| 72 | } xmlSchemaValidOption; |
| 73 | |
| 74 | /* |
| 75 | XML_SCHEMA_VAL_XSI_ASSEMBLE = 1<<1, |
| 76 | * assemble schemata using |
| 77 | * xsi:schemaLocation and |
| 78 | * xsi:noNamespaceSchemaLocation |
| 79 | */ |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 80 | |
| 81 | /** |
| 82 | * The schemas related types are kept internal |
| 83 | */ |
| 84 | typedef struct _xmlSchema xmlSchema; |
| 85 | typedef xmlSchema *xmlSchemaPtr; |
| 86 | |
| 87 | /** |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 88 | * xmlSchemaValidityErrorFunc: |
| 89 | * @ctx: the validation context |
| 90 | * @msg: the message |
| 91 | * @...: extra arguments |
| 92 | * |
| 93 | * Signature of an error callback from an XSD validation |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 94 | */ |
Daniel Veillard | f8e3db0 | 2012-09-11 13:26:36 +0800 | [diff] [blame^] | 95 | typedef void (XMLCDECL *xmlSchemaValidityErrorFunc) |
| 96 | (void *ctx, const char *msg, ...) LIBXML_ATTR_FORMAT(2,3); |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 97 | |
| 98 | /** |
| 99 | * xmlSchemaValidityWarningFunc: |
| 100 | * @ctx: the validation context |
| 101 | * @msg: the message |
| 102 | * @...: extra arguments |
| 103 | * |
| 104 | * Signature of a warning callback from an XSD validation |
| 105 | */ |
Daniel Veillard | f8e3db0 | 2012-09-11 13:26:36 +0800 | [diff] [blame^] | 106 | typedef void (XMLCDECL *xmlSchemaValidityWarningFunc) |
| 107 | (void *ctx, const char *msg, ...) LIBXML_ATTR_FORMAT(2,3); |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 108 | |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 109 | /** |
| 110 | * A schemas validation context |
| 111 | */ |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 112 | typedef struct _xmlSchemaParserCtxt xmlSchemaParserCtxt; |
| 113 | typedef xmlSchemaParserCtxt *xmlSchemaParserCtxtPtr; |
| 114 | |
| 115 | typedef struct _xmlSchemaValidCtxt xmlSchemaValidCtxt; |
| 116 | typedef xmlSchemaValidCtxt *xmlSchemaValidCtxtPtr; |
| 117 | |
Daniel Veillard | 97fa5b3 | 2012-08-14 11:01:07 +0800 | [diff] [blame] | 118 | /** |
| 119 | * xmlSchemaValidityLocatorFunc: |
| 120 | * @ctx: user provided context |
| 121 | * @file: returned file information |
| 122 | * @line: returned line information |
| 123 | * |
| 124 | * A schemas validation locator, a callback called by the validator. |
| 125 | * This is used when file or node informations are not available |
| 126 | * to find out what file and line number are affected |
| 127 | * |
| 128 | * Returns: 0 in case of success and -1 in case of error |
| 129 | */ |
| 130 | |
| 131 | typedef int (XMLCDECL *xmlSchemaValidityLocatorFunc) (void *ctx, |
| 132 | const char **file, unsigned long *line); |
| 133 | |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 134 | /* |
| 135 | * Interfaces for parsing. |
| 136 | */ |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 137 | XMLPUBFUN xmlSchemaParserCtxtPtr XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 138 | xmlSchemaNewParserCtxt (const char *URL); |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 139 | XMLPUBFUN xmlSchemaParserCtxtPtr XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 140 | xmlSchemaNewMemParserCtxt (const char *buffer, |
| 141 | int size); |
Daniel Veillard | 9d75150 | 2003-10-29 13:21:47 +0000 | [diff] [blame] | 142 | XMLPUBFUN xmlSchemaParserCtxtPtr XMLCALL |
| 143 | xmlSchemaNewDocParserCtxt (xmlDocPtr doc); |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 144 | XMLPUBFUN void XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 145 | xmlSchemaFreeParserCtxt (xmlSchemaParserCtxtPtr ctxt); |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 146 | XMLPUBFUN void XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 147 | xmlSchemaSetParserErrors (xmlSchemaParserCtxtPtr ctxt, |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 148 | xmlSchemaValidityErrorFunc err, |
| 149 | xmlSchemaValidityWarningFunc warn, |
| 150 | void *ctx); |
Kasimier T. Buchcik | 90b5ebc | 2005-11-18 17:18:27 +0000 | [diff] [blame] | 151 | XMLPUBFUN void XMLCALL |
| 152 | xmlSchemaSetParserStructuredErrors(xmlSchemaParserCtxtPtr ctxt, |
| 153 | xmlStructuredErrorFunc serror, |
| 154 | void *ctx); |
Daniel Veillard | 259f0df | 2004-08-18 09:13:18 +0000 | [diff] [blame] | 155 | XMLPUBFUN int XMLCALL |
Daniel Veillard | f10ae12 | 2005-07-10 19:03:16 +0000 | [diff] [blame] | 156 | xmlSchemaGetParserErrors(xmlSchemaParserCtxtPtr ctxt, |
Daniel Veillard | 259f0df | 2004-08-18 09:13:18 +0000 | [diff] [blame] | 157 | xmlSchemaValidityErrorFunc * err, |
| 158 | xmlSchemaValidityWarningFunc * warn, |
| 159 | void **ctx); |
Daniel Veillard | f10ae12 | 2005-07-10 19:03:16 +0000 | [diff] [blame] | 160 | XMLPUBFUN int XMLCALL |
| 161 | xmlSchemaIsValid (xmlSchemaValidCtxtPtr ctxt); |
| 162 | |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 163 | XMLPUBFUN xmlSchemaPtr XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 164 | xmlSchemaParse (xmlSchemaParserCtxtPtr ctxt); |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 165 | XMLPUBFUN void XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 166 | xmlSchemaFree (xmlSchemaPtr schema); |
Daniel Veillard | a9cce9c | 2003-09-29 13:20:24 +0000 | [diff] [blame] | 167 | #ifdef LIBXML_OUTPUT_ENABLED |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 168 | XMLPUBFUN void XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 169 | xmlSchemaDump (FILE *output, |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 170 | xmlSchemaPtr schema); |
Daniel Veillard | a9cce9c | 2003-09-29 13:20:24 +0000 | [diff] [blame] | 171 | #endif /* LIBXML_OUTPUT_ENABLED */ |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 172 | /* |
| 173 | * Interfaces for validating |
| 174 | */ |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 175 | XMLPUBFUN void XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 176 | xmlSchemaSetValidErrors (xmlSchemaValidCtxtPtr ctxt, |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 177 | xmlSchemaValidityErrorFunc err, |
| 178 | xmlSchemaValidityWarningFunc warn, |
| 179 | void *ctx); |
Daniel Veillard | da0aa4c | 2005-07-13 23:07:49 +0000 | [diff] [blame] | 180 | XMLPUBFUN void XMLCALL |
| 181 | xmlSchemaSetValidStructuredErrors(xmlSchemaValidCtxtPtr ctxt, |
Kasimier T. Buchcik | 90b5ebc | 2005-11-18 17:18:27 +0000 | [diff] [blame] | 182 | xmlStructuredErrorFunc serror, |
| 183 | void *ctx); |
Daniel Veillard | 259f0df | 2004-08-18 09:13:18 +0000 | [diff] [blame] | 184 | XMLPUBFUN int XMLCALL |
Kasimier T. Buchcik | 8787640 | 2004-09-29 13:29:03 +0000 | [diff] [blame] | 185 | xmlSchemaGetValidErrors (xmlSchemaValidCtxtPtr ctxt, |
| 186 | xmlSchemaValidityErrorFunc *err, |
| 187 | xmlSchemaValidityWarningFunc *warn, |
| 188 | void **ctx); |
| 189 | XMLPUBFUN int XMLCALL |
| 190 | xmlSchemaSetValidOptions (xmlSchemaValidCtxtPtr ctxt, |
| 191 | int options); |
Daniel Veillard | 97fa5b3 | 2012-08-14 11:01:07 +0800 | [diff] [blame] | 192 | XMLPUBFUN void XMLCALL |
| 193 | xmlSchemaValidateSetFilename(xmlSchemaValidCtxtPtr vctxt, |
| 194 | const char *filename); |
Kasimier T. Buchcik | 8787640 | 2004-09-29 13:29:03 +0000 | [diff] [blame] | 195 | XMLPUBFUN int XMLCALL |
| 196 | xmlSchemaValidCtxtGetOptions(xmlSchemaValidCtxtPtr ctxt); |
Daniel Veillard | 259f0df | 2004-08-18 09:13:18 +0000 | [diff] [blame] | 197 | |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 198 | XMLPUBFUN xmlSchemaValidCtxtPtr XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 199 | xmlSchemaNewValidCtxt (xmlSchemaPtr schema); |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 200 | XMLPUBFUN void XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 201 | xmlSchemaFreeValidCtxt (xmlSchemaValidCtxtPtr ctxt); |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 202 | XMLPUBFUN int XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 203 | xmlSchemaValidateDoc (xmlSchemaValidCtxtPtr ctxt, |
| 204 | xmlDocPtr instance); |
Kasimier T. Buchcik | 5eba91f | 2004-09-08 09:17:27 +0000 | [diff] [blame] | 205 | XMLPUBFUN int XMLCALL |
| 206 | xmlSchemaValidateOneElement (xmlSchemaValidCtxtPtr ctxt, |
| 207 | xmlNodePtr elem); |
Kasimier T. Buchcik | c63fbbf | 2005-06-15 12:54:05 +0000 | [diff] [blame] | 208 | XMLPUBFUN int XMLCALL |
Igor Zlatkovic | aa3cfbd | 2003-08-27 08:59:58 +0000 | [diff] [blame] | 209 | xmlSchemaValidateStream (xmlSchemaValidCtxtPtr ctxt, |
| 210 | xmlParserInputBufferPtr input, |
| 211 | xmlCharEncoding enc, |
| 212 | xmlSAXHandlerPtr sax, |
| 213 | void *user_data); |
Kasimier T. Buchcik | c63fbbf | 2005-06-15 12:54:05 +0000 | [diff] [blame] | 214 | XMLPUBFUN int XMLCALL |
| 215 | xmlSchemaValidateFile (xmlSchemaValidCtxtPtr ctxt, |
| 216 | const char * filename, |
| 217 | int options); |
Daniel Veillard | 971771e | 2005-07-09 17:32:57 +0000 | [diff] [blame] | 218 | |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 219 | XMLPUBFUN xmlParserCtxtPtr XMLCALL |
| 220 | xmlSchemaValidCtxtGetParserCtxt(xmlSchemaValidCtxtPtr ctxt); |
| 221 | |
Daniel Veillard | 971771e | 2005-07-09 17:32:57 +0000 | [diff] [blame] | 222 | /* |
Daniel Veillard | dee2348 | 2008-04-11 12:58:43 +0000 | [diff] [blame] | 223 | * Interface to insert Schemas SAX validation in a SAX stream |
Daniel Veillard | 971771e | 2005-07-09 17:32:57 +0000 | [diff] [blame] | 224 | */ |
| 225 | typedef struct _xmlSchemaSAXPlug xmlSchemaSAXPlugStruct; |
| 226 | typedef xmlSchemaSAXPlugStruct *xmlSchemaSAXPlugPtr; |
| 227 | |
| 228 | XMLPUBFUN xmlSchemaSAXPlugPtr XMLCALL |
| 229 | xmlSchemaSAXPlug (xmlSchemaValidCtxtPtr ctxt, |
| 230 | xmlSAXHandlerPtr *sax, |
| 231 | void **user_data); |
| 232 | XMLPUBFUN int XMLCALL |
| 233 | xmlSchemaSAXUnplug (xmlSchemaSAXPlugPtr plug); |
Daniel Veillard | 97fa5b3 | 2012-08-14 11:01:07 +0800 | [diff] [blame] | 234 | |
| 235 | |
| 236 | XMLPUBFUN void XMLCALL |
| 237 | xmlSchemaValidateSetLocator (xmlSchemaValidCtxtPtr vctxt, |
| 238 | xmlSchemaValidityLocatorFunc f, |
| 239 | void *ctxt); |
| 240 | |
Daniel Veillard | 4255d50 | 2002-04-16 15:50:10 +0000 | [diff] [blame] | 241 | #ifdef __cplusplus |
| 242 | } |
| 243 | #endif |
| 244 | |
| 245 | #endif /* LIBXML_SCHEMAS_ENABLED */ |
| 246 | #endif /* __XML_SCHEMA_H__ */ |