1 /* $Id: ZOOM.xs,v 1.12 2005-10-13 13:48:08 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).
24 ZOOM_connection_new(host, portnum)
30 ZOOM_connection_create(options)
35 ZOOM_connection_connect(c, host, portnum)
42 ZOOM_connection_destroy(c)
47 ZOOM_connection_option_get(c, key)
53 ZOOM_connection_option_set(c, key, val)
59 ZOOM_connection_option_setl(c, key, val, len)
65 # The reference parameters, `cp' and `addinfo', need to already have
66 # values when this function is called, otherwise an "uninitialised
67 # value" warning is generated. As far as I can see, there is no way
68 # around this: no way to specify in a prototype that an argument is
69 # allowed to be undefined, for example. Since these function will
70 # never be called directly by well-behaved client code, but only by
71 # our own wrapper classes, I think we can live with that.
73 # The poxing about with cpp and caddinfo is due to Perl XS's lack of
74 # support for const char**, but who can blame it? If you ask me, the
75 # whole "const" thing was well-intentioned by ghastly mistake.
79 ZOOM_connection_error(c, cp, addinfo)
84 const char *ccp, *caddinfo;
85 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
87 addinfo = (char*) caddinfo;
94 ZOOM_connection_error_x(c, cp, addinfo, diagset)
101 ZOOM_connection_errcode(c)
105 ZOOM_connection_errmsg(c)
109 ZOOM_connection_addinfo(c)
118 ZOOM_connection_last_event(cs)
122 ZOOM_connection_search(arg0, q)
126 # "const" discarded from type of `q'
130 ZOOM_connection_search_pqf(c, q)
136 ZOOM_resultset_destroy(r)
140 ZOOM_resultset_option_get(r, key)
145 ZOOM_resultset_option_set(r, key, val)
152 ZOOM_resultset_size(r)
156 ZOOM_resultset_records(r, recs, start, count)
164 ZOOM_resultset_record(s, pos)
169 ZOOM_resultset_record_immediate(s, pos)
174 ZOOM_resultset_cache_reset(r)
177 # "const" discarded from type of `type'
178 # See "typemap" for discussion of the "const char *" return-type.
182 ZOOM_record_get(rec, type, len)
191 ZOOM_record_destroy(rec)
195 ZOOM_record_clone(srec)
202 ZOOM_query_destroy(s)
206 ZOOM_query_cql(s, str)
211 ZOOM_query_prefix(s, str)
216 ZOOM_query_sortby(s, criteria)
218 const char * criteria
221 ZOOM_connection_scan(c, startterm)
223 const char * startterm
226 ZOOM_scanset_term(scan, pos, occ, len)
233 ZOOM_scanset_display_term(scan, pos, occ, len)
240 ZOOM_scanset_size(scan)
244 ZOOM_scanset_destroy(scan)
248 ZOOM_scanset_option_get(scan, key)
253 ZOOM_scanset_option_set(scan, key, val)
259 ZOOM_connection_package(c, options)
264 ZOOM_package_destroy(p)
268 ZOOM_package_send(p, type)
273 ZOOM_package_option_get(p, key)
278 ZOOM_package_option_set(p, key, val)
284 ZOOM_resultset_sort(r, sort_type, sort_spec)
286 const char * sort_type
287 const char * sort_spec
289 ZOOM_options_callback
290 ZOOM_options_set_callback(opt, c, handle)
292 ZOOM_options_callback c
297 ZOOM_options_create()
300 ZOOM_options_create_with_parent(parent)
304 ZOOM_options_create_with_parent2(parent1, parent2)
309 ZOOM_options_get(opt, name)
314 ZOOM_options_set(opt, name, v)
320 ZOOM_options_setl(opt, name, value, len)
327 ZOOM_options_destroy(opt)
331 ZOOM_options_get_bool(opt, name, defa)
337 ZOOM_options_get_int(opt, name, defa)
343 ZOOM_options_set_int(opt, name, value)