Implemented data1_add_insert_taggeddata utility which is more flexible
[yaz-moved-to-github.git] / include / odr.h
index fa59a53..9af4c88 100644 (file)
@@ -1,11 +1,99 @@
-
 /*
- * Copyright (C) 1994, Index Data I/S 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
+ * Copyright (c) 1995-1998, Index Data.
+ *
+ * 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:
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * 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.
  *
  * $Log: odr.h,v $
- * Revision 1.3  1995-05-15 11:55:54  quinn
+ * Revision 1.25  1998-02-11 11:53:33  adam
+ * Changed code so that it compiles as C++.
+ *
+ * Revision 1.24  1997/11/24 11:33:56  adam
+ * Using function odr_nullval() instead of global ODR_NULLVAL when
+ * appropriate.
+ *
+ * Revision 1.23  1997/09/01 08:49:49  adam
+ * New windows NT/95 port using MSV5.0. To export DLL functions the
+ * YAZ_EXPORT modifier was added. Defined in yconfig.h.
+ *
+ * Revision 1.22  1997/07/21 12:44:30  adam
+ * Moved definitions of nmem_block and nmem_control.
+ *
+ * Revision 1.21  1997/05/14 06:53:41  adam
+ * C++ support.
+ *
+ * Revision 1.20  1997/04/30 08:52:08  quinn
+ * Null
+ *
+ * Revision 1.19  1996/10/08  12:58:08  adam
+ * New ODR function, odr_choice_enable_bias, to control behaviour of
+ * odr_choice_bias.
+ *
+ * Revision 1.18  1996/07/26  13:38:14  quinn
+ * Various smaller things. Gathered header-files.
+ *
+ * Revision 1.17  1995/11/08  17:41:27  quinn
+ * Smallish.
+ *
+ * Revision 1.16  1995/11/01  13:54:36  quinn
+ * Minor adjustments
+ *
+ * Revision 1.15  1995/10/18  16:12:36  quinn
+ * Better diagnostics.
+ *
+ * Revision 1.14  1995/09/29  17:12:04  quinn
+ * Smallish
+ *
+ * Revision 1.13  1995/09/29  17:01:49  quinn
+ * More Windows work
+ *
+ * Revision 1.12  1995/09/27  15:02:48  quinn
+ * Modified function heads & prototypes.
+ *
+ * Revision 1.11  1995/08/15  12:00:09  quinn
+ * Updated External
+ *
+ * Revision 1.10  1995/08/10  08:54:33  quinn
+ * Added Explain.
+ *
+ * Revision 1.9  1995/06/19  12:38:26  quinn
+ * Reorganized include-files. Added small features.
+ *
+ * Revision 1.8  1995/06/16  13:16:04  quinn
+ * Fixed Defaultdiagformat.
+ *
+ * Revision 1.7  1995/05/29  08:11:32  quinn
+ * Moved oid from odr/asn to util.
+ *
+ * Revision 1.6  1995/05/22  14:47:00  quinn
+ * ODR_NULLVAL --> void
+ *
+ * Revision 1.5  1995/05/22  11:31:24  quinn
+ * Added PDUs
+ *
+ * Revision 1.4  1995/05/16  08:50:33  quinn
+ * License, documentation, and memory fixes
+ *
+ * Revision 1.3  1995/05/15  11:55:54  quinn
  * Work on asynchronous activity.
  *
  * Revision 1.2  1995/04/18  08:14:37  quinn
 #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 +218,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,7 +230,6 @@ typedef struct odr_bitmask
     int top;
 } Odr_bitmask;
 
-#define ODR_OID_SIZE 100
 typedef int Odr_oid;   /* terminate by -1 */
 
 typedef struct odr_constack
@@ -138,15 +237,12 @@ typedef struct odr_constack
     unsigned char *base;         /* starting point of data */
     int base_offset;
     int len;                     /* length of data, if known, else -1
-                                       (decoding only) */
+                                        (decoding only) */
     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,6 +256,12 @@ 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
 {
@@ -176,23 +278,29 @@ 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);
 
 typedef struct odr_arm
 {
     int tagmode;
-    int class;
+    int zclass;
     int tag;
     int which;
     Odr_fun fun;
@@ -201,38 +309,42 @@ typedef struct 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 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) )
 
 #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)) ? \
+        t ((o), (p), (opt)) &&\
+        odr_constructed_end(o) : opt))
 
 #define ODR_MASK_ZERO(mask)\
     ((void) (memset((mask)->bits, 0, ODR_BITMASK_SIZE),\
@@ -248,49 +360,56 @@ 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
 
+#ifdef __cplusplus
+}
+#endif
+
 #include <prt.h>
-#include <dmalloc.h>
+#include <xmalloc.h>
 
 #endif