include/idzebra/data1.h

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