ZOOM.xs

   1 /* $Id: ZOOM.xs,v 1.25 2005-11-07 14:27:43 mike Exp $ */
   2
   3 #include "EXTERN.h"
   4 #include "perl.h"
   5 #include "XSUB.h"
   6
   7 #include <yaz/zoom.h>
   8 #include <yaz/xmalloc.h>
   9
  10 /* Used by the *_setl() functions */
  11 typedef char opaquechar;
  12
  13 /* Used as the return value of the *_getl() functions */
  14 struct datachunk {
  15         char *data;
  16         int len;
  17 };
  18
  19 /* Used to package Perl function-pointer and user-data together */
  20 struct callback_block {
  21         SV *function;
  22         SV *handle;
  23 };
  24
  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
  29  * Work, More Or Less.
  30  */
  31 const char *__ZOOM_option_callback (void *handle, const char *name)
  32 {
  33         struct callback_block *cb = (struct callback_block*) handle;
  34         int count;
  35         SV *ret;
  36         char *s;
  37         char *res;
  38
  39         dSP;
  40
  41         ENTER;
  42         SAVETMPS;
  43
  44         PUSHMARK(SP);
  45         XPUSHs(cb->handle);
  46         XPUSHs(sv_2mortal(newSVpv(name, 0)));
  47         PUTBACK;
  48         /* Perl_sv_dump(0, cb->function); */
  49
  50         count = call_sv(cb->function, G_SCALAR);
  51
  52         SPAGAIN;
  53
  54         if (count != 1)
  55                 croak("callback function for ZOOM_options_get() returned %d values: should have returned exactly one", count);
  56
  57         ret = POPs;
  58         if (SvPOK(ret)) {
  59                 s = SvPV_nolen(ret);
  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
  63                  * inadequate. */
  64                 res = xstrdup(s);
  65         } else {
  66                 res = 0;
  67         }
  68
  69         PUTBACK;
  70         FREETMPS;
  71         LEAVE;
  72
  73         return res;
  74 }
  75
  76
  77 MODULE = Net::Z3950::ZOOM               PACKAGE = Net::Z3950::ZOOM              PREFIX=ZOOM_
  78
  79 PROTOTYPES: ENABLE
  80
  81
  82 # TESTED
  83 ZOOM_connection
  84 ZOOM_connection_new(host, portnum)
  85         const char* host
  86         int portnum
  87
  88 # TESTED
  89 ZOOM_connection
  90 ZOOM_connection_create(options)
  91         ZOOM_options options
  92
  93 # TESTED
  94 void
  95 ZOOM_connection_connect(c, host, portnum)
  96         ZOOM_connection c
  97         const char* host
  98         int portnum
  99
 100 # TESTED
 101 void
 102 ZOOM_connection_destroy(c)
 103         ZOOM_connection c
 104
 105 # TESTED
 106 const char *
 107 ZOOM_connection_option_get(c, key)
 108         ZOOM_connection c
 109         const char *key
 110
 111 # TESTED
 112 struct datachunk
 113 ZOOM_connection_option_getl(c, key, len)
 114         ZOOM_connection c
 115         const char* key
 116         int &len
 117         CODE:
 118                 RETVAL.data = (char*) ZOOM_connection_option_getl(c, key, &len);
 119                 RETVAL.len = len;
 120         OUTPUT:
 121                 RETVAL
 122                 len
 123
 124 # TESTED
 125 void
 126 ZOOM_connection_option_set(c, key, val)
 127         ZOOM_connection c
 128         const char *key
 129         const char *val
 130
 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.
 136 #
 137 # TESTED
 138 void
 139 ZOOM_connection_option_setl(c, key, val, len)
 140         ZOOM_connection c
 141         const char* key
 142         opaquechar* val
 143         int len
 144
 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.
 152 #
 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.
 156 #
 157 # TESTED
 158 int
 159 ZOOM_connection_error(c, cp, addinfo)
 160         ZOOM_connection c
 161         char* &cp
 162         char* &addinfo
 163         CODE:
 164                 const char *ccp, *caddinfo;
 165                 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
 166                 cp = (char*) ccp;
 167                 addinfo = (char*) caddinfo;
 168         OUTPUT:
 169                 RETVAL
 170                 cp
 171                 addinfo
 172
 173 # See comments for ZOOM_connection_error() above
 174 # TESTED
 175 int
 176 ZOOM_connection_error_x(c, cp, addinfo, diagset)
 177         ZOOM_connection c
 178         const char * &cp
 179         const char * &addinfo
 180         const char * &diagset
 181         CODE:
 182                 const char *ccp, *caddinfo, *cdset;
 183                 RETVAL = ZOOM_connection_error_x(c, &ccp, &caddinfo, &cdset);
 184                 cp = (char*) ccp;
 185                 addinfo = (char*) caddinfo;
 186                 diagset = (char*) cdset;
 187         OUTPUT:
 188                 RETVAL
 189                 cp
 190                 addinfo
 191                 diagset
 192
 193 # TESTED
 194 int
 195 ZOOM_connection_errcode(c)
 196         ZOOM_connection c
 197
 198 # TESTED
 199 const char *
 200 ZOOM_connection_errmsg(c)
 201         ZOOM_connection c
 202
 203 # TESTED
 204 const char *
 205 ZOOM_connection_addinfo(c)
 206         ZOOM_connection c
 207
 208 # TESTED
 209 const char *
 210 ZOOM_diag_str(error)
 211         int error
 212
 213 # TESTED
 214 ZOOM_resultset
 215 ZOOM_connection_search(arg0, q)
 216         ZOOM_connection arg0
 217         ZOOM_query q
 218
 219 # TESTED
 220 ZOOM_resultset
 221 ZOOM_connection_search_pqf(c, q)
 222         ZOOM_connection c
 223         const char *q
 224
 225 # TESTED
 226 void
 227 ZOOM_resultset_destroy(r)
 228         ZOOM_resultset r
 229
 230 # TESTED
 231 const char *
 232 ZOOM_resultset_option_get(r, key)
 233         ZOOM_resultset r
 234         const char* key
 235
 236 # TESTED
 237 void
 238 ZOOM_resultset_option_set(r, key, val)
 239         ZOOM_resultset r
 240         const char* key
 241         const char* val
 242
 243 # TESTED
 244 size_t
 245 ZOOM_resultset_size(r)
 246         ZOOM_resultset r
 247
 248 # TESTED
 249 SV *
 250 ZOOM_resultset_records(r, start, count, return_records)
 251         ZOOM_resultset r
 252         size_t start
 253         size_t count
 254         int return_records
 255         INIT:
 256                 ZOOM_record *recs = 0;
 257         CODE:
 258                 if (return_records)
 259                         recs = (ZOOM_record*) xmalloc(count * sizeof *recs);
 260                 ZOOM_resultset_records(r, recs, start, count);
 261                 if (return_records) {
 262                         AV *av = newAV();
 263                         int i;
 264                         for (i = 0; i < count; i++) {
 265                                 SV *tmp = newSV(0);
 266                                 sv_setref_pv(tmp, "ZOOM_record", (void*) recs[i]);
 267                                 av_push(av, tmp);
 268                         }
 269                         RETVAL = newRV((SV*) av);
 270                 } else {
 271                         RETVAL = &PL_sv_undef;
 272                 }
 273         OUTPUT:
 274                 RETVAL
 275
 276 # TESTED
 277 ZOOM_record
 278 ZOOM_resultset_record(s, pos)
 279         ZOOM_resultset s
 280         size_t pos
 281
 282 # TESTED
 283 ZOOM_record
 284 ZOOM_resultset_record_immediate(s, pos)
 285         ZOOM_resultset s
 286         size_t pos
 287
 288 # TESTED
 289 void
 290 ZOOM_resultset_cache_reset(r)
 291         ZOOM_resultset r
 292
 293 # TESTED
 294 void
 295 ZOOM_resultset_sort(r, sort_type, sort_spec)
 296         ZOOM_resultset r
 297         const char* sort_type
 298         const char* sort_spec
 299
 300 # See "typemap" for discussion of the "const char *" return-type.
 301 #
 302 # TESTED
 303 ### but should use datachunk for in some (not all!) cases.
 304 const char *
 305 ZOOM_record_get(rec, type, len)
 306         ZOOM_record rec
 307         const char* type
 308         int &len
 309         OUTPUT:
 310                 RETVAL
 311                 len
 312
 313 # TESTED
 314 void
 315 ZOOM_record_destroy(rec)
 316         ZOOM_record rec
 317
 318 # TESTED
 319 ZOOM_record
 320 ZOOM_record_clone(srec)
 321         ZOOM_record srec
 322
 323 # TESTED
 324 ZOOM_query
 325 ZOOM_query_create()
 326
 327 # TESTED
 328 void
 329 ZOOM_query_destroy(s)
 330         ZOOM_query s
 331
 332 # TESTED
 333 int
 334 ZOOM_query_cql(s, str)
 335         ZOOM_query s
 336         const char* str
 337
 338 # TESTED
 339 int
 340 ZOOM_query_prefix(s, str)
 341         ZOOM_query s
 342         const char* str
 343
 344 # TESTED
 345 int
 346 ZOOM_query_sortby(s, criteria)
 347         ZOOM_query      s
 348         const char *    criteria
 349
 350 # UNTESTED
 351 ZOOM_scanset
 352 ZOOM_connection_scan(c, startterm)
 353         ZOOM_connection c
 354         const char *    startterm
 355
 356 # UNTESTED
 357 const char *
 358 ZOOM_scanset_term(scan, pos, occ, len)
 359         ZOOM_scanset    scan
 360         size_t  pos
 361         int *   occ
 362         int *   len
 363
 364 # UNTESTED
 365 const char *
 366 ZOOM_scanset_display_term(scan, pos, occ, len)
 367         ZOOM_scanset    scan
 368         size_t  pos
 369         int *   occ
 370         int *   len
 371
 372 # UNTESTED
 373 size_t
 374 ZOOM_scanset_size(scan)
 375         ZOOM_scanset    scan
 376
 377 # UNTESTED
 378 void
 379 ZOOM_scanset_destroy(scan)
 380         ZOOM_scanset    scan
 381
 382 # UNTESTED
 383 const char *
 384 ZOOM_scanset_option_get(scan, key)
 385         ZOOM_scanset    scan
 386         const char *    key
 387
 388 # UNTESTED
 389 void
 390 ZOOM_scanset_option_set(scan, key, val)
 391         ZOOM_scanset    scan
 392         const char *    key
 393         const char *    val
 394
 395 # UNTESTED
 396 ZOOM_package
 397 ZOOM_connection_package(c, options)
 398         ZOOM_connection c
 399         ZOOM_options    options
 400
 401 # UNTESTED
 402 void
 403 ZOOM_package_destroy(p)
 404         ZOOM_package    p
 405
 406 # UNTESTED
 407 void
 408 ZOOM_package_send(p, type)
 409         ZOOM_package    p
 410         const char *    type
 411
 412 # UNTESTED
 413 const char *
 414 ZOOM_package_option_get(p, key)
 415         ZOOM_package    p
 416         const char *    key
 417
 418 # UNTESTED
 419 void
 420 ZOOM_package_option_set(p, key, val)
 421         ZOOM_package    p
 422         const char *    key
 423         const char *    val
 424
 425 # We ignore the return value of ZOOM_options_set_callback(), since it
 426 # is always just the address of the __ZOOM_option_callback() function.
 427 # The information that we actually want -- the address of the Perl
 428 # function in the callback_block -- is unavailable to us, as the
 429 # underlying C function doesn't give the block back.
 430 #
 431 # TESTED
 432 void
 433 ZOOM_options_set_callback(opt, function, handle)
 434         ZOOM_options opt
 435         SV* function;
 436         SV* handle;
 437         CODE:
 438                 /* The tiny amount of memory allocated here is never
 439                  * released, as options_destroy() doesn't do anything
 440                  * to the callback information.  Not a big deal.
 441                  * Also, I have no idea how to drive the Perl "mortal"
 442                  * reference-counting stuff, so I am just allocating
 443                  * copies which also never get released.  Don't sue!
 444                  */
 445                 struct callback_block *block = (struct callback_block*)
 446                         xmalloc(sizeof *block);
 447                 block->function = function;
 448                 block->handle = handle;
 449                 SvREFCNT(block->function);
 450                 SvREFCNT(block->handle);
 451                 ZOOM_options_set_callback(opt, __ZOOM_option_callback,
 452                                           (void*) block);
 453
 454 # TESTED
 455 ZOOM_options
 456 ZOOM_options_create()
 457
 458 # TESTED
 459 ZOOM_options
 460 ZOOM_options_create_with_parent(parent)
 461         ZOOM_options parent
 462
 463 # TESTED
 464 ZOOM_options
 465 ZOOM_options_create_with_parent2(parent1, parent2)
 466         ZOOM_options parent1
 467         ZOOM_options parent2
 468
 469 # TESTED
 470 const char *
 471 ZOOM_options_get(opt, name)
 472         ZOOM_options opt
 473         const char* name
 474
 475 # TESTED
 476 struct datachunk
 477 ZOOM_options_getl(opt, name, len)
 478         ZOOM_options opt
 479         const char* name
 480         int &len
 481         CODE:
 482                 RETVAL.data = (char*) ZOOM_options_getl(opt, name, &len);
 483                 RETVAL.len = len;
 484         OUTPUT:
 485                 RETVAL
 486                 len
 487
 488 # TESTED
 489 void
 490 ZOOM_options_set(opt, name, v)
 491         ZOOM_options opt
 492         const char* name
 493         const char* v
 494
 495 # TESTED
 496 void
 497 ZOOM_options_setl(opt, name, value, len)
 498         ZOOM_options opt
 499         const char* name
 500         opaquechar* value
 501         int len
 502
 503 # TESTED
 504 void
 505 ZOOM_options_destroy(opt)
 506         ZOOM_options opt
 507
 508 # TESTED
 509 int
 510 ZOOM_options_get_bool(opt, name, defa)
 511         ZOOM_options opt
 512         const char* name
 513         int defa
 514
 515 # TESTED
 516 int
 517 ZOOM_options_get_int(opt, name, defa)
 518         ZOOM_options opt
 519         const char* name
 520         int defa
 521
 522 # TESTED
 523 void
 524 ZOOM_options_set_int(opt, name, value)
 525         ZOOM_options opt
 526         const char* name
 527         int value
 528
 529 # UNTESTED
 530 int
 531 ZOOM_event(no, cs)
 532         int     no
 533         ZOOM_connection *       cs
 534
 535 # UNTESTED
 536 int
 537 ZOOM_connection_last_event(cs)
 538         ZOOM_connection cs
 539