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