1 /* $Id: ZOOM.xs,v 1.9 2005-10-12 09:45:36 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)
48 ZOOM_connection_option_get(c, key)
55 ZOOM_connection_option_set(c, key, val)
61 ZOOM_connection_option_setl(c, key, val, len)
69 # The reference parameters, `cp' and `addinfo', need to already have
70 # values when this function is called, otherwise an "uninitialised
71 # value" warning is generated. As far as I can see, there is no way
72 # around this: no way to specify in a prototype that an argument is
73 # allowed to be undefined, for example. Since these function will
74 # never be called directly by well-behaved client code, but only by
75 # our own wrapper classes, I think we can live with that.
77 # The poxing about with cpp and caddinfo is due to Perl XS's lack of
78 # support for const char**, but who can blame it? If you ask me, the
79 # whole "const" thing was well-intentioned by ghastly mistake.
82 ZOOM_connection_error(c, cp, addinfo)
87 const char *ccp, *caddinfo;
88 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
90 addinfo = (char*) caddinfo;
97 ZOOM_connection_error_x(c, cp, addinfo, diagset)
100 const char ** addinfo
101 const char ** diagset
104 ZOOM_connection_errcode(c)
108 ZOOM_connection_errmsg(c)
112 ZOOM_connection_addinfo(c)
120 ZOOM_connection_last_event(cs)
124 ZOOM_connection_search(arg0, q)
130 # "const" discarded from type of `q'
132 ZOOM_connection_search_pqf(c, q)
139 ZOOM_resultset_destroy(r)
143 ZOOM_resultset_option_get(r, key)
148 ZOOM_resultset_option_set(r, key, val)
156 ZOOM_resultset_size(r)
160 ZOOM_resultset_records(r, recs, start, count)
169 ZOOM_resultset_record(s, pos)
174 ZOOM_resultset_record_immediate(s, pos)
179 ZOOM_resultset_cache_reset(r)
184 # "const" discarded from type of `type'
185 # See "typemap" for discussion of the "const char *" return-type.
187 ZOOM_record_get(rec, type, len)
196 ZOOM_record_destroy(rec)
200 ZOOM_record_clone(srec)
207 ZOOM_query_destroy(s)
211 ZOOM_query_cql(s, str)
216 ZOOM_query_prefix(s, str)
221 ZOOM_query_sortby(s, criteria)
223 const char * criteria
226 ZOOM_connection_scan(c, startterm)
228 const char * startterm
231 ZOOM_scanset_term(scan, pos, occ, len)
238 ZOOM_scanset_display_term(scan, pos, occ, len)
245 ZOOM_scanset_size(scan)
249 ZOOM_scanset_destroy(scan)
253 ZOOM_scanset_option_get(scan, key)
258 ZOOM_scanset_option_set(scan, key, val)
264 ZOOM_connection_package(c, options)
269 ZOOM_package_destroy(p)
273 ZOOM_package_send(p, type)
278 ZOOM_package_option_get(p, key)
283 ZOOM_package_option_set(p, key, val)
289 ZOOM_resultset_sort(r, sort_type, sort_spec)
291 const char * sort_type
292 const char * sort_spec
294 ZOOM_options_callback
295 ZOOM_options_set_callback(opt, c, handle)
297 ZOOM_options_callback c
301 ZOOM_options_create()
304 ZOOM_options_create_with_parent(parent)
308 ZOOM_options_create_with_parent2(parent1, parent2)
313 ZOOM_options_get(opt, name)
318 ZOOM_options_set(opt, name, v)
324 ZOOM_options_setl(opt, name, value, len)
331 ZOOM_options_destroy(opt)
335 ZOOM_options_get_bool(opt, name, defa)
341 ZOOM_options_get_int(opt, name, defa)
347 ZOOM_options_set_int(opt, name, value)