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