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