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