1 /* $Id: data1.h,v 1.24 2007-06-27 22:04:45 adam Exp $
2 Copyright (C) 1995-2007
5 This file is part of the Zebra server.
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
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
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
29 #include <yaz/proto.h>
30 #include <yaz/yaz-util.h>
32 #include <idzebra/util.h>
34 #define d1_isspace(c) strchr(" \r\n\t\f", c)
35 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
39 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
41 #define DATA1_MAX_SYMBOL 31
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.
54 typedef struct data1_attset data1_attset;
55 typedef struct data1_att data1_att;
56 typedef struct data1_attset_child data1_attset_child;
60 data1_attset *parent; /* attribute set */
61 char *name; /* symbolic name of this attribute */
62 int value; /* attribute value */
66 struct data1_attset_child {
68 data1_attset_child *next;
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 */
80 typedef struct data1_handle_info *data1_handle;
82 YAZ_EXPORT data1_att *data1_getattbyname(data1_handle dh, data1_attset *s,
84 YAZ_EXPORT data1_attset *data1_read_attset(data1_handle dh, const char *file);
86 YAZ_EXPORT data1_attset *data1_empty_attset(data1_handle dh);
88 typedef struct data1_maptag
92 #define D1_MAPTAG_numeric 1
93 #define D1_MAPTAG_string 2
100 struct data1_maptag *next;
103 typedef struct data1_mapunit
106 char *source_element_name;
107 data1_maptag *target_path;
108 struct data1_mapunit *next;
111 typedef struct data1_maptab
114 Odr_oid *oid; /* target abstract syntax */
115 char *target_absyn_name;
117 struct data1_maptab *next;
120 typedef struct data1_name
123 struct data1_name *next;
126 typedef struct data1_absyn_cache_info *data1_absyn_cache;
127 typedef struct data1_attset_cache_info *data1_attset_cache;
128 typedef struct data1_absyn data1_absyn;
130 typedef enum data1_datatype
138 DATA1K_generalizedtime,
145 typedef struct data1_marctab
148 Odr_oid *oid; /* MARC OID */
150 char record_status[2];
151 char implementation_codes[5];
152 int indicator_length;
153 int identifier_length;
154 char user_systems[4];
156 int length_data_entry;
158 int length_implementation;
161 int force_indicator_length;
162 int force_identifier_length;
163 char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */
164 struct data1_marctab *next;
167 typedef struct data1_esetname
171 struct data1_esetname *next;
175 * Variant set definitions.
178 typedef struct data1_vartype
181 struct data1_varclass *zclass;
183 data1_datatype datatype;
184 struct data1_vartype *next;
187 typedef struct data1_varclass
190 struct data1_varset *set;
192 data1_vartype *types;
193 struct data1_varclass *next;
196 typedef struct data1_varset
199 Odr_oid *oid; /* variant OID */
200 data1_varclass *classes;
209 typedef struct data1_tag
212 #define DATA1T_numeric 1
213 #define DATA1T_string 2
222 struct data1_tagset *tagset;
223 struct data1_tag *next;
226 typedef struct data1_tagset data1_tagset;
230 int type; /* type of tagset in current context */
231 char *name; /* symbolic name */
232 Odr_oid *oid; /* variant OID */
233 data1_tag *tags; /* tags defined by this set */
234 data1_tagset *children; /* children */
235 data1_tagset *next; /* sibling */
238 typedef struct data1_termlist
243 struct data1_termlist *next;
247 * abstract syntax specification
250 typedef struct data1_element
254 data1_termlist *termlists;
256 struct data1_element *children;
257 struct data1_element *next;
258 struct data1_hash_table *hash;
261 typedef struct data1_sub_elements {
263 struct data1_sub_elements *next;
264 data1_element *elements;
265 } data1_sub_elements;
267 typedef struct data1_xattr {
270 struct data1_xattr *next;
271 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
276 * record data node (tag/data/variant)
279 typedef struct data1_node
281 /* the root of a record (containing global data) */
282 #define DATA1N_root 1
285 /* some data under a leaf tag or variant */
286 #define DATA1N_data 3
287 /* variant specification (a triple, actually) */
288 #define DATA1N_variant 4
289 /* comment (same as data) */
290 #define DATA1N_comment 5
291 /* preprocessing instruction */
292 #define DATA1N_preprocess 6
299 struct data1_absyn *absyn; /* abstract syntax for this type */
305 data1_element *element;
306 int no_data_requested;
308 unsigned node_selected : 1;
309 unsigned make_variantlist : 1;
310 data1_xattr *attributes;
315 char *data; /* filename or data */
318 #define DATA1I_inctxt 1
319 /* binary data inclusion */
320 #define DATA1I_incbin 2
322 #define DATA1I_text 3
325 /* object identifier */
328 #define DATA1I_xmltext 6
330 unsigned formatted_text : 1; /* newlines are significant */
342 data1_xattr *attributes;
346 #define DATA1_LOCALDATA 12
347 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
348 struct data1_node *next;
349 struct data1_node *child;
350 struct data1_node *last_child;
351 struct data1_node *parent;
352 struct data1_node *root;
355 enum DATA1_XPATH_INDEXING {
356 DATA1_XPATH_INDEXING_DISABLE,
357 DATA1_XPATH_INDEXING_ENABLE
360 YAZ_EXPORT data1_handle data1_create (void);
363 YAZ_EXPORT void data1_destroy(data1_handle dh);
364 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
365 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
367 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
368 int (*get_byte)(void *fh), void *fh,
370 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
371 int (*rf)(void *, char *, size_t),
374 YAZ_EXPORT void data1_remove_node (data1_handle dh, data1_node *n);
375 YAZ_EXPORT void data1_remove_idzebra_subtree (data1_handle dh, data1_node *n);
376 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
378 int type, int value);
379 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
380 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
383 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
385 data1_element *parent,
386 const char *tagname);
387 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
390 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
392 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
393 int select, int *len);
394 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
396 const char *tagname, NMEM m);
397 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
398 const char *tagname, NMEM m);
399 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
400 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
401 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
405 YAZ_EXPORT data1_vartype *data1_getvartypeby_absyn(data1_handle dh,
407 char *zclass, char *type);
408 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
409 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
410 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
413 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
416 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
417 int type, data1_node *parent);
419 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
420 const char *tag, const char **attr,
422 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
423 const char *tag, size_t len,
426 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
427 data1_node *res, const char **attr);
429 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
430 const char *buf, size_t len,
432 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
433 const char *buf, size_t len,
435 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
436 const char *buf, data1_node *parent);
438 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
439 const char *buf, size_t len,
442 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
443 const char *buf, data1_node *parent);
445 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
446 const char *target, size_t len,
450 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
455 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
461 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
466 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
468 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
469 NMEM nmem, const char *name);
471 YAZ_EXPORT data1_node *data1_mk_tag_data_zint (data1_handle dh, data1_node *at,
472 const char *tag, zint num,
474 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
475 const char *tag, int num,
477 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
478 const char *tag, Odr_oid *oid,
480 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
484 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
490 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name,
491 enum DATA1_XPATH_INDEXING en);
493 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
495 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
496 const char *tag, data1_node *at);
497 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
498 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
499 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
500 data1_maptab *map, NMEM m);
501 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
503 YAZ_EXPORT data1_marctab *data1_absyn_getmarctab(data1_handle dh,
505 YAZ_EXPORT data1_element *data1_absyn_getelements(data1_handle dh,
507 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
508 data1_node *n, int selected, int *len);
509 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
510 int select, int *len);
511 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
512 data1_node *n, int select,
514 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
515 data1_node *n, int select,
517 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
519 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
520 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
521 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
522 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
524 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
525 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
526 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
527 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
528 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
529 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
530 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
531 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
532 NMEM m, const char *str);
533 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
534 NMEM m, const char *str, size_t len);
535 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
537 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
538 int (*rf)(void *, char *, size_t),
540 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
541 void (*fh)(data1_handle dh,
542 void *h, data1_absyn *a));
544 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh,
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);
551 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
554 /* obsolete functions ... */
556 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
557 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
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,
567 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
569 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
571 const char *fromcode);
573 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
575 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
577 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
578 const char *default_value);
580 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
581 YAZ_EXPORT void data1_chop_text(data1_handle dh, NMEM m, data1_node *n);
583 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);
585 YAZ_EXPORT const char *data1_absyn_get_staticrank(data1_absyn *absyn);
593 * indent-tabs-mode: nil
595 * vim: shiftwidth=4 tabstop=8 expandtab