Add support for privately defined extended service, xml update, with
[yaz-moved-to-github.git] / include / yaz / oid.h
1 /*
2  * Copyright (C) 1995-2005, Index Data ApS
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and
5  * its documentation, in whole or in part, for any purpose, is hereby granted,
6  * provided that:
7  *
8  * 1. This copyright and permission notice appear in all copies of the
9  * software and its documentation. Notices of copyright or attribution
10  * which appear at the beginning of any file must remain unchanged.
11  *
12  * 2. The name of Index Data or the individual authors may not be used to
13  * endorse or promote products derived from this software without specific
14  * prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24  * OF THIS SOFTWARE.
25  *
26  * $Id: oid.h,v 1.25 2005-06-06 10:29:33 adam Exp $
27  */
28
29 /**
30  * \file oid.h
31  * \brief Header for OID database
32  *
33  * More or less protocol-transparent OID database.
34  * We could (and should?) extend this so that the user app can add new
35  * entries to the list at initialization.
36  */
37 #ifndef OID_H
38 #define OID_H
39
40 #include <yaz/yconfig.h>
41
42 YAZ_BEGIN_CDECL
43
44 #define OID_SIZE 20
45     
46 typedef enum oid_proto
47 {
48     PROTO_NOP=0,
49     PROTO_Z3950,
50     PROTO_SR,
51     PROTO_GENERAL,
52     PROTO_WAIS,
53     PROTO_HTTP
54 } oid_proto;
55
56 typedef enum oid_class
57 {
58     CLASS_NOP=0,
59     CLASS_APPCTX,
60     CLASS_ABSYN,
61     CLASS_ATTSET,
62     CLASS_TRANSYN,
63     CLASS_DIAGSET,
64     CLASS_RECSYN,
65     CLASS_RESFORM,
66     CLASS_ACCFORM,
67     CLASS_EXTSERV,
68     CLASS_USERINFO,
69     CLASS_ELEMSPEC,
70     CLASS_VARSET,
71     CLASS_SCHEMA,
72     CLASS_TAGSET,
73     CLASS_GENERAL,
74     CLASS_NEGOT
75 } oid_class;
76
77 typedef enum oid_value
78 {
79     VAL_NOP=0,
80     VAL_APDU,
81     VAL_BER,
82     VAL_BASIC_CTX,
83     VAL_BIB1,
84
85     VAL_EXP1,
86     VAL_EXT1,
87     VAL_CCL1,
88     VAL_GILS,
89     VAL_WAIS, 
90 /* 10 */
91     VAL_STAS,
92     VAL_COLLECT1,
93     VAL_CIMI1,
94     VAL_GEO,
95     VAL_DIAG1,
96
97     VAL_ISO2709,
98     VAL_UNIMARC,
99     VAL_INTERMARC,
100     VAL_CCF,
101     VAL_USMARC,
102 /* 20 */
103     VAL_UKMARC,
104     VAL_NORMARC,
105     VAL_LIBRISMARC,
106     VAL_DANMARC,
107     VAL_FINMARC,
108
109     VAL_MAB,
110     VAL_CANMARC,
111     VAL_SBN,
112     VAL_PICAMARC,
113     VAL_AUSMARC,
114 /* 30 */
115     VAL_IBERMARC,
116     VAL_CATMARC,
117     VAL_MALMARC,
118     VAL_EXPLAIN,
119     VAL_SUTRS,
120
121     VAL_OPAC,
122     VAL_SUMMARY,
123     VAL_GRS0,
124     VAL_GRS1,
125     VAL_EXTENDED,
126 /* 40 */
127     VAL_FRAGMENT,
128     VAL_RESOURCE1,
129     VAL_RESOURCE2,
130     VAL_PROMPT1,
131     VAL_DES1,
132
133     VAL_KRB1,
134     VAL_PRESSET,
135     VAL_PQUERY,
136     VAL_PCQUERY,
137     VAL_ITEMORDER,
138
139 /* 50 */
140     VAL_DBUPDATE0,
141     VAL_DBUPDATE,
142     VAL_EXPORTSPEC,
143     VAL_EXPORTINV,
144     VAL_NONE,
145
146     VAL_SETM,
147     VAL_SETG,
148     VAL_VAR1,
149     VAL_ESPEC1,
150     VAL_SOIF,
151
152 /* 60 */
153     VAL_SEARCHRES1,
154     VAL_THESAURUS,
155     VAL_CHARLANG,
156     VAL_USERINFO1,
157     VAL_MULTISRCH1,
158
159     VAL_MULTISRCH2,
160     VAL_DATETIME,
161     VAL_SQLRS,
162     VAL_PDF,
163     VAL_POSTSCRIPT,
164
165 /* 70 */
166     VAL_HTML,
167     VAL_TIFF,
168     VAL_GIF,
169     VAL_JPEG,
170     VAL_PNG,
171
172     VAL_MPEG,
173     VAL_SGML,
174     VAL_TIFFB,
175     VAL_WAV,
176     VAL_UPDATEES,
177
178 /* 80 */
179     VAL_TEXT_XML,
180     VAL_APPLICATION_XML,
181     VAL_UNIVERSE_REPORT,
182     VAL_PROXY,
183     VAL_COOKIE,
184
185     VAL_CLIENT_IP,
186     VAL_ISO_ILL_1,
187     VAL_ZBIG,
188     VAL_UTIL,
189     VAL_XD1,
190
191 /* 90 */
192     VAL_ZTHES,
193     VAL_FIN1,
194     VAL_DAN1,
195     VAL_DIAG_ES,
196     VAL_DIAG_GENERAL,
197
198     VAL_JPMARC,
199     VAL_SWEMARC,
200     VAL_SIGLEMARC,
201     VAL_ISDSMARC,
202     VAL_RUSMARC,
203
204 /* 100 */
205     VAL_ADMINSERVICE,
206     VAL_HOLDINGS,
207     VAL_HUNMARC,
208     VAL_CHARNEG3,
209     VAL_LIB1,
210
211     VAL_VIRT,
212     VAL_UCS2,
213     VAL_UCS4,
214     VAL_UTF16,
215     VAL_UTF8,
216 /* 110 */
217
218     VAL_IDXPATH,
219     VAL_BIB2,
220     VAL_ZEEREX,
221     VAL_CQL,
222     VAL_DBUPDATE1,
223
224     VAL_OCLCUI,
225     VAL_ID_CHARSET,
226     VAL_EXTLITE,
227     VAL_NACSISCATP,
228     VAL_FINMARC2000,
229 /* 120 */
230
231     VAL_MARC21FIN,
232     VAL_CHARNEG4,
233     VAL_XMLUPDATE,
234
235 /* VAL_DYNAMIC must have highest value */
236     VAL_DYNAMIC,
237     VAL_MAX = VAL_DYNAMIC+30
238 } oid_value;
239
240 typedef struct oident
241 {
242     oid_proto proto;
243     oid_class oclass;
244     oid_value value;
245     int oidsuffix[OID_SIZE];
246     char *desc;
247 } oident;
248
249 YAZ_EXPORT int *oid_getoidbyent(struct oident *ent);
250 YAZ_EXPORT int *oid_ent_to_oid(struct oident *ent, int *dst);
251 YAZ_EXPORT struct oident *oid_getentbyoid(int *o);
252 YAZ_EXPORT void oid_oidcpy(int *t, int *s);
253 YAZ_EXPORT void oid_oidcat(int *t, int *s);
254 YAZ_EXPORT int oid_oidcmp(int *o1, int *o2);
255 YAZ_EXPORT int oid_oidlen(int *o);
256 YAZ_EXPORT oid_value oid_getvalbyname(const char *name);
257 YAZ_EXPORT void oid_setprivateoids(oident *list);
258 YAZ_EXPORT struct oident *oid_addent (int *oid, enum oid_proto proto,
259                                       enum oid_class oclass,
260                                       const char *desc, int value);
261
262 YAZ_EXPORT void oid_trav (void (*func)(struct oident *oidinfo, void *vp),
263                           void *vp);
264
265 YAZ_EXPORT void oid_init(void);
266 YAZ_EXPORT void oid_exit(void);
267 YAZ_EXPORT int *oid_name_to_oid(oid_class oclass, const char *name, int *oid);
268 YAZ_EXPORT char *oid_to_dotstring(const int *oid, char *oidbuf);
269 YAZ_EXPORT char *oid_name_to_dotstring(oid_class oclass, const char *name,
270                                        char *oidbuf);
271
272 YAZ_END_CDECL
273
274 #endif