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.30 1997-10-31 12:20:07 adam
28 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
29 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
30 * Bug fix: missing fclose in data1_read_espec1.
32 * Revision 1.29 1997/10/27 13:54:18 adam
33 * Changed structure field in data1 node to be simple string which
34 * is "unknown" to the retrieval system itself.
36 * Revision 1.28 1997/10/06 09:37:53 adam
37 * Added prototype for data1_get_map_buf.
39 * Revision 1.27 1997/09/24 13:35:44 adam
40 * Added two members to data1_marctab to ease reading of weird MARC records.
42 * Revision 1.26 1997/09/17 12:10:32 adam
45 * Revision 1.25 1997/09/05 09:50:55 adam
46 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
48 * Revision 1.24 1997/09/01 09:30:39 adam
49 * Added include of yaz-util.h.
51 * Revision 1.23 1997/09/01 08:58:04 adam
52 * Removed declaration of data1_matchstr since it's a macro.
54 * Revision 1.22 1997/09/01 08:49:48 adam
55 * New windows NT/95 port using MSV5.0. To export DLL functions the
56 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
58 * Revision 1.21 1997/05/14 06:53:38 adam
61 * Revision 1.20 1996/10/29 13:34:39 adam
62 * New functions to get/set data1_tabpath.
64 * Revision 1.19 1996/10/11 11:57:16 quinn
67 * Revision 1.18 1996/10/07 15:29:16 quinn
70 * Revision 1.17 1996/07/06 19:58:32 quinn
71 * System headerfiles gathered in yconfig
73 * Revision 1.16 1996/06/10 08:55:34 quinn
74 * Added Summary. Unfinished work
76 * Revision 1.15 1996/06/03 09:46:03 quinn
79 * Revision 1.14 1996/05/09 07:27:11 quinn
80 * Multiple local values supported.
82 * Revision 1.13 1996/02/20 16:32:48 quinn
85 * Revision 1.12 1996/01/18 09:46:34 adam
86 * Changed prototype for reader function parsed to data1_read_record.
88 * Revision 1.11 1995/12/15 16:19:45 quinn
89 * Added formatted_text.
91 * Revision 1.10 1995/12/14 11:09:43 quinn
94 * Revision 1.9 1995/12/13 15:32:47 quinn
97 * Revision 1.8 1995/12/13 13:44:23 quinn
98 * Modified Data1-system to use nmem
100 * Revision 1.7 1995/12/12 16:37:05 quinn
101 * Added destroy element to data1_node.
103 * Revision 1.6 1995/12/11 15:22:12 quinn
104 * Added last_child field to the node.
106 * Revision 1.5 1995/12/05 14:26:40 quinn
107 * Added global lbuf to data1_node.
109 * Revision 1.4 1995/11/13 09:27:29 quinn
110 * Fiddling with the variant stuff.
112 * Revision 1.3 1995/11/01 16:34:52 quinn
113 * Making data1 look for tables in data1_tabpath
115 * Revision 1.2 1995/11/01 13:54:35 quinn
118 * Revision 1.1 1995/11/01 13:07:18 quinn
119 * Data1 module now lives in YAZ.
121 * Revision 1.13 1995/10/25 16:00:49 quinn
122 * USMARC support is now almost operational
124 * Revision 1.12 1995/10/16 14:02:59 quinn
125 * Changes to support element set names and espec1
127 * Revision 1.11 1995/10/13 16:05:10 quinn
128 * Adding Espec1-processing
130 * Revision 1.10 1995/10/11 14:53:46 quinn
133 * Revision 1.9 1995/10/10 16:27:59 quinn
134 * *** empty log message ***
136 * Revision 1.8 1995/10/06 16:44:14 quinn
137 * Work on attribute set mapping, etc.
139 * Revision 1.7 1995/10/06 12:58:36 quinn
142 * Revision 1.6 1995/10/04 09:29:51 quinn
143 * Adjustments to support USGS test data
145 * Revision 1.5 1995/10/03 17:56:44 quinn
148 * Revision 1.4 1995/10/02 14:55:43 quinn
149 * *** empty log message ***
151 * Revision 1.3 1995/09/15 14:41:43 quinn
154 * Revision 1.2 1995/09/14 15:18:14 quinn
157 * Revision 1.1 1995/09/12 11:24:33 quinn
158 * Beginning to add code for structured records.
172 #include <d1_attset.h>
174 #include <yaz-util.h>
181 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
183 #define DATA1_MAX_SYMBOL 31
185 typedef struct data1_name
188 struct data1_name *next;
191 typedef struct data1_absyn_cache_info *data1_absyn_cache;
193 typedef enum data1_datatype
195 DATA1K_structured = 1,
200 DATA1K_generalizedtime,
207 typedef struct data1_marctab
212 char record_status[2];
213 char implementation_codes[5];
214 int indicator_length;
215 int identifier_length;
216 char user_systems[4];
218 int length_data_entry;
220 int length_implementation;
223 int force_indicator_length;
224 int force_identifier_length;
225 struct data1_marctab *next;
228 typedef struct data1_esetname
232 struct data1_esetname *next;
236 * Variant set definitions.
239 typedef struct data1_vartype
242 struct data1_varclass *zclass;
244 data1_datatype datatype;
245 struct data1_vartype *next;
248 typedef struct data1_varclass
251 struct data1_varset *set;
253 data1_vartype *types;
254 struct data1_varclass *next;
257 typedef struct data1_varset
261 data1_varclass *classes;
270 typedef struct data1_tag
273 #define DATA1T_numeric 1
274 #define DATA1T_string 2
283 struct data1_tagset *tagset;
284 struct data1_tag *next;
287 typedef struct data1_tagset
289 char *name; /* symbolic name */
291 int type; /* type of tagset in current context */
292 data1_tag *tags; /* tags defined by this set */
293 struct data1_tagset *children; /* included tagsets */
294 struct data1_tagset *next; /* sibling */
297 typedef struct data1_termlist
301 struct data1_termlist *next;
305 * abstract syntax specification
308 typedef struct data1_element
312 data1_termlist *termlists;
313 struct data1_element *parent;
314 struct data1_element *children;
315 struct data1_element *next;
318 typedef struct data1_absyn
322 data1_tagset *tagset;
323 data1_attset *attset;
324 data1_varset *varset;
325 data1_esetname *esetnames;
326 data1_maptab *maptabs;
328 data1_element *elements;
332 * record data node (tag/data/variant)
335 typedef struct data1_node
337 /* the root of a record (containing global data) */
338 #define DATA1N_root 1
341 /* some data under a leaf tag or variant */
342 #define DATA1N_data 3
343 /* variant specification (a triple, actually) */
344 #define DATA1N_variant 4
352 data1_absyn *absyn; /* abstract syntax for this type */
358 data1_element *element;
360 int make_variantlist;
361 int no_data_requested;
368 #define DATA1I_inctxt 1
369 /* binary data inclusion */
370 #define DATA1I_incbin 2
372 #define DATA1I_text 3
375 /* object identifier */
378 int formatted_text; /* newlines are significant */
380 char *data; /* filename or data */
395 void (*destroy)(struct data1_node *n);
396 #define DATA1_LOCALDATA 40
397 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
400 struct data1_node *next;
401 struct data1_node *child;
402 struct data1_node *last_child;
403 struct data1_node *parent;
404 struct data1_node *root;
407 YAZ_EXPORT data1_handle data1_create (void);
408 YAZ_EXPORT void data1_destroy(data1_handle dh);
409 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
410 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, char **buf,
412 int *line, data1_absyn *absyn, NMEM m);
413 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
414 int (*rf)(void *, char *, size_t),
416 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
417 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
418 int type, int value);
419 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
420 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
422 data1_element *parent,
424 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
427 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
429 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
430 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
431 int select, int *len);
432 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
435 char *tagname, NMEM m);
436 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
437 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
438 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
440 char *zclass, char *type);
441 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
442 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
443 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
444 data1_absyn *a, char *name);
445 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
448 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
449 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, char *name);
450 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
451 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
452 data1_maptab *map, NMEM m);
453 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
455 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
456 data1_node *n, int selected, int *len);
457 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
458 int select, int *len);
459 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
460 data1_node *n, int select,
462 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
463 data1_node *n, int select,
465 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
467 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
468 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
470 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
471 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
472 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
473 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
474 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
475 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);