ZOOM.xs

   1 /* $Id: ZOOM.xs,v 1.20 2005-11-02 18:23:10 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 # UNTESTED
 214 int
 215 ZOOM_connection_last_event(cs)
 216         ZOOM_connection cs
 217
 218 # TESTED
 219 ZOOM_resultset
 220 ZOOM_connection_search(arg0, q)
 221         ZOOM_connection arg0
 222         ZOOM_query q
 223
 224 # TESTED
 225 ZOOM_resultset
 226 ZOOM_connection_search_pqf(c, q)
 227         ZOOM_connection c
 228         const char *q
 229
 230 # TESTED
 231 void
 232 ZOOM_resultset_destroy(r)
 233         ZOOM_resultset r
 234
 235 # TESTED
 236 const char *
 237 ZOOM_resultset_option_get(r, key)
 238         ZOOM_resultset r
 239         const char* key
 240
 241 # TESTED
 242 void
 243 ZOOM_resultset_option_set(r, key, val)
 244         ZOOM_resultset r
 245         const char* key
 246         const char* val
 247
 248 # TESTED
 249 size_t
 250 ZOOM_resultset_size(r)
 251         ZOOM_resultset r
 252
 253 # TESTING
 254 SV *
 255 ZOOM_resultset_records(r, start, count, return_values)
 256         ZOOM_resultset r
 257         size_t start
 258         size_t count
 259         int return_values
 260         INIT:
 261                 ZOOM_record *recs;
 262         CODE:
 263                 /*printf("*** ZOOM_resultset_records(r=0x%lx, start=%lu, count=%lx, return_values=%d)\n", (unsigned long) r, (unsigned long) start, (unsigned long) count, return_values);*/
 264                 if (return_values) {
 265                         /*printf("*** generating space for %ld records\n", (unsigned long) count);*/
 266                         recs = (ZOOM_record*) xmalloc(count * sizeof *recs);
 267                 } else {
 268                         /*printf("*** using null pointer for records array\n");*/
 269                         recs = 0;
 270                 }
 271                 ZOOM_resultset_records(r, recs, start, count);
 272                 /*printf("*** returned from ZOOM_resultset_records()\n");*/
 273                 if (return_values) {
 274                         AV *av = newAV();
 275                         int i;
 276                         for (i = 0; i < count; i++) {
 277                                 SV *tmp = sv_newmortal();
 278                                 printf("*** recs[%d] = %lu\n", i, (unsigned long) recs[i]);
 279                                 /* ### Next line fails.  Damn and blast Perl */
 280                                 sv_setref_pv(tmp, "ZOOM_record", (void*) recs[i]);
 281                                 av_push(av, tmp);
 282                         }
 283                         RETVAL = newRV((SV*) av);
 284                         printf("*** returning array %lu\n", (unsigned long) RETVAL);
 285                 } else {
 286                         /*printf("*** returning undef\n");*/
 287                         RETVAL = &PL_sv_undef;
 288                 }
 289         OUTPUT:
 290                 RETVAL
 291
 292 # TESTED
 293 ZOOM_record
 294 ZOOM_resultset_record(s, pos)
 295         ZOOM_resultset s
 296         size_t pos
 297
 298 # TESTED
 299 ZOOM_record
 300 ZOOM_resultset_record_immediate(s, pos)
 301         ZOOM_resultset s
 302         size_t pos
 303
 304 # TESTED
 305 void
 306 ZOOM_resultset_cache_reset(r)
 307         ZOOM_resultset r
 308
 309 # See "typemap" for discussion of the "const char *" return-type.
 310 #
 311 # TESTED
 312 ### but should use datachunk for in some (not all!) cases.
 313 const char *
 314 ZOOM_record_get(rec, type, len)
 315         ZOOM_record rec
 316         const char* type
 317         int &len
 318         OUTPUT:
 319                 RETVAL
 320                 len
 321
 322 # UNTESTED
 323 void
 324 ZOOM_record_destroy(rec)
 325         ZOOM_record     rec
 326
 327 # UNTESTED
 328 ZOOM_record
 329 ZOOM_record_clone(srec)
 330         ZOOM_record     srec
 331
 332 # TESTED
 333 ZOOM_query
 334 ZOOM_query_create()
 335
 336 # TESTED
 337 void
 338 ZOOM_query_destroy(s)
 339         ZOOM_query s
 340
 341 # TESTED
 342 int
 343 ZOOM_query_cql(s, str)
 344         ZOOM_query s
 345         const char* str
 346
 347 # TESTED
 348 int
 349 ZOOM_query_prefix(s, str)
 350         ZOOM_query s
 351         const char* str
 352
 353 # TESTED
 354 int
 355 ZOOM_query_sortby(s, criteria)
 356         ZOOM_query      s
 357         const char *    criteria
 358
 359 # UNTESTED
 360 ZOOM_scanset
 361 ZOOM_connection_scan(c, startterm)
 362         ZOOM_connection c
 363         const char *    startterm
 364
 365 # UNTESTED
 366 const char *
 367 ZOOM_scanset_term(scan, pos, occ, len)
 368         ZOOM_scanset    scan
 369         size_t  pos
 370         int *   occ
 371         int *   len
 372
 373 # UNTESTED
 374 const char *
 375 ZOOM_scanset_display_term(scan, pos, occ, len)
 376         ZOOM_scanset    scan
 377         size_t  pos
 378         int *   occ
 379         int *   len
 380
 381 # UNTESTED
 382 size_t
 383 ZOOM_scanset_size(scan)
 384         ZOOM_scanset    scan
 385
 386 # UNTESTED
 387 void
 388 ZOOM_scanset_destroy(scan)
 389         ZOOM_scanset    scan
 390
 391 # UNTESTED
 392 const char *
 393 ZOOM_scanset_option_get(scan, key)
 394         ZOOM_scanset    scan
 395         const char *    key
 396
 397 # UNTESTED
 398 void
 399 ZOOM_scanset_option_set(scan, key, val)
 400         ZOOM_scanset    scan
 401         const char *    key
 402         const char *    val
 403
 404 # UNTESTED
 405 ZOOM_package
 406 ZOOM_connection_package(c, options)
 407         ZOOM_connection c
 408         ZOOM_options    options
 409
 410 # UNTESTED
 411 void
 412 ZOOM_package_destroy(p)
 413         ZOOM_package    p
 414
 415 # UNTESTED
 416 void
 417 ZOOM_package_send(p, type)
 418         ZOOM_package    p
 419         const char *    type
 420
 421 # UNTESTED
 422 const char *
 423 ZOOM_package_option_get(p, key)
 424         ZOOM_package    p
 425         const char *    key
 426
 427 # UNTESTED
 428 void
 429 ZOOM_package_option_set(p, key, val)
 430         ZOOM_package    p
 431         const char *    key
 432         const char *    val
 433
 434 # UNTESTED
 435 void
 436 ZOOM_resultset_sort(r, sort_type, sort_spec)
 437         ZOOM_resultset  r
 438         const char *    sort_type
 439         const char *    sort_spec
 440
 441 # We ignore the return value of ZOOM_options_set_callback(), since it
 442 # is always just the address of the __ZOOM_option_callback() function.
 443 # The information that we actually want -- the address of the Perl
 444 # function in the callback_block -- is unavailable to us, as the
 445 # underlying C function doesn't give the block back.
 446 #
 447 # TESTED
 448 void
 449 ZOOM_options_set_callback(opt, function, handle)
 450         ZOOM_options opt
 451         SV* function;
 452         SV* handle;
 453         CODE:
 454                 /* The tiny amount of memory allocated here is never
 455                  * released, as options_destroy() doesn't do anything
 456                  * to the callback information.  Not a big deal.
 457                  * Also, I have no idea how to drive the Perl "mortal"
 458                  * reference-counting stuff, so I am just allocating
 459                  * copies which also never get released.  Don't sue!
 460                  */
 461                 struct callback_block *block = (struct callback_block*)
 462                         xmalloc(sizeof *block);
 463                 block->function = function;
 464                 block->handle = handle;
 465                 SvREFCNT(block->function);
 466                 SvREFCNT(block->handle);
 467                 ZOOM_options_set_callback(opt, __ZOOM_option_callback,
 468                                           (void*) block);
 469
 470 # TESTED
 471 ZOOM_options
 472 ZOOM_options_create()
 473
 474 # TESTED
 475 ZOOM_options
 476 ZOOM_options_create_with_parent(parent)
 477         ZOOM_options parent
 478
 479 # TESTED
 480 ZOOM_options
 481 ZOOM_options_create_with_parent2(parent1, parent2)
 482         ZOOM_options parent1
 483         ZOOM_options parent2
 484
 485 # TESTED
 486 const char *
 487 ZOOM_options_get(opt, name)
 488         ZOOM_options opt
 489         const char* name
 490
 491 # TESTED
 492 struct datachunk
 493 ZOOM_options_getl(opt, name, len)
 494         ZOOM_options opt
 495         const char* name
 496         int &len
 497         CODE:
 498                 RETVAL.data = (char*) ZOOM_options_getl(opt, name, &len);
 499                 RETVAL.len = len;
 500         OUTPUT:
 501                 RETVAL
 502                 len
 503
 504 # TESTED
 505 void
 506 ZOOM_options_set(opt, name, v)
 507         ZOOM_options opt
 508         const char* name
 509         const char* v
 510
 511 # TESTED
 512 void
 513 ZOOM_options_setl(opt, name, value, len)
 514         ZOOM_options opt
 515         const char* name
 516         opaquechar* value
 517         int len
 518
 519 # TESTED
 520 void
 521 ZOOM_options_destroy(opt)
 522         ZOOM_options opt
 523
 524 # TESTED
 525 int
 526 ZOOM_options_get_bool(opt, name, defa)
 527         ZOOM_options opt
 528         const char* name
 529         int defa
 530
 531 # TESTED
 532 int
 533 ZOOM_options_get_int(opt, name, defa)
 534         ZOOM_options opt
 535         const char* name
 536         int defa
 537
 538 # TESTED
 539 void
 540 ZOOM_options_set_int(opt, name, value)
 541         ZOOM_options opt
 542         const char* name
 543         int value
 544
 545 # UNTESTED
 546 int
 547 ZOOM_event(no, cs)
 548         int     no
 549         ZOOM_connection *       cs
 550