1 /* $Id: data1.h,v 1.10 2004-08-04 08:35:23 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
26 #define ENHANCED_XELM 1
32 #include <yaz/proto.h>
35 #include <d1_attset.h>
37 #include <yaz/yaz-util.h>
38 #include <yaz/wrbuf.h>
39 #include <dfa.h> /* pop */
40 #include <zebra_xpath.h> /* pop */
42 #define d1_isspace(c) strchr(" \r\n\t\f", c)
43 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
47 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
49 #define DATA1_MAX_SYMBOL 31
51 typedef struct data1_name
54 struct data1_name *next;
57 typedef struct data1_absyn_cache_info *data1_absyn_cache;
58 typedef struct data1_attset_cache_info *data1_attset_cache;
60 typedef enum data1_datatype
68 DATA1K_generalizedtime,
75 typedef struct data1_marctab
80 char record_status[2];
81 char implementation_codes[5];
83 int identifier_length;
86 int length_data_entry;
88 int length_implementation;
91 int force_indicator_length;
92 int force_identifier_length;
93 char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */
94 struct data1_marctab *next;
97 typedef struct data1_esetname
101 struct data1_esetname *next;
105 * Variant set definitions.
108 typedef struct data1_vartype
111 struct data1_varclass *zclass;
113 data1_datatype datatype;
114 struct data1_vartype *next;
117 typedef struct data1_varclass
120 struct data1_varset *set;
122 data1_vartype *types;
123 struct data1_varclass *next;
126 typedef struct data1_varset
130 data1_varclass *classes;
139 typedef struct data1_tag
142 #define DATA1T_numeric 1
143 #define DATA1T_string 2
152 struct data1_tagset *tagset;
153 struct data1_tag *next;
156 typedef struct data1_tagset data1_tagset;
160 int type; /* type of tagset in current context */
161 char *name; /* symbolic name */
163 data1_tag *tags; /* tags defined by this set */
164 data1_tagset *children; /* children */
165 data1_tagset *next; /* sibling */
168 typedef struct data1_termlist
173 struct data1_termlist *next;
177 * abstract syntax specification
180 typedef struct data1_element
184 data1_termlist *termlists;
186 struct data1_element *children;
187 struct data1_element *next;
190 typedef struct data1_sub_elements {
192 struct data1_sub_elements *next;
193 data1_element *elements;
194 } data1_sub_elements;
197 typedef struct data1_xpelement
201 struct xpath_location_step xpath[XPATH_STEP_COUNT];
205 data1_termlist *termlists;
206 struct data1_xpelement *next;
209 typedef struct data1_xattr {
212 struct data1_xattr *next;
213 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
217 typedef struct data1_absyn data1_absyn;
219 typedef struct data1_absyn
223 data1_tagset *tagset;
224 data1_attset *attset;
225 data1_varset *varset;
226 data1_esetname *esetnames;
227 data1_maptab *maptabs;
229 data1_sub_elements *sub_elements;
230 data1_element *main_elements;
231 data1_xpelement *xp_elements; /* pop */
232 struct data1_systag *systags;
234 int enable_xpath_indexing;
238 * record data node (tag/data/variant)
241 typedef struct data1_node
243 /* the root of a record (containing global data) */
244 #define DATA1N_root 1
247 /* some data under a leaf tag or variant */
248 #define DATA1N_data 3
249 /* variant specification (a triple, actually) */
250 #define DATA1N_variant 4
251 /* comment (same as data) */
252 #define DATA1N_comment 5
253 /* preprocessing instruction */
254 #define DATA1N_preprocess 6
261 data1_absyn *absyn; /* abstract syntax for this type */
267 data1_element *element;
268 int no_data_requested;
270 unsigned node_selected : 1;
271 unsigned make_variantlist : 1;
272 data1_xattr *attributes;
277 char *data; /* filename or data */
280 #define DATA1I_inctxt 1
281 /* binary data inclusion */
282 #define DATA1I_incbin 2
284 #define DATA1I_text 3
287 /* object identifier */
290 #define DATA1I_xmltext 6
292 unsigned formatted_text : 1; /* newlines are significant */
304 data1_xattr *attributes;
308 void (*destroy)(struct data1_node *n);
309 #define DATA1_LOCALDATA 12
310 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
311 struct data1_node *next;
312 struct data1_node *child;
313 struct data1_node *last_child;
314 struct data1_node *parent;
315 struct data1_node *root;
318 YAZ_EXPORT data1_handle data1_create (void);
320 #define DATA1_FLAG_XML 1
321 YAZ_EXPORT data1_handle data1_createx (int flags);
323 YAZ_EXPORT void data1_destroy(data1_handle dh);
324 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
325 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
327 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
328 int (*get_byte)(void *fh), void *fh,
330 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
331 int (*rf)(void *, char *, size_t),
333 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
334 int file_must_exist);
335 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
337 int type, int value);
338 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
339 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
342 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
344 data1_element *parent,
345 const char *tagname);
346 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
349 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
351 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
352 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
353 int select, int *len);
354 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
356 const char *tagname, NMEM m);
357 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
358 const char *tagname, NMEM m);
359 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
360 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
361 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
363 char *zclass, char *type);
364 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
365 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
366 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
369 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
372 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
373 int type, data1_node *parent);
375 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
376 const char *tag, const char **attr,
378 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
379 const char *tag, size_t len,
382 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
383 data1_node *res, const char **attr);
385 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
386 const char *buf, size_t len,
388 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
389 const char *buf, size_t len,
391 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
392 const char *buf, data1_node *parent);
394 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
395 const char *buf, size_t len,
398 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
399 const char *buf, data1_node *parent);
401 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
402 const char *target, size_t len,
406 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
411 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
417 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
422 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
424 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
425 NMEM nmem, const char *name);
427 YAZ_EXPORT data1_node *data1_mk_tag_data_zint (data1_handle dh, data1_node *at,
428 const char *tag, zint num,
430 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
431 const char *tag, int num,
433 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
434 const char *tag, Odr_oid *oid,
436 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
440 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
446 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
448 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
450 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
451 const char *tag, data1_node *at);
452 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
453 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
454 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
455 data1_maptab *map, NMEM m);
456 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
458 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
459 data1_node *n, int selected, int *len);
460 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
461 int select, int *len);
462 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
463 data1_node *n, int select,
465 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
466 data1_node *n, int select,
468 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
470 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
471 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
472 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
473 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
475 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
476 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
477 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
478 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
479 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
480 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
481 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
482 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
483 NMEM m, const char *str);
484 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
485 NMEM m, const char *str, size_t len);
486 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
488 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
489 int (*rf)(void *, char *, size_t),
491 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
492 void (*fh)(data1_handle dh,
493 void *h, data1_absyn *a));
495 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
497 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
498 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
499 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
501 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
504 /* obsolete functions ... */
506 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
507 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
510 const char *tagname, NMEM m);
511 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
512 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
517 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
519 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
521 const char *fromcode);
523 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
525 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
527 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
528 const char *default_value);
530 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
532 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);