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