kc3-lang/libxml2/include/libxml/schematron.h
Branch
-
Show log
Commit
-
Hash : c7a9ef1d
Author :
Date : 2025-07-04T16:20:28
doc: Document struct typedefs Unfortunately, Doxygen's TYPDEF_HIDES_STRUCT option is too broken. Document struct typedefs to make autolinks work.
-
include/libxml/schematron.h
-
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
/** * @file * * @brief XML Schematron implementation * * interface to the XML Schematron validity checking. * * @copyright See Copyright for the status of this software. * * @author Daniel Veillard */ #ifndef __XML_SCHEMATRON_H__ #define __XML_SCHEMATRON_H__ #include <libxml/xmlversion.h> #ifdef LIBXML_SCHEMATRON_ENABLED #include <libxml/xmlerror.h> #include <libxml/tree.h> #ifdef __cplusplus extern "C" { #endif /** * Schematron validation options */ typedef enum { /** quiet no report */ XML_SCHEMATRON_OUT_QUIET = 1 << 0, /** build a textual report */ XML_SCHEMATRON_OUT_TEXT = 1 << 1, /** output SVRL */ XML_SCHEMATRON_OUT_XML = 1 << 2, /** output via xmlStructuredErrorFunc */ XML_SCHEMATRON_OUT_ERROR = 1 << 3, /** output to a file descriptor */ XML_SCHEMATRON_OUT_FILE = 1 << 8, /** output to a buffer */ XML_SCHEMATRON_OUT_BUFFER = 1 << 9, /** output to I/O mechanism */ XML_SCHEMATRON_OUT_IO = 1 << 10 } xmlSchematronValidOptions; /** Schematron schema */ typedef struct _xmlSchematron xmlSchematron; typedef xmlSchematron *xmlSchematronPtr; /** * Signature of an error callback from a Schematron validation * * @param ctx the validation context * @param msg the message * @param ... extra arguments */ typedef void (*xmlSchematronValidityErrorFunc) (void *ctx, const char *msg, ...); /** * Signature of a warning callback from a Schematron validation * * @param ctx the validation context * @param msg the message * @param ... extra arguments */ typedef void (*xmlSchematronValidityWarningFunc) (void *ctx, const char *msg, ...); /** Schematron parser context */ typedef struct _xmlSchematronParserCtxt xmlSchematronParserCtxt; typedef xmlSchematronParserCtxt *xmlSchematronParserCtxtPtr; /** Schematron validation context */ typedef struct _xmlSchematronValidCtxt xmlSchematronValidCtxt; typedef xmlSchematronValidCtxt *xmlSchematronValidCtxtPtr; /* * Interfaces for parsing. */ XMLPUBFUN xmlSchematronParserCtxt * xmlSchematronNewParserCtxt (const char *URL); XMLPUBFUN xmlSchematronParserCtxt * xmlSchematronNewMemParserCtxt(const char *buffer, int size); XMLPUBFUN xmlSchematronParserCtxt * xmlSchematronNewDocParserCtxt(xmlDoc *doc); XMLPUBFUN void xmlSchematronFreeParserCtxt (xmlSchematronParserCtxt *ctxt); /***** XMLPUBFUN void xmlSchematronSetParserErrors(xmlSchematronParserCtxt *ctxt, xmlSchematronValidityErrorFunc err, xmlSchematronValidityWarningFunc warn, void *ctx); XMLPUBFUN int xmlSchematronGetParserErrors(xmlSchematronParserCtxt *ctxt, xmlSchematronValidityErrorFunc * err, xmlSchematronValidityWarningFunc * warn, void **ctx); XMLPUBFUN int xmlSchematronIsValid (xmlSchematronValidCtxt *ctxt); *****/ XMLPUBFUN xmlSchematron * xmlSchematronParse (xmlSchematronParserCtxt *ctxt); XMLPUBFUN void xmlSchematronFree (xmlSchematron *schema); /* * Interfaces for validating */ XMLPUBFUN void xmlSchematronSetValidStructuredErrors( xmlSchematronValidCtxt *ctxt, xmlStructuredErrorFunc serror, void *ctx); /****** XMLPUBFUN void xmlSchematronSetValidErrors (xmlSchematronValidCtxt *ctxt, xmlSchematronValidityErrorFunc err, xmlSchematronValidityWarningFunc warn, void *ctx); XMLPUBFUN int xmlSchematronGetValidErrors (xmlSchematronValidCtxt *ctxt, xmlSchematronValidityErrorFunc *err, xmlSchematronValidityWarningFunc *warn, void **ctx); XMLPUBFUN int xmlSchematronSetValidOptions(xmlSchematronValidCtxt *ctxt, int options); XMLPUBFUN int xmlSchematronValidCtxtGetOptions(xmlSchematronValidCtxt *ctxt); XMLPUBFUN int xmlSchematronValidateOneElement (xmlSchematronValidCtxt *ctxt, xmlNode *elem); *******/ XMLPUBFUN xmlSchematronValidCtxt * xmlSchematronNewValidCtxt (xmlSchematron *schema, int options); XMLPUBFUN void xmlSchematronFreeValidCtxt (xmlSchematronValidCtxt *ctxt); XMLPUBFUN int xmlSchematronValidateDoc (xmlSchematronValidCtxt *ctxt, xmlDoc *instance); #ifdef __cplusplus } #endif #endif /* LIBXML_SCHEMATRON_ENABLED */ #endif /* __XML_SCHEMATRON_H__ */