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