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