include/data1.h

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