X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=ZOOM.xs;h=b5e27a16e330e33cb795fa19de6803b4eb3d3eda;hb=1a19d07900d504bc0af3c43c4246b101b3701bc3;hp=3f5d3af468bb5a37158f1cdd021278cef5e9d023;hpb=6e6b267c542d94f96018ae6da367192c858f97c6;p=ZOOM-Perl-moved-to-github.git diff --git a/ZOOM.xs b/ZOOM.xs index 3f5d3af..b5e27a1 100644 --- a/ZOOM.xs +++ b/ZOOM.xs @@ -1,3 +1,5 @@ +/* $Id: ZOOM.xs,v 1.11 2005-10-13 13:30:52 mike Exp $ */ + #include "EXTERN.h" #include "perl.h" #include "XSUB.h" @@ -5,40 +7,88 @@ #include -MODULE = ZOOM PACKAGE = ZOOM +MODULE = Net::Z3950::ZOOM PACKAGE = Net::Z3950::ZOOM PREFIX=ZOOM_ +PROTOTYPES: ENABLE -const char * -ZOOM_connection_addinfo(c) - ZOOM_connection c +# 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 + int portnum + +# TESTED +ZOOM_connection +ZOOM_connection_create(options) + ZOOM_options options + +# TESTED void ZOOM_connection_connect(c, host, portnum) ZOOM_connection c const char * host int portnum -ZOOM_connection -ZOOM_connection_create(options) - ZOOM_options options - +# TESTED void ZOOM_connection_destroy(c) ZOOM_connection c -int -ZOOM_connection_errcode(c) +# TESTED +const char * +ZOOM_connection_option_get(c, key) ZOOM_connection c + const char *key -const char * -ZOOM_connection_errmsg(c) +# TESTED +void +ZOOM_connection_option_set(c, key, val) ZOOM_connection c + const char *key + const char *val +void +ZOOM_connection_option_setl(c, key, val, len) + ZOOM_connection c + const char * key + const char * val + int len + +# The reference parameters, `cp' and `addinfo', need to already have +# values when this function is called, otherwise an "uninitialised +# value" warning is generated. As far as I can see, there is no way +# around this: no way to specify in a prototype that an argument is +# allowed to be undefined, for example. Since these function will +# never be called directly by well-behaved client code, but only by +# our own wrapper classes, I think we can live with that. +# +# The poxing about with cpp and caddinfo is due to Perl XS's lack of +# support for const char**, but who can blame it? If you ask me, the +# whole "const" thing was well-intentioned by ghastly mistake. +# +# TESTED int ZOOM_connection_error(c, cp, addinfo) ZOOM_connection c - const char ** cp - const char ** addinfo + char* &cp + char* &addinfo + CODE: + const char *ccp, *caddinfo; + RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo); + cp = (char*) ccp; + addinfo = (char*) caddinfo; + OUTPUT: + RETVAL + cp + addinfo int ZOOM_connection_error_x(c, cp, addinfo, diagset) @@ -48,143 +98,102 @@ ZOOM_connection_error_x(c, cp, addinfo, diagset) const char ** diagset int -ZOOM_connection_last_event(cs) - ZOOM_connection cs - -ZOOM_connection -ZOOM_connection_new(host, portnum) - const char * host - int portnum - -const char * -ZOOM_connection_option_get(c, key) +ZOOM_connection_errcode(c) ZOOM_connection c - const char * key -void -ZOOM_connection_option_set(c, key, val) +const char * +ZOOM_connection_errmsg(c) ZOOM_connection c - const char * key - const char * val -void -ZOOM_connection_option_setl(c, key, val, len) +const char * +ZOOM_connection_addinfo(c) ZOOM_connection c - const char * key - const char * val - int len -ZOOM_package -ZOOM_connection_package(c, options) - ZOOM_connection c - ZOOM_options options +# TESTED +const char * +ZOOM_diag_str(error) + int error -ZOOM_scanset -ZOOM_connection_scan(c, startterm) - ZOOM_connection c - const char * startterm +int +ZOOM_connection_last_event(cs) + ZOOM_connection cs ZOOM_resultset ZOOM_connection_search(arg0, q) ZOOM_connection arg0 ZOOM_query q +# "const" discarded from type of `q' +# +# TESTED ZOOM_resultset ZOOM_connection_search_pqf(c, q) - ZOOM_connection c - const char * q - -const char * -ZOOM_diag_str(error) - int error - -int -ZOOM_event(no, cs) - int no - ZOOM_connection * cs - -ZOOM_options -ZOOM_options_create() - -ZOOM_options -ZOOM_options_create_with_parent(parent) - ZOOM_options parent - -ZOOM_options -ZOOM_options_create_with_parent2(parent1, parent2) - ZOOM_options parent1 - ZOOM_options parent2 + ZOOM_connection c + char *q +# TESTED void -ZOOM_options_destroy(opt) - ZOOM_options opt +ZOOM_resultset_destroy(r) + ZOOM_resultset r const char * -ZOOM_options_get(opt, name) - ZOOM_options opt - const char * name - -int -ZOOM_options_get_bool(opt, name, defa) - ZOOM_options opt - const char * name - int defa - -int -ZOOM_options_get_int(opt, name, defa) - ZOOM_options opt - const char * name - int defa +ZOOM_resultset_option_get(r, key) + ZOOM_resultset r + const char * key void -ZOOM_options_set(opt, name, v) - ZOOM_options opt - const char * name - const char * v +ZOOM_resultset_option_set(r, key, val) + ZOOM_resultset r + const char * key + const char * val -ZOOM_options_callback -ZOOM_options_set_callback(opt, c, handle) - ZOOM_options opt - ZOOM_options_callback c - void * handle +# TESTED +size_t +ZOOM_resultset_size(r) + ZOOM_resultset r void -ZOOM_options_set_int(opt, name, value) - ZOOM_options opt - const char * name - int value +ZOOM_resultset_records(r, recs, start, count) + ZOOM_resultset r + ZOOM_record * recs + size_t start + size_t count -void -ZOOM_options_setl(opt, name, value, len) - ZOOM_options opt - const char * name - const char * value - int len +# TESTED +ZOOM_record +ZOOM_resultset_record(s, pos) + ZOOM_resultset s + size_t pos + +ZOOM_record +ZOOM_resultset_record_immediate(s, pos) + ZOOM_resultset s + size_t pos void -ZOOM_package_destroy(p) - ZOOM_package p +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 const char * -ZOOM_package_option_get(p, key) - ZOOM_package p - const char * key - -void -ZOOM_package_option_set(p, key, val) - ZOOM_package p - const char * key - const char * val +ZOOM_record_get(rec, type, len) + ZOOM_record rec + char* type + int &len + OUTPUT: + RETVAL + len void -ZOOM_package_send(p, type) - ZOOM_package p - const char * type +ZOOM_record_destroy(rec) + ZOOM_record rec -int -ZOOM_query_cql(s, str) - ZOOM_query s - const char * str +ZOOM_record +ZOOM_record_clone(srec) + ZOOM_record srec ZOOM_query ZOOM_query_create() @@ -194,6 +203,11 @@ ZOOM_query_destroy(s) ZOOM_query s int +ZOOM_query_cql(s, str) + ZOOM_query s + const char * str + +int ZOOM_query_prefix(s, str) ZOOM_query s const char * str @@ -203,59 +217,68 @@ ZOOM_query_sortby(s, criteria) ZOOM_query s const char * criteria -ZOOM_record -ZOOM_record_clone(srec) - ZOOM_record srec +ZOOM_scanset +ZOOM_connection_scan(c, startterm) + ZOOM_connection c + const char * startterm -void -ZOOM_record_destroy(rec) - ZOOM_record rec +const char * +ZOOM_scanset_term(scan, pos, occ, len) + ZOOM_scanset scan + size_t pos + int * occ + int * len const char * -ZOOM_record_get(rec, type, len) - ZOOM_record rec - const char * type +ZOOM_scanset_display_term(scan, pos, occ, len) + ZOOM_scanset scan + size_t pos + int * occ int * len -void -ZOOM_resultset_cache_reset(r) - ZOOM_resultset r +size_t +ZOOM_scanset_size(scan) + ZOOM_scanset scan void -ZOOM_resultset_destroy(r) - ZOOM_resultset r +ZOOM_scanset_destroy(scan) + ZOOM_scanset scan const char * -ZOOM_resultset_option_get(r, key) - ZOOM_resultset r +ZOOM_scanset_option_get(scan, key) + ZOOM_scanset scan const char * key void -ZOOM_resultset_option_set(r, key, val) - ZOOM_resultset r +ZOOM_scanset_option_set(scan, key, val) + ZOOM_scanset scan const char * key const char * val -ZOOM_record -ZOOM_resultset_record(s, pos) - ZOOM_resultset s - size_t pos +ZOOM_package +ZOOM_connection_package(c, options) + ZOOM_connection c + ZOOM_options options -ZOOM_record -ZOOM_resultset_record_immediate(s, pos) - ZOOM_resultset s - size_t pos +void +ZOOM_package_destroy(p) + ZOOM_package p void -ZOOM_resultset_records(r, recs, start, count) - ZOOM_resultset r - ZOOM_record * recs - size_t start - size_t count +ZOOM_package_send(p, type) + ZOOM_package p + const char * type -size_t -ZOOM_resultset_size(r) - ZOOM_resultset r +const char * +ZOOM_package_option_get(p, key) + ZOOM_package p + const char * key + +void +ZOOM_package_option_set(p, key, val) + ZOOM_package p + const char * key + const char * val void ZOOM_resultset_sort(r, sort_type, sort_spec) @@ -263,36 +286,67 @@ ZOOM_resultset_sort(r, sort_type, sort_spec) const char * sort_type const char * sort_spec -void -ZOOM_scanset_destroy(scan) - ZOOM_scanset scan +ZOOM_options_callback +ZOOM_options_set_callback(opt, c, handle) + ZOOM_options opt + ZOOM_options_callback c + void * handle -const char * -ZOOM_scanset_display_term(scan, pos, occ, len) - ZOOM_scanset scan - size_t pos - int * occ - int * len +# TESTING +ZOOM_options +ZOOM_options_create() + +ZOOM_options +ZOOM_options_create_with_parent(parent) + ZOOM_options parent + +ZOOM_options +ZOOM_options_create_with_parent2(parent1, parent2) + ZOOM_options parent1 + ZOOM_options parent2 const char * -ZOOM_scanset_option_get(scan, key) - ZOOM_scanset scan - const char * key +ZOOM_options_get(opt, name) + ZOOM_options opt + const char * name void -ZOOM_scanset_option_set(scan, key, val) - ZOOM_scanset scan - const char * key - const char * val +ZOOM_options_set(opt, name, v) + ZOOM_options opt + const char * name + const char * v -size_t -ZOOM_scanset_size(scan) - ZOOM_scanset scan +void +ZOOM_options_setl(opt, name, value, len) + ZOOM_options opt + const char * name + const char * value + int len -const char * -ZOOM_scanset_term(scan, pos, occ, len) - ZOOM_scanset scan - size_t pos - int * occ - int * len +void +ZOOM_options_destroy(opt) + ZOOM_options opt + +int +ZOOM_options_get_bool(opt, name, defa) + ZOOM_options opt + const char * name + int defa + +int +ZOOM_options_get_int(opt, name, defa) + ZOOM_options opt + const char * name + int defa + +void +ZOOM_options_set_int(opt, name, value) + ZOOM_options opt + const char * name + int value + +int +ZOOM_event(no, cs) + int no + ZOOM_connection * cs