Moved file locking utilities from index/lockutil.c to util/flock.c
[idzebra-moved-to-github.git] / include / idzebra / data1.h
1 /* $Id: data1.h,v 1.10 2005-06-23 06:45:46 adam Exp $
2    Copyright (C) 1995-2005
3    Index Data ApS
4
5 This file is part of the Zebra server.
6
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.
21 */
22
23 #ifndef DATA1_H
24 #define DATA1_H
25
26 #include <stdio.h>
27
28 #include <yaz/nmem.h>
29 #include <yaz/oid.h>
30 #include <yaz/proto.h>
31 #include <yaz/yaz-util.h>
32
33 #include <idzebra/util.h>
34
35 #define d1_isspace(c) strchr(" \r\n\t\f", c)
36 #define d1_isdigit(c) ((c) <= '9' && (c) >= '0')
37
38 YAZ_BEGIN_CDECL
39
40 #define data1_matchstr(s1, s2) yaz_matchstr(s1, s2)
41
42 #define DATA1_MAX_SYMBOL 31
43
44 /*
45  * This structure describes a attset, perhaps made up by inclusion
46  * (supersetting) of other attribute sets. When indexing and searching,
47  * we perform a normalisation, where we associate a given tag with
48  * the set that originally defined it, rather than the superset. This
49  * allows the most flexible access. Eg, the tags common to GILS and BIB-1
50  * should be searchable by both names.
51  */
52
53 struct data1_attset;
54
55 typedef struct data1_local_attribute
56 {
57     int local;
58     struct data1_local_attribute *next;
59 } data1_local_attribute;
60
61 typedef struct data1_attset data1_attset;    
62 typedef struct data1_att data1_att;
63 typedef struct data1_attset_child data1_attset_child;
64
65 struct data1_att
66 {
67     data1_attset *parent;          /* attribute set */
68     char *name;                    /* symbolic name of this attribute */
69     int value;                     /* attribute value */
70     data1_local_attribute *locals; /* local index values */
71     data1_att *next;
72 };
73
74 struct data1_attset_child {
75     data1_attset *child;
76     data1_attset_child *next;
77 };
78
79 struct data1_attset
80 {
81     char *name;          /* symbolic name */
82     oid_value reference;   /* external ID of attset */
83     data1_att *atts;          /* attributes */
84     data1_attset_child *children;  /* included attset */
85     data1_attset *next;       /* next in cache */
86 };
87
88 typedef struct data1_handle_info *data1_handle;
89
90 YAZ_EXPORT data1_att *data1_getattbyname(data1_handle dh, data1_attset *s,
91                                          char *name);
92 YAZ_EXPORT data1_attset *data1_read_attset(data1_handle dh, const char *file);
93
94 YAZ_EXPORT data1_attset *data1_empty_attset(data1_handle dh);
95
96 typedef struct data1_maptag
97 {
98     int new_field;
99     int type;
100 #define D1_MAPTAG_numeric 1
101 #define D1_MAPTAG_string 2
102     int which;
103     union
104     {
105         int numeric;
106         char *string;
107     } value;
108     struct data1_maptag *next;
109 } data1_maptag;
110
111 typedef struct data1_mapunit
112 {
113     int no_data;
114     char *source_element_name;
115     data1_maptag *target_path;
116     struct data1_mapunit *next;
117 } data1_mapunit;
118
119 typedef struct data1_maptab
120 {
121     char *name;
122     oid_value target_absyn_ref;
123     char *target_absyn_name;
124     data1_mapunit *map;
125     struct data1_maptab *next;
126 } data1_maptab;
127
128 typedef struct data1_name
129 {
130     char *name;
131     struct data1_name *next;
132 } data1_name;
133
134 typedef struct data1_absyn_cache_info *data1_absyn_cache;
135 typedef struct data1_attset_cache_info *data1_attset_cache;
136 typedef struct data1_absyn data1_absyn;
137
138 typedef enum data1_datatype
139 {
140     DATA1K_unknown,
141     DATA1K_structured,
142     DATA1K_string,
143     DATA1K_numeric,
144     DATA1K_bool,
145     DATA1K_oid,
146     DATA1K_generalizedtime,
147     DATA1K_intunit,
148     DATA1K_int,
149     DATA1K_octetstring,
150     DATA1K_null
151 } data1_datatype;
152
153 typedef struct data1_marctab
154 {
155     char *name;
156     oid_value reference;
157
158     char record_status[2];
159     char implementation_codes[5];
160     int  indicator_length;
161     int  identifier_length;
162     char user_systems[4];
163
164     int  length_data_entry;
165     int  length_starting;
166     int  length_implementation;
167     char future_use[2];
168
169     int  force_indicator_length;
170     int  force_identifier_length;
171     char leader[24]; /* Fixme! Need linear access to LEADER of MARC record */  
172     struct data1_marctab *next;
173 } data1_marctab;
174
175 typedef struct data1_esetname
176 {
177     char *name;
178     Z_Espec1 *spec;
179     struct data1_esetname *next;
180 } data1_esetname;
181
182 /*
183  * Variant set definitions.
184  */
185
186 typedef struct data1_vartype
187 {
188     char *name;
189     struct data1_varclass *zclass;
190     int type;
191     data1_datatype datatype;
192     struct data1_vartype *next;
193 } data1_vartype;
194
195 typedef struct data1_varclass
196 {
197     char *name;
198     struct data1_varset *set;
199     int zclass;
200     data1_vartype *types;
201     struct data1_varclass *next;
202 } data1_varclass;
203
204 typedef struct data1_varset
205 {
206     char *name;
207     oid_value reference;
208     data1_varclass *classes;
209 } data1_varset;
210
211 /*
212  * Tagset definitions
213  */
214
215 struct data1_tagset;
216
217 typedef struct data1_tag
218 {
219     data1_name *names;
220 #define DATA1T_numeric 1
221 #define DATA1T_string 2
222     int which;
223     union
224     {
225         int numeric;
226         char *string;
227     } value;
228     data1_datatype kind;
229
230     struct data1_tagset *tagset;
231     struct data1_tag *next;
232 } data1_tag;
233
234 typedef struct data1_tagset data1_tagset;
235
236 struct data1_tagset
237 {
238     int type;                        /* type of tagset in current context */
239     char *name;                      /* symbolic name */
240     oid_value reference;
241     data1_tag *tags;                 /* tags defined by this set */
242     data1_tagset *children;          /* children */
243     data1_tagset *next;              /* sibling */
244 };
245
246 typedef struct data1_termlist
247 {
248 #if NATTR
249     char *index_name;
250 #else
251     data1_att *att;
252 #endif
253     char *structure;
254     char *source;
255     struct data1_termlist *next;
256 } data1_termlist;
257
258 /*
259  * abstract syntax specification
260  */
261
262 typedef struct data1_element
263 {
264     char *name;
265     data1_tag *tag;
266     data1_termlist *termlists;
267     char *sub_name;
268     struct data1_element *children;
269     struct data1_element *next;
270     struct data1_hash_table *hash;
271 } data1_element;
272
273 typedef struct data1_sub_elements {
274     char *name;
275     struct data1_sub_elements *next;
276     data1_element *elements;
277 } data1_sub_elements;
278
279 typedef struct data1_xattr {
280     char *name;
281     char *value;
282     struct data1_xattr *next;
283     unsigned short what;  /* DATA1I_text, .. see data1_node.u.data */
284 } data1_xattr;
285
286
287 /*
288  * record data node (tag/data/variant)
289  */
290
291 typedef struct data1_node
292 {
293     /* the root of a record (containing global data) */
294 #define DATA1N_root 1 
295     /* a tag */
296 #define DATA1N_tag  2       
297     /* some data under a leaf tag or variant */
298 #define DATA1N_data 3
299     /* variant specification (a triple, actually) */
300 #define DATA1N_variant 4
301     /* comment (same as data) */
302 #define DATA1N_comment 5
303     /* preprocessing instruction */
304 #define DATA1N_preprocess 6
305     int which;
306     union
307     {
308         struct
309         {
310             char *type;
311             struct data1_absyn *absyn;  /* abstract syntax for this type */
312         } root;
313
314         struct 
315         {
316             char *tag;
317             data1_element *element;
318             int no_data_requested;
319             int get_bytes;
320             unsigned node_selected : 1;
321             unsigned make_variantlist : 1;
322             data1_xattr *attributes;
323         } tag;
324
325         struct
326         {
327             char *data;      /* filename or data */
328             int len;
329             /* text inclusion */
330 #define DATA1I_inctxt 1
331             /* binary data inclusion */
332 #define DATA1I_incbin 2
333         /* text data */
334 #define DATA1I_text 3 
335             /* numerical data */
336 #define DATA1I_num 4
337             /* object identifier */
338 #define DATA1I_oid 5
339             /* XML text */
340 #define DATA1I_xmltext 6
341             unsigned what:7;
342             unsigned formatted_text : 1;   /* newlines are significant */
343         } data;
344
345         struct
346         {
347             data1_vartype *type;
348             char *value;
349         } variant;
350
351         struct
352         {
353             char *target;
354             data1_xattr *attributes;
355         } preprocess;
356     } u;
357
358     void (*destroy)(struct data1_node *n);
359 #define DATA1_LOCALDATA 12
360     char lbuf[DATA1_LOCALDATA]; /* small buffer for local data */
361     struct data1_node *next;
362     struct data1_node *child;
363     struct data1_node *last_child;
364     struct data1_node *parent;
365     struct data1_node *root;
366 } data1_node;
367
368 YAZ_EXPORT data1_handle data1_create (void);
369
370 #define DATA1_FLAG_XML  1
371 YAZ_EXPORT data1_handle data1_createx (int flags);
372
373 YAZ_EXPORT void data1_destroy(data1_handle dh);
374 YAZ_EXPORT data1_node *get_parent_tag(data1_handle dh, data1_node *n);
375 YAZ_EXPORT data1_node *data1_read_node(data1_handle dh, const char **buf,
376                                        NMEM m);
377 YAZ_EXPORT data1_node *data1_read_nodex (data1_handle dh, NMEM m,
378                                          int (*get_byte)(void *fh), void *fh,
379                                          WRBUF wrbuf);
380 YAZ_EXPORT data1_node *data1_read_record(data1_handle dh, 
381                                          int (*rf)(void *, char *, size_t),
382                                          void *fh, NMEM m);
383 YAZ_EXPORT data1_absyn *data1_read_absyn(data1_handle dh, const char *file,
384                                          int file_must_exist);
385 YAZ_EXPORT data1_tag *data1_gettagbynum(data1_handle dh,
386                                         data1_tagset *s,
387                                         int type, int value);
388 YAZ_EXPORT data1_tagset *data1_empty_tagset (data1_handle dh);
389 YAZ_EXPORT data1_tagset *data1_read_tagset(data1_handle dh, 
390                                            const char *file,
391                                            int type);
392 YAZ_EXPORT data1_element *data1_getelementbytagname(data1_handle dh, 
393                                                     data1_absyn *abs,
394                                                     data1_element *parent,
395                                                     const char *tagname);
396 YAZ_EXPORT Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
397                                            int select, ODR o,
398                                            int *len);
399 YAZ_EXPORT data1_tag *data1_gettagbyname(data1_handle dh, data1_tagset *s,
400                                          const char *name);
401 YAZ_EXPORT void data1_free_tree(data1_handle dh, data1_node *t);
402 YAZ_EXPORT char *data1_nodetobuf(data1_handle dh, data1_node *n,
403                                  int select, int *len);
404 YAZ_EXPORT data1_node *data1_mk_tag_data_wd(data1_handle dh,
405                                             data1_node *at,
406                                             const char *tagname, NMEM m);
407 YAZ_EXPORT data1_node *data1_mk_tag_data(data1_handle dh, data1_node *at,
408                                          const char *tagname, NMEM m);
409 YAZ_EXPORT data1_datatype data1_maptype(data1_handle dh, char *t);
410 YAZ_EXPORT data1_varset *data1_read_varset(data1_handle dh, const char *file);
411 YAZ_EXPORT data1_vartype *data1_getvartypebyct(data1_handle dh,
412                                                data1_varset *set,
413                                                const char *zclass,
414                                                const char *type);
415 YAZ_EXPORT data1_vartype *data1_getvartypeby_absyn(data1_handle dh,
416                                                    data1_absyn *absyn,
417                                                    char *zclass, char *type);
418 YAZ_EXPORT Z_Espec1 *data1_read_espec1(data1_handle dh, const char *file);
419 YAZ_EXPORT int data1_doespec1(data1_handle dh, data1_node *n, Z_Espec1 *e);
420 YAZ_EXPORT data1_esetname *data1_getesetbyname(data1_handle dh, 
421                                                data1_absyn *a,
422                                                const char *name);
423 YAZ_EXPORT data1_element *data1_getelementbyname(data1_handle dh,
424                                                  data1_absyn *absyn,
425                                                  const char *name);
426 YAZ_EXPORT data1_node *data1_mk_node2(data1_handle dh, NMEM m,
427                                       int type, data1_node *parent);
428
429 YAZ_EXPORT data1_node *data1_mk_tag (data1_handle dh, NMEM nmem, 
430                                      const char *tag, const char **attr,
431                                      data1_node *at);
432 YAZ_EXPORT data1_node *data1_mk_tag_n (data1_handle dh, NMEM nmem,
433                                        const char *tag, size_t len,
434                                        const char **attr,
435                                        data1_node *at);
436 YAZ_EXPORT void data1_tag_add_attr (data1_handle dh, NMEM nmem,
437                                     data1_node *res, const char **attr);
438
439 YAZ_EXPORT data1_node *data1_mk_text_n (data1_handle dh, NMEM mem,
440                                         const char *buf, size_t len,
441                                         data1_node *parent);
442 YAZ_EXPORT data1_node *data1_mk_text_nf (data1_handle dh, NMEM mem,
443                                          const char *buf, size_t len,
444                                          data1_node *parent);
445 YAZ_EXPORT data1_node *data1_mk_text (data1_handle dh, NMEM mem,
446                                       const char *buf, data1_node *parent);
447
448 YAZ_EXPORT data1_node *data1_mk_comment_n (data1_handle dh, NMEM mem,
449                                            const char *buf, size_t len,
450                                            data1_node *parent);
451
452 YAZ_EXPORT data1_node *data1_mk_comment (data1_handle dh, NMEM mem,
453                                          const char *buf, data1_node *parent);
454
455 YAZ_EXPORT data1_node *data1_mk_preprocess_n (data1_handle dh, NMEM nmem,
456                                               const char *target, size_t len,
457                                               const char **attr,
458                                               data1_node *at);
459
460 YAZ_EXPORT data1_node *data1_mk_preprocess (data1_handle dh, NMEM nmem,
461                                             const char *target,
462                                             const char **attr,
463                                             data1_node *at);
464
465 YAZ_EXPORT data1_node *data1_insert_preprocess_n (data1_handle dh, NMEM nmem,
466                                                   const char *target,
467                                                   size_t len,
468                                                   const char **attr,
469                                                   data1_node *at);
470
471 YAZ_EXPORT data1_node *data1_insert_preprocess (data1_handle dh, NMEM nmem,
472                                                 const char *target,
473                                                 const char **attr,
474                                                 data1_node *at);
475
476 YAZ_EXPORT data1_node *data1_mk_root (data1_handle dh, NMEM nmem,
477                                       const char *name);
478 YAZ_EXPORT void data1_set_root(data1_handle dh, data1_node *res,
479                                NMEM nmem, const char *name);
480
481 YAZ_EXPORT data1_node *data1_mk_tag_data_zint (data1_handle dh, data1_node *at,
482                                                const char *tag, zint num,
483                                                NMEM nmem);
484 YAZ_EXPORT data1_node *data1_mk_tag_data_int (data1_handle dh, data1_node *at,
485                                               const char *tag, int num,
486                                               NMEM nmem);
487 YAZ_EXPORT data1_node *data1_mk_tag_data_oid (data1_handle dh, data1_node *at,
488                                               const char *tag, Odr_oid *oid,
489                                               NMEM nmem);
490 YAZ_EXPORT data1_node *data1_mk_tag_data_text (data1_handle dh, data1_node *at,
491                                                const char *tag,
492                                                const char *str,
493                                                NMEM nmem);
494 YAZ_EXPORT data1_node *data1_mk_tag_data_text_uni (data1_handle dh,
495                                                    data1_node *at,
496                                                    const char *tag,
497                                                    const char *str,
498                                                    NMEM nmem);
499
500 YAZ_EXPORT data1_absyn *data1_get_absyn (data1_handle dh, const char *name);
501
502 YAZ_EXPORT data1_node *data1_search_tag (data1_handle dh, data1_node *n,
503                                          const char *tag);
504 YAZ_EXPORT data1_node *data1_mk_tag_uni (data1_handle dh, NMEM nmem, 
505                                          const char *tag, data1_node *at);
506 YAZ_EXPORT data1_attset *data1_get_attset (data1_handle dh, const char *name);
507 YAZ_EXPORT data1_maptab *data1_read_maptab(data1_handle dh, const char *file);
508 YAZ_EXPORT data1_node *data1_map_record(data1_handle dh, data1_node *n,
509                                         data1_maptab *map, NMEM m);
510 YAZ_EXPORT data1_marctab *data1_read_marctab (data1_handle dh,
511                                               const char *file);
512 YAZ_EXPORT data1_marctab *data1_absyn_getmarctab(data1_handle dh,
513                                                  data1_absyn *absyn);
514 YAZ_EXPORT data1_element *data1_absyn_getelements(data1_handle dh,
515                                                  data1_absyn *absyn);
516 YAZ_EXPORT char *data1_nodetomarc(data1_handle dh, data1_marctab *p,
517                                   data1_node *n, int selected, int *len);
518 YAZ_EXPORT char *data1_nodetoidsgml(data1_handle dh, data1_node *n,
519                                     int select, int *len);
520 YAZ_EXPORT Z_ExplainRecord *data1_nodetoexplain(data1_handle dh,
521                                                 data1_node *n, int select,
522                                                 ODR o);
523 YAZ_EXPORT Z_BriefBib *data1_nodetosummary(data1_handle dh, 
524                                            data1_node *n, int select,
525                                            ODR o);
526 YAZ_EXPORT char *data1_nodetosoif(data1_handle dh, data1_node *n, int select,
527                                   int *len);
528 YAZ_EXPORT void data1_set_tabpath(data1_handle dh, const char *path);
529 YAZ_EXPORT void data1_set_tabroot (data1_handle dp, const char *p);
530 YAZ_EXPORT const char *data1_get_tabpath(data1_handle dh);
531 YAZ_EXPORT const char *data1_get_tabroot(data1_handle dh);
532
533 YAZ_EXPORT WRBUF data1_get_wrbuf (data1_handle dp);
534 YAZ_EXPORT char **data1_get_read_buf (data1_handle dp, int **lenp);
535 YAZ_EXPORT char **data1_get_map_buf (data1_handle dp, int **lenp);
536 YAZ_EXPORT data1_absyn_cache *data1_absyn_cache_get (data1_handle dh);
537 YAZ_EXPORT data1_attset_cache *data1_attset_cache_get (data1_handle dh);
538 YAZ_EXPORT NMEM data1_nmem_get (data1_handle dh);
539 YAZ_EXPORT void data1_pr_tree (data1_handle dh, data1_node *n, FILE *out);
540 YAZ_EXPORT char *data1_insert_string (data1_handle dh, data1_node *res,
541                                       NMEM m, const char *str);
542 YAZ_EXPORT char *data1_insert_string_n (data1_handle dh, data1_node *res,
543                                         NMEM m, const char *str, size_t len);
544 YAZ_EXPORT data1_node *data1_read_sgml (data1_handle dh, NMEM m,
545                                         const char *buf);
546 YAZ_EXPORT data1_node *data1_read_xml (data1_handle dh,
547                                        int (*rf)(void *, char *, size_t),
548                                        void *fh, NMEM m);
549 YAZ_EXPORT void data1_absyn_trav (data1_handle dh, void *handle,
550                                   void (*fh)(data1_handle dh,
551                                              void *h, data1_absyn *a));
552
553 YAZ_EXPORT data1_attset *data1_attset_search_id (data1_handle dh, int id);
554
555 YAZ_EXPORT char *data1_getNodeValue(data1_node* node, char* pTagPath);
556 YAZ_EXPORT data1_node *data1_LookupNode(data1_node* node, char* pTagPath);
557 YAZ_EXPORT int data1_CountOccurences(data1_node* node, char* pTagPath);
558
559 YAZ_EXPORT FILE *data1_path_fopen (data1_handle dh, const char *file,
560                                    const char *mode);
561
562 /* obsolete functions ... */
563
564 YAZ_EXPORT data1_node *data1_mk_node (data1_handle dh, NMEM m);
565 YAZ_EXPORT data1_node *data1_insert_taggeddata (data1_handle dh,
566                                                 data1_node *root,
567                                                 data1_node *at,
568                                                 const char *tagname, NMEM m);
569 YAZ_EXPORT data1_node *data1_mk_node_type (data1_handle dh, NMEM m, int type);
570 YAZ_EXPORT data1_node *data1_add_taggeddata (data1_handle dh, data1_node *root,
571                                              data1_node *at,
572                                              const char *tagname,
573                                              NMEM m);
574
575 YAZ_EXPORT data1_node *data1_get_root_tag (data1_handle dh, data1_node *n);
576
577 YAZ_EXPORT int data1_iconv (data1_handle dh, NMEM m, data1_node *n,
578                             const char *tocode, 
579                             const char *fromcode);
580
581 YAZ_EXPORT const char *data1_get_encoding (data1_handle dh, data1_node *n);
582
583 YAZ_EXPORT int data1_is_xmlmode(data1_handle dh);
584
585 YAZ_EXPORT const char *data1_systag_lookup(data1_absyn *absyn, const char *tag,
586                                            const char *default_value);
587
588 YAZ_EXPORT void data1_concat_text(data1_handle dh, NMEM m, data1_node *n);
589
590 YAZ_EXPORT void data1_absyn_destroy(data1_handle dh);
591
592 YAZ_END_CDECL
593
594 #endif