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.31 1997-11-18 09:51:08 adam
28 * Removed element num_children from data1_node. Minor changes in
31 * Revision 1.30 1997/10/31 12:20:07 adam
32 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
33 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
34 * Bug fix: missing fclose in data1_read_espec1.
36 * Revision 1.29 1997/10/27 13:54:18 adam
37 * Changed structure field in data1 node to be simple string which
38 * is "unknown" to the retrieval system itself.
40 * Revision 1.28 1997/10/06 09:37:53 adam
41 * Added prototype for data1_get_map_buf.
43 * Revision 1.27 1997/09/24 13:35:44 adam
44 * Added two members to data1_marctab to ease reading of weird MARC records.
46 * Revision 1.26 1997/09/17 12:10:32 adam
49 * Revision 1.25 1997/09/05 09:50:55 adam
50 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
52 * Revision 1.24 1997/09/01 09:30:39 adam
53 * Added include of yaz-util.h.
55 * Revision 1.23 1997/09/01 08:58:04 adam
56 * Removed declaration of data1_matchstr since it's a macro.
58 * Revision 1.22 1997/09/01 08:49:48 adam
59 * New windows NT/95 port using MSV5.0. To export DLL functions the
60 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
62 * Revision 1.21 1997/05/14 06:53:38 adam
65 * Revision 1.20 1996/10/29 13:34:39 adam
66 * New functions to get/set data1_tabpath.
68 * Revision 1.19 1996/10/11 11:57:16 quinn
71 * Revision 1.18 1996/10/07 15:29:16 quinn
74 * Revision 1.17 1996/07/06 19:58:32 quinn
75 * System headerfiles gathered in yconfig
77 * Revision 1.16 1996/06/10 08:55:34 quinn
78 * Added Summary. Unfinished work
80 * Revision 1.15 1996/06/03 09:46:03 quinn
83 * Revision 1.14 1996/05/09 07:27:11 quinn
84 * Multiple local values supported.
86 * Revision 1.13 1996/02/20 16:32:48 quinn
89 * Revision 1.12 1996/01/18 09:46:34 adam
90 * Changed prototype for reader function parsed to data1_read_record.
92 * Revision 1.11 1995/12/15 16:19:45 quinn
93 * Added formatted_text.
95 * Revision 1.10 1995/12/14 11:09:43 quinn
98 * Revision 1.9 1995/12/13 15:32:47 quinn
101 * Revision 1.8 1995/12/13 13:44:23 quinn
102 * Modified Data1-system to use nmem
104 * Revision 1.7 1995/12/12 16:37:05 quinn
105 * Added destroy element to data1_node.
107 * Revision 1.6 1995/12/11 15:22:12 quinn
108 * Added last_child field to the node.
110 * Revision 1.5 1995/12/05 14:26:40 quinn
111 * Added global lbuf to data1_node.
113 * Revision 1.4 1995/11/13 09:27:29 quinn
114 * Fiddling with the variant stuff.
116 * Revision 1.3 1995/11/01 16:34:52 quinn
117 * Making data1 look for tables in data1_tabpath
119 * Revision 1.2 1995/11/01 13:54:35 quinn
122 * Revision 1.1 1995/11/01 13:07:18 quinn
123 * Data1 module now lives in YAZ.
125 * Revision 1.13 1995/10/25 16:00:49 quinn
126 * USMARC support is now almost operational
128 * Revision 1.12 1995/10/16 14:02:59 quinn
129 * Changes to support element set names and espec1
131 * Revision 1.11 1995/10/13 16:05:10 quinn
132 * Adding Espec1-processing
134 * Revision 1.10 1995/10/11 14:53:46 quinn
137 * Revision 1.9 1995/10/10 16:27:59 quinn
138 * *** empty log message ***
140 * Revision 1.8 1995/10/06 16:44:14 quinn
141 * Work on attribute set mapping, etc.
143 * Revision 1.7 1995/10/06 12:58:36 quinn
146 * Revision 1.6 1995/10/04 09:29:51 quinn
147 * Adjustments to support USGS test data
149 * Revision 1.5 1995/10/03 17:56:44 quinn
152 * Revision 1.4 1995/10/02 14:55:43 quinn
153 * *** empty log message ***
155 * Revision 1.3 1995/09/15 14:41:43 quinn
158 * Revision 1.2 1995/09/14 15:18:14 quinn
161 * Revision 1.1 1995/09/12 11:24:33 quinn
162 * Beginning to add code for structured records.
176 #include <d1_attset.h>
178 #include <yaz-util.h>
185 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
187 #define DATA1_MAX_SYMBOL 31
189 typedef struct data1_name
192 struct data1_name *next;
195 typedef struct data1_absyn_cache_info *data1_absyn_cache;
197 typedef enum data1_datatype
199 DATA1K_structured = 1,
204 DATA1K_generalizedtime,
211 typedef struct data1_marctab
216 char record_status[2];
217 char implementation_codes[5];
218 int indicator_length;
219 int identifier_length;
220 char user_systems[4];
222 int length_data_entry;
224 int length_implementation;
227 int force_indicator_length;
228 int force_identifier_length;
229 struct data1_marctab *next;
232 typedef struct data1_esetname
236 struct data1_esetname *next;
240 * Variant set definitions.
243 typedef struct data1_vartype
246 struct data1_varclass *zclass;
248 data1_datatype datatype;
249 struct data1_vartype *next;
252 typedef struct data1_varclass
255 struct data1_varset *set;
257 data1_vartype *types;
258 struct data1_varclass *next;
261 typedef struct data1_varset
265 data1_varclass *classes;
274 typedef struct data1_tag
277 #define DATA1T_numeric 1
278 #define DATA1T_string 2
287 struct data1_tagset *tagset;
288 struct data1_tag *next;
291 typedef struct data1_tagset
293 char *name; /* symbolic name */
295 int type; /* type of tagset in current context */
296 data1_tag *tags; /* tags defined by this set */
297 struct data1_tagset *children; /* included tagsets */
298 struct data1_tagset *next; /* sibling */
301 typedef struct data1_termlist
305 struct data1_termlist *next;
309 * abstract syntax specification
312 typedef struct data1_element
316 data1_termlist *termlists;
317 struct data1_element *parent;
318 struct data1_element *children;
319 struct data1_element *next;
322 typedef struct data1_absyn
326 data1_tagset *tagset;
327 data1_attset *attset;
328 data1_varset *varset;
329 data1_esetname *esetnames;
330 data1_maptab *maptabs;
332 data1_element *elements;
336 * record data node (tag/data/variant)
339 typedef struct data1_node
341 /* the root of a record (containing global data) */
342 #define DATA1N_root 1
345 /* some data under a leaf tag or variant */
346 #define DATA1N_data 3
347 /* variant specification (a triple, actually) */
348 #define DATA1N_variant 4
356 data1_absyn *absyn; /* abstract syntax for this type */
362 data1_element *element;
364 int make_variantlist;
365 int no_data_requested;
372 #define DATA1I_inctxt 1
373 /* binary data inclusion */
374 #define DATA1I_incbin 2
376 #define DATA1I_text 3
379 /* object identifier */
382 int formatted_text; /* newlines are significant */
384 char *data; /* filename or data */
394 void (*destroy)(struct data1_node *n);
395 #define DATA1_LOCALDATA 40
396 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
398 struct data1_node *next;
399 struct data1_node *child;
400 struct data1_node *last_child;
401 struct data1_node *parent;
402 struct data1_node *root;
405 YAZ_EXPORT data1_handle data1_create (void);
406 YAZ_EXPORT void data1_destroy(data1_handle dh);
407 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
408 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, char **buf,
410 int *line, data1_absyn *absyn, NMEM m);
411 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
412 int (*rf)(void *, char *, size_t),
414 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
415 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
416 int type, int value);
417 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
418 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
420 data1_element *parent,
422 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
425 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
427 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
428 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
429 int select, int *len);
430 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
433 char *tagname, NMEM m);
434 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
435 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
436 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
438 char *zclass, char *type);
439 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
440 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
441 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
442 data1_absyn *a, char *name);
443 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
446 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
447 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, char *name);
448 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
449 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
450 data1_maptab *map, NMEM m);
451 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
453 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
454 data1_node *n, int selected, int *len);
455 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
456 int select, int *len);
457 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
458 data1_node *n, int select,
460 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
461 data1_node *n, int select,
463 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
465 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
466 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
468 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
469 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
470 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
471 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
472 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
473 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);