c14n		API documentation		The XML C parser and toolkit of Gnome	chvalid

the catalog module implements the support for XML Catalogs and SGML catalogs

Table of Contents

#define XML_CATALOGS_NAMESPACE

#define XML_CATALOG_PI

Structure xmlCatalog
struct _xmlCatalog
The content of this structure is not made public by the API.

Enum xmlCatalogAllow

Enum xmlCatalogPrefer

Typedef xmlCatalog * xmlCatalogPtr

int	xmlACatalogAdd			(xmlCatalogPtr catal, 
					 const xmlChar * type, 
					 const xmlChar * orig, 
					 const xmlChar * replace)

void	xmlACatalogDump			(xmlCatalogPtr catal, 
					 FILE * out)

int	xmlACatalogRemove		(xmlCatalogPtr catal, 
					 const xmlChar * value)

xmlChar *	xmlACatalogResolve	(xmlCatalogPtr catal, 
					 const xmlChar * pubID, 
					 const xmlChar * sysID)

xmlChar *	xmlACatalogResolvePublic	(xmlCatalogPtr catal, 
						 const xmlChar * pubID)

xmlChar *	xmlACatalogResolveSystem	(xmlCatalogPtr catal, 
						 const xmlChar * sysID)

xmlChar *	xmlACatalogResolveURI	(xmlCatalogPtr catal, 
					 const xmlChar * URI)

int	xmlCatalogAdd			(const xmlChar * type, 
					 const xmlChar * orig, 
					 const xmlChar * replace)

void *	xmlCatalogAddLocal		(void * catalogs, 
					 const xmlChar * URL)

void	xmlCatalogCleanup		(void)

int	xmlCatalogConvert		(void)

void	xmlCatalogDump			(FILE * out)

void	xmlCatalogFreeLocal		(void * catalogs)

xmlCatalogAllow	xmlCatalogGetDefaults	(void)

const xmlChar *	xmlCatalogGetPublic	(const xmlChar * pubID)

const xmlChar *	xmlCatalogGetSystem	(const xmlChar * sysID)

int	xmlCatalogIsEmpty		(xmlCatalogPtr catal)

xmlChar *	xmlCatalogLocalResolve	(void * catalogs, 
					 const xmlChar * pubID, 
					 const xmlChar * sysID)

xmlChar *	xmlCatalogLocalResolveURI	(void * catalogs, 
						 const xmlChar * URI)

int	xmlCatalogRemove		(const xmlChar * value)

xmlChar *	xmlCatalogResolve	(const xmlChar * pubID, 
					 const xmlChar * sysID)

xmlChar *	xmlCatalogResolvePublic	(const xmlChar * pubID)

xmlChar *	xmlCatalogResolveSystem	(const xmlChar * sysID)

xmlChar *	xmlCatalogResolveURI	(const xmlChar * URI)

int	xmlCatalogSetDebug		(int level)

xmlCatalogPrefer	xmlCatalogSetDefaultPrefer	(xmlCatalogPrefer prefer)

void	xmlCatalogSetDefaults		(xmlCatalogAllow allow)

int	xmlConvertSGMLCatalog		(xmlCatalogPtr catal)

void	xmlFreeCatalog			(xmlCatalogPtr catal)

void	xmlInitializeCatalog		(void)

xmlCatalogPtr	xmlLoadACatalog		(const char * filename)

int	xmlLoadCatalog			(const char * filename)

void	xmlLoadCatalogs			(const char * pathss)

xmlCatalogPtr	xmlLoadSGMLSuperCatalog	(const char * filename)

xmlCatalogPtr	xmlNewCatalog		(int sgml)

xmlDocPtr	xmlParseCatalogFile	(const char * filename)

Description

Macro: XML_CATALOGS_NAMESPACE

#define XML_CATALOGS_NAMESPACE

The namespace for the XML Catalogs elements.

Macro: XML_CATALOG_PI

#define XML_CATALOG_PI

The specific XML Catalog Processing Instuction name.

Structure xmlCatalog

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

Enum xmlCatalogAllow

Enum xmlCatalogAllow {
    XML_CATA_ALLOW_NONE = 0
    XML_CATA_ALLOW_GLOBAL = 1
    XML_CATA_ALLOW_DOCUMENT = 2
    XML_CATA_ALLOW_ALL = 3
}

Enum xmlCatalogPrefer

Enum xmlCatalogPrefer {
    XML_CATA_PREFER_NONE = 0
    XML_CATA_PREFER_PUBLIC = 1
    XML_CATA_PREFER_SYSTEM = 2
}

Function: xmlACatalogAdd

int	xmlACatalogAdd			(xmlCatalogPtr catal, 
					 const xmlChar * type, 
					 const xmlChar * orig, 
					 const xmlChar * replace)

Add an entry in the catalog, it may overwrite existing but different entries.

Function: xmlACatalogDump

void	xmlACatalogDump			(xmlCatalogPtr catal, 
					 FILE * out)

Dump the given catalog to the given file.

Function: xmlACatalogRemove

int	xmlACatalogRemove		(xmlCatalogPtr catal, 
					 const xmlChar * value)

Remove an entry from the catalog

Function: xmlACatalogResolve

xmlChar *	xmlACatalogResolve	(xmlCatalogPtr catal, 
					 const xmlChar * pubID, 
					 const xmlChar * sysID)

Do a complete resolution lookup of an External Identifier

Function: xmlACatalogResolvePublic

xmlChar *	xmlACatalogResolvePublic	(xmlCatalogPtr catal, 
						 const xmlChar * pubID)

Try to lookup the catalog local reference associated to a public ID in that catalog

Function: xmlACatalogResolveSystem

xmlChar *	xmlACatalogResolveSystem	(xmlCatalogPtr catal, 
						 const xmlChar * sysID)

Try to lookup the catalog resource for a system ID

Function: xmlACatalogResolveURI

xmlChar *	xmlACatalogResolveURI	(xmlCatalogPtr catal, 
					 const xmlChar * URI)

Do a complete resolution lookup of an URI

Function: xmlCatalogAdd

int	xmlCatalogAdd			(const xmlChar * type, 
					 const xmlChar * orig, 
					 const xmlChar * replace)

Add an entry in the catalog, it may overwrite existing but different entries. If called before any other catalog routine, allows to override the default shared catalog put in place by xmlInitializeCatalog();

Function: xmlCatalogAddLocal

void *	xmlCatalogAddLocal		(void * catalogs, 
					 const xmlChar * URL)

Add the new entry to the catalog list

Function: xmlCatalogCleanup

void	xmlCatalogCleanup		(void)

Free up all the memory associated with catalogs

Function: xmlCatalogConvert

int	xmlCatalogConvert		(void)

Convert all the SGML catalog entries as XML ones

Function: xmlCatalogDump

void	xmlCatalogDump			(FILE * out)

Dump all the global catalog content to the given file.

Function: xmlCatalogFreeLocal

void	xmlCatalogFreeLocal		(void * catalogs)

Free up the memory associated to the catalog list

Function: xmlCatalogGetDefaults

xmlCatalogAllow	xmlCatalogGetDefaults	(void)

Used to get the user preference w.r.t. to what catalogs should be accepted

Function: xmlCatalogGetPublic

const xmlChar *	xmlCatalogGetPublic	(const xmlChar * pubID)

Try to lookup the catalog reference associated to a public ID DEPRECATED, use xmlCatalogResolvePublic()

Function: xmlCatalogGetSystem

const xmlChar *	xmlCatalogGetSystem	(const xmlChar * sysID)

Try to lookup the catalog reference associated to a system ID DEPRECATED, use xmlCatalogResolveSystem()

Function: xmlCatalogIsEmpty

int	xmlCatalogIsEmpty		(xmlCatalogPtr catal)

Check is a catalog is empty

Function: xmlCatalogLocalResolve

xmlChar *	xmlCatalogLocalResolve	(void * catalogs, 
					 const xmlChar * pubID, 
					 const xmlChar * sysID)

Do a complete resolution lookup of an External Identifier using a document's private catalog list

Function: xmlCatalogLocalResolveURI

xmlChar *	xmlCatalogLocalResolveURI	(void * catalogs, 
						 const xmlChar * URI)

Do a complete resolution lookup of an URI using a document's private catalog list

Function: xmlCatalogRemove

int	xmlCatalogRemove		(const xmlChar * value)

Remove an entry from the catalog

Function: xmlCatalogResolve

xmlChar *	xmlCatalogResolve	(const xmlChar * pubID, 
					 const xmlChar * sysID)

Do a complete resolution lookup of an External Identifier

Function: xmlCatalogResolvePublic

xmlChar *	xmlCatalogResolvePublic	(const xmlChar * pubID)

Try to lookup the catalog reference associated to a public ID

Function: xmlCatalogResolveSystem

xmlChar *	xmlCatalogResolveSystem	(const xmlChar * sysID)

Try to lookup the catalog resource for a system ID

Function: xmlCatalogResolveURI

xmlChar *	xmlCatalogResolveURI	(const xmlChar * URI)

Do a complete resolution lookup of an URI

Function: xmlCatalogSetDebug

int	xmlCatalogSetDebug		(int level)

Used to set the debug level for catalog operation, 0 disable debugging, 1 enable it

Function: xmlCatalogSetDefaultPrefer

xmlCatalogPrefer	xmlCatalogSetDefaultPrefer	(xmlCatalogPrefer prefer)

Allows to set the preference between public and system for deletion in XML Catalog resolution. C.f. section 4.1.1 of the spec Values accepted are XML_CATA_PREFER_PUBLIC or XML_CATA_PREFER_SYSTEM

Function: xmlCatalogSetDefaults

void	xmlCatalogSetDefaults		(xmlCatalogAllow allow)

Used to set the user preference w.r.t. to what catalogs should be accepted

Function: xmlConvertSGMLCatalog

int	xmlConvertSGMLCatalog		(xmlCatalogPtr catal)

Convert all the SGML catalog entries as XML ones

Function: xmlFreeCatalog

void	xmlFreeCatalog			(xmlCatalogPtr catal)

Free the memory allocated to a Catalog

Function: xmlInitializeCatalog

void	xmlInitializeCatalog		(void)

Do the catalog initialization. this function is not thread safe, catalog initialization should preferably be done once at startup

Function: xmlLoadACatalog

xmlCatalogPtr	xmlLoadACatalog		(const char * filename)

Load the catalog and build the associated data structures. This can be either an XML Catalog or an SGML Catalog It will recurse in SGML CATALOG entries. On the other hand XML Catalogs are not handled recursively.

Function: xmlLoadCatalog

int	xmlLoadCatalog			(const char * filename)

Load the catalog and makes its definitions effective for the default external entity loader. It will recurse in SGML CATALOG entries. this function is not thread safe, catalog initialization should preferably be done once at startup

Function: xmlLoadCatalogs

void	xmlLoadCatalogs			(const char * pathss)

Load the catalogs and makes their definitions effective for the default external entity loader. this function is not thread safe, catalog initialization should preferably be done once at startup

Function: xmlLoadSGMLSuperCatalog

xmlCatalogPtr	xmlLoadSGMLSuperCatalog	(const char * filename)

Load an SGML super catalog. It won't expand CATALOG or DELEGATE references. This is only needed for manipulating SGML Super Catalogs like adding and removing CATALOG or DELEGATE entries.

Function: xmlNewCatalog

xmlCatalogPtr	xmlNewCatalog		(int sgml)

create a new Catalog.

Function: xmlParseCatalogFile

xmlDocPtr	xmlParseCatalogFile	(const char * filename)

parse an XML file and build a tree. It's like xmlParseFile() except it bypass all catalog lookups.

Daniel Veillard