Gnome XML Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# valid

## Name

valid —

## Synopsis

    void        (*xmlValidityErrorFunc)         (void *ctx,
                                                 const char *msg,
                                                 ...);
    void        (*xmlValidityWarningFunc)       (void *ctx,
                                                 const char *msg,
                                                 ...);
    #define     XML_MIN_NOTATION_TABLE
    typedef     xmlNotationTablePtr;
    #define     XML_MIN_ELEMENT_TABLE
    typedef     xmlElementTablePtr;
    #define     XML_MIN_ATTRIBUTE_TABLE
    typedef     xmlAttributeTablePtr;
    #define     XML_MIN_ID_TABLE
    typedef     xmlIDTablePtr;
    #define     XML_MIN_REF_TABLE
    typedef     xmlRefTablePtr;
    xmlNotationPtr xmlAddNotationDecl           (xmlValidCtxtPtr ctxt,
                                                 xmlDtdPtr dtd,
                                                 const xmlChar *name,
                                                 const xmlChar *PublicID,
                                                 const xmlChar *SystemID);
    xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);
    void        xmlFreeNotationTable            (xmlNotationTablePtr table);
    void        xmlDumpNotationTable            (xmlBufferPtr buf,
                                                 xmlNotationTablePtr table);
    xmlElementContentPtr xmlNewElementContent   (xmlChar *name,
                                                 xmlElementContentType type);
    xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);
    void        xmlFreeElementContent           (xmlElementContentPtr cur);
    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);
    xmlEnumerationPtr xmlCreateEnumeration      (xmlChar *name);
    void        xmlFreeEnumeration              (xmlEnumerationPtr cur);
    xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);
    xmlAttributePtr xmlAddAttributeDecl         (xmlValidCtxtPtr ctxt,
                                                 xmlDtdPtr dtd,
                                                 const xmlChar *elem,
                                                 const xmlChar *name,
                                                 xmlAttributeType type,
                                                 xmlAttributeDefault def,
                                                 const xmlChar *defaultValue,
                                                 xmlEnumerationPtr tree);
    xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);
    void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);
    void        xmlDumpAttributeTable           (xmlBufferPtr buf,
                                                 xmlAttributeTablePtr table);
    xmlIDPtr    xmlAddID                        (xmlValidCtxtPtr ctxt,
                                                 xmlDocPtr doc,
                                                 const xmlChar *value,
                                                 xmlAttrPtr attr);
    xmlIDTablePtr xmlCopyIDTable                (xmlIDTablePtr table);
    void        xmlFreeIDTable                  (xmlIDTablePtr table);
    xmlAttrPtr  xmlGetID                        (xmlDocPtr doc,
                                                 const xmlChar *ID);
    int         xmlIsID                         (xmlDocPtr doc,
                                                 xmlNodePtr elem,
                                                 xmlAttrPtr attr);
    xmlRefPtr   xmlAddRef                       (xmlValidCtxtPtr ctxt,
                                                 xmlDocPtr doc,
                                                 const xmlChar *value,
                                                 xmlAttrPtr attr);
    xmlRefTablePtr xmlCopyRefTable              (xmlRefTablePtr table);
    void        xmlFreeRefTable                 (xmlRefTablePtr table);
    int         xmlIsRef                        (xmlDocPtr doc,
                                                 xmlNodePtr elem,
                                                 xmlAttrPtr attr);
    int         xmlValidateRoot                 (xmlValidCtxtPtr ctxt,
                                                 xmlDocPtr doc);
    int         xmlValidateElementDecl          (xmlValidCtxtPtr ctxt,
                                                 xmlDocPtr doc,
                                                 xmlElementPtr elem);
    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         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         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);
    xmlNotationPtr xmlGetDtdNotationDesc        (xmlDtdPtr dtd,
                                                 const xmlChar *name);
    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);

## Description

## Details

### xmlValidityErrorFunc ()

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

`ctx` : |
`msg` : |
`...` : |

### xmlValidityWarningFunc ()

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

`ctx` : |
`msg` : |
`...` : |

### XML_MIN_NOTATION_TABLE

    #define     XML_MIN_NOTATION_TABLE

### xmlNotationTablePtr

### XML_MIN_ELEMENT_TABLE

    #define     XML_MIN_ELEMENT_TABLE

### xmlElementTablePtr

### XML_MIN_ATTRIBUTE_TABLE

    #define     XML_MIN_ATTRIBUTE_TABLE

### xmlAttributeTablePtr

### XML_MIN_ID_TABLE

    #define     XML_MIN_ID_TABLE

### xmlIDTablePtr

### XML_MIN_REF_TABLE

    #define     XML_MIN_REF_TABLE

### xmlRefTablePtr

### xmlAddNotationDecl ()

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

Register a new notation declaration

`ctxt` : |
`dtd` : |
`name` : |
`PublicID` : |
`SystemID` : |
Returns : |

### xmlCopyNotationTable ()

    xmlNotationTablePtr xmlCopyNotationTable    (xmlNotationTablePtr table);

Build a copy of a notation table.

`table` : |
Returns : |

### xmlFreeNotationTable ()

    void        xmlFreeNotationTable            (xmlNotationTablePtr table);

Deallocate the memory used by an entities hash table.

`table` : |

### xmlDumpNotationTable ()

    void        xmlDumpNotationTable            (xmlBufferPtr buf,
                                                 xmlNotationTablePtr table);

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

`buf` : |
`table` : |

### xmlNewElementContent ()

    xmlElementContentPtr xmlNewElementContent   (xmlChar *name,
                                                 xmlElementContentType type);

Allocate an element content structure.

`name` : |
`type` : |
Returns : |

### xmlCopyElementContent ()

    xmlElementContentPtr xmlCopyElementContent  (xmlElementContentPtr content);

Build a copy of an element content description.

`content` : |
Returns : |

### xmlFreeElementContent ()

    void        xmlFreeElementContent           (xmlElementContentPtr cur);

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

`cur` : |

### xmlAddElementDecl ()

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

Register a new element declaration

`ctxt` : |
`dtd` : |
`name` : |
`type` : |
`content` : |
Returns : |

### xmlCopyElementTable ()

    xmlElementTablePtr xmlCopyElementTable      (xmlElementTablePtr table);

Build a copy of an element table.

`table` : |
Returns : |

### xmlFreeElementTable ()

    void        xmlFreeElementTable             (xmlElementTablePtr table);

Deallocate the memory used by an element hash table.

`table` : |

### xmlDumpElementTable ()

    void        xmlDumpElementTable             (xmlBufferPtr buf,
                                                 xmlElementTablePtr table);

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

`buf` : |
`table` : |

### xmlCreateEnumeration ()

    xmlEnumerationPtr xmlCreateEnumeration      (xmlChar *name);

create and initialize an enumeration attribute node.

`name` : |
Returns : |

### xmlFreeEnumeration ()

    void        xmlFreeEnumeration              (xmlEnumerationPtr cur);

free an enumeration attribute node (recursive).

`cur` : |

### xmlCopyEnumeration ()

    xmlEnumerationPtr xmlCopyEnumeration        (xmlEnumerationPtr cur);

Copy an enumeration attribute node (recursive).

`cur` : |
Returns : |

### xmlAddAttributeDecl ()

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

Register a new attribute declaration

`ctxt` : |
`dtd` : |
`elem` : |
`name` : |
`type` : |
`def` : |
`defaultValue` : |
`tree` : |
Returns : |

### xmlCopyAttributeTable ()

    xmlAttributeTablePtr xmlCopyAttributeTable  (xmlAttributeTablePtr table);

Build a copy of an attribute table.

`table` : |
Returns : |

### xmlFreeAttributeTable ()

    void        xmlFreeAttributeTable           (xmlAttributeTablePtr table);

Deallocate the memory used by an entities hash table.

`table` : |

### xmlDumpAttributeTable ()

    void        xmlDumpAttributeTable           (xmlBufferPtr buf,
                                                 xmlAttributeTablePtr table);

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

`buf` : |
`table` : |

### xmlAddID ()

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

Register a new id declaration

`ctxt` : |
`doc` : |
`value` : |
`attr` : |
Returns : |

### xmlCopyIDTable ()

    xmlIDTablePtr xmlCopyIDTable                (xmlIDTablePtr table);

`table` : |
Returns : |

### xmlFreeIDTable ()

    void        xmlFreeIDTable                  (xmlIDTablePtr table);

Deallocate the memory used by an ID hash table.

`table` : |

### xmlGetID ()

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

Search the attribute declaring the given ID

`doc` : |
`ID` : |
Returns : |

### 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 simple, otherwise we use an heuristic: name ID (upper or lowercase).

`doc` : |
`elem` : |
`attr` : |
Returns : |

### xmlAddRef ()

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

Register a new ref declaration

`ctxt` : |
`doc` : |
`value` : |
`attr` : |
Returns : |

### xmlCopyRefTable ()

    xmlRefTablePtr xmlCopyRefTable              (xmlRefTablePtr table);

`table` : |
Returns : |

### xmlFreeRefTable ()

    void        xmlFreeRefTable                 (xmlRefTablePtr table);

Deallocate the memory used by an Ref hash table.

`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).

`doc` : |
`elem` : |
`attr` : |
Returns : |

### 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` : |
`doc` : |
Returns : |

### 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` : |
`doc` : |
`elem` : |
Returns : |

### 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` : |
`doc` : |
`attr` : |
Returns : |

### 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` : |
`value` : |
Returns : |

### 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 constraing exist on notation declarations But this function get called anyway ...

`ctxt` : |
`doc` : |
`nota` : |
Returns : |

### 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` : |
`doc` : |
`dtd` : |
Returns : |

### 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` : |
`doc` : |
Returns : |

### xmlValidateElement ()

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

Try to validate the subtree under an element

`ctxt` : |
`doc` : |
`elem` : |
Returns : |

### 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` : |
`doc` : |
`elem` : |
Returns : |

### 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` : |
`doc` : |
`elem` : |
`attr` : |
`value` : |
Returns : |

### 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

`ctxt` : |
`doc` : |
Returns : |

### xmlValidateNotationUse ()

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

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

`ctxt` : |
`doc` : |
`notationName` : |
Returns : |

### 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` : |
`name` : |
Returns : |

### xmlGetDtdAttrDesc ()

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

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

`dtd` : |
`elem` : |
`name` : |
Returns : |

### xmlGetDtdNotationDesc ()

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

Search the Dtd for the description of this notation

`dtd` : |
`name` : |
Returns : |

### xmlGetDtdElementDesc ()

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

Search the Dtd for the description of this element

`dtd` : |
`name` : |
Returns : |

### 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` : |
`next` : |
`list` : |
`max` : |
Returns : |

### 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` : |
`list` : |
`len` : |
`max` : |
Returns : |

<<< Previous Page | Home | Up | Next Page >>>
entities | xml-error