1 /* $Id: ZOOM.xs,v 1.8 2005-10-11 15:44:33 mike Exp $ */
10 MODULE = Net::Z3950::ZOOM PACKAGE = Net::Z3950::ZOOM PREFIX=ZOOM_
17 # It seems that when one of these functions is called from Perl with
18 # a string-constant argument, that is not recognised as suitable to
19 # be mapped onto a "const char*" argument. The only fix I can find is
20 # to delete as the "const" qualifiers from "char*" arguments:
21 # overriding the auto-generated prototyping with PROTOTYPE: $$
22 # doesn't help (and indeed seems to make no difference at all).
25 ZOOM_connection_new(host, portnum)
30 ZOOM_connection_create(options)
34 ZOOM_connection_connect(c, host, portnum)
42 ZOOM_connection_destroy(c)
46 ZOOM_connection_option_get(c, key)
53 ZOOM_connection_option_set(c, key, val)
59 ZOOM_connection_option_setl(c, key, val, len)
67 # The reference parameters, `cp' and `addinfo', need to already have
68 # values when this function is called, otherwise an "uninitialised
69 # value" warning is generated. As far as I can see, there is no way
70 # around this: no way to specify in a prototype that an argument is
71 # allowed to be undefined, for example. Since these function will
72 # never be called directly by well-behaved client code, but only by
73 # our own wrapper classes, I think we can live with that.
75 # The poxing about with cpp and caddinfo is due to Perl XS's lack of
76 # support for const char**, but who can blame it? If you ask me, the
77 # whole "const" thing was well-intentioned by ghastly mistake.
80 ZOOM_connection_error(c, cp, addinfo)
85 const char *ccp, *caddinfo;
86 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
88 addinfo = (char*) caddinfo;
95 ZOOM_connection_error_x(c, cp, addinfo, diagset)
102 ZOOM_connection_errcode(c)
106 ZOOM_connection_errmsg(c)
110 ZOOM_connection_addinfo(c)
118 ZOOM_connection_last_event(cs)
122 ZOOM_connection_search(arg0, q)
128 # "const" discarded from type of `q'
130 ZOOM_connection_search_pqf(c, q)
137 ZOOM_resultset_destroy(r)
141 ZOOM_resultset_option_get(r, key)
146 ZOOM_resultset_option_set(r, key, val)
154 ZOOM_resultset_size(r)
158 ZOOM_resultset_records(r, recs, start, count)
167 ZOOM_resultset_record(s, pos)
172 ZOOM_resultset_record_immediate(s, pos)
177 ZOOM_resultset_cache_reset(r)
182 # "const" discarded from type of `type'
183 # See "typemap" for discussion of the "const char *" return-type.
185 ZOOM_record_get(rec, type, len)
194 ZOOM_record_destroy(rec)
198 ZOOM_record_clone(srec)
205 ZOOM_query_destroy(s)
209 ZOOM_query_cql(s, str)
214 ZOOM_query_prefix(s, str)
219 ZOOM_query_sortby(s, criteria)
221 const char * criteria
224 ZOOM_connection_scan(c, startterm)
226 const char * startterm
229 ZOOM_scanset_term(scan, pos, occ, len)
236 ZOOM_scanset_display_term(scan, pos, occ, len)
243 ZOOM_scanset_size(scan)
247 ZOOM_scanset_destroy(scan)
251 ZOOM_scanset_option_get(scan, key)
256 ZOOM_scanset_option_set(scan, key, val)
262 ZOOM_connection_package(c, options)
267 ZOOM_package_destroy(p)
271 ZOOM_package_send(p, type)
276 ZOOM_package_option_get(p, key)
281 ZOOM_package_option_set(p, key, val)
287 ZOOM_resultset_sort(r, sort_type, sort_spec)
289 const char * sort_type
290 const char * sort_spec
292 ZOOM_options_callback
293 ZOOM_options_set_callback(opt, c, handle)
295 ZOOM_options_callback c
299 ZOOM_options_create()
302 ZOOM_options_create_with_parent(parent)
306 ZOOM_options_create_with_parent2(parent1, parent2)
311 ZOOM_options_get(opt, name)
316 ZOOM_options_set(opt, name, v)
322 ZOOM_options_setl(opt, name, value, len)
329 ZOOM_options_destroy(opt)
333 ZOOM_options_get_bool(opt, name, defa)
339 ZOOM_options_get_int(opt, name, defa)
345 ZOOM_options_set_int(opt, name, value)