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