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