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