1 /* $Id: ZOOM.xs,v 1.7 2005-10-11 12:11:17 mike Exp $ */
10 MODULE = Net::Z3950::ZOOM PACKAGE = Net::Z3950::ZOOM PREFIX=ZOOM_
15 # It seems that when one of these functions is called from Perl with
16 # a string-constant argument, that is not recognised as suitable to
17 # be mapped onto a "const char*" argument. The only fix I can find is
18 # to delete as the "const" qualifiers from "char*" arguments:
19 # overriding the auto-generated prototyping with PROTOTYPE: $$
20 # doesn't help (and indeed seems to make no difference at all).
23 ZOOM_connection_new(host, portnum)
28 ZOOM_connection_create(options)
32 ZOOM_connection_connect(c, host, portnum)
38 ZOOM_connection_destroy(c)
42 ZOOM_connection_option_get(c, key)
47 ZOOM_connection_option_set(c, key, val)
53 ZOOM_connection_option_setl(c, key, val, len)
59 # The reference parameters, `cp' and `addinfo', need to already have
60 # values when this function is called, otherwise an "uninitialised
61 # value" warning is generated. As far as I can see, there is no way
62 # around this: no way to specify in a prototype that an argument is
63 # allowed to be undefined, for example. Since these function will
64 # never be called directly by well-behaved client code, but only by
65 # our own wrapper classes, I think we can live with that.
67 # The poxing about with cpp and caddinfo is due to Perl XS's lack of
68 # support for const char**, but who can blame it? If you ask me, the
69 # whole "const" thing was well-intentioned by ghastly mistake.
72 ZOOM_connection_error(c, cp, addinfo)
77 const char *ccp, *caddinfo;
78 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
80 addinfo = (char*) caddinfo;
87 ZOOM_connection_error_x(c, cp, addinfo, diagset)
94 ZOOM_connection_errcode(c)
98 ZOOM_connection_errmsg(c)
102 ZOOM_connection_addinfo(c)
110 ZOOM_connection_last_event(cs)
114 ZOOM_connection_search(arg0, q)
118 # "const" discarded from type of `q'
120 ZOOM_connection_search_pqf(c, q)
125 ZOOM_resultset_destroy(r)
129 ZOOM_resultset_option_get(r, key)
134 ZOOM_resultset_option_set(r, key, val)
140 ZOOM_resultset_size(r)
144 ZOOM_resultset_records(r, recs, start, count)
151 ZOOM_resultset_record(s, pos)
156 ZOOM_resultset_record_immediate(s, pos)
161 ZOOM_resultset_cache_reset(r)
165 ZOOM_record_get(rec, type, len)
171 ZOOM_record_destroy(rec)
175 ZOOM_record_clone(srec)
182 ZOOM_query_destroy(s)
186 ZOOM_query_cql(s, str)
191 ZOOM_query_prefix(s, str)
196 ZOOM_query_sortby(s, criteria)
198 const char * criteria
201 ZOOM_connection_scan(c, startterm)
203 const char * startterm
206 ZOOM_scanset_term(scan, pos, occ, len)
213 ZOOM_scanset_display_term(scan, pos, occ, len)
220 ZOOM_scanset_size(scan)
224 ZOOM_scanset_destroy(scan)
228 ZOOM_scanset_option_get(scan, key)
233 ZOOM_scanset_option_set(scan, key, val)
239 ZOOM_connection_package(c, options)
244 ZOOM_package_destroy(p)
248 ZOOM_package_send(p, type)
253 ZOOM_package_option_get(p, key)
258 ZOOM_package_option_set(p, key, val)
264 ZOOM_resultset_sort(r, sort_type, sort_spec)
266 const char * sort_type
267 const char * sort_spec
269 ZOOM_options_callback
270 ZOOM_options_set_callback(opt, c, handle)
272 ZOOM_options_callback c
276 ZOOM_options_create()
279 ZOOM_options_create_with_parent(parent)
283 ZOOM_options_create_with_parent2(parent1, parent2)
288 ZOOM_options_get(opt, name)
293 ZOOM_options_set(opt, name, v)
299 ZOOM_options_setl(opt, name, value, len)
306 ZOOM_options_destroy(opt)
310 ZOOM_options_get_bool(opt, name, defa)
316 ZOOM_options_get_int(opt, name, defa)
322 ZOOM_options_set_int(opt, name, value)