1 /* $Id: data1.h,v 1.1 2004-09-28 10:15:03 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
30 #include <yaz/proto.h>
32 #include <idzebra/version.h>
33 #include <d1_attset.h>
35 #include <yaz/yaz-util.h>
36 #include <yaz/wrbuf.h>
38 #define d1_isspace(c) strchr(" \r\n\t\f", c)
39 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
43 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
45 #define DATA1_MAX_SYMBOL 31
47 typedef struct data1_name
50 struct data1_name *next;
53 typedef struct data1_absyn_cache_info *data1_absyn_cache;
54 typedef struct data1_attset_cache_info *data1_attset_cache;
55 typedef struct data1_absyn data1_absyn;
57 typedef enum data1_datatype
65 DATA1K_generalizedtime,
72 typedef struct data1_marctab
77 char record_status[2];
78 char implementation_codes[5];
80 int identifier_length;
83 int length_data_entry;
85 int length_implementation;
88 int force_indicator_length;
89 int force_identifier_length;
90 char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */
91 struct data1_marctab *next;
94 typedef struct data1_esetname
98 struct data1_esetname *next;
102 * Variant set definitions.
105 typedef struct data1_vartype
108 struct data1_varclass *zclass;
110 data1_datatype datatype;
111 struct data1_vartype *next;
114 typedef struct data1_varclass
117 struct data1_varset *set;
119 data1_vartype *types;
120 struct data1_varclass *next;
123 typedef struct data1_varset
127 data1_varclass *classes;
136 typedef struct data1_tag
139 #define DATA1T_numeric 1
140 #define DATA1T_string 2
149 struct data1_tagset *tagset;
150 struct data1_tag *next;
153 typedef struct data1_tagset data1_tagset;
157 int type; /* type of tagset in current context */
158 char *name; /* symbolic name */
160 data1_tag *tags; /* tags defined by this set */
161 data1_tagset *children; /* children */
162 data1_tagset *next; /* sibling */
165 typedef struct data1_termlist
170 struct data1_termlist *next;
174 * abstract syntax specification
177 typedef struct data1_element
181 data1_termlist *termlists;
183 struct data1_element *children;
184 struct data1_element *next;
187 typedef struct data1_sub_elements {
189 struct data1_sub_elements *next;
190 data1_element *elements;
191 } data1_sub_elements;
193 typedef struct data1_xattr {
196 struct data1_xattr *next;
197 unsigned short what; /* DATA1I_text, .. see data1_node.u.data */
202 * record data node (tag/data/variant)
205 typedef struct data1_node
207 /* the root of a record (containing global data) */
208 #define DATA1N_root 1
211 /* some data under a leaf tag or variant */
212 #define DATA1N_data 3
213 /* variant specification (a triple, actually) */
214 #define DATA1N_variant 4
215 /* comment (same as data) */
216 #define DATA1N_comment 5
217 /* preprocessing instruction */
218 #define DATA1N_preprocess 6
225 struct data1_absyn *absyn; /* abstract syntax for this type */
231 data1_element *element;
232 int no_data_requested;
234 unsigned node_selected : 1;
235 unsigned make_variantlist : 1;
236 data1_xattr *attributes;
241 char *data; /* filename or data */
244 #define DATA1I_inctxt 1
245 /* binary data inclusion */
246 #define DATA1I_incbin 2
248 #define DATA1I_text 3
251 /* object identifier */
254 #define DATA1I_xmltext 6
256 unsigned formatted_text : 1; /* newlines are significant */
268 data1_xattr *attributes;
272 void (*destroy)(struct data1_node *n);
273 #define DATA1_LOCALDATA 12
274 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
275 struct data1_node *next;
276 struct data1_node *child;
277 struct data1_node *last_child;
278 struct data1_node *parent;
279 struct data1_node *root;
282 YAZ_EXPORT data1_handle data1_create (void);
284 #define DATA1_FLAG_XML 1
285 YAZ_EXPORT data1_handle data1_createx (int flags);
287 YAZ_EXPORT void data1_destroy(data1_handle dh);
288 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
289 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
291 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
292 int (*get_byte)(void *fh), void *fh,
294 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
295 int (*rf)(void *, char *, size_t),
297 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
298 int file_must_exist);
299 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
301 int type, int value);
302 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
303 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
306 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
308 data1_element *parent,
309 const char *tagname);
310 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
313 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
315 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
316 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
317 int select, int *len);
318 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
320 const char *tagname, NMEM m);
321 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
322 const char *tagname, NMEM m);
323 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
324 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
325 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
327 char *zclass, char *type);
328 YAZ_EXPORT data1_vartype *data1_getvartypeby_absyn(data1_handle dh,
330 char *zclass, char *type);
331 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
332 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
333 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
336 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
339 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
340 int type, data1_node *parent);
342 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
343 const char *tag, const char **attr,
345 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
346 const char *tag, size_t len,
349 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
350 data1_node *res, const char **attr);
352 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
353 const char *buf, size_t len,
355 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
356 const char *buf, size_t len,
358 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
359 const char *buf, data1_node *parent);
361 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
362 const char *buf, size_t len,
365 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
366 const char *buf, data1_node *parent);
368 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
369 const char *target, size_t len,
373 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
378 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
384 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
389 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
391 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
392 NMEM nmem, const char *name);
394 YAZ_EXPORT data1_node *data1_mk_tag_data_zint (data1_handle dh, data1_node *at,
395 const char *tag, zint num,
397 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
398 const char *tag, int num,
400 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
401 const char *tag, Odr_oid *oid,
403 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
407 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
413 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
415 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
417 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
418 const char *tag, data1_node *at);
419 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
420 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
421 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
422 data1_maptab *map, NMEM m);
423 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
425 YAZ_EXPORT data1_marctab *data1_absyn_getmarctab(data1_handle dh,
427 YAZ_EXPORT data1_element *data1_absyn_getelements(data1_handle dh,
429 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
430 data1_node *n, int selected, int *len);
431 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
432 int select, int *len);
433 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
434 data1_node *n, int select,
436 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
437 data1_node *n, int select,
439 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
441 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
442 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
443 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
444 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
446 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
447 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
448 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
449 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
450 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
451 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
452 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
453 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
454 NMEM m, const char *str);
455 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
456 NMEM m, const char *str, size_t len);
457 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
459 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
460 int (*rf)(void *, char *, size_t),
462 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
463 void (*fh)(data1_handle dh,
464 void *h, data1_absyn *a));
466 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
468 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
469 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
470 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
472 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
475 /* obsolete functions ... */
477 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
478 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
481 const char *tagname, NMEM m);
482 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
483 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
488 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
490 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
492 const char *fromcode);
494 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
496 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
498 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
499 const char *default_value);
501 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
503 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);