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