Changed the way implementationName - and version is set.
[yaz-moved-to-github.git] / include / odr.h
index fa59a53..c4eecd9 100644 (file)
@@ -1,65 +1,29 @@
-
 /*
- * Copyright (C) 1994, Index Data I/S 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: odr.h,v $
- * Revision 1.3  1995-05-15 11:55:54  quinn
- * Work on asynchronous activity.
- *
- * Revision 1.2  1995/04/18  08:14:37  quinn
- * Added dynamic memory allocation on encoding
- *
- * Revision 1.1  1995/03/30  09:39:41  quinn
- * Moved .h files to include directory
- *
- * Revision 1.15  1995/03/29  15:39:57  quinn
- * Fixed bugs in the bitmask operations
- *
- * Revision 1.14  1995/03/27  08:33:15  quinn
- * Added more OID utilities.
- *
- * Revision 1.13  1995/03/17  10:17:44  quinn
- * Added memory management.
- *
- * Revision 1.12  1995/03/14  10:27:38  quinn
- * Modified makefile to use common lib
- * Beginning to add memory management to odr
- *
- * Revision 1.11  1995/03/10  11:44:41  quinn
- * Fixed serious stack-bug in odr_cons_begin
- *
- * Revision 1.10  1995/03/08  12:12:16  quinn
- * Added better error checking.
- *
- * Revision 1.9  1995/03/07  10:10:00  quinn
- * Added some headers for Adam.
- *
- * Revision 1.8  1995/03/07  09:23:16  quinn
- * Installing top-level API and documentation.
- *
- * Revision 1.7  1995/02/10  15:55:29  quinn
- * Bug fixes, mostly.
- *
- * Revision 1.6  1995/02/09  15:51:47  quinn
- * Works better now.
+ * Copyright (c) 1995-1999, Index Data.
  *
- * Revision 1.5  1995/02/07  17:52:59  quinn
- * A damn mess, but now things work, I think.
+ * Permission to use, copy, modify, distribute, and sell this software and
+ * its documentation, in whole or in part, for any purpose, is hereby granted,
+ * provided that:
  *
- * Revision 1.4  1995/02/06  16:45:03  quinn
- * Small mods.
+ * 1. This copyright and permission notice appear in all copies of the
+ * software and its documentation. Notices of copyright or attribution
+ * which appear at the beginning of any file must remain unchanged.
  *
- * Revision 1.3  1995/02/03  17:04:36  quinn
- * *** empty log message ***
+ * 2. The name of Index Data or the individual authors may not be used to
+ * endorse or promote products derived from this software without specific
+ * prior written permission.
  *
- * Revision 1.2  1995/02/02  20:38:50  quinn
- * Updates.
- *
- * Revision 1.1  1995/02/02  16:21:53  quinn
- * First kick.
+ * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
+ * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
+ * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
+ * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
+ * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
+ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+ * OF THIS SOFTWARE.
  *
+ * $Id: odr.h,v 1.29 1999-04-20 09:56:48 adam Exp $
  */
 
 #ifndef ODR_H
 #include <stdio.h>
 #include <string.h>
 
+#include <nmem.h>
+#include <yconfig.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #ifndef bool_t
 #define bool_t int
 #endif
 #define ODR_SET         17
 #define ODR_NUMERICSTRING   18
 #define ODR_PRINTABLESTRING 19
+#define ODR_GENERALIZEDTIME 24
 #define ODR_GRAPHICSTRING   25
 #define ODR_VISIBLESTRING   26
+#define ODR_GENERALSTRING   27
 
 /*
  * odr stream directions
@@ -121,6 +94,9 @@ typedef struct odr_oct
     int size;
 } Odr_oct;
 
+typedef void Odr_null;
+extern Odr_null *ODR_NULLVAL;
+
 typedef Odr_oct Odr_any;
 
 typedef struct odr_bitmask
@@ -130,23 +106,19 @@ typedef struct odr_bitmask
     int top;
 } Odr_bitmask;
 
-#define ODR_OID_SIZE 100
 typedef int Odr_oid;   /* terminate by -1 */
 
 typedef struct odr_constack
 {
-    unsigned char *base;         /* starting point of data */
+    const unsigned char *base;   /* starting point of data */
     int base_offset;
     int len;                     /* length of data, if known, else -1
-                                       (decoding only) */
-    unsigned char *lenb;         /* where to encode length */
+                                        (decoding only) */
+    const unsigned char *lenb;   /* where to encode length */
     int len_offset;
     int lenlen;                  /* length of length-field */
 } odr_constack;
 
-struct odr_memblock; /* defined in odr_mem.c */
-typedef struct odr_memblock *ODR_MEM;
-
 #define ODR_S_SET     0
 #define ODR_S_CUR     1
 #define ODR_S_END     2
@@ -160,15 +132,21 @@ typedef struct odr_ecblock
     int size;             /* current buffer size */
 } odr_ecblock;
 
+typedef struct {      /* used to be statics in ber_tag... */
+    int lclass;
+    int ltag;
+    int br;
+    int lcons;
+} Odr_ber_tag;
 
 typedef struct odr
 {
     int direction;       /* the direction of this stream */
 
     int error;           /* current error state (0==OK) */
-    unsigned char *buf;  /* for encoding or decoding */
+    const unsigned char *buf;  /* for encoding or decoding */
     int buflen;          /* size of buffer for encoding, len for decoding */
-    unsigned char *bp;   /* position in buffer */
+    const unsigned char *bp;   /* position in buffer */
     int left;            /* bytes remaining in buffer */
 
     odr_ecblock ecb;     /* memory control block */
@@ -176,63 +154,83 @@ typedef struct odr
     int t_class;         /* implicit tagging (-1==default tag) */
     int t_tag;
 
+    int enable_bias;     /* force choice enable flag */
+    int choice_bias;     /* force choice */
+    int lenlen;          /* force length-of-lenght (odr_setlen()) */
+
     FILE *print;         /* output file for direction print */
     int indent;          /* current indent level for printing */
 
-    struct odr_memblock *mem;
+    NMEM mem;            /* memory handle for decoding (primarily) */
 
     /* stack for constructed types */
 #define ODR_MAX_STACK 50
     int stackp;          /* top of stack (-1 == initial state) */
     odr_constack stack[ODR_MAX_STACK];
+
+    Odr_ber_tag odr_ber_tag;
 } *ODR;
 
-typedef int (*Odr_fun)();
+typedef int (*Odr_fun)(ODR, char **, int, const char *);
 
 typedef struct odr_arm
 {
     int tagmode;
-    int class;
+    int zclass;
     int tag;
     int which;
     Odr_fun fun;
+    char *name;
 } Odr_arm;
 
 /*
  * Error control.
  */
-#define ONONE          0
-#define OMEMORY                1
-#define OSYSERR                2
-#define OSPACE         3
-#define OREQUIRED      4
-#define OUNEXPECTED    5
-#define OOTHER         6
-#define OPROTO         7
-#define ODATA          8
+#define ONONE           0
+#define OMEMORY         1
+#define OSYSERR         2
+#define OSPACE          3
+#define OREQUIRED       4
+#define OUNEXPECTED     5
+#define OOTHER          6
+#define OPROTO          7
+#define ODATA           8
 #define OSTACK          9
+#define OCONLEN        10
+#define OLENOV         11
 
 extern char *odr_errlist[];
 
-int odr_geterror(ODR o);
-void odr_perror(ODR o, char *message);
-void odr_setprint(ODR o, FILE *file);
-ODR odr_createmem(int direction);
-void odr_reset(ODR o);
-void odr_destroy(ODR o);
-void odr_setbuf(ODR o, char *buf, int len, int can_grow);
-char *odr_getbuf(ODR o, int *len, int *size);
-void *odr_malloc(ODR o, int size);
-ODR_MEM odr_extract_mem(ODR o);
-void odr_release_mem(ODR_MEM p);
+YAZ_EXPORT int odr_geterror(ODR o);
+YAZ_EXPORT void odr_perror(ODR o, char *message);
+YAZ_EXPORT void odr_setprint(ODR o, FILE *file);
+YAZ_EXPORT ODR odr_createmem(int direction);
+YAZ_EXPORT void odr_reset(ODR o);
+YAZ_EXPORT void odr_destroy(ODR o);
+YAZ_EXPORT void odr_setbuf(ODR o, char *buf, int len, int can_grow);
+YAZ_EXPORT char *odr_getbuf(ODR o, int *len, int *size);
+YAZ_EXPORT void *odr_malloc(ODR o, int size);
+YAZ_EXPORT char *odr_strdup(ODR o, const char *str);
+YAZ_EXPORT NMEM odr_extract_mem(ODR o);
+YAZ_EXPORT Odr_null *odr_nullval(void);
+#define odr_release_mem(m) nmem_destroy(m)
+#define ODR_MEM NMEM
 
 #define odr_implicit(o, t, p, cl, tg, opt)\
-       (odr_implicit_settag((o), cl, tg), t ((o), (p), opt) )
+        (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), 0) )
+
+#define odr_implicit_tag(o, t, p, cl, tg, opt, name)\
+        (odr_implicit_settag((o), cl, tg), t ((o), (p), (opt), name) )
 
 #define odr_explicit(o, t, p, cl, tg, opt)\
-       ((int) (odr_constructed_begin((o), (p), (cl), (tg)) ? \
-       t ((o), (p), (opt)) &&\
-       odr_constructed_end(o) : opt))
+        ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
+        t ((o), (p), (opt), 0) &&\
+        odr_constructed_end(o) : opt))
+
+#define odr_explicit_tag(o, t, p, cl, tg, opt, name)\
+        ((int) (odr_constructed_begin((o), (p), (cl), (tg), 0) ? \
+        t ((o), (p), (opt), name) &&\
+        odr_constructed_end(o) : opt))
 
 #define ODR_MASK_ZERO(mask)\
     ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
@@ -248,49 +246,118 @@ void odr_release_mem(ODR_MEM p);
 #define ODR_MASK_GET(mask, num)  ( ((num) >> 3 <= (mask)->top) ? \
     ((mask)->bits[(num) >> 3] & (0X80 >> ((num) & 0X07)) ? 1 : 0) : 0)
 
-/*
+/* Private macro.
  * write a single character at the current position - grow buffer if
  * necessary.
- * (no, we're not usually this anal about our macros, but this one is
+ * (no, we're not usually this anal about our macros, but this baby is
  *  next to unreadable without some indentation  :)
  */
 #define odr_putc(o, c) \
 ( \
     ( \
-       (o)->ecb.pos < (o)->ecb.size ? \
-       ( \
-           (o)->ecb.buf[(o)->ecb.pos++] = (c), \
-           0 \
-       ) : \
-       ( \
-           odr_grow_block(&(o)->ecb, 1) == 0 ? \
-           ( \
-               (o)->ecb.buf[(o)->ecb.pos++] = (c), \
-               0 \
-           ) : \
-           ( \
-               (o)->error = OSPACE, \
-               -1 \
-           ) \
-       ) \
+        (o)->ecb.pos < (o)->ecb.size ? \
+        ( \
+            (o)->ecb.buf[(o)->ecb.pos++] = (c), \
+            0 \
+        ) : \
+        ( \
+            odr_grow_block(&(o)->ecb, 1) == 0 ? \
+            ( \
+                (o)->ecb.buf[(o)->ecb.pos++] = (c), \
+                0 \
+            ) : \
+            ( \
+                (o)->error = OSPACE, \
+                -1 \
+            ) \
+        ) \
     ) == 0 ? \
     ( \
-       (o)->ecb.pos > (o)->ecb.top ? \
-       ( \
-           (o)->ecb.top = (o)->ecb.pos, \
-           0 \
-       ) : \
-       0 \
+        (o)->ecb.pos > (o)->ecb.top ? \
+        ( \
+            (o)->ecb.top = (o)->ecb.pos, \
+            0 \
+        ) : \
+        0 \
     ) : \
-       -1 \
+        -1 \
 ) \
 
 #define odr_tell(o) ((o)->ecb.pos)
-#define odr_ok(o) (!(o)->ecb.error)
+#define odr_offset(o) ((o)->bp - (o)->buf)
+#define odr_ok(o) (!(o)->error)
+#define odr_getmem(o) ((o)->mem)
+#define odr_setmem(o, v) ((o)->mem = (v))
 
 #define ODR_MAXNAME 256
 
-#include <prt.h>
-#include <dmalloc.h>
+YAZ_EXPORT int ber_boolean(ODR o, int *val);
+YAZ_EXPORT int ber_tag(ODR o, void *p, int zclass, int tag,
+                      int *constructed, int opt);
+YAZ_EXPORT int ber_enctag(ODR o, int zclass, int tag, int constructed);
+YAZ_EXPORT int ber_dectag(const unsigned char *buf, int *zclass,
+                         int *tag, int *constructed);
+YAZ_EXPORT int odr_bool(ODR o, int **p, int opt, const char *name);
+YAZ_EXPORT int odr_integer(ODR o, int **p, int opt, const char *name);
+YAZ_EXPORT int odr_enum(ODR o, int **p, int opt, const char *name);
+YAZ_EXPORT int odr_implicit_settag(ODR o, int zclass, int tag);
+YAZ_EXPORT int ber_enclen(ODR o, int len, int lenlen, int exact);
+YAZ_EXPORT int ber_declen(const unsigned char *buf, int *len);
+YAZ_EXPORT void odr_prname(ODR o, const char *name);
+YAZ_EXPORT int ber_null(ODR o);
+YAZ_EXPORT int odr_null(ODR o, Odr_null **p, int opt, const char *name);
+YAZ_EXPORT int ber_integer(ODR o, int *val);
+YAZ_EXPORT int odr_constructed_begin(ODR o, void *p, int zclass, int tag,
+                                    const char *name);
+YAZ_EXPORT int odr_constructed_end(ODR o);
+YAZ_EXPORT int odr_sequence_begin(ODR o, void *p, int size, const char *name);
+YAZ_EXPORT int odr_set_begin(ODR o, void *p, int size, const char *name);
+YAZ_EXPORT int odr_sequence_end(ODR o);
+YAZ_EXPORT int odr_set_end(ODR o);
+YAZ_EXPORT int ber_octetstring(ODR o, Odr_oct *p, int cons);
+YAZ_EXPORT int odr_octetstring(ODR o, Odr_oct **p, int opt, const char *name);
+YAZ_EXPORT int odp_more_chunks(ODR o, const unsigned char *base, int len);
+YAZ_EXPORT int odr_constructed_more(ODR o);
+YAZ_EXPORT int odr_bitstring(ODR o, Odr_bitmask **p, int opt,
+                            const char *name);
+YAZ_EXPORT int ber_bitstring(ODR o, Odr_bitmask *p, int cons);
+YAZ_EXPORT int odr_generalstring(ODR o, char **p, int opt, const char *name);
+YAZ_EXPORT int ber_oidc(ODR o, Odr_oid *p);
+YAZ_EXPORT int odr_oid(ODR o, Odr_oid **p, int opt, const char *name);
+YAZ_EXPORT int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp,
+                         const char *name);
+YAZ_EXPORT int odr_cstring(ODR o, char **p, int opt, const char *name);
+YAZ_EXPORT int odr_sequence_of(ODR o, Odr_fun type, void *p, int *num,
+                              const char *name);
+YAZ_EXPORT int odr_set_of(ODR o, Odr_fun type, void *p, int *num,
+                         const char *name);
+YAZ_EXPORT int odr_any(ODR o, Odr_any **p, int opt, const char *name);
+YAZ_EXPORT int ber_any(ODR o, Odr_any **p);
+YAZ_EXPORT int completeBER(const unsigned char *buf, int len);
+YAZ_EXPORT void odr_begin(ODR o);
+YAZ_EXPORT void odr_end(ODR o);
+YAZ_EXPORT Odr_oid *odr_oiddup(ODR odr, Odr_oid *o);
+YAZ_EXPORT Odr_oid *odr_oiddup_nmem(NMEM nmem, Odr_oid *o);
+YAZ_EXPORT int odr_grow_block(odr_ecblock *b, int min_bytes);
+YAZ_EXPORT int odr_write(ODR o, unsigned char *buf, int bytes);
+YAZ_EXPORT int odr_seek(ODR o, int whence, int offset);
+YAZ_EXPORT int odr_dumpBER(FILE *f, const char *buf, int len);
+YAZ_EXPORT void odr_choice_bias(ODR o, int what);
+YAZ_EXPORT void odr_choice_enable_bias(ODR o, int mode);
+YAZ_EXPORT int odr_total(ODR o);
+YAZ_EXPORT char *odr_errmsg(int n);
+YAZ_EXPORT Odr_oid *odr_getoidbystr(ODR o, char *str);
+YAZ_EXPORT Odr_oid *odr_getoidbystr_nmem(NMEM o, char *str);
+YAZ_EXPORT int odr_initmember(ODR o, void *p, int size);
+YAZ_EXPORT int odr_peektag(ODR o, int *zclass, int *tag, int *cons);
+YAZ_EXPORT void odr_setlenlen(ODR o, int len);
+
+#ifdef __cplusplus
+}
+#endif
+
+#include <odr_use.h>
+
+#include <xmalloc.h>
 
 #endif