X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=ZOOM.xs;h=7c6e25775a6c20397afe2be5d567e9cfad0cdcdd;hb=6d4a7babf3cfb31a824e745f9641887534248247;hp=b5e27a16e330e33cb795fa19de6803b4eb3d3eda;hpb=1a19d07900d504bc0af3c43c4246b101b3701bc3;p=ZOOM-Perl-moved-to-github.git diff --git a/ZOOM.xs b/ZOOM.xs index b5e27a1..7c6e257 100644 --- a/ZOOM.xs +++ b/ZOOM.xs @@ -1,10 +1,77 @@ -/* $Id: ZOOM.xs,v 1.11 2005-10-13 13:30:52 mike Exp $ */ +/* $Id: ZOOM.xs,v 1.17 2005-10-26 16:27:25 mike Exp $ */ #include "EXTERN.h" #include "perl.h" #include "XSUB.h" #include +#include + +/* Used by the *_setl() functions */ +typedef char opaquechar; + +/* Used as the return value of the *_getl() functions */ +struct datachunk { + char *data; + int len; +}; + +/* Used to package Perl function-pointer and user-data together */ +struct callback_block { + SV *function; + SV *handle; +}; + +/* The callback function used for ZOOM_options_set_callback(). I do + * not claim to fully understand all the stack-hacking magic, and less + * still the reference-counting/mortality stuff. Accordingly, the + * memory management here is best characterised as What I Could Get To + * Work, More Or Less. + */ +const char *__ZOOM_option_callback (void *handle, const char *name) +{ + struct callback_block *cb = (struct callback_block*) handle; + int count; + SV *ret; + char *s; + char *res; + + dSP; + + ENTER; + SAVETMPS; + + PUSHMARK(SP); + XPUSHs(cb->handle); + XPUSHs(sv_2mortal(newSVpv(name, 0))); + PUTBACK; + /* Perl_sv_dump(0, cb->function); */ + + count = call_sv(cb->function, G_SCALAR); + + SPAGAIN; + + if (count != 1) + croak("callback function for ZOOM_options_get() returned %d values: should have returned exactly one", count); + + ret = POPs; + if (SvPOK(ret)) { + s = SvPV_nolen(ret); + /* ### `res' never gets freed! I think it is + * impossible to solve this problem "correctly" + * because the ZOOM-C option callback interface is + * inadequate. */ + res = xstrdup(s); + } else { + res = 0; + } + + PUTBACK; + FREETMPS; + LEAVE; + + return res; +} MODULE = Net::Z3950::ZOOM PACKAGE = Net::Z3950::ZOOM PREFIX=ZOOM_ @@ -12,30 +79,23 @@ MODULE = Net::Z3950::ZOOM PACKAGE = Net::Z3950::ZOOM PREFIX=ZOOM_ PROTOTYPES: ENABLE -# It seems that when one of these functions is called from Perl with -# a string-constant argument, that is not recognised as suitable to -# be mapped onto a "const char*" argument. The only fix I can find is -# to delete as the "const" qualifiers from "char*" arguments: -# overriding the auto-generated prototyping with PROTOTYPE: $$ -# doesn't help (and indeed seems to make no difference at all). -# # TESTED ZOOM_connection ZOOM_connection_new(host, portnum) - char* host + const char* host int portnum # TESTED ZOOM_connection ZOOM_connection_create(options) - ZOOM_options options + ZOOM_options options # TESTED void ZOOM_connection_connect(c, host, portnum) ZOOM_connection c - const char * host - int portnum + const char* host + int portnum # TESTED void @@ -49,18 +109,38 @@ ZOOM_connection_option_get(c, key) const char *key # TESTED +struct datachunk +ZOOM_connection_option_getl(c, key, len) + ZOOM_connection c + const char* key + int &len + CODE: + RETVAL.data = (char*) ZOOM_connection_option_getl(c, key, &len); + RETVAL.len = len; + OUTPUT: + RETVAL + len + +# TESTED void ZOOM_connection_option_set(c, key, val) ZOOM_connection c const char *key const char *val +# In ZOOM-C, the `val' parameter is const char*. However, our typemap +# treats this as T_PV, i.e. it's "known" that it points to a +# NUL-terminated string. Instead, then, I here use opaquechar*, which +# is an opaque pointer. The underlying C function can then use this +# along with `len' to Do The Right Thing. +# +# TESTED void ZOOM_connection_option_setl(c, key, val, len) ZOOM_connection c - const char * key - const char * val - int len + const char* key + opaquechar* val + int len # The reference parameters, `cp' and `addinfo', need to already have # values when this function is called, otherwise an "uninitialised @@ -90,21 +170,37 @@ ZOOM_connection_error(c, cp, addinfo) cp addinfo +# See comments for ZOOM_connection_error() above +# TESTED int ZOOM_connection_error_x(c, cp, addinfo, diagset) ZOOM_connection c - const char ** cp - const char ** addinfo - const char ** diagset + const char * &cp + const char * &addinfo + const char * &diagset + CODE: + const char *ccp, *caddinfo, *cdset; + RETVAL = ZOOM_connection_error_x(c, &ccp, &caddinfo, &cdset); + cp = (char*) ccp; + addinfo = (char*) caddinfo; + diagset = (char*) cdset; + OUTPUT: + RETVAL + cp + addinfo + diagset +# TESTED int ZOOM_connection_errcode(c) ZOOM_connection c +# TESTED const char * ZOOM_connection_errmsg(c) ZOOM_connection c +# TESTED const char * ZOOM_connection_addinfo(c) ZOOM_connection c @@ -112,35 +208,37 @@ ZOOM_connection_addinfo(c) # TESTED const char * ZOOM_diag_str(error) - int error + int error +# UNTESTED int ZOOM_connection_last_event(cs) ZOOM_connection cs +# TESTED ZOOM_resultset ZOOM_connection_search(arg0, q) ZOOM_connection arg0 - ZOOM_query q + ZOOM_query q -# "const" discarded from type of `q' -# # TESTED ZOOM_resultset ZOOM_connection_search_pqf(c, q) ZOOM_connection c - char *q + const char *q # TESTED void ZOOM_resultset_destroy(r) ZOOM_resultset r +# UNTESTED const char * ZOOM_resultset_option_get(r, key) ZOOM_resultset r const char * key +# UNTESTED void ZOOM_resultset_option_set(r, key, val) ZOOM_resultset r @@ -152,6 +250,7 @@ size_t ZOOM_resultset_size(r) ZOOM_resultset r +# UNTESTED void ZOOM_resultset_records(r, recs, start, count) ZOOM_resultset r @@ -162,66 +261,77 @@ ZOOM_resultset_records(r, recs, start, count) # TESTED ZOOM_record ZOOM_resultset_record(s, pos) - ZOOM_resultset s - size_t pos + ZOOM_resultset s + size_t pos +# UNTESTED ZOOM_record ZOOM_resultset_record_immediate(s, pos) ZOOM_resultset s size_t pos +# UNTESTED void ZOOM_resultset_cache_reset(r) ZOOM_resultset r -# "const" discarded from type of `type' # See "typemap" for discussion of the "const char *" return-type. # # TESTED +### but should use datachunk for in some (not all!) cases. const char * ZOOM_record_get(rec, type, len) ZOOM_record rec - char* type + const char* type int &len OUTPUT: RETVAL len +# UNTESTED void ZOOM_record_destroy(rec) ZOOM_record rec +# UNTESTED ZOOM_record ZOOM_record_clone(srec) ZOOM_record srec +# TESTED ZOOM_query ZOOM_query_create() +# TESTED void ZOOM_query_destroy(s) - ZOOM_query s + ZOOM_query s +# TESTED int ZOOM_query_cql(s, str) - ZOOM_query s - const char * str + ZOOM_query s + const char* str +# TESTED int ZOOM_query_prefix(s, str) - ZOOM_query s - const char * str + ZOOM_query s + const char* str +# TESTED int ZOOM_query_sortby(s, criteria) ZOOM_query s const char * criteria +# UNTESTED ZOOM_scanset ZOOM_connection_scan(c, startterm) ZOOM_connection c const char * startterm +# UNTESTED const char * ZOOM_scanset_term(scan, pos, occ, len) ZOOM_scanset scan @@ -229,6 +339,7 @@ ZOOM_scanset_term(scan, pos, occ, len) int * occ int * len +# UNTESTED const char * ZOOM_scanset_display_term(scan, pos, occ, len) ZOOM_scanset scan @@ -236,115 +347,171 @@ ZOOM_scanset_display_term(scan, pos, occ, len) int * occ int * len +# UNTESTED size_t ZOOM_scanset_size(scan) ZOOM_scanset scan +# UNTESTED void ZOOM_scanset_destroy(scan) ZOOM_scanset scan +# UNTESTED const char * ZOOM_scanset_option_get(scan, key) ZOOM_scanset scan const char * key +# UNTESTED void ZOOM_scanset_option_set(scan, key, val) ZOOM_scanset scan const char * key const char * val +# UNTESTED ZOOM_package ZOOM_connection_package(c, options) ZOOM_connection c ZOOM_options options +# UNTESTED void ZOOM_package_destroy(p) ZOOM_package p +# UNTESTED void ZOOM_package_send(p, type) ZOOM_package p const char * type +# UNTESTED const char * ZOOM_package_option_get(p, key) ZOOM_package p const char * key +# UNTESTED void ZOOM_package_option_set(p, key, val) ZOOM_package p const char * key const char * val +# UNTESTED void ZOOM_resultset_sort(r, sort_type, sort_spec) ZOOM_resultset r const char * sort_type const char * sort_spec -ZOOM_options_callback -ZOOM_options_set_callback(opt, c, handle) - ZOOM_options opt - ZOOM_options_callback c - void * handle +# We ignore the return value of ZOOM_options_set_callback(), since it +# is always just the address of the __ZOOM_option_callback() function. +# The information that we actually want -- the address of the Perl +# function in the callback_block -- is unavailable to us, as the +# underlying C function doesn't give the block back. +# +# TESTED +void +ZOOM_options_set_callback(opt, function, handle) + ZOOM_options opt + SV* function; + SV* handle; + CODE: + /* The tiny amount of memory allocated here is never + * released, as options_destroy() doesn't do anything + * to the callback information. Not a big deal. + * Also, I have no idea how to drive the Perl "mortal" + * reference-counting stuff, so I am just allocating + * copies which also never get released. Don't sue! + */ + struct callback_block *block = (struct callback_block*) + xmalloc(sizeof *block); + block->function = function; + block->handle = handle; + SvREFCNT(block->function); + SvREFCNT(block->handle); + ZOOM_options_set_callback(opt, __ZOOM_option_callback, + (void*) block); -# TESTING +# TESTED ZOOM_options ZOOM_options_create() +# TESTED ZOOM_options ZOOM_options_create_with_parent(parent) - ZOOM_options parent + ZOOM_options parent +# TESTED ZOOM_options ZOOM_options_create_with_parent2(parent1, parent2) - ZOOM_options parent1 - ZOOM_options parent2 + ZOOM_options parent1 + ZOOM_options parent2 +# TESTED const char * ZOOM_options_get(opt, name) - ZOOM_options opt - const char * name + ZOOM_options opt + const char* name + +# TESTED +struct datachunk +ZOOM_options_getl(opt, name, len) + ZOOM_options opt + const char* name + int &len + CODE: + RETVAL.data = (char*) ZOOM_options_getl(opt, name, &len); + RETVAL.len = len; + OUTPUT: + RETVAL + len +# TESTED void ZOOM_options_set(opt, name, v) - ZOOM_options opt - const char * name - const char * v + ZOOM_options opt + const char* name + const char* v +# TESTED void ZOOM_options_setl(opt, name, value, len) - ZOOM_options opt - const char * name - const char * value - int len + ZOOM_options opt + const char* name + opaquechar* value + int len +# TESTED void ZOOM_options_destroy(opt) - ZOOM_options opt + ZOOM_options opt +# TESTED int ZOOM_options_get_bool(opt, name, defa) - ZOOM_options opt - const char * name - int defa + ZOOM_options opt + const char* name + int defa +# TESTED int ZOOM_options_get_int(opt, name, defa) - ZOOM_options opt - const char * name - int defa + ZOOM_options opt + const char* name + int defa +# TESTED void ZOOM_options_set_int(opt, name, value) - ZOOM_options opt - const char * name - int value + ZOOM_options opt + const char* name + int value +# UNTESTED int ZOOM_event(no, cs) int no