include/data1.h

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