1 /* $Id: ZOOM.xs,v 1.33 2005-12-19 17:05:05 mike Exp $ */
8 #include <yaz/xmalloc.h>
10 /* Used by the *_setl() functions */
11 typedef char opaquechar;
13 /* Used as the return value of the *_getl() functions */
19 /* Used to package Perl function-pointer and user-data together */
20 struct callback_block {
25 /* The callback function used for ZOOM_options_set_callback(). I do
26 * not claim to fully understand all the stack-hacking magic, and less
27 * still the reference-counting/mortality stuff. Accordingly, the
28 * memory management here is best characterised as What I Could Get To
31 const char *__ZOOM_option_callback (void *handle, const char *name)
33 struct callback_block *cb = (struct callback_block*) handle;
46 XPUSHs(sv_2mortal(newSVpv(name, 0)));
48 /* Perl_sv_dump(0, cb->function); */
50 count = call_sv(cb->function, G_SCALAR);
55 croak("callback function for ZOOM_options_get() returned %d values: should have returned exactly one", count);
60 /* ### `res' never gets freed! I think it is
61 * impossible to solve this problem "correctly"
62 * because the ZOOM-C option callback interface is
77 MODULE = Net::Z3950::ZOOM PACKAGE = Net::Z3950::ZOOM PREFIX=ZOOM_
84 ZOOM_connection_new(host, portnum)
90 ZOOM_connection_create(options)
95 ZOOM_connection_connect(c, host, portnum)
102 ZOOM_connection_destroy(c)
107 ZOOM_connection_option_get(c, key)
113 ZOOM_connection_option_getl(c, key, len)
118 RETVAL.data = (char*) ZOOM_connection_option_getl(c, key, &len);
126 ZOOM_connection_option_set(c, key, val)
131 # In ZOOM-C, the `val' parameter is const char*. However, our typemap
132 # treats this as T_PV, i.e. it's "known" that it points to a
133 # NUL-terminated string. Instead, then, I here use opaquechar*, which
134 # is an opaque pointer. The underlying C function can then use this
135 # along with `len' to Do The Right Thing.
139 ZOOM_connection_option_setl(c, key, val, len)
145 # The reference parameters, `cp' and `addinfo', need to already have
146 # values when this function is called, otherwise an "uninitialised
147 # value" warning is generated. As far as I can see, there is no way
148 # around this: no way to specify in a prototype that an argument is
149 # allowed to be undefined, for example. Since these function will
150 # never be called directly by well-behaved client code, but only by
151 # our own wrapper classes, I think we can live with that.
153 # The poxing about with cpp and caddinfo is due to Perl XS's lack of
154 # support for const char**, but who can blame it? If you ask me, the
155 # whole "const" thing was well-intentioned by ghastly mistake.
159 ZOOM_connection_error(c, cp, addinfo)
165 const char *ccp, *caddinfo;
166 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
168 addinfo = (char*) caddinfo;
175 # See comments for ZOOM_connection_error() above
178 ZOOM_connection_error_x(c, cp, addinfo, diagset)
181 const char * &addinfo
182 const char * &diagset
185 const char *ccp, *caddinfo, *cdset;
186 RETVAL = ZOOM_connection_error_x(c, &ccp, &caddinfo, &cdset);
188 addinfo = (char*) caddinfo;
189 diagset = (char*) cdset;
199 ZOOM_connection_errcode(c)
204 ZOOM_connection_errmsg(c)
209 ZOOM_connection_addinfo(c)
214 ZOOM_connection_diagset(c)
224 ZOOM_connection_search(arg0, q)
230 ZOOM_connection_search_pqf(c, q)
236 ZOOM_resultset_destroy(r)
241 ZOOM_resultset_option_get(r, key)
247 ZOOM_resultset_option_set(r, key, val)
254 ZOOM_resultset_size(r)
259 ZOOM_resultset_records(r, start, count, return_records)
266 ZOOM_record *recs = 0;
268 recs = (ZOOM_record*) xmalloc(count * sizeof *recs);
269 ZOOM_resultset_records(r, recs, start, count);
270 if (return_records) {
273 for (i = 0; i < count; i++) {
275 sv_setref_pv(tmp, "ZOOM_record", (void*) recs[i]);
278 RETVAL = newRV((SV*) av);
280 RETVAL = &PL_sv_undef;
288 ZOOM_resultset_record(s, pos)
294 ZOOM_resultset_record_immediate(s, pos)
300 ZOOM_resultset_cache_reset(r)
303 # TESTED (but deprecated)
305 ZOOM_resultset_sort(r, sort_type, sort_spec)
307 const char* sort_type
308 const char* sort_spec
312 ZOOM_resultset_sort1(r, sort_type, sort_spec)
314 const char* sort_type
315 const char* sort_spec
317 # See "typemap" for discussion of the "const char *" return-type.
320 ### but should use datachunk for in some (not all!) cases.
322 ZOOM_record_get(rec, type, len)
332 ZOOM_record_destroy(rec)
337 ZOOM_record_clone(srec)
346 ZOOM_query_destroy(s)
351 ZOOM_query_cql(s, str)
357 ZOOM_query_prefix(s, str)
363 ZOOM_query_sortby(s, criteria)
365 const char * criteria
369 ZOOM_connection_scan(c, startterm)
371 const char* startterm
375 ZOOM_connection_scan1(c, startterm)
381 ZOOM_scanset_term(scan, pos, occ, len)
393 ZOOM_scanset_display_term(scan, pos, occ, len)
405 ZOOM_scanset_size(scan)
410 ZOOM_scanset_destroy(scan)
415 ZOOM_scanset_option_get(scan, key)
421 ZOOM_scanset_option_set(scan, key, val)
426 # We ignore the return value of ZOOM_options_set_callback(), since it
427 # is always just the address of the __ZOOM_option_callback() function.
428 # The information that we actually want -- the address of the Perl
429 # function in the callback_block -- is unavailable to us, as the
430 # underlying C function doesn't give the block back.
434 ZOOM_options_set_callback(opt, function, handle)
440 /* The tiny amount of memory allocated here is never
441 * released, as options_destroy() doesn't do anything
442 * to the callback information. Not a big deal.
443 * Also, I have no idea how to drive the Perl "mortal"
444 * reference-counting stuff, so I am just allocating
445 * copies which also never get released. Don't sue!
447 struct callback_block *block = (struct callback_block*)
448 xmalloc(sizeof *block);
449 block->function = function;
450 block->handle = handle;
451 SvREFCNT(block->function);
452 SvREFCNT(block->handle);
453 ZOOM_options_set_callback(opt, __ZOOM_option_callback,
459 ZOOM_options_create()
463 ZOOM_options_create_with_parent(parent)
468 ZOOM_options_create_with_parent2(parent1, parent2)
474 ZOOM_options_get(opt, name)
480 ZOOM_options_getl(opt, name, len)
485 RETVAL.data = (char*) ZOOM_options_getl(opt, name, &len);
493 ZOOM_options_set(opt, name, v)
500 ZOOM_options_setl(opt, name, value, len)
508 ZOOM_options_destroy(opt)
513 ZOOM_options_get_bool(opt, name, defa)
520 ZOOM_options_get_int(opt, name, defa)
527 ZOOM_options_set_int(opt, name, value)
534 ZOOM_connection_package(c, options)
540 ZOOM_package_destroy(p)
545 ZOOM_package_send(p, type)
551 ZOOM_package_option_get(p, key)
557 ZOOM_package_option_set(p, key, val)
570 ZOOM_connection_last_event(cs)