include/idzebra/data1.h

   1 /* $Id: data1.h,v 1.17 2006-07-06 12:42:22 marc Exp $
   2    Copyright (C) 1995-2006
   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 #include <stdio.h>
  27
  28 #include <yaz/nmem.h>
  29 #include <yaz/oid.h>
  30 #include <yaz/proto.h>
  31 #include <yaz/yaz-util.h>
  32
  33 #include <idzebra/util.h>
  34
  35 #define d1_isspace(c) strchr(" \r\n\t\f", c)
  36 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
  37
  38 YAZ_BEGIN_CDECL
  39
  40 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
  41
  42 #define DATA1_MAX_SYMBOL 31
  43
  44 /*
  45  * This structure describes a attset, perhaps made up by inclusion
  46  * (supersetting) of other attribute sets. When indexing and searching,
  47  * we perform a normalisation, where we associate a given tag with
  48  * the set that originally defined it, rather than the superset. This
  49  * allows the most flexible access. Eg, the tags common to GILS and BIB-1
  50  * should be searchable by both names.
  51  */
  52
  53 struct data1_attset;
  54
  55 typedef struct data1_attset data1_attset;
  56 typedef struct data1_att data1_att;
  57 typedef struct data1_attset_child data1_attset_child;
  58
  59 struct data1_att
  60 {
  61     data1_attset *parent;          /* attribute set */
  62     char *name;                    /* symbolic name of this attribute */
  63     int value;                     /* attribute value */
  64     data1_att *next;
  65 };
  66
  67 struct data1_attset_child {
  68     data1_attset *child;
  69     data1_attset_child *next;
  70 };
  71
  72 struct data1_attset
  73 {
  74     char *name;          /* symbolic name */
  75     oid_value reference;   /* external ID of attset */
  76     data1_att *atts;          /* attributes */
  77     data1_attset_child *children;  /* included attset */
  78     data1_attset *next;       /* next in cache */
  79 };
  80
  81 typedef struct data1_handle_info *data1_handle;
  82
  83 YAZ_EXPORT data1_att *data1_getattbyname(data1_handle dh, data1_attset *s,
  84                                          const char *name);
  85 YAZ_EXPORT data1_attset *data1_read_attset(data1_handle dh, const char *file);
  86
  87 YAZ_EXPORT data1_attset *data1_empty_attset(data1_handle dh);
  88
  89 typedef struct data1_maptag
  90 {
  91     int new_field;
  92     int type;
  93 #define D1_MAPTAG_numeric 1
  94 #define D1_MAPTAG_string 2
  95     int which;
  96     union
  97     {
  98         int numeric;
  99         char *string;
 100     } value;
 101     struct data1_maptag *next;
 102 } data1_maptag;
 103
 104 typedef struct data1_mapunit
 105 {
 106     int no_data;
 107     char *source_element_name;
 108     data1_maptag *target_path;
 109     struct data1_mapunit *next;
 110 } data1_mapunit;
 111
 112 typedef struct data1_maptab
 113 {
 114     char *name;
 115     oid_value target_absyn_ref;
 116     char *target_absyn_name;
 117     data1_mapunit *map;
 118     struct data1_maptab *next;
 119 } data1_maptab;
 120
 121 typedef struct data1_name
 122 {
 123     char *name;
 124     struct data1_name *next;
 125 } data1_name;
 126
 127 typedef struct data1_absyn_cache_info *data1_absyn_cache;
 128 typedef struct data1_attset_cache_info *data1_attset_cache;
 129 typedef struct data1_absyn data1_absyn;
 130
 131 typedef enum data1_datatype
 132 {
 133     DATA1K_unknown,
 134     DATA1K_structured,
 135     DATA1K_string,
 136     DATA1K_numeric,
 137     DATA1K_bool,
 138     DATA1K_oid,
 139     DATA1K_generalizedtime,
 140     DATA1K_intunit,
 141     DATA1K_int,
 142     DATA1K_octetstring,
 143     DATA1K_null
 144 } data1_datatype;
 145
 146 typedef struct data1_marctab
 147 {
 148     char *name;
 149     oid_value reference;
 150
 151     char record_status[2];
 152     char implementation_codes[5];
 153     int  indicator_length;
 154     int  identifier_length;
 155     char user_systems[4];
 156
 157     int  length_data_entry;
 158     int  length_starting;
 159     int  length_implementation;
 160     char future_use[2];
 161
 162     int  force_indicator_length;
 163     int  force_identifier_length;
 164     char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */
 165     struct data1_marctab *next;
 166 } data1_marctab;
 167
 168 typedef struct data1_esetname
 169 {
 170     char *name;
 171     Z_Espec1 *spec;
 172     struct data1_esetname *next;
 173 } data1_esetname;
 174
 175 /*
 176  * Variant set definitions.
 177  */
 178
 179 typedef struct data1_vartype
 180 {
 181     char *name;
 182     struct data1_varclass *zclass;
 183     int type;
 184     data1_datatype datatype;
 185     struct data1_vartype *next;
 186 } data1_vartype;
 187
 188 typedef struct data1_varclass
 189 {
 190     char *name;
 191     struct data1_varset *set;
 192     int zclass;
 193     data1_vartype *types;
 194     struct data1_varclass *next;
 195 } data1_varclass;
 196
 197 typedef struct data1_varset
 198 {
 199     char *name;
 200     oid_value reference;
 201     data1_varclass *classes;
 202 } data1_varset;
 203
 204 /*
 205  * Tagset definitions
 206  */
 207
 208 struct data1_tagset;
 209
 210 typedef struct data1_tag
 211 {
 212     data1_name *names;
 213 #define DATA1T_numeric 1
 214 #define DATA1T_string 2
 215     int which;
 216     union
 217     {
 218         int numeric;
 219         char *string;
 220     } value;
 221     data1_datatype kind;
 222
 223     struct data1_tagset *tagset;
 224     struct data1_tag *next;
 225 } data1_tag;
 226
 227 typedef struct data1_tagset data1_tagset;
 228
 229 struct data1_tagset
 230 {
 231     int type;                        /* type of tagset in current context */
 232     char *name;                      /* symbolic name */
 233     oid_value reference;
 234     data1_tag *tags;                 /* tags defined by this set */
 235     data1_tagset *children;          /* children */
 236     data1_tagset *next;              /* sibling */
 237 };
 238
 239 typedef struct data1_termlist
 240 {
 241     char *index_name;
 242     char *structure;
 243     char *source;
 244     struct data1_termlist *next;
 245 } data1_termlist;
 246
 247 /*
 248  * abstract syntax specification
 249  */
 250
 251 typedef struct data1_element
 252 {
 253     char *name;
 254     data1_tag *tag;
 255     data1_termlist *termlists;
 256     char *sub_name;
 257     struct data1_element *children;
 258     struct data1_element *next;
 259     struct data1_hash_table *hash;
 260 } data1_element;
 261
 262 typedef struct data1_sub_elements {
 263     char *name;
 264     struct data1_sub_elements *next;
 265     data1_element *elements;
 266 } data1_sub_elements;
 267
 268 typedef struct data1_xattr {
 269     char *name;
 270     char *value;
 271     struct data1_xattr *next;
 272     unsigned short what;  /* DATA1I_text, .. see data1_node.u.data */
 273 } data1_xattr;
 274
 275
 276 /*
 277  * record data node (tag/data/variant)
 278  */
 279
 280 typedef struct data1_node
 281 {
 282     /* the root of a record (containing global data) */
 283 #define DATA1N_root 1
 284     /* a tag */
 285 #define DATA1N_tag  2
 286     /* some data under a leaf tag or variant */
 287 #define DATA1N_data 3
 288     /* variant specification (a triple, actually) */
 289 #define DATA1N_variant 4
 290     /* comment (same as data) */
 291 #define DATA1N_comment 5
 292     /* preprocessing instruction */
 293 #define DATA1N_preprocess 6
 294     int which;
 295     union
 296     {
 297         struct
 298         {
 299             char *type;
 300             struct data1_absyn *absyn;  /* abstract syntax for this type */
 301         } root;
 302
 303         struct
 304         {
 305             char *tag;
 306             data1_element *element;
 307             int no_data_requested;
 308             int get_bytes;
 309             unsigned node_selected : 1;
 310             unsigned make_variantlist : 1;
 311             data1_xattr *attributes;
 312         } tag;
 313
 314         struct
 315         {
 316             char *data;      /* filename or data */
 317             int len;
 318             /* text inclusion */
 319 #define DATA1I_inctxt 1
 320             /* binary data inclusion */
 321 #define DATA1I_incbin 2
 322         /* text data */
 323 #define DATA1I_text 3
 324             /* numerical data */
 325 #define DATA1I_num 4
 326             /* object identifier */
 327 #define DATA1I_oid 5
 328             /* XML text */
 329 #define DATA1I_xmltext 6
 330             unsigned what:7;
 331             unsigned formatted_text : 1;   /* newlines are significant */
 332         } data;
 333
 334         struct
 335         {
 336             data1_vartype *type;
 337             char *value;
 338         } variant;
 339
 340         struct
 341         {
 342             char *target;
 343             data1_xattr *attributes;
 344         } preprocess;
 345     } u;
 346
 347 #define DATA1_LOCALDATA 12
 348     char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
 349     struct data1_node *next;
 350     struct data1_node *child;
 351     struct data1_node *last_child;
 352     struct data1_node *parent;
 353     struct data1_node *root;
 354 } data1_node;
 355
 356 enum DATA1_XPATH_INDEXING {
 357     DATA1_XPATH_INDEXING_DISABLE,
 358     DATA1_XPATH_INDEXING_ENABLE
 359 };
 360
 361 YAZ_EXPORT data1_handle data1_create (void);
 362
 363
 364 YAZ_EXPORT void data1_destroy(data1_handle dh);
 365 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
 366 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
 367                                        NMEM m);
 368 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
 369                                          int (*get_byte)(void *fh), void *fh,
 370                                          WRBUF wrbuf);
 371 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
 372                                          int (*rf)(void *, char *, size_t),
 373                                          void *fh, NMEM m);
 374
 375 YAZ_EXPORT void data1_remove_node (data1_handle dh, data1_node *n);
 376 YAZ_EXPORT void data1_remove_idzebra_subtree (data1_handle dh, data1_node *n);
 377 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
 378                                         data1_tagset *s,
 379                                         int type, int value);
 380 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
 381 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
 382                                            const char *file,
 383                                            int type);
 384 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
 385                                                     data1_absyn *abs,
 386                                                     data1_element *parent,
 387                                                     const char *tagname);
 388 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 389                                            int select, ODR o,
 390                                            int *len);
 391 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
 392                                          const char *name);
 393 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
 394                                  int select, int *len);
 395 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
 396                                             data1_node *at,
 397                                             const char *tagname, NMEM m);
 398 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
 399                                          const char *tagname, NMEM m);
 400 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
 401 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
 402 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
 403                                                data1_varset *set,
 404                                                const char *zclass,
 405                                                const char *type);
 406 YAZ_EXPORT data1_vartype *data1_getvartypeby_absyn(data1_handle dh,
 407                                                    data1_absyn *absyn,
 408                                                    char *zclass, char *type);
 409 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
 410 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
 411 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
 412                                                data1_absyn *a,
 413                                                const char *name);
 414 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
 415                                                  data1_absyn *absyn,
 416                                                  const char *name);
 417 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
 418                                       int type, data1_node *parent);
 419
 420 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
 421                                      const char *tag, const char **attr,
 422                                      data1_node *at);
 423 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
 424                                        const char *tag, size_t len,
 425                                        const char **attr,
 426                                        data1_node *at);
 427 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
 428                                     data1_node *res, const char **attr);
 429
 430 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
 431                                         const char *buf, size_t len,
 432                                         data1_node *parent);
 433 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
 434                                          const char *buf, size_t len,
 435                                          data1_node *parent);
 436 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
 437                                       const char *buf, data1_node *parent);
 438
 439 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
 440                                            const char *buf, size_t len,
 441                                            data1_node *parent);
 442
 443 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
 444                                          const char *buf, data1_node *parent);
 445
 446 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
 447                                               const char *target, size_t len,
 448                                               const char **attr,
 449                                               data1_node *at);
 450
 451 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
 452                                             const char *target,
 453                                             const char **attr,
 454                                             data1_node *at);
 455
 456 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
 457                                                   const char *target,
 458                                                   size_t len,
 459                                                   const char **attr,
 460                                                   data1_node *at);
 461
 462 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
 463                                                 const char *target,
 464                                                 const char **attr,
 465                                                 data1_node *at);
 466
 467 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
 468                                       const char *name);
 469 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
 470                                NMEM nmem, const char *name);
 471
 472 YAZ_EXPORT data1_node *data1_mk_tag_data_zint (data1_handle dh, data1_node *at,
 473                                                const char *tag, zint num,
 474                                                NMEM nmem);
 475 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
 476                                               const char *tag, int num,
 477                                               NMEM nmem);
 478 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
 479                                               const char *tag, Odr_oid *oid,
 480                                               NMEM nmem);
 481 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
 482                                                const char *tag,
 483                                                const char *str,
 484                                                NMEM nmem);
 485 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
 486                                                    data1_node *at,
 487                                                    const char *tag,
 488                                                    const char *str,
 489                                                    NMEM nmem);
 490
 491 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name,
 492                                          enum DATA1_XPATH_INDEXING en);
 493
 494 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
 495                                          const char *tag);
 496 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
 497                                          const char *tag, data1_node *at);
 498 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
 499 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
 500 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
 501                                         data1_maptab *map, NMEM m);
 502 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
 503                                               const char *file);
 504 YAZ_EXPORT data1_marctab *data1_absyn_getmarctab(data1_handle dh,
 505                                                  data1_absyn *absyn);
 506 YAZ_EXPORT data1_element *data1_absyn_getelements(data1_handle dh,
 507                                                  data1_absyn *absyn);
 508 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
 509                                   data1_node *n, int selected, int *len);
 510 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
 511                                     int select, int *len);
 512 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
 513                                                 data1_node *n, int select,
 514                                                 ODR o);
 515 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
 516                                            data1_node *n, int select,
 517                                            ODR o);
 518 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
 519                                   int *len);
 520 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
 521 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
 522 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
 523 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
 524
 525 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
 526 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
 527 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
 528 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
 529 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
 530 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
 531 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
 532 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
 533                                       NMEM m, const char *str);
 534 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
 535                                         NMEM m, const char *str, size_t len);
 536 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
 537                                         const char *buf);
 538 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
 539                                        int (*rf)(void *, char *, size_t),
 540                                        void *fh, NMEM m);
 541 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
 542                                   void (*fh)(data1_handle dh,
 543                                              void *h, data1_absyn *a));
 544
 545 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
 546
 547 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
 548 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
 549 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
 550
 551 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
 552                                    const char *mode);
 553
 554 /* obsolete functions ... */
 555
 556 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
 557 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
 558                                                 data1_node *root,
 559                                                 data1_node *at,
 560                                                 const char *tagname, NMEM m);
 561 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
 562 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
 563                                              data1_node *at,
 564                                              const char *tagname,
 565                                              NMEM m);
 566
 567 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
 568
 569 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
 570                             const char *tocode,
 571                             const char *fromcode);
 572
 573 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
 574
 575 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
 576
 577 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
 578                                            const char *default_value);
 579
 580 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
 581
 582 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);
 583
 584 YAZ_END_CDECL
 585
 586 #endif
 587 /*
 588  * Local variables:
 589  * c-basic-offset: 4
 590  * indent-tabs-mode: nil
 591  * End:
 592  * vim: shiftwidth=4 tabstop=8 expandtab
 593  */
 594