include/data1.h

   1 /* $Id: data1.h,v 1.9.2.1 2005-04-23 16:31:55 adam Exp $
   2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
   3    Index Data Aps
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23 #ifndef DATA1_H
  24 #define DATA1_H
  25
  26 #define ENHANCED_XELM 1
  27
  28 #include <stdio.h>
  29
  30 #include <yaz/nmem.h>
  31 #include <yaz/oid.h>
  32 #include <yaz/proto.h>
  33
  34 #include <d1_attset.h>
  35 #include <d1_map.h>
  36 #include <yaz/yaz-util.h>
  37 #include <yaz/wrbuf.h>
  38 #include <dfa.h>         /* pop */
  39 #include <zebra_xpath.h> /* pop */
  40
  41 #define d1_isspace(c) strchr(" \r\n\t\f", c)
  42 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
  43
  44 YAZ_BEGIN_CDECL
  45
  46 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
  47
  48 #define DATA1_MAX_SYMBOL 31
  49
  50 typedef struct data1_name
  51 {
  52     char *name;
  53     struct data1_name *next;
  54 } data1_name;
  55
  56 typedef struct data1_absyn_cache_info *data1_absyn_cache;
  57 typedef struct data1_attset_cache_info *data1_attset_cache;
  58
  59 typedef enum data1_datatype
  60 {
  61     DATA1K_unknown,
  62     DATA1K_structured,
  63     DATA1K_string,
  64     DATA1K_numeric,
  65     DATA1K_bool,
  66     DATA1K_oid,
  67     DATA1K_generalizedtime,
  68     DATA1K_intunit,
  69     DATA1K_int,
  70     DATA1K_octetstring,
  71     DATA1K_null
  72 } data1_datatype;
  73
  74 typedef struct data1_marctab
  75 {
  76     char *name;
  77     oid_value reference;
  78
  79     char record_status[2];
  80     char implementation_codes[5];
  81     int  indicator_length;
  82     int  identifier_length;
  83     char user_systems[4];
  84
  85     int  length_data_entry;
  86     int  length_starting;
  87     int  length_implementation;
  88     char future_use[2];
  89
  90     int  force_indicator_length;
  91     int  force_identifier_length;
  92     char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */
  93     struct data1_marctab *next;
  94 } data1_marctab;
  95
  96 typedef struct data1_esetname
  97 {
  98     char *name;
  99     Z_Espec1 *spec;
 100     struct data1_esetname *next;
 101 } data1_esetname;
 102
 103 /*
 104  * Variant set definitions.
 105  */
 106
 107 typedef struct data1_vartype
 108 {
 109     char *name;
 110     struct data1_varclass *zclass;
 111     int type;
 112     data1_datatype datatype;
 113     struct data1_vartype *next;
 114 } data1_vartype;
 115
 116 typedef struct data1_varclass
 117 {
 118     char *name;
 119     struct data1_varset *set;
 120     int zclass;
 121     data1_vartype *types;
 122     struct data1_varclass *next;
 123 } data1_varclass;
 124
 125 typedef struct data1_varset
 126 {
 127     char *name;
 128     oid_value reference;
 129     data1_varclass *classes;
 130 } data1_varset;
 131
 132 /*
 133  * Tagset definitions
 134  */
 135
 136 struct data1_tagset;
 137
 138 typedef struct data1_tag
 139 {
 140     data1_name *names;
 141 #define DATA1T_numeric 1
 142 #define DATA1T_string 2
 143     int which;
 144     union
 145     {
 146         int numeric;
 147         char *string;
 148     } value;
 149     data1_datatype kind;
 150
 151     struct data1_tagset *tagset;
 152     struct data1_tag *next;
 153 } data1_tag;
 154
 155 typedef struct data1_tagset data1_tagset;
 156
 157 struct data1_tagset
 158 {
 159     int type;                        /* type of tagset in current context */
 160     char *name;                      /* symbolic name */
 161     oid_value reference;
 162     data1_tag *tags;                 /* tags defined by this set */
 163     data1_tagset *children;          /* children */
 164     data1_tagset *next;              /* sibling */
 165 };
 166
 167 typedef struct data1_termlist
 168 {
 169     data1_att *att;
 170     char *structure;
 171     char *source;
 172     struct data1_termlist *next;
 173 } data1_termlist;
 174
 175 /*
 176  * abstract syntax specification
 177  */
 178
 179 typedef struct data1_element
 180 {
 181     char *name;
 182     data1_tag *tag;
 183     data1_termlist *termlists;
 184     char *sub_name;
 185     struct data1_element *children;
 186     struct data1_element *next;
 187 } data1_element;
 188
 189 typedef struct data1_sub_elements {
 190     char *name;
 191     struct data1_sub_elements *next;
 192     data1_element *elements;
 193 } data1_sub_elements;
 194
 195 /* pop */
 196 typedef struct data1_xpelement
 197 {
 198     char *xpath_expr;
 199 #ifdef ENHANCED_XELM
 200     struct xpath_location_step xpath[XPATH_STEP_COUNT];
 201     int xpath_len;
 202 #endif
 203     struct DFA *dfa;
 204     data1_termlist *termlists;
 205     struct data1_xpelement *next;
 206 } data1_xpelement;
 207
 208 typedef struct data1_xattr {
 209     char *name;
 210     char *value;
 211     struct data1_xattr *next;
 212     unsigned short what;  /* DATA1I_text, .. see data1_node.u.data */
 213 } data1_xattr;
 214
 215 #if 0
 216 typedef struct data1_absyn data1_absyn;
 217 #else
 218 typedef struct data1_absyn
 219 {
 220     char *name;
 221     oid_value reference;
 222     data1_tagset *tagset;
 223     data1_attset *attset;
 224     data1_varset *varset;
 225     data1_esetname *esetnames;
 226     data1_maptab *maptabs;
 227     data1_marctab *marc;
 228     data1_sub_elements *sub_elements;
 229     data1_element *main_elements;
 230     data1_xpelement *xp_elements; /* pop */
 231     struct data1_systag *systags;
 232     char *encoding;
 233     int  enable_xpath_indexing;
 234 } data1_absyn;
 235 #endif
 236 /*
 237  * record data node (tag/data/variant)
 238  */
 239
 240 typedef struct data1_node
 241 {
 242     /* the root of a record (containing global data) */
 243 #define DATA1N_root 1
 244     /* a tag */
 245 #define DATA1N_tag  2
 246     /* some data under a leaf tag or variant */
 247 #define DATA1N_data 3
 248     /* variant specification (a triple, actually) */
 249 #define DATA1N_variant 4
 250     /* comment (same as data) */
 251 #define DATA1N_comment 5
 252     /* preprocessing instruction */
 253 #define DATA1N_preprocess 6
 254     int which;
 255     union
 256     {
 257         struct
 258         {
 259             char *type;
 260             data1_absyn *absyn;  /* abstract syntax for this type */
 261         } root;
 262
 263         struct
 264         {
 265             char *tag;
 266             data1_element *element;
 267             int no_data_requested;
 268             int get_bytes;
 269             unsigned node_selected : 1;
 270             unsigned make_variantlist : 1;
 271             data1_xattr *attributes;
 272         } tag;
 273
 274         struct
 275         {
 276             char *data;      /* filename or data */
 277             int len;
 278             /* text inclusion */
 279 #define DATA1I_inctxt 1
 280             /* binary data inclusion */
 281 #define DATA1I_incbin 2
 282         /* text data */
 283 #define DATA1I_text 3
 284             /* numerical data */
 285 #define DATA1I_num 4
 286             /* object identifier */
 287 #define DATA1I_oid 5
 288             /* XML text */
 289 #define DATA1I_xmltext 6
 290             unsigned what:7;
 291             unsigned formatted_text : 1;   /* newlines are significant */
 292         } data;
 293
 294         struct
 295         {
 296             data1_vartype *type;
 297             char *value;
 298         } variant;
 299
 300         struct
 301         {
 302             char *target;
 303             data1_xattr *attributes;
 304         } preprocess;
 305     } u;
 306
 307     void (*destroy)(struct data1_node *n);
 308 #define DATA1_LOCALDATA 12
 309     char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
 310     struct data1_node *next;
 311     struct data1_node *child;
 312     struct data1_node *last_child;
 313     struct data1_node *parent;
 314     struct data1_node *root;
 315 } data1_node;
 316
 317 YAZ_EXPORT data1_handle data1_create (void);
 318
 319 #define DATA1_FLAG_XML  1
 320 YAZ_EXPORT data1_handle data1_createx (int flags);
 321
 322 YAZ_EXPORT void data1_destroy(data1_handle dh);
 323 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
 324 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
 325                                        NMEM m);
 326 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
 327                                          int (*get_byte)(void *fh), void *fh,
 328                                          WRBUF wrbuf);
 329 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
 330                                          int (*rf)(void *, char *, size_t),
 331                                          void *fh, NMEM m);
 332 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
 333                                          int file_must_exist);
 334 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
 335                                         data1_tagset *s,
 336                                         int type, int value);
 337 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
 338 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
 339                                            const char *file,
 340                                            int type);
 341 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
 342                                                     data1_absyn *abs,
 343                                                     data1_element *parent,
 344                                                     const char *tagname);
 345 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 346                                            int select, ODR o,
 347                                            int *len);
 348 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
 349                                          const char *name);
 350 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
 351 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
 352                                  int select, int *len);
 353 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
 354                                             data1_node *at,
 355                                             const char *tagname, NMEM m);
 356 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
 357                                          const char *tagname, NMEM m);
 358 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
 359 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
 360 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
 361                                                data1_varset *set,
 362                                                const char *zclass,
 363                                                const char *type);
 364 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
 365 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
 366 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
 367                                                data1_absyn *a,
 368                                                const char *name);
 369 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
 370                                                  data1_absyn *absyn,
 371                                                  const char *name);
 372 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
 373                                       int type, data1_node *parent);
 374
 375 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
 376                                      const char *tag, const char **attr,
 377                                      data1_node *at);
 378 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
 379                                        const char *tag, size_t len,
 380                                        const char **attr,
 381                                        data1_node *at);
 382 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
 383                                     data1_node *res, const char **attr);
 384
 385 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
 386                                         const char *buf, size_t len,
 387                                         data1_node *parent);
 388 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
 389                                          const char *buf, size_t len,
 390                                          data1_node *parent);
 391 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
 392                                       const char *buf, data1_node *parent);
 393
 394 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
 395                                            const char *buf, size_t len,
 396                                            data1_node *parent);
 397
 398 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
 399                                          const char *buf, data1_node *parent);
 400
 401 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
 402                                               const char *target, size_t len,
 403                                               const char **attr,
 404                                               data1_node *at);
 405
 406 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
 407                                             const char *target,
 408                                             const char **attr,
 409                                             data1_node *at);
 410
 411 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
 412                                                   const char *target,
 413                                                   size_t len,
 414                                                   const char **attr,
 415                                                   data1_node *at);
 416
 417 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
 418                                                 const char *target,
 419                                                 const char **attr,
 420                                                 data1_node *at);
 421
 422 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
 423                                       const char *name);
 424 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
 425                                NMEM nmem, const char *name);
 426
 427 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
 428                                               const char *tag, int num,
 429                                               NMEM nmem);
 430 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
 431                                               const char *tag, Odr_oid *oid,
 432                                               NMEM nmem);
 433 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
 434                                                const char *tag,
 435                                                const char *str,
 436                                                NMEM nmem);
 437 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
 438                                                    data1_node *at,
 439                                                    const char *tag,
 440                                                    const char *str,
 441                                                    NMEM nmem);
 442
 443 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
 444
 445 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
 446                                          const char *tag);
 447 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
 448                                          const char *tag, data1_node *at);
 449 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
 450 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
 451 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
 452                                         data1_maptab *map, NMEM m);
 453 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
 454                                               const char *file);
 455 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
 456                                   data1_node *n, int selected, int *len);
 457 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
 458                                     int select, int *len);
 459 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
 460                                                 data1_node *n, int select,
 461                                                 ODR o);
 462 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
 463                                            data1_node *n, int select,
 464                                            ODR o);
 465 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
 466                                   int *len);
 467 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
 468 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
 469 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
 470 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
 471
 472 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
 473 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
 474 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
 475 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
 476 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
 477 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
 478 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
 479 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
 480                                       NMEM m, const char *str);
 481 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
 482                                         NMEM m, const char *str, size_t len);
 483 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
 484                                         const char *buf);
 485 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
 486                                        int (*rf)(void *, char *, size_t),
 487                                        void *fh, NMEM m);
 488 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
 489                                   void (*fh)(data1_handle dh,
 490                                              void *h, data1_absyn *a));
 491
 492 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
 493
 494 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
 495 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
 496 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
 497
 498 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
 499                                    const char *mode);
 500
 501 /* obsolete functions ... */
 502
 503 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
 504 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
 505                                                 data1_node *root,
 506                                                 data1_node *at,
 507                                                 const char *tagname, NMEM m);
 508 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
 509 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
 510                                              data1_node *at,
 511                                              const char *tagname,
 512                                              NMEM m);
 513
 514 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
 515
 516 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
 517                             const char *tocode,
 518                             const char *fromcode);
 519
 520 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
 521
 522 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
 523
 524 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
 525                                            const char *default_value);
 526
 527 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
 528
 529 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);
 530
 531 YAZ_END_CDECL
 532
 533 #endif