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