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.41 1999-07-13 13:23:47 adam
28 * Non-recursive version of data1_read_node. data1_read_nodex reads
29 * stream of bytes (instead of buffer in memory).
31 * Revision 1.40 1998/11/03 10:14:12 adam
32 * Changed definition of data1 node so that it uses less space.
34 * Revision 1.39 1998/10/28 15:10:06 adam
35 * Added --with-yc option to configure. For the data1_node in data1.h:
36 * decreased size of localdata and removed member "line" which wasn't useful.
38 * Revision 1.38 1998/10/15 08:29:15 adam
39 * Tag set type may be specified in reference to it using "tagset"
40 * directive in .abs-files and "include" directive in .tag-files.
42 * Revision 1.37 1998/10/13 16:09:46 adam
43 * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
44 * Added support for multiple attribute set references and tagset references
45 * from an abstract syntax file.
46 * Fixed many bad logs-calls in routines that read the various
47 * specifications regarding data1 (*.abs,*.att,...) and made the messages
48 * consistent whenever possible.
49 * Added extra 'lineno' argument to function readconf_line.
51 * Revision 1.36 1998/05/18 13:06:57 adam
52 * Changed the way attribute sets are handled by the retriaval module.
53 * Extended Explain conversion / schema.
54 * Modified server and client to work with ASN.1 compiled protocol handlers.
56 * Revision 1.35 1998/03/05 08:15:32 adam
57 * Implemented data1_add_insert_taggeddata utility which is more flexible
58 * than data1_insert_taggeddata.
60 * Revision 1.34 1998/02/27 14:08:04 adam
61 * Added const to some char pointer arguments.
62 * Reworked data1_read_node so that it doesn't create a tree with
63 * pointers to original "SGML"-buffer.
65 * Revision 1.33 1997/12/18 10:51:30 adam
66 * Implemented sub-trees feature for schemas - including forward
69 * Revision 1.32 1997/12/09 16:18:16 adam
70 * Work on EXPLAIN schema. First implementation of sub-schema facility
73 * Revision 1.31 1997/11/18 09:51:08 adam
74 * Removed element num_children from data1_node. Minor changes in
77 * Revision 1.30 1997/10/31 12:20:07 adam
78 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
79 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
80 * Bug fix: missing fclose in data1_read_espec1.
82 * Revision 1.29 1997/10/27 13:54:18 adam
83 * Changed structure field in data1 node to be simple string which
84 * is "unknown" to the retrieval system itself.
86 * Revision 1.28 1997/10/06 09:37:53 adam
87 * Added prototype for data1_get_map_buf.
89 * Revision 1.27 1997/09/24 13:35:44 adam
90 * Added two members to data1_marctab to ease reading of weird MARC records.
92 * Revision 1.26 1997/09/17 12:10:32 adam
95 * Revision 1.25 1997/09/05 09:50:55 adam
96 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
98 * Revision 1.24 1997/09/01 09:30:39 adam
99 * Added include of yaz-util.h.
101 * Revision 1.23 1997/09/01 08:58:04 adam
102 * Removed declaration of data1_matchstr since it's a macro.
104 * Revision 1.22 1997/09/01 08:49:48 adam
105 * New windows NT/95 port using MSV5.0. To export DLL functions the
106 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
108 * Revision 1.21 1997/05/14 06:53:38 adam
111 * Revision 1.20 1996/10/29 13:34:39 adam
112 * New functions to get/set data1_tabpath.
114 * Revision 1.19 1996/10/11 11:57:16 quinn
117 * Revision 1.18 1996/10/07 15:29:16 quinn
120 * Revision 1.17 1996/07/06 19:58:32 quinn
121 * System headerfiles gathered in yconfig
123 * Revision 1.16 1996/06/10 08:55:34 quinn
124 * Added Summary. Unfinished work
126 * Revision 1.15 1996/06/03 09:46:03 quinn
129 * Revision 1.14 1996/05/09 07:27:11 quinn
130 * Multiple local values supported.
132 * Revision 1.13 1996/02/20 16:32:48 quinn
135 * Revision 1.12 1996/01/18 09:46:34 adam
136 * Changed prototype for reader function parsed to data1_read_record.
138 * Revision 1.11 1995/12/15 16:19:45 quinn
139 * Added formatted_text.
141 * Revision 1.10 1995/12/14 11:09:43 quinn
144 * Revision 1.9 1995/12/13 15:32:47 quinn
147 * Revision 1.8 1995/12/13 13:44:23 quinn
148 * Modified Data1-system to use nmem
150 * Revision 1.7 1995/12/12 16:37:05 quinn
151 * Added destroy element to data1_node.
153 * Revision 1.6 1995/12/11 15:22:12 quinn
154 * Added last_child field to the node.
156 * Revision 1.5 1995/12/05 14:26:40 quinn
157 * Added global lbuf to data1_node.
159 * Revision 1.4 1995/11/13 09:27:29 quinn
160 * Fiddling with the variant stuff.
162 * Revision 1.3 1995/11/01 16:34:52 quinn
163 * Making data1 look for tables in data1_tabpath
165 * Revision 1.2 1995/11/01 13:54:35 quinn
168 * Revision 1.1 1995/11/01 13:07:18 quinn
169 * Data1 module now lives in YAZ.
171 * Revision 1.13 1995/10/25 16:00:49 quinn
172 * USMARC support is now almost operational
174 * Revision 1.12 1995/10/16 14:02:59 quinn
175 * Changes to support element set names and espec1
177 * Revision 1.11 1995/10/13 16:05:10 quinn
178 * Adding Espec1-processing
180 * Revision 1.10 1995/10/11 14:53:46 quinn
183 * Revision 1.9 1995/10/10 16:27:59 quinn
184 * *** empty log message ***
186 * Revision 1.8 1995/10/06 16:44:14 quinn
187 * Work on attribute set mapping, etc.
189 * Revision 1.7 1995/10/06 12:58:36 quinn
192 * Revision 1.6 1995/10/04 09:29:51 quinn
193 * Adjustments to support USGS test data
195 * Revision 1.5 1995/10/03 17:56:44 quinn
198 * Revision 1.4 1995/10/02 14:55:43 quinn
199 * *** empty log message ***
201 * Revision 1.3 1995/09/15 14:41:43 quinn
204 * Revision 1.2 1995/09/14 15:18:14 quinn
207 * Revision 1.1 1995/09/12 11:24:33 quinn
208 * Beginning to add code for structured records.
222 #include <d1_attset.h>
224 #include <yaz-util.h>
231 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
233 #define DATA1_MAX_SYMBOL 31
235 typedef struct data1_name
238 struct data1_name *next;
241 typedef struct data1_absyn_cache_info *data1_absyn_cache;
242 typedef struct data1_attset_cache_info *data1_attset_cache;
244 typedef enum data1_datatype
252 DATA1K_generalizedtime,
259 typedef struct data1_marctab
264 char record_status[2];
265 char implementation_codes[5];
266 int indicator_length;
267 int identifier_length;
268 char user_systems[4];
270 int length_data_entry;
272 int length_implementation;
275 int force_indicator_length;
276 int force_identifier_length;
277 struct data1_marctab *next;
280 typedef struct data1_esetname
284 struct data1_esetname *next;
288 * Variant set definitions.
291 typedef struct data1_vartype
294 struct data1_varclass *zclass;
296 data1_datatype datatype;
297 struct data1_vartype *next;
300 typedef struct data1_varclass
303 struct data1_varset *set;
305 data1_vartype *types;
306 struct data1_varclass *next;
309 typedef struct data1_varset
313 data1_varclass *classes;
322 typedef struct data1_tag
325 #define DATA1T_numeric 1
326 #define DATA1T_string 2
335 struct data1_tagset *tagset;
336 struct data1_tag *next;
339 typedef struct data1_tagset data1_tagset;
343 int type; /* type of tagset in current context */
344 char *name; /* symbolic name */
346 data1_tag *tags; /* tags defined by this set */
347 data1_tagset *children; /* children */
348 data1_tagset *next; /* sibling */
351 typedef struct data1_termlist
355 struct data1_termlist *next;
359 * abstract syntax specification
362 typedef struct data1_element
366 data1_termlist *termlists;
368 struct data1_element *children;
369 struct data1_element *next;
372 typedef struct data1_sub_elements {
374 struct data1_sub_elements *next;
375 data1_element *elements;
376 } data1_sub_elements;
378 typedef struct data1_absyn
382 data1_tagset *tagset;
383 data1_attset *attset;
384 data1_varset *varset;
385 data1_esetname *esetnames;
386 data1_maptab *maptabs;
388 data1_sub_elements *sub_elements;
389 data1_element *main_elements;
393 * record data node (tag/data/variant)
396 typedef struct data1_node
398 /* the root of a record (containing global data) */
399 #define DATA1N_root 1
402 /* some data under a leaf tag or variant */
403 #define DATA1N_data 3
404 /* variant specification (a triple, actually) */
405 #define DATA1N_variant 4
413 data1_absyn *absyn; /* abstract syntax for this type */
419 data1_element *element;
420 int no_data_requested;
422 unsigned node_selected : 1;
423 unsigned make_variantlist : 1;
428 char *data; /* filename or data */
431 #define DATA1I_inctxt 1
432 /* binary data inclusion */
433 #define DATA1I_incbin 2
435 #define DATA1I_text 3
438 /* object identifier */
441 unsigned formatted_text : 1; /* newlines are significant */
451 void (*destroy)(struct data1_node *n);
452 #define DATA1_LOCALDATA 12
453 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
454 struct data1_node *next;
455 struct data1_node *child;
456 struct data1_node *last_child;
457 struct data1_node *parent;
458 struct data1_node *root;
461 YAZ_EXPORT data1_handle data1_create (void);
462 YAZ_EXPORT void data1_destroy(data1_handle dh);
463 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
464 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
466 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
467 int (*get_byte)(void *fh), void *fh,
469 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
470 int (*rf)(void *, char *, size_t),
472 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
473 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
475 int type, int value);
476 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
477 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
480 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
482 data1_element *parent,
483 const char *tagname);
484 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
487 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
489 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
490 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
491 int select, int *len);
492 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
495 const char *tagname, NMEM m);
496 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
498 const char *tagname, NMEM m);
499 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
500 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
501 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
503 char *zclass, char *type);
504 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
505 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
506 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
509 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
512 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
513 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
514 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
515 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
516 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
517 data1_maptab *map, NMEM m);
518 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
520 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
521 data1_node *n, int selected, int *len);
522 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
523 int select, int *len);
524 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
525 data1_node *n, int select,
527 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
528 data1_node *n, int select,
530 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
532 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
533 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
535 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
536 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
537 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
538 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
539 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
540 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
541 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
542 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
543 NMEM m, const char *str);
544 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
546 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
547 void (*fh)(data1_handle dh,
548 void *h, data1_absyn *a));
550 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
552 YAZ_EXPORT data1_node
553 *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
554 data1_node *at, const char *tagname, NMEM m,
555 int first_flag, int local_allowed);