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