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