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.9 2002-05-07 11:02:56 adam Exp $
36 #include <yaz/proto.h>
38 #include <yaz/d1_attset.h>
39 #include <yaz/d1_map.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')
46 #define DATA1_USING_XATTR 1
50 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
52 #define DATA1_MAX_SYMBOL 31
54 typedef struct data1_name
57 struct data1_name *next;
60 typedef struct data1_absyn_cache_info *data1_absyn_cache;
61 typedef struct data1_attset_cache_info *data1_attset_cache;
63 typedef enum data1_datatype
71 DATA1K_generalizedtime,
78 typedef struct data1_marctab
83 char record_status[2];
84 char implementation_codes[5];
86 int identifier_length;
89 int length_data_entry;
91 int length_implementation;
94 int force_indicator_length;
95 int force_identifier_length;
96 struct data1_marctab *next;
99 typedef struct data1_esetname
103 struct data1_esetname *next;
107 * Variant set definitions.
110 typedef struct data1_vartype
113 struct data1_varclass *zclass;
115 data1_datatype datatype;
116 struct data1_vartype *next;
119 typedef struct data1_varclass
122 struct data1_varset *set;
124 data1_vartype *types;
125 struct data1_varclass *next;
128 typedef struct data1_varset
132 data1_varclass *classes;
141 typedef struct data1_tag
144 #define DATA1T_numeric 1
145 #define DATA1T_string 2
154 struct data1_tagset *tagset;
155 struct data1_tag *next;
158 typedef struct data1_tagset data1_tagset;
162 int type; /* type of tagset in current context */
163 char *name; /* symbolic name */
165 data1_tag *tags; /* tags defined by this set */
166 data1_tagset *children; /* children */
167 data1_tagset *next; /* sibling */
170 typedef struct data1_termlist
175 struct data1_termlist *next;
179 * abstract syntax specification
182 typedef struct data1_element
186 data1_termlist *termlists;
188 struct data1_element *children;
189 struct data1_element *next;
192 typedef struct data1_sub_elements {
194 struct data1_sub_elements *next;
195 data1_element *elements;
196 } data1_sub_elements;
198 #if DATA1_USING_XATTR
199 typedef struct data1_xattr {
202 struct data1_xattr *next;
206 typedef struct data1_absyn
210 data1_tagset *tagset;
211 data1_attset *attset;
212 data1_varset *varset;
213 data1_esetname *esetnames;
214 data1_maptab *maptabs;
216 data1_sub_elements *sub_elements;
217 data1_element *main_elements;
221 * record data node (tag/data/variant)
224 typedef struct data1_node
226 /* the root of a record (containing global data) */
227 #define DATA1N_root 1
230 /* some data under a leaf tag or variant */
231 #define DATA1N_data 3
232 /* variant specification (a triple, actually) */
233 #define DATA1N_variant 4
241 data1_absyn *absyn; /* abstract syntax for this type */
247 data1_element *element;
248 int no_data_requested;
250 unsigned node_selected : 1;
251 unsigned make_variantlist : 1;
252 #if DATA1_USING_XATTR
253 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 unsigned formatted_text : 1; /* newlines are significant */
282 void (*destroy)(struct data1_node *n);
283 #define DATA1_LOCALDATA 12
284 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
285 struct data1_node *next;
286 struct data1_node *child;
287 struct data1_node *last_child;
288 struct data1_node *parent;
289 struct data1_node *root;
292 YAZ_EXPORT data1_handle data1_create (void);
293 YAZ_EXPORT void data1_destroy(data1_handle dh);
294 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
295 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
297 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
298 int (*get_byte)(void *fh), void *fh,
300 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
301 int (*rf)(void *, char *, size_t),
303 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
304 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
306 int type, int value);
307 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
308 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
311 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
313 data1_element *parent,
314 const char *tagname);
315 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
318 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
320 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
321 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
322 int select, int *len);
323 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
325 const char *tagname, NMEM m);
326 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
327 const char *tagname, NMEM m);
328 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
329 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
330 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
332 char *zclass, char *type);
333 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
334 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
335 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
338 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
341 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
342 int type, data1_node *parent);
344 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
345 const char *tag, data1_node *at);
346 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
347 const char *tag, size_t len,
350 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
351 const char *buf, size_t len,
353 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
354 const char *buf, data1_node *parent);
356 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
359 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
360 const char *tag, int num,
362 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
363 const char *tag, Odr_oid *oid,
365 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
369 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
375 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
377 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
379 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
380 const char *tag, data1_node *at);
381 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
382 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
383 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
384 data1_maptab *map, NMEM m);
385 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
387 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
388 data1_node *n, int selected, int *len);
389 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
390 int select, int *len);
391 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
392 data1_node *n, int select,
394 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
395 data1_node *n, int select,
397 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
399 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
400 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
401 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
402 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
404 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
405 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
406 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
407 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
408 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
409 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
410 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
411 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
412 NMEM m, const char *str);
413 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
414 NMEM m, const char *str, size_t len);
415 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
417 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
418 void (*fh)(data1_handle dh,
419 void *h, data1_absyn *a));
421 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
423 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
424 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
425 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
427 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
430 /* obsolete functions ... */
432 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
433 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
436 const char *tagname, NMEM m);
437 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
438 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,