struct xmlValidState

struct xmlValidState;

xmlValidStatePtr

typedef xmlValidState *xmlValidStatePtr;

xmlValidityErrorFunc ()

void        (*xmlValidityErrorFunc)         (void *ctx,
                                             const char *msg,
                                             ...);

Callback called when a validity error is found. This is a message oriented function similar to an *printf function.

xmlValidityWarningFunc ()

void        (*xmlValidityWarningFunc)       (void *ctx,
                                             const char *msg,
                                             ...);

Callback called when a validity warning is found. This is a message oriented function similar to an *printf function.

struct xmlValidCtxt

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
};

xmlValidCtxtPtr

typedef xmlValidCtxt *xmlValidCtxtPtr;

xmlNotationTablePtr

typedef xmlNotationTable *xmlNotationTablePtr;

xmlElementTablePtr

typedef xmlElementTable *xmlElementTablePtr;

xmlAttributeTablePtr

typedef xmlAttributeTable *xmlAttributeTablePtr;

xmlIDTablePtr

typedef xmlIDTable *xmlIDTablePtr;

xmlRefTablePtr

typedef xmlRefTable *xmlRefTablePtr;

xmlNewValidCtxt ()

xmlValidCtxtPtr xmlNewValidCtxt             (void);

Allocate a validation context structure.

xmlFreeValidCtxt ()

void        xmlFreeValidCtxt                (xmlValidCtxtPtr);

Free a validation context structure.

xmlAddNotationDecl ()

xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
                                             xmlDtdPtr dtd,
                                             const xmlChar *name,
                                             const xmlChar *PublicID,
                                             const xmlChar *SystemID);

Register a new notation declaration

xmlCopyNotationTable ()

xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);

Build a copy of a notation table.

xmlFreeNotationTable ()

void        xmlFreeNotationTable            (xmlNotationTablePtr table);

Deallocate the memory used by an entities hash table.

xmlDumpNotationDecl ()

void        xmlDumpNotationDecl             (xmlBufferPtr buf,
                                             xmlNotationPtr nota);

This will dump the content the notation declaration as an XML DTD definition

xmlDumpNotationTable ()

void        xmlDumpNotationTable            (xmlBufferPtr buf,
                                             xmlNotationTablePtr table);

This will dump the content of the notation table as an XML DTD definition

xmlNewElementContent ()

xmlElementContentPtr xmlNewElementContent   (const xmlChar *name,
                                             xmlElementContentType type);

Allocate an element content structure.

xmlCopyElementContent ()

xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);

Build a copy of an element content description.

xmlFreeElementContent ()

void        xmlFreeElementContent           (xmlElementContentPtr cur);

Free an element content structure. This is a recursive call !

xmlSnprintfElementContent ()

void        xmlSnprintfElementContent       (char *buf,
                                             int size,
                                             xmlElementContentPtr content,
                                             int glob);

This will dump the content of the element content definition Intended just for the debug routine

xmlSprintfElementContent ()

void        xmlSprintfElementContent        (char *buf,
                                             xmlElementContentPtr content,
                                             int glob);

Deprecated, unsafe, use xmlSnprintfElementContent

xmlAddElementDecl ()

xmlElementPtr xmlAddElementDecl             (xmlValidCtxtPtr ctxt,
                                             xmlDtdPtr dtd,
                                             const xmlChar *name,
                                             xmlElementTypeVal type,
                                             xmlElementContentPtr content);

Register a new element declaration

xmlCopyElementTable ()

xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);

Build a copy of an element table.

xmlFreeElementTable ()

void        xmlFreeElementTable             (xmlElementTablePtr table);

Deallocate the memory used by an element hash table.

xmlDumpElementTable ()

void        xmlDumpElementTable             (xmlBufferPtr buf,
                                             xmlElementTablePtr table);

This will dump the content of the element table as an XML DTD definition

xmlDumpElementDecl ()

void        xmlDumpElementDecl              (xmlBufferPtr buf,
                                             xmlElementPtr elem);

This will dump the content of the element declaration as an XML DTD definition

xmlCreateEnumeration ()

xmlEnumerationPtr xmlCreateEnumeration      (const xmlChar *name);

create and initialize an enumeration attribute node.

xmlFreeEnumeration ()

void        xmlFreeEnumeration              (xmlEnumerationPtr cur);

free an enumeration attribute node (recursive).

xmlCopyEnumeration ()

xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);

Copy an enumeration attribute node (recursive).

xmlAddAttributeDecl ()

xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
                                             xmlDtdPtr dtd,
                                             const xmlChar *elem,
                                             const xmlChar *name,
                                             const xmlChar *ns,
                                             xmlAttributeType type,
                                             xmlAttributeDefault def,
                                             const xmlChar *defaultValue,
                                             xmlEnumerationPtr tree);

Register a new attribute declaration Note that tree becomes the ownership of the DTD

xmlCopyAttributeTable ()

xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);

Build a copy of an attribute table.

xmlFreeAttributeTable ()

void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);

Deallocate the memory used by an entities hash table.

xmlDumpAttributeTable ()

void        xmlDumpAttributeTable           (xmlBufferPtr buf,
                                             xmlAttributeTablePtr table);

This will dump the content of the attribute table as an XML DTD definition

xmlDumpAttributeDecl ()

void        xmlDumpAttributeDecl            (xmlBufferPtr buf,
                                             xmlAttributePtr attr);

This will dump the content of the attribute declaration as an XML DTD definition

xmlAddID ()

xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             const xmlChar *value,
                                             xmlAttrPtr attr);

Register a new id declaration

xmlFreeIDTable ()

void        xmlFreeIDTable                  (xmlIDTablePtr table);

Deallocate the memory used by an ID hash table.

xmlGetID ()

xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
                                             const xmlChar *ID);

Search the attribute declaring the given ID

xmlIsID ()

int         xmlIsID                         (xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             xmlAttrPtr attr);

Determine whether an attribute is of type ID. In case we have DTD(s) then this is done if DTD loading has been requested. In the case of HTML documents parsed with the HTML parser, then ID detection is done systematically.

xmlRemoveID ()

int         xmlRemoveID                     (xmlDocPtr doc,
                                             xmlAttrPtr attr);

Remove the given attribute from the ID table maintained internally.

xmlAddRef ()

xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             const xmlChar *value,
                                             xmlAttrPtr attr);

Register a new ref declaration

xmlFreeRefTable ()

void        xmlFreeRefTable                 (xmlRefTablePtr table);

Deallocate the memory used by an Ref hash table.

xmlIsRef ()

int         xmlIsRef                        (xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             xmlAttrPtr attr);

Determine whether an attribute is of type Ref. In case we have DTD(s) then this is simple, otherwise we use an heuristic: name Ref (upper or lowercase).

xmlRemoveRef ()

int         xmlRemoveRef                    (xmlDocPtr doc,
                                             xmlAttrPtr attr);

Remove the given attribute from the Ref table maintained internally.

xmlGetRefs ()

xmlListPtr  xmlGetRefs                      (xmlDocPtr doc,
                                             const xmlChar *ID);

Find the set of references for the supplied ID.

xmlValidateRoot ()

int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc);

Try to validate a the root element basically it does the following check as described by the XML-1.0 recommendation: - [ VC: Root Element Type ] it doesn't try to recurse or apply other check to the element

xmlValidateElementDecl ()

int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlElementPtr elem);

Try to validate a single element definition basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: One ID per Element Type ] - [ VC: No Duplicate Types ] - [ VC: Unique Element Type Declaration ]

xmlValidNormalizeAttributeValue ()

xmlChar*    xmlValidNormalizeAttributeValue (xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             const xmlChar *name,
                                             const xmlChar *value);

Does the validation related extra step of the normalization of attribute values:

If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and trailing space (x20) characters, and by replacing sequences of space (x20) characters by single space (x20) character.

xmlValidCtxtNormalizeAttributeValue ()

xmlChar*    xmlValidCtxtNormalizeAttributeValue
                                            (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             const xmlChar *name,
                                             const xmlChar *value);

Does the validation related extra step of the normalization of attribute values:

If the declared value is not CDATA, then the XML processor must further process the normalized attribute value by discarding any leading and trailing space (x20) characters, and by replacing sequences of space (x20) characters by single space (x20) character.

Also check VC: Standalone Document Declaration in P32, and update ctxt->valid accordingly

xmlValidateAttributeDecl ()

int         xmlValidateAttributeDecl        (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlAttributePtr attr);

Try to validate a single attribute definition basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Attribute Default Legal ] - [ VC: Enumeration ] - [ VC: ID Attribute Default ]

The ID/IDREF uniqueness and matching are done separately

xmlValidateAttributeValue ()

int         xmlValidateAttributeValue       (xmlAttributeType type,
                                             const xmlChar *value);

Validate that the given attribute value match the proper production

[ VC: ID ] Values of type ID must match the Name production....

[ VC: IDREF ] Values of type IDREF must match the Name production, and values of type IDREFS must match Names ...

[ VC: Entity Name ] Values of type ENTITY must match the Name production, values of type ENTITIES must match Names ...

[ VC: Name Token ] Values of type NMTOKEN must match the Nmtoken production; values of type NMTOKENS must match Nmtokens.

xmlValidateNotationDecl ()

int         xmlValidateNotationDecl         (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNotationPtr nota);

Try to validate a single notation definition basically it does the following checks as described by the XML-1.0 recommendation: - it seems that no validity constraint exists on notation declarations But this function get called anyway ...

xmlValidateDtd ()

int         xmlValidateDtd                  (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlDtdPtr dtd);

Try to validate the document against the dtd instance

basically it does check all the definitions in the DtD.

xmlValidateDtdFinal ()

int         xmlValidateDtdFinal             (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc);

Does the final step for the dtds validation once all the subsets have been parsed

basically it does the following checks described by the XML Rec - check that ENTITY and ENTITIES type attributes default or possible values matches one of the defined entities. - check that NOTATION type attributes default or possible values matches one of the defined notations.

xmlValidateDocument ()

int         xmlValidateDocument             (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc);

Try to validate the document instance

basically it does the all the checks described by the XML Rec i.e. validates the internal and external subset (if present) and validate the document tree.

xmlValidateElement ()

int         xmlValidateElement              (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNodePtr elem);

Try to validate the subtree under an element

xmlValidateOneElement ()

int         xmlValidateOneElement           (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNodePtr elem);

Try to validate a single element and it's attributes, basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Element Valid ] - [ VC: Required Attribute ] Then call xmlValidateOneAttribute() for each attribute present.

The ID/IDREF checkings are done separately

xmlValidateOneAttribute ()

int         xmlValidateOneAttribute         (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             xmlAttrPtr attr,
                                             const xmlChar *value);

Try to validate a single attribute for an element basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Attribute Value Type ] - [ VC: Fixed Attribute Default ] - [ VC: Entity Name ] - [ VC: Name Token ] - [ VC: ID ] - [ VC: IDREF ] - [ VC: Entity Name ] - [ VC: Notation Attributes ]

The ID/IDREF uniqueness and matching are done separately

xmlValidateOneNamespace ()

int         xmlValidateOneNamespace         (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             const xmlChar *prefix,
                                             xmlNsPtr ns,
                                             const xmlChar *value);

Try to validate a single namespace declaration for an element basically it does the following checks as described by the XML-1.0 recommendation: - [ VC: Attribute Value Type ] - [ VC: Fixed Attribute Default ] - [ VC: Entity Name ] - [ VC: Name Token ] - [ VC: ID ] - [ VC: IDREF ] - [ VC: Entity Name ] - [ VC: Notation Attributes ]

The ID/IDREF uniqueness and matching are done separately

xmlValidateDocumentFinal ()

int         xmlValidateDocumentFinal        (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc);

Does the final step for the document validation once all the incremental validation steps have been completed

basically it does the following checks described by the XML Rec

Check all the IDREF/IDREFS attributes definition for validity

xmlValidateNotationUse ()

int         xmlValidateNotationUse          (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             const xmlChar *notationName);

Validate that the given name match a notation declaration. - [ VC: Notation Declared ]

xmlIsMixedElement ()

int         xmlIsMixedElement               (xmlDocPtr doc,
                                             const xmlChar *name);

Search in the DtDs whether an element accept Mixed content (or ANY) basically if it is supposed to accept text childs

xmlGetDtdAttrDesc ()

xmlAttributePtr xmlGetDtdAttrDesc           (xmlDtdPtr dtd,
                                             const xmlChar *elem,
                                             const xmlChar *name);

Search the DTD for the description of this attribute on this element.

xmlGetDtdQAttrDesc ()

xmlAttributePtr xmlGetDtdQAttrDesc          (xmlDtdPtr dtd,
                                             const xmlChar *elem,
                                             const xmlChar *name,
                                             const xmlChar *prefix);

Search the DTD for the description of this qualified attribute on this element.

xmlGetDtdNotationDesc ()

xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
                                             const xmlChar *name);

Search the DTD for the description of this notation

xmlGetDtdQElementDesc ()

xmlElementPtr xmlGetDtdQElementDesc         (xmlDtdPtr dtd,
                                             const xmlChar *name,
                                             const xmlChar *prefix);

Search the DTD for the description of this element

xmlGetDtdElementDesc ()

xmlElementPtr xmlGetDtdElementDesc          (xmlDtdPtr dtd,
                                             const xmlChar *name);

Search the DTD for the description of this element

xmlValidGetValidElements ()

int         xmlValidGetValidElements        (xmlNode *prev,
                                             xmlNode *next,
                                             const xmlChar **list,
                                             int max);

This function returns the list of authorized children to insert within an existing tree while respecting the validity constraints forced by the Dtd. The insertion point is defined using prev and next in the following ways: to insert before 'node': xmlValidGetValidElements(node->prev, node, ... to insert next 'node': xmlValidGetValidElements(node, node->next, ... to replace 'node': xmlValidGetValidElements(node->prev, node->next, ... to prepend a child to 'node': xmlValidGetValidElements(NULL, node->childs, to append a child to 'node': xmlValidGetValidElements(node->last, NULL, ...

pointers to the element names are inserted at the beginning of the array and do not need to be freed.

xmlValidGetPotentialChildren ()

int         xmlValidGetPotentialChildren    (xmlElementContent *ctree,
                                             const xmlChar **list,
                                             int *len,
                                             int max);

Build/extend a list of potential children allowed by the content tree

xmlValidateNameValue ()

int         xmlValidateNameValue            (const xmlChar *value);

Validate that the given value match Name production

xmlValidateNamesValue ()

int         xmlValidateNamesValue           (const xmlChar *value);

Validate that the given value match Names production

xmlValidateNmtokenValue ()

int         xmlValidateNmtokenValue         (const xmlChar *value);

Validate that the given value match Nmtoken production

[ VC: Name Token ]

xmlValidateNmtokensValue ()

int         xmlValidateNmtokensValue        (const xmlChar *value);

Validate that the given value match Nmtokens production

[ VC: Name Token ]

xmlValidBuildContentModel ()

int         xmlValidBuildContentModel       (xmlValidCtxtPtr ctxt,
                                             xmlElementPtr elem);

(Re)Build the automata associated to the content model of this element

xmlValidatePushElement ()

int         xmlValidatePushElement          (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             const xmlChar *qname);

Push a new element start on the validation stack.

xmlValidatePushCData ()

int         xmlValidatePushCData            (xmlValidCtxtPtr ctxt,
                                             const xmlChar *data,
                                             int len);

check the CData parsed for validation in the current stack

xmlValidatePopElement ()

int         xmlValidatePopElement           (xmlValidCtxtPtr ctxt,
                                             xmlDocPtr doc,
                                             xmlNodePtr elem,
                                             const xmlChar *qname);

Pop the element end from the validation stack.