include/data1.h

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