include/yaz/odr.h

   1 /*
   2  * Copyright (c) 1995-2003, Index Data.
   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: odr.h,v 1.7 2003-01-06 08:20:27 adam Exp $
  27  */
  28
  29 #ifndef ODR_H
  30 #define ODR_H
  31
  32 #include <stdio.h>
  33 #include <string.h>
  34
  35 #include <yaz/yconfig.h>
  36 #include <yaz/nmem.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 #ifndef bool_t
  41 #define bool_t int
  42 #endif
  43
  44 /*
  45  * Tag modes
  46  */
  47 #define ODR_NONE -1
  48 #define ODR_IMPLICIT 0
  49 #define ODR_EXPLICIT 1
  50
  51 /*
  52  * Classes
  53  */
  54 #define ODR_UNIVERSAL   0
  55 #define ODR_APPLICATION 1
  56 #define ODR_CONTEXT     2
  57 #define ODR_PRIVATE     3
  58
  59 /*
  60  * UNIVERSAL tags
  61  */
  62 #define ODR_BOOLEAN     1
  63 #define ODR_INTEGER     2
  64 #define ODR_BITSTRING   3
  65 #define ODR_OCTETSTRING 4
  66 #define ODR_NULL        5
  67 #define ODR_OID         6
  68 #define ODR_ODESC       7
  69 #define ODR_EXTERNAL    8
  70 #define ODR_REAL        9
  71 #define ODR_ENUM        10
  72 #define ODR_SEQUENCE    16
  73 #define ODR_SET         17
  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
  80
  81 /*
  82  * odr stream directions
  83  */
  84 #define ODR_DECODE      0
  85 #define ODR_ENCODE      1
  86 #define ODR_PRINT       2
  87
  88 typedef struct odr_oct
  89 {
  90     unsigned char *buf;
  91     int len;
  92     int size;
  93 } Odr_oct;
  94
  95 typedef void Odr_null;
  96 extern Odr_null *ODR_NULLVAL;
  97
  98 typedef Odr_oct Odr_any;
  99
 100 typedef struct odr_bitmask
 101 {
 102 #define ODR_BITMASK_SIZE 256
 103     unsigned char bits[ODR_BITMASK_SIZE];
 104     int top;
 105 } Odr_bitmask;
 106
 107 typedef int Odr_oid;   /* terminate by -1 */
 108
 109 typedef struct odr_constack
 110 {
 111     const unsigned char *base;   /* starting point of data */
 112     int base_offset;
 113     int len;                     /* length of data, if known, else -1
 114                                         (decoding only) */
 115     const unsigned char *lenb;   /* where to encode length */
 116     int len_offset;
 117     int lenlen;                  /* length of length-field */
 118 } odr_constack;
 119
 120 #define ODR_S_SET     0
 121 #define ODR_S_CUR     1
 122 #define ODR_S_END     2
 123
 124 typedef struct odr
 125 {
 126     int direction;       /* the direction of this stream */
 127
 128     int error;           /* current error state (0==OK) */
 129
 130     int can_grow;         /* are we allowed to reallocate */
 131     unsigned char *buf;            /* memory handle */
 132     int size;             /* current buffer size */
 133
 134     int pos;              /* current position */
 135     int top;              /* top of buffer (max pos when decoding) */
 136
 137     const unsigned char *bp; /* position in buffer (decoding) */
 138
 139     int t_class;         /* implicit tagging (-1==default tag) */
 140     int t_tag;
 141
 142     int enable_bias;     /* force choice enable flag */
 143     int choice_bias;     /* force choice */
 144     int lenlen;          /* force length-of-lenght (odr_setlen()) */
 145
 146     FILE *print;         /* output file for direction print */
 147     int indent;          /* current indent level for printing */
 148
 149     NMEM mem;            /* memory handle for decoding (primarily) */
 150
 151     struct Odr_private *op;
 152 } *ODR;
 153
 154 typedef int (*Odr_fun)(ODR, char **, int, const char *);
 155
 156 typedef struct odr_arm
 157 {
 158     int tagmode;
 159     int zclass;
 160     int tag;
 161     int which;
 162     Odr_fun fun;
 163     char *name;
 164 } Odr_arm;
 165
 166 /*
 167  * Error control.
 168  */
 169 #define ONONE           0
 170 #define OMEMORY         1
 171 #define OSYSERR         2
 172 #define OSPACE          3
 173 #define OREQUIRED       4
 174 #define OUNEXPECTED     5
 175 #define OOTHER          6
 176 #define OPROTO          7
 177 #define ODATA           8
 178 #define OSTACK          9
 179 #define OCONLEN        10
 180 #define OLENOV         11
 181
 182 extern char *odr_errlist[];
 183
 184 YAZ_EXPORT int odr_geterror(ODR o);
 185 YAZ_EXPORT void odr_perror(ODR o, char *message);
 186 YAZ_EXPORT void odr_setprint(ODR o, FILE *file);
 187 YAZ_EXPORT ODR odr_createmem(int direction);
 188 YAZ_EXPORT void odr_reset(ODR o);
 189 YAZ_EXPORT void odr_destroy(ODR o);
 190 YAZ_EXPORT void odr_setbuf(ODR o, char *buf, int len, int can_grow);
 191 YAZ_EXPORT char *odr_getbuf(ODR o, int *len, int *size);
 192 YAZ_EXPORT void *odr_malloc(ODR o, int size);
 193 YAZ_EXPORT char *odr_strdup(ODR o, const char *str);
 194 YAZ_EXPORT int *odr_intdup(ODR o, int v);
 195 YAZ_EXPORT NMEM odr_extract_mem(ODR o);
 196 YAZ_EXPORT Odr_null *odr_nullval(void);
 197 #define odr_release_mem(m) nmem_destroy(m)
 198 #define ODR_MEM NMEM
 199
 200 #define odr_implicit(o, t, p, cl, tg, opt)\
 201         (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), 0) )
 202
 203 #define odr_implicit_tag(o, t, p, cl, tg, opt, name)\
 204         (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), name) )
 205
 206 #define odr_explicit(o, t, p, cl, tg, opt)\
 207         ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
 208         t ((o), (p), (opt), 0) &&\
 209         odr_constructed_end(o) : opt))
 210
 211 #define odr_explicit_tag(o, t, p, cl, tg, opt, name)\
 212         ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
 213         t ((o), (p), (opt), name) &&\
 214         odr_constructed_end(o) : opt))
 215
 216 #define ODR_MASK_ZERO(mask)\
 217     ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
 218     (mask)->top = -1))
 219
 220 #define ODR_MASK_SET(mask, num)\
 221     (((mask)->bits[(num) >> 3] |= 0X80 >> ((num) & 0X07)),\
 222     (mask)->top < (num) >> 3 ? ((mask)->top = (num) >> 3) : 0)
 223
 224 #define ODR_MASK_CLEAR(mask, num)\
 225     ((mask)->bits[(num) >> 3] &= ~(0X80 >> ((num) & 0X07)))
 226
 227 #define ODR_MASK_GET(mask, num)  ( ((num) >> 3 <= (mask)->top) ? \
 228     ((mask)->bits[(num) >> 3] & (0X80 >> ((num) & 0X07)) ? 1 : 0) : 0)
 229
 230
 231 #define odr_tell(o) ((o)->pos)
 232 #define odr_offset(o) ((o)->bp - (o)->buf)
 233 #define odr_ok(o) (!(o)->error)
 234 #define odr_getmem(o) ((o)->mem)
 235 #define odr_setmem(o, v) ((o)->mem = (v))
 236
 237 #define ODR_MAXNAME 256
 238
 239 YAZ_EXPORT int ber_boolean(ODR o, int *val);
 240 YAZ_EXPORT int ber_tag(ODR o, void *p, int zclass, int tag,
 241                        int *constructed, int opt);
 242 YAZ_EXPORT int ber_enctag(ODR o, int zclass, int tag, int constructed);
 243 YAZ_EXPORT int ber_dectag(const unsigned char *buf, int *zclass,
 244                           int *tag, int *constructed);
 245 YAZ_EXPORT int odr_bool(ODR o, int **p, int opt, const char *name);
 246 YAZ_EXPORT int odr_integer(ODR o, int **p, int opt, const char *name);
 247 YAZ_EXPORT int odr_enum(ODR o, int **p, int opt, const char *name);
 248 YAZ_EXPORT int odr_implicit_settag(ODR o, int zclass, int tag);
 249 YAZ_EXPORT int ber_enclen(ODR o, int len, int lenlen, int exact);
 250 YAZ_EXPORT int ber_declen(const unsigned char *buf, int *len);
 251 YAZ_EXPORT void odr_prname(ODR o, const char *name);
 252 YAZ_EXPORT int ber_null(ODR o);
 253 YAZ_EXPORT int odr_null(ODR o, Odr_null **p, int opt, const char *name);
 254 YAZ_EXPORT int ber_integer(ODR o, int *val);
 255 YAZ_EXPORT int odr_constructed_begin(ODR o, void *p, int zclass, int tag,
 256                                      const char *name);
 257 YAZ_EXPORT int odr_constructed_end(ODR o);
 258 YAZ_EXPORT int odr_sequence_begin(ODR o, void *p, int size, const char *name);
 259 YAZ_EXPORT int odr_set_begin(ODR o, void *p, int size, const char *name);
 260 YAZ_EXPORT int odr_sequence_end(ODR o);
 261 YAZ_EXPORT int odr_set_end(ODR o);
 262 YAZ_EXPORT int ber_octetstring(ODR o, Odr_oct *p, int cons);
 263 YAZ_EXPORT int odr_octetstring(ODR o, Odr_oct **p, int opt, const char *name);
 264 YAZ_EXPORT int odp_more_chunks(ODR o, const unsigned char *base, int len);
 265 YAZ_EXPORT int odr_constructed_more(ODR o);
 266 YAZ_EXPORT int odr_bitstring(ODR o, Odr_bitmask **p, int opt,
 267                              const char *name);
 268 YAZ_EXPORT int ber_bitstring(ODR o, Odr_bitmask *p, int cons);
 269 YAZ_EXPORT int odr_generalstring(ODR o, char **p, int opt, const char *name);
 270 YAZ_EXPORT int ber_oidc(ODR o, Odr_oid *p);
 271 YAZ_EXPORT int odr_oid(ODR o, Odr_oid **p, int opt, const char *name);
 272 YAZ_EXPORT int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp,
 273                           const char *name);
 274 YAZ_EXPORT int odr_cstring(ODR o, char **p, int opt, const char *name);
 275 YAZ_EXPORT int odr_iconv_string(ODR o, char **p, int opt, const char *name);
 276 YAZ_EXPORT int odr_sequence_of(ODR o, Odr_fun type, void *p, int *num,
 277                                const char *name);
 278 YAZ_EXPORT int odr_set_of(ODR o, Odr_fun type, void *p, int *num,
 279                           const char *name);
 280 YAZ_EXPORT int odr_any(ODR o, Odr_any **p, int opt, const char *name);
 281 YAZ_EXPORT int ber_any(ODR o, Odr_any **p);
 282 YAZ_EXPORT int completeBER(const unsigned char *buf, int len);
 283 YAZ_EXPORT void odr_begin(ODR o);
 284 YAZ_EXPORT void odr_end(ODR o);
 285 YAZ_EXPORT Odr_oid *odr_oiddup(ODR odr, Odr_oid *o);
 286 YAZ_EXPORT Odr_oid *odr_oiddup_nmem(NMEM nmem, Odr_oid *o);
 287 YAZ_EXPORT int odr_grow_block(ODR b, int min_bytes);
 288 YAZ_EXPORT int odr_write(ODR o, unsigned char *buf, int bytes);
 289 YAZ_EXPORT int odr_seek(ODR o, int whence, int offset);
 290 YAZ_EXPORT int odr_dumpBER(FILE *f, const char *buf, int len);
 291 YAZ_EXPORT void odr_choice_bias(ODR o, int what);
 292 YAZ_EXPORT void odr_choice_enable_bias(ODR o, int mode);
 293 YAZ_EXPORT int odr_total(ODR o);
 294 YAZ_EXPORT char *odr_errmsg(int n);
 295 YAZ_EXPORT Odr_oid *odr_getoidbystr(ODR o, const char *str);
 296 YAZ_EXPORT Odr_oid *odr_getoidbystr_nmem(NMEM o, const char *str);
 297
 298 YAZ_EXPORT int odr_initmember(ODR o, void *p, int size);
 299 YAZ_EXPORT int odr_peektag(ODR o, int *zclass, int *tag, int *cons);
 300 YAZ_EXPORT void odr_setlenlen(ODR o, int len);
 301
 302 typedef struct Odr_external
 303 {
 304     Odr_oid *direct_reference;       /* OPTIONAL */
 305     int     *indirect_reference;     /* OPTIONAL */
 306     char    *descriptor;             /* OPTIONAL */
 307     int which;
 308 #define ODR_EXTERNAL_single 0
 309 #define ODR_EXTERNAL_octet 1
 310 #define ODR_EXTERNAL_arbitrary 2
 311     union
 312     {
 313         Odr_any  *single_ASN1_type;
 314         Odr_oct  *octet_aligned;
 315         Odr_bitmask *arbitrary;      /* we aren't really equipped for this*/
 316     } u;
 317 } Odr_external;
 318
 319 YAZ_EXPORT int odr_external(ODR o, Odr_external **p, int opt,
 320                             const char *name);
 321 YAZ_EXPORT int odr_visiblestring(ODR o, char **p, int opt,
 322                                  const char *name);
 323 YAZ_EXPORT int odr_graphicstring(ODR o, char **p, int opt,
 324                                  const char *name);
 325 YAZ_EXPORT int odr_generalizedtime(ODR o, char **p, int opt,
 326                                    const char *name);
 327
 328 YAZ_EXPORT int odr_set_charset(ODR o, const char *to, const char *from);
 329
 330 YAZ_END_CDECL
 331
 332 #include <yaz/xmalloc.h>
 333
 334 #endif