include/data1.h

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