New OID database - with public definitions in oid_db.h. Removed old OID
[yaz-moved-to-github.git] / include / yaz / odr.h
1 /*
2  * Copyright (c) 1995-2007, Index Data
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Index Data nor the names of its contributors
13  *       may be used to endorse or promote products derived from this
14  *       software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 /* $Id: odr.h,v 1.27 2007-04-12 13:52:57 adam Exp $ */
28
29 /**
30  * \file odr.h
31  * \brief Header for ODR (Open Data Representation)
32  */
33
34 #ifndef ODR_H
35 #define ODR_H
36
37 #include <stdio.h>
38 #include <string.h>
39
40 #include <yaz/yconfig.h>
41 #include <yaz/nmem.h>
42
43 YAZ_BEGIN_CDECL
44
45 #ifndef bool_t
46 #define bool_t int
47 #endif
48
49 /*
50  * Tag modes
51  */
52 #define ODR_NONE -1
53 #define ODR_IMPLICIT 0
54 #define ODR_EXPLICIT 1
55
56 /*
57  * Classes
58  */
59 #define ODR_UNIVERSAL   0
60 #define ODR_APPLICATION 1
61 #define ODR_CONTEXT     2
62 #define ODR_PRIVATE     3
63
64 /*
65  * UNIVERSAL tags
66  */
67 #define ODR_BOOLEAN     1
68 #define ODR_INTEGER     2
69 #define ODR_BITSTRING   3
70 #define ODR_OCTETSTRING 4
71 #define ODR_NULL        5
72 #define ODR_OID         6
73 #define ODR_ODESC       7
74 #define ODR_EXTERNAL    8
75 #define ODR_REAL        9
76 #define ODR_ENUM        10
77 #define ODR_SEQUENCE    16
78 #define ODR_SET         17
79 #define ODR_NUMERICSTRING   18
80 #define ODR_PRINTABLESTRING 19
81 #define ODR_GENERALIZEDTIME 24
82 #define ODR_GRAPHICSTRING   25
83 #define ODR_VISIBLESTRING   26
84 #define ODR_GENERALSTRING   27
85
86 /*
87  * odr stream directions
88  */
89 #define ODR_DECODE      0
90 #define ODR_ENCODE      1
91 #define ODR_PRINT       2
92
93 typedef struct odr_oct
94 {
95     unsigned char *buf;
96     int len;
97     int size;
98 } Odr_oct;
99
100 typedef void Odr_null;
101 extern Odr_null *ODR_NULLVAL;
102
103 typedef Odr_oct Odr_any;
104
105 typedef struct odr_bitmask
106 {
107 #define ODR_BITMASK_SIZE 256
108     unsigned char bits[ODR_BITMASK_SIZE];
109     int top;
110 } Odr_bitmask;
111
112 typedef int Odr_oid;   /* terminate by -1 */
113
114 #define ODR_S_SET     0
115 #define ODR_S_CUR     1
116 #define ODR_S_END     2
117
118 typedef struct odr *ODR;
119
120 /** ODR handle and the public structs */
121 struct odr
122 {
123     int direction;       /* the direction of this stream */
124
125     int error;            /* current error state (0==OK) */
126
127     unsigned char *buf;            /* memory handle */
128     int top;              /* top of buffer (max pos when encoding) */
129     int size;             /* current buffer size (encoding+decoding) */
130
131     int pos;              /* current position (encoding) */
132
133     const unsigned char *bp; /* position in buffer (decoding) */
134
135     NMEM mem;            /* memory handle for decoding (primarily) */
136
137     struct Odr_private *op;
138 };
139
140 typedef int (*Odr_fun)(ODR, char **, int, const char *);
141
142 typedef struct odr_arm
143 {
144     int tagmode;
145     int zclass;
146     int tag;
147     int which;
148     Odr_fun fun;
149     char *name;
150 } Odr_arm;
151
152 /*
153  * Error control.
154  */
155 #define ONONE           0
156 #define OMEMORY         1
157 #define OSYSERR         2
158 #define OSPACE          3
159 #define OREQUIRED       4
160 #define OUNEXPECTED     5
161 #define OOTHER          6
162 #define OPROTO          7
163 #define ODATA           8
164 #define OSTACK          9
165 #define OCONLEN        10
166 #define OLENOV         11
167 #define OHTTP          12
168
169 extern char *odr_errlist[];
170
171 YAZ_EXPORT int odr_geterror(ODR o);
172 YAZ_EXPORT int odr_geterrorx(ODR o, int *x);
173 YAZ_EXPORT void odr_seterror(ODR o, int errorno, int errorid);
174 YAZ_EXPORT void odr_setelement(ODR o, const char *addinfo);
175 YAZ_EXPORT const char *odr_getelement(ODR o);
176 YAZ_EXPORT void odr_perror(ODR o, const char *message);
177 YAZ_EXPORT void odr_setprint(ODR o, FILE *file);
178 YAZ_EXPORT ODR odr_createmem(int direction);
179 YAZ_EXPORT void odr_reset(ODR o);
180 YAZ_EXPORT void odr_destroy(ODR o);
181 YAZ_EXPORT void odr_setbuf(ODR o, char *buf, int len, int can_grow);
182 YAZ_EXPORT char *odr_getbuf(ODR o, int *len, int *size);
183 YAZ_EXPORT void *odr_malloc(ODR o, int size);
184 YAZ_EXPORT char *odr_strdup(ODR o, const char *str);
185 YAZ_EXPORT char *odr_strdupn(ODR o, const char *str, size_t n);
186 YAZ_EXPORT int *odr_intdup(ODR o, int v);
187 YAZ_EXPORT Odr_oct *odr_create_Odr_oct(ODR o, const unsigned char *buf,
188                                        int sz);
189 YAZ_EXPORT NMEM odr_extract_mem(ODR o);
190 YAZ_EXPORT Odr_null *odr_nullval(void);
191 #define odr_release_mem(m) nmem_destroy(m)
192 #define ODR_MEM NMEM
193
194 #define odr_implicit_tag(o, t, p, cl, tg, opt, name)\
195         (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), name) )
196
197 #define odr_explicit_tag(o, t, p, cl, tg, opt, name)\
198         ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
199         t ((o), (p), (opt), name) &&\
200         odr_constructed_end(o) : odr_missing((o), opt, name)))
201
202 #define ODR_MASK_ZERO(mask)\
203     ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
204     (mask)->top = -1))
205
206 #define ODR_MASK_SET(mask, num)\
207     (((mask)->bits[(num) >> 3] |= 0X80 >> ((num) & 0X07)),\
208     (mask)->top < (num) >> 3 ? ((mask)->top = (num) >> 3) : 0)
209
210 #define ODR_MASK_CLEAR(mask, num)\
211     ((mask)->bits[(num) >> 3] &= ~(0X80 >> ((num) & 0X07)))
212
213 #define ODR_MASK_GET(mask, num)  ( ((num) >> 3 <= (mask)->top) ? \
214     ((mask)->bits[(num) >> 3] & (0X80 >> ((num) & 0X07)) ? 1 : 0) : 0)
215
216
217 #define odr_tell(o) ((o)->pos)
218 #define odr_offset(o) ((o)->bp - (o)->buf)
219 #define odr_ok(o) (!(o)->error)
220 #define odr_getmem(o) ((o)->mem)
221
222 #define ODR_MAXNAME 256
223
224 YAZ_EXPORT int ber_boolean(ODR o, int *val);
225 YAZ_EXPORT int ber_tag(ODR o, void *p, int zclass, int tag,
226                        int *constructed, int opt, const char *name);
227 YAZ_EXPORT int ber_enctag(ODR o, int zclass, int tag, int constructed);
228 YAZ_EXPORT int ber_dectag(const unsigned char *buf, int *zclass,
229                           int *tag, int *constructed, int max);
230 YAZ_EXPORT int odr_bool(ODR o, int **p, int opt, const char *name);
231 YAZ_EXPORT int odr_integer(ODR o, int **p, int opt, const char *name);
232 YAZ_EXPORT int odr_enum(ODR o, int **p, int opt, const char *name);
233 YAZ_EXPORT int odr_implicit_settag(ODR o, int zclass, int tag);
234 YAZ_EXPORT int ber_enclen(ODR o, int len, int lenlen, int exact);
235 YAZ_EXPORT int ber_declen(const unsigned char *buf, int *len, int max);
236 YAZ_EXPORT void odr_prname(ODR o, const char *name);
237 YAZ_EXPORT int ber_null(ODR o);
238 YAZ_EXPORT int odr_null(ODR o, Odr_null **p, int opt, const char *name);
239 YAZ_EXPORT int ber_integer(ODR o, int *val);
240 YAZ_EXPORT int odr_constructed_begin(ODR o, void *p, int zclass, int tag,
241                                      const char *name);
242 YAZ_EXPORT int odr_constructed_end(ODR o);
243 YAZ_EXPORT int odr_sequence_begin(ODR o, void *p, int size, const char *name);
244 YAZ_EXPORT int odr_set_begin(ODR o, void *p, int size, const char *name);
245 YAZ_EXPORT int odr_sequence_end(ODR o);
246 YAZ_EXPORT int odr_set_end(ODR o);
247 YAZ_EXPORT int ber_octetstring(ODR o, Odr_oct *p, int cons);
248 YAZ_EXPORT int odr_octetstring(ODR o, Odr_oct **p, int opt, const char *name);
249 YAZ_EXPORT int odp_more_chunks(ODR o, const unsigned char *base, int len);
250 YAZ_EXPORT int odr_constructed_more(ODR o);
251 YAZ_EXPORT int odr_bitstring(ODR o, Odr_bitmask **p, int opt,
252                              const char *name);
253 YAZ_EXPORT int ber_bitstring(ODR o, Odr_bitmask *p, int cons);
254 YAZ_EXPORT int odr_generalstring(ODR o, char **p, int opt, const char *name);
255 YAZ_EXPORT int ber_oidc(ODR o, Odr_oid *p, int max_oid_size);
256 YAZ_EXPORT int odr_oid(ODR o, Odr_oid **p, int opt, const char *name);
257 YAZ_EXPORT int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp,
258                           const char *name);
259 YAZ_EXPORT int odr_cstring(ODR o, char **p, int opt, const char *name);
260 YAZ_EXPORT int odr_iconv_string(ODR o, char **p, int opt, const char *name);
261 YAZ_EXPORT int odr_sequence_of(ODR o, Odr_fun type, void *p, int *num,
262                                const char *name);
263 YAZ_EXPORT int odr_set_of(ODR o, Odr_fun type, void *p, int *num,
264                           const char *name);
265 YAZ_EXPORT int odr_any(ODR o, Odr_any **p, int opt, const char *name);
266
267 YAZ_EXPORT int ber_any(ODR o, Odr_any **p);
268 /** \brief determine whether a buffer is a complete BER buffer
269     \param buf BER buffer
270     \param len length of buffer
271     \retval 0 package is incomplete
272     \retval >0 package is complete and length is return value
273 */
274 YAZ_EXPORT int completeBER(const unsigned char *buf, int len);
275
276 YAZ_EXPORT void odr_begin(ODR o);
277 YAZ_EXPORT void odr_end(ODR o);
278 YAZ_EXPORT Odr_oid *odr_oiddup(ODR odr, const Odr_oid *o);
279 YAZ_EXPORT Odr_oid *odr_oiddup_nmem(NMEM nmem, const Odr_oid *o);
280 YAZ_EXPORT int odr_grow_block(ODR b, int min_bytes);
281 YAZ_EXPORT int odr_write(ODR o, unsigned char *buf, int bytes);
282 YAZ_EXPORT int odr_seek(ODR o, int whence, int offset);
283 YAZ_EXPORT int odr_dumpBER(FILE *f, const char *buf, int len);
284 YAZ_EXPORT void odr_choice_bias(ODR o, int what);
285 YAZ_EXPORT void odr_choice_enable_bias(ODR o, int mode);
286 YAZ_EXPORT int odr_total(ODR o);
287 YAZ_EXPORT char *odr_errmsg(int n);
288 YAZ_EXPORT Odr_oid *odr_getoidbystr(ODR o, const char *str);
289 YAZ_EXPORT Odr_oid *odr_getoidbystr_nmem(NMEM o, const char *str);
290
291 YAZ_EXPORT int odr_initmember(ODR o, void *p, int size);
292 YAZ_EXPORT int odr_peektag(ODR o, int *zclass, int *tag, int *cons);
293 YAZ_EXPORT void odr_setlenlen(ODR o, int len);
294 YAZ_EXPORT int odr_missing(ODR o, int opt, const char *name);
295 YAZ_EXPORT char *odr_prepend(ODR o, const char *prefix, const char *old);
296
297 typedef struct Odr_external
298 {
299     Odr_oid *direct_reference;       /* OPTIONAL */
300     int     *indirect_reference;     /* OPTIONAL */
301     char    *descriptor;             /* OPTIONAL */
302     int which;
303 #define ODR_EXTERNAL_single 0
304 #define ODR_EXTERNAL_octet 1
305 #define ODR_EXTERNAL_arbitrary 2
306     union
307     {
308         Odr_any  *single_ASN1_type;
309         Odr_oct  *octet_aligned; 
310         Odr_bitmask *arbitrary;      /* we aren't really equipped for this*/
311     } u;
312 } Odr_external;
313
314 YAZ_EXPORT int odr_external(ODR o, Odr_external **p, int opt,
315                             const char *name);
316 YAZ_EXPORT int odr_visiblestring(ODR o, char **p, int opt,
317                                  const char *name);
318 YAZ_EXPORT int odr_graphicstring(ODR o, char **p, int opt,
319                                  const char *name);
320 YAZ_EXPORT int odr_generalizedtime(ODR o, char **p, int opt,
321                                    const char *name);
322
323 YAZ_EXPORT int odr_set_charset(ODR o, const char *to, const char *from);
324
325 YAZ_EXPORT void odr_set_stream(ODR o,  void *handle,
326                                void (*stream_write)(ODR o, 
327                                                     void *handle,
328                                                     int type,
329                                                     const char *buf,
330                                                     int len),
331                                void (*stream_close)(void *handle));
332
333 YAZ_EXPORT void odr_printf(ODR o, const char *fmt, ...);
334
335 YAZ_EXPORT const char **odr_get_element_path(ODR o);
336
337 YAZ_END_CDECL
338
339 #include <yaz/xmalloc.h>
340
341 #endif
342 /*
343  * Local variables:
344  * c-basic-offset: 4
345  * indent-tabs-mode: nil
346  * End:
347  * vim: shiftwidth=4 tabstop=8 expandtab
348  */
349