1 /* $Id: data1.h,v 1.6 2003-02-28 12:33:38 oleg Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002
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>
34 #include <d1_attset.h>
36 #include <yaz/yaz-util.h>
37 #include <yaz/wrbuf.h>
38 #include <dfa.h> /* pop */
39 #include <zebra_xpath.h> /* pop */
41 #define d1_isspace(c) strchr(" \r\n\t\f", c)
42 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
46 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
48 #define DATA1_MAX_SYMBOL 31
50 typedef struct data1_name
53 struct data1_name *next;
56 typedef struct data1_absyn_cache_info *data1_absyn_cache;
57 typedef struct data1_attset_cache_info *data1_attset_cache;
59 typedef enum data1_datatype
67 DATA1K_generalizedtime,
74 typedef struct data1_marctab
79 char record_status[2];
80 char implementation_codes[5];
82 int identifier_length;
85 int length_data_entry;
87 int length_implementation;
90 int force_indicator_length;
91 int force_identifier_length;
92 char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */
93 struct data1_marctab *next;
96 typedef struct data1_esetname
100 struct data1_esetname *next;
104 * Variant set definitions.
107 typedef struct data1_vartype
110 struct data1_varclass *zclass;
112 data1_datatype datatype;
113 struct data1_vartype *next;
116 typedef struct data1_varclass
119 struct data1_varset *set;
121 data1_vartype *types;
122 struct data1_varclass *next;
125 typedef struct data1_varset
129 data1_varclass *classes;
138 typedef struct data1_tag
141 #define DATA1T_numeric 1
142 #define DATA1T_string 2
151 struct data1_tagset *tagset;
152 struct data1_tag *next;
155 typedef struct data1_tagset data1_tagset;
159 int type; /* type of tagset in current context */
160 char *name; /* symbolic name */
162 data1_tag *tags; /* tags defined by this set */
163 data1_tagset *children; /* children */
164 data1_tagset *next; /* sibling */
167 typedef struct data1_termlist
172 struct data1_termlist *next;
176 * abstract syntax specification
179 typedef struct data1_element
183 data1_termlist *termlists;
185 struct data1_element *children;
186 struct data1_element *next;
189 typedef struct data1_sub_elements {
191 struct data1_sub_elements *next;
192 data1_element *elements;
193 } data1_sub_elements;
196 typedef struct data1_xpelement
200 struct xpath_location_step xpath[XPATH_STEP_COUNT];
204 data1_termlist *termlists;
205 struct data1_xpelement *next;
208 typedef struct data1_xattr {
211 struct data1_xattr *next;
212 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
216 typedef struct data1_absyn data1_absyn;
218 typedef struct data1_absyn
222 data1_tagset *tagset;
223 data1_attset *attset;
224 data1_varset *varset;
225 data1_esetname *esetnames;
226 data1_maptab *maptabs;
228 data1_sub_elements *sub_elements;
229 data1_element *main_elements;
230 data1_xpelement *xp_elements; /* pop */
231 struct data1_systag *systags;
233 int enable_xpath_indexing;
237 * record data node (tag/data/variant)
240 typedef struct data1_node
242 /* the root of a record (containing global data) */
243 #define DATA1N_root 1
246 /* some data under a leaf tag or variant */
247 #define DATA1N_data 3
248 /* variant specification (a triple, actually) */
249 #define DATA1N_variant 4
250 /* comment (same as data) */
251 #define DATA1N_comment 5
252 /* preprocessing instruction */
253 #define DATA1N_preprocess 6
260 data1_absyn *absyn; /* abstract syntax for this type */
266 data1_element *element;
267 int no_data_requested;
269 unsigned node_selected : 1;
270 unsigned make_variantlist : 1;
271 data1_xattr *attributes;
276 char *data; /* filename or data */
279 #define DATA1I_inctxt 1
280 /* binary data inclusion */
281 #define DATA1I_incbin 2
283 #define DATA1I_text 3
286 /* object identifier */
289 #define DATA1I_xmltext 6
291 unsigned formatted_text : 1; /* newlines are significant */
303 data1_xattr *attributes;
307 void (*destroy)(struct data1_node *n);
308 #define DATA1_LOCALDATA 12
309 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
310 struct data1_node *next;
311 struct data1_node *child;
312 struct data1_node *last_child;
313 struct data1_node *parent;
314 struct data1_node *root;
317 YAZ_EXPORT data1_handle data1_create (void);
319 #define DATA1_FLAG_XML 1
320 YAZ_EXPORT data1_handle data1_createx (int flags);
322 YAZ_EXPORT void data1_destroy(data1_handle dh);
323 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
324 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
326 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
327 int (*get_byte)(void *fh), void *fh,
329 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
330 int (*rf)(void *, char *, size_t),
332 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
333 int file_must_exist);
334 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
336 int type, int value);
337 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
338 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
341 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
343 data1_element *parent,
344 const char *tagname);
345 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
348 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
350 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
351 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
352 int select, int *len);
353 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
355 const char *tagname, NMEM m);
356 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
357 const char *tagname, NMEM m);
358 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
359 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
360 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
362 char *zclass, char *type);
363 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
364 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
365 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
368 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
371 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
372 int type, data1_node *parent);
374 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
375 const char *tag, const char **attr,
377 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
378 const char *tag, size_t len,
381 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
382 data1_node *res, const char **attr);
384 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
385 const char *buf, size_t len,
387 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
388 const char *buf, size_t len,
390 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
391 const char *buf, data1_node *parent);
393 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
394 const char *buf, size_t len,
397 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
398 const char *buf, data1_node *parent);
400 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
401 const char *target, size_t len,
405 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
410 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
412 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
413 NMEM nmem, const char *name);
415 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
416 const char *tag, int num,
418 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
419 const char *tag, Odr_oid *oid,
421 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
425 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
431 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
433 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
435 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
436 const char *tag, data1_node *at);
437 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
438 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
439 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
440 data1_maptab *map, NMEM m);
441 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
443 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
444 data1_node *n, int selected, int *len);
445 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
446 int select, int *len);
447 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
448 data1_node *n, int select,
450 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
451 data1_node *n, int select,
453 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
455 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
456 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
457 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
458 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
460 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
461 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
462 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
463 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
464 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
465 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
466 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
467 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
468 NMEM m, const char *str);
469 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
470 NMEM m, const char *str, size_t len);
471 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
473 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
474 int (*rf)(void *, char *, size_t),
476 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
477 void (*fh)(data1_handle dh,
478 void *h, data1_absyn *a));
480 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
482 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
483 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
484 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
486 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
489 /* obsolete functions ... */
491 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
492 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
495 const char *tagname, NMEM m);
496 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
497 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
502 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
504 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
506 const char *fromcode);
508 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
510 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
512 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
513 const char *default_value);