1 /* $Id: ZOOM.xs,v 1.10 2005-10-12 16:13:00 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)
122 ZOOM_connection_last_event(cs)
126 ZOOM_connection_search(arg0, q)
132 # "const" discarded from type of `q'
134 ZOOM_connection_search_pqf(c, q)
141 ZOOM_resultset_destroy(r)
145 ZOOM_resultset_option_get(r, key)
150 ZOOM_resultset_option_set(r, key, val)
158 ZOOM_resultset_size(r)
162 ZOOM_resultset_records(r, recs, start, count)
171 ZOOM_resultset_record(s, pos)
176 ZOOM_resultset_record_immediate(s, pos)
181 ZOOM_resultset_cache_reset(r)
186 # "const" discarded from type of `type'
187 # See "typemap" for discussion of the "const char *" return-type.
189 ZOOM_record_get(rec, type, len)
198 ZOOM_record_destroy(rec)
202 ZOOM_record_clone(srec)
209 ZOOM_query_destroy(s)
213 ZOOM_query_cql(s, str)
218 ZOOM_query_prefix(s, str)
223 ZOOM_query_sortby(s, criteria)
225 const char * criteria
228 ZOOM_connection_scan(c, startterm)
230 const char * startterm
233 ZOOM_scanset_term(scan, pos, occ, len)
240 ZOOM_scanset_display_term(scan, pos, occ, len)
247 ZOOM_scanset_size(scan)
251 ZOOM_scanset_destroy(scan)
255 ZOOM_scanset_option_get(scan, key)
260 ZOOM_scanset_option_set(scan, key, val)
266 ZOOM_connection_package(c, options)
271 ZOOM_package_destroy(p)
275 ZOOM_package_send(p, type)
280 ZOOM_package_option_get(p, key)
285 ZOOM_package_option_set(p, key, val)
291 ZOOM_resultset_sort(r, sort_type, sort_spec)
293 const char * sort_type
294 const char * sort_spec
296 ZOOM_options_callback
297 ZOOM_options_set_callback(opt, c, handle)
299 ZOOM_options_callback c
303 ZOOM_options_create()
306 ZOOM_options_create_with_parent(parent)
310 ZOOM_options_create_with_parent2(parent1, parent2)
315 ZOOM_options_get(opt, name)
320 ZOOM_options_set(opt, name, v)
326 ZOOM_options_setl(opt, name, value, len)
333 ZOOM_options_destroy(opt)
337 ZOOM_options_get_bool(opt, name, defa)
343 ZOOM_options_get_int(opt, name, defa)
349 ZOOM_options_set_int(opt, name, value)