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.36 1998-05-18 13:06:57 adam
28 * Changed the way attribute sets are handled by the retriaval module.
29 * Extended Explain conversion / schema.
30 * Modified server and client to work with ASN.1 compiled protocol handlers.
32 * Revision 1.35 1998/03/05 08:15:32 adam
33 * Implemented data1_add_insert_taggeddata utility which is more flexible
34 * than data1_insert_taggeddata.
36 * Revision 1.34 1998/02/27 14:08:04 adam
37 * Added const to some char pointer arguments.
38 * Reworked data1_read_node so that it doesn't create a tree with
39 * pointers to original "SGML"-buffer.
41 * Revision 1.33 1997/12/18 10:51:30 adam
42 * Implemented sub-trees feature for schemas - including forward
45 * Revision 1.32 1997/12/09 16:18:16 adam
46 * Work on EXPLAIN schema. First implementation of sub-schema facility
49 * Revision 1.31 1997/11/18 09:51:08 adam
50 * Removed element num_children from data1_node. Minor changes in
53 * Revision 1.30 1997/10/31 12:20:07 adam
54 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
55 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
56 * Bug fix: missing fclose in data1_read_espec1.
58 * Revision 1.29 1997/10/27 13:54:18 adam
59 * Changed structure field in data1 node to be simple string which
60 * is "unknown" to the retrieval system itself.
62 * Revision 1.28 1997/10/06 09:37:53 adam
63 * Added prototype for data1_get_map_buf.
65 * Revision 1.27 1997/09/24 13:35:44 adam
66 * Added two members to data1_marctab to ease reading of weird MARC records.
68 * Revision 1.26 1997/09/17 12:10:32 adam
71 * Revision 1.25 1997/09/05 09:50:55 adam
72 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
74 * Revision 1.24 1997/09/01 09:30:39 adam
75 * Added include of yaz-util.h.
77 * Revision 1.23 1997/09/01 08:58:04 adam
78 * Removed declaration of data1_matchstr since it's a macro.
80 * Revision 1.22 1997/09/01 08:49:48 adam
81 * New windows NT/95 port using MSV5.0. To export DLL functions the
82 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
84 * Revision 1.21 1997/05/14 06:53:38 adam
87 * Revision 1.20 1996/10/29 13:34:39 adam
88 * New functions to get/set data1_tabpath.
90 * Revision 1.19 1996/10/11 11:57:16 quinn
93 * Revision 1.18 1996/10/07 15:29:16 quinn
96 * Revision 1.17 1996/07/06 19:58:32 quinn
97 * System headerfiles gathered in yconfig
99 * Revision 1.16 1996/06/10 08:55:34 quinn
100 * Added Summary. Unfinished work
102 * Revision 1.15 1996/06/03 09:46:03 quinn
105 * Revision 1.14 1996/05/09 07:27:11 quinn
106 * Multiple local values supported.
108 * Revision 1.13 1996/02/20 16:32:48 quinn
111 * Revision 1.12 1996/01/18 09:46:34 adam
112 * Changed prototype for reader function parsed to data1_read_record.
114 * Revision 1.11 1995/12/15 16:19:45 quinn
115 * Added formatted_text.
117 * Revision 1.10 1995/12/14 11:09:43 quinn
120 * Revision 1.9 1995/12/13 15:32:47 quinn
123 * Revision 1.8 1995/12/13 13:44:23 quinn
124 * Modified Data1-system to use nmem
126 * Revision 1.7 1995/12/12 16:37:05 quinn
127 * Added destroy element to data1_node.
129 * Revision 1.6 1995/12/11 15:22:12 quinn
130 * Added last_child field to the node.
132 * Revision 1.5 1995/12/05 14:26:40 quinn
133 * Added global lbuf to data1_node.
135 * Revision 1.4 1995/11/13 09:27:29 quinn
136 * Fiddling with the variant stuff.
138 * Revision 1.3 1995/11/01 16:34:52 quinn
139 * Making data1 look for tables in data1_tabpath
141 * Revision 1.2 1995/11/01 13:54:35 quinn
144 * Revision 1.1 1995/11/01 13:07:18 quinn
145 * Data1 module now lives in YAZ.
147 * Revision 1.13 1995/10/25 16:00:49 quinn
148 * USMARC support is now almost operational
150 * Revision 1.12 1995/10/16 14:02:59 quinn
151 * Changes to support element set names and espec1
153 * Revision 1.11 1995/10/13 16:05:10 quinn
154 * Adding Espec1-processing
156 * Revision 1.10 1995/10/11 14:53:46 quinn
159 * Revision 1.9 1995/10/10 16:27:59 quinn
160 * *** empty log message ***
162 * Revision 1.8 1995/10/06 16:44:14 quinn
163 * Work on attribute set mapping, etc.
165 * Revision 1.7 1995/10/06 12:58:36 quinn
168 * Revision 1.6 1995/10/04 09:29:51 quinn
169 * Adjustments to support USGS test data
171 * Revision 1.5 1995/10/03 17:56:44 quinn
174 * Revision 1.4 1995/10/02 14:55:43 quinn
175 * *** empty log message ***
177 * Revision 1.3 1995/09/15 14:41:43 quinn
180 * Revision 1.2 1995/09/14 15:18:14 quinn
183 * Revision 1.1 1995/09/12 11:24:33 quinn
184 * Beginning to add code for structured records.
198 #include <d1_attset.h>
200 #include <yaz-util.h>
207 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
209 #define DATA1_MAX_SYMBOL 31
211 typedef struct data1_name
214 struct data1_name *next;
217 typedef struct data1_absyn_cache_info *data1_absyn_cache;
218 typedef struct data1_attset_cache_info *data1_attset_cache;
220 typedef enum data1_datatype
222 DATA1K_structured = 1,
227 DATA1K_generalizedtime,
234 typedef struct data1_marctab
239 char record_status[2];
240 char implementation_codes[5];
241 int indicator_length;
242 int identifier_length;
243 char user_systems[4];
245 int length_data_entry;
247 int length_implementation;
250 int force_indicator_length;
251 int force_identifier_length;
252 struct data1_marctab *next;
255 typedef struct data1_esetname
259 struct data1_esetname *next;
263 * Variant set definitions.
266 typedef struct data1_vartype
269 struct data1_varclass *zclass;
271 data1_datatype datatype;
272 struct data1_vartype *next;
275 typedef struct data1_varclass
278 struct data1_varset *set;
280 data1_vartype *types;
281 struct data1_varclass *next;
284 typedef struct data1_varset
288 data1_varclass *classes;
297 typedef struct data1_tag
300 #define DATA1T_numeric 1
301 #define DATA1T_string 2
310 struct data1_tagset *tagset;
311 struct data1_tag *next;
314 typedef struct data1_tagset
316 char *name; /* symbolic name */
318 int type; /* type of tagset in current context */
319 data1_tag *tags; /* tags defined by this set */
320 struct data1_tagset *children; /* included tagsets */
321 struct data1_tagset *next; /* sibling */
324 typedef struct data1_termlist
328 struct data1_termlist *next;
332 * abstract syntax specification
335 typedef struct data1_element
339 data1_termlist *termlists;
341 struct data1_element *children;
342 struct data1_element *next;
345 typedef struct data1_sub_elements {
347 struct data1_sub_elements *next;
348 data1_element *elements;
349 } data1_sub_elements;
351 typedef struct data1_absyn
355 data1_tagset *tagset;
356 data1_attset *attset;
357 data1_varset *varset;
358 data1_esetname *esetnames;
359 data1_maptab *maptabs;
361 data1_sub_elements *sub_elements;
362 data1_element *main_elements;
366 * record data node (tag/data/variant)
369 typedef struct data1_node
371 /* the root of a record (containing global data) */
372 #define DATA1N_root 1
375 /* some data under a leaf tag or variant */
376 #define DATA1N_data 3
377 /* variant specification (a triple, actually) */
378 #define DATA1N_variant 4
386 data1_absyn *absyn; /* abstract syntax for this type */
392 data1_element *element;
394 int make_variantlist;
395 int no_data_requested;
402 #define DATA1I_inctxt 1
403 /* binary data inclusion */
404 #define DATA1I_incbin 2
406 #define DATA1I_text 3
409 /* object identifier */
412 int formatted_text; /* newlines are significant */
414 char *data; /* filename or data */
424 void (*destroy)(struct data1_node *n);
425 #define DATA1_LOCALDATA 40
426 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
428 struct data1_node *next;
429 struct data1_node *child;
430 struct data1_node *last_child;
431 struct data1_node *parent;
432 struct data1_node *root;
435 YAZ_EXPORT data1_handle data1_create (void);
436 YAZ_EXPORT void data1_destroy(data1_handle dh);
437 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
438 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
440 int *line, data1_absyn *absyn, NMEM m);
441 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
442 int (*rf)(void *, char *, size_t),
444 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
445 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh, data1_tagset *s,
446 int type, int value);
447 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, char *file);
448 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
450 data1_element *parent,
451 const char *tagname);
452 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
455 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
457 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
458 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
459 int select, int *len);
460 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
463 const char *tagname, NMEM m);
464 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
466 const char *tagname, NMEM m);
467 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
468 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
469 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
471 char *zclass, char *type);
472 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
473 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
474 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
477 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
480 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
481 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
482 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
483 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
484 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
485 data1_maptab *map, NMEM m);
486 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
488 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
489 data1_node *n, int selected, int *len);
490 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
491 int select, int *len);
492 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
493 data1_node *n, int select,
495 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
496 data1_node *n, int select,
498 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
500 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
501 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
503 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
504 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
505 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
506 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
507 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
508 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
509 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
510 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
511 NMEM m, const char *str);
512 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
514 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
515 void (*fh)(data1_handle dh,
516 void *h, data1_absyn *a));
518 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
520 YAZ_EXPORT data1_node
521 *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
522 data1_node *at, const char *tagname, NMEM m,
523 int first_flag, int local_allowed);