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