encoding		API documentation		The XML C parser and toolkit of Gnome	globals

this module provides some of the entity API needed for the parser and applications.

Table of Contents

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

Typedef xmlEntitiesTable * xmlEntitiesTablePtr

Enum xmlEntityType

xmlEntityPtr	xmlAddDocEntity		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID, 
					 const xmlChar * content)

xmlEntityPtr	xmlAddDtdEntity		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID, 
					 const xmlChar * content)

void	xmlCleanupPredefinedEntities	(void)

xmlEntitiesTablePtr	xmlCopyEntitiesTable	(xmlEntitiesTablePtr table)

xmlEntitiesTablePtr	xmlCreateEntitiesTable	(void)

void	xmlDumpEntitiesTable		(xmlBufferPtr buf, 
					 xmlEntitiesTablePtr table)

void	xmlDumpEntityDecl		(xmlBufferPtr buf, 
					 xmlEntityPtr ent)

const xmlChar *	xmlEncodeEntities	(xmlDocPtr doc, 
					 const xmlChar * input)

xmlChar *	xmlEncodeEntitiesReentrant	(xmlDocPtr doc, 
						 const xmlChar * input)

xmlChar *	xmlEncodeSpecialChars	(const xmlDoc * doc, 
					 const xmlChar * input)

void	xmlFreeEntitiesTable		(xmlEntitiesTablePtr table)

xmlEntityPtr	xmlGetDocEntity		(const xmlDoc * doc, 
					 const xmlChar * name)

xmlEntityPtr	xmlGetDtdEntity		(xmlDocPtr doc, 
					 const xmlChar * name)

xmlEntityPtr	xmlGetParameterEntity	(xmlDocPtr doc, 
					 const xmlChar * name)

xmlEntityPtr	xmlGetPredefinedEntity	(const xmlChar * name)

void	xmlInitializePredefinedEntities	(void)

xmlEntityPtr	xmlNewEntity		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID, 
					 const xmlChar * content)

Description

Structure xmlEntitiesTable

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

Enum xmlEntityType

Enum xmlEntityType {
    XML_INTERNAL_GENERAL_ENTITY = 1
    XML_EXTERNAL_GENERAL_PARSED_ENTITY = 2
    XML_EXTERNAL_GENERAL_UNPARSED_ENTITY = 3
    XML_INTERNAL_PARAMETER_ENTITY = 4
    XML_EXTERNAL_PARAMETER_ENTITY = 5
    XML_INTERNAL_PREDEFINED_ENTITY = 6
}

Function: xmlAddDocEntity

xmlEntityPtr	xmlAddDocEntity		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID, 
					 const xmlChar * content)

Register a new entity for this document.

Function: xmlAddDtdEntity

xmlEntityPtr	xmlAddDtdEntity		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID, 
					 const xmlChar * content)

Register a new entity for this document DTD external subset.

Function: xmlCleanupPredefinedEntities

void	xmlCleanupPredefinedEntities	(void)

Cleanup up the predefined entities table. Deprecated call

Function: xmlCopyEntitiesTable

xmlEntitiesTablePtr	xmlCopyEntitiesTable	(xmlEntitiesTablePtr table)

Build a copy of an entity table.

Function: xmlCreateEntitiesTable

xmlEntitiesTablePtr	xmlCreateEntitiesTable	(void)

create and initialize an empty entities hash table. This really doesn't make sense and should be deprecated

Function: xmlDumpEntitiesTable

void	xmlDumpEntitiesTable		(xmlBufferPtr buf, 
					 xmlEntitiesTablePtr table)

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

Function: xmlDumpEntityDecl

void	xmlDumpEntityDecl		(xmlBufferPtr buf, 
					 xmlEntityPtr ent)

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

Function: xmlEncodeEntities

const xmlChar *	xmlEncodeEntities	(xmlDocPtr doc, 
					 const xmlChar * input)

TODO: remove xmlEncodeEntities, once we are not afraid of breaking binary compatibility People must migrate their code to xmlEncodeEntitiesReentrant ! This routine will issue a warning when encountered.

Function: xmlEncodeEntitiesReentrant

xmlChar *	xmlEncodeEntitiesReentrant	(xmlDocPtr doc, 
						 const xmlChar * input)

Do a global encoding of a string, replacing the predefined entities and non ASCII values with their entities and CharRef counterparts. Contrary to xmlEncodeEntities, this routine is reentrant, and result must be deallocated.

Function: xmlEncodeSpecialChars

xmlChar *	xmlEncodeSpecialChars	(const xmlDoc * doc, 
					 const xmlChar * input)

Do a global encoding of a string, replacing the predefined entities this routine is reentrant, and result must be deallocated.

Function: xmlFreeEntitiesTable

void	xmlFreeEntitiesTable		(xmlEntitiesTablePtr table)

Deallocate the memory used by an entities hash table.

Function: xmlGetDocEntity

xmlEntityPtr	xmlGetDocEntity		(const xmlDoc * doc, 
					 const xmlChar * name)

Do an entity lookup in the document entity hash table and

Function: xmlGetDtdEntity

xmlEntityPtr	xmlGetDtdEntity		(xmlDocPtr doc, 
					 const xmlChar * name)

Do an entity lookup in the DTD entity hash table and

Function: xmlGetParameterEntity

xmlEntityPtr	xmlGetParameterEntity	(xmlDocPtr doc, 
					 const xmlChar * name)

Do an entity lookup in the internal and external subsets and

Function: xmlGetPredefinedEntity

xmlEntityPtr	xmlGetPredefinedEntity	(const xmlChar * name)

Check whether this name is an predefined entity.

Function: xmlInitializePredefinedEntities

void	xmlInitializePredefinedEntities	(void)

Set up the predefined entities. Deprecated call

Function: xmlNewEntity

xmlEntityPtr	xmlNewEntity		(xmlDocPtr doc, 
					 const xmlChar * name, 
					 int type, 
					 const xmlChar * ExternalID, 
					 const xmlChar * SystemID, 
					 const xmlChar * content)

Create a new entity, this differs from xmlAddDocEntity() that if the document is NULL or has no internal subset defined, then an unlinked entity structure will be returned, it is then the responsability of the caller to link it to the document later or free it when not needed anymore.

Daniel Veillard