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.34 1998-02-27 14:08:04 adam
28 * Added const to some char pointer arguments.
29 * Reworked data1_read_node so that it doesn't create a tree with
30 * pointers to original "SGML"-buffer.
32 * Revision 1.33 1997/12/18 10:51:30 adam
33 * Implemented sub-trees feature for schemas - including forward
36 * Revision 1.32 1997/12/09 16:18:16 adam
37 * Work on EXPLAIN schema. First implementation of sub-schema facility
40 * Revision 1.31 1997/11/18 09:51:08 adam
41 * Removed element num_children from data1_node. Minor changes in
44 * Revision 1.30 1997/10/31 12:20:07 adam
45 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
46 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
47 * Bug fix: missing fclose in data1_read_espec1.
49 * Revision 1.29 1997/10/27 13:54:18 adam
50 * Changed structure field in data1 node to be simple string which
51 * is "unknown" to the retrieval system itself.
53 * Revision 1.28 1997/10/06 09:37:53 adam
54 * Added prototype for data1_get_map_buf.
56 * Revision 1.27 1997/09/24 13:35:44 adam
57 * Added two members to data1_marctab to ease reading of weird MARC records.
59 * Revision 1.26 1997/09/17 12:10:32 adam
62 * Revision 1.25 1997/09/05 09:50:55 adam
63 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
65 * Revision 1.24 1997/09/01 09:30:39 adam
66 * Added include of yaz-util.h.
68 * Revision 1.23 1997/09/01 08:58:04 adam
69 * Removed declaration of data1_matchstr since it's a macro.
71 * Revision 1.22 1997/09/01 08:49:48 adam
72 * New windows NT/95 port using MSV5.0. To export DLL functions the
73 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
75 * Revision 1.21 1997/05/14 06:53:38 adam
78 * Revision 1.20 1996/10/29 13:34:39 adam
79 * New functions to get/set data1_tabpath.
81 * Revision 1.19 1996/10/11 11:57:16 quinn
84 * Revision 1.18 1996/10/07 15:29:16 quinn
87 * Revision 1.17 1996/07/06 19:58:32 quinn
88 * System headerfiles gathered in yconfig
90 * Revision 1.16 1996/06/10 08:55:34 quinn
91 * Added Summary. Unfinished work
93 * Revision 1.15 1996/06/03 09:46:03 quinn
96 * Revision 1.14 1996/05/09 07:27:11 quinn
97 * Multiple local values supported.
99 * Revision 1.13 1996/02/20 16:32:48 quinn
102 * Revision 1.12 1996/01/18 09:46:34 adam
103 * Changed prototype for reader function parsed to data1_read_record.
105 * Revision 1.11 1995/12/15 16:19:45 quinn
106 * Added formatted_text.
108 * Revision 1.10 1995/12/14 11:09:43 quinn
111 * Revision 1.9 1995/12/13 15:32:47 quinn
114 * Revision 1.8 1995/12/13 13:44:23 quinn
115 * Modified Data1-system to use nmem
117 * Revision 1.7 1995/12/12 16:37:05 quinn
118 * Added destroy element to data1_node.
120 * Revision 1.6 1995/12/11 15:22:12 quinn
121 * Added last_child field to the node.
123 * Revision 1.5 1995/12/05 14:26:40 quinn
124 * Added global lbuf to data1_node.
126 * Revision 1.4 1995/11/13 09:27:29 quinn
127 * Fiddling with the variant stuff.
129 * Revision 1.3 1995/11/01 16:34:52 quinn
130 * Making data1 look for tables in data1_tabpath
132 * Revision 1.2 1995/11/01 13:54:35 quinn
135 * Revision 1.1 1995/11/01 13:07:18 quinn
136 * Data1 module now lives in YAZ.
138 * Revision 1.13 1995/10/25 16:00:49 quinn
139 * USMARC support is now almost operational
141 * Revision 1.12 1995/10/16 14:02:59 quinn
142 * Changes to support element set names and espec1
144 * Revision 1.11 1995/10/13 16:05:10 quinn
145 * Adding Espec1-processing
147 * Revision 1.10 1995/10/11 14:53:46 quinn
150 * Revision 1.9 1995/10/10 16:27:59 quinn
151 * *** empty log message ***
153 * Revision 1.8 1995/10/06 16:44:14 quinn
154 * Work on attribute set mapping, etc.
156 * Revision 1.7 1995/10/06 12:58:36 quinn
159 * Revision 1.6 1995/10/04 09:29:51 quinn
160 * Adjustments to support USGS test data
162 * Revision 1.5 1995/10/03 17:56:44 quinn
165 * Revision 1.4 1995/10/02 14:55:43 quinn
166 * *** empty log message ***
168 * Revision 1.3 1995/09/15 14:41:43 quinn
171 * Revision 1.2 1995/09/14 15:18:14 quinn
174 * Revision 1.1 1995/09/12 11:24:33 quinn
175 * Beginning to add code for structured records.
189 #include <d1_attset.h>
191 #include <yaz-util.h>
198 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
200 #define DATA1_MAX_SYMBOL 31
202 typedef struct data1_name
205 struct data1_name *next;
208 typedef struct data1_absyn_cache_info *data1_absyn_cache;
210 typedef enum data1_datatype
212 DATA1K_structured = 1,
217 DATA1K_generalizedtime,
224 typedef struct data1_marctab
229 char record_status[2];
230 char implementation_codes[5];
231 int indicator_length;
232 int identifier_length;
233 char user_systems[4];
235 int length_data_entry;
237 int length_implementation;
240 int force_indicator_length;
241 int force_identifier_length;
242 struct data1_marctab *next;
245 typedef struct data1_esetname
249 struct data1_esetname *next;
253 * Variant set definitions.
256 typedef struct data1_vartype
259 struct data1_varclass *zclass;
261 data1_datatype datatype;
262 struct data1_vartype *next;
265 typedef struct data1_varclass
268 struct data1_varset *set;
270 data1_vartype *types;
271 struct data1_varclass *next;
274 typedef struct data1_varset
278 data1_varclass *classes;
287 typedef struct data1_tag
290 #define DATA1T_numeric 1
291 #define DATA1T_string 2
300 struct data1_tagset *tagset;
301 struct data1_tag *next;
304 typedef struct data1_tagset
306 char *name; /* symbolic name */
308 int type; /* type of tagset in current context */
309 data1_tag *tags; /* tags defined by this set */
310 struct data1_tagset *children; /* included tagsets */
311 struct data1_tagset *next; /* sibling */
314 typedef struct data1_termlist
318 struct data1_termlist *next;
322 * abstract syntax specification
325 typedef struct data1_element
329 data1_termlist *termlists;
331 struct data1_element *children;
332 struct data1_element *next;
335 typedef struct data1_sub_elements {
337 struct data1_sub_elements *next;
338 data1_element *elements;
339 } data1_sub_elements;
341 typedef struct data1_absyn
345 data1_tagset *tagset;
346 data1_attset *attset;
347 data1_varset *varset;
348 data1_esetname *esetnames;
349 data1_maptab *maptabs;
351 data1_sub_elements *sub_elements;
352 data1_element *main_elements;
356 * record data node (tag/data/variant)
359 typedef struct data1_node
361 /* the root of a record (containing global data) */
362 #define DATA1N_root 1
365 /* some data under a leaf tag or variant */
366 #define DATA1N_data 3
367 /* variant specification (a triple, actually) */
368 #define DATA1N_variant 4
376 data1_absyn *absyn; /* abstract syntax for this type */
382 data1_element *element;
384 int make_variantlist;
385 int no_data_requested;
392 #define DATA1I_inctxt 1
393 /* binary data inclusion */
394 #define DATA1I_incbin 2
396 #define DATA1I_text 3
399 /* object identifier */
402 int formatted_text; /* newlines are significant */
404 char *data; /* filename or data */
414 void (*destroy)(struct data1_node *n);
415 #define DATA1_LOCALDATA 40
416 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
418 struct data1_node *next;
419 struct data1_node *child;
420 struct data1_node *last_child;
421 struct data1_node *parent;
422 struct data1_node *root;
425 YAZ_EXPORT data1_handle data1_create (void);
426 YAZ_EXPORT void data1_destroy(data1_handle dh);
427 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
428 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
430 int *line, data1_absyn *absyn, NMEM m);
431 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
432 int (*rf)(void *, char *, size_t),
434 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
435 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
436 int type, int value);
437 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
438 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
440 data1_element *parent,
441 const char *tagname);
442 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
445 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
447 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
448 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
449 int select, int *len);
450 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
453 const char *tagname, NMEM m);
454 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
456 const char *tagname, NMEM m);
457 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
458 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
459 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
461 char *zclass, char *type);
462 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
463 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
464 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
467 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
470 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
471 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
472 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
473 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
474 data1_maptab *map, NMEM m);
475 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
477 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
478 data1_node *n, int selected, int *len);
479 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
480 int select, int *len);
481 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
482 data1_node *n, int select,
484 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
485 data1_node *n, int select,
487 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
489 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
490 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
492 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
493 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
494 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
495 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
496 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
497 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
498 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
499 NMEM m, const char *str);
500 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,