2 * Copyright (C) 1994-1998, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.35 2002-04-13 18:16:42 adam
8 * More XPATH work; common sequence numbers for extract keys
10 * Revision 1.34 2000/03/20 19:08:36 adam
11 * Added remote record import using Z39.50 extended services and Segment
14 * Revision 1.33 2000/02/25 13:24:49 adam
15 * Fixed bug regarding pointer conversion that showed up on OSF V5.
17 * Revision 1.32 1999/11/30 13:48:03 adam
18 * Improved installation. Updated for inclusion of YAZ header files.
20 * Revision 1.31 1999/09/07 07:19:21 adam
21 * Work on character mapping. Implemented replace rules.
23 * Revision 1.30 1999/05/21 12:00:17 adam
24 * Better diagnostics for extraction process.
26 * Revision 1.29 1999/05/20 12:57:18 adam
27 * Implemented TCL filter. Updated recctrl system.
29 * Revision 1.28 1999/03/02 16:15:42 quinn
30 * Added "tagsysno" and "tagrank" directives to zebra.cfg.
32 * Revision 1.27 1998/10/16 08:14:28 adam
33 * Updated record control system.
35 * Revision 1.26 1998/05/20 10:12:12 adam
36 * Implemented automatic EXPLAIN database maintenance.
37 * Modified Zebra to work with ASN.1 compiled version of YAZ.
39 * Revision 1.25 1998/03/11 11:19:04 adam
40 * Changed the way sequence numbers are generated.
42 * Revision 1.24 1998/03/05 08:38:46 adam
43 * New member recordSize in recRetrieveCtrl.
45 * Revision 1.23 1998/02/10 12:03:05 adam
48 * Revision 1.22 1997/10/27 14:33:04 adam
49 * Moved towards generic character mapping depending on "structure"
50 * field in abstract syntax file. Fixed a few memory leaks. Fixed
51 * bug with negative integers when doing searches with relational
54 * Revision 1.21 1997/09/18 08:59:19 adam
55 * Extra generic handle for the character mapping routines.
57 * Revision 1.20 1997/09/17 12:19:10 adam
58 * Zebra version corresponds to YAZ version 1.4.
59 * Changed Zebra server so that it doesn't depend on global common_resource.
61 * Revision 1.19 1997/09/05 15:30:02 adam
62 * Changed prototype for chr_map_input - added const.
63 * Added support for C++, headers uses extern "C" for public definitions.
65 * Revision 1.18 1997/09/04 13:56:15 adam
66 * Added new filter grs.marc.<syntax> where <syntax> refers to
67 * abstract syntax. New method tellf in extract/retrieve control
70 * Revision 1.17 1997/04/30 08:56:04 quinn
73 * Revision 1.16 1996/10/11 10:56:25 adam
74 * New module recctrl. Used to manage records (extract/retrieval).
75 * All record types are accessed by means of definitions in recctrl.h.
77 * Revision 1.15 1996/06/06 12:08:16 quinn
78 * Added showRecord Group entry
80 * Revision 1.14 1996/05/09 07:28:49 quinn
81 * Work towards phrases and multiple registers
83 * Revision 1.13 1996/05/01 13:44:05 adam
84 * Added seek function to the recExtractCtrl and recRetrieveCtrl control
85 * structures. Added end-of-file indicator function and start offset to
88 * Revision 1.12 1996/01/17 15:01:25 adam
89 * Prototype changed for reader functions in extract/retrieve. File
90 * is identified by 'void *' instead of 'int'.
92 * Revision 1.11 1995/12/04 14:20:54 adam
93 * Extra arg to recType_byName.
95 * Revision 1.10 1995/10/16 14:03:06 quinn
96 * Changes to support element set names and espec1
98 * Revision 1.9 1995/10/06 14:37:53 adam
99 * New result set method: r_score.
100 * Local no (sysno) and score is transferred to retrieveCtrl.
102 * Revision 1.8 1995/10/02 15:43:35 adam
103 * Extract uses file descriptors instead of FILE pointers.
105 * Revision 1.7 1995/10/02 15:18:09 adam
108 * Revision 1.6 1995/10/02 15:05:26 quinn
109 * Added a few fields.
111 * Revision 1.5 1995/10/02 14:55:52 quinn
112 * *** empty log message ***
114 * Revision 1.4 1995/09/27 16:17:29 adam
115 * More work on retrieve.
117 * Revision 1.3 1995/09/27 12:21:25 adam
118 * New function: recType_byName.
120 * Revision 1.2 1995/09/15 14:45:03 adam
123 * Revision 1.1 1995/09/14 07:48:13 adam
124 * Record control management.
131 #include <yaz/proto.h>
134 #include <yaz/data1.h>
135 #include <zebramap.h>
141 /* single word entity */
149 ZebraMaps zebra_maps;
150 struct recExtractCtrl *extractCtrl;
153 /* Extract record control */
154 struct recExtractCtrl {
155 void *fh; /* File handle and read function */
156 int (*readf)(void *fh, char *buf, size_t count);
157 off_t (*seekf)(void *fh, off_t offset); /* seek function */
158 off_t (*tellf)(void *fh); /* tell function */
159 void (*endf)(void *fh, off_t offset); /* end of record position */
160 off_t offset; /* start offset */
162 void (*init)(struct recExtractCtrl *p, RecWord *w);
164 void (*tokenAdd)(RecWord *w);
165 ZebraMaps zebra_maps;
168 void (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
173 /* Retrieve record control */
174 struct recRetrieveCtrl {
175 /* Input parameters ... */
176 Res res; /* Resource pool */
177 ODR odr; /* ODR used to create response */
178 void *fh; /* File descriptor and read function */
179 int (*readf)(void *fh, char *buf, size_t count);
180 off_t (*seekf)(void *fh, off_t offset);
181 off_t (*tellf)(void *fh);
182 oid_value input_format; /* Preferred record syntax */
183 Z_RecordComposition *comp; /* formatting instructions */
184 int localno; /* local id of record */
185 int score; /* score 0-1000 or -1 if none */
186 int recordSize; /* size of record in bytes */
191 oid_value output_format;
198 typedef struct recType *RecType;
202 char *name; /* Name of record type */
203 void *(*init)(RecType recType); /* Init function - called once */
204 void (*destroy)(void *clientData); /* Destroy function */
205 int (*extract)(void *clientData,
206 struct recExtractCtrl *ctrl); /* Extract proc */
207 int (*retrieve)(void *clientData,
208 struct recRetrieveCtrl *ctrl); /* Retrieve proc */
211 #define RECCTRL_EXTRACT_OK 0
212 #define RECCTRL_EXTRACT_EOF 1
213 #define RECCTRL_EXTRACT_ERROR 2
215 typedef struct recTypes *RecTypes;
217 RecTypes recTypes_init (data1_handle dh);
218 void recTypes_destroy (RecTypes recTypes);
219 void recTypes_default_handlers (RecTypes recTypes);
221 RecType recType_byName (RecTypes rts, const char *name, char *subType,
224 int grs_extract_tree(struct recExtractCtrl *p, data1_node *n);