Annotation of embedaddon/libxml2/include/libxml/catalog.h, revision 1.1.1.2
1.1 misho 1: /**
2: * Summary: interfaces to the Catalog handling system
3: * Description: the catalog module implements the support for
4: * XML Catalogs and SGML catalogs
5: *
6: * SGML Open Technical Resolution TR9401:1997.
7: * http://www.jclark.com/sp/catalog.htm
8: *
9: * XML Catalogs Working Draft 06 August 2001
10: * http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
11: *
12: * Copy: See Copyright for the status of this software.
13: *
14: * Author: Daniel Veillard
15: */
16:
17: #ifndef __XML_CATALOG_H__
18: #define __XML_CATALOG_H__
19:
20: #include <stdio.h>
21:
22: #include <libxml/xmlversion.h>
23: #include <libxml/xmlstring.h>
24: #include <libxml/tree.h>
25:
26: #ifdef LIBXML_CATALOG_ENABLED
27:
28: #ifdef __cplusplus
29: extern "C" {
30: #endif
31:
32: /**
33: * XML_CATALOGS_NAMESPACE:
34: *
35: * The namespace for the XML Catalogs elements.
36: */
37: #define XML_CATALOGS_NAMESPACE \
38: (const xmlChar *) "urn:oasis:names:tc:entity:xmlns:xml:catalog"
39: /**
40: * XML_CATALOG_PI:
41: *
42: * The specific XML Catalog Processing Instuction name.
43: */
44: #define XML_CATALOG_PI \
45: (const xmlChar *) "oasis-xml-catalog"
46:
47: /*
48: * The API is voluntarily limited to general cataloging.
49: */
50: typedef enum {
51: XML_CATA_PREFER_NONE = 0,
52: XML_CATA_PREFER_PUBLIC = 1,
53: XML_CATA_PREFER_SYSTEM
54: } xmlCatalogPrefer;
55:
56: typedef enum {
57: XML_CATA_ALLOW_NONE = 0,
58: XML_CATA_ALLOW_GLOBAL = 1,
59: XML_CATA_ALLOW_DOCUMENT = 2,
60: XML_CATA_ALLOW_ALL = 3
61: } xmlCatalogAllow;
62:
63: typedef struct _xmlCatalog xmlCatalog;
64: typedef xmlCatalog *xmlCatalogPtr;
65:
66: /*
67: * Operations on a given catalog.
68: */
69: XMLPUBFUN xmlCatalogPtr XMLCALL
70: xmlNewCatalog (int sgml);
1.1.1.2 ! misho 71: XMLPUBFUN xmlCatalogPtr XMLCALL
1.1 misho 72: xmlLoadACatalog (const char *filename);
1.1.1.2 ! misho 73: XMLPUBFUN xmlCatalogPtr XMLCALL
1.1 misho 74: xmlLoadSGMLSuperCatalog (const char *filename);
1.1.1.2 ! misho 75: XMLPUBFUN int XMLCALL
1.1 misho 76: xmlConvertSGMLCatalog (xmlCatalogPtr catal);
1.1.1.2 ! misho 77: XMLPUBFUN int XMLCALL
1.1 misho 78: xmlACatalogAdd (xmlCatalogPtr catal,
79: const xmlChar *type,
80: const xmlChar *orig,
81: const xmlChar *replace);
1.1.1.2 ! misho 82: XMLPUBFUN int XMLCALL
1.1 misho 83: xmlACatalogRemove (xmlCatalogPtr catal,
84: const xmlChar *value);
1.1.1.2 ! misho 85: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 86: xmlACatalogResolve (xmlCatalogPtr catal,
87: const xmlChar *pubID,
88: const xmlChar *sysID);
1.1.1.2 ! misho 89: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 90: xmlACatalogResolveSystem(xmlCatalogPtr catal,
91: const xmlChar *sysID);
1.1.1.2 ! misho 92: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 93: xmlACatalogResolvePublic(xmlCatalogPtr catal,
94: const xmlChar *pubID);
1.1.1.2 ! misho 95: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 96: xmlACatalogResolveURI (xmlCatalogPtr catal,
97: const xmlChar *URI);
98: #ifdef LIBXML_OUTPUT_ENABLED
1.1.1.2 ! misho 99: XMLPUBFUN void XMLCALL
1.1 misho 100: xmlACatalogDump (xmlCatalogPtr catal,
101: FILE *out);
102: #endif /* LIBXML_OUTPUT_ENABLED */
1.1.1.2 ! misho 103: XMLPUBFUN void XMLCALL
1.1 misho 104: xmlFreeCatalog (xmlCatalogPtr catal);
1.1.1.2 ! misho 105: XMLPUBFUN int XMLCALL
1.1 misho 106: xmlCatalogIsEmpty (xmlCatalogPtr catal);
107:
108: /*
109: * Global operations.
110: */
1.1.1.2 ! misho 111: XMLPUBFUN void XMLCALL
1.1 misho 112: xmlInitializeCatalog (void);
1.1.1.2 ! misho 113: XMLPUBFUN int XMLCALL
1.1 misho 114: xmlLoadCatalog (const char *filename);
1.1.1.2 ! misho 115: XMLPUBFUN void XMLCALL
1.1 misho 116: xmlLoadCatalogs (const char *paths);
1.1.1.2 ! misho 117: XMLPUBFUN void XMLCALL
1.1 misho 118: xmlCatalogCleanup (void);
119: #ifdef LIBXML_OUTPUT_ENABLED
1.1.1.2 ! misho 120: XMLPUBFUN void XMLCALL
1.1 misho 121: xmlCatalogDump (FILE *out);
122: #endif /* LIBXML_OUTPUT_ENABLED */
1.1.1.2 ! misho 123: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 124: xmlCatalogResolve (const xmlChar *pubID,
125: const xmlChar *sysID);
1.1.1.2 ! misho 126: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 127: xmlCatalogResolveSystem (const xmlChar *sysID);
1.1.1.2 ! misho 128: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 129: xmlCatalogResolvePublic (const xmlChar *pubID);
1.1.1.2 ! misho 130: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 131: xmlCatalogResolveURI (const xmlChar *URI);
1.1.1.2 ! misho 132: XMLPUBFUN int XMLCALL
1.1 misho 133: xmlCatalogAdd (const xmlChar *type,
134: const xmlChar *orig,
135: const xmlChar *replace);
1.1.1.2 ! misho 136: XMLPUBFUN int XMLCALL
1.1 misho 137: xmlCatalogRemove (const xmlChar *value);
1.1.1.2 ! misho 138: XMLPUBFUN xmlDocPtr XMLCALL
1.1 misho 139: xmlParseCatalogFile (const char *filename);
1.1.1.2 ! misho 140: XMLPUBFUN int XMLCALL
1.1 misho 141: xmlCatalogConvert (void);
142:
143: /*
144: * Strictly minimal interfaces for per-document catalogs used
145: * by the parser.
146: */
1.1.1.2 ! misho 147: XMLPUBFUN void XMLCALL
1.1 misho 148: xmlCatalogFreeLocal (void *catalogs);
1.1.1.2 ! misho 149: XMLPUBFUN void * XMLCALL
1.1 misho 150: xmlCatalogAddLocal (void *catalogs,
151: const xmlChar *URL);
1.1.1.2 ! misho 152: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 153: xmlCatalogLocalResolve (void *catalogs,
154: const xmlChar *pubID,
155: const xmlChar *sysID);
1.1.1.2 ! misho 156: XMLPUBFUN xmlChar * XMLCALL
1.1 misho 157: xmlCatalogLocalResolveURI(void *catalogs,
158: const xmlChar *URI);
159: /*
160: * Preference settings.
161: */
1.1.1.2 ! misho 162: XMLPUBFUN int XMLCALL
1.1 misho 163: xmlCatalogSetDebug (int level);
1.1.1.2 ! misho 164: XMLPUBFUN xmlCatalogPrefer XMLCALL
1.1 misho 165: xmlCatalogSetDefaultPrefer(xmlCatalogPrefer prefer);
1.1.1.2 ! misho 166: XMLPUBFUN void XMLCALL
1.1 misho 167: xmlCatalogSetDefaults (xmlCatalogAllow allow);
1.1.1.2 ! misho 168: XMLPUBFUN xmlCatalogAllow XMLCALL
1.1 misho 169: xmlCatalogGetDefaults (void);
170:
171:
172: /* DEPRECATED interfaces */
1.1.1.2 ! misho 173: XMLPUBFUN const xmlChar * XMLCALL
1.1 misho 174: xmlCatalogGetSystem (const xmlChar *sysID);
1.1.1.2 ! misho 175: XMLPUBFUN const xmlChar * XMLCALL
1.1 misho 176: xmlCatalogGetPublic (const xmlChar *pubID);
177:
178: #ifdef __cplusplus
179: }
180: #endif
181: #endif /* LIBXML_CATALOG_ENABLED */
182: #endif /* __XML_CATALOG_H__ */
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>