1 /* $Id: data1.h,v 1.9.2.3 2006-09-28 18:38:42 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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 #define ENHANCED_XELM 1
27 #define OPTIMIZE_MELM 1
33 #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;
213 typedef struct data1_xattr {
216 struct data1_xattr *next;
217 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
220 typedef struct data1_absyn
224 data1_tagset *tagset;
225 data1_attset *attset;
226 data1_varset *varset;
227 data1_esetname *esetnames;
228 data1_maptab *maptabs;
230 data1_sub_elements *sub_elements;
231 data1_element *main_elements;
232 data1_xpelement *xp_elements; /* pop */
233 struct data1_systag *systags;
235 int enable_xpath_indexing;
239 * record data node (tag/data/variant)
242 typedef struct data1_node
244 /* the root of a record (containing global data) */
245 #define DATA1N_root 1
248 /* some data under a leaf tag or variant */
249 #define DATA1N_data 3
250 /* variant specification (a triple, actually) */
251 #define DATA1N_variant 4
252 /* comment (same as data) */
253 #define DATA1N_comment 5
254 /* preprocessing instruction */
255 #define DATA1N_preprocess 6
262 data1_absyn *absyn; /* abstract syntax for this type */
268 data1_element *element;
269 int no_data_requested;
271 unsigned node_selected : 1;
272 unsigned make_variantlist : 1;
273 data1_xattr *attributes;
278 char *data; /* filename or data */
281 #define DATA1I_inctxt 1
282 /* binary data inclusion */
283 #define DATA1I_incbin 2
285 #define DATA1I_text 3
288 /* object identifier */
291 #define DATA1I_xmltext 6
293 unsigned formatted_text : 1; /* newlines are significant */
305 data1_xattr *attributes;
309 void (*destroy)(struct data1_node *n);
310 #define DATA1_LOCALDATA 12
311 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
312 struct data1_node *next;
313 struct data1_node *child;
314 struct data1_node *last_child;
315 struct data1_node *parent;
316 struct data1_node *root;
319 YAZ_EXPORT data1_handle data1_create (void);
321 #define DATA1_FLAG_XML 1
322 YAZ_EXPORT data1_handle data1_createx (int flags);
324 YAZ_EXPORT void data1_destroy(data1_handle dh);
325 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
326 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
328 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
329 int (*get_byte)(void *fh), void *fh,
331 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
332 int (*rf)(void *, char *, size_t),
334 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
335 int file_must_exist);
336 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
338 int type, int value);
339 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
340 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
343 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
345 data1_element *parent,
346 const char *tagname);
347 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
350 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
352 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
353 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
354 int select, int *len);
355 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
357 const char *tagname, NMEM m);
358 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
359 const char *tagname, NMEM m);
360 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
361 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
362 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
366 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
367 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
368 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
371 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
374 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
375 int type, data1_node *parent);
377 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
378 const char *tag, const char **attr,
380 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
381 const char *tag, size_t len,
384 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
385 data1_node *res, const char **attr);
387 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
388 const char *buf, size_t len,
390 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
391 const char *buf, size_t len,
393 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
394 const char *buf, data1_node *parent);
396 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
397 const char *buf, size_t len,
400 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
401 const char *buf, data1_node *parent);
403 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
404 const char *target, size_t len,
408 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
413 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
419 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
424 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
426 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
427 NMEM nmem, const char *name);
429 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
430 const char *tag, int num,
432 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
433 const char *tag, Odr_oid *oid,
435 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
439 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
445 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
447 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
449 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
450 const char *tag, data1_node *at);
451 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
452 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
453 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
454 data1_maptab *map, NMEM m);
455 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
457 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
458 data1_node *n, int selected, int *len);
459 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
460 int select, int *len);
461 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
462 data1_node *n, int select,
464 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
465 data1_node *n, int select,
467 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
469 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
470 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
471 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
472 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
474 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
475 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
476 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
477 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
478 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
479 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
480 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
481 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
482 NMEM m, const char *str);
483 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
484 NMEM m, const char *str, size_t len);
485 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
487 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
488 int (*rf)(void *, char *, size_t),
490 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
491 void (*fh)(data1_handle dh,
492 void *h, data1_absyn *a));
494 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
496 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
497 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
498 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
500 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
503 /* obsolete functions ... */
505 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
506 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
509 const char *tagname, NMEM m);
510 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
511 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
516 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
518 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
520 const char *fromcode);
522 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
524 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
526 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
527 const char *default_value);
529 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
531 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);