include/data1.h

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