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