Module valid from libxml2

Module valid from libxml2

API Menu

API Indexes

Related links

API for the DTD handling and the validity checking

Structure xmlAttributeTable
struct _xmlHashTable
The content of this structure is not made public by the API.

Typedef xmlAttributeTable * xmlAttributeTablePtr

Structure xmlElementTable
struct _xmlHashTable
The content of this structure is not made public by the API.

Typedef xmlElementTable * xmlElementTablePtr

Structure xmlIDTable
struct _xmlHashTable
The content of this structure is not made public by the API.

Typedef xmlIDTable * xmlIDTablePtr

Structure xmlNotationTable
struct _xmlHashTable
The content of this structure is not made public by the API.

Typedef xmlNotationTable * xmlNotationTablePtr

Structure xmlRefTable
struct _xmlHashTable
The content of this structure is not made public by the API.

Typedef xmlRefTable * xmlRefTablePtr

Structure xmlValidCtxt
struct _xmlValidCtxt

Typedef xmlValidCtxt * xmlValidCtxtPtr

Structure xmlValidState
struct _xmlValidState
The content of this structure is not made public by the API.

Typedef xmlValidState * xmlValidStatePtr

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

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

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

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

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

xmlAttributeTablePtr	xmlCopyAttributeTable	(xmlAttributeTablePtr table)

xmlElementContentPtr	xmlCopyElementContent	(xmlElementContentPtr cur)

xmlElementTablePtr	xmlCopyElementTable	(xmlElementTablePtr table)

xmlEnumerationPtr	xmlCopyEnumeration	(xmlEnumerationPtr cur)

xmlNotationTablePtr	xmlCopyNotationTable	(xmlNotationTablePtr table)

xmlEnumerationPtr	xmlCreateEnumeration	(const xmlChar * name)

void	xmlDumpAttributeDecl		(xmlBufferPtr buf, 
					 xmlAttributePtr attr)

void	xmlDumpAttributeTable		(xmlBufferPtr buf, 
					 xmlAttributeTablePtr table)

void	xmlDumpElementDecl		(xmlBufferPtr buf, 
					 xmlElementPtr elem)

void	xmlDumpElementTable		(xmlBufferPtr buf, 
					 xmlElementTablePtr table)

void	xmlDumpNotationDecl		(xmlBufferPtr buf, 
					 xmlNotationPtr nota)

void	xmlDumpNotationTable		(xmlBufferPtr buf, 
					 xmlNotationTablePtr table)

void	xmlFreeAttributeTable		(xmlAttributeTablePtr table)

void	xmlFreeElementContent		(xmlElementContentPtr cur)

void	xmlFreeElementTable		(xmlElementTablePtr table)

void	xmlFreeEnumeration		(xmlEnumerationPtr cur)

void	xmlFreeIDTable			(xmlIDTablePtr table)

void	xmlFreeNotationTable		(xmlNotationTablePtr table)

void	xmlFreeRefTable			(xmlRefTablePtr table)

void	xmlFreeValidCtxt		(xmlValidCtxtPtr cur)

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

xmlElementPtr	xmlGetDtdElementDesc	(xmlDtdPtr dtd, 
					 const xmlChar * name)

xmlNotationPtr	xmlGetDtdNotationDesc	(xmlDtdPtr dtd, 
					 const xmlChar * name)

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

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

xmlAttrPtr	xmlGetID		(xmlDocPtr doc, 
					 const xmlChar * ID)

xmlListPtr	xmlGetRefs		(xmlDocPtr doc, 
					 const xmlChar * ID)

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

int	xmlIsMixedElement		(xmlDocPtr doc, 
					 const xmlChar * name)

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

xmlElementContentPtr	xmlNewElementContent	(const xmlChar * name, 
						 xmlElementContentType type)

xmlValidCtxtPtr	xmlNewValidCtxt		(void)

int	xmlRemoveID			(xmlDocPtr doc, 
					 xmlAttrPtr attr)

int	xmlRemoveRef			(xmlDocPtr doc, 
					 xmlAttrPtr attr)

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

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

int	xmlValidBuildContentModel	(xmlValidCtxtPtr ctxt, 
					 xmlElementPtr elem)

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

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

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

xmlChar *	xmlValidNormalizeAttributeValue	(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	xmlValidateDocument		(xmlValidCtxtPtr ctxt, 
					 xmlDocPtr doc)

int	xmlValidateDocumentFinal	(xmlValidCtxtPtr ctxt, 
					 xmlDocPtr doc)

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

int	xmlValidateDtdFinal		(xmlValidCtxtPtr ctxt, 
					 xmlDocPtr doc)

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

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

int	xmlValidateNameValue		(const xmlChar * value)

int	xmlValidateNamesValue		(const xmlChar * value)

int	xmlValidateNmtokenValue		(const xmlChar * value)

int	xmlValidateNmtokensValue	(const xmlChar * value)

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

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

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

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

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

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

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

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

int	xmlValidateRoot			(xmlValidCtxtPtr ctxt, 
					 xmlDocPtr doc)

Function type: xmlValidityErrorFunc
void	xmlValidityErrorFunc		(void * ctx, 
					 const char * msg, 
					 ... ...)

Function type: xmlValidityWarningFunc
void	xmlValidityWarningFunc		(void * ctx, 
					 const char * msg, 
					 ... ...)

Description

Structure xmlElementTable

Structure xmlElementTable
struct _xmlHashTable {
The content of this structure is not made public by the API.
}

Structure xmlAttributeTable

Structure xmlAttributeTable
struct _xmlHashTable {
The content of this structure is not made public by the API.
}

Structure xmlNotationTable

Structure xmlNotationTable
struct _xmlHashTable {
The content of this structure is not made public by the API.
}

Structure xmlRefTable

Structure xmlRefTable
struct _xmlHashTable {
The content of this structure is not made public by the API.
}

Structure xmlValidState

Structure xmlValidState
struct _xmlValidState {
The content of this structure is not made public by the API.
}

Structure xmlValidCtxt

Structure 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 an
    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 s
    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
    xmlAutomataPtr	am	: the automata
    xmlAutomataStatePtr	state	: used to build the automata
    void *	am
    void *	state
}

Structure xmlIDTable

Structure xmlIDTable
struct _xmlHashTable {
The content of this structure is not made public by the API.
}

Function: xmlFreeNotationTable

void	xmlFreeNotationTable		(xmlNotationTablePtr table)

Deallocate the memory used by an entities hash table.

table: An notation table

Function: xmlValidateNameValue

int	xmlValidateNameValue		(const xmlChar * value)

Validate that the given value match Name production

`value`:	an Name value
`Returns`:	1 if valid or 0 otherwise

Function: xmlValidateElement

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

Try to validate the subtree under an element

`ctxt`:	the validation context
`doc`:	a document instance
`elem`:	an element instance
`Returns`:	1 if valid or 0 otherwise

Function: xmlAddRef

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

`ctxt`:	the validation context
`doc`:	pointer to the document
`value`:	the value name
`attr`:	the attribute holding the Ref
`Returns`:	NULL if not, otherwise the new xmlRefPtr

Function: xmlDumpAttributeDecl

void	xmlDumpAttributeDecl		(xmlBufferPtr buf, 
					 xmlAttributePtr attr)

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

`buf`:	the XML buffer output
`attr`:	An attribute declaration

Function: 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

`ctxt`:	the validation context
`doc`:	a document instance
`Returns`:	1 if valid or 0 otherwise

Function: 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.

`ctxt`:	the validation context
`doc`:	a document instance
`Returns`:	1 if valid or 0 if invalid and -1 if not well-formed

Function: xmlDumpAttributeTable

void	xmlDumpAttributeTable		(xmlBufferPtr buf, 
					 xmlAttributeTablePtr table)

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

`buf`:	the XML buffer output
`table`:	An attribute table

Function: xmlCreateEnumeration

xmlEnumerationPtr	xmlCreateEnumeration	(const xmlChar * name)

create and initialize an enumeration attribute node.

`name`:	the enumeration name or NULL
`Returns`:	the xmlEnumerationPtr just created or NULL in case of error.

Function: 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

`ctxt`:	the validation context
`doc`:	a document instance
`elem`:	an element instance
`attr`:	an attribute instance
`value`:	the attribute value (without entities processing)
`Returns`:	1 if valid or 0 otherwise

Function: 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.

`prev`:	an element to insert after
`next`:	an element to insert next
`list`:	an array to store the list of child names
`max`:	the size of the array
`Returns`:	the number of element in the list, or -1 in case of error. If the function returns the value @max the caller is invited to grow the receiving array and retry.

Function: xmlDumpNotationTable

void	xmlDumpNotationTable		(xmlBufferPtr buf, 
					 xmlNotationTablePtr table)

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

`buf`:	the XML buffer output
`table`:	A notation table

Function: xmlFreeAttributeTable

void	xmlFreeAttributeTable		(xmlAttributeTablePtr table)

Deallocate the memory used by an entities hash table.

table: An attribute table

Function: 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.

`doc`:	the document
`elem`:	the element carrying the attribute
`attr`:	the attribute
`Returns`:	0 or 1 depending on the lookup result

Function: 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.

`dtd`:	a pointer to the DtD to search
`elem`:	the element name
`name`:	the attribute name
`prefix`:	the attribute namespace prefix
`Returns`:	the xmlAttributePtr if found or NULL

Function: xmlDumpNotationDecl

void	xmlDumpNotationDecl		(xmlBufferPtr buf, 
					 xmlNotationPtr nota)

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

`buf`:	the XML buffer output
`nota`:	A notation declaration

Function type: xmlValidityErrorFunc

Function type: 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.

`ctx`:	an xmlValidCtxtPtr validity error context
`msg`:	the string to format *printf like vararg
`...`:	remaining arguments to the format

Function: xmlGetDtdQElementDesc

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

Search the DTD for the description of this element

`dtd`:	a pointer to the DtD to search
`name`:	the element name
`prefix`:	the element namespace prefix
`Returns`:	the xmlElementPtr if found or NULL

Function: xmlGetRefs

xmlListPtr	xmlGetRefs		(xmlDocPtr doc, 
					 const xmlChar * ID)

Find the set of references for the supplied ID.

`doc`:	pointer to the document
`ID`:	the ID value
`Returns`:	NULL if not found, otherwise node set for the ID.

Function: xmlCopyNotationTable

xmlNotationTablePtr	xmlCopyNotationTable	(xmlNotationTablePtr table)

Build a copy of a notation table.

`table`:	A notation table
`Returns`:	the new xmlNotationTablePtr or NULL in case of error.

Function: 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.

`ctxt`:	the validation context
`doc`:	a document instance
`Returns`:	1 if valid or 0 otherwise

Function: xmlValidGetPotentialChildren

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

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

`ctree`:	an element content tree
`list`:	an array to store the list of child names
`len`:	a pointer to the number of element in the list
`max`:	the size of the array
`Returns`:	the number of element in the list, or -1 in case of error.

Function: xmlAddNotationDecl

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

`ctxt`:	the validation context
`dtd`:	pointer to the DTD
`name`:	the entity name
`PublicID`:	the public identifier or NULL
`SystemID`:	the system identifier or NULL
`Returns`:	NULL if not, otherwise the entity

Function: 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 ]

`ctxt`:	the validation context
`doc`:	a document instance
`elem`:	an element definition
`Returns`:	1 if valid or 0 otherwise

Function: 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)

`ctxt`:	the validation context
`dtd`:	pointer to the DTD
`elem`:	the element name
`name`:	the attribute name
`ns`:	the attribute namespace prefix
`type`:	the attribute type
`def`:	the attribute default type
`defaultValue`:	the attribute default value
`tree`:	if it's an enumeration, the associated list
`Returns`:	NULL if not new, otherwise the attribute decl

Function: xmlGetID

xmlAttrPtr	xmlGetID		(xmlDocPtr doc, 
					 const xmlChar * ID)

Search the attribute declaring the given ID

`doc`:	pointer to the document
`ID`:	the ID value
`Returns`:	NULL if not found, otherwise the xmlAttrPtr defining the ID

Function: xmlAddID

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

`ctxt`:	the validation context
`doc`:	pointer to the document
`value`:	the value name
`attr`:	the attribute holding the ID
`Returns`:	NULL if not, otherwise the new xmlIDPtr

Function: 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

`ctxt`:	the validation context
`doc`:	a document instance
`attr`:	an attribute definition
`Returns`:	1 if valid or 0 otherwise

Function: xmlSprintfElementContent

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

Deprecated, unsafe, use xmlSnprintfElementContent

`buf`:	an output buffer
`content`:	An element table
`glob`:	1 if one must print the englobing parenthesis, 0 otherwise

Function: 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

`ctxt`:	the validation context
`doc`:	a document instance
`elem`:	an element instance
`Returns`:	1 if valid or 0 otherwise

Function: xmlValidateNmtokenValue

int	xmlValidateNmtokenValue		(const xmlChar * value)

Validate that the given value match Nmtoken production [ VC: Name Token ]

`value`:	an Nmtoken value
`Returns`:	1 if valid or 0 otherwise

Function: xmlRemoveRef

int	xmlRemoveRef			(xmlDocPtr doc, 
					 xmlAttrPtr attr)

Remove the given attribute from the Ref table maintained internally.

`doc`:	the document
`attr`:	the attribute
`Returns`:	-1 if the lookup failed and 0 otherwise

Function: xmlValidateNmtokensValue

int	xmlValidateNmtokensValue	(const xmlChar * value)

Validate that the given value match Nmtokens production [ VC: Name Token ]

`value`:	an Nmtokens value
`Returns`:	1 if valid or 0 otherwise

Function: xmlAddElementDecl

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

`ctxt`:	the validation context
`dtd`:	pointer to the DTD
`name`:	the entity name
`type`:	the element type
`content`:	the element content tree or NULL
`Returns`:	NULL if not, otherwise the entity

Function: 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

`buf`:	an output buffer
`size`:	the buffer size
`content`:	An element table
`glob`:	1 if one must print the englobing parenthesis, 0 otherwise

Function: 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

`ctxt`:	the validation context
`doc`:	a document instance
`elem`:	an element instance
`prefix`:	the namespace prefix
`ns`:	an namespace declaration instance
`value`:	the attribute value (without entities processing)
`Returns`:	1 if valid or 0 otherwise

Function: xmlValidatePushElement

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

Push a new element start on the validation stack.

`ctxt`:	the validation context
`doc`:	a document instance
`elem`:	an element instance
`qname`:	the qualified name as appearing in the serialization
`Returns`:	1 if no validation problem was found or 0 otherwise

Function: 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).

`doc`:	the document
`elem`:	the element carrying the attribute
`attr`:	the attribute
`Returns`:	0 or 1 depending on the lookup result

Function: xmlDumpElementTable

void	xmlDumpElementTable		(xmlBufferPtr buf, 
					 xmlElementTablePtr table)

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

`buf`:	the XML buffer output
`table`:	An element table

Function: xmlCopyElementTable

xmlElementTablePtr	xmlCopyElementTable	(xmlElementTablePtr table)

Build a copy of an element table.

`table`:	An element table
`Returns`:	the new xmlElementTablePtr or NULL in case of error.

Function: xmlFreeRefTable

void	xmlFreeRefTable			(xmlRefTablePtr table)

Deallocate the memory used by an Ref hash table.

table: An ref table

Function: xmlFreeElementContent

void	xmlFreeElementContent		(xmlElementContentPtr cur)

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

cur: the element content tree to free

Function: xmlRemoveID

int	xmlRemoveID			(xmlDocPtr doc, 
					 xmlAttrPtr attr)

Remove the given attribute from the ID table maintained internally.

`doc`:	the document
`attr`:	the attribute
`Returns`:	-1 if the lookup failed and 0 otherwise

Function: xmlFreeElementTable

void	xmlFreeElementTable		(xmlElementTablePtr table)

Deallocate the memory used by an element hash table.

table: An element table

Function: xmlFreeIDTable

void	xmlFreeIDTable			(xmlIDTablePtr table)

Deallocate the memory used by an ID hash table.

table: An id table

Function: xmlFreeValidCtxt

void	xmlFreeValidCtxt		(xmlValidCtxtPtr cur)

Free a validation context structure.

cur: the validation context to free

Function: xmlCopyAttributeTable

xmlAttributeTablePtr	xmlCopyAttributeTable	(xmlAttributeTablePtr table)

Build a copy of an attribute table.

`table`:	An attribute table
`Returns`:	the new xmlAttributeTablePtr or NULL in case of error.

Function: xmlCopyElementContent

xmlElementContentPtr	xmlCopyElementContent	(xmlElementContentPtr cur)

Build a copy of an element content description.

`cur`:	An element content pointer.
`Returns`:	the new xmlElementContentPtr or NULL in case of error.

Function: 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.

`type`:	an attribute type
`value`:	an attribute value
`Returns`:	1 if valid or 0 otherwise

Function: 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

`ctxt`:	the validation context or NULL
`doc`:	the document
`elem`:	the parent
`name`:	the attribute name
`value`:	the attribute value
`Returns`:	a new normalized string if normalization is needed, NULL otherwise the caller must free the returned value.

Function type: xmlValidityWarningFunc

Function type: 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.

`ctx`:	an xmlValidCtxtPtr validity error context
`msg`:	the string to format *printf like vararg
`...`:	remaining arguments to the format

Function: xmlValidatePopElement

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

Pop the element end from the validation stack.

`ctxt`:	the validation context
`doc`:	a document instance
`elem`:	an element instance
`qname`:	the qualified name as appearing in the serialization
`Returns`:	1 if no validation problem was found or 0 otherwise

Function: xmlFreeEnumeration

void	xmlFreeEnumeration		(xmlEnumerationPtr cur)

free an enumeration attribute node (recursive).

cur: the tree to free.

Function: xmlValidateNamesValue

int	xmlValidateNamesValue		(const xmlChar * value)

Validate that the given value match Names production

`value`:	an Names value
`Returns`:	1 if valid or 0 otherwise

Function: xmlCopyEnumeration

xmlEnumerationPtr	xmlCopyEnumeration	(xmlEnumerationPtr cur)

Copy an enumeration attribute node (recursive).

`cur`:	the tree to copy.
`Returns`:	the xmlEnumerationPtr just created or NULL in case of error.

Function: xmlGetDtdAttrDesc

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

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

`dtd`:	a pointer to the DtD to search
`elem`:	the element name
`name`:	the attribute name
`Returns`:	the xmlAttributePtr if found or NULL

Function: 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.

`ctxt`:	the validation context
`doc`:	a document instance
`dtd`:	a dtd instance
`Returns`:	1 if valid or 0 otherwise

Function: xmlNewValidCtxt

xmlValidCtxtPtr	xmlNewValidCtxt		(void)

Allocate a validation context structure.

Returns: NULL if not, otherwise the new validation context structure

Function: 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

`doc`:	the document
`name`:	the element name
`Returns`:	0 if no, 1 if yes, and -1 if no element description is available

Function: xmlDumpElementDecl

void	xmlDumpElementDecl		(xmlBufferPtr buf, 
					 xmlElementPtr elem)

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

`buf`:	the XML buffer output
`elem`:	An element table

Function: xmlValidNormalizeAttributeValue

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

`doc`:	the document
`elem`:	the parent
`name`:	the attribute name
`value`:	the attribute value
`Returns`:	a new normalized string if normalization is needed, NULL otherwise the caller must free the returned value.

Function: xmlValidBuildContentModel

int	xmlValidBuildContentModel	(xmlValidCtxtPtr ctxt, 
					 xmlElementPtr elem)

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

`ctxt`:	a validation context
`elem`:	an element declaration node
`Returns`:	1 in case of success, 0 in case of error

Function: xmlValidateNotationUse

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

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

`ctxt`:	the validation context
`doc`:	the document
`notationName`:	the notation name to check
`Returns`:	1 if valid or 0 otherwise

Function: 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

`ctxt`:	the validation context
`doc`:	a document instance
`Returns`:	1 if valid or 0 otherwise

Function: 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 ...

`ctxt`:	the validation context
`doc`:	a document instance
`nota`:	a notation definition
`Returns`:	1 if valid or 0 otherwise

Function: xmlNewElementContent

xmlElementContentPtr	xmlNewElementContent	(const xmlChar * name, 
						 xmlElementContentType type)

Allocate an element content structure.

`name`:	the subelement name or NULL
`type`:	the type of element content decl
`Returns`:	NULL if not, otherwise the new element content structure

Function: xmlGetDtdElementDesc

xmlElementPtr	xmlGetDtdElementDesc	(xmlDtdPtr dtd, 
					 const xmlChar * name)

Search the DTD for the description of this element

`dtd`:	a pointer to the DtD to search
`name`:	the element name
`Returns`:	the xmlElementPtr if found or NULL

Function: xmlGetDtdNotationDesc

xmlNotationPtr	xmlGetDtdNotationDesc	(xmlDtdPtr dtd, 
					 const xmlChar * name)

Search the DTD for the description of this notation

`dtd`:	a pointer to the DtD to search
`name`:	the notation name
`Returns`:	the xmlNotationPtr if found or NULL

Function: xmlValidatePushCData

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

check the CData parsed for validation in the current stack

`ctxt`:	the validation context
`data`:	some character data read
`len`:	the lenght of the data
`Returns`:	1 if no validation problem was found or 0 otherwise

Daniel Veillard

Module valid from libxml2

Table of Contents

Description

Structure xmlElementTable

Structure xmlAttributeTable

Structure xmlNotationTable

Structure xmlRefTable

Structure xmlValidState

Structure xmlValidCtxt

Structure xmlIDTable

Function: xmlFreeNotationTable

Function: xmlValidateNameValue

Function: xmlValidateElement

Function: xmlAddRef

Function: xmlDumpAttributeDecl

Function: xmlValidateDocumentFinal

Function: xmlValidateDtdFinal

Function: xmlDumpAttributeTable

Function: xmlCreateEnumeration

Function: xmlValidateOneAttribute

Function: xmlValidGetValidElements

Function: xmlDumpNotationTable

Function: xmlFreeAttributeTable

Function: xmlIsID

Function: xmlGetDtdQAttrDesc

Function: xmlDumpNotationDecl

Function type: xmlValidityErrorFunc

Function: xmlGetDtdQElementDesc

Function: xmlGetRefs

Function: xmlCopyNotationTable

Function: xmlValidateDocument

Function: xmlValidGetPotentialChildren

Function: xmlAddNotationDecl

Function: xmlValidateElementDecl

Function: xmlAddAttributeDecl

Function: xmlGetID

Function: xmlAddID

Function: xmlValidateAttributeDecl

Function: xmlSprintfElementContent

Function: xmlValidateOneElement

Function: xmlValidateNmtokenValue

Function: xmlRemoveRef

Function: xmlValidateNmtokensValue

Function: xmlAddElementDecl

Function: xmlSnprintfElementContent

Function: xmlValidateOneNamespace

Function: xmlValidatePushElement

Function: xmlIsRef

Function: xmlDumpElementTable

Function: xmlCopyElementTable

Function: xmlFreeRefTable

Function: xmlFreeElementContent

Function: xmlRemoveID

Function: xmlFreeElementTable

Function: xmlFreeIDTable

Function: xmlFreeValidCtxt

Function: xmlCopyAttributeTable

Function: xmlCopyElementContent

Function: xmlValidateAttributeValue

Function: xmlValidCtxtNormalizeAttributeValue

Function type: xmlValidityWarningFunc

Function: xmlValidatePopElement

Function: xmlFreeEnumeration

Function: xmlValidateNamesValue

Function: xmlCopyEnumeration

Function: xmlGetDtdAttrDesc

Function: xmlValidateDtd

Function: xmlNewValidCtxt

Function: xmlIsMixedElement

Function: xmlDumpElementDecl

Function: xmlValidNormalizeAttributeValue

Function: xmlValidBuildContentModel

Function: xmlValidateNotationUse

Function: xmlValidateRoot

Function: xmlValidateNotationDecl

Function: xmlNewElementContent

Function: xmlGetDtdElementDesc

Function: xmlGetDtdNotationDesc

Function: xmlValidatePushCData