1 /* $Id: data1.h,v 1.20 2006-12-22 13:57:26 adam Exp $
2 Copyright (C) 1995-2006
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
30 #include <yaz/proto.h>
31 #include <yaz/yaz-util.h>
33 #include <idzebra/util.h>
35 #define d1_isspace(c) strchr(" \r\n\t\f", c)
36 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
40 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
42 #define DATA1_MAX_SYMBOL 31
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.
55 typedef struct data1_attset data1_attset;
56 typedef struct data1_att data1_att;
57 typedef struct data1_attset_child data1_attset_child;
61 data1_attset *parent; /* attribute set */
62 char *name; /* symbolic name of this attribute */
63 int value; /* attribute value */
67 struct data1_attset_child {
69 data1_attset_child *next;
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 */
81 typedef struct data1_handle_info *data1_handle;
83 YAZ_EXPORT data1_att *data1_getattbyname(data1_handle dh, data1_attset *s,
85 YAZ_EXPORT data1_attset *data1_read_attset(data1_handle dh, const char *file);
87 YAZ_EXPORT data1_attset *data1_empty_attset(data1_handle dh);
89 typedef struct data1_maptag
93 #define D1_MAPTAG_numeric 1
94 #define D1_MAPTAG_string 2
101 struct data1_maptag *next;
104 typedef struct data1_mapunit
107 char *source_element_name;
108 data1_maptag *target_path;
109 struct data1_mapunit *next;
112 typedef struct data1_maptab
115 oid_value target_absyn_ref;
116 char *target_absyn_name;
118 struct data1_maptab *next;
121 typedef struct data1_name
124 struct data1_name *next;
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;
131 typedef enum data1_datatype
139 DATA1K_generalizedtime,
146 typedef struct data1_marctab
151 char record_status[2];
152 char implementation_codes[5];
153 int indicator_length;
154 int identifier_length;
155 char user_systems[4];
157 int length_data_entry;
159 int length_implementation;
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;
168 typedef struct data1_esetname
172 struct data1_esetname *next;
176 * Variant set definitions.
179 typedef struct data1_vartype
182 struct data1_varclass *zclass;
184 data1_datatype datatype;
185 struct data1_vartype *next;
188 typedef struct data1_varclass
191 struct data1_varset *set;
193 data1_vartype *types;
194 struct data1_varclass *next;
197 typedef struct data1_varset
201 data1_varclass *classes;
210 typedef struct data1_tag
213 #define DATA1T_numeric 1
214 #define DATA1T_string 2
223 struct data1_tagset *tagset;
224 struct data1_tag *next;
227 typedef struct data1_tagset data1_tagset;
231 int type; /* type of tagset in current context */
232 char *name; /* symbolic name */
234 data1_tag *tags; /* tags defined by this set */
235 data1_tagset *children; /* children */
236 data1_tagset *next; /* sibling */
239 typedef struct data1_termlist
244 struct data1_termlist *next;
248 * abstract syntax specification
251 typedef struct data1_element
255 data1_termlist *termlists;
257 struct data1_element *children;
258 struct data1_element *next;
259 struct data1_hash_table *hash;
262 typedef struct data1_sub_elements {
264 struct data1_sub_elements *next;
265 data1_element *elements;
266 } data1_sub_elements;
268 typedef struct data1_xattr {
271 struct data1_xattr *next;
272 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
277 * record data node (tag/data/variant)
280 typedef struct data1_node
282 /* the root of a record (containing global data) */
283 #define DATA1N_root 1
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
300 struct data1_absyn *absyn; /* abstract syntax for this type */
306 data1_element *element;
307 int no_data_requested;
309 unsigned node_selected : 1;
310 unsigned make_variantlist : 1;
311 data1_xattr *attributes;
316 char *data; /* filename or data */
319 #define DATA1I_inctxt 1
320 /* binary data inclusion */
321 #define DATA1I_incbin 2
323 #define DATA1I_text 3
326 /* object identifier */
329 #define DATA1I_xmltext 6
331 unsigned formatted_text : 1; /* newlines are significant */
343 data1_xattr *attributes;
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;
356 enum DATA1_XPATH_INDEXING {
357 DATA1_XPATH_INDEXING_DISABLE,
358 DATA1_XPATH_INDEXING_ENABLE
361 YAZ_EXPORT data1_handle data1_create (void);
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,
368 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
369 int (*get_byte)(void *fh), void *fh,
371 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
372 int (*rf)(void *, char *, size_t),
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,
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,
384 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
386 data1_element *parent,
387 const char *tagname);
388 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
391 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
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,
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,
406 YAZ_EXPORT data1_vartype *data1_getvartypeby_absyn(data1_handle dh,
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,
414 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
417 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
418 int type, data1_node *parent);
420 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
421 const char *tag, const char **attr,
423 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
424 const char *tag, size_t len,
427 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
428 data1_node *res, const char **attr);
430 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
431 const char *buf, size_t len,
433 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
434 const char *buf, size_t len,
436 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
437 const char *buf, data1_node *parent);
439 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
440 const char *buf, size_t len,
443 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
444 const char *buf, data1_node *parent);
446 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
447 const char *target, size_t len,
451 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
456 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
462 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
467 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
469 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
470 NMEM nmem, const char *name);
472 YAZ_EXPORT data1_node *data1_mk_tag_data_zint (data1_handle dh, data1_node *at,
473 const char *tag, zint num,
475 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
476 const char *tag, int num,
478 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
479 const char *tag, Odr_oid *oid,
481 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
485 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
491 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name,
492 enum DATA1_XPATH_INDEXING en);
494 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
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,
504 YAZ_EXPORT data1_marctab *data1_absyn_getmarctab(data1_handle dh,
506 YAZ_EXPORT data1_element *data1_absyn_getelements(data1_handle dh,
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,
515 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
516 data1_node *n, int select,
518 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
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);
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,
538 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
539 int (*rf)(void *, char *, size_t),
541 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
542 void (*fh)(data1_handle dh,
543 void *h, data1_absyn *a));
545 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
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);
582 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);
584 YAZ_EXPORT const char *data1_absyn_get_staticrank(data1_absyn *absyn);
592 * indent-tabs-mode: nil
594 * vim: shiftwidth=4 tabstop=8 expandtab