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