Fix yaz URL
[yaz-moved-to-github.git] / include / yaz / zoom.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2010 Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Index Data nor the names of its contributors
13  *       may be used to endorse or promote products derived from this
14  *       software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 /**
29  * \file zoom.h
30  * \brief Header for ZOOM
31  */
32
33 #include <stdlib.h>
34 #include <yaz/yconfig.h>
35
36 #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL
37 #define ZOOM_END_CDECL YAZ_END_CDECL
38
39 #ifdef WIN32
40 #  define ZOOM_API(x) __declspec(dllexport) x __stdcall
41 #else
42 #  define ZOOM_API(x) x
43 # endif
44
45 ZOOM_BEGIN_CDECL
46
47 /* ----------------------------------------------------------- */
48 /* the types we use */
49
50 typedef struct ZOOM_options_p *ZOOM_options;
51 typedef struct ZOOM_query_p *ZOOM_query;
52 typedef struct ZOOM_connection_p *ZOOM_connection;
53 typedef struct ZOOM_resultset_p *ZOOM_resultset;
54 typedef struct ZOOM_record_p *ZOOM_record;
55 typedef struct ZOOM_facet_field_p *ZOOM_facet_field;
56 typedef struct ZOOM_scanset_p *ZOOM_scanset;
57 typedef struct ZOOM_package_p *ZOOM_package;
58
59 typedef const char *(*ZOOM_options_callback)(void *handle, const char *name);
60
61 /* ----------------------------------------------------------- */
62 /* connections */
63
64 /* create connection, connect to host, if portnum is 0, then port is
65    read from host string (e.g. myhost:9821) */
66 ZOOM_API(ZOOM_connection)
67 ZOOM_connection_new(const char *host, int portnum);
68
69 /* create connection, don't connect, apply options */
70 ZOOM_API(ZOOM_connection)
71 ZOOM_connection_create(ZOOM_options options);
72
73 /* connect given existing connection */
74 ZOOM_API(void)
75 ZOOM_connection_connect(ZOOM_connection c, const char *host,
76                               int portnum);
77
78 ZOOM_API(void)
79 ZOOM_connection_close(ZOOM_connection c);
80
81 /* destroy connection (close connection also) */
82 ZOOM_API(void)
83 ZOOM_connection_destroy(ZOOM_connection c);
84
85 /* get/set option for connection */
86 ZOOM_API(const char *)
87 ZOOM_connection_option_get(ZOOM_connection c, const char *key);
88
89 ZOOM_API(const char *)
90 ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp);
91
92 ZOOM_API(void)
93 ZOOM_connection_option_set(ZOOM_connection c, const char *key,
94                            const char *val);
95
96 ZOOM_API(void)
97 ZOOM_connection_option_setl(ZOOM_connection c, const char *key,
98                             const char *val, int len);
99
100 /* return error code (0 == success, failure otherwise). cp
101    holds error string on failure, addinfo holds addititional info (if any)
102 */
103 ZOOM_API(int)
104 ZOOM_connection_error(ZOOM_connection c, const char **cp,
105                       const char **addinfo);
106
107 ZOOM_API(int)
108 ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
109                         const char **addinfo, const char **diagset);
110
111 /* returns error code */
112 ZOOM_API(int)
113 ZOOM_connection_errcode(ZOOM_connection c);
114 /* returns error message */
115 ZOOM_API(const char *)
116 ZOOM_connection_errmsg(ZOOM_connection c);
117 /* returns additional info */
118 ZOOM_API(const char *)
119 ZOOM_connection_addinfo(ZOOM_connection c);
120 /* returns diagnostic set */
121 ZOOM_API(const char *)
122 ZOOM_connection_diagset(ZOOM_connection c);
123 /* translates error code into human-readable string */
124 ZOOM_API(const char *)
125 ZOOM_diag_str (int error);
126
127 #define ZOOM_ERROR_NONE 0
128 #define ZOOM_ERROR_CONNECT 10000
129 #define ZOOM_ERROR_MEMORY  10001
130 #define ZOOM_ERROR_ENCODE  10002
131 #define ZOOM_ERROR_DECODE  10003
132 #define ZOOM_ERROR_CONNECTION_LOST 10004
133 #define ZOOM_ERROR_INIT 10005
134 #define ZOOM_ERROR_INTERNAL 10006
135 #define ZOOM_ERROR_TIMEOUT 10007
136 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008
137 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009
138 #define ZOOM_ERROR_INVALID_QUERY 10010
139 #define ZOOM_ERROR_CQL_PARSE 10011
140 #define ZOOM_ERROR_CQL_TRANSFORM 10012
141 #define ZOOM_ERROR_CCL_CONFIG 10013
142 #define ZOOM_ERROR_CCL_PARSE 10014
143
144 ZOOM_API(int)
145 ZOOM_connection_last_event(ZOOM_connection cs);
146
147 #define ZOOM_EVENT_NONE 0
148 #define ZOOM_EVENT_CONNECT 1
149 #define ZOOM_EVENT_SEND_DATA  2
150 #define ZOOM_EVENT_RECV_DATA 3
151 #define ZOOM_EVENT_TIMEOUT 4
152 #define ZOOM_EVENT_UNKNOWN 5
153 #define ZOOM_EVENT_SEND_APDU 6
154 #define ZOOM_EVENT_RECV_APDU 7
155 #define ZOOM_EVENT_RECV_RECORD 8
156 #define ZOOM_EVENT_RECV_SEARCH 9
157 #define ZOOM_EVENT_END 10
158 #define ZOOM_EVENT_MAX 10
159
160 /* ----------------------------------------------------------- */
161 /* result sets */
162
163 /* create result set given a search */
164 ZOOM_API(ZOOM_resultset)
165 ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
166 /* create result set given PQF query */
167 ZOOM_API(ZOOM_resultset)
168 ZOOM_connection_search_pqf(ZOOM_connection c, const char *q);
169
170 /* destroy result set */
171 ZOOM_API(void)
172 ZOOM_resultset_destroy(ZOOM_resultset r);
173
174 /** release result set from connection.
175
176     The result will will no longer be able to perform retrievals
177     from the connection from which it was created.
178 */
179 ZOOM_API(void)
180 ZOOM_resultset_release(ZOOM_resultset r);
181
182 /* result set option */
183 ZOOM_API(const char *)
184 ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
185 ZOOM_API(void)
186 ZOOM_resultset_option_set(ZOOM_resultset r, const char *key, const char *val);
187
188 /* return size of result set (alias hit count AKA result count) */
189 ZOOM_API(size_t)
190 ZOOM_resultset_size(ZOOM_resultset r);
191
192 /* retrieve records */
193 ZOOM_API(void)
194 ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs,
195                        size_t start, size_t count);
196
197 /* return record object at pos. Returns 0 if unavailable */
198 ZOOM_API(ZOOM_record)
199 ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
200
201 /* like ZOOM_resultset_record - but never blocks .. */
202 ZOOM_API(ZOOM_record)
203 ZOOM_resultset_record_immediate(ZOOM_resultset s, size_t pos);
204
205 /* reset record cache for result set */
206 ZOOM_API(void)
207 ZOOM_resultset_cache_reset(ZOOM_resultset r);
208
209
210 /* retrieve facet field */
211 ZOOM_API(ZOOM_facet_field)
212 ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name);
213
214 /* retrieve facet field at position. Returns 0 if unavailable */
215 ZOOM_API(ZOOM_facet_field)
216 ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos);
217
218 /* return number of facets available */
219 ZOOM_API(size_t)
220 ZOOM_resultset_facets_size(ZOOM_resultset r);
221
222 /* retrieve (array of pointers to) facet fields */
223 ZOOM_API(ZOOM_facet_field *)
224 ZOOM_resultset_facets(ZOOM_resultset r);
225
226 /* retrieve (array of pointers to) facet fields */
227 ZOOM_API(const char **)
228 ZOOM_resultset_facets_names(ZOOM_resultset r);
229
230
231
232 /* ----------------------------------------------------------- */
233 /* records */
234
235 /* get record information, in a form given by type */
236 ZOOM_API(const char *)
237 ZOOM_record_get(ZOOM_record rec, const char *type, int *len);
238
239 /* destroy record */
240 ZOOM_API(void)
241 ZOOM_record_destroy(ZOOM_record rec);
242
243 /* return copy of record */
244 ZOOM_API(ZOOM_record)
245 ZOOM_record_clone(ZOOM_record srec);
246
247 /* return error info (surrogate diagnostic) for record */
248 ZOOM_API(int)
249     ZOOM_record_error(ZOOM_record rec, const char **msg,
250                       const char **addinfo, const char **diagset);
251     
252 /* ----------------------------------------------------------- */
253 /* facets */
254
255 /* get facet name */
256 ZOOM_API(const char *)
257 ZOOM_facet_field_name(ZOOM_facet_field facet_field);
258
259 /* get terms count on facet */
260 ZOOM_API(size_t)
261 ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
262
263 /* get facet information, term and frequency, at a position. Returns 0 if out of bounds */
264 ZOOM_API(const char *)
265 ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq);
266
267 /* ----------------------------------------------------------- */
268
269
270 /* queries */
271
272 /* create search object */
273 ZOOM_API(ZOOM_query)
274 ZOOM_query_create(void);
275 /* destroy it */
276 ZOOM_API(void)
277 ZOOM_query_destroy(ZOOM_query s);
278 /* CQL */
279 ZOOM_API(int)
280 ZOOM_query_cql(ZOOM_query s, const char *str);
281 /* CQL translated client-side into RPN: `conn' is optional for diagnostics */
282 ZOOM_API(int)
283 ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn);
284 /* CCL translated client-side into RPN: `conn' is optional for diagnostics */
285 ZOOM_API(int)
286 ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str,
287                    const char *config, 
288                    int *ccl_error, const char **error_string, int *error_pos);
289 /* PQF */
290 ZOOM_API(int)
291 ZOOM_query_prefix(ZOOM_query s, const char *str);
292 /* specify sort criteria for search */
293 ZOOM_API(int)
294 ZOOM_query_sortby(ZOOM_query s, const char *criteria);
295
296 ZOOM_API(void)
297 ZOOM_query_addref(ZOOM_query s);
298
299 /* ----------------------------------------------------------- */
300 /* scan */
301 ZOOM_API(ZOOM_scanset)
302 ZOOM_connection_scan(ZOOM_connection c, const char *startterm);
303
304 ZOOM_API(ZOOM_scanset)
305 ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query startterm);
306
307 ZOOM_API(const char *)
308 ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
309                   size_t *occ, size_t *len);
310
311 ZOOM_API(const char *)
312 ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
313                           size_t *occ, size_t *len);
314
315 ZOOM_API(size_t)
316 ZOOM_scanset_size(ZOOM_scanset scan);
317
318 ZOOM_API(void)
319 ZOOM_scanset_destroy(ZOOM_scanset scan);
320
321 ZOOM_API(const char *)
322 ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key);
323
324 ZOOM_API(void)
325 ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
326                             const char *val);
327 /* ----------------------------------------------------------- */
328 /* Extended Services Packages */
329
330 ZOOM_API(ZOOM_package)
331 ZOOM_connection_package(ZOOM_connection c, ZOOM_options options);
332
333 ZOOM_API(void)
334 ZOOM_package_destroy(ZOOM_package p);
335
336 ZOOM_API(void)
337 ZOOM_package_send(ZOOM_package p, const char *type);
338
339 ZOOM_API(const char *)
340 ZOOM_package_option_get(ZOOM_package p, const char *key);
341
342 ZOOM_API(const char *)
343 ZOOM_package_option_getl(ZOOM_package p, const char *key, int *lenp);
344
345 ZOOM_API(void)
346 ZOOM_package_option_set(ZOOM_package p, const char *key,
347                         const char *val);
348
349 ZOOM_API(void)
350 ZOOM_package_option_setl(ZOOM_package p, const char *key,
351                          const char *val, int len);
352
353 /* ----------------------------------------------------------- */
354 /* Sort.  First function is deprecated, use second instead */
355 ZOOM_API(void)
356 ZOOM_resultset_sort(ZOOM_resultset r,
357                     const char *sort_type, const char *sort_spec);
358 ZOOM_API(int)
359 ZOOM_resultset_sort1(ZOOM_resultset r,
360                      const char *sort_type, const char *sort_spec);
361
362 /* ----------------------------------------------------------- */
363 /* options */
364
365 ZOOM_API(ZOOM_options_callback)
366 ZOOM_options_set_callback(ZOOM_options opt,
367                           ZOOM_options_callback c, void *handle);
368 ZOOM_API(ZOOM_options)
369 ZOOM_options_create(void);
370
371 ZOOM_API(ZOOM_options)
372 ZOOM_options_create_with_parent(ZOOM_options parent);
373
374 ZOOM_API(ZOOM_options)
375 ZOOM_options_create_with_parent2(ZOOM_options parent1,
376                                  ZOOM_options parent2);
377
378 ZOOM_API(ZOOM_options)
379 ZOOM_options_dup(ZOOM_options src);
380
381 ZOOM_API(const char *)
382 ZOOM_options_get(ZOOM_options opt, const char *name);
383
384 ZOOM_API(const char *)
385 ZOOM_options_getl(ZOOM_options opt, const char *name, int *lenp);
386
387 ZOOM_API(void)
388 ZOOM_options_set(ZOOM_options opt, const char *name, const char *v);
389     
390 ZOOM_API(void)
391 ZOOM_options_setl(ZOOM_options opt, const char *name, const char *value,
392                   int len);
393
394 ZOOM_API(void)
395 ZOOM_options_destroy(ZOOM_options opt);
396
397 ZOOM_API(int)
398 ZOOM_options_get_bool(ZOOM_options opt, const char *name, int defa);
399
400 ZOOM_API(int)
401 ZOOM_options_get_int(ZOOM_options opt, const char *name, int defa);
402
403 ZOOM_API(void)
404 ZOOM_options_set_int(ZOOM_options opt, const char *name, int value);
405
406 /** \brief select/poll socket mask: read */
407 #define ZOOM_SELECT_READ 1
408 /** \brief select/poll socket mask: write */
409 #define ZOOM_SELECT_WRITE 2
410 /** \brief select/poll socket mask: except */
411 #define ZOOM_SELECT_EXCEPT 4
412
413 /** \brief wait for events on connection(s) (BLOCKING)
414     \param no number of connections (size of cs)
415     \param cs connection array
416     \retval 0 no event was fired
417     \retval >0 event was fired for connection at (retval-1)
418     
419     blocking poll for events on a number of connections. Returns positive
420     integer if event occurred ; zero if none occurred and no more
421     events are pending. The positive integer specifies the
422     connection for which the event occurred.
423 */
424 ZOOM_API(int)
425 ZOOM_event(int no, ZOOM_connection *cs);
426
427
428 /** \brief determines if connection is idle (no active or pending work)
429     \param c connection
430     \retval 1 is idle
431     \retval 0 is non-idle (active)
432 */
433 ZOOM_API(int)
434 ZOOM_connection_is_idle(ZOOM_connection c);
435
436
437 /** \brief process one event for one of connections given
438     \param no number of connections (size of cs)
439     \param cs connection array
440     \retval 0 no event was processed
441     \retval >0 event was processed for connection at (retval-1)
442
443     This function attemps to deal with outstandings events in a non-blocking
444     mode. If no events was processed (return value of 0),  then the system
445     should attempt to deal with sockets in blocking mode using socket
446     select/poll which means calling the following functions:
447     ZOOM_connection_get_socket, ZOOM_connection_get_mask,
448     ZOOM_connection_get_timeout.
449 */
450 ZOOM_API(int)
451 ZOOM_event_nonblock(int no, ZOOM_connection *cs);
452
453
454 /** \brief process one event for connection
455     \param c connection
456     \retval 0 no event was processed
457     \retval 1 event was processed for connection
458
459     This function attemps to deal with outstandings events in 
460     a non-blocking fashion. If no event was processed (return value of 0),
461     then the system should attempt to deal with sockets in blocking mode
462     using socket select/poll which means calling the following functions:
463     ZOOM_connection_get_socket, ZOOM_connection_get_mask,
464     ZOOM_connection_get_timeout. If an event was processed call this
465     function again.
466 */
467 ZOOM_API(int)
468 ZOOM_connection_process(ZOOM_connection c);
469
470
471 /** \brief executes non-blocking tasks for connection
472     \param c connection
473     \retval 0 no task was executed
474     \retval 1 task was executed (but probably not completed)
475
476     This function, unlike, ZOOM_connection_process, does not try to
477     return any events (and remove them). But events may be generated
478     from it. These are saved and may later be retrieved with
479     ZOOM_connection_process and ZOOM_connection_last_event .
480 */
481 ZOOM_API(int)
482 ZOOM_connection_exec_task(ZOOM_connection c);
483
484
485 /** \brief get socket fd for ZOOM connection
486     \param c connection
487     \retval -1 no socket assigned for connection
488     \retval >=0 socket for connection
489
490     Use this function when preparing for socket/poll and
491     in conjunction with ZOOM_connection_get_mask.
492 */
493 ZOOM_API(int)
494 ZOOM_connection_get_socket(ZOOM_connection c);
495
496
497 /** \brief get socket mask for connection 
498     \param c connection
499     \returns mask for connection (possibly 0)
500
501     Use this function when preparing for socket select/poll and
502     in conjunction with ZOOM_connection_get_socket.
503 */
504 ZOOM_API(int)
505 ZOOM_connection_get_mask(ZOOM_connection c);
506
507
508 /** \brief set socket mask for connection (DO NOT call outside zoom) */
509 ZOOM_API(int)
510 ZOOM_connection_set_mask(ZOOM_connection c, int mask);
511
512
513 /** \brief get timeout in seconds for ZOOM connection
514     \param c connection
515     \returns timeout value in seconds
516
517     Use this function when preparing for socket/poll and
518     in conjunction with ZOOM_connection_get_socket.
519 */
520 ZOOM_API(int)
521 ZOOM_connection_get_timeout(ZOOM_connection c);
522
523
524 /** \brief fire socket event timeout
525     \param c connection
526     \retval 0 event was fired OK
527     \retval -1 event was not fired
528
529     Call this function when a timeout occurs - for example in the
530     case of select(2) returning 0.
531 */
532 ZOOM_API(int)
533 ZOOM_connection_fire_event_timeout(ZOOM_connection c);
534
535
536 /** \brief fire socket event activity (read,write,except)
537     \param c connection
538     \param mask or'ed mask of ZOOM_SELECT_.. values
539     \retval 0 event was fired OK
540     \retval -1 event was not fired
541 */
542 ZOOM_API(int)
543 ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask);
544
545
546 /** \brief peek at next event
547     \param c connection
548     \returns ZOOM_EVENT_NONE (for no events in queue), ZOOM_EVENT_CONNECT, ..
549
550     Does not actually remove the event from the event queue. ZOOM_event and
551     ZOOM_process_event removes one event.
552 */
553
554 ZOOM_API(int)
555 ZOOM_connection_peek_event(ZOOM_connection c);
556
557 ZOOM_API(const char *)
558 ZOOM_get_event_str(int event);
559
560 ZOOM_END_CDECL
561
562 /*
563  * Local variables:
564  * c-basic-offset: 4
565  * c-file-style: "Stroustrup"
566  * indent-tabs-mode: nil
567  * End:
568  * vim: shiftwidth=4 tabstop=8 expandtab
569  */
570