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