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