include/yaz/data1.h

   1 /*
   2  * Copyright (c) 1995-2002, 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  * $Id: data1.h,v 1.9 2002-05-07 11:02:56 adam Exp $
  27  */
  28
  29 #ifndef DATA1_H
  30 #define DATA1_H
  31
  32 #include <stdio.h>
  33
  34 #include <yaz/nmem.h>
  35 #include <yaz/oid.h>
  36 #include <yaz/proto.h>
  37
  38 #include <yaz/d1_attset.h>
  39 #include <yaz/d1_map.h>
  40 #include <yaz/yaz-util.h>
  41 #include <yaz/wrbuf.h>
  42
  43 #define d1_isspace(c) strchr(" \r\n\t\f", c)
  44 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
  45
  46 #define DATA1_USING_XATTR 1
  47
  48 YAZ_BEGIN_CDECL
  49
  50 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
  51
  52 #define DATA1_MAX_SYMBOL 31
  53
  54 typedef struct data1_name
  55 {
  56     char *name;
  57     struct data1_name *next;
  58 } data1_name;
  59
  60 typedef struct data1_absyn_cache_info *data1_absyn_cache;
  61 typedef struct data1_attset_cache_info *data1_attset_cache;
  62
  63 typedef enum data1_datatype
  64 {
  65     DATA1K_unknown,
  66     DATA1K_structured,
  67     DATA1K_string,
  68     DATA1K_numeric,
  69     DATA1K_bool,
  70     DATA1K_oid,
  71     DATA1K_generalizedtime,
  72     DATA1K_intunit,
  73     DATA1K_int,
  74     DATA1K_octetstring,
  75     DATA1K_null
  76 } data1_datatype;
  77
  78 typedef struct data1_marctab
  79 {
  80     char *name;
  81     oid_value reference;
  82
  83     char record_status[2];
  84     char implementation_codes[5];
  85     int  indicator_length;
  86     int  identifier_length;
  87     char user_systems[4];
  88
  89     int  length_data_entry;
  90     int  length_starting;
  91     int  length_implementation;
  92     char future_use[2];
  93
  94     int  force_indicator_length;
  95     int  force_identifier_length;
  96     struct data1_marctab *next;
  97 } data1_marctab;
  98
  99 typedef struct data1_esetname
 100 {
 101     char *name;
 102     Z_Espec1 *spec;
 103     struct data1_esetname *next;
 104 } data1_esetname;
 105
 106 /*
 107  * Variant set definitions.
 108  */
 109
 110 typedef struct data1_vartype
 111 {
 112     char *name;
 113     struct data1_varclass *zclass;
 114     int type;
 115     data1_datatype datatype;
 116     struct data1_vartype *next;
 117 } data1_vartype;
 118
 119 typedef struct data1_varclass
 120 {
 121     char *name;
 122     struct data1_varset *set;
 123     int zclass;
 124     data1_vartype *types;
 125     struct data1_varclass *next;
 126 } data1_varclass;
 127
 128 typedef struct data1_varset
 129 {
 130     char *name;
 131     oid_value reference;
 132     data1_varclass *classes;
 133 } data1_varset;
 134
 135 /*
 136  * Tagset definitions
 137  */
 138
 139 struct data1_tagset;
 140
 141 typedef struct data1_tag
 142 {
 143     data1_name *names;
 144 #define DATA1T_numeric 1
 145 #define DATA1T_string 2
 146     int which;
 147     union
 148     {
 149         int numeric;
 150         char *string;
 151     } value;
 152     data1_datatype kind;
 153
 154     struct data1_tagset *tagset;
 155     struct data1_tag *next;
 156 } data1_tag;
 157
 158 typedef struct data1_tagset data1_tagset;
 159
 160 struct data1_tagset
 161 {
 162     int type;                        /* type of tagset in current context */
 163     char *name;                      /* symbolic name */
 164     oid_value reference;
 165     data1_tag *tags;                 /* tags defined by this set */
 166     data1_tagset *children;          /* children */
 167     data1_tagset *next;              /* sibling */
 168 };
 169
 170 typedef struct data1_termlist
 171 {
 172     data1_att *att;
 173     char *structure;
 174     char *source;
 175     struct data1_termlist *next;
 176 } data1_termlist;
 177
 178 /*
 179  * abstract syntax specification
 180  */
 181
 182 typedef struct data1_element
 183 {
 184     char *name;
 185     data1_tag *tag;
 186     data1_termlist *termlists;
 187     char *sub_name;
 188     struct data1_element *children;
 189     struct data1_element *next;
 190 } data1_element;
 191
 192 typedef struct data1_sub_elements {
 193     char *name;
 194     struct data1_sub_elements *next;
 195     data1_element *elements;
 196 } data1_sub_elements;
 197
 198 #if DATA1_USING_XATTR
 199 typedef struct data1_xattr {
 200     char *name;
 201     char *value;
 202     struct data1_xattr *next;
 203 } data1_xattr;
 204 #endif
 205
 206 typedef struct data1_absyn
 207 {
 208     char *name;
 209     oid_value reference;
 210     data1_tagset *tagset;
 211     data1_attset *attset;
 212     data1_varset *varset;
 213     data1_esetname *esetnames;
 214     data1_maptab *maptabs;
 215     data1_marctab *marc;
 216     data1_sub_elements *sub_elements;
 217     data1_element *main_elements;
 218 } data1_absyn;
 219
 220 /*
 221  * record data node (tag/data/variant)
 222  */
 223
 224 typedef struct data1_node
 225 {
 226     /* the root of a record (containing global data) */
 227 #define DATA1N_root 1
 228     /* a tag */
 229 #define DATA1N_tag  2
 230     /* some data under a leaf tag or variant */
 231 #define DATA1N_data 3
 232     /* variant specification (a triple, actually) */
 233 #define DATA1N_variant 4
 234     int which;
 235
 236     union
 237     {
 238         struct
 239         {
 240             char *type;
 241             data1_absyn *absyn;  /* abstract syntax for this type */
 242         } root;
 243
 244         struct
 245         {
 246             char *tag;
 247             data1_element *element;
 248             int no_data_requested;
 249             int get_bytes;
 250             unsigned node_selected : 1;
 251             unsigned make_variantlist : 1;
 252 #if DATA1_USING_XATTR
 253             data1_xattr *attributes;
 254 #endif
 255         } tag;
 256
 257         struct
 258         {
 259             char *data;      /* filename or data */
 260             int len;
 261         /* text inclusion */
 262 #define DATA1I_inctxt 1
 263         /* binary data inclusion */
 264 #define DATA1I_incbin 2
 265         /* text data */
 266 #define DATA1I_text 3
 267         /* numerical data */
 268 #define DATA1I_num 4
 269         /* object identifier */
 270 #define DATA1I_oid 5
 271             unsigned what:7;
 272             unsigned formatted_text : 1;   /* newlines are significant */
 273         } data;
 274
 275         struct
 276         {
 277             data1_vartype *type;
 278             char *value;
 279         } variant;
 280     } u;
 281
 282     void (*destroy)(struct data1_node *n);
 283 #define DATA1_LOCALDATA 12
 284     char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
 285     struct data1_node *next;
 286     struct data1_node *child;
 287     struct data1_node *last_child;
 288     struct data1_node *parent;
 289     struct data1_node *root;
 290 } data1_node;
 291
 292 YAZ_EXPORT data1_handle data1_create (void);
 293 YAZ_EXPORT void data1_destroy(data1_handle dh);
 294 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
 295 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
 296                                        NMEM m);
 297 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
 298                                          int (*get_byte)(void *fh), void *fh,
 299                                          WRBUF wrbuf);
 300 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
 301                                          int (*rf)(void *, char *, size_t),
 302                                          void *fh, NMEM m);
 303 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
 304 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
 305                                         data1_tagset *s,
 306                                         int type, int value);
 307 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
 308 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
 309                                            const char *file,
 310                                            int type);
 311 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
 312                                                     data1_absyn *abs,
 313                                                     data1_element *parent,
 314                                                     const char *tagname);
 315 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 316                                            int select, ODR o,
 317                                            int *len);
 318 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
 319                                          const char *name);
 320 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
 321 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
 322                                  int select, int *len);
 323 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
 324                                             data1_node *at,
 325                                             const char *tagname, NMEM m);
 326 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
 327                                          const char *tagname, NMEM m);
 328 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
 329 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
 330 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
 331                                                data1_varset *set,
 332                                                char *zclass, char *type);
 333 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
 334 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
 335 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
 336                                                data1_absyn *a,
 337                                                const char *name);
 338 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
 339                                                  data1_absyn *absyn,
 340                                                  const char *name);
 341 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
 342                                       int type, data1_node *parent);
 343
 344 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
 345                                      const char *tag, data1_node *at);
 346 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
 347                                        const char *tag, size_t len,
 348                                        data1_node *at);
 349
 350 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
 351                                         const char *buf, size_t len,
 352                                         data1_node *parent);
 353 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
 354                                       const char *buf, data1_node *parent);
 355
 356 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
 357                                       const char *name);
 358
 359 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
 360                                               const char *tag, int num,
 361                                               NMEM nmem);
 362 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
 363                                               const char *tag, Odr_oid *oid,
 364                                               NMEM nmem);
 365 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
 366                                                const char *tag,
 367                                                const char *str,
 368                                                NMEM nmem);
 369 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
 370                                                    data1_node *at,
 371                                                    const char *tag,
 372                                                    const char *str,
 373                                                    NMEM nmem);
 374
 375 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
 376
 377 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
 378                                          const char *tag);
 379 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
 380                                          const char *tag, data1_node *at);
 381 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
 382 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
 383 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
 384                                         data1_maptab *map, NMEM m);
 385 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
 386                                               const char *file);
 387 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
 388                                   data1_node *n, int selected, int *len);
 389 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
 390                                     int select, int *len);
 391 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
 392                                                 data1_node *n, int select,
 393                                                 ODR o);
 394 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
 395                                            data1_node *n, int select,
 396                                            ODR o);
 397 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
 398                                   int *len);
 399 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
 400 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
 401 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
 402 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
 403
 404 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
 405 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
 406 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
 407 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
 408 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
 409 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
 410 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
 411 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
 412                                       NMEM m, const char *str);
 413 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
 414                                         NMEM m, const char *str, size_t len);
 415 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
 416                                         const char *buf);
 417 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
 418                                   void (*fh)(data1_handle dh,
 419                                              void *h, data1_absyn *a));
 420
 421 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
 422
 423 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
 424 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
 425 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
 426
 427 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
 428                                    const char *mode);
 429
 430 /* obsolete functions ... */
 431
 432 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
 433 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
 434                                                 data1_node *root,
 435                                                 data1_node *at,
 436                                                 const char *tagname, NMEM m);
 437 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
 438 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
 439                                              data1_node *at,
 440                                              const char *tagname,
 441                                              NMEM m);
 442
 443 YAZ_END_CDECL
 444
 445 #endif