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.26 1997-09-17 12:10:32 adam
30 * Revision 1.25 1997/09/05 09:50:55 adam
31 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
33 * Revision 1.24 1997/09/01 09:30:39 adam
34 * Added include of yaz-util.h.
36 * Revision 1.23 1997/09/01 08:58:04 adam
37 * Removed declaration of data1_matchstr since it's a macro.
39 * Revision 1.22 1997/09/01 08:49:48 adam
40 * New windows NT/95 port using MSV5.0. To export DLL functions the
41 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
43 * Revision 1.21 1997/05/14 06:53:38 adam
46 * Revision 1.20 1996/10/29 13:34:39 adam
47 * New functions to get/set data1_tabpath.
49 * Revision 1.19 1996/10/11 11:57:16 quinn
52 * Revision 1.18 1996/10/07 15:29:16 quinn
55 * Revision 1.17 1996/07/06 19:58:32 quinn
56 * System headerfiles gathered in yconfig
58 * Revision 1.16 1996/06/10 08:55:34 quinn
59 * Added Summary. Unfinished work
61 * Revision 1.15 1996/06/03 09:46:03 quinn
64 * Revision 1.14 1996/05/09 07:27:11 quinn
65 * Multiple local values supported.
67 * Revision 1.13 1996/02/20 16:32:48 quinn
70 * Revision 1.12 1996/01/18 09:46:34 adam
71 * Changed prototype for reader function parsed to data1_read_record.
73 * Revision 1.11 1995/12/15 16:19:45 quinn
74 * Added formatted_text.
76 * Revision 1.10 1995/12/14 11:09:43 quinn
79 * Revision 1.9 1995/12/13 15:32:47 quinn
82 * Revision 1.8 1995/12/13 13:44:23 quinn
83 * Modified Data1-system to use nmem
85 * Revision 1.7 1995/12/12 16:37:05 quinn
86 * Added destroy element to data1_node.
88 * Revision 1.6 1995/12/11 15:22:12 quinn
89 * Added last_child field to the node.
91 * Revision 1.5 1995/12/05 14:26:40 quinn
92 * Added global lbuf to data1_node.
94 * Revision 1.4 1995/11/13 09:27:29 quinn
95 * Fiddling with the variant stuff.
97 * Revision 1.3 1995/11/01 16:34:52 quinn
98 * Making data1 look for tables in data1_tabpath
100 * Revision 1.2 1995/11/01 13:54:35 quinn
103 * Revision 1.1 1995/11/01 13:07:18 quinn
104 * Data1 module now lives in YAZ.
106 * Revision 1.13 1995/10/25 16:00:49 quinn
107 * USMARC support is now almost operational
109 * Revision 1.12 1995/10/16 14:02:59 quinn
110 * Changes to support element set names and espec1
112 * Revision 1.11 1995/10/13 16:05:10 quinn
113 * Adding Espec1-processing
115 * Revision 1.10 1995/10/11 14:53:46 quinn
118 * Revision 1.9 1995/10/10 16:27:59 quinn
119 * *** empty log message ***
121 * Revision 1.8 1995/10/06 16:44:14 quinn
122 * Work on attribute set mapping, etc.
124 * Revision 1.7 1995/10/06 12:58:36 quinn
127 * Revision 1.6 1995/10/04 09:29:51 quinn
128 * Adjustments to support USGS test data
130 * Revision 1.5 1995/10/03 17:56:44 quinn
133 * Revision 1.4 1995/10/02 14:55:43 quinn
134 * *** empty log message ***
136 * Revision 1.3 1995/09/15 14:41:43 quinn
139 * Revision 1.2 1995/09/14 15:18:14 quinn
142 * Revision 1.1 1995/09/12 11:24:33 quinn
143 * Beginning to add code for structured records.
157 #include <d1_attset.h>
159 #include <yaz-util.h>
166 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
168 #define DATA1_MAX_SYMBOL 31
170 typedef struct data1_name
173 struct data1_name *next;
176 typedef struct data1_absyn_cache_info *data1_absyn_cache;
178 typedef enum data1_datatype
180 DATA1K_structured = 1,
185 DATA1K_generalizedtime,
192 typedef enum data1_structure
198 typedef struct data1_marctab
203 char record_status[2];
204 char implementation_codes[5];
205 int indicator_length;
206 int identifier_length;
207 char user_systems[4];
209 int length_data_entry;
211 int length_implementation;
214 struct data1_marctab *next;
217 typedef struct data1_esetname
221 struct data1_esetname *next;
225 * Variant set definitions.
228 typedef struct data1_vartype
231 struct data1_varclass *zclass;
233 data1_datatype datatype;
234 struct data1_vartype *next;
237 typedef struct data1_varclass
240 struct data1_varset *set;
242 data1_vartype *types;
243 struct data1_varclass *next;
246 typedef struct data1_varset
250 data1_varclass *classes;
259 typedef struct data1_tag
262 #define DATA1T_numeric 1
263 #define DATA1T_string 2
272 struct data1_tagset *tagset;
273 struct data1_tag *next;
276 typedef struct data1_tagset
278 char *name; /* symbolic name */
280 int type; /* type of tagset in current context */
281 data1_tag *tags; /* tags defined by this set */
282 struct data1_tagset *children; /* included tagsets */
283 struct data1_tagset *next; /* sibling */
286 typedef struct data1_termlist
289 data1_structure structure;
290 struct data1_termlist *next;
294 * abstract syntax specification
297 typedef struct data1_element
301 data1_termlist *termlists;
302 struct data1_element *parent;
303 struct data1_element *children;
304 struct data1_element *next;
307 typedef struct data1_absyn
311 data1_tagset *tagset;
312 data1_attset *attset;
313 data1_varset *varset;
314 data1_esetname *esetnames;
315 data1_maptab *maptabs;
317 data1_element *elements;
321 * record data node (tag/data/variant)
324 typedef struct data1_node
326 /* the root of a record (containing global data) */
327 #define DATA1N_root 1
330 /* some data under a leaf tag or variant */
331 #define DATA1N_data 3
332 /* variant specification (a triple, actually) */
333 #define DATA1N_variant 4
341 data1_absyn *absyn; /* abstract syntax for this type */
347 data1_element *element;
349 int make_variantlist;
350 int no_data_requested;
357 #define DATA1I_inctxt 1
358 /* binary data inclusion */
359 #define DATA1I_incbin 2
361 #define DATA1I_text 3
364 /* object identifier */
367 int formatted_text; /* newlines are significant */
369 char *data; /* filename or data */
370 #define DATA1_LOCALDATA 40
371 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
386 void (*destroy)(struct data1_node *n);
387 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
390 struct data1_node *next;
391 struct data1_node *child;
392 struct data1_node *last_child;
393 struct data1_node *parent;
394 struct data1_node *root;
397 YAZ_EXPORT data1_handle data1_create (void);
398 YAZ_EXPORT void data1_destroy(data1_handle dh);
399 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
400 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, char **buf,
402 int *line, data1_absyn *absyn, NMEM m);
403 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
404 int (*rf)(void *, char *, size_t),
406 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
407 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
408 int type, int value);
409 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
410 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
412 data1_element *parent,
414 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
417 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
419 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
420 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
421 int select, int *len);
422 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
425 char *tagname, NMEM m);
426 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
427 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
428 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
430 char *zclass, char *type);
431 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file,
433 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
434 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
435 data1_absyn *a, char *name);
436 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
439 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
440 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, char *name);
441 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
442 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
443 data1_maptab *map, NMEM m);
444 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
446 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
447 data1_node *n, int selected, int *len);
448 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
449 int select, int *len);
450 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
451 data1_node *n, int select,
453 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
454 data1_node *n, int select,
456 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
458 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
459 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
461 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
462 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
463 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
464 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);