2 * Copyright (c) 1995-2000, 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
27 * Revision 1.8 2002-05-03 13:48:27 adam
30 * Revision 1.7 2002/04/04 20:49:46 adam
31 * New functions yaz_is_abspath, yaz_path_fopen_base
33 * Revision 1.6 2000/12/05 12:21:45 adam
34 * Added termlist source for data1 system.
36 * Revision 1.5 2000/11/29 14:22:47 adam
37 * Implemented XML/SGML attributes for data1 so that d1_read reads them
38 * and d1_write generates proper attributes for XML/SGML records. Added
39 * register locking for threaded version.
41 * Revision 1.4 2000/02/28 11:20:06 adam
42 * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
44 * Revision 1.3 2000/01/04 17:46:17 ian
45 * Added function to count occurences of a tag spec in a data1 tree.
47 * Revision 1.2 1999/12/21 14:16:19 ian
48 * Changed retrieval module to allow data1 trees with no associated absyn.
49 * Also added a simple interface for extracting values from data1 trees using
50 * a string based tagpath.
52 * Revision 1.1 1999/11/30 13:47:11 adam
53 * Improved installation. Moved header files to include/yaz.
55 * Revision 1.42 1999/10/21 12:06:28 adam
56 * Retrieval module no longer uses ctype.h - functions.
58 * Revision 1.41 1999/07/13 13:23:47 adam
59 * Non-recursive version of data1_read_node. data1_read_nodex reads
60 * stream of bytes (instead of buffer in memory).
62 * Revision 1.40 1998/11/03 10:14:12 adam
63 * Changed definition of data1 node so that it uses less space.
65 * Revision 1.39 1998/10/28 15:10:06 adam
66 * Added --with-yc option to configure. For the data1_node in data1.h:
67 * decreased size of localdata and removed member "line" which wasn't useful.
69 * Revision 1.38 1998/10/15 08:29:15 adam
70 * Tag set type may be specified in reference to it using "tagset"
71 * directive in .abs-files and "include" directive in .tag-files.
73 * Revision 1.37 1998/10/13 16:09:46 adam
74 * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
75 * Added support for multiple attribute set references and tagset references
76 * from an abstract syntax file.
77 * Fixed many bad logs-calls in routines that read the various
78 * specifications regarding data1 (*.abs,*.att,...) and made the messages
79 * consistent whenever possible.
80 * Added extra 'lineno' argument to function readconf_line.
82 * Revision 1.36 1998/05/18 13:06:57 adam
83 * Changed the way attribute sets are handled by the retriaval module.
84 * Extended Explain conversion / schema.
85 * Modified server and client to work with ASN.1 compiled protocol handlers.
87 * Revision 1.35 1998/03/05 08:15:32 adam
88 * Implemented data1_add_insert_taggeddata utility which is more flexible
89 * than data1_insert_taggeddata.
91 * Revision 1.34 1998/02/27 14:08:04 adam
92 * Added const to some char pointer arguments.
93 * Reworked data1_read_node so that it doesn't create a tree with
94 * pointers to original "SGML"-buffer.
96 * Revision 1.33 1997/12/18 10:51:30 adam
97 * Implemented sub-trees feature for schemas - including forward
100 * Revision 1.32 1997/12/09 16:18:16 adam
101 * Work on EXPLAIN schema. First implementation of sub-schema facility
102 * in the *.abs files.
104 * Revision 1.31 1997/11/18 09:51:08 adam
105 * Removed element num_children from data1_node. Minor changes in
108 * Revision 1.30 1997/10/31 12:20:07 adam
109 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
110 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
111 * Bug fix: missing fclose in data1_read_espec1.
113 * Revision 1.29 1997/10/27 13:54:18 adam
114 * Changed structure field in data1 node to be simple string which
115 * is "unknown" to the retrieval system itself.
117 * Revision 1.28 1997/10/06 09:37:53 adam
118 * Added prototype for data1_get_map_buf.
120 * Revision 1.27 1997/09/24 13:35:44 adam
121 * Added two members to data1_marctab to ease reading of weird MARC records.
123 * Revision 1.26 1997/09/17 12:10:32 adam
126 * Revision 1.25 1997/09/05 09:50:55 adam
127 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
129 * Revision 1.24 1997/09/01 09:30:39 adam
130 * Added include of yaz-util.h.
132 * Revision 1.23 1997/09/01 08:58:04 adam
133 * Removed declaration of data1_matchstr since it's a macro.
135 * Revision 1.22 1997/09/01 08:49:48 adam
136 * New windows NT/95 port using MSV5.0. To export DLL functions the
137 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
139 * Revision 1.21 1997/05/14 06:53:38 adam
142 * Revision 1.20 1996/10/29 13:34:39 adam
143 * New functions to get/set data1_tabpath.
145 * Revision 1.19 1996/10/11 11:57:16 quinn
148 * Revision 1.18 1996/10/07 15:29:16 quinn
151 * Revision 1.17 1996/07/06 19:58:32 quinn
152 * System headerfiles gathered in yconfig
154 * Revision 1.16 1996/06/10 08:55:34 quinn
155 * Added Summary. Unfinished work
157 * Revision 1.15 1996/06/03 09:46:03 quinn
160 * Revision 1.14 1996/05/09 07:27:11 quinn
161 * Multiple local values supported.
163 * Revision 1.13 1996/02/20 16:32:48 quinn
166 * Revision 1.12 1996/01/18 09:46:34 adam
167 * Changed prototype for reader function parsed to data1_read_record.
169 * Revision 1.11 1995/12/15 16:19:45 quinn
170 * Added formatted_text.
172 * Revision 1.10 1995/12/14 11:09:43 quinn
175 * Revision 1.9 1995/12/13 15:32:47 quinn
178 * Revision 1.8 1995/12/13 13:44:23 quinn
179 * Modified Data1-system to use nmem
181 * Revision 1.7 1995/12/12 16:37:05 quinn
182 * Added destroy element to data1_node.
184 * Revision 1.6 1995/12/11 15:22:12 quinn
185 * Added last_child field to the node.
187 * Revision 1.5 1995/12/05 14:26:40 quinn
188 * Added global lbuf to data1_node.
190 * Revision 1.4 1995/11/13 09:27:29 quinn
191 * Fiddling with the variant stuff.
193 * Revision 1.3 1995/11/01 16:34:52 quinn
194 * Making data1 look for tables in data1_tabpath
196 * Revision 1.2 1995/11/01 13:54:35 quinn
199 * Revision 1.1 1995/11/01 13:07:18 quinn
200 * Data1 module now lives in YAZ.
202 * Revision 1.13 1995/10/25 16:00:49 quinn
203 * USMARC support is now almost operational
205 * Revision 1.12 1995/10/16 14:02:59 quinn
206 * Changes to support element set names and espec1
208 * Revision 1.11 1995/10/13 16:05:10 quinn
209 * Adding Espec1-processing
211 * Revision 1.10 1995/10/11 14:53:46 quinn
214 * Revision 1.9 1995/10/10 16:27:59 quinn
215 * *** empty log message ***
217 * Revision 1.8 1995/10/06 16:44:14 quinn
218 * Work on attribute set mapping, etc.
220 * Revision 1.7 1995/10/06 12:58:36 quinn
223 * Revision 1.6 1995/10/04 09:29:51 quinn
224 * Adjustments to support USGS test data
226 * Revision 1.5 1995/10/03 17:56:44 quinn
229 * Revision 1.4 1995/10/02 14:55:43 quinn
230 * *** empty log message ***
232 * Revision 1.3 1995/09/15 14:41:43 quinn
235 * Revision 1.2 1995/09/14 15:18:14 quinn
238 * Revision 1.1 1995/09/12 11:24:33 quinn
239 * Beginning to add code for structured records.
249 #include <yaz/nmem.h>
251 #include <yaz/proto.h>
253 #include <yaz/d1_attset.h>
254 #include <yaz/d1_map.h>
255 #include <yaz/yaz-util.h>
256 #include <yaz/wrbuf.h>
258 #define d1_isspace(c) strchr(" \r\n\t\f", c)
259 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
261 #define DATA1_USING_XATTR 1
265 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
267 #define DATA1_MAX_SYMBOL 31
269 typedef struct data1_name
272 struct data1_name *next;
275 typedef struct data1_absyn_cache_info *data1_absyn_cache;
276 typedef struct data1_attset_cache_info *data1_attset_cache;
278 typedef enum data1_datatype
286 DATA1K_generalizedtime,
293 typedef struct data1_marctab
298 char record_status[2];
299 char implementation_codes[5];
300 int indicator_length;
301 int identifier_length;
302 char user_systems[4];
304 int length_data_entry;
306 int length_implementation;
309 int force_indicator_length;
310 int force_identifier_length;
311 struct data1_marctab *next;
314 typedef struct data1_esetname
318 struct data1_esetname *next;
322 * Variant set definitions.
325 typedef struct data1_vartype
328 struct data1_varclass *zclass;
330 data1_datatype datatype;
331 struct data1_vartype *next;
334 typedef struct data1_varclass
337 struct data1_varset *set;
339 data1_vartype *types;
340 struct data1_varclass *next;
343 typedef struct data1_varset
347 data1_varclass *classes;
356 typedef struct data1_tag
359 #define DATA1T_numeric 1
360 #define DATA1T_string 2
369 struct data1_tagset *tagset;
370 struct data1_tag *next;
373 typedef struct data1_tagset data1_tagset;
377 int type; /* type of tagset in current context */
378 char *name; /* symbolic name */
380 data1_tag *tags; /* tags defined by this set */
381 data1_tagset *children; /* children */
382 data1_tagset *next; /* sibling */
385 typedef struct data1_termlist
390 struct data1_termlist *next;
394 * abstract syntax specification
397 typedef struct data1_element
401 data1_termlist *termlists;
403 struct data1_element *children;
404 struct data1_element *next;
407 typedef struct data1_sub_elements {
409 struct data1_sub_elements *next;
410 data1_element *elements;
411 } data1_sub_elements;
413 #if DATA1_USING_XATTR
414 typedef struct data1_xattr {
417 struct data1_xattr *next;
421 typedef struct data1_absyn
425 data1_tagset *tagset;
426 data1_attset *attset;
427 data1_varset *varset;
428 data1_esetname *esetnames;
429 data1_maptab *maptabs;
431 data1_sub_elements *sub_elements;
432 data1_element *main_elements;
436 * record data node (tag/data/variant)
439 typedef struct data1_node
441 /* the root of a record (containing global data) */
442 #define DATA1N_root 1
445 /* some data under a leaf tag or variant */
446 #define DATA1N_data 3
447 /* variant specification (a triple, actually) */
448 #define DATA1N_variant 4
456 data1_absyn *absyn; /* abstract syntax for this type */
462 data1_element *element;
463 int no_data_requested;
465 unsigned node_selected : 1;
466 unsigned make_variantlist : 1;
467 #if DATA1_USING_XATTR
468 data1_xattr *attributes;
474 char *data; /* filename or data */
477 #define DATA1I_inctxt 1
478 /* binary data inclusion */
479 #define DATA1I_incbin 2
481 #define DATA1I_text 3
484 /* object identifier */
487 unsigned formatted_text : 1; /* newlines are significant */
497 void (*destroy)(struct data1_node *n);
498 #define DATA1_LOCALDATA 12
499 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
500 struct data1_node *next;
501 struct data1_node *child;
502 struct data1_node *last_child;
503 struct data1_node *parent;
504 struct data1_node *root;
507 YAZ_EXPORT data1_handle data1_create (void);
508 YAZ_EXPORT void data1_destroy(data1_handle dh);
509 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
510 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
512 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
513 int (*get_byte)(void *fh), void *fh,
515 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
516 int (*rf)(void *, char *, size_t),
518 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
519 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
521 int type, int value);
522 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
523 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
526 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
528 data1_element *parent,
529 const char *tagname);
530 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
533 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
535 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
536 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
537 int select, int *len);
538 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
541 const char *tagname, NMEM m);
542 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *root,
544 const char *tagname, NMEM m);
545 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
546 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
547 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
549 char *zclass, char *type);
550 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
551 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
552 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
555 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
558 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m,
559 int type, data1_node *parent);
561 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem,
562 const char *tag, data1_node *at);
563 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
564 const char *tag, size_t len,
567 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
568 const char *buf, size_t len,
570 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
571 const char *buf, data1_node *parent);
573 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
576 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
577 const char *tag, int num,
579 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
580 const char *tag, Odr_oid *oid,
582 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
586 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
592 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
594 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
596 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem,
597 const char *tag, data1_node *at);
598 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
599 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
600 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
601 data1_maptab *map, NMEM m);
602 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
604 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
605 data1_node *n, int selected, int *len);
606 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
607 int select, int *len);
608 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
609 data1_node *n, int select,
611 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
612 data1_node *n, int select,
614 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
616 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
617 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
618 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
619 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
621 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
622 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
623 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
624 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
625 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
626 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
627 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
628 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
629 NMEM m, const char *str);
630 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
631 NMEM m, const char *str, size_t len);
632 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
634 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
635 void (*fh)(data1_handle dh,
636 void *h, data1_absyn *a));
638 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
640 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
641 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
642 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
644 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,