2 * Copyright (c) 1995-1998, 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.2 1999-12-21 14:16:19 ian
28 * Changed retrieval module to allow data1 trees with no associated absyn.
29 * Also added a simple interface for extracting values from data1 trees using
30 * a string based tagpath.
32 * Revision 1.1 1999/11/30 13:47:11 adam
33 * Improved installation. Moved header files to include/yaz.
35 * Revision 1.42 1999/10/21 12:06:28 adam
36 * Retrieval module no longer uses ctype.h - functions.
38 * Revision 1.41 1999/07/13 13:23:47 adam
39 * Non-recursive version of data1_read_node. data1_read_nodex reads
40 * stream of bytes (instead of buffer in memory).
42 * Revision 1.40 1998/11/03 10:14:12 adam
43 * Changed definition of data1 node so that it uses less space.
45 * Revision 1.39 1998/10/28 15:10:06 adam
46 * Added --with-yc option to configure. For the data1_node in data1.h:
47 * decreased size of localdata and removed member "line" which wasn't useful.
49 * Revision 1.38 1998/10/15 08:29:15 adam
50 * Tag set type may be specified in reference to it using "tagset"
51 * directive in .abs-files and "include" directive in .tag-files.
53 * Revision 1.37 1998/10/13 16:09:46 adam
54 * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
55 * Added support for multiple attribute set references and tagset references
56 * from an abstract syntax file.
57 * Fixed many bad logs-calls in routines that read the various
58 * specifications regarding data1 (*.abs,*.att,...) and made the messages
59 * consistent whenever possible.
60 * Added extra 'lineno' argument to function readconf_line.
62 * Revision 1.36 1998/05/18 13:06:57 adam
63 * Changed the way attribute sets are handled by the retriaval module.
64 * Extended Explain conversion / schema.
65 * Modified server and client to work with ASN.1 compiled protocol handlers.
67 * Revision 1.35 1998/03/05 08:15:32 adam
68 * Implemented data1_add_insert_taggeddata utility which is more flexible
69 * than data1_insert_taggeddata.
71 * Revision 1.34 1998/02/27 14:08:04 adam
72 * Added const to some char pointer arguments.
73 * Reworked data1_read_node so that it doesn't create a tree with
74 * pointers to original "SGML"-buffer.
76 * Revision 1.33 1997/12/18 10:51:30 adam
77 * Implemented sub-trees feature for schemas - including forward
80 * Revision 1.32 1997/12/09 16:18:16 adam
81 * Work on EXPLAIN schema. First implementation of sub-schema facility
84 * Revision 1.31 1997/11/18 09:51:08 adam
85 * Removed element num_children from data1_node. Minor changes in
88 * Revision 1.30 1997/10/31 12:20:07 adam
89 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
90 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
91 * Bug fix: missing fclose in data1_read_espec1.
93 * Revision 1.29 1997/10/27 13:54:18 adam
94 * Changed structure field in data1 node to be simple string which
95 * is "unknown" to the retrieval system itself.
97 * Revision 1.28 1997/10/06 09:37:53 adam
98 * Added prototype for data1_get_map_buf.
100 * Revision 1.27 1997/09/24 13:35:44 adam
101 * Added two members to data1_marctab to ease reading of weird MARC records.
103 * Revision 1.26 1997/09/17 12:10:32 adam
106 * Revision 1.25 1997/09/05 09:50:55 adam
107 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
109 * Revision 1.24 1997/09/01 09:30:39 adam
110 * Added include of yaz-util.h.
112 * Revision 1.23 1997/09/01 08:58:04 adam
113 * Removed declaration of data1_matchstr since it's a macro.
115 * Revision 1.22 1997/09/01 08:49:48 adam
116 * New windows NT/95 port using MSV5.0. To export DLL functions the
117 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
119 * Revision 1.21 1997/05/14 06:53:38 adam
122 * Revision 1.20 1996/10/29 13:34:39 adam
123 * New functions to get/set data1_tabpath.
125 * Revision 1.19 1996/10/11 11:57:16 quinn
128 * Revision 1.18 1996/10/07 15:29:16 quinn
131 * Revision 1.17 1996/07/06 19:58:32 quinn
132 * System headerfiles gathered in yconfig
134 * Revision 1.16 1996/06/10 08:55:34 quinn
135 * Added Summary. Unfinished work
137 * Revision 1.15 1996/06/03 09:46:03 quinn
140 * Revision 1.14 1996/05/09 07:27:11 quinn
141 * Multiple local values supported.
143 * Revision 1.13 1996/02/20 16:32:48 quinn
146 * Revision 1.12 1996/01/18 09:46:34 adam
147 * Changed prototype for reader function parsed to data1_read_record.
149 * Revision 1.11 1995/12/15 16:19:45 quinn
150 * Added formatted_text.
152 * Revision 1.10 1995/12/14 11:09:43 quinn
155 * Revision 1.9 1995/12/13 15:32:47 quinn
158 * Revision 1.8 1995/12/13 13:44:23 quinn
159 * Modified Data1-system to use nmem
161 * Revision 1.7 1995/12/12 16:37:05 quinn
162 * Added destroy element to data1_node.
164 * Revision 1.6 1995/12/11 15:22:12 quinn
165 * Added last_child field to the node.
167 * Revision 1.5 1995/12/05 14:26:40 quinn
168 * Added global lbuf to data1_node.
170 * Revision 1.4 1995/11/13 09:27:29 quinn
171 * Fiddling with the variant stuff.
173 * Revision 1.3 1995/11/01 16:34:52 quinn
174 * Making data1 look for tables in data1_tabpath
176 * Revision 1.2 1995/11/01 13:54:35 quinn
179 * Revision 1.1 1995/11/01 13:07:18 quinn
180 * Data1 module now lives in YAZ.
182 * Revision 1.13 1995/10/25 16:00:49 quinn
183 * USMARC support is now almost operational
185 * Revision 1.12 1995/10/16 14:02:59 quinn
186 * Changes to support element set names and espec1
188 * Revision 1.11 1995/10/13 16:05:10 quinn
189 * Adding Espec1-processing
191 * Revision 1.10 1995/10/11 14:53:46 quinn
194 * Revision 1.9 1995/10/10 16:27:59 quinn
195 * *** empty log message ***
197 * Revision 1.8 1995/10/06 16:44:14 quinn
198 * Work on attribute set mapping, etc.
200 * Revision 1.7 1995/10/06 12:58:36 quinn
203 * Revision 1.6 1995/10/04 09:29:51 quinn
204 * Adjustments to support USGS test data
206 * Revision 1.5 1995/10/03 17:56:44 quinn
209 * Revision 1.4 1995/10/02 14:55:43 quinn
210 * *** empty log message ***
212 * Revision 1.3 1995/09/15 14:41:43 quinn
215 * Revision 1.2 1995/09/14 15:18:14 quinn
218 * Revision 1.1 1995/09/12 11:24:33 quinn
219 * Beginning to add code for structured records.
229 #include <yaz/nmem.h>
231 #include <yaz/proto.h>
233 #include <yaz/d1_attset.h>
234 #include <yaz/d1_map.h>
235 #include <yaz/yaz-util.h>
236 #include <yaz/wrbuf.h>
238 #define d1_isspace(c) strchr(" \r\n\t\f", c)
239 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
244 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
246 #define DATA1_MAX_SYMBOL 31
248 typedef struct data1_name
251 struct data1_name *next;
254 typedef struct data1_absyn_cache_info *data1_absyn_cache;
255 typedef struct data1_attset_cache_info *data1_attset_cache;
257 typedef enum data1_datatype
265 DATA1K_generalizedtime,
272 typedef struct data1_marctab
277 char record_status[2];
278 char implementation_codes[5];
279 int indicator_length;
280 int identifier_length;
281 char user_systems[4];
283 int length_data_entry;
285 int length_implementation;
288 int force_indicator_length;
289 int force_identifier_length;
290 struct data1_marctab *next;
293 typedef struct data1_esetname
297 struct data1_esetname *next;
301 * Variant set definitions.
304 typedef struct data1_vartype
307 struct data1_varclass *zclass;
309 data1_datatype datatype;
310 struct data1_vartype *next;
313 typedef struct data1_varclass
316 struct data1_varset *set;
318 data1_vartype *types;
319 struct data1_varclass *next;
322 typedef struct data1_varset
326 data1_varclass *classes;
335 typedef struct data1_tag
338 #define DATA1T_numeric 1
339 #define DATA1T_string 2
348 struct data1_tagset *tagset;
349 struct data1_tag *next;
352 typedef struct data1_tagset data1_tagset;
356 int type; /* type of tagset in current context */
357 char *name; /* symbolic name */
359 data1_tag *tags; /* tags defined by this set */
360 data1_tagset *children; /* children */
361 data1_tagset *next; /* sibling */
364 typedef struct data1_termlist
368 struct data1_termlist *next;
372 * abstract syntax specification
375 typedef struct data1_element
379 data1_termlist *termlists;
381 struct data1_element *children;
382 struct data1_element *next;
385 typedef struct data1_sub_elements {
387 struct data1_sub_elements *next;
388 data1_element *elements;
389 } data1_sub_elements;
391 typedef struct data1_absyn
395 data1_tagset *tagset;
396 data1_attset *attset;
397 data1_varset *varset;
398 data1_esetname *esetnames;
399 data1_maptab *maptabs;
401 data1_sub_elements *sub_elements;
402 data1_element *main_elements;
406 * record data node (tag/data/variant)
409 typedef struct data1_node
411 /* the root of a record (containing global data) */
412 #define DATA1N_root 1
415 /* some data under a leaf tag or variant */
416 #define DATA1N_data 3
417 /* variant specification (a triple, actually) */
418 #define DATA1N_variant 4
426 data1_absyn *absyn; /* abstract syntax for this type */
432 data1_element *element;
433 int no_data_requested;
435 unsigned node_selected : 1;
436 unsigned make_variantlist : 1;
441 char *data; /* filename or data */
444 #define DATA1I_inctxt 1
445 /* binary data inclusion */
446 #define DATA1I_incbin 2
448 #define DATA1I_text 3
451 /* object identifier */
454 unsigned formatted_text : 1; /* newlines are significant */
464 void (*destroy)(struct data1_node *n);
465 #define DATA1_LOCALDATA 12
466 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
467 struct data1_node *next;
468 struct data1_node *child;
469 struct data1_node *last_child;
470 struct data1_node *parent;
471 struct data1_node *root;
474 YAZ_EXPORT data1_handle data1_create (void);
475 YAZ_EXPORT void data1_destroy(data1_handle dh);
476 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
477 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
479 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
480 int (*get_byte)(void *fh), void *fh,
482 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
483 int (*rf)(void *, char *, size_t),
485 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
486 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
488 int type, int value);
489 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
490 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
493 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
495 data1_element *parent,
496 const char *tagname);
497 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
500 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
502 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
503 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
504 int select, int *len);
505 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
508 const char *tagname, NMEM m);
509 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
511 const char *tagname, NMEM m);
512 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
513 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
514 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
516 char *zclass, char *type);
517 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
518 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
519 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
522 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
525 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
526 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
527 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
528 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
529 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
530 data1_maptab *map, NMEM m);
531 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
533 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
534 data1_node *n, int selected, int *len);
535 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
536 int select, int *len);
537 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
538 data1_node *n, int select,
540 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
541 data1_node *n, int select,
543 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
545 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
546 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
548 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
549 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
550 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
551 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
552 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
553 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
554 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
555 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
556 NMEM m, const char *str);
557 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
559 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
560 void (*fh)(data1_handle dh,
561 void *h, data1_absyn *a));
563 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
565 YAZ_EXPORT data1_node
566 *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
567 data1_node *at, const char *tagname, NMEM m,
568 int first_flag, int local_allowed);
570 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
572 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);