include/data1.h

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