2 * Copyright (c) 1995-2002, Index Data.
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation, in whole or in part, for any purpose, is hereby granted,
8 * 1. This copyright and permission notice appear in all copies of the
9 * software and its documentation. Notices of copyright or attribution
10 * which appear at the beginning of any file must remain unchanged.
12 * 2. The names of Index Data or the individual authors may not be used to
13 * endorse or promote products derived from this software without specific
14 * prior written permission.
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20 * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22 * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
26 * $Id: data1.h,v 1.1 2002-10-22 12:51:08 adam Exp $
36 #include <yaz/proto.h>
38 #include <d1_attset.h>
40 #include <yaz/yaz-util.h>
41 #include <yaz/wrbuf.h>
43 #define d1_isspace(c) strchr(" \r\n\t\f", c)
44 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
48 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
50 #define DATA1_MAX_SYMBOL 31
52 typedef struct data1_name
55 struct data1_name *next;
58 typedef struct data1_absyn_cache_info *data1_absyn_cache;
59 typedef struct data1_attset_cache_info *data1_attset_cache;
61 typedef enum data1_datatype
69 DATA1K_generalizedtime,
76 typedef struct data1_marctab
81 char record_status[2];
82 char implementation_codes[5];
84 int identifier_length;
87 int length_data_entry;
89 int length_implementation;
92 int force_indicator_length;
93 int force_identifier_length;
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;
196 typedef struct data1_xattr {
199 struct data1_xattr *next;
200 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
203 typedef struct data1_absyn
207 data1_tagset *tagset;
208 data1_attset *attset;
209 data1_varset *varset;
210 data1_esetname *esetnames;
211 data1_maptab *maptabs;
213 data1_sub_elements *sub_elements;
214 data1_element *main_elements;
216 int enable_xpath_indexing;
220 * record data node (tag/data/variant)
223 typedef struct data1_node
225 /* the root of a record (containing global data) */
226 #define DATA1N_root 1
229 /* some data under a leaf tag or variant */
230 #define DATA1N_data 3
231 /* variant specification (a triple, actually) */
232 #define DATA1N_variant 4
233 /* comment (same as data) */
234 #define DATA1N_comment 5
235 /* preprocessing instruction */
236 #define DATA1N_preprocess 6
243 data1_absyn *absyn; /* abstract syntax for this type */
249 data1_element *element;
250 int no_data_requested;
252 unsigned node_selected : 1;
253 unsigned make_variantlist : 1;
254 data1_xattr *attributes;
259 char *data; /* filename or data */
262 #define DATA1I_inctxt 1
263 /* binary data inclusion */
264 #define DATA1I_incbin 2
266 #define DATA1I_text 3
269 /* object identifier */
272 #define DATA1I_xmltext 6
274 unsigned formatted_text : 1; /* newlines are significant */
286 data1_xattr *attributes;
290 void (*destroy)(struct data1_node *n);
291 #define DATA1_LOCALDATA 12
292 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
293 struct data1_node *next;
294 struct data1_node *child;
295 struct data1_node *last_child;
296 struct data1_node *parent;
297 struct data1_node *root;
300 YAZ_EXPORT data1_handle data1_create (void);
302 #define DATA1_FLAG_XML 1
303 YAZ_EXPORT data1_handle data1_createx (int flags);
305 YAZ_EXPORT void data1_destroy(data1_handle dh);
306 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
307 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
309 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
310 int (*get_byte)(void *fh), void *fh,
312 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
313 int (*rf)(void *, char *, size_t),
315 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
316 int file_must_exist);
317 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
319 int type, int value);
320 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
321 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
324 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
326 data1_element *parent,
327 const char *tagname);
328 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
331 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
333 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
334 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
335 int select, int *len);
336 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
338 const char *tagname, NMEM m);
339 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
340 const char *tagname, NMEM m);
341 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
342 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
343 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
345 char *zclass, char *type);
346 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
347 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
348 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
351 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
354 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
355 int type, data1_node *parent);
357 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
358 const char *tag, const char **attr,
360 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
361 const char *tag, size_t len,
364 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
365 data1_node *res, const char **attr);
367 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
368 const char *buf, size_t len,
370 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
371 const char *buf, size_t len,
373 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
374 const char *buf, data1_node *parent);
376 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
377 const char *buf, size_t len,
380 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
381 const char *buf, data1_node *parent);
383 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
384 const char *target, size_t len,
388 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
393 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
395 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
396 NMEM nmem, const char *name);
398 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
399 const char *tag, int num,
401 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
402 const char *tag, Odr_oid *oid,
404 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
408 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
414 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
416 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
418 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
419 const char *tag, data1_node *at);
420 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
421 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
422 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
423 data1_maptab *map, NMEM m);
424 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
426 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
427 data1_node *n, int selected, int *len);
428 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
429 int select, int *len);
430 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
431 data1_node *n, int select,
433 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
434 data1_node *n, int select,
436 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
438 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
439 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
440 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
441 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
443 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
444 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
445 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
446 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
447 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
448 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
449 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
450 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
451 NMEM m, const char *str);
452 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
453 NMEM m, const char *str, size_t len);
454 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
456 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
457 int (*rf)(void *, char *, size_t),
459 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
460 void (*fh)(data1_handle dh,
461 void *h, data1_absyn *a));
463 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
465 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
466 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
467 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
469 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
472 /* obsolete functions ... */
474 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
475 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
478 const char *tagname, NMEM m);
479 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
480 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
485 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
487 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
489 const char *fromcode);
491 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
493 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);