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