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