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