2 * Copyright (C) 1994-1998, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.32 1999-11-30 13:48:03 adam
8 * Improved installation. Updated for inclusion of YAZ header files.
10 * Revision 1.31 1999/09/07 07:19:21 adam
11 * Work on character mapping. Implemented replace rules.
13 * Revision 1.30 1999/05/21 12:00:17 adam
14 * Better diagnostics for extraction process.
16 * Revision 1.29 1999/05/20 12:57:18 adam
17 * Implemented TCL filter. Updated recctrl system.
19 * Revision 1.28 1999/03/02 16:15:42 quinn
20 * Added "tagsysno" and "tagrank" directives to zebra.cfg.
22 * Revision 1.27 1998/10/16 08:14:28 adam
23 * Updated record control system.
25 * Revision 1.26 1998/05/20 10:12:12 adam
26 * Implemented automatic EXPLAIN database maintenance.
27 * Modified Zebra to work with ASN.1 compiled version of YAZ.
29 * Revision 1.25 1998/03/11 11:19:04 adam
30 * Changed the way sequence numbers are generated.
32 * Revision 1.24 1998/03/05 08:38:46 adam
33 * New member recordSize in recRetrieveCtrl.
35 * Revision 1.23 1998/02/10 12:03:05 adam
38 * Revision 1.22 1997/10/27 14:33:04 adam
39 * Moved towards generic character mapping depending on "structure"
40 * field in abstract syntax file. Fixed a few memory leaks. Fixed
41 * bug with negative integers when doing searches with relational
44 * Revision 1.21 1997/09/18 08:59:19 adam
45 * Extra generic handle for the character mapping routines.
47 * Revision 1.20 1997/09/17 12:19:10 adam
48 * Zebra version corresponds to YAZ version 1.4.
49 * Changed Zebra server so that it doesn't depend on global common_resource.
51 * Revision 1.19 1997/09/05 15:30:02 adam
52 * Changed prototype for chr_map_input - added const.
53 * Added support for C++, headers uses extern "C" for public definitions.
55 * Revision 1.18 1997/09/04 13:56:15 adam
56 * Added new filter grs.marc.<syntax> where <syntax> refers to
57 * abstract syntax. New method tellf in extract/retrieve control
60 * Revision 1.17 1997/04/30 08:56:04 quinn
63 * Revision 1.16 1996/10/11 10:56:25 adam
64 * New module recctrl. Used to manage records (extract/retrieval).
65 * All record types are accessed by means of definitions in recctrl.h.
67 * Revision 1.15 1996/06/06 12:08:16 quinn
68 * Added showRecord Group entry
70 * Revision 1.14 1996/05/09 07:28:49 quinn
71 * Work towards phrases and multiple registers
73 * Revision 1.13 1996/05/01 13:44:05 adam
74 * Added seek function to the recExtractCtrl and recRetrieveCtrl control
75 * structures. Added end-of-file indicator function and start offset to
78 * Revision 1.12 1996/01/17 15:01:25 adam
79 * Prototype changed for reader functions in extract/retrieve. File
80 * is identified by 'void *' instead of 'int'.
82 * Revision 1.11 1995/12/04 14:20:54 adam
83 * Extra arg to recType_byName.
85 * Revision 1.10 1995/10/16 14:03:06 quinn
86 * Changes to support element set names and espec1
88 * Revision 1.9 1995/10/06 14:37:53 adam
89 * New result set method: r_score.
90 * Local no (sysno) and score is transferred to retrieveCtrl.
92 * Revision 1.8 1995/10/02 15:43:35 adam
93 * Extract uses file descriptors instead of FILE pointers.
95 * Revision 1.7 1995/10/02 15:18:09 adam
98 * Revision 1.6 1995/10/02 15:05:26 quinn
101 * Revision 1.5 1995/10/02 14:55:52 quinn
102 * *** empty log message ***
104 * Revision 1.4 1995/09/27 16:17:29 adam
105 * More work on retrieve.
107 * Revision 1.3 1995/09/27 12:21:25 adam
108 * New function: recType_byName.
110 * Revision 1.2 1995/09/15 14:45:03 adam
113 * Revision 1.1 1995/09/14 07:48:13 adam
114 * Record control management.
121 #include <yaz/proto.h>
124 #include <yaz/data1.h>
125 #include <zebramap.h>
131 /* single word entity */
139 ZebraMaps zebra_maps;
140 struct recExtractCtrl *extractCtrl;
143 /* Extract record control */
144 struct recExtractCtrl {
145 void *fh; /* File handle and read function */
146 int (*readf)(void *fh, char *buf, size_t count);
147 off_t (*seekf)(void *fh, off_t offset); /* seek function */
148 off_t (*tellf)(void *fh); /* tell function */
149 void (*endf)(void *fh, off_t offset); /* end of record position */
150 off_t offset; /* start offset */
152 void (*init)(struct recExtractCtrl *p, RecWord *w);
154 void (*tokenAdd)(RecWord *w);
155 ZebraMaps zebra_maps;
158 void (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
162 /* Retrieve record control */
163 struct recRetrieveCtrl {
164 /* Input parameters ... */
165 Res res; /* Resource pool */
166 ODR odr; /* ODR used to create response */
167 void *fh; /* File descriptor and read function */
168 int (*readf)(void *fh, char *buf, size_t count);
169 off_t (*seekf)(void *fh, off_t offset);
170 off_t (*tellf)(void *fh);
171 oid_value input_format; /* Preferred record syntax */
172 Z_RecordComposition *comp; /* formatting instructions */
173 int localno; /* local id of record */
174 int score; /* score 0-1000 or -1 if none */
175 int recordSize; /* size of record in bytes */
180 oid_value output_format;
187 typedef struct recType *RecType;
191 char *name; /* Name of record type */
192 void *(*init)(RecType recType); /* Init function - called once */
193 void (*destroy)(void *clientData); /* Destroy function */
194 int (*extract)(void *clientData,
195 struct recExtractCtrl *ctrl); /* Extract proc */
196 int (*retrieve)(void *clientData,
197 struct recRetrieveCtrl *ctrl); /* Retrieve proc */
200 #define RECCTRL_EXTRACT_OK 0
201 #define RECCTRL_EXTRACT_EOF 1
202 #define RECCTRL_EXTRACT_ERROR 2
204 typedef struct recTypes *RecTypes;
206 RecTypes recTypes_init (data1_handle dh);
207 void recTypes_destroy (RecTypes recTypes);
208 void recTypes_default_handlers (RecTypes recTypes);
210 RecType recType_byName (RecTypes rts, const char *name, char *subType,
213 int grs_extract_tree(struct recExtractCtrl *p, data1_node *n);