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