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.42 1999-10-21 12:06:28 adam
28 * Retrieval module no longer uses ctype.h - functions.
30 * Revision 1.41 1999/07/13 13:23:47 adam
31 * Non-recursive version of data1_read_node. data1_read_nodex reads
32 * stream of bytes (instead of buffer in memory).
34 * Revision 1.40 1998/11/03 10:14:12 adam
35 * Changed definition of data1 node so that it uses less space.
37 * Revision 1.39 1998/10/28 15:10:06 adam
38 * Added --with-yc option to configure. For the data1_node in data1.h:
39 * decreased size of localdata and removed member "line" which wasn't useful.
41 * Revision 1.38 1998/10/15 08:29:15 adam
42 * Tag set type may be specified in reference to it using "tagset"
43 * directive in .abs-files and "include" directive in .tag-files.
45 * Revision 1.37 1998/10/13 16:09:46 adam
46 * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
47 * Added support for multiple attribute set references and tagset references
48 * from an abstract syntax file.
49 * Fixed many bad logs-calls in routines that read the various
50 * specifications regarding data1 (*.abs,*.att,...) and made the messages
51 * consistent whenever possible.
52 * Added extra 'lineno' argument to function readconf_line.
54 * Revision 1.36 1998/05/18 13:06:57 adam
55 * Changed the way attribute sets are handled by the retriaval module.
56 * Extended Explain conversion / schema.
57 * Modified server and client to work with ASN.1 compiled protocol handlers.
59 * Revision 1.35 1998/03/05 08:15:32 adam
60 * Implemented data1_add_insert_taggeddata utility which is more flexible
61 * than data1_insert_taggeddata.
63 * Revision 1.34 1998/02/27 14:08:04 adam
64 * Added const to some char pointer arguments.
65 * Reworked data1_read_node so that it doesn't create a tree with
66 * pointers to original "SGML"-buffer.
68 * Revision 1.33 1997/12/18 10:51:30 adam
69 * Implemented sub-trees feature for schemas - including forward
72 * Revision 1.32 1997/12/09 16:18:16 adam
73 * Work on EXPLAIN schema. First implementation of sub-schema facility
76 * Revision 1.31 1997/11/18 09:51:08 adam
77 * Removed element num_children from data1_node. Minor changes in
80 * Revision 1.30 1997/10/31 12:20:07 adam
81 * Improved memory debugging for xmalloc/nmem.c. References to NMEM
82 * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
83 * Bug fix: missing fclose in data1_read_espec1.
85 * Revision 1.29 1997/10/27 13:54:18 adam
86 * Changed structure field in data1 node to be simple string which
87 * is "unknown" to the retrieval system itself.
89 * Revision 1.28 1997/10/06 09:37:53 adam
90 * Added prototype for data1_get_map_buf.
92 * Revision 1.27 1997/09/24 13:35:44 adam
93 * Added two members to data1_marctab to ease reading of weird MARC records.
95 * Revision 1.26 1997/09/17 12:10:32 adam
98 * Revision 1.25 1997/09/05 09:50:55 adam
99 * Removed global data1_tabpath - uses data1_get_tabpath() instead.
101 * Revision 1.24 1997/09/01 09:30:39 adam
102 * Added include of yaz-util.h.
104 * Revision 1.23 1997/09/01 08:58:04 adam
105 * Removed declaration of data1_matchstr since it's a macro.
107 * Revision 1.22 1997/09/01 08:49:48 adam
108 * New windows NT/95 port using MSV5.0. To export DLL functions the
109 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
111 * Revision 1.21 1997/05/14 06:53:38 adam
114 * Revision 1.20 1996/10/29 13:34:39 adam
115 * New functions to get/set data1_tabpath.
117 * Revision 1.19 1996/10/11 11:57:16 quinn
120 * Revision 1.18 1996/10/07 15:29:16 quinn
123 * Revision 1.17 1996/07/06 19:58:32 quinn
124 * System headerfiles gathered in yconfig
126 * Revision 1.16 1996/06/10 08:55:34 quinn
127 * Added Summary. Unfinished work
129 * Revision 1.15 1996/06/03 09:46:03 quinn
132 * Revision 1.14 1996/05/09 07:27:11 quinn
133 * Multiple local values supported.
135 * Revision 1.13 1996/02/20 16:32:48 quinn
138 * Revision 1.12 1996/01/18 09:46:34 adam
139 * Changed prototype for reader function parsed to data1_read_record.
141 * Revision 1.11 1995/12/15 16:19:45 quinn
142 * Added formatted_text.
144 * Revision 1.10 1995/12/14 11:09:43 quinn
147 * Revision 1.9 1995/12/13 15:32:47 quinn
150 * Revision 1.8 1995/12/13 13:44:23 quinn
151 * Modified Data1-system to use nmem
153 * Revision 1.7 1995/12/12 16:37:05 quinn
154 * Added destroy element to data1_node.
156 * Revision 1.6 1995/12/11 15:22:12 quinn
157 * Added last_child field to the node.
159 * Revision 1.5 1995/12/05 14:26:40 quinn
160 * Added global lbuf to data1_node.
162 * Revision 1.4 1995/11/13 09:27:29 quinn
163 * Fiddling with the variant stuff.
165 * Revision 1.3 1995/11/01 16:34:52 quinn
166 * Making data1 look for tables in data1_tabpath
168 * Revision 1.2 1995/11/01 13:54:35 quinn
171 * Revision 1.1 1995/11/01 13:07:18 quinn
172 * Data1 module now lives in YAZ.
174 * Revision 1.13 1995/10/25 16:00:49 quinn
175 * USMARC support is now almost operational
177 * Revision 1.12 1995/10/16 14:02:59 quinn
178 * Changes to support element set names and espec1
180 * Revision 1.11 1995/10/13 16:05:10 quinn
181 * Adding Espec1-processing
183 * Revision 1.10 1995/10/11 14:53:46 quinn
186 * Revision 1.9 1995/10/10 16:27:59 quinn
187 * *** empty log message ***
189 * Revision 1.8 1995/10/06 16:44:14 quinn
190 * Work on attribute set mapping, etc.
192 * Revision 1.7 1995/10/06 12:58:36 quinn
195 * Revision 1.6 1995/10/04 09:29:51 quinn
196 * Adjustments to support USGS test data
198 * Revision 1.5 1995/10/03 17:56:44 quinn
201 * Revision 1.4 1995/10/02 14:55:43 quinn
202 * *** empty log message ***
204 * Revision 1.3 1995/09/15 14:41:43 quinn
207 * Revision 1.2 1995/09/14 15:18:14 quinn
210 * Revision 1.1 1995/09/12 11:24:33 quinn
211 * Beginning to add code for structured records.
225 #include <d1_attset.h>
227 #include <yaz-util.h>
230 #define d1_isspace(c) strchr(" \r\n\t\f", c)
231 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
236 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
238 #define DATA1_MAX_SYMBOL 31
240 typedef struct data1_name
243 struct data1_name *next;
246 typedef struct data1_absyn_cache_info *data1_absyn_cache;
247 typedef struct data1_attset_cache_info *data1_attset_cache;
249 typedef enum data1_datatype
257 DATA1K_generalizedtime,
264 typedef struct data1_marctab
269 char record_status[2];
270 char implementation_codes[5];
271 int indicator_length;
272 int identifier_length;
273 char user_systems[4];
275 int length_data_entry;
277 int length_implementation;
280 int force_indicator_length;
281 int force_identifier_length;
282 struct data1_marctab *next;
285 typedef struct data1_esetname
289 struct data1_esetname *next;
293 * Variant set definitions.
296 typedef struct data1_vartype
299 struct data1_varclass *zclass;
301 data1_datatype datatype;
302 struct data1_vartype *next;
305 typedef struct data1_varclass
308 struct data1_varset *set;
310 data1_vartype *types;
311 struct data1_varclass *next;
314 typedef struct data1_varset
318 data1_varclass *classes;
327 typedef struct data1_tag
330 #define DATA1T_numeric 1
331 #define DATA1T_string 2
340 struct data1_tagset *tagset;
341 struct data1_tag *next;
344 typedef struct data1_tagset data1_tagset;
348 int type; /* type of tagset in current context */
349 char *name; /* symbolic name */
351 data1_tag *tags; /* tags defined by this set */
352 data1_tagset *children; /* children */
353 data1_tagset *next; /* sibling */
356 typedef struct data1_termlist
360 struct data1_termlist *next;
364 * abstract syntax specification
367 typedef struct data1_element
371 data1_termlist *termlists;
373 struct data1_element *children;
374 struct data1_element *next;
377 typedef struct data1_sub_elements {
379 struct data1_sub_elements *next;
380 data1_element *elements;
381 } data1_sub_elements;
383 typedef struct data1_absyn
387 data1_tagset *tagset;
388 data1_attset *attset;
389 data1_varset *varset;
390 data1_esetname *esetnames;
391 data1_maptab *maptabs;
393 data1_sub_elements *sub_elements;
394 data1_element *main_elements;
398 * record data node (tag/data/variant)
401 typedef struct data1_node
403 /* the root of a record (containing global data) */
404 #define DATA1N_root 1
407 /* some data under a leaf tag or variant */
408 #define DATA1N_data 3
409 /* variant specification (a triple, actually) */
410 #define DATA1N_variant 4
418 data1_absyn *absyn; /* abstract syntax for this type */
424 data1_element *element;
425 int no_data_requested;
427 unsigned node_selected : 1;
428 unsigned make_variantlist : 1;
433 char *data; /* filename or data */
436 #define DATA1I_inctxt 1
437 /* binary data inclusion */
438 #define DATA1I_incbin 2
440 #define DATA1I_text 3
443 /* object identifier */
446 unsigned formatted_text : 1; /* newlines are significant */
456 void (*destroy)(struct data1_node *n);
457 #define DATA1_LOCALDATA 12
458 char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
459 struct data1_node *next;
460 struct data1_node *child;
461 struct data1_node *last_child;
462 struct data1_node *parent;
463 struct data1_node *root;
466 YAZ_EXPORT data1_handle data1_create (void);
467 YAZ_EXPORT void data1_destroy(data1_handle dh);
468 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
469 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
471 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
472 int (*get_byte)(void *fh), void *fh,
474 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh,
475 int (*rf)(void *, char *, size_t),
477 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
478 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
480 int type, int value);
481 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
482 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh,
485 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh,
487 data1_element *parent,
488 const char *tagname);
489 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
492 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
494 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
495 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
496 int select, int *len);
497 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
500 const char *tagname, NMEM m);
501 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
503 const char *tagname, NMEM m);
504 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
505 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
506 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
508 char *zclass, char *type);
509 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
510 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
511 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh,
514 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
517 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
518 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
519 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
520 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
521 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
522 data1_maptab *map, NMEM m);
523 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
525 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
526 data1_node *n, int selected, int *len);
527 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
528 int select, int *len);
529 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
530 data1_node *n, int select,
532 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh,
533 data1_node *n, int select,
535 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
537 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
538 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
540 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
541 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
542 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
543 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
544 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
545 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
546 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
547 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
548 NMEM m, const char *str);
549 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
551 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
552 void (*fh)(data1_handle dh,
553 void *h, data1_absyn *a));
555 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
557 YAZ_EXPORT data1_node
558 *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
559 data1_node *at, const char *tagname, NMEM m,
560 int first_flag, int local_allowed);