2 * Copyright (c) 1995-2001, Index Data.
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,
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.
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.
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
26 * $Id: odr.h,v 1.5 2001-09-24 21:51:55 adam Exp $
35 #include <yaz/yconfig.h>
48 #define ODR_IMPLICIT 0
49 #define ODR_EXPLICIT 1
54 #define ODR_UNIVERSAL 0
55 #define ODR_APPLICATION 1
64 #define ODR_BITSTRING 3
65 #define ODR_OCTETSTRING 4
69 #define ODR_EXTERNAL 8
72 #define ODR_SEQUENCE 16
74 #define ODR_NUMERICSTRING 18
75 #define ODR_PRINTABLESTRING 19
76 #define ODR_GENERALIZEDTIME 24
77 #define ODR_GRAPHICSTRING 25
78 #define ODR_VISIBLESTRING 26
79 #define ODR_GENERALSTRING 27
82 * odr stream directions
88 typedef struct odr_oct
95 typedef void Odr_null;
96 extern Odr_null *ODR_NULLVAL;
98 typedef Odr_oct Odr_any;
100 typedef struct odr_bitmask
102 #define ODR_BITMASK_SIZE 256
103 unsigned char bits[ODR_BITMASK_SIZE];
107 typedef int Odr_oid; /* terminate by -1 */
109 typedef struct odr_constack
111 const unsigned char *base; /* starting point of data */
113 int len; /* length of data, if known, else -1
115 const unsigned char *lenb; /* where to encode length */
117 int lenlen; /* length of length-field */
124 typedef struct { /* used to be statics in ber_tag... */
133 int direction; /* the direction of this stream */
135 int error; /* current error state (0==OK) */
137 int can_grow; /* are we allowed to reallocate */
138 unsigned char *buf; /* memory handle */
139 int size; /* current buffer size */
141 int pos; /* current position */
142 int top; /* top of buffer (max pos when decoding) */
144 const unsigned char *bp; /* position in buffer (decoding) */
146 int t_class; /* implicit tagging (-1==default tag) */
149 int enable_bias; /* force choice enable flag */
150 int choice_bias; /* force choice */
151 int lenlen; /* force length-of-lenght (odr_setlen()) */
153 FILE *print; /* output file for direction print */
154 int indent; /* current indent level for printing */
156 NMEM mem; /* memory handle for decoding (primarily) */
158 /* stack for constructed types */
159 #define ODR_MAX_STACK 50
160 int stackp; /* top of stack (-1 == initial state) */
161 odr_constack stack[ODR_MAX_STACK];
163 Odr_ber_tag odr_ber_tag;
166 typedef int (*Odr_fun)(ODR, char **, int, const char *);
168 typedef struct odr_arm
186 #define OUNEXPECTED 5
194 extern char *odr_errlist[];
196 YAZ_EXPORT int odr_geterror(ODR o);
197 YAZ_EXPORT void odr_perror(ODR o, char *message);
198 YAZ_EXPORT void odr_setprint(ODR o, FILE *file);
199 YAZ_EXPORT ODR odr_createmem(int direction);
200 YAZ_EXPORT void odr_reset(ODR o);
201 YAZ_EXPORT void odr_destroy(ODR o);
202 YAZ_EXPORT void odr_setbuf(ODR o, char *buf, int len, int can_grow);
203 YAZ_EXPORT char *odr_getbuf(ODR o, int *len, int *size);
204 YAZ_EXPORT void *odr_malloc(ODR o, int size);
205 YAZ_EXPORT char *odr_strdup(ODR o, const char *str);
206 YAZ_EXPORT int *odr_intdup(ODR o, int v);
207 YAZ_EXPORT NMEM odr_extract_mem(ODR o);
208 YAZ_EXPORT Odr_null *odr_nullval(void);
209 #define odr_release_mem(m) nmem_destroy(m)
212 #define odr_implicit(o, t, p, cl, tg, opt)\
213 (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), 0) )
215 #define odr_implicit_tag(o, t, p, cl, tg, opt, name)\
216 (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), name) )
218 #define odr_explicit(o, t, p, cl, tg, opt)\
219 ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
220 t ((o), (p), (opt), 0) &&\
221 odr_constructed_end(o) : opt))
223 #define odr_explicit_tag(o, t, p, cl, tg, opt, name)\
224 ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
225 t ((o), (p), (opt), name) &&\
226 odr_constructed_end(o) : opt))
228 #define ODR_MASK_ZERO(mask)\
229 ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
232 #define ODR_MASK_SET(mask, num)\
233 (((mask)->bits[(num) >> 3] |= 0X80 >> ((num) & 0X07)),\
234 (mask)->top < (num) >> 3 ? ((mask)->top = (num) >> 3) : 0)
236 #define ODR_MASK_CLEAR(mask, num)\
237 ((mask)->bits[(num) >> 3] &= ~(0X80 >> ((num) & 0X07)))
239 #define ODR_MASK_GET(mask, num) ( ((num) >> 3 <= (mask)->top) ? \
240 ((mask)->bits[(num) >> 3] & (0X80 >> ((num) & 0X07)) ? 1 : 0) : 0)
243 * write a single character at the current position - grow buffer if
245 * (no, we're not usually this anal about our macros, but this baby is
246 * next to unreadable without some indentation :)
248 #define odr_putc(o, c) \
251 (o)->pos < (o)->size ? \
253 (o)->buf[(o)->pos++] = (c), \
257 odr_grow_block((o), 1) == 0 ? \
259 (o)->buf[(o)->pos++] = (c), \
263 (o)->error = OSPACE, \
269 (o)->pos > (o)->top ? \
271 (o)->top = (o)->pos, \
279 #define odr_tell(o) ((o)->pos)
280 #define odr_offset(o) ((o)->bp - (o)->buf)
281 #define odr_ok(o) (!(o)->error)
282 #define odr_getmem(o) ((o)->mem)
283 #define odr_setmem(o, v) ((o)->mem = (v))
285 #define ODR_MAXNAME 256
287 YAZ_EXPORT int ber_boolean(ODR o, int *val);
288 YAZ_EXPORT int ber_tag(ODR o, void *p, int zclass, int tag,
289 int *constructed, int opt);
290 YAZ_EXPORT int ber_enctag(ODR o, int zclass, int tag, int constructed);
291 YAZ_EXPORT int ber_dectag(const unsigned char *buf, int *zclass,
292 int *tag, int *constructed);
293 YAZ_EXPORT int odr_bool(ODR o, int **p, int opt, const char *name);
294 YAZ_EXPORT int odr_integer(ODR o, int **p, int opt, const char *name);
295 YAZ_EXPORT int odr_enum(ODR o, int **p, int opt, const char *name);
296 YAZ_EXPORT int odr_implicit_settag(ODR o, int zclass, int tag);
297 YAZ_EXPORT int ber_enclen(ODR o, int len, int lenlen, int exact);
298 YAZ_EXPORT int ber_declen(const unsigned char *buf, int *len);
299 YAZ_EXPORT void odr_prname(ODR o, const char *name);
300 YAZ_EXPORT int ber_null(ODR o);
301 YAZ_EXPORT int odr_null(ODR o, Odr_null **p, int opt, const char *name);
302 YAZ_EXPORT int ber_integer(ODR o, int *val);
303 YAZ_EXPORT int odr_constructed_begin(ODR o, void *p, int zclass, int tag,
305 YAZ_EXPORT int odr_constructed_end(ODR o);
306 YAZ_EXPORT int odr_sequence_begin(ODR o, void *p, int size, const char *name);
307 YAZ_EXPORT int odr_set_begin(ODR o, void *p, int size, const char *name);
308 YAZ_EXPORT int odr_sequence_end(ODR o);
309 YAZ_EXPORT int odr_set_end(ODR o);
310 YAZ_EXPORT int ber_octetstring(ODR o, Odr_oct *p, int cons);
311 YAZ_EXPORT int odr_octetstring(ODR o, Odr_oct **p, int opt, const char *name);
312 YAZ_EXPORT int odp_more_chunks(ODR o, const unsigned char *base, int len);
313 YAZ_EXPORT int odr_constructed_more(ODR o);
314 YAZ_EXPORT int odr_bitstring(ODR o, Odr_bitmask **p, int opt,
316 YAZ_EXPORT int ber_bitstring(ODR o, Odr_bitmask *p, int cons);
317 YAZ_EXPORT int odr_generalstring(ODR o, char **p, int opt, const char *name);
318 YAZ_EXPORT int ber_oidc(ODR o, Odr_oid *p);
319 YAZ_EXPORT int odr_oid(ODR o, Odr_oid **p, int opt, const char *name);
320 YAZ_EXPORT int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp,
322 YAZ_EXPORT int odr_cstring(ODR o, char **p, int opt, const char *name);
323 YAZ_EXPORT int odr_sequence_of(ODR o, Odr_fun type, void *p, int *num,
325 YAZ_EXPORT int odr_set_of(ODR o, Odr_fun type, void *p, int *num,
327 YAZ_EXPORT int odr_any(ODR o, Odr_any **p, int opt, const char *name);
328 YAZ_EXPORT int ber_any(ODR o, Odr_any **p);
329 YAZ_EXPORT int completeBER(const unsigned char *buf, int len);
330 YAZ_EXPORT void odr_begin(ODR o);
331 YAZ_EXPORT void odr_end(ODR o);
332 YAZ_EXPORT Odr_oid *odr_oiddup(ODR odr, Odr_oid *o);
333 YAZ_EXPORT Odr_oid *odr_oiddup_nmem(NMEM nmem, Odr_oid *o);
334 YAZ_EXPORT int odr_grow_block(ODR b, int min_bytes);
335 YAZ_EXPORT int odr_write(ODR o, unsigned char *buf, int bytes);
336 YAZ_EXPORT int odr_seek(ODR o, int whence, int offset);
337 YAZ_EXPORT int odr_dumpBER(FILE *f, const char *buf, int len);
338 YAZ_EXPORT void odr_choice_bias(ODR o, int what);
339 YAZ_EXPORT void odr_choice_enable_bias(ODR o, int mode);
340 YAZ_EXPORT int odr_total(ODR o);
341 YAZ_EXPORT char *odr_errmsg(int n);
342 YAZ_EXPORT Odr_oid *odr_getoidbystr(ODR o, const char *str);
343 YAZ_EXPORT Odr_oid *odr_getoidbystr_nmem(NMEM o, const char *str);
345 YAZ_EXPORT int odr_initmember(ODR o, void *p, int size);
346 YAZ_EXPORT int odr_peektag(ODR o, int *zclass, int *tag, int *cons);
347 YAZ_EXPORT void odr_setlenlen(ODR o, int len);
349 typedef struct Odr_external
351 Odr_oid *direct_reference; /* OPTIONAL */
352 int *indirect_reference; /* OPTIONAL */
353 char *descriptor; /* OPTIONAL */
355 #define ODR_EXTERNAL_single 0
356 #define ODR_EXTERNAL_octet 1
357 #define ODR_EXTERNAL_arbitrary 2
360 Odr_any *single_ASN1_type;
361 Odr_oct *octet_aligned;
362 Odr_bitmask *arbitrary; /* we aren't really equipped for this*/
366 YAZ_EXPORT int odr_external(ODR o, Odr_external **p, int opt,
368 YAZ_EXPORT int odr_visiblestring(ODR o, char **p, int opt,
370 YAZ_EXPORT int odr_graphicstring(ODR o, char **p, int opt,
372 YAZ_EXPORT int odr_generalizedtime(ODR o, char **p, int opt,
376 #include <yaz/xmalloc.h>