File: catalog.h

package info (click to toggle)
xdmf 3.0%2Bgit20160803-3
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 35,388 kB
  • ctags: 36,627
  • sloc: ansic: 265,382; cpp: 162,889; python: 10,976; f90: 1,378; yacc: 687; fortran: 464; xml: 200; java: 187; lex: 125; makefile: 82; sh: 28
file content (182 lines) | stat: -rw-r--r-- 6,392 bytes parent folder | download | duplicates (14)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/**
 * Summary: interfaces to the Catalog handling system
 * Description: the catalog module implements the support for
 * XML Catalogs and SGML catalogs
 *
 * SGML Open Technical Resolution TR9401:1997.
 * http://www.jclark.com/sp/catalog.htm
 *
 * XML Catalogs Working Draft 06 August 2001
 * http://www.oasis-open.org/committees/entity/spec-2001-08-06.html
 *
 * Copy: See Copyright for the status of this software.
 *
 * Author: Daniel Veillard
 */

#ifndef __XML_CATALOG_H__
#define __XML_CATALOG_H__

#include <stdio.h>

#include "xmlversion.h"
#include "xmlstring.h"
#include "tree.h"

#ifdef LIBXML_CATALOG_ENABLED

#ifdef __cplusplus
extern "C" {
#endif

/**
 * XML_CATALOGS_NAMESPACE:
 *
 * The namespace for the XML Catalogs elements.
 */
#define XML_CATALOGS_NAMESPACE                                  \
    (const xmlChar *) "urn:oasis:names:tc:entity:xmlns:xml:catalog"
/**
 * XML_CATALOG_PI:
 *
 * The specific XML Catalog Processing Instuction name.
 */
#define XML_CATALOG_PI                                          \
    (const xmlChar *) "oasis-xml-catalog"

/*
 * The API is voluntarily limited to general cataloging.
 */
typedef enum {
    XML_CATA_PREFER_NONE = 0,
    XML_CATA_PREFER_PUBLIC = 1,
    XML_CATA_PREFER_SYSTEM
} xmlCatalogPrefer;

typedef enum {
    XML_CATA_ALLOW_NONE = 0,
    XML_CATA_ALLOW_GLOBAL = 1,
    XML_CATA_ALLOW_DOCUMENT = 2,
    XML_CATA_ALLOW_ALL = 3
} xmlCatalogAllow;

typedef struct _xmlCatalog xmlCatalog;
typedef xmlCatalog *xmlCatalogPtr;

/*
 * Operations on a given catalog.
 */
XMLPUBFUN xmlCatalogPtr XMLCALL
                xmlNewCatalog           (int sgml);
XMLPUBFUN xmlCatalogPtr XMLCALL 
                xmlLoadACatalog         (const char *filename);
XMLPUBFUN xmlCatalogPtr XMLCALL 
                xmlLoadSGMLSuperCatalog (const char *filename);
XMLPUBFUN int XMLCALL           
                xmlConvertSGMLCatalog   (xmlCatalogPtr catal);
XMLPUBFUN int XMLCALL           
                xmlACatalogAdd          (xmlCatalogPtr catal,
                                         const xmlChar *type,
                                         const xmlChar *orig,
                                         const xmlChar *replace);
XMLPUBFUN int XMLCALL           
                xmlACatalogRemove       (xmlCatalogPtr catal,
                                         const xmlChar *value);
XMLPUBFUN xmlChar * XMLCALL     
                xmlACatalogResolve      (xmlCatalogPtr catal,
                                         const xmlChar *pubID,
                                         const xmlChar *sysID);
XMLPUBFUN xmlChar * XMLCALL     
                xmlACatalogResolveSystem(xmlCatalogPtr catal,
                                         const xmlChar *sysID);
XMLPUBFUN xmlChar * XMLCALL     
                xmlACatalogResolvePublic(xmlCatalogPtr catal,
                                         const xmlChar *pubID);
XMLPUBFUN xmlChar * XMLCALL     
                xmlACatalogResolveURI   (xmlCatalogPtr catal,
                                         const xmlChar *URI);
#ifdef LIBXML_OUTPUT_ENABLED
XMLPUBFUN void XMLCALL          
                xmlACatalogDump         (xmlCatalogPtr catal,
                                         FILE *out);
#endif /* LIBXML_OUTPUT_ENABLED */
XMLPUBFUN void XMLCALL          
                xmlFreeCatalog          (xmlCatalogPtr catal);
XMLPUBFUN int XMLCALL           
                xmlCatalogIsEmpty       (xmlCatalogPtr catal);

/*
 * Global operations.
 */
XMLPUBFUN void XMLCALL          
                xmlInitializeCatalog    (void);
XMLPUBFUN int XMLCALL           
                xmlLoadCatalog          (const char *filename);
XMLPUBFUN void XMLCALL          
                xmlLoadCatalogs         (const char *paths);
XMLPUBFUN void XMLCALL          
                xmlCatalogCleanup       (void);
#ifdef LIBXML_OUTPUT_ENABLED
XMLPUBFUN void XMLCALL          
                xmlCatalogDump          (FILE *out);
#endif /* LIBXML_OUTPUT_ENABLED */
XMLPUBFUN xmlChar * XMLCALL     
                xmlCatalogResolve       (const xmlChar *pubID,
                                         const xmlChar *sysID);
XMLPUBFUN xmlChar * XMLCALL     
                xmlCatalogResolveSystem (const xmlChar *sysID);
XMLPUBFUN xmlChar * XMLCALL     
                xmlCatalogResolvePublic (const xmlChar *pubID);
XMLPUBFUN xmlChar * XMLCALL     
                xmlCatalogResolveURI    (const xmlChar *URI);
XMLPUBFUN int XMLCALL           
                xmlCatalogAdd           (const xmlChar *type,
                                         const xmlChar *orig,
                                         const xmlChar *replace);
XMLPUBFUN int XMLCALL           
                xmlCatalogRemove        (const xmlChar *value);
XMLPUBFUN xmlDocPtr XMLCALL     
                xmlParseCatalogFile     (const char *filename);
XMLPUBFUN int XMLCALL           
                xmlCatalogConvert       (void);

/*
 * Strictly minimal interfaces for per-document catalogs used
 * by the parser.
 */
XMLPUBFUN void XMLCALL          
                xmlCatalogFreeLocal     (void *catalogs);
XMLPUBFUN void * XMLCALL                
                xmlCatalogAddLocal      (void *catalogs,
                                         const xmlChar *URL);
XMLPUBFUN xmlChar * XMLCALL     
                xmlCatalogLocalResolve  (void *catalogs,
                                         const xmlChar *pubID,
                                         const xmlChar *sysID);
XMLPUBFUN xmlChar * XMLCALL     
                xmlCatalogLocalResolveURI(void *catalogs,
                                         const xmlChar *URI);
/*
 * Preference settings.
 */
XMLPUBFUN int XMLCALL           
                xmlCatalogSetDebug      (int level);
XMLPUBFUN xmlCatalogPrefer XMLCALL 
                xmlCatalogSetDefaultPrefer(xmlCatalogPrefer prefer);
XMLPUBFUN void XMLCALL          
                xmlCatalogSetDefaults   (xmlCatalogAllow allow);
XMLPUBFUN xmlCatalogAllow XMLCALL       
                xmlCatalogGetDefaults   (void);


/* DEPRECATED interfaces */
XMLPUBFUN const xmlChar * XMLCALL       
                xmlCatalogGetSystem     (const xmlChar *sysID);
XMLPUBFUN const xmlChar * XMLCALL       
                xmlCatalogGetPublic     (const xmlChar *pubID);

#ifdef __cplusplus
}
#endif
#endif /* LIBXML_CATALOG_ENABLED */
#endif /* __XML_CATALOG_H__ */