include/data1.h

   1 /*
   2  * Copyright (c) 1995, 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 names 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  * $Log: data1.h,v $
  27  * Revision 1.3  1995-11-01 16:34:52  quinn
  28  * Making data1 look for tables in data1_tabpath
  29  *
  30  * Revision 1.2  1995/11/01  13:54:35  quinn
  31  * Minor adjustments
  32  *
  33  * Revision 1.1  1995/11/01  13:07:18  quinn
  34  * Data1 module now lives in YAZ.
  35  *
  36  * Revision 1.13  1995/10/25  16:00:49  quinn
  37  * USMARC support is now almost operational
  38  *
  39  * Revision 1.12  1995/10/16  14:02:59  quinn
  40  * Changes to support element set names and espec1
  41  *
  42  * Revision 1.11  1995/10/13  16:05:10  quinn
  43  * Adding Espec1-processing
  44  *
  45  * Revision 1.10  1995/10/11  14:53:46  quinn
  46  * Work on variants.
  47  *
  48  * Revision 1.9  1995/10/10  16:27:59  quinn
  49  * *** empty log message ***
  50  *
  51  * Revision 1.8  1995/10/06  16:44:14  quinn
  52  * Work on attribute set mapping, etc.
  53  *
  54  * Revision 1.7  1995/10/06  12:58:36  quinn
  55  * SUTRS support
  56  *
  57  * Revision 1.6  1995/10/04  09:29:51  quinn
  58  * Adjustments to support USGS test data
  59  *
  60  * Revision 1.5  1995/10/03  17:56:44  quinn
  61  * Fixing GRS code.
  62  *
  63  * Revision 1.4  1995/10/02  14:55:43  quinn
  64  * *** empty log message ***
  65  *
  66  * Revision 1.3  1995/09/15  14:41:43  quinn
  67  * GRS1 work
  68  *
  69  * Revision 1.2  1995/09/14  15:18:14  quinn
  70  * Work
  71  *
  72  * Revision 1.1  1995/09/12  11:24:33  quinn
  73  * Beginning to add code for structured records.
  74  *
  75  *
  76  */
  77
  78 #ifndef DATA1_H
  79 #define DATA1_H
  80
  81 #include <stdio.h>
  82
  83 #include <oid.h>
  84 #include <proto.h>
  85
  86 #include <d1_attset.h>
  87 #include <d1_map.h>
  88
  89 extern char *data1_tabpath; /* global path for tables */
  90
  91 #define DATA1_MAX_SYMBOL 31
  92
  93 typedef struct data1_name
  94 {
  95     char *name;
  96     struct data1_name *next;
  97 } data1_name;
  98
  99 typedef enum data1_datatype
 100 {
 101     DATA1K_structured = 1,
 102     DATA1K_string,
 103     DATA1K_numeric,
 104     DATA1K_bool,
 105     DATA1K_oid,
 106     DATA1K_generalizedtime,
 107     DATA1K_intunit,
 108     DATA1K_int,
 109     DATA1K_octetstring,
 110     DATA1K_null
 111 } data1_datatype;
 112
 113 typedef struct data1_marctab
 114 {
 115     char *name;
 116     oid_value reference;
 117
 118     char record_status[2];
 119     char implementation_codes[5];
 120     int  indicator_length;
 121     int  identifier_length;
 122     char user_systems[4];
 123
 124     int  length_data_entry;
 125     int  length_starting;
 126     int  length_implementation;
 127     char future_use[2];
 128
 129     struct data1_marctab *next;
 130 } data1_marctab;
 131
 132 typedef struct data1_esetname
 133 {
 134     char *name;
 135     Z_Espec1 *spec;
 136     struct data1_esetname *next;
 137 } data1_esetname;
 138
 139 /*
 140  * Variant set definitions.
 141  */
 142
 143 typedef struct data1_vartype
 144 {
 145     char *name;
 146     struct data1_varclass *class;
 147     int type;
 148     data1_datatype datatype;
 149     struct data1_vartype *next;
 150 } data1_vartype;
 151
 152 typedef struct data1_varclass
 153 {
 154     char *name;
 155     struct data1_varset *set;
 156     int class;
 157     data1_vartype *types;
 158     struct data1_varclass *next;
 159 } data1_varclass;
 160
 161 typedef struct data1_varset
 162 {
 163     char *name;
 164     oid_value reference;
 165     data1_varclass *classes;
 166 } data1_varset;
 167
 168 /*
 169  * Tagset definitions
 170  */
 171
 172 struct data1_tagset;
 173
 174 typedef struct data1_tag
 175 {
 176     data1_name *names;
 177     enum
 178     {
 179         DATA1T_numeric,
 180         DATA1T_string
 181     } which;
 182     union
 183     {
 184         int numeric;
 185         char *string;
 186     } value;
 187     data1_datatype kind;
 188
 189     struct data1_tagset *tagset;
 190     struct data1_tag *next;
 191 } data1_tag;
 192
 193 typedef struct data1_tagset
 194 {
 195     char *name;                      /* symbolic name */
 196     oid_value reference;
 197     int type;                        /* type of tagset in current context */
 198     data1_tag *tags;                 /* tags defined by this set */
 199     struct data1_tagset *children;   /* included tagsets */
 200     struct data1_tagset *next;       /* sibling */
 201 } data1_tagset;
 202
 203 /*
 204  * abstract syntax specification
 205  */
 206
 207 typedef struct data1_element
 208 {
 209     char *name;
 210     data1_tag *tag;
 211     data1_att *att;
 212     struct data1_element *children;
 213     struct data1_element *next;
 214 } data1_element;
 215
 216 typedef struct data1_absyn
 217 {
 218     char *name;
 219     oid_value reference;
 220     data1_tagset *tagset;
 221     data1_attset *attset;
 222     data1_varset *varset;
 223     data1_esetname *esetnames;
 224     data1_maptab *maptabs;
 225     data1_marctab *marc;
 226     data1_element *elements;
 227 } data1_absyn;
 228
 229 /*
 230  * record data node (tag/data/variant)
 231  */
 232
 233 typedef struct data1_node
 234 {
 235     enum
 236     {
 237         DATA1N_root,
 238         DATA1N_tag,         /* a tag */
 239         DATA1N_data,        /* */
 240         DATA1N_variant,     /* variant specification */
 241         DATA1N_indicator    /* ISO2709 indicator */
 242     } which;
 243
 244     union
 245     {
 246         struct
 247         {
 248             char *type;
 249             data1_absyn *absyn;  /* abstract syntax for this type */
 250         } root;
 251
 252         struct
 253         {
 254             char *tag;
 255             data1_element *element;
 256             int node_selected;
 257         } tag;
 258
 259         struct
 260         {
 261             enum
 262             {
 263                 DATA1I_inctxt,      /* text inclusion */
 264                 DATA1I_incbin,      /* binary data inclusion */
 265                 DATA1I_text,        /* text data */
 266                 DATA1I_num          /* numerical data */
 267             } what;
 268             int len;
 269             char *data;      /* filename or data */
 270 #define DATA1_LOCALDATA 15
 271             char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
 272         } data;
 273
 274         struct
 275         {
 276             data1_vartype *type;
 277             char *value;
 278         } variant;
 279
 280         struct
 281         {
 282             char *ind;
 283         } indicator;
 284     } u;
 285
 286     int line;
 287     int num_children;
 288     struct data1_node *next;
 289     struct data1_node *child;
 290     struct data1_node *parent;
 291     struct data1_node *root;
 292 } data1_node;
 293
 294 data1_node *get_parent_tag(data1_node *n);
 295 data1_node *data1_read_node(char **buf, data1_node *parent, int *line,
 296     data1_absyn *absyn);
 297 data1_node *data1_read_record(int (*rf)(int, char *, size_t), int fd);
 298 data1_absyn *data1_read_absyn(char *file);
 299 data1_tag *data1_gettagbynum(data1_tagset *s, int type, int value);
 300 data1_tagset *data1_read_tagset(char *file);
 301 data1_element *data1_getelementbytagname(data1_absyn *abs,
 302     data1_element *parent, char *tagname);
 303 Z_GenericRecord *data1_nodetogr(data1_node *n, int select, ODR o);
 304 int data1_matchstr(char *s1, char *s2);
 305 data1_tag *data1_gettagbyname(data1_tagset *s, char *name);
 306 void data1_free_tree(data1_node *t);
 307 char *data1_nodetobuf(data1_node *n, int select, int *len);
 308 data1_node *data1_insert_taggeddata(data1_node *root, data1_node *at,
 309     char *tagname);
 310 data1_datatype data1_maptype(char *t);
 311 data1_varset *data1_read_varset(char *file);
 312 data1_vartype *data1_getvartypebyct(data1_varset *set, char *class, char *type);
 313 Z_Espec1 *data1_read_espec1(char *file, ODR o);
 314 int data1_doespec1(data1_node *n, Z_Espec1 *e);
 315 data1_esetname *data1_getesetbyname(data1_absyn *a, char *name);
 316 data1_element *data1_getelementbyname(data1_absyn *absyn, char *name);
 317 data1_node *data1_mk_node(void);
 318 data1_absyn *data1_get_absyn(char *name);
 319 data1_maptab *data1_read_maptab(char *file);
 320 data1_node *data1_map_record(data1_node *n, data1_maptab *map);
 321 data1_marctab *data1_read_marctab(char *file);
 322 char *data1_nodetomarc(data1_marctab *p, data1_node *n, int selected, int *len);
 323
 324 #endif