include/data1.h

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