include/data1.h

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