1 /* $Id: data1.h,v 1.2 2002-10-22 13:19:50 adam 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
30 #include <yaz/proto.h>
32 #include <d1_attset.h>
34 #include <yaz/yaz-util.h>
35 #include <yaz/wrbuf.h>
37 #define d1_isspace(c) strchr(" \r\n\t\f", c)
38 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
42 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
44 #define DATA1_MAX_SYMBOL 31
46 typedef struct data1_name
49 struct data1_name *next;
52 typedef struct data1_absyn_cache_info *data1_absyn_cache;
53 typedef struct data1_attset_cache_info *data1_attset_cache;
55 typedef enum data1_datatype
63 DATA1K_generalizedtime,
70 typedef struct data1_marctab
75 char record_status[2];
76 char implementation_codes[5];
78 int identifier_length;
81 int length_data_entry;
83 int length_implementation;
86 int force_indicator_length;
87 int force_identifier_length;
88 struct data1_marctab *next;
91 typedef struct data1_esetname
95 struct data1_esetname *next;
99 * Variant set definitions.
102 typedef struct data1_vartype
105 struct data1_varclass *zclass;
107 data1_datatype datatype;
108 struct data1_vartype *next;
111 typedef struct data1_varclass
114 struct data1_varset *set;
116 data1_vartype *types;
117 struct data1_varclass *next;
120 typedef struct data1_varset
124 data1_varclass *classes;
133 typedef struct data1_tag
136 #define DATA1T_numeric 1
137 #define DATA1T_string 2
146 struct data1_tagset *tagset;
147 struct data1_tag *next;
150 typedef struct data1_tagset data1_tagset;
154 int type; /* type of tagset in current context */
155 char *name; /* symbolic name */
157 data1_tag *tags; /* tags defined by this set */
158 data1_tagset *children; /* children */
159 data1_tagset *next; /* sibling */
162 typedef struct data1_termlist
167 struct data1_termlist *next;
171 * abstract syntax specification
174 typedef struct data1_element
178 data1_termlist *termlists;
180 struct data1_element *children;
181 struct data1_element *next;
184 typedef struct data1_sub_elements {
186 struct data1_sub_elements *next;
187 data1_element *elements;
188 } data1_sub_elements;
190 typedef struct data1_xattr {
193 struct data1_xattr *next;
194 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
197 typedef struct data1_absyn
201 data1_tagset *tagset;
202 data1_attset *attset;
203 data1_varset *varset;
204 data1_esetname *esetnames;
205 data1_maptab *maptabs;
207 data1_sub_elements *sub_elements;
208 data1_element *main_elements;
210 int enable_xpath_indexing;
214 * record data node (tag/data/variant)
217 typedef struct data1_node
219 /* the root of a record (containing global data) */
220 #define DATA1N_root 1
223 /* some data under a leaf tag or variant */
224 #define DATA1N_data 3
225 /* variant specification (a triple, actually) */
226 #define DATA1N_variant 4
227 /* comment (same as data) */
228 #define DATA1N_comment 5
229 /* preprocessing instruction */
230 #define DATA1N_preprocess 6
237 data1_absyn *absyn; /* abstract syntax for this type */
243 data1_element *element;
244 int no_data_requested;
246 unsigned node_selected : 1;
247 unsigned make_variantlist : 1;
248 data1_xattr *attributes;
253 char *data; /* filename or data */
256 #define DATA1I_inctxt 1
257 /* binary data inclusion */
258 #define DATA1I_incbin 2
260 #define DATA1I_text 3
263 /* object identifier */
266 #define DATA1I_xmltext 6
268 unsigned formatted_text : 1; /* newlines are significant */
280 data1_xattr *attributes;
284 void (*destroy)(struct data1_node *n);
285 #define DATA1_LOCALDATA 12
286 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
287 struct data1_node *next;
288 struct data1_node *child;
289 struct data1_node *last_child;
290 struct data1_node *parent;
291 struct data1_node *root;
294 YAZ_EXPORT data1_handle data1_create (void);
296 #define DATA1_FLAG_XML 1
297 YAZ_EXPORT data1_handle data1_createx (int flags);
299 YAZ_EXPORT void data1_destroy(data1_handle dh);
300 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
301 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
303 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
304 int (*get_byte)(void *fh), void *fh,
306 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
307 int (*rf)(void *, char *, size_t),
309 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
310 int file_must_exist);
311 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
313 int type, int value);
314 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
315 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
318 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
320 data1_element *parent,
321 const char *tagname);
322 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
325 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
327 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
328 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
329 int select, int *len);
330 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
332 const char *tagname, NMEM m);
333 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
334 const char *tagname, NMEM m);
335 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
336 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
337 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
339 char *zclass, char *type);
340 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
341 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
342 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
345 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
348 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
349 int type, data1_node *parent);
351 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
352 const char *tag, const char **attr,
354 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
355 const char *tag, size_t len,
358 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
359 data1_node *res, const char **attr);
361 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
362 const char *buf, size_t len,
364 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
365 const char *buf, size_t len,
367 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
368 const char *buf, data1_node *parent);
370 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
371 const char *buf, size_t len,
374 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
375 const char *buf, data1_node *parent);
377 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
378 const char *target, size_t len,
382 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
387 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
389 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
390 NMEM nmem, const char *name);
392 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
393 const char *tag, int num,
395 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
396 const char *tag, Odr_oid *oid,
398 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
402 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
408 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
410 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
412 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
413 const char *tag, data1_node *at);
414 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
415 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
416 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
417 data1_maptab *map, NMEM m);
418 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
420 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
421 data1_node *n, int selected, int *len);
422 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
423 int select, int *len);
424 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
425 data1_node *n, int select,
427 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
428 data1_node *n, int select,
430 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
432 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
433 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
434 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
435 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
437 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
438 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
439 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
440 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
441 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
442 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
443 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
444 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
445 NMEM m, const char *str);
446 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
447 NMEM m, const char *str, size_t len);
448 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
450 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
451 int (*rf)(void *, char *, size_t),
453 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
454 void (*fh)(data1_handle dh,
455 void *h, data1_absyn *a));
457 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
459 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
460 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
461 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
463 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
466 /* obsolete functions ... */
468 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
469 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
472 const char *tagname, NMEM m);
473 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
474 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
479 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
481 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
483 const char *fromcode);
485 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
487 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);