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