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.6 2000-12-05 12:21:45 adam
28 * Added termlist source for data1 system.
30 * Revision 1.5 2000/11/29 14:22:47 adam
31 * Implemented XML/SGML attributes for data1 so that d1_read reads them
32 * and d1_write generates proper attributes for XML/SGML records. Added
33 * register locking for threaded version.
35 * Revision 1.4 2000/02/28 11:20:06 adam
36 * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
38 * Revision 1.3 2000/01/04 17:46:17 ian
39 * Added function to count occurences of a tag spec in a data1 tree.
41 * Revision 1.2 1999/12/21 14:16:19 ian
42 * Changed retrieval module to allow data1 trees with no associated absyn.
43 * Also added a simple interface for extracting values from data1 trees using
44 * a string based tagpath.
46 * Revision 1.1 1999/11/30 13:47:11 adam
47 * Improved installation. Moved header files to include/yaz.
49 * Revision 1.42 1999/10/21 12:06:28 adam
50 * Retrieval module no longer uses ctype.h - functions.
52 * Revision 1.41 1999/07/13 13:23:47 adam
53 * Non-recursive version of data1_read_node. data1_read_nodex reads
54 * stream of bytes (instead of buffer in memory).
56 * Revision 1.40 1998/11/03 10:14:12 adam
57 * Changed definition of data1 node so that it uses less space.
59 * Revision 1.39 1998/10/28 15:10:06 adam
60 * Added --with-yc option to configure. For the data1_node in data1.h:
61 * decreased size of localdata and removed member "line" which wasn't useful.
63 * Revision 1.38 1998/10/15 08:29:15 adam
64 * Tag set type may be specified in reference to it using "tagset"
65 * directive in .abs-files and "include" directive in .tag-files.
67 * Revision 1.37 1998/10/13 16:09:46 adam
68 * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
69 * Added support for multiple attribute set references and tagset references
70 * from an abstract syntax file.
71 * Fixed many bad logs-calls in routines that read the various
72 * specifications regarding data1 (*.abs,*.att,...) and made the messages
73 * consistent whenever possible.
74 * Added extra 'lineno' argument to function readconf_line.
76 * Revision 1.36 1998/05/18 13:06:57 adam
77 * Changed the way attribute sets are handled by the retriaval module.
78 * Extended Explain conversion / schema.
79 * Modified server and client to work with ASN.1 compiled protocol handlers.
81 * Revision 1.35 1998/03/05 08:15:32 adam
82 * Implemented data1_add_insert_taggeddata utility which is more flexible
83 * than data1_insert_taggeddata.
85 * Revision 1.34 1998/02/27 14:08:04 adam
86 * Added const to some char pointer arguments.
87 * Reworked data1_read_node so that it doesn't create a tree with
88 * pointers to original "SGML"-buffer.
90 * Revision 1.33 1997/12/18 10:51:30 adam
91 * Implemented sub-trees feature for schemas - including forward
94 * Revision 1.32 1997/12/09 16:18:16 adam
95 * Work on EXPLAIN schema. First implementation of sub-schema facility
98 * Revision 1.31 1997/11/18 09:51:08 adam
99 * Removed element num_children from data1_node. Minor changes in
102 * Revision 1.30 1997/10/31 12:20:07 adam
103 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
104 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
105 * Bug fix: missing fclose in data1_read_espec1.
107 * Revision 1.29 1997/10/27 13:54:18 adam
108 * Changed structure field in data1 node to be simple string which
109 * is "unknown" to the retrieval system itself.
111 * Revision 1.28 1997/10/06 09:37:53 adam
112 * Added prototype for data1_get_map_buf.
114 * Revision 1.27 1997/09/24 13:35:44 adam
115 * Added two members to data1_marctab to ease reading of weird MARC records.
117 * Revision 1.26 1997/09/17 12:10:32 adam
120 * Revision 1.25 1997/09/05 09:50:55 adam
121 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
123 * Revision 1.24 1997/09/01 09:30:39 adam
124 * Added include of yaz-util.h.
126 * Revision 1.23 1997/09/01 08:58:04 adam
127 * Removed declaration of data1_matchstr since it's a macro.
129 * Revision 1.22 1997/09/01 08:49:48 adam
130 * New windows NT/95 port using MSV5.0. To export DLL functions the
131 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
133 * Revision 1.21 1997/05/14 06:53:38 adam
136 * Revision 1.20 1996/10/29 13:34:39 adam
137 * New functions to get/set data1_tabpath.
139 * Revision 1.19 1996/10/11 11:57:16 quinn
142 * Revision 1.18 1996/10/07 15:29:16 quinn
145 * Revision 1.17 1996/07/06 19:58:32 quinn
146 * System headerfiles gathered in yconfig
148 * Revision 1.16 1996/06/10 08:55:34 quinn
149 * Added Summary. Unfinished work
151 * Revision 1.15 1996/06/03 09:46:03 quinn
154 * Revision 1.14 1996/05/09 07:27:11 quinn
155 * Multiple local values supported.
157 * Revision 1.13 1996/02/20 16:32:48 quinn
160 * Revision 1.12 1996/01/18 09:46:34 adam
161 * Changed prototype for reader function parsed to data1_read_record.
163 * Revision 1.11 1995/12/15 16:19:45 quinn
164 * Added formatted_text.
166 * Revision 1.10 1995/12/14 11:09:43 quinn
169 * Revision 1.9 1995/12/13 15:32:47 quinn
172 * Revision 1.8 1995/12/13 13:44:23 quinn
173 * Modified Data1-system to use nmem
175 * Revision 1.7 1995/12/12 16:37:05 quinn
176 * Added destroy element to data1_node.
178 * Revision 1.6 1995/12/11 15:22:12 quinn
179 * Added last_child field to the node.
181 * Revision 1.5 1995/12/05 14:26:40 quinn
182 * Added global lbuf to data1_node.
184 * Revision 1.4 1995/11/13 09:27:29 quinn
185 * Fiddling with the variant stuff.
187 * Revision 1.3 1995/11/01 16:34:52 quinn
188 * Making data1 look for tables in data1_tabpath
190 * Revision 1.2 1995/11/01 13:54:35 quinn
193 * Revision 1.1 1995/11/01 13:07:18 quinn
194 * Data1 module now lives in YAZ.
196 * Revision 1.13 1995/10/25 16:00:49 quinn
197 * USMARC support is now almost operational
199 * Revision 1.12 1995/10/16 14:02:59 quinn
200 * Changes to support element set names and espec1
202 * Revision 1.11 1995/10/13 16:05:10 quinn
203 * Adding Espec1-processing
205 * Revision 1.10 1995/10/11 14:53:46 quinn
208 * Revision 1.9 1995/10/10 16:27:59 quinn
209 * *** empty log message ***
211 * Revision 1.8 1995/10/06 16:44:14 quinn
212 * Work on attribute set mapping, etc.
214 * Revision 1.7 1995/10/06 12:58:36 quinn
217 * Revision 1.6 1995/10/04 09:29:51 quinn
218 * Adjustments to support USGS test data
220 * Revision 1.5 1995/10/03 17:56:44 quinn
223 * Revision 1.4 1995/10/02 14:55:43 quinn
224 * *** empty log message ***
226 * Revision 1.3 1995/09/15 14:41:43 quinn
229 * Revision 1.2 1995/09/14 15:18:14 quinn
232 * Revision 1.1 1995/09/12 11:24:33 quinn
233 * Beginning to add code for structured records.
243 #include <yaz/nmem.h>
245 #include <yaz/proto.h>
247 #include <yaz/d1_attset.h>
248 #include <yaz/d1_map.h>
249 #include <yaz/yaz-util.h>
250 #include <yaz/wrbuf.h>
252 #define d1_isspace(c) strchr(" \r\n\t\f", c)
253 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
255 #define DATA1_USING_XATTR 1
259 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
261 #define DATA1_MAX_SYMBOL 31
263 typedef struct data1_name
266 struct data1_name *next;
269 typedef struct data1_absyn_cache_info *data1_absyn_cache;
270 typedef struct data1_attset_cache_info *data1_attset_cache;
272 typedef enum data1_datatype
280 DATA1K_generalizedtime,
287 typedef struct data1_marctab
292 char record_status[2];
293 char implementation_codes[5];
294 int indicator_length;
295 int identifier_length;
296 char user_systems[4];
298 int length_data_entry;
300 int length_implementation;
303 int force_indicator_length;
304 int force_identifier_length;
305 struct data1_marctab *next;
308 typedef struct data1_esetname
312 struct data1_esetname *next;
316 * Variant set definitions.
319 typedef struct data1_vartype
322 struct data1_varclass *zclass;
324 data1_datatype datatype;
325 struct data1_vartype *next;
328 typedef struct data1_varclass
331 struct data1_varset *set;
333 data1_vartype *types;
334 struct data1_varclass *next;
337 typedef struct data1_varset
341 data1_varclass *classes;
350 typedef struct data1_tag
353 #define DATA1T_numeric 1
354 #define DATA1T_string 2
363 struct data1_tagset *tagset;
364 struct data1_tag *next;
367 typedef struct data1_tagset data1_tagset;
371 int type; /* type of tagset in current context */
372 char *name; /* symbolic name */
374 data1_tag *tags; /* tags defined by this set */
375 data1_tagset *children; /* children */
376 data1_tagset *next; /* sibling */
379 typedef struct data1_termlist
384 struct data1_termlist *next;
388 * abstract syntax specification
391 typedef struct data1_element
395 data1_termlist *termlists;
397 struct data1_element *children;
398 struct data1_element *next;
401 typedef struct data1_sub_elements {
403 struct data1_sub_elements *next;
404 data1_element *elements;
405 } data1_sub_elements;
407 #if DATA1_USING_XATTR
408 typedef struct data1_xattr {
411 struct data1_xattr *next;
415 typedef struct data1_absyn
419 data1_tagset *tagset;
420 data1_attset *attset;
421 data1_varset *varset;
422 data1_esetname *esetnames;
423 data1_maptab *maptabs;
425 data1_sub_elements *sub_elements;
426 data1_element *main_elements;
430 * record data node (tag/data/variant)
433 typedef struct data1_node
435 /* the root of a record (containing global data) */
436 #define DATA1N_root 1
439 /* some data under a leaf tag or variant */
440 #define DATA1N_data 3
441 /* variant specification (a triple, actually) */
442 #define DATA1N_variant 4
450 data1_absyn *absyn; /* abstract syntax for this type */
456 data1_element *element;
457 int no_data_requested;
459 unsigned node_selected : 1;
460 unsigned make_variantlist : 1;
461 #if DATA1_USING_XATTR
462 data1_xattr *attributes;
468 char *data; /* filename or data */
471 #define DATA1I_inctxt 1
472 /* binary data inclusion */
473 #define DATA1I_incbin 2
475 #define DATA1I_text 3
478 /* object identifier */
481 unsigned formatted_text : 1; /* newlines are significant */
491 void (*destroy)(struct data1_node *n);
492 #define DATA1_LOCALDATA 12
493 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
494 struct data1_node *next;
495 struct data1_node *child;
496 struct data1_node *last_child;
497 struct data1_node *parent;
498 struct data1_node *root;
501 YAZ_EXPORT data1_handle data1_create (void);
502 YAZ_EXPORT void data1_destroy(data1_handle dh);
503 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
504 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
506 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
507 int (*get_byte)(void *fh), void *fh,
509 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
510 int (*rf)(void *, char *, size_t),
512 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
513 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
515 int type, int value);
516 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
517 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
520 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
522 data1_element *parent,
523 const char *tagname);
524 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
527 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
529 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
530 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
531 int select, int *len);
532 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
535 const char *tagname, NMEM m);
536 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
538 const char *tagname, NMEM m);
539 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
540 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
541 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
543 char *zclass, char *type);
544 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
545 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
546 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
549 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
552 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
553 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
554 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
555 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
556 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
557 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
558 data1_maptab *map, NMEM m);
559 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
561 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
562 data1_node *n, int selected, int *len);
563 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
564 int select, int *len);
565 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
566 data1_node *n, int select,
568 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
569 data1_node *n, int select,
571 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
573 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
574 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
576 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
577 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
578 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
579 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
580 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
581 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
582 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
583 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
584 NMEM m, const char *str);
585 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
587 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
588 void (*fh)(data1_handle dh,
589 void *h, data1_absyn *a));
591 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
593 YAZ_EXPORT data1_node
594 *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
595 data1_node *at, const char *tagname, NMEM m,
596 int first_flag, int local_allowed);
598 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
599 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
600 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);