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