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