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