Referencia del Archivo src/libdigidoc/libxml2/valid.c

#include "libxml.h"
#include <string.h>
#include <libxml/xmlmemory.h>
#include <libxml/hash.h>
#include <libxml/uri.h>
#include <libxml/valid.h>
#include <libxml/parser.h>
#include <libxml/parserInternals.h>
#include <libxml/xmlerror.h>
#include <libxml/list.h>
#include <libxml/globals.h>
#include "elfgcchack.h"

Clases
struct	xmlRemoveMemo_t
struct	xmlValidateMemo_t
'defines'
#define	IN_LIBXML
#define	TODO
Funciones
: the subelement name or NULL
xmlNewElementContent: : the type of element content decl Allocate an element content structure. Deprecated in favor of xmlNewDocElementContent Returns NULL if not, otherwise the new element content structure
xmlElementContentPtr	xmlNewDocElementContent (xmlDocPtr doc, const xmlChar *name, xmlElementContentType type)
xmlElementContentPtr	xmlNewElementContent (const xmlChar *name, xmlElementContentType type)
xmlElementContentPtr	xmlCopyDocElementContent (xmlDocPtr doc, xmlElementContentPtr cur)
xmlElementContentPtr	xmlCopyElementContent (xmlElementContentPtr cur)
void	xmlFreeDocElementContent (xmlDocPtr doc, xmlElementContentPtr cur)
void	xmlFreeElementContent (xmlElementContentPtr cur)
void	xmlSnprintfElementContent (char *buf, int size, xmlElementContentPtr content, int englob)
: the enumeration name or NULL
xmlCreateEnumeration: create and initialize an enumeration attribute node. Returns the xmlEnumerationPtr just created or NULL in case of error.
xmlEnumerationPtr	xmlCreateEnumeration (const xmlChar *name)
void	xmlFreeEnumeration (xmlEnumerationPtr cur)
: the attribute name
xmlGetDtdQAttrDesc: : a pointer to the DtD to search : the element name : the attribute namespace prefix Search the DTD for the description of this qualified attribute on this element. returns the xmlAttributePtr if found or NULL
xmlAttributePtr	xmlAddAttributeDecl (xmlValidCtxtPtr ctxt, xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name, const xmlChar *ns, xmlAttributeType type, xmlAttributeDefault def, const xmlChar *defaultValue, xmlEnumerationPtr tree)
void	xmlFreeAttributeTable (xmlAttributeTablePtr table)
xmlAttributePtr	xmlGetDtdAttrDesc (xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name)
xmlAttributePtr	xmlGetDtdQAttrDesc (xmlDtdPtr dtd, const xmlChar *elem, const xmlChar *name, const xmlChar *prefix)
: the notation name
xmlGetDtdNotationDesc: : a pointer to the DtD to search Search the DTD for the description of this notation returns the xmlNotationPtr if found or NULL
xmlNotationPtr	xmlGetDtdNotationDesc (xmlDtdPtr dtd, const xmlChar *name)
: the entity name
xmlAddNotationDecl: : pointer to the DTD : the validation context : the public identifier or NULL : the system identifier or NULL Register a new notation declaration Returns NULL if not, otherwise the entity
#define	DICT_FREE(str)
typedef struct xmlRemoveMemo_t	xmlRemoveMemo
typedef xmlRemoveMemo *	xmlRemoveMemoPtr
typedef struct xmlValidateMemo_t	xmlValidateMemo
typedef xmlValidateMemo *	xmlValidateMemoPtr
xmlElementPtr	xmlAddElementDecl (xmlValidCtxtPtr ctxt, xmlDtdPtr dtd, const xmlChar *name, xmlElementTypeVal type, xmlElementContentPtr content)
void	xmlFreeElementTable (xmlElementTablePtr table)
xmlNotationPtr	xmlAddNotationDecl (xmlValidCtxtPtr ctxt, xmlDtdPtr dtd, const xmlChar *name, const xmlChar *PublicID, const xmlChar *SystemID)
void	xmlFreeNotationTable (xmlNotationTablePtr table)
xmlIDPtr	xmlAddID (xmlValidCtxtPtr ctxt, xmlDocPtr doc, const xmlChar *value, xmlAttrPtr attr)
void	xmlFreeIDTable (xmlIDTablePtr table)
int	xmlIsID (xmlDocPtr doc, xmlNodePtr elem, xmlAttrPtr attr)
int	xmlRemoveID (xmlDocPtr doc, xmlAttrPtr attr)
xmlAttrPtr	xmlGetID (xmlDocPtr doc, const xmlChar *ID)
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 element name
xmlIsMixedElement: : the document Search in the DtDs whether an element accept Mixed content (or ANY) basically if it is supposed to accept text childs returns 0 if no, 1 if yes, and -1 if no element description is available
#define	bottom_valid
xmlElementPtr	xmlGetDtdElementDesc (xmlDtdPtr dtd, const xmlChar *name)
xmlElementPtr	xmlGetDtdQElementDesc (xmlDtdPtr dtd, const xmlChar *name, const xmlChar *prefix)
int	xmlIsMixedElement (xmlDocPtr doc, const xmlChar *name)

---

Documentación de los 'defines'

#define bottom_valid

#define DICT_FREE

(

str

)

Valor:

if ((str) && ((!dict) ||                                \
            (xmlDictOwns(dict, (const xmlChar *)(str)) == 0)))  \
            xmlFree((char *)(str));

DICT_FREE: : a string

Free a string if it is not owned by the "dict" dictionnary in the current scope

#define IN_LIBXML

#define TODO

Valor:

xmlGenericError(xmlGenericErrorContext,                         \
            "Unimplemented block at %s:%d\n",                           \
            __FILE__, __LINE__);

---

Documentación de los 'typedefs'

typedef struct xmlRemoveMemo_t xmlRemoveMemo

typedef xmlRemoveMemo* xmlRemoveMemoPtr

typedef struct xmlValidateMemo_t xmlValidateMemo

typedef xmlValidateMemo* xmlValidateMemoPtr

---

Documentación de las funciones

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
	)

xmlAddID: : the validation context : pointer to the document : the value name : the attribute holding the ID

Register a new id declaration

Returns NULL if not, otherwise the new xmlIDPtr

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
	)

xmlAddRef: : the validation context : pointer to the document : the value name : the attribute holding the Ref

Register a new ref declaration

Returns NULL if not, otherwise the new xmlRefPtr

xmlElementContentPtr xmlCopyDocElementContent	(	xmlDocPtr	doc,
		xmlElementContentPtr	cur
	)

xmlCopyDocElementContent: : the document owning the element declaration : An element content pointer.

Build a copy of an element content description.

Returns the new xmlElementContentPtr or NULL in case of error.

xmlElementContentPtr xmlCopyElementContent

(

xmlElementContentPtr

cur

)

xmlCopyElementContent: : An element content pointer.

Build a copy of an element content description. Deprecated, use xmlCopyDocElementContent instead

Returns the new xmlElementContentPtr or NULL in case of error.

xmlEnumerationPtr xmlCreateEnumeration

(

const xmlChar *

name

)

void xmlFreeAttributeTable

(

xmlAttributeTablePtr

table

)

xmlFreeAttributeTable: : An attribute table

Deallocate the memory used by an entities hash table.

void xmlFreeDocElementContent	(	xmlDocPtr	doc,
		xmlElementContentPtr	cur
	)

xmlFreeDocElementContent: : the document owning the element declaration : the element content tree to free

Free an element content structure. The whole subtree is removed.

void xmlFreeElementContent

(

xmlElementContentPtr

cur

)

xmlFreeElementContent: : the element content tree to free

Free an element content structure. The whole subtree is removed. Deprecated, use xmlFreeDocElementContent instead

void xmlFreeElementTable

(

xmlElementTablePtr

table

)

xmlFreeElementTable: : An element table

Deallocate the memory used by an element hash table.

void xmlFreeEnumeration

(

xmlEnumerationPtr

cur

)

xmlFreeEnumeration: : the tree to free.

free an enumeration attribute node (recursive).

void xmlFreeIDTable

(

xmlIDTablePtr

table

)

xmlFreeIDTable: : An id table

Deallocate the memory used by an ID hash table.

void xmlFreeNotationTable

(

xmlNotationTablePtr

table

)

xmlFreeNotationTable: : An notation table

Deallocate the memory used by an entities hash table.

void xmlFreeRefTable

(

xmlRefTablePtr

table

)

xmlFreeRefTable: : An ref table

Deallocate the memory used by an Ref hash table.

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
	)

xmlGetID: : pointer to the document : the ID value

Search the attribute declaring the given ID

Returns NULL if not found, otherwise the xmlAttrPtr defining the ID

xmlListPtr xmlGetRefs	(	xmlDocPtr	doc,
		const xmlChar *	ID
	)

xmlGetRefs: : pointer to the document : the ID value

Find the set of references for the supplied ID.

Returns NULL if not found, otherwise node set for the ID.

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

xmlIsID: : the document : the element carrying the attribute : the attribute

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.

Returns 0 or 1 depending on the lookup result

int xmlIsMixedElement	(	xmlDocPtr	doc,
		const xmlChar *	name
	)

The public function calls related to validity checking.

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

xmlIsRef: : the document : the element carrying the attribute : the attribute

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

Returns 0 or 1 depending on the lookup result

xmlElementContentPtr xmlNewDocElementContent	(	xmlDocPtr	doc,
		const xmlChar *	name,
		xmlElementContentType	type
	)

xmlElementContentPtr xmlNewElementContent	(	const xmlChar *	name,
		xmlElementContentType	type
	)

int xmlRemoveID	(	xmlDocPtr	doc,
		xmlAttrPtr	attr
	)

xmlRemoveID: : the document : the attribute

Remove the given attribute from the ID table maintained internally.

Returns -1 if the lookup failed and 0 otherwise

int xmlRemoveRef	(	xmlDocPtr	doc,
		xmlAttrPtr	attr
	)

xmlRemoveRef: : the document : the attribute

Remove the given attribute from the Ref table maintained internally.

Returns -1 if the lookup failed and 0 otherwise

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

xmlSnprintfElementContent: : an output buffer : the buffer size : An element table : 1 if one must print the englobing parenthesis, 0 otherwise

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