From 82aa6fe37332e0b2a79a14f3d50c3c9f54034817 Mon Sep 17 00:00:00 2001 From: Adam Dickmeiss Date: Wed, 21 Mar 2007 11:27:46 +0000 Subject: [PATCH] Revert ZOOM API changes. --- NEWS | 9 +-- include/yaz/zoom.h | 219 +++++++++++++++++++++++++--------------------------- src/zoom-c.c | 36 +++++---- zoom/zoomsh.c | 4 +- zoom/zoomtst7.c | 4 +- zoom/zoomtst8.c | 4 +- 6 files changed, 132 insertions(+), 144 deletions(-) diff --git a/NEWS b/NEWS index f3bf309..e502777 100644 --- a/NEWS +++ b/NEWS @@ -6,17 +6,10 @@ yaz_iconv(cd, 0, 0, &outbut, &outbytesleft) . Definition of wrbuf_diags moved to querytowrbuf.h. Function wrbuf_put_zquery removed, because function yaz_query_to_wrbuf does the same. -API changes to ZOOM. Functions for setting options returns int, rather -than void, so we have a way to flag unknown options. ZOOM_resultset_sort1 -has become "the" ZOOM_resultset_sort. (and old ZOOM_resultset_sort is removed). -ZOOM_connection_scan1 removed. The generic scan is ZOOM_connection_scan -and the ZOOM_connection_scan_pqf is a handy short-hand taking a PQF string -as argument. - API changes to WRBUF. wrbuf_free removed; replaced by wrbuf_destroy. And wrbuf_puts no longer appends '\0'. Use wrbuf_cstr to get C-string out. -Deprecated functions for yaz_marc-removed. +Deprecated MARC utility functions removed. Changed prototype of yaz_marc_decode_buf: const char for result and size_t for rsize. diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index aceda93..4e09e00 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -24,7 +24,7 @@ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -/* $Id: zoom.h,v 1.45 2007-03-19 20:58:34 adam Exp $ */ +/* $Id: zoom.h,v 1.46 2007-03-21 11:27:46 adam Exp $ */ /** * \file zoom.h @@ -64,62 +64,63 @@ typedef const char *(*ZOOM_options_callback)(void *handle, const char *name); /* create connection, connect to host, if portnum is 0, then port is read from host string (e.g. myhost:9821) */ ZOOM_API(ZOOM_connection) - ZOOM_connection_new(const char *host, int portnum); - +ZOOM_connection_new (const char *host, int portnum); + /* create connection, don't connect, apply options */ ZOOM_API(ZOOM_connection) - ZOOM_connection_create(ZOOM_options options); +ZOOM_connection_create (ZOOM_options options); /* connect given existing connection */ ZOOM_API(void) - ZOOM_connection_connect(ZOOM_connection c, const char *host, int portnum); +ZOOM_connection_connect(ZOOM_connection c, const char *host, + int portnum); /* destroy connection (close connection also) */ ZOOM_API(void) - ZOOM_connection_destroy(ZOOM_connection c); +ZOOM_connection_destroy (ZOOM_connection c); /* get/set option for connection */ ZOOM_API(const char *) - ZOOM_connection_option_get(ZOOM_connection c, const char *key); +ZOOM_connection_option_get (ZOOM_connection c, const char *key); ZOOM_API(const char *) - ZOOM_connection_option_getl(ZOOM_connection c, const char *key, int *lenp); +ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp); -ZOOM_API(int) - ZOOM_connection_option_set(ZOOM_connection c, const char *key, - const char *val); +ZOOM_API(void) +ZOOM_connection_option_set (ZOOM_connection c, const char *key, + const char *val); -ZOOM_API(int) - ZOOM_connection_option_setl(ZOOM_connection c, const char *key, - const char *val, int len); +ZOOM_API(void) +ZOOM_connection_option_setl (ZOOM_connection c, const char *key, + const char *val, int len); /* return error code (0 == success, failure otherwise). cp holds error string on failure, addinfo holds addititional info (if any) */ ZOOM_API(int) - ZOOM_connection_error(ZOOM_connection c, const char **cp, - const char **addinfo); +ZOOM_connection_error (ZOOM_connection c, const char **cp, + const char **addinfo); ZOOM_API(int) - ZOOM_connection_error_x(ZOOM_connection c, const char **cp, - const char **addinfo, const char **diagset); +ZOOM_connection_error_x (ZOOM_connection c, const char **cp, + const char **addinfo, const char **diagset); /* returns error code */ ZOOM_API(int) - ZOOM_connection_errcode(ZOOM_connection c); +ZOOM_connection_errcode (ZOOM_connection c); /* returns error message */ ZOOM_API(const char *) - ZOOM_connection_errmsg(ZOOM_connection c); +ZOOM_connection_errmsg (ZOOM_connection c); /* returns additional info */ ZOOM_API(const char *) - ZOOM_connection_addinfo(ZOOM_connection c); +ZOOM_connection_addinfo (ZOOM_connection c); /* returns diagnostic set */ ZOOM_API(const char *) - ZOOM_connection_diagset(ZOOM_connection c); +ZOOM_connection_diagset (ZOOM_connection c); /* translates error code into human-readable string */ ZOOM_API(const char *) - ZOOM_diag_str(int error); - +ZOOM_diag_str (int error); + #define ZOOM_ERROR_NONE 0 #define ZOOM_ERROR_CONNECT 10000 #define ZOOM_ERROR_MEMORY 10001 @@ -138,7 +139,7 @@ ZOOM_API(const char *) #define ZOOM_ERROR_CCL_PARSE 10014 ZOOM_API(int) - ZOOM_connection_last_event(ZOOM_connection cs); +ZOOM_connection_last_event(ZOOM_connection cs); #define ZOOM_EVENT_NONE 0 #define ZOOM_EVENT_CONNECT 1 @@ -157,60 +158,57 @@ ZOOM_API(int) /* create result set given a search */ ZOOM_API(ZOOM_resultset) - ZOOM_connection_search(ZOOM_connection, ZOOM_query q); +ZOOM_connection_search(ZOOM_connection, ZOOM_query q); /* create result set given PQF query */ ZOOM_API(ZOOM_resultset) - ZOOM_connection_search_pqf(ZOOM_connection c, const char *q); - +ZOOM_connection_search_pqf(ZOOM_connection c, const char *q); + /* destroy result set */ ZOOM_API(void) - ZOOM_resultset_destroy(ZOOM_resultset r); - +ZOOM_resultset_destroy(ZOOM_resultset r); + /* result set option */ ZOOM_API(const char *) - ZOOM_resultset_option_get(ZOOM_resultset r, const char *key); - -/* get option from result set */ -ZOOM_API(int) - ZOOM_resultset_option_set(ZOOM_resultset r, const char *key, - const char *val); - +ZOOM_resultset_option_get (ZOOM_resultset r, const char *key); +ZOOM_API(void) +ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val); + /* return size of result set (alias hit count AKA result count) */ ZOOM_API(size_t) - ZOOM_resultset_size(ZOOM_resultset r); - +ZOOM_resultset_size (ZOOM_resultset r); + /* retrieve records */ ZOOM_API(void) - ZOOM_resultset_records(ZOOM_resultset r, ZOOM_record *recs, - size_t start, size_t count); - +ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs, + size_t start, size_t count); + /* return record object at pos. Returns 0 if unavailable */ ZOOM_API(ZOOM_record) - ZOOM_resultset_record(ZOOM_resultset s, size_t pos); - +ZOOM_resultset_record (ZOOM_resultset s, size_t pos); + /* like ZOOM_resultset_record - but never blocks .. */ ZOOM_API(ZOOM_record) - ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos); - +ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos); + /* reset record cache for result set */ ZOOM_API(void) - ZOOM_resultset_cache_reset(ZOOM_resultset r); - +ZOOM_resultset_cache_reset(ZOOM_resultset r); + /* ----------------------------------------------------------- */ /* records */ /* get record information, in a form given by type */ ZOOM_API(const char *) - ZOOM_record_get(ZOOM_record rec, const char *type, int *len); - +ZOOM_record_get (ZOOM_record rec, const char *type, int *len); + /* destroy record */ ZOOM_API(void) - ZOOM_record_destroy(ZOOM_record rec); +ZOOM_record_destroy (ZOOM_record rec); /* return copy of record */ ZOOM_API(ZOOM_record) - ZOOM_record_clone(ZOOM_record srec); - +ZOOM_record_clone (ZOOM_record srec); + /* return error info (surrogate diagnostic) for record */ ZOOM_API(int) ZOOM_record_error(ZOOM_record rec, const char **msg, @@ -221,130 +219,125 @@ ZOOM_API(int) /* create search object */ ZOOM_API(ZOOM_query) - ZOOM_query_create(void); +ZOOM_query_create(void); /* destroy it */ ZOOM_API(void) - ZOOM_query_destroy(ZOOM_query s); +ZOOM_query_destroy(ZOOM_query s); /* CQL */ ZOOM_API(int) - ZOOM_query_cql(ZOOM_query s, const char *str); +ZOOM_query_cql(ZOOM_query s, const char *str); /* CQL translated client-side into RPN: `conn' is optional for diagnostics */ ZOOM_API(int) - ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn); +ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn); /* CCL translated client-side into RPN: `conn' is optional for diagnostics */ ZOOM_API(int) - ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str, - const char *config, - int *ccl_error, const char **error_string, - int *error_pos); +ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str, + const char *config, + int *ccl_error, const char **error_string, int *error_pos); /* PQF */ ZOOM_API(int) - ZOOM_query_prefix(ZOOM_query s, const char *str); +ZOOM_query_prefix(ZOOM_query s, const char *str); /* specify sort criteria for search */ ZOOM_API(int) - ZOOM_query_sortby(ZOOM_query s, const char *criteria); - +ZOOM_query_sortby(ZOOM_query s, const char *criteria); + /* ----------------------------------------------------------- */ /* scan */ ZOOM_API(ZOOM_scanset) - ZOOM_connection_scan_pqf(ZOOM_connection c, const char *startterm); - -/* scan wtih ZOOM_query start term */ +ZOOM_connection_scan (ZOOM_connection c, const char *startterm); + ZOOM_API(ZOOM_scanset) - ZOOM_connection_scan(ZOOM_connection c, ZOOM_query startterm); - -/* get scan term */ +ZOOM_connection_scan1 (ZOOM_connection c, ZOOM_query startterm); + ZOOM_API(const char *) - ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, - int *occ, int *len); - -/* get display scan term */ +ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, + int *occ, int *len); + ZOOM_API(const char *) - ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos, - int *occ, int *len); - -/* get size of scan set */ +ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos, + int *occ, int *len); + ZOOM_API(size_t) - ZOOM_scanset_size(ZOOM_scanset scan); - -/* destory scan set */ +ZOOM_scanset_size(ZOOM_scanset scan); + ZOOM_API(void) -ZOOM_scanset_destroy(ZOOM_scanset scan); +ZOOM_scanset_destroy (ZOOM_scanset scan); -/* get scan set option */ ZOOM_API(const char *) - ZOOM_scanset_option_get(ZOOM_scanset scan, const char *key); + ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key); -/* set scan set option */ -ZOOM_API(int) - ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key, - const char *val); +ZOOM_API(void) + ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key, + const char *val); /* ----------------------------------------------------------- */ /* Extended Services Packages */ ZOOM_API(ZOOM_package) - ZOOM_connection_package(ZOOM_connection c, ZOOM_options options); + ZOOM_connection_package (ZOOM_connection c, ZOOM_options options); ZOOM_API(void) ZOOM_package_destroy(ZOOM_package p); ZOOM_API(void) - ZOOM_package_send(ZOOM_package p, const char *type); + ZOOM_package_send (ZOOM_package p, const char *type); ZOOM_API(const char *) - ZOOM_package_option_get(ZOOM_package p, const char *key); + ZOOM_package_option_get (ZOOM_package p, const char *key); -ZOOM_API(int) - ZOOM_package_option_set(ZOOM_package p, const char *key, - const char *val); +ZOOM_API(void) + ZOOM_package_option_set (ZOOM_package p, const char *key, + const char *val); /* ----------------------------------------------------------- */ -/* Sort. */ -ZOOM_API(int) +/* Sort. First function is deprecated, use second instead */ +ZOOM_API(void) ZOOM_resultset_sort(ZOOM_resultset r, const char *sort_type, const char *sort_spec); +ZOOM_API(int) + ZOOM_resultset_sort1(ZOOM_resultset r, + const char *sort_type, const char *sort_spec); /* ----------------------------------------------------------- */ /* options */ ZOOM_API(ZOOM_options_callback) - ZOOM_options_set_callback(ZOOM_options opt, + ZOOM_options_set_callback (ZOOM_options opt, ZOOM_options_callback c, void *handle); ZOOM_API(ZOOM_options) - ZOOM_options_create(void); +ZOOM_options_create (void); ZOOM_API(ZOOM_options) - ZOOM_options_create_with_parent(ZOOM_options parent); +ZOOM_options_create_with_parent (ZOOM_options parent); ZOOM_API(ZOOM_options) - ZOOM_options_create_with_parent2(ZOOM_options parent1, - ZOOM_options parent2); + ZOOM_options_create_with_parent2 (ZOOM_options parent1, + ZOOM_options parent2); ZOOM_API(const char *) - ZOOM_options_get(ZOOM_options opt, const char *name); +ZOOM_options_get (ZOOM_options opt, const char *name); ZOOM_API(const char *) - ZOOM_options_getl(ZOOM_options opt, const char *name, int *lenp); +ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp); ZOOM_API(void) - ZOOM_options_set(ZOOM_options opt, const char *name, const char *v); +ZOOM_options_set (ZOOM_options opt, const char *name, const char *v); ZOOM_API(void) - ZOOM_options_setl(ZOOM_options opt, const char *name, const char *value, - int len); +ZOOM_options_setl (ZOOM_options opt, const char *name, const char *value, + int len); ZOOM_API(void) - ZOOM_options_destroy(ZOOM_options opt); +ZOOM_options_destroy (ZOOM_options opt); ZOOM_API(int) - ZOOM_options_get_bool(ZOOM_options opt, const char *name, int defa); +ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa); ZOOM_API(int) - ZOOM_options_get_int(ZOOM_options opt, const char *name, int defa); +ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa); ZOOM_API(void) - ZOOM_options_set_int(ZOOM_options opt, const char *name, int value); +ZOOM_options_set_int(ZOOM_options opt, const char *name, int value); /** \brief select/poll socket mask: read */ #define ZOOM_SELECT_READ 1 @@ -365,8 +358,8 @@ ZOOM_API(void) connection for which the event occurred. */ ZOOM_API(int) - ZOOM_event(int no, ZOOM_connection *cs); - +ZOOM_event (int no, ZOOM_connection *cs); + /** \brief determines if connection is idle (no active or pending work) \param c connection @@ -374,7 +367,7 @@ ZOOM_API(int) \retval 0 is non-idle (active) */ ZOOM_API(int) - ZOOM_connection_is_idle(ZOOM_connection c); +ZOOM_connection_is_idle(ZOOM_connection c); /** \brief process one event for one of connections given diff --git a/src/zoom-c.c b/src/zoom-c.c index 5ba1b32..bf4beb0 100644 --- a/src/zoom-c.c +++ b/src/zoom-c.c @@ -2,7 +2,7 @@ * Copyright (C) 1995-2007, Index Data ApS * See the file LICENSE for details. * - * $Id: zoom-c.c,v 1.121 2007-03-21 10:22:31 adam Exp $ + * $Id: zoom-c.c,v 1.122 2007-03-21 11:27:46 adam Exp $ */ /** * \file zoom-c.c @@ -853,9 +853,16 @@ ZOOM_API(ZOOM_resultset) return r; } -ZOOM_API(int) +ZOOM_API(void) ZOOM_resultset_sort(ZOOM_resultset r, - const char *sort_type, const char *sort_spec) + const char *sort_type, const char *sort_spec) +{ + (void) ZOOM_resultset_sort(r, sort_type, sort_spec); +} + +ZOOM_API(int) + ZOOM_resultset_sort1(ZOOM_resultset r, + const char *sort_type, const char *sort_spec) { ZOOM_connection c = r->connection; ZOOM_task task; @@ -1284,7 +1291,7 @@ static zoom_ret ZOOM_connection_send_init(ZOOM_connection c) odr_prepend(c->odr_out, "ZOOM-C", ireq->implementationName)); - version = odr_strdup(c->odr_out, "$Revision: 1.121 $"); + version = odr_strdup(c->odr_out, "$Revision: 1.122 $"); if (strlen(version) > 10) /* check for unexpanded CVS strings */ version[strlen(version)-2] = '\0'; ireq->implementationVersion = @@ -2628,21 +2635,21 @@ static zoom_ret send_present(ZOOM_connection c) } ZOOM_API(ZOOM_scanset) - ZOOM_connection_scan_pqf(ZOOM_connection c, const char *start) + ZOOM_connection_scan(ZOOM_connection c, const char *start) { ZOOM_scanset s; ZOOM_query q = ZOOM_query_create(); ZOOM_query_prefix(q, start); - s = ZOOM_connection_scan(c, q); + s = ZOOM_connection_scan1(c, q); ZOOM_query_destroy(q); return s; } ZOOM_API(ZOOM_scanset) - ZOOM_connection_scan(ZOOM_connection c, ZOOM_query q) + ZOOM_connection_scan1(ZOOM_connection c, ZOOM_query q) { char *start; char *freeme = 0; @@ -2842,12 +2849,11 @@ ZOOM_API(const char *) return ZOOM_options_get(scan->options, key); } -ZOOM_API(int) +ZOOM_API(void) ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key, const char *val) { ZOOM_options_set(scan->options, key, val); - return 0; } static Z_APDU *create_es_package(ZOOM_package p, int type) @@ -3299,12 +3305,11 @@ ZOOM_API(const char *) } -ZOOM_API(int) +ZOOM_API(void) ZOOM_package_option_set(ZOOM_package p, const char *key, const char *val) { ZOOM_options_set(p->options, key, val); - return 0; } static int ZOOM_connection_exec_task(ZOOM_connection c) @@ -3868,20 +3873,18 @@ ZOOM_API(const char *) return ZOOM_options_getl(c->options, key, lenp); } -ZOOM_API(int) +ZOOM_API(void) ZOOM_connection_option_set(ZOOM_connection c, const char *key, const char *val) { ZOOM_options_set(c->options, key, val); - return 0; } -ZOOM_API(int) +ZOOM_API(void) ZOOM_connection_option_setl(ZOOM_connection c, const char *key, const char *val, int len) { ZOOM_options_setl(c->options, key, val, len); - return 0; } ZOOM_API(const char *) @@ -3890,12 +3893,11 @@ ZOOM_API(const char *) return ZOOM_options_get(r->options, key); } -ZOOM_API(int) +ZOOM_API(void) ZOOM_resultset_option_set(ZOOM_resultset r, const char *key, const char *val) { ZOOM_options_set(r->options, key, val); - return 0; } diff --git a/zoom/zoomsh.c b/zoom/zoomsh.c index 11b5698..25b220e 100644 --- a/zoom/zoomsh.c +++ b/zoom/zoomsh.c @@ -2,7 +2,7 @@ * Copyright (C) 1995-2007, Index Data ApS * See the file LICENSE for details. * - * $Id: zoomsh.c,v 1.44 2007-03-19 20:58:34 adam Exp $ + * $Id: zoomsh.c,v 1.45 2007-03-21 11:27:47 adam Exp $ */ /** \file zoomsh.c @@ -393,7 +393,7 @@ static void cmd_scan (ZOOM_connection *c, ZOOM_resultset *r, for (i = 0; i 0) while (ZOOM_event (1, &z)) ; diff --git a/zoom/zoomtst8.c b/zoom/zoomtst8.c index ed9ff68..40c8f90 100644 --- a/zoom/zoomtst8.c +++ b/zoom/zoomtst8.c @@ -1,4 +1,4 @@ -/* $Id: zoomtst8.c,v 1.7 2007-03-19 20:58:34 adam Exp $ */ +/* $Id: zoomtst8.c,v 1.8 2007-03-21 11:27:47 adam Exp $ */ /** \file zoomtst8.c \brief Asynchronous multi-target client doing scan @@ -47,7 +47,7 @@ int main(int argc, char **argv) /* set number of scan terms to be returned. */ ZOOM_connection_option_set (z[i], "number", "7"); /* and perform scan */ - s[i] = ZOOM_connection_scan_pqf(z[i], argv[argc-1]); + s[i] = ZOOM_connection_scan(z[i], argv[argc-1]); } /* network I/O. pass number of connections and array of connections */ -- 1.7.10.4