mirror of
https://gitlab.gnome.org/GNOME/libxml2.git
synced 2026-01-17 02:02:39 +03:00
ea7751d53b
* testReader.c xmlreader.c valid.c include/libxml/tree.h include/libxml/valid.h include/libxml/xmlreader.h: working on DTD validation on top of xml reader interfaces. Allows to validate arbitrary large instances. This required some extensions to the valid module interface and augmenting the size of xmlID and xmlRef structs a bit. * uri.c xmlregexp.c: simple cleanup. Daniel
331 lines
10 KiB
C
331 lines
10 KiB
C
/*
|
|
* valid.h : interface to the DTD handling and the validity checking
|
|
*
|
|
* See Copyright for the status of this software.
|
|
*
|
|
* daniel@veillard.com
|
|
*/
|
|
|
|
|
|
#ifndef __XML_VALID_H__
|
|
#define __XML_VALID_H__
|
|
|
|
#include <libxml/tree.h>
|
|
#include <libxml/list.h>
|
|
#include <libxml/xmlautomata.h>
|
|
#include <libxml/xmlregexp.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* Validation state added for non-determinist content model.
|
|
*/
|
|
typedef struct _xmlValidState xmlValidState;
|
|
typedef xmlValidState *xmlValidStatePtr;
|
|
|
|
/**
|
|
* xmlValidityErrorFunc:
|
|
* @ctx: an xmlValidCtxtPtr validity error context
|
|
* @msg: the string to format *printf like vararg
|
|
* @...: remaining arguments to the format
|
|
*
|
|
* Callback called when a validity error is found. This is a message
|
|
* oriented function similar to an *printf function.
|
|
*/
|
|
typedef void (*xmlValidityErrorFunc) (void *ctx,
|
|
const char *msg,
|
|
...);
|
|
|
|
/**
|
|
* xmlValidityWarningFunc:
|
|
* @ctx: an xmlValidCtxtPtr validity error context
|
|
* @msg: the string to format *printf like vararg
|
|
* @...: remaining arguments to the format
|
|
*
|
|
* Callback called when a validity warning is found. This is a message
|
|
* oriented function similar to an *printf function.
|
|
*/
|
|
typedef void (*xmlValidityWarningFunc) (void *ctx,
|
|
const char *msg,
|
|
...);
|
|
|
|
/**
|
|
* xmlValidCtxt:
|
|
* An xmlValidCtxt is used for error reporting when validating.
|
|
*/
|
|
typedef struct _xmlValidCtxt xmlValidCtxt;
|
|
typedef xmlValidCtxt *xmlValidCtxtPtr;
|
|
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 */
|
|
xmlNodePtr node; /* Current parsed Node */
|
|
int nodeNr; /* Depth of the parsing stack */
|
|
int nodeMax; /* Max depth of the parsing stack */
|
|
xmlNodePtr *nodeTab; /* array of nodes */
|
|
|
|
int finishDtd; /* finished validating the Dtd ? */
|
|
xmlDocPtr 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
|
|
xmlAutomataPtr am; /* the automata */
|
|
xmlAutomataStatePtr state; /* used to build the automata */
|
|
#else
|
|
void *am;
|
|
void *state;
|
|
#endif
|
|
};
|
|
|
|
/*
|
|
* ALL notation declarations are stored in a table.
|
|
* There is one table per DTD.
|
|
*/
|
|
|
|
typedef struct _xmlHashTable xmlNotationTable;
|
|
typedef xmlNotationTable *xmlNotationTablePtr;
|
|
|
|
/*
|
|
* ALL element declarations are stored in a table.
|
|
* There is one table per DTD.
|
|
*/
|
|
|
|
typedef struct _xmlHashTable xmlElementTable;
|
|
typedef xmlElementTable *xmlElementTablePtr;
|
|
|
|
/*
|
|
* ALL attribute declarations are stored in a table.
|
|
* There is one table per DTD.
|
|
*/
|
|
|
|
typedef struct _xmlHashTable xmlAttributeTable;
|
|
typedef xmlAttributeTable *xmlAttributeTablePtr;
|
|
|
|
/*
|
|
* ALL IDs attributes are stored in a table.
|
|
* There is one table per document.
|
|
*/
|
|
|
|
typedef struct _xmlHashTable xmlIDTable;
|
|
typedef xmlIDTable *xmlIDTablePtr;
|
|
|
|
/*
|
|
* ALL Refs attributes are stored in a table.
|
|
* There is one table per document.
|
|
*/
|
|
|
|
typedef struct _xmlHashTable xmlRefTable;
|
|
typedef xmlRefTable *xmlRefTablePtr;
|
|
|
|
/* helper */
|
|
xmlChar * xmlSplitQName2 (const xmlChar *name,
|
|
xmlChar **prefix);
|
|
|
|
/* Notation */
|
|
xmlNotationPtr xmlAddNotationDecl (xmlValidCtxtPtr ctxt,
|
|
xmlDtdPtr dtd,
|
|
const xmlChar *name,
|
|
const xmlChar *PublicID,
|
|
const xmlChar *SystemID);
|
|
xmlNotationTablePtr xmlCopyNotationTable(xmlNotationTablePtr table);
|
|
void xmlFreeNotationTable(xmlNotationTablePtr table);
|
|
void xmlDumpNotationDecl (xmlBufferPtr buf,
|
|
xmlNotationPtr nota);
|
|
void xmlDumpNotationTable(xmlBufferPtr buf,
|
|
xmlNotationTablePtr table);
|
|
|
|
/* Element Content */
|
|
xmlElementContentPtr xmlNewElementContent (xmlChar *name,
|
|
xmlElementContentType type);
|
|
xmlElementContentPtr xmlCopyElementContent(xmlElementContentPtr content);
|
|
void xmlFreeElementContent(xmlElementContentPtr cur);
|
|
void xmlSnprintfElementContent(char *buf,
|
|
int size,
|
|
xmlElementContentPtr content,
|
|
int glob);
|
|
/* DEPRECATED */
|
|
void xmlSprintfElementContent(char *buf,
|
|
xmlElementContentPtr content,
|
|
int glob);
|
|
/* DEPRECATED */
|
|
|
|
/* Element */
|
|
xmlElementPtr xmlAddElementDecl (xmlValidCtxtPtr ctxt,
|
|
xmlDtdPtr dtd,
|
|
const xmlChar *name,
|
|
xmlElementTypeVal type,
|
|
xmlElementContentPtr content);
|
|
xmlElementTablePtr xmlCopyElementTable (xmlElementTablePtr table);
|
|
void xmlFreeElementTable (xmlElementTablePtr table);
|
|
void xmlDumpElementTable (xmlBufferPtr buf,
|
|
xmlElementTablePtr table);
|
|
void xmlDumpElementDecl (xmlBufferPtr buf,
|
|
xmlElementPtr elem);
|
|
|
|
/* Enumeration */
|
|
xmlEnumerationPtr xmlCreateEnumeration (xmlChar *name);
|
|
void xmlFreeEnumeration (xmlEnumerationPtr cur);
|
|
xmlEnumerationPtr xmlCopyEnumeration (xmlEnumerationPtr cur);
|
|
|
|
/* Attribute */
|
|
xmlAttributePtr xmlAddAttributeDecl (xmlValidCtxtPtr ctxt,
|
|
xmlDtdPtr dtd,
|
|
const xmlChar *elem,
|
|
const xmlChar *name,
|
|
const xmlChar *ns,
|
|
xmlAttributeType type,
|
|
xmlAttributeDefault def,
|
|
const xmlChar *defaultValue,
|
|
xmlEnumerationPtr tree);
|
|
xmlAttributeTablePtr xmlCopyAttributeTable (xmlAttributeTablePtr table);
|
|
void xmlFreeAttributeTable (xmlAttributeTablePtr table);
|
|
void xmlDumpAttributeTable (xmlBufferPtr buf,
|
|
xmlAttributeTablePtr table);
|
|
void xmlDumpAttributeDecl (xmlBufferPtr buf,
|
|
xmlAttributePtr attr);
|
|
|
|
/* IDs */
|
|
xmlIDPtr xmlAddID (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
const xmlChar *value,
|
|
xmlAttrPtr attr);
|
|
void xmlFreeIDTable (xmlIDTablePtr table);
|
|
xmlAttrPtr xmlGetID (xmlDocPtr doc,
|
|
const xmlChar *ID);
|
|
int xmlIsID (xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
xmlAttrPtr attr);
|
|
int xmlRemoveID (xmlDocPtr doc, xmlAttrPtr attr);
|
|
|
|
/* IDREFs */
|
|
xmlRefPtr xmlAddRef (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
const xmlChar *value,
|
|
xmlAttrPtr attr);
|
|
void xmlFreeRefTable (xmlRefTablePtr table);
|
|
int xmlIsRef (xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
xmlAttrPtr attr);
|
|
int xmlRemoveRef (xmlDocPtr doc, xmlAttrPtr attr);
|
|
xmlListPtr xmlGetRefs (xmlDocPtr doc,
|
|
const xmlChar *ID);
|
|
|
|
/**
|
|
* The public function calls related to validity checking.
|
|
*/
|
|
|
|
int xmlValidateRoot (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc);
|
|
int xmlValidateElementDecl (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlElementPtr elem);
|
|
xmlChar * xmlValidNormalizeAttributeValue(xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
const xmlChar *name,
|
|
const xmlChar *value);
|
|
xmlChar * xmlValidCtxtNormalizeAttributeValue(xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
const xmlChar *name,
|
|
const xmlChar *value);
|
|
int xmlValidateAttributeDecl(xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlAttributePtr attr);
|
|
int xmlValidateAttributeValue(xmlAttributeType type,
|
|
const xmlChar *value);
|
|
int xmlValidateNotationDecl (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNotationPtr nota);
|
|
int xmlValidateDtd (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlDtdPtr dtd);
|
|
int xmlValidateDtdFinal (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc);
|
|
int xmlValidateDocument (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc);
|
|
int xmlValidateElement (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNodePtr elem);
|
|
int xmlValidateOneElement (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNodePtr elem);
|
|
int xmlValidateOneAttribute (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
xmlAttrPtr attr,
|
|
const xmlChar *value);
|
|
int xmlValidateOneNamespace (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
const xmlChar *prefix,
|
|
xmlNsPtr ns,
|
|
const xmlChar *value);
|
|
int xmlValidateDocumentFinal(xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc);
|
|
int xmlValidateNotationUse (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
const xmlChar *notationName);
|
|
int xmlIsMixedElement (xmlDocPtr doc,
|
|
const xmlChar *name);
|
|
xmlAttributePtr xmlGetDtdAttrDesc (xmlDtdPtr dtd,
|
|
const xmlChar *elem,
|
|
const xmlChar *name);
|
|
xmlAttributePtr xmlGetDtdQAttrDesc (xmlDtdPtr dtd,
|
|
const xmlChar *elem,
|
|
const xmlChar *name,
|
|
const xmlChar *prefix);
|
|
xmlNotationPtr xmlGetDtdNotationDesc (xmlDtdPtr dtd,
|
|
const xmlChar *name);
|
|
xmlElementPtr xmlGetDtdQElementDesc (xmlDtdPtr dtd,
|
|
const xmlChar *name,
|
|
const xmlChar *prefix);
|
|
xmlElementPtr xmlGetDtdElementDesc (xmlDtdPtr dtd,
|
|
const xmlChar *name);
|
|
|
|
int xmlValidGetValidElements(xmlNode *prev,
|
|
xmlNode *next,
|
|
const xmlChar **list,
|
|
int max);
|
|
int xmlValidGetPotentialChildren(xmlElementContent *ctree,
|
|
const xmlChar **list,
|
|
int *len,
|
|
int max);
|
|
int xmlValidateNameValue (const xmlChar *value);
|
|
int xmlValidateNamesValue (const xmlChar *value);
|
|
int xmlValidateNmtokenValue (const xmlChar *value);
|
|
int xmlValidateNmtokensValue(const xmlChar *value);
|
|
|
|
#ifdef LIBXML_REGEXP_ENABLED
|
|
/*
|
|
* Validation based on the regexp support
|
|
*/
|
|
int xmlValidBuildContentModel(xmlValidCtxtPtr ctxt,
|
|
xmlElementPtr elem);
|
|
|
|
int xmlValidatePushElement (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
const xmlChar *qname);
|
|
int xmlValidatePushCData (xmlValidCtxtPtr ctxt,
|
|
const xmlChar *data,
|
|
int len);
|
|
int xmlValidatePopElement (xmlValidCtxtPtr ctxt,
|
|
xmlDocPtr doc,
|
|
xmlNodePtr elem,
|
|
const xmlChar *qname);
|
|
#endif /* LIBXML_REGEXP_ENABLED */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* __XML_VALID_H__ */
|