Happy new year
[yaz-moved-to-github.git] / include / yaz / odr.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2009 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
28 /**
29  * \file odr.h
30  * \brief Header for ODR (Open Data Representation)
31  */
32
33 #ifndef ODR_H
34 #define ODR_H
35
36 #include <stdio.h>
37 #include <string.h>
38
39 #include <yaz/yconfig.h>
40 #include <yaz/nmem.h>
41
42 /* for definition of Odr_oid */
43 #include <yaz/oid_util.h>
44
45 YAZ_BEGIN_CDECL
46
47 #ifndef bool_t
48 #define bool_t int
49 #endif
50
51 /*
52  * Tag modes
53  */
54 #define ODR_NONE -1
55 #define ODR_IMPLICIT 0
56 #define ODR_EXPLICIT 1
57
58 /*
59  * Classes
60  */
61 #define ODR_UNIVERSAL   0
62 #define ODR_APPLICATION 1
63 #define ODR_CONTEXT     2
64 #define ODR_PRIVATE     3
65
66 /*
67  * UNIVERSAL tags
68  */
69 #define ODR_BOOLEAN     1
70 #define ODR_INTEGER     2
71 #define ODR_BITSTRING   3
72 #define ODR_OCTETSTRING 4
73 #define ODR_NULL        5
74 #define ODR_OID         6
75 #define ODR_ODESC       7
76 #define ODR_EXTERNAL    8
77 #define ODR_REAL        9
78 #define ODR_ENUM        10
79 #define ODR_SEQUENCE    16
80 #define ODR_SET         17
81 #define ODR_NUMERICSTRING   18
82 #define ODR_PRINTABLESTRING 19
83 #define ODR_GENERALIZEDTIME 24
84 #define ODR_GRAPHICSTRING   25
85 #define ODR_VISIBLESTRING   26
86 #define ODR_GENERALSTRING   27
87
88 /*
89  * odr stream directions
90  */
91 #define ODR_DECODE      0
92 #define ODR_ENCODE      1
93 #define ODR_PRINT       2
94
95 typedef struct odr_oct
96 {
97     unsigned char *buf;
98     int len;
99     int size;
100 } Odr_oct;
101
102 typedef void Odr_null;
103 extern Odr_null *ODR_NULLVAL;
104
105 typedef Odr_oct Odr_any;
106
107 typedef struct odr_bitmask
108 {
109 #define ODR_BITMASK_SIZE 256
110     unsigned char bits[ODR_BITMASK_SIZE];
111     int top;
112 } Odr_bitmask;
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 char *odr_strdup_null(ODR o, const char *str);
187 YAZ_EXPORT int *odr_intdup(ODR o, int v);
188 YAZ_EXPORT Odr_oct *odr_create_Odr_oct(ODR o, const unsigned char *buf,
189                                        int sz);
190 YAZ_EXPORT NMEM odr_extract_mem(ODR o);
191 YAZ_EXPORT Odr_null *odr_nullval(void);
192 #define odr_release_mem(m) nmem_destroy(m)
193 #define ODR_MEM NMEM
194
195 #define odr_implicit_tag(o, t, p, cl, tg, opt, name)\
196         (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), name) )
197
198 #define odr_explicit_tag(o, t, p, cl, tg, opt, name)\
199         ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
200         t ((o), (p), (opt), name) &&\
201         odr_constructed_end(o) : odr_missing((o), opt, name)))
202
203 #define ODR_MASK_ZERO(mask)\
204     ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
205     (mask)->top = -1))
206
207 #define ODR_MASK_SET(mask, num)\
208     (((mask)->bits[(num) >> 3] |= 0X80 >> ((num) & 0X07)),\
209     (mask)->top < (num) >> 3 ? ((mask)->top = (num) >> 3) : 0)
210
211 #define ODR_MASK_CLEAR(mask, num)\
212     ((mask)->bits[(num) >> 3] &= ~(0X80 >> ((num) & 0X07)))
213
214 #define ODR_MASK_GET(mask, num)  ( ((num) >> 3 <= (mask)->top) ? \
215     ((mask)->bits[(num) >> 3] & (0X80 >> ((num) & 0X07)) ? 1 : 0) : 0)
216
217
218 #define odr_tell(o) ((o)->pos)
219 #define odr_offset(o) ((o)->bp - (o)->buf)
220 #define odr_ok(o) (!(o)->error)
221 #define odr_getmem(o) ((o)->mem)
222
223 #define ODR_MAXNAME 256
224
225 YAZ_EXPORT int ber_boolean(ODR o, int *val);
226 YAZ_EXPORT int ber_tag(ODR o, void *p, int zclass, int tag,
227                        int *constructed, int opt, const char *name);
228 YAZ_EXPORT int ber_enctag(ODR o, int zclass, int tag, int constructed);
229 YAZ_EXPORT int ber_dectag(const unsigned char *buf, int *zclass,
230                           int *tag, int *constructed, int max);
231 YAZ_EXPORT int odr_bool(ODR o, int **p, int opt, const char *name);
232 YAZ_EXPORT int odr_integer(ODR o, int **p, int opt, const char *name);
233 YAZ_EXPORT int odr_enum(ODR o, int **p, int opt, const char *name);
234 YAZ_EXPORT int odr_implicit_settag(ODR o, int zclass, int tag);
235 YAZ_EXPORT int ber_enclen(ODR o, int len, int lenlen, int exact);
236 YAZ_EXPORT int ber_declen(const unsigned char *buf, int *len, int max);
237 YAZ_EXPORT void odr_prname(ODR o, const char *name);
238 YAZ_EXPORT int ber_null(ODR o);
239 YAZ_EXPORT int odr_null(ODR o, Odr_null **p, int opt, const char *name);
240 YAZ_EXPORT int ber_integer(ODR o, int *val);
241 YAZ_EXPORT int odr_constructed_begin(ODR o, void *p, int zclass, int tag,
242                                      const char *name);
243 YAZ_EXPORT int odr_constructed_end(ODR o);
244 YAZ_EXPORT int odr_sequence_begin(ODR o, void *p, int size, const char *name);
245 YAZ_EXPORT int odr_set_begin(ODR o, void *p, int size, const char *name);
246 YAZ_EXPORT int odr_sequence_end(ODR o);
247 YAZ_EXPORT int odr_set_end(ODR o);
248 YAZ_EXPORT int ber_octetstring(ODR o, Odr_oct *p, int cons);
249 YAZ_EXPORT int odr_octetstring(ODR o, Odr_oct **p, int opt, const char *name);
250 YAZ_EXPORT int odp_more_chunks(ODR o, const unsigned char *base, int len);
251 YAZ_EXPORT int odr_constructed_more(ODR o);
252 YAZ_EXPORT int odr_bitstring(ODR o, Odr_bitmask **p, int opt,
253                              const char *name);
254 YAZ_EXPORT int ber_bitstring(ODR o, Odr_bitmask *p, int cons);
255 YAZ_EXPORT int odr_generalstring(ODR o, char **p, int opt, const char *name);
256 YAZ_EXPORT int ber_oidc(ODR o, Odr_oid *p, int max_oid_size);
257 YAZ_EXPORT int odr_oid(ODR o, Odr_oid **p, int opt, const char *name);
258 YAZ_EXPORT int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp,
259                           const char *name);
260 YAZ_EXPORT int odr_cstring(ODR o, char **p, int opt, const char *name);
261 YAZ_EXPORT int odr_iconv_string(ODR o, char **p, int opt, const char *name);
262 YAZ_EXPORT int odr_sequence_of(ODR o, Odr_fun type, void *p, int *num,
263                                const char *name);
264 YAZ_EXPORT int odr_set_of(ODR o, Odr_fun type, void *p, int *num,
265                           const char *name);
266 YAZ_EXPORT int odr_any(ODR o, Odr_any **p, int opt, const char *name);
267
268 YAZ_EXPORT int ber_any(ODR o, Odr_any **p);
269 /** \brief determine whether a buffer is a complete BER buffer
270     \param buf BER buffer
271     \param len length of buffer
272     \retval 0 package is incomplete
273     \retval >0 package is complete and length is return value
274 */
275 YAZ_EXPORT int completeBER(const unsigned char *buf, int len);
276
277 YAZ_EXPORT void odr_begin(ODR o);
278 YAZ_EXPORT void odr_end(ODR o);
279 YAZ_EXPORT Odr_oid *odr_oiddup(ODR odr, const Odr_oid *o);
280 YAZ_EXPORT Odr_oid *odr_oiddup_nmem(NMEM nmem, const Odr_oid *o);
281 YAZ_EXPORT int odr_grow_block(ODR b, int min_bytes);
282 YAZ_EXPORT int odr_write(ODR o, unsigned char *buf, int bytes);
283 YAZ_EXPORT int odr_seek(ODR o, int whence, int offset);
284 YAZ_EXPORT int odr_dumpBER(FILE *f, const char *buf, int len);
285 YAZ_EXPORT void odr_choice_bias(ODR o, int what);
286 YAZ_EXPORT void odr_choice_enable_bias(ODR o, int mode);
287 YAZ_EXPORT int odr_total(ODR o);
288 YAZ_EXPORT char *odr_errmsg(int n);
289 YAZ_EXPORT Odr_oid *odr_getoidbystr(ODR o, const char *str);
290 YAZ_EXPORT Odr_oid *odr_getoidbystr_nmem(NMEM o, const char *str);
291
292 YAZ_EXPORT int odr_initmember(ODR o, void *p, int size);
293 YAZ_EXPORT int odr_peektag(ODR o, int *zclass, int *tag, int *cons);
294 YAZ_EXPORT void odr_setlenlen(ODR o, int len);
295 YAZ_EXPORT int odr_missing(ODR o, int opt, const char *name);
296 YAZ_EXPORT char *odr_prepend(ODR o, const char *prefix, const char *old);
297
298 typedef struct Odr_external
299 {
300     Odr_oid *direct_reference;       /* OPTIONAL */
301     int     *indirect_reference;     /* OPTIONAL */
302     char    *descriptor;             /* OPTIONAL */
303     int which;
304 #define ODR_EXTERNAL_single 0
305 #define ODR_EXTERNAL_octet 1
306 #define ODR_EXTERNAL_arbitrary 2
307     union
308     {
309         Odr_any  *single_ASN1_type;
310         Odr_oct  *octet_aligned; 
311         Odr_bitmask *arbitrary;      /* we aren't really equipped for this*/
312     } u;
313 } Odr_external;
314
315 YAZ_EXPORT int odr_external(ODR o, Odr_external **p, int opt,
316                             const char *name);
317 YAZ_EXPORT int odr_visiblestring(ODR o, char **p, int opt,
318                                  const char *name);
319 YAZ_EXPORT int odr_graphicstring(ODR o, char **p, int opt,
320                                  const char *name);
321 YAZ_EXPORT int odr_generalizedtime(ODR o, char **p, int opt,
322                                    const char *name);
323
324 YAZ_EXPORT int odr_set_charset(ODR o, const char *to, const char *from);
325
326 YAZ_EXPORT void odr_set_stream(ODR o,  void *handle,
327                                void (*stream_write)(ODR o, 
328                                                     void *handle,
329                                                     int type,
330                                                     const char *buf,
331                                                     int len),
332                                void (*stream_close)(void *handle));
333
334 YAZ_EXPORT void odr_printf(ODR o, const char *fmt, ...);
335
336 YAZ_EXPORT const char **odr_get_element_path(ODR o);
337
338 YAZ_END_CDECL
339
340 #include <yaz/xmalloc.h>
341
342 #endif
343 /*
344  * Local variables:
345  * c-basic-offset: 4
346  * indent-tabs-mode: nil
347  * End:
348  * vim: shiftwidth=4 tabstop=8 expandtab
349  */
350