1 /* $Id: data1.h,v 1.4 2004-10-04 09:20:31 adam Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
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 Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
30 #include <yaz/proto.h>
32 #include <idzebra/version.h>
33 #include <yaz/yaz-util.h>
34 #include <yaz/wrbuf.h>
36 #define d1_isspace(c) strchr(" \r\n\t\f", c)
37 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
41 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
43 #define DATA1_MAX_SYMBOL 31
46 * This structure describes a attset, perhaps made up by inclusion
47 * (supersetting) of other attribute sets. When indexing and searching,
48 * we perform a normalisation, where we associate a given tag with
49 * the set that originally defined it, rather than the superset. This
50 * allows the most flexible access. Eg, the tags common to GILS and BIB-1
51 * should be searchable by both names.
56 typedef struct data1_local_attribute
59 struct data1_local_attribute *next;
60 } data1_local_attribute;
62 typedef struct data1_attset data1_attset;
63 typedef struct data1_att data1_att;
64 typedef struct data1_attset_child data1_attset_child;
68 data1_attset *parent; /* attribute set */
69 char *name; /* symbolic name of this attribute */
70 int value; /* attribute value */
71 data1_local_attribute *locals; /* local index values */
75 struct data1_attset_child {
77 data1_attset_child *next;
82 char *name; /* symbolic name */
83 oid_value reference; /* external ID of attset */
84 data1_att *atts; /* attributes */
85 data1_attset_child *children; /* included attset */
86 data1_attset *next; /* next in cache */
89 typedef struct data1_handle_info *data1_handle;
91 YAZ_EXPORT data1_att *data1_getattbyname(data1_handle dh, data1_attset *s,
93 YAZ_EXPORT data1_attset *data1_read_attset(data1_handle dh, const char *file);
95 YAZ_EXPORT data1_attset *data1_empty_attset(data1_handle dh);
97 typedef struct data1_maptag
101 #define D1_MAPTAG_numeric 1
102 #define D1_MAPTAG_string 2
109 struct data1_maptag *next;
112 typedef struct data1_mapunit
115 char *source_element_name;
116 data1_maptag *target_path;
117 struct data1_mapunit *next;
120 typedef struct data1_maptab
123 oid_value target_absyn_ref;
124 char *target_absyn_name;
126 struct data1_maptab *next;
129 typedef struct data1_name
132 struct data1_name *next;
135 typedef struct data1_absyn_cache_info *data1_absyn_cache;
136 typedef struct data1_attset_cache_info *data1_attset_cache;
137 typedef struct data1_absyn data1_absyn;
139 typedef enum data1_datatype
147 DATA1K_generalizedtime,
154 typedef struct data1_marctab
159 char record_status[2];
160 char implementation_codes[5];
161 int indicator_length;
162 int identifier_length;
163 char user_systems[4];
165 int length_data_entry;
167 int length_implementation;
170 int force_indicator_length;
171 int force_identifier_length;
172 char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */
173 struct data1_marctab *next;
176 typedef struct data1_esetname
180 struct data1_esetname *next;
184 * Variant set definitions.
187 typedef struct data1_vartype
190 struct data1_varclass *zclass;
192 data1_datatype datatype;
193 struct data1_vartype *next;
196 typedef struct data1_varclass
199 struct data1_varset *set;
201 data1_vartype *types;
202 struct data1_varclass *next;
205 typedef struct data1_varset
209 data1_varclass *classes;
218 typedef struct data1_tag
221 #define DATA1T_numeric 1
222 #define DATA1T_string 2
231 struct data1_tagset *tagset;
232 struct data1_tag *next;
235 typedef struct data1_tagset data1_tagset;
239 int type; /* type of tagset in current context */
240 char *name; /* symbolic name */
242 data1_tag *tags; /* tags defined by this set */
243 data1_tagset *children; /* children */
244 data1_tagset *next; /* sibling */
247 typedef struct data1_termlist
252 struct data1_termlist *next;
256 * abstract syntax specification
259 typedef struct data1_element
263 data1_termlist *termlists;
265 struct data1_element *children;
266 struct data1_element *next;
267 struct data1_hash_table *hash;
270 typedef struct data1_sub_elements {
272 struct data1_sub_elements *next;
273 data1_element *elements;
274 } data1_sub_elements;
276 typedef struct data1_xattr {
279 struct data1_xattr *next;
280 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
285 * record data node (tag/data/variant)
288 typedef struct data1_node
290 /* the root of a record (containing global data) */
291 #define DATA1N_root 1
294 /* some data under a leaf tag or variant */
295 #define DATA1N_data 3
296 /* variant specification (a triple, actually) */
297 #define DATA1N_variant 4
298 /* comment (same as data) */
299 #define DATA1N_comment 5
300 /* preprocessing instruction */
301 #define DATA1N_preprocess 6
308 struct data1_absyn *absyn; /* abstract syntax for this type */
314 data1_element *element;
315 int no_data_requested;
317 unsigned node_selected : 1;
318 unsigned make_variantlist : 1;
319 data1_xattr *attributes;
324 char *data; /* filename or data */
327 #define DATA1I_inctxt 1
328 /* binary data inclusion */
329 #define DATA1I_incbin 2
331 #define DATA1I_text 3
334 /* object identifier */
337 #define DATA1I_xmltext 6
339 unsigned formatted_text : 1; /* newlines are significant */
351 data1_xattr *attributes;
355 void (*destroy)(struct data1_node *n);
356 #define DATA1_LOCALDATA 12
357 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
358 struct data1_node *next;
359 struct data1_node *child;
360 struct data1_node *last_child;
361 struct data1_node *parent;
362 struct data1_node *root;
365 YAZ_EXPORT data1_handle data1_create (void);
367 #define DATA1_FLAG_XML 1
368 YAZ_EXPORT data1_handle data1_createx (int flags);
370 YAZ_EXPORT void data1_destroy(data1_handle dh);
371 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
372 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
374 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
375 int (*get_byte)(void *fh), void *fh,
377 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
378 int (*rf)(void *, char *, size_t),
380 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
381 int file_must_exist);
382 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
384 int type, int value);
385 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
386 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
389 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
391 data1_element *parent,
392 const char *tagname);
393 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
396 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
398 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
399 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
400 int select, int *len);
401 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
403 const char *tagname, NMEM m);
404 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
405 const char *tagname, NMEM m);
406 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
407 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
408 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
410 char *zclass, char *type);
411 YAZ_EXPORT data1_vartype *data1_getvartypeby_absyn(data1_handle dh,
413 char *zclass, char *type);
414 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
415 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
416 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
419 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
422 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
423 int type, data1_node *parent);
425 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
426 const char *tag, const char **attr,
428 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
429 const char *tag, size_t len,
432 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
433 data1_node *res, const char **attr);
435 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
436 const char *buf, size_t len,
438 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
439 const char *buf, size_t len,
441 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
442 const char *buf, data1_node *parent);
444 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
445 const char *buf, size_t len,
448 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
449 const char *buf, data1_node *parent);
451 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
452 const char *target, size_t len,
456 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
461 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
467 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
472 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
474 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
475 NMEM nmem, const char *name);
477 YAZ_EXPORT data1_node *data1_mk_tag_data_zint (data1_handle dh, data1_node *at,
478 const char *tag, zint num,
480 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
481 const char *tag, int num,
483 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
484 const char *tag, Odr_oid *oid,
486 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
490 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
496 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
498 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
500 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
501 const char *tag, data1_node *at);
502 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
503 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
504 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
505 data1_maptab *map, NMEM m);
506 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
508 YAZ_EXPORT data1_marctab *data1_absyn_getmarctab(data1_handle dh,
510 YAZ_EXPORT data1_element *data1_absyn_getelements(data1_handle dh,
512 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
513 data1_node *n, int selected, int *len);
514 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
515 int select, int *len);
516 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
517 data1_node *n, int select,
519 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
520 data1_node *n, int select,
522 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
524 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
525 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
526 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
527 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
529 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
530 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
531 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
532 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
533 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
534 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
535 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
536 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
537 NMEM m, const char *str);
538 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
539 NMEM m, const char *str, size_t len);
540 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
542 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
543 int (*rf)(void *, char *, size_t),
545 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
546 void (*fh)(data1_handle dh,
547 void *h, data1_absyn *a));
549 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
551 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
552 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
553 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
555 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
558 /* obsolete functions ... */
560 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
561 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
564 const char *tagname, NMEM m);
565 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
566 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
571 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
573 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
575 const char *fromcode);
577 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
579 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
581 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
582 const char *default_value);
584 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
586 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);