2 * Copyright (c) 1995-1997, 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.32 1997-12-09 16:18:16 adam
28 * Work on EXPLAIN schema. First implementation of sub-schema facility
31 * Revision 1.31 1997/11/18 09:51:08 adam
32 * Removed element num_children from data1_node. Minor changes in
35 * Revision 1.30 1997/10/31 12:20:07 adam
36 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
37 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
38 * Bug fix: missing fclose in data1_read_espec1.
40 * Revision 1.29 1997/10/27 13:54:18 adam
41 * Changed structure field in data1 node to be simple string which
42 * is "unknown" to the retrieval system itself.
44 * Revision 1.28 1997/10/06 09:37:53 adam
45 * Added prototype for data1_get_map_buf.
47 * Revision 1.27 1997/09/24 13:35:44 adam
48 * Added two members to data1_marctab to ease reading of weird MARC records.
50 * Revision 1.26 1997/09/17 12:10:32 adam
53 * Revision 1.25 1997/09/05 09:50:55 adam
54 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
56 * Revision 1.24 1997/09/01 09:30:39 adam
57 * Added include of yaz-util.h.
59 * Revision 1.23 1997/09/01 08:58:04 adam
60 * Removed declaration of data1_matchstr since it's a macro.
62 * Revision 1.22 1997/09/01 08:49:48 adam
63 * New windows NT/95 port using MSV5.0. To export DLL functions the
64 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
66 * Revision 1.21 1997/05/14 06:53:38 adam
69 * Revision 1.20 1996/10/29 13:34:39 adam
70 * New functions to get/set data1_tabpath.
72 * Revision 1.19 1996/10/11 11:57:16 quinn
75 * Revision 1.18 1996/10/07 15:29:16 quinn
78 * Revision 1.17 1996/07/06 19:58:32 quinn
79 * System headerfiles gathered in yconfig
81 * Revision 1.16 1996/06/10 08:55:34 quinn
82 * Added Summary. Unfinished work
84 * Revision 1.15 1996/06/03 09:46:03 quinn
87 * Revision 1.14 1996/05/09 07:27:11 quinn
88 * Multiple local values supported.
90 * Revision 1.13 1996/02/20 16:32:48 quinn
93 * Revision 1.12 1996/01/18 09:46:34 adam
94 * Changed prototype for reader function parsed to data1_read_record.
96 * Revision 1.11 1995/12/15 16:19:45 quinn
97 * Added formatted_text.
99 * Revision 1.10 1995/12/14 11:09:43 quinn
102 * Revision 1.9 1995/12/13 15:32:47 quinn
105 * Revision 1.8 1995/12/13 13:44:23 quinn
106 * Modified Data1-system to use nmem
108 * Revision 1.7 1995/12/12 16:37:05 quinn
109 * Added destroy element to data1_node.
111 * Revision 1.6 1995/12/11 15:22:12 quinn
112 * Added last_child field to the node.
114 * Revision 1.5 1995/12/05 14:26:40 quinn
115 * Added global lbuf to data1_node.
117 * Revision 1.4 1995/11/13 09:27:29 quinn
118 * Fiddling with the variant stuff.
120 * Revision 1.3 1995/11/01 16:34:52 quinn
121 * Making data1 look for tables in data1_tabpath
123 * Revision 1.2 1995/11/01 13:54:35 quinn
126 * Revision 1.1 1995/11/01 13:07:18 quinn
127 * Data1 module now lives in YAZ.
129 * Revision 1.13 1995/10/25 16:00:49 quinn
130 * USMARC support is now almost operational
132 * Revision 1.12 1995/10/16 14:02:59 quinn
133 * Changes to support element set names and espec1
135 * Revision 1.11 1995/10/13 16:05:10 quinn
136 * Adding Espec1-processing
138 * Revision 1.10 1995/10/11 14:53:46 quinn
141 * Revision 1.9 1995/10/10 16:27:59 quinn
142 * *** empty log message ***
144 * Revision 1.8 1995/10/06 16:44:14 quinn
145 * Work on attribute set mapping, etc.
147 * Revision 1.7 1995/10/06 12:58:36 quinn
150 * Revision 1.6 1995/10/04 09:29:51 quinn
151 * Adjustments to support USGS test data
153 * Revision 1.5 1995/10/03 17:56:44 quinn
156 * Revision 1.4 1995/10/02 14:55:43 quinn
157 * *** empty log message ***
159 * Revision 1.3 1995/09/15 14:41:43 quinn
162 * Revision 1.2 1995/09/14 15:18:14 quinn
165 * Revision 1.1 1995/09/12 11:24:33 quinn
166 * Beginning to add code for structured records.
180 #include <d1_attset.h>
182 #include <yaz-util.h>
189 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
191 #define DATA1_MAX_SYMBOL 31
193 typedef struct data1_name
196 struct data1_name *next;
199 typedef struct data1_absyn_cache_info *data1_absyn_cache;
201 typedef enum data1_datatype
203 DATA1K_structured = 1,
208 DATA1K_generalizedtime,
215 typedef struct data1_marctab
220 char record_status[2];
221 char implementation_codes[5];
222 int indicator_length;
223 int identifier_length;
224 char user_systems[4];
226 int length_data_entry;
228 int length_implementation;
231 int force_indicator_length;
232 int force_identifier_length;
233 struct data1_marctab *next;
236 typedef struct data1_esetname
240 struct data1_esetname *next;
244 * Variant set definitions.
247 typedef struct data1_vartype
250 struct data1_varclass *zclass;
252 data1_datatype datatype;
253 struct data1_vartype *next;
256 typedef struct data1_varclass
259 struct data1_varset *set;
261 data1_vartype *types;
262 struct data1_varclass *next;
265 typedef struct data1_varset
269 data1_varclass *classes;
278 typedef struct data1_tag
281 #define DATA1T_numeric 1
282 #define DATA1T_string 2
291 struct data1_tagset *tagset;
292 struct data1_tag *next;
295 typedef struct data1_tagset
297 char *name; /* symbolic name */
299 int type; /* type of tagset in current context */
300 data1_tag *tags; /* tags defined by this set */
301 struct data1_tagset *children; /* included tagsets */
302 struct data1_tagset *next; /* sibling */
305 typedef struct data1_termlist
309 struct data1_termlist *next;
313 * abstract syntax specification
316 typedef struct data1_element
320 data1_termlist *termlists;
321 struct data1_element *children;
322 struct data1_element *next;
325 typedef struct data1_sub_elements {
327 struct data1_sub_elements *next;
328 data1_element *elements;
329 } data1_sub_elements;
331 typedef struct data1_absyn
335 data1_tagset *tagset;
336 data1_attset *attset;
337 data1_varset *varset;
338 data1_esetname *esetnames;
339 data1_maptab *maptabs;
341 data1_sub_elements *sub_elements;
342 data1_element *main_elements;
346 * record data node (tag/data/variant)
349 typedef struct data1_node
351 /* the root of a record (containing global data) */
352 #define DATA1N_root 1
355 /* some data under a leaf tag or variant */
356 #define DATA1N_data 3
357 /* variant specification (a triple, actually) */
358 #define DATA1N_variant 4
366 data1_absyn *absyn; /* abstract syntax for this type */
372 data1_element *element;
374 int make_variantlist;
375 int no_data_requested;
382 #define DATA1I_inctxt 1
383 /* binary data inclusion */
384 #define DATA1I_incbin 2
386 #define DATA1I_text 3
389 /* object identifier */
392 int formatted_text; /* newlines are significant */
394 char *data; /* filename or data */
404 void (*destroy)(struct data1_node *n);
405 #define DATA1_LOCALDATA 40
406 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
408 struct data1_node *next;
409 struct data1_node *child;
410 struct data1_node *last_child;
411 struct data1_node *parent;
412 struct data1_node *root;
415 YAZ_EXPORT data1_handle data1_create (void);
416 YAZ_EXPORT void data1_destroy(data1_handle dh);
417 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
418 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, char **buf,
420 int *line, data1_absyn *absyn, NMEM m);
421 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
422 int (*rf)(void *, char *, size_t),
424 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
425 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
426 int type, int value);
427 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
428 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
430 data1_element *parent,
432 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
435 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
437 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
438 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
439 int select, int *len);
440 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
443 char *tagname, NMEM m);
444 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
445 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
446 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
448 char *zclass, char *type);
449 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
450 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
451 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
452 data1_absyn *a, char *name);
453 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
456 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
457 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, char *name);
458 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
459 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
460 data1_maptab *map, NMEM m);
461 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
463 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
464 data1_node *n, int selected, int *len);
465 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
466 int select, int *len);
467 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
468 data1_node *n, int select,
470 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
471 data1_node *n, int select,
473 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
475 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
476 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
478 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
479 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
480 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
481 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
482 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
483 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);