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.37 1998-10-13 16:09:46 adam
28 * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
29 * Added support for multiple attribute set references and tagset references
30 * from an abstract syntax file.
31 * Fixed many bad logs-calls in routines that read the various
32 * specifications regarding data1 (*.abs,*.att,...) and made the messages
33 * consistent whenever possible.
34 * Added extra 'lineno' argument to function readconf_line.
36 * Revision 1.36 1998/05/18 13:06:57 adam
37 * Changed the way attribute sets are handled by the retriaval module.
38 * Extended Explain conversion / schema.
39 * Modified server and client to work with ASN.1 compiled protocol handlers.
41 * Revision 1.35 1998/03/05 08:15:32 adam
42 * Implemented data1_add_insert_taggeddata utility which is more flexible
43 * than data1_insert_taggeddata.
45 * Revision 1.34 1998/02/27 14:08:04 adam
46 * Added const to some char pointer arguments.
47 * Reworked data1_read_node so that it doesn't create a tree with
48 * pointers to original "SGML"-buffer.
50 * Revision 1.33 1997/12/18 10:51:30 adam
51 * Implemented sub-trees feature for schemas - including forward
54 * Revision 1.32 1997/12/09 16:18:16 adam
55 * Work on EXPLAIN schema. First implementation of sub-schema facility
58 * Revision 1.31 1997/11/18 09:51:08 adam
59 * Removed element num_children from data1_node. Minor changes in
62 * Revision 1.30 1997/10/31 12:20:07 adam
63 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
64 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
65 * Bug fix: missing fclose in data1_read_espec1.
67 * Revision 1.29 1997/10/27 13:54:18 adam
68 * Changed structure field in data1 node to be simple string which
69 * is "unknown" to the retrieval system itself.
71 * Revision 1.28 1997/10/06 09:37:53 adam
72 * Added prototype for data1_get_map_buf.
74 * Revision 1.27 1997/09/24 13:35:44 adam
75 * Added two members to data1_marctab to ease reading of weird MARC records.
77 * Revision 1.26 1997/09/17 12:10:32 adam
80 * Revision 1.25 1997/09/05 09:50:55 adam
81 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
83 * Revision 1.24 1997/09/01 09:30:39 adam
84 * Added include of yaz-util.h.
86 * Revision 1.23 1997/09/01 08:58:04 adam
87 * Removed declaration of data1_matchstr since it's a macro.
89 * Revision 1.22 1997/09/01 08:49:48 adam
90 * New windows NT/95 port using MSV5.0. To export DLL functions the
91 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
93 * Revision 1.21 1997/05/14 06:53:38 adam
96 * Revision 1.20 1996/10/29 13:34:39 adam
97 * New functions to get/set data1_tabpath.
99 * Revision 1.19 1996/10/11 11:57:16 quinn
102 * Revision 1.18 1996/10/07 15:29:16 quinn
105 * Revision 1.17 1996/07/06 19:58:32 quinn
106 * System headerfiles gathered in yconfig
108 * Revision 1.16 1996/06/10 08:55:34 quinn
109 * Added Summary. Unfinished work
111 * Revision 1.15 1996/06/03 09:46:03 quinn
114 * Revision 1.14 1996/05/09 07:27:11 quinn
115 * Multiple local values supported.
117 * Revision 1.13 1996/02/20 16:32:48 quinn
120 * Revision 1.12 1996/01/18 09:46:34 adam
121 * Changed prototype for reader function parsed to data1_read_record.
123 * Revision 1.11 1995/12/15 16:19:45 quinn
124 * Added formatted_text.
126 * Revision 1.10 1995/12/14 11:09:43 quinn
129 * Revision 1.9 1995/12/13 15:32:47 quinn
132 * Revision 1.8 1995/12/13 13:44:23 quinn
133 * Modified Data1-system to use nmem
135 * Revision 1.7 1995/12/12 16:37:05 quinn
136 * Added destroy element to data1_node.
138 * Revision 1.6 1995/12/11 15:22:12 quinn
139 * Added last_child field to the node.
141 * Revision 1.5 1995/12/05 14:26:40 quinn
142 * Added global lbuf to data1_node.
144 * Revision 1.4 1995/11/13 09:27:29 quinn
145 * Fiddling with the variant stuff.
147 * Revision 1.3 1995/11/01 16:34:52 quinn
148 * Making data1 look for tables in data1_tabpath
150 * Revision 1.2 1995/11/01 13:54:35 quinn
153 * Revision 1.1 1995/11/01 13:07:18 quinn
154 * Data1 module now lives in YAZ.
156 * Revision 1.13 1995/10/25 16:00:49 quinn
157 * USMARC support is now almost operational
159 * Revision 1.12 1995/10/16 14:02:59 quinn
160 * Changes to support element set names and espec1
162 * Revision 1.11 1995/10/13 16:05:10 quinn
163 * Adding Espec1-processing
165 * Revision 1.10 1995/10/11 14:53:46 quinn
168 * Revision 1.9 1995/10/10 16:27:59 quinn
169 * *** empty log message ***
171 * Revision 1.8 1995/10/06 16:44:14 quinn
172 * Work on attribute set mapping, etc.
174 * Revision 1.7 1995/10/06 12:58:36 quinn
177 * Revision 1.6 1995/10/04 09:29:51 quinn
178 * Adjustments to support USGS test data
180 * Revision 1.5 1995/10/03 17:56:44 quinn
183 * Revision 1.4 1995/10/02 14:55:43 quinn
184 * *** empty log message ***
186 * Revision 1.3 1995/09/15 14:41:43 quinn
189 * Revision 1.2 1995/09/14 15:18:14 quinn
192 * Revision 1.1 1995/09/12 11:24:33 quinn
193 * Beginning to add code for structured records.
207 #include <d1_attset.h>
209 #include <yaz-util.h>
216 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
218 #define DATA1_MAX_SYMBOL 31
220 typedef struct data1_name
223 struct data1_name *next;
226 typedef struct data1_absyn_cache_info *data1_absyn_cache;
227 typedef struct data1_attset_cache_info *data1_attset_cache;
229 typedef enum data1_datatype
231 DATA1K_structured = 1,
236 DATA1K_generalizedtime,
243 typedef struct data1_marctab
248 char record_status[2];
249 char implementation_codes[5];
250 int indicator_length;
251 int identifier_length;
252 char user_systems[4];
254 int length_data_entry;
256 int length_implementation;
259 int force_indicator_length;
260 int force_identifier_length;
261 struct data1_marctab *next;
264 typedef struct data1_esetname
268 struct data1_esetname *next;
272 * Variant set definitions.
275 typedef struct data1_vartype
278 struct data1_varclass *zclass;
280 data1_datatype datatype;
281 struct data1_vartype *next;
284 typedef struct data1_varclass
287 struct data1_varset *set;
289 data1_vartype *types;
290 struct data1_varclass *next;
293 typedef struct data1_varset
297 data1_varclass *classes;
306 typedef struct data1_tag
309 #define DATA1T_numeric 1
310 #define DATA1T_string 2
319 struct data1_tagset *tagset;
320 struct data1_tag *next;
323 typedef struct data1_tagset
325 char *name; /* symbolic name */
327 int type; /* type of tagset in current context */
328 data1_tag *tags; /* tags defined by this set */
329 struct data1_tagset *children; /* included tagsets */
330 struct data1_tagset *next; /* sibling */
333 typedef struct data1_termlist
337 struct data1_termlist *next;
341 * abstract syntax specification
344 typedef struct data1_element
348 data1_termlist *termlists;
350 struct data1_element *children;
351 struct data1_element *next;
354 typedef struct data1_sub_elements {
356 struct data1_sub_elements *next;
357 data1_element *elements;
358 } data1_sub_elements;
360 typedef struct data1_absyn
364 data1_tagset *tagset;
365 data1_attset *attset;
366 data1_varset *varset;
367 data1_esetname *esetnames;
368 data1_maptab *maptabs;
370 data1_sub_elements *sub_elements;
371 data1_element *main_elements;
375 * record data node (tag/data/variant)
378 typedef struct data1_node
380 /* the root of a record (containing global data) */
381 #define DATA1N_root 1
384 /* some data under a leaf tag or variant */
385 #define DATA1N_data 3
386 /* variant specification (a triple, actually) */
387 #define DATA1N_variant 4
395 data1_absyn *absyn; /* abstract syntax for this type */
401 data1_element *element;
403 int make_variantlist;
404 int no_data_requested;
411 #define DATA1I_inctxt 1
412 /* binary data inclusion */
413 #define DATA1I_incbin 2
415 #define DATA1I_text 3
418 /* object identifier */
421 int formatted_text; /* newlines are significant */
423 char *data; /* filename or data */
433 void (*destroy)(struct data1_node *n);
434 #define DATA1_LOCALDATA 40
435 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
437 struct data1_node *next;
438 struct data1_node *child;
439 struct data1_node *last_child;
440 struct data1_node *parent;
441 struct data1_node *root;
444 YAZ_EXPORT data1_handle data1_create (void);
445 YAZ_EXPORT void data1_destroy(data1_handle dh);
446 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
447 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
449 int *line, data1_absyn *absyn, NMEM m);
450 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
451 int (*rf)(void *, char *, size_t),
453 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
454 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
455 int type, int value);
456 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
457 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
458 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
460 data1_element *parent,
461 const char *tagname);
462 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
465 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
467 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
468 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
469 int select, int *len);
470 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
473 const char *tagname, NMEM m);
474 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
476 const char *tagname, NMEM m);
477 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
478 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
479 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
481 char *zclass, char *type);
482 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
483 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
484 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
487 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
490 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
491 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
492 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
493 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
494 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
495 data1_maptab *map, NMEM m);
496 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
498 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
499 data1_node *n, int selected, int *len);
500 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
501 int select, int *len);
502 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
503 data1_node *n, int select,
505 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
506 data1_node *n, int select,
508 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
510 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
511 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
513 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
514 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
515 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
516 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
517 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
518 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
519 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
520 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
521 NMEM m, const char *str);
522 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
524 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
525 void (*fh)(data1_handle dh,
526 void *h, data1_absyn *a));
528 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
530 YAZ_EXPORT data1_node
531 *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
532 data1_node *at, const char *tagname, NMEM m,
533 int first_flag, int local_allowed);