From 35a201cc8ef0c3f5b2df88d2e528aabee1048348 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Fri, 30 Apr 2021 18:47:09 +0200 Subject: Initial/Final commit --- libxml2-2.9.10/doc/html/libxml-catalog.html | 142 ++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) create mode 100644 libxml2-2.9.10/doc/html/libxml-catalog.html (limited to 'libxml2-2.9.10/doc/html/libxml-catalog.html') diff --git a/libxml2-2.9.10/doc/html/libxml-catalog.html b/libxml2-2.9.10/doc/html/libxml-catalog.html new file mode 100644 index 0000000..3d6b2cc --- /dev/null +++ b/libxml2-2.9.10/doc/html/libxml-catalog.html @@ -0,0 +1,142 @@ + + +Module catalog from libxml2
Action against software patentsGnome2 LogoW3C LogoRed Hat Logo
Made with Libxml2 Logo

Module catalog from libxml2

API Menu
API Indexes
Related links
Prevc14nUpAPI documentationHomeThe XML C parser and toolkit of GnomechvalidNext

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

+
catal:a Catalog
type:the type of record to add to the catalog
orig:the system, public or prefix to match
replace:the replacement value for the match
Returns:0 if successful, -1 otherwise

Function: xmlACatalogDump

void	xmlACatalogDump			(xmlCatalogPtr catal, 
					 FILE * out)

+

Dump the given catalog to the given file.

+
catal:a Catalog
out:the file.

Function: xmlACatalogRemove

int	xmlACatalogRemove		(xmlCatalogPtr catal, 
					 const xmlChar * value)

+

Remove an entry from the catalog

+
catal:a Catalog
value:the value to remove
Returns:the number of entries removed if successful, -1 otherwise

Function: xmlACatalogResolve

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

+

Do a complete resolution lookup of an External Identifier

+
catal:a Catalog
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.

Function: xmlACatalogResolvePublic

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

+

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

+
catal:a Catalog
pubID:the public ID string
Returns:the local resource if found or NULL otherwise, the value returned must be freed by the caller.

Function: xmlACatalogResolveSystem

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

+

Try to lookup the catalog resource for a system ID

+
catal:a Catalog
sysID:the system ID string
Returns:the resource if found or NULL otherwise, the value returned must be freed by the caller.

Function: xmlACatalogResolveURI

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

+

Do a complete resolution lookup of an URI

+
catal:a Catalog
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.

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();

+
type:the type of record to add to the catalog
orig:the system, public or prefix to match
replace:the replacement value for the match
Returns:0 if successful, -1 otherwise

Function: xmlCatalogAddLocal

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

+

Add the new entry to the catalog list

+
catalogs:a document's list of catalogs
URL:the URL to a new local catalog
Returns:the updated 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

+
Returns:the number of entries converted if successful, -1 otherwise

Function: xmlCatalogDump

void	xmlCatalogDump			(FILE * out)

+

Dump all the global catalog content to the given file.

+
out:the file.

Function: xmlCatalogFreeLocal

void	xmlCatalogFreeLocal		(void * catalogs)

+

Free up the memory associated to the catalog list

+
catalogs:a document's list of catalogs

Function: xmlCatalogGetDefaults

xmlCatalogAllow	xmlCatalogGetDefaults	(void)

+

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

+
Returns:the current xmlCatalogAllow value

Function: xmlCatalogGetPublic

const xmlChar *	xmlCatalogGetPublic	(const xmlChar * pubID)

+

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

+
pubID:the public ID string
Returns:the resource if found or NULL otherwise.

Function: xmlCatalogGetSystem

const xmlChar *	xmlCatalogGetSystem	(const xmlChar * sysID)

+

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

+
sysID:the system ID string
Returns:the resource if found or NULL otherwise.

Function: xmlCatalogIsEmpty

int	xmlCatalogIsEmpty		(xmlCatalogPtr catal)

+

Check is a catalog is empty

+
catal:should this create an SGML catalog
Returns:1 if the catalog is empty, 0 if not, amd -1 in case of error.

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

+
catalogs:a document's list of catalogs
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.

Function: xmlCatalogLocalResolveURI

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

+

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

+
catalogs:a document's list of catalogs
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.

Function: xmlCatalogRemove

int	xmlCatalogRemove		(const xmlChar * value)

+

Remove an entry from the catalog

+
value:the value to remove
Returns:the number of entries removed if successful, -1 otherwise

Function: xmlCatalogResolve

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

+

Do a complete resolution lookup of an External Identifier

+
pubID:the public ID string
sysID:the system ID string
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.

Function: xmlCatalogResolvePublic

xmlChar *	xmlCatalogResolvePublic	(const xmlChar * pubID)

+

Try to lookup the catalog reference associated to a public ID

+
pubID:the public ID string
Returns:the resource if found or NULL otherwise, the value returned must be freed by the caller.

Function: xmlCatalogResolveSystem

xmlChar *	xmlCatalogResolveSystem	(const xmlChar * sysID)

+

Try to lookup the catalog resource for a system ID

+
sysID:the system ID string
Returns:the resource if found or NULL otherwise, the value returned must be freed by the caller.

Function: xmlCatalogResolveURI

xmlChar *	xmlCatalogResolveURI	(const xmlChar * URI)

+

Do a complete resolution lookup of an URI

+
URI:the URI
Returns:the URI of the resource or NULL if not found, it must be freed by the caller.

Function: xmlCatalogSetDebug

int	xmlCatalogSetDebug		(int level)

+

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

+
level:the debug level of catalogs required
Returns:the previous value of the catalog debugging level

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

+
prefer:the default preference for delegation
Returns:the previous value of the default preference for delegation

Function: xmlCatalogSetDefaults

void	xmlCatalogSetDefaults		(xmlCatalogAllow allow)

+

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

+
allow:what catalogs should be accepted

Function: xmlConvertSGMLCatalog

int	xmlConvertSGMLCatalog		(xmlCatalogPtr catal)

+

Convert all the SGML catalog entries as XML ones

+
catal:the catalog
Returns:the number of entries converted if successful, -1 otherwise

Function: xmlFreeCatalog

void	xmlFreeCatalog			(xmlCatalogPtr catal)

+

Free the memory allocated to a Catalog

+
catal: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.

+
filename:a file path
Returns:the catalog parsed or NULL in case of error

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

+
filename:a file path
Returns:0 in case of success -1 in case of error

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

+
pathss:a list of directories separated by a colon or a space.

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.

+
filename:a file path
Returns:the catalog parsed or NULL in case of error

Function: xmlNewCatalog

xmlCatalogPtr	xmlNewCatalog		(int sgml)

+

create a new Catalog.

+
sgml:should this create an SGML catalog
Returns:the xmlCatalogPtr or NULL in case of error

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.

+
filename:the filename
Returns:the resulting document tree or NULL in case of error

Daniel Veillard

-- cgit v1.2.3