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.18 2002-10-08 20:14:44 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 YAZ_BEGIN_CDECL
  47
  48 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
  49
  50 #define DATA1_MAX_SYMBOL 31
  51
  52 typedef struct data1_name
  53 {
  54     char *name;
  55     struct data1_name *next;
  56 } data1_name;
  57
  58 typedef struct data1_absyn_cache_info *data1_absyn_cache;
  59 typedef struct data1_attset_cache_info *data1_attset_cache;
  60
  61 typedef enum data1_datatype
  62 {
  63     DATA1K_unknown,
  64     DATA1K_structured,
  65     DATA1K_string,
  66     DATA1K_numeric,
  67     DATA1K_bool,
  68     DATA1K_oid,
  69     DATA1K_generalizedtime,
  70     DATA1K_intunit,
  71     DATA1K_int,
  72     DATA1K_octetstring,
  73     DATA1K_null
  74 } data1_datatype;
  75
  76 typedef struct data1_marctab
  77 {
  78     char *name;
  79     oid_value reference;
  80
  81     char record_status[2];
  82     char implementation_codes[5];
  83     int  indicator_length;
  84     int  identifier_length;
  85     char user_systems[4];
  86
  87     int  length_data_entry;
  88     int  length_starting;
  89     int  length_implementation;
  90     char future_use[2];
  91
  92     int  force_indicator_length;
  93     int  force_identifier_length;
  94     struct data1_marctab *next;
  95 } data1_marctab;
  96
  97 typedef struct data1_esetname
  98 {
  99     char *name;
 100     Z_Espec1 *spec;
 101     struct data1_esetname *next;
 102 } data1_esetname;
 103
 104 /*
 105  * Variant set definitions.
 106  */
 107
 108 typedef struct data1_vartype
 109 {
 110     char *name;
 111     struct data1_varclass *zclass;
 112     int type;
 113     data1_datatype datatype;
 114     struct data1_vartype *next;
 115 } data1_vartype;
 116
 117 typedef struct data1_varclass
 118 {
 119     char *name;
 120     struct data1_varset *set;
 121     int zclass;
 122     data1_vartype *types;
 123     struct data1_varclass *next;
 124 } data1_varclass;
 125
 126 typedef struct data1_varset
 127 {
 128     char *name;
 129     oid_value reference;
 130     data1_varclass *classes;
 131 } data1_varset;
 132
 133 /*
 134  * Tagset definitions
 135  */
 136
 137 struct data1_tagset;
 138
 139 typedef struct data1_tag
 140 {
 141     data1_name *names;
 142 #define DATA1T_numeric 1
 143 #define DATA1T_string 2
 144     int which;
 145     union
 146     {
 147         int numeric;
 148         char *string;
 149     } value;
 150     data1_datatype kind;
 151
 152     struct data1_tagset *tagset;
 153     struct data1_tag *next;
 154 } data1_tag;
 155
 156 typedef struct data1_tagset data1_tagset;
 157
 158 struct data1_tagset
 159 {
 160     int type;                        /* type of tagset in current context */
 161     char *name;                      /* symbolic name */
 162     oid_value reference;
 163     data1_tag *tags;                 /* tags defined by this set */
 164     data1_tagset *children;          /* children */
 165     data1_tagset *next;              /* sibling */
 166 };
 167
 168 typedef struct data1_termlist
 169 {
 170     data1_att *att;
 171     char *structure;
 172     char *source;
 173     struct data1_termlist *next;
 174 } data1_termlist;
 175
 176 /*
 177  * abstract syntax specification
 178  */
 179
 180 typedef struct data1_element
 181 {
 182     char *name;
 183     data1_tag *tag;
 184     data1_termlist *termlists;
 185     char *sub_name;
 186     struct data1_element *children;
 187     struct data1_element *next;
 188 } data1_element;
 189
 190 typedef struct data1_sub_elements {
 191     char *name;
 192     struct data1_sub_elements *next;
 193     data1_element *elements;
 194 } data1_sub_elements;
 195
 196 typedef struct data1_xattr {
 197     char *name;
 198     char *value;
 199     struct data1_xattr *next;
 200     unsigned short what;  /* DATA1I_text, .. see data1_node.u.data */
 201 } data1_xattr;
 202
 203 typedef struct data1_absyn
 204 {
 205     char *name;
 206     oid_value reference;
 207     data1_tagset *tagset;
 208     data1_attset *attset;
 209     data1_varset *varset;
 210     data1_esetname *esetnames;
 211     data1_maptab *maptabs;
 212     data1_marctab *marc;
 213     data1_sub_elements *sub_elements;
 214     data1_element *main_elements;
 215     char *encoding;
 216     int  enable_xpath_indexing;
 217 } data1_absyn;
 218
 219 /*
 220  * record data node (tag/data/variant)
 221  */
 222
 223 typedef struct data1_node
 224 {
 225     /* the root of a record (containing global data) */
 226 #define DATA1N_root 1
 227     /* a tag */
 228 #define DATA1N_tag  2
 229     /* some data under a leaf tag or variant */
 230 #define DATA1N_data 3
 231     /* variant specification (a triple, actually) */
 232 #define DATA1N_variant 4
 233     /* comment (same as data) */
 234 #define DATA1N_comment 5
 235     /* preprocessing instruction */
 236 #define DATA1N_preprocess 6
 237     int which;
 238     union
 239     {
 240         struct
 241         {
 242             char *type;
 243             data1_absyn *absyn;  /* abstract syntax for this type */
 244         } root;
 245
 246         struct
 247         {
 248             char *tag;
 249             data1_element *element;
 250             int no_data_requested;
 251             int get_bytes;
 252             unsigned node_selected : 1;
 253             unsigned make_variantlist : 1;
 254             data1_xattr *attributes;
 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             /* XML text */
 272 #define DATA1I_xmltext 6
 273             unsigned what:7;
 274             unsigned formatted_text : 1;   /* newlines are significant */
 275         } data;
 276
 277         struct
 278         {
 279             data1_vartype *type;
 280             char *value;
 281         } variant;
 282
 283         struct
 284         {
 285             char *target;
 286             data1_xattr *attributes;
 287         } preprocess;
 288     } u;
 289
 290     void (*destroy)(struct data1_node *n);
 291 #define DATA1_LOCALDATA 12
 292     char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
 293     struct data1_node *next;
 294     struct data1_node *child;
 295     struct data1_node *last_child;
 296     struct data1_node *parent;
 297     struct data1_node *root;
 298 } data1_node;
 299
 300 YAZ_EXPORT data1_handle data1_create (void);
 301
 302 #define DATA1_FLAG_XML  1
 303 YAZ_EXPORT data1_handle data1_createx (int flags);
 304
 305 YAZ_EXPORT void data1_destroy(data1_handle dh);
 306 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
 307 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
 308                                        NMEM m);
 309 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
 310                                          int (*get_byte)(void *fh), void *fh,
 311                                          WRBUF wrbuf);
 312 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
 313                                          int (*rf)(void *, char *, size_t),
 314                                          void *fh, NMEM m);
 315 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
 316                                          int file_must_exist);
 317 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
 318                                         data1_tagset *s,
 319                                         int type, int value);
 320 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
 321 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
 322                                            const char *file,
 323                                            int type);
 324 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
 325                                                     data1_absyn *abs,
 326                                                     data1_element *parent,
 327                                                     const char *tagname);
 328 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 329                                            int select, ODR o,
 330                                            int *len);
 331 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
 332                                          const char *name);
 333 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
 334 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
 335                                  int select, int *len);
 336 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
 337                                             data1_node *at,
 338                                             const char *tagname, NMEM m);
 339 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
 340                                          const char *tagname, NMEM m);
 341 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
 342 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
 343 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
 344                                                data1_varset *set,
 345                                                char *zclass, char *type);
 346 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
 347 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
 348 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
 349                                                data1_absyn *a,
 350                                                const char *name);
 351 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
 352                                                  data1_absyn *absyn,
 353                                                  const char *name);
 354 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
 355                                       int type, data1_node *parent);
 356
 357 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
 358                                      const char *tag, const char **attr,
 359                                      data1_node *at);
 360 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
 361                                        const char *tag, size_t len,
 362                                        const char **attr,
 363                                        data1_node *at);
 364 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
 365                                     data1_node *res, const char **attr);
 366
 367 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
 368                                         const char *buf, size_t len,
 369                                         data1_node *parent);
 370 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
 371                                          const char *buf, size_t len,
 372                                          data1_node *parent);
 373 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
 374                                       const char *buf, data1_node *parent);
 375
 376 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
 377                                            const char *buf, size_t len,
 378                                            data1_node *parent);
 379
 380 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
 381                                          const char *buf, data1_node *parent);
 382
 383 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
 384                                               const char *target, size_t len,
 385                                               const char **attr,
 386                                               data1_node *at);
 387
 388 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
 389                                             const char *target,
 390                                             const char **attr,
 391                                             data1_node *at);
 392
 393 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
 394                                       const char *name);
 395 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
 396                                NMEM nmem, const char *name);
 397
 398 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
 399                                               const char *tag, int num,
 400                                               NMEM nmem);
 401 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
 402                                               const char *tag, Odr_oid *oid,
 403                                               NMEM nmem);
 404 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
 405                                                const char *tag,
 406                                                const char *str,
 407                                                NMEM nmem);
 408 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
 409                                                    data1_node *at,
 410                                                    const char *tag,
 411                                                    const char *str,
 412                                                    NMEM nmem);
 413
 414 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
 415
 416 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
 417                                          const char *tag);
 418 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
 419                                          const char *tag, data1_node *at);
 420 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
 421 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
 422 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
 423                                         data1_maptab *map, NMEM m);
 424 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
 425                                               const char *file);
 426 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
 427                                   data1_node *n, int selected, int *len);
 428 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
 429                                     int select, int *len);
 430 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
 431                                                 data1_node *n, int select,
 432                                                 ODR o);
 433 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
 434                                            data1_node *n, int select,
 435                                            ODR o);
 436 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
 437                                   int *len);
 438 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
 439 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
 440 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
 441 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
 442
 443 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
 444 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
 445 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
 446 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
 447 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
 448 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
 449 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
 450 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
 451                                       NMEM m, const char *str);
 452 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
 453                                         NMEM m, const char *str, size_t len);
 454 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
 455                                         const char *buf);
 456 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
 457                                        int (*rf)(void *, char *, size_t),
 458                                        void *fh, NMEM m);
 459 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
 460                                   void (*fh)(data1_handle dh,
 461                                              void *h, data1_absyn *a));
 462
 463 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
 464
 465 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
 466 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
 467 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
 468
 469 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
 470                                    const char *mode);
 471
 472 /* obsolete functions ... */
 473
 474 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
 475 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
 476                                                 data1_node *root,
 477                                                 data1_node *at,
 478                                                 const char *tagname, NMEM m);
 479 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
 480 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
 481                                              data1_node *at,
 482                                              const char *tagname,
 483                                              NMEM m);
 484
 485 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
 486
 487 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
 488                             const char *tocode,
 489                             const char *fromcode);
 490
 491 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
 492
 493 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
 494
 495 YAZ_END_CDECL
 496
 497 #endif