Added termlist source for data1 system.
[yaz-moved-to-github.git] / include / yaz / data1.h
1 /*
2  * Copyright (c) 1995-2000, Index Data.
3  *
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,
6  * provided that:
7  *
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.
11  *
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.
15  *
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
24  * OF THIS SOFTWARE.
25  *
26  * $Log: data1.h,v $
27  * Revision 1.6  2000-12-05 12:21:45  adam
28  * Added termlist source for data1 system.
29  *
30  * Revision 1.5  2000/11/29 14:22:47  adam
31  * Implemented XML/SGML attributes for data1 so that d1_read reads them
32  * and d1_write generates proper attributes for XML/SGML records. Added
33  * register locking for threaded version.
34  *
35  * Revision 1.4  2000/02/28 11:20:06  adam
36  * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
37  *
38  * Revision 1.3  2000/01/04 17:46:17  ian
39  * Added function to count occurences of a tag spec in a data1 tree.
40  *
41  * Revision 1.2  1999/12/21 14:16:19  ian
42  * Changed retrieval module to allow data1 trees with no associated absyn.
43  * Also added a simple interface for extracting values from data1 trees using
44  * a string based tagpath.
45  *
46  * Revision 1.1  1999/11/30 13:47:11  adam
47  * Improved installation. Moved header files to include/yaz.
48  *
49  * Revision 1.42  1999/10/21 12:06:28  adam
50  * Retrieval module no longer uses ctype.h - functions.
51  *
52  * Revision 1.41  1999/07/13 13:23:47  adam
53  * Non-recursive version of data1_read_node. data1_read_nodex reads
54  * stream of bytes (instead of buffer in memory).
55  *
56  * Revision 1.40  1998/11/03 10:14:12  adam
57  * Changed definition of data1 node so that it uses less space.
58  *
59  * Revision 1.39  1998/10/28 15:10:06  adam
60  * Added --with-yc option to configure. For the data1_node in data1.h:
61  * decreased size of localdata and removed member "line" which wasn't useful.
62  *
63  * Revision 1.38  1998/10/15 08:29:15  adam
64  * Tag set type may be specified in reference to it using "tagset"
65  * directive in .abs-files and "include" directive in .tag-files.
66  *
67  * Revision 1.37  1998/10/13 16:09:46  adam
68  * Added support for arbitrary OID's for tagsets, schemas and attribute sets.
69  * Added support for multiple attribute set references and tagset references
70  * from an abstract syntax file.
71  * Fixed many bad logs-calls in routines that read the various
72  * specifications regarding data1 (*.abs,*.att,...) and made the messages
73  * consistent whenever possible.
74  * Added extra 'lineno' argument to function readconf_line.
75  *
76  * Revision 1.36  1998/05/18 13:06:57  adam
77  * Changed the way attribute sets are handled by the retriaval module.
78  * Extended Explain conversion / schema.
79  * Modified server and client to work with ASN.1 compiled protocol handlers.
80  *
81  * Revision 1.35  1998/03/05 08:15:32  adam
82  * Implemented data1_add_insert_taggeddata utility which is more flexible
83  * than data1_insert_taggeddata.
84  *
85  * Revision 1.34  1998/02/27 14:08:04  adam
86  * Added const to some char pointer arguments.
87  * Reworked data1_read_node so that it doesn't create a tree with
88  * pointers to original "SGML"-buffer.
89  *
90  * Revision 1.33  1997/12/18 10:51:30  adam
91  * Implemented sub-trees feature for schemas - including forward
92  * references.
93  *
94  * Revision 1.32  1997/12/09 16:18:16  adam
95  * Work on EXPLAIN schema. First implementation of sub-schema facility
96  * in the *.abs files.
97  *
98  * Revision 1.31  1997/11/18 09:51:08  adam
99  * Removed element num_children from data1_node. Minor changes in
100  * data1 to Explain.
101  *
102  * Revision 1.30  1997/10/31 12:20:07  adam
103  * Improved memory debugging for xmalloc/nmem.c. References to NMEM
104  * instead of ODR in n ESPEC-1 handling in source d1_espec.c.
105  * Bug fix: missing fclose in data1_read_espec1.
106  *
107  * Revision 1.29  1997/10/27 13:54:18  adam
108  * Changed structure field in data1 node to be simple string which
109  * is "unknown" to the retrieval system itself.
110  *
111  * Revision 1.28  1997/10/06 09:37:53  adam
112  * Added prototype for data1_get_map_buf.
113  *
114  * Revision 1.27  1997/09/24 13:35:44  adam
115  * Added two members to data1_marctab to ease reading of weird MARC records.
116  *
117  * Revision 1.26  1997/09/17 12:10:32  adam
118  * YAZ version 1.4.
119  *
120  * Revision 1.25  1997/09/05 09:50:55  adam
121  * Removed global data1_tabpath - uses data1_get_tabpath() instead.
122  *
123  * Revision 1.24  1997/09/01 09:30:39  adam
124  * Added include of yaz-util.h.
125  *
126  * Revision 1.23  1997/09/01 08:58:04  adam
127  * Removed declaration of data1_matchstr since it's a macro.
128  *
129  * Revision 1.22  1997/09/01 08:49:48  adam
130  * New windows NT/95 port using MSV5.0. To export DLL functions the
131  * YAZ_EXPORT modifier was added. Defined in yconfig.h.
132  *
133  * Revision 1.21  1997/05/14 06:53:38  adam
134  * C++ support.
135  *
136  * Revision 1.20  1996/10/29 13:34:39  adam
137  * New functions to get/set data1_tabpath.
138  *
139  * Revision 1.19  1996/10/11 11:57:16  quinn
140  * Smallish
141  *
142  * Revision 1.18  1996/10/07  15:29:16  quinn
143  * Added SOIF support
144  *
145  * Revision 1.17  1996/07/06  19:58:32  quinn
146  * System headerfiles gathered in yconfig
147  *
148  * Revision 1.16  1996/06/10  08:55:34  quinn
149  * Added Summary. Unfinished work
150  *
151  * Revision 1.15  1996/06/03  09:46:03  quinn
152  * Added OID type.
153  *
154  * Revision 1.14  1996/05/09  07:27:11  quinn
155  * Multiple local values supported.
156  *
157  * Revision 1.13  1996/02/20  16:32:48  quinn
158  * Created util file.
159  *
160  * Revision 1.12  1996/01/18  09:46:34  adam
161  * Changed prototype for reader function parsed to data1_read_record.
162  *
163  * Revision 1.11  1995/12/15  16:19:45  quinn
164  * Added formatted_text.
165  *
166  * Revision 1.10  1995/12/14  11:09:43  quinn
167  * Work on Explain
168  *
169  * Revision 1.9  1995/12/13  15:32:47  quinn
170  * Added sgml-output.
171  *
172  * Revision 1.8  1995/12/13  13:44:23  quinn
173  * Modified Data1-system to use nmem
174  *
175  * Revision 1.7  1995/12/12  16:37:05  quinn
176  * Added destroy element to data1_node.
177  *
178  * Revision 1.6  1995/12/11  15:22:12  quinn
179  * Added last_child field to the node.
180  *
181  * Revision 1.5  1995/12/05  14:26:40  quinn
182  * Added global lbuf to data1_node.
183  *
184  * Revision 1.4  1995/11/13  09:27:29  quinn
185  * Fiddling with the variant stuff.
186  *
187  * Revision 1.3  1995/11/01  16:34:52  quinn
188  * Making data1 look for tables in data1_tabpath
189  *
190  * Revision 1.2  1995/11/01  13:54:35  quinn
191  * Minor adjustments
192  *
193  * Revision 1.1  1995/11/01  13:07:18  quinn
194  * Data1 module now lives in YAZ.
195  *
196  * Revision 1.13  1995/10/25  16:00:49  quinn
197  * USMARC support is now almost operational
198  *
199  * Revision 1.12  1995/10/16  14:02:59  quinn
200  * Changes to support element set names and espec1
201  *
202  * Revision 1.11  1995/10/13  16:05:10  quinn
203  * Adding Espec1-processing
204  *
205  * Revision 1.10  1995/10/11  14:53:46  quinn
206  * Work on variants.
207  *
208  * Revision 1.9  1995/10/10  16:27:59  quinn
209  * *** empty log message ***
210  *
211  * Revision 1.8  1995/10/06  16:44:14  quinn
212  * Work on attribute set mapping, etc.
213  *
214  * Revision 1.7  1995/10/06  12:58:36  quinn
215  * SUTRS support
216  *
217  * Revision 1.6  1995/10/04  09:29:51  quinn
218  * Adjustments to support USGS test data
219  *
220  * Revision 1.5  1995/10/03  17:56:44  quinn
221  * Fixing GRS code.
222  *
223  * Revision 1.4  1995/10/02  14:55:43  quinn
224  * *** empty log message ***
225  *
226  * Revision 1.3  1995/09/15  14:41:43  quinn
227  * GRS1 work
228  *
229  * Revision 1.2  1995/09/14  15:18:14  quinn
230  * Work
231  *
232  * Revision 1.1  1995/09/12  11:24:33  quinn
233  * Beginning to add code for structured records.
234  *
235  *
236  */
237
238 #ifndef DATA1_H
239 #define DATA1_H
240
241 #include <stdio.h>
242
243 #include <yaz/nmem.h>
244 #include <yaz/oid.h>
245 #include <yaz/proto.h>
246
247 #include <yaz/d1_attset.h>
248 #include <yaz/d1_map.h>
249 #include <yaz/yaz-util.h>
250 #include <yaz/wrbuf.h>
251
252 #define d1_isspace(c) strchr(" \r\n\t\f", c)
253 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
254
255 #define DATA1_USING_XATTR 1
256
257 YAZ_BEGIN_CDECL
258
259 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
260
261 #define DATA1_MAX_SYMBOL 31
262
263 typedef struct data1_name
264 {
265     char *name;
266     struct data1_name *next;
267 } data1_name;
268
269 typedef struct data1_absyn_cache_info *data1_absyn_cache;
270 typedef struct data1_attset_cache_info *data1_attset_cache;
271
272 typedef enum data1_datatype
273 {
274     DATA1K_unknown,
275     DATA1K_structured,
276     DATA1K_string,
277     DATA1K_numeric,
278     DATA1K_bool,
279     DATA1K_oid,
280     DATA1K_generalizedtime,
281     DATA1K_intunit,
282     DATA1K_int,
283     DATA1K_octetstring,
284     DATA1K_null
285 } data1_datatype;
286
287 typedef struct data1_marctab
288 {
289     char *name;
290     oid_value reference;
291
292     char record_status[2];
293     char implementation_codes[5];
294     int  indicator_length;
295     int  identifier_length;
296     char user_systems[4];
297
298     int  length_data_entry;
299     int  length_starting;
300     int  length_implementation;
301     char future_use[2];
302
303     int  force_indicator_length;
304     int  force_identifier_length;
305     struct data1_marctab *next;
306 } data1_marctab;
307
308 typedef struct data1_esetname
309 {
310     char *name;
311     Z_Espec1 *spec;
312     struct data1_esetname *next;
313 } data1_esetname;
314
315 /*
316  * Variant set definitions.
317  */
318
319 typedef struct data1_vartype
320 {
321     char *name;
322     struct data1_varclass *zclass;
323     int type;
324     data1_datatype datatype;
325     struct data1_vartype *next;
326 } data1_vartype;
327
328 typedef struct data1_varclass
329 {
330     char *name;
331     struct data1_varset *set;
332     int zclass;
333     data1_vartype *types;
334     struct data1_varclass *next;
335 } data1_varclass;
336
337 typedef struct data1_varset
338 {
339     char *name;
340     oid_value reference;
341     data1_varclass *classes;
342 } data1_varset;
343
344 /*
345  * Tagset definitions
346  */
347
348 struct data1_tagset;
349
350 typedef struct data1_tag
351 {
352     data1_name *names;
353 #define DATA1T_numeric 1
354 #define DATA1T_string 2
355     int which;
356     union
357     {
358         int numeric;
359         char *string;
360     } value;
361     data1_datatype kind;
362
363     struct data1_tagset *tagset;
364     struct data1_tag *next;
365 } data1_tag;
366
367 typedef struct data1_tagset data1_tagset;
368
369 struct data1_tagset
370 {
371     int type;                        /* type of tagset in current context */
372     char *name;                      /* symbolic name */
373     oid_value reference;
374     data1_tag *tags;                 /* tags defined by this set */
375     data1_tagset *children;          /* children */
376     data1_tagset *next;              /* sibling */
377 };
378
379 typedef struct data1_termlist
380 {
381     data1_att *att;
382     char *structure;
383     char *source;
384     struct data1_termlist *next;
385 } data1_termlist;
386
387 /*
388  * abstract syntax specification
389  */
390
391 typedef struct data1_element
392 {
393     char *name;
394     data1_tag *tag;
395     data1_termlist *termlists;
396     char *sub_name;
397     struct data1_element *children;
398     struct data1_element *next;
399 } data1_element;
400
401 typedef struct data1_sub_elements {
402     char *name;
403     struct data1_sub_elements *next;
404     data1_element *elements;
405 } data1_sub_elements;
406
407 #if DATA1_USING_XATTR
408 typedef struct data1_xattr {
409     char *name;
410     char *value;
411     struct data1_xattr *next;
412 } data1_xattr;
413 #endif
414
415 typedef struct data1_absyn
416 {
417     char *name;
418     oid_value reference;
419     data1_tagset *tagset;
420     data1_attset *attset;
421     data1_varset *varset;
422     data1_esetname *esetnames;
423     data1_maptab *maptabs;
424     data1_marctab *marc;
425     data1_sub_elements *sub_elements;
426     data1_element *main_elements;
427 } data1_absyn;
428
429 /*
430  * record data node (tag/data/variant)
431  */
432
433 typedef struct data1_node
434 {
435     /* the root of a record (containing global data) */
436 #define DATA1N_root 1 
437     /* a tag */
438 #define DATA1N_tag  2       
439     /* some data under a leaf tag or variant */
440 #define DATA1N_data 3
441     /* variant specification (a triple, actually) */
442 #define DATA1N_variant 4
443     int which;
444
445     union
446     {
447         struct
448         {
449             char *type;
450             data1_absyn *absyn;  /* abstract syntax for this type */
451         } root;
452
453         struct 
454         {
455             char *tag;
456             data1_element *element;
457             int no_data_requested;
458             int get_bytes;
459             unsigned node_selected : 1;
460             unsigned make_variantlist : 1;
461 #if DATA1_USING_XATTR
462             data1_xattr *attributes;
463 #endif
464         } tag;
465
466         struct
467         {
468             char *data;      /* filename or data */
469             int len;
470         /* text inclusion */
471 #define DATA1I_inctxt 1
472         /* binary data inclusion */
473 #define DATA1I_incbin 2
474         /* text data */
475 #define DATA1I_text 3 
476         /* numerical data */
477 #define DATA1I_num 4
478         /* object identifier */
479 #define DATA1I_oid 5         
480             unsigned what:7;
481             unsigned formatted_text : 1;   /* newlines are significant */
482         } data;
483
484         struct
485         {
486             data1_vartype *type;
487             char *value;
488         } variant;
489     } u;
490
491     void (*destroy)(struct data1_node *n);
492 #define DATA1_LOCALDATA 12
493     char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
494     struct data1_node *next;
495     struct data1_node *child;
496     struct data1_node *last_child;
497     struct data1_node *parent;
498     struct data1_node *root;
499 } data1_node;
500
501 YAZ_EXPORT data1_handle data1_create (void);
502 YAZ_EXPORT void data1_destroy(data1_handle dh);
503 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
504 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
505                                        NMEM m);
506 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
507                                          int (*get_byte)(void *fh), void *fh,
508                                          WRBUF wrbuf);
509 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh, 
510                                          int (*rf)(void *, char *, size_t),
511                                          void *fh, NMEM m);
512 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file);
513 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
514                                         data1_tagset *s,
515                                         int type, int value);
516 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
517 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, 
518                                            const char *file,
519                                            int type);
520 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh, 
521                                                     data1_absyn *abs,
522                                                     data1_element *parent,
523                                                     const char *tagname);
524 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
525                                            int select, ODR o,
526                                            int *len);
527 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
528                                          const char *name);
529 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
530 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
531                                  int select, int *len);
532 YAZ_EXPORT data1_node *data1_insert_taggeddata(data1_handle dh,
533                                                data1_node *root,
534                                                data1_node *at,
535                                                const char *tagname, NMEM m);
536 YAZ_EXPORT data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
537                                             data1_node *at,
538                                             const char *tagname, NMEM m);
539 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
540 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
541 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
542                                                data1_varset *set,
543                                                char *zclass, char *type);
544 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
545 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
546 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh, 
547                                                data1_absyn *a,
548                                                const char *name);
549 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
550                                                  data1_absyn *absyn,
551                                                  const char *name);
552 YAZ_EXPORT data1_node *data1_mk_node(data1_handle dh, NMEM m);
553 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
554 YAZ_EXPORT data1_absyn *data1_get_absyn(data1_handle dh, const char *name);
555 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
556 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
557 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
558                                         data1_maptab *map, NMEM m);
559 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
560                                               const char *file);
561 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
562                                   data1_node *n, int selected, int *len);
563 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
564                                     int select, int *len);
565 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
566                                                 data1_node *n, int select,
567                                                 ODR o);
568 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh, 
569                                            data1_node *n, int select,
570                                            ODR o);
571 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
572                                   int *len);
573 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
574 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
575
576 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
577 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
578 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
579 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
580 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
581 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
582 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
583 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
584                                       NMEM m, const char *str);
585 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
586                                         const char *buf);
587 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
588                                   void (*fh)(data1_handle dh,
589                                              void *h, data1_absyn *a));
590
591 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
592
593 YAZ_EXPORT data1_node 
594 *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
595                              data1_node *at, const char *tagname, NMEM m,
596                              int first_flag, int local_allowed);
597
598 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
599 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
600 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
601
602 YAZ_END_CDECL
603
604 #endif