Changed ZOOM_query_ccl2rpn function so that it takes a CCL config
[yaz-moved-to-github.git] / include / yaz / zoom.h
1 /*
2  * Copyright (C) 1995-2005, Index Data ApS
3  * See the file LICENSE for details.
4  *
5  * $Id: zoom.h,v 1.36 2006-06-15 10:34:16 adam Exp $
6  */
7 /**
8  * \file zoom.h
9  * \brief Header for ZOOM
10  */
11
12 #include <stdlib.h>
13 #include <yaz/yconfig.h>
14
15 #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
16 #define ZOOM_END_CDECL YAZ_END_CDECL
17
18 #ifdef WIN32
19 #  define ZOOM_API(x) __declspec(dllexport) x __stdcall
20 #else
21 #  define ZOOM_API(x) x
22 # endif
23
24 ZOOM_BEGIN_CDECL
25
26 /* ----------------------------------------------------------- */
27 /* the types we use */
28
29 typedef struct ZOOM_options_p *ZOOM_options;
30 typedef struct ZOOM_query_p *ZOOM_query;
31 typedef struct ZOOM_connection_p *ZOOM_connection;
32 typedef struct ZOOM_resultset_p *ZOOM_resultset;
33 typedef struct ZOOM_record_p *ZOOM_record;
34 typedef struct ZOOM_scanset_p *ZOOM_scanset;
35 typedef struct ZOOM_package_p *ZOOM_package;
36
37 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
38
39 /* ----------------------------------------------------------- */
40 /* connections */
41
42 /* create connection, connect to host, if portnum is 0, then port is
43 read from host string (e.g. myhost:9821) */
44 ZOOM_API(ZOOM_connection)
45 ZOOM_connection_new (const char *host, int portnum);
46
47 /* create connection, don't connect, apply options */
48 ZOOM_API(ZOOM_connection)
49 ZOOM_connection_create (ZOOM_options options);
50
51 /* connect given existing connection */
52 ZOOM_API(void)
53 ZOOM_connection_connect(ZOOM_connection c, const char *host,
54                               int portnum);
55
56 /* destroy connection (close connection also) */
57 ZOOM_API(void)
58 ZOOM_connection_destroy (ZOOM_connection c);
59
60 /* get/set option for connection */
61 ZOOM_API(const char *)
62 ZOOM_connection_option_get (ZOOM_connection c, const char *key);
63
64 ZOOM_API(const char *)
65 ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp);
66
67 ZOOM_API(void)
68 ZOOM_connection_option_set (ZOOM_connection c, const char *key,
69                             const char *val);
70
71 ZOOM_API(void)
72 ZOOM_connection_option_setl (ZOOM_connection c, const char *key,
73                              const char *val, int len);
74
75 /* return error code (0 == success, failure otherwise). cp
76    holds error string on failure, addinfo holds addititional info (if any)
77 */
78 ZOOM_API(int)
79 ZOOM_connection_error (ZOOM_connection c, const char **cp,
80                             const char **addinfo);
81
82 ZOOM_API(int)
83 ZOOM_connection_error_x (ZOOM_connection c, const char **cp,
84                          const char **addinfo, const char **diagset);
85
86 /* returns error code */
87 ZOOM_API(int)
88 ZOOM_connection_errcode (ZOOM_connection c);
89 /* returns error message */
90 ZOOM_API(const char *)
91 ZOOM_connection_errmsg (ZOOM_connection c);
92 /* returns additional info */
93 ZOOM_API(const char *)
94 ZOOM_connection_addinfo (ZOOM_connection c);
95 /* returns diagnostic set */
96 ZOOM_API(const char *)
97 ZOOM_connection_diagset (ZOOM_connection c);
98 /* translates error code into human-readable string */
99 ZOOM_API(const char *)
100 ZOOM_diag_str (int error);
101
102 #define ZOOM_ERROR_NONE 0
103 #define ZOOM_ERROR_CONNECT 10000
104 #define ZOOM_ERROR_MEMORY  10001
105 #define ZOOM_ERROR_ENCODE  10002
106 #define ZOOM_ERROR_DECODE  10003
107 #define ZOOM_ERROR_CONNECTION_LOST 10004
108 #define ZOOM_ERROR_INIT 10005
109 #define ZOOM_ERROR_INTERNAL 10006
110 #define ZOOM_ERROR_TIMEOUT 10007
111 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
112 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
113 #define ZOOM_ERROR_INVALID_QUERY 10010
114 #define ZOOM_ERROR_CQL_PARSE 10011
115 #define ZOOM_ERROR_CQL_TRANSFORM 10012
116 #define ZOOM_ERROR_CCL_CONFIG 10013
117 #define ZOOM_ERROR_CCL_PARSE 10014
118
119 ZOOM_API(int)
120 ZOOM_connection_last_event(ZOOM_connection cs);
121
122 #define ZOOM_EVENT_NONE 0
123 #define ZOOM_EVENT_CONNECT 1
124 #define ZOOM_EVENT_SEND_DATA  2
125 #define ZOOM_EVENT_RECV_DATA 3
126 #define ZOOM_EVENT_TIMEOUT 4
127 #define ZOOM_EVENT_UNKNOWN 5
128 #define ZOOM_EVENT_SEND_APDU 6
129 #define ZOOM_EVENT_RECV_APDU 7
130 #define ZOOM_EVENT_RECV_RECORD 8
131 #define ZOOM_EVENT_RECV_SEARCH 9
132 #define ZOOM_EVENT_END 10
133
134 /* ----------------------------------------------------------- */
135 /* result sets */
136
137 /* create result set given a search */
138 ZOOM_API(ZOOM_resultset)
139 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
140 /* create result set given PQF query */
141 ZOOM_API(ZOOM_resultset)
142 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
143
144 /* destroy result set */
145 ZOOM_API(void)
146 ZOOM_resultset_destroy(ZOOM_resultset r);
147
148 /* result set option */
149 ZOOM_API(const char *)
150 ZOOM_resultset_option_get (ZOOM_resultset r, const char *key);
151 ZOOM_API(void)
152 ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val);
153
154 /*┬áreturn size of result set (alias hit count AKA result count) */
155 ZOOM_API(size_t)
156 ZOOM_resultset_size (ZOOM_resultset r);
157
158 /* retrieve records */
159 ZOOM_API(void)
160 ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs,
161                         size_t start, size_t count);
162
163 /* return record object at pos. Returns 0 if unavailable */
164 ZOOM_API(ZOOM_record)
165 ZOOM_resultset_record (ZOOM_resultset s, size_t pos);
166
167 /* like ZOOM_resultset_record - but never blocks .. */
168 ZOOM_API(ZOOM_record)
169 ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos);
170
171 /* reset record cache for result set */
172 ZOOM_API(void)
173 ZOOM_resultset_cache_reset(ZOOM_resultset r);
174
175 /* ----------------------------------------------------------- */
176 /* records */
177
178 /* get record information, in a form given by type */
179 ZOOM_API(const char *)
180 ZOOM_record_get (ZOOM_record rec, const char *type, int *len);
181
182 /* destroy record */
183 ZOOM_API(void)
184 ZOOM_record_destroy (ZOOM_record rec);
185
186 /* return copy of record */
187 ZOOM_API(ZOOM_record)
188 ZOOM_record_clone (ZOOM_record srec);
189
190 /* ----------------------------------------------------------- */
191 /* queries */
192
193 /* create search object */
194 ZOOM_API(ZOOM_query)
195 ZOOM_query_create(void);
196 /* destroy it */
197 ZOOM_API(void)
198 ZOOM_query_destroy(ZOOM_query s);
199 /* CQL */
200 ZOOM_API(int)
201 ZOOM_query_cql(ZOOM_query s, const char *str);
202 /* CQL translated client-side into RPN: `conn' is optional for diagnostics */
203 ZOOM_API(int)
204 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn);
205 /* CCL translated client-side into RPN: `conn' is optional for diagnostics */
206 ZOOM_API(int)
207 ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str,
208                    const char *config, 
209                    int *ccl_error, const char **error_string, int *error_pos);
210 /* PQF */
211 ZOOM_API(int)
212 ZOOM_query_prefix(ZOOM_query s, const char *str);
213 /* specify sort criteria for search */
214 ZOOM_API(int)
215 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
216
217 /* ----------------------------------------------------------- */
218 /* scan */
219 ZOOM_API(ZOOM_scanset)
220 ZOOM_connection_scan (ZOOM_connection c, const char *startterm);
221
222 ZOOM_API(ZOOM_scanset)
223 ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm);
224
225 ZOOM_API(const char *)
226 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
227                   int *occ, int *len);
228
229 ZOOM_API(const char *)
230 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
231                           int *occ, int *len);
232
233 ZOOM_API(size_t)
234 ZOOM_scanset_size(ZOOM_scanset scan);
235
236 ZOOM_API(void)
237 ZOOM_scanset_destroy (ZOOM_scanset scan);
238
239 ZOOM_API(const char *)
240     ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key);
241
242 ZOOM_API(void)
243     ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key,
244                              const char *val);
245 /* ----------------------------------------------------------- */
246 /* Extended Services Packages */
247
248 ZOOM_API(ZOOM_package)
249     ZOOM_connection_package (ZOOM_connection c, ZOOM_options options);
250
251 ZOOM_API(void)
252     ZOOM_package_destroy(ZOOM_package p);
253
254 ZOOM_API(void)
255     ZOOM_package_send (ZOOM_package p, const char *type);
256
257 ZOOM_API(const char *)
258     ZOOM_package_option_get (ZOOM_package p, const char *key);
259
260 ZOOM_API(void)
261     ZOOM_package_option_set (ZOOM_package p, const char *key,
262                              const char *val);
263
264 /* ----------------------------------------------------------- */
265 /* Sort.  First function is deprecated, use second instead */
266 ZOOM_API(void)
267     ZOOM_resultset_sort(ZOOM_resultset r,
268                         const char *sort_type, const char *sort_spec);
269 ZOOM_API(int)
270     ZOOM_resultset_sort1(ZOOM_resultset r,
271                         const char *sort_type, const char *sort_spec);
272
273 /* ----------------------------------------------------------- */
274 /* options */
275
276 ZOOM_API(ZOOM_options_callback)
277     ZOOM_options_set_callback (ZOOM_options opt,
278                                ZOOM_options_callback c,
279                                void *handle);
280 ZOOM_API(ZOOM_options)
281 ZOOM_options_create (void);
282
283 ZOOM_API(ZOOM_options)
284 ZOOM_options_create_with_parent (ZOOM_options parent);
285
286 ZOOM_API(ZOOM_options)
287     ZOOM_options_create_with_parent2 (ZOOM_options parent1,
288                                       ZOOM_options parent2);
289
290 ZOOM_API(const char *)
291 ZOOM_options_get (ZOOM_options opt, const char *name);
292
293 ZOOM_API(const char *)
294 ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp);
295
296 ZOOM_API(void)
297 ZOOM_options_set (ZOOM_options opt, const char *name, const char *v);
298
299 ZOOM_API(void)
300 ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value,
301                    int len);
302
303 ZOOM_API(void)
304 ZOOM_options_destroy (ZOOM_options opt);
305
306 ZOOM_API(int)
307 ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa);
308
309 ZOOM_API(int)
310 ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa);
311
312 ZOOM_API(void)
313 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
314
315 /* ----------------------------------------------------------- */
316 /* events */
317 /* poll for events on a number of connections. Returns positive
318    integer if event occurred ; zero if none occurred and no more
319    events are pending. The positive integer specifies the
320    connection for which the event occurred. */
321 ZOOM_API(int)
322 ZOOM_event (int no, ZOOM_connection *cs);
323
324 ZOOM_END_CDECL
325 /*
326  * Local variables:
327  * c-basic-offset: 4
328  * indent-tabs-mode: nil
329  * End:
330  * vim: shiftwidth=4 tabstop=8 expandtab
331  */
332