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