ZOOM.xs

   1 #include "EXTERN.h"
   2 #include "perl.h"
   3 #include "XSUB.h"
   4
   5 #include <yaz/zoom.h>
   6
   7
   8 MODULE = Net::Z3950::ZOOM               PACKAGE = Net::Z3950::ZOOM
   9
  10 PROTOTYPES: ENABLE
  11
  12
  13 # It seems that when one of these functions is called from Perl with
  14 # a string-constant argument, that is not recognised as suitable to
  15 # be mapped onto a "const char*" argument.  The only fix I can find is
  16 # to delete as the "const" qualifiers from "char*" arguments:
  17 # overriding the auto-generated prototyping with PROTOTYPE: $$
  18 # doesn't help (and indeed seems to make no difference at all).
  19 #
  20 ZOOM_connection
  21 ZOOM_connection_new(host, portnum)
  22         char* host
  23         int portnum
  24
  25 ZOOM_connection
  26 ZOOM_connection_create(options)
  27         ZOOM_options    options
  28
  29 void
  30 ZOOM_connection_connect(c, host, portnum)
  31         ZOOM_connection c
  32         const char *    host
  33         int     portnum
  34
  35 void
  36 ZOOM_connection_destroy(c)
  37         ZOOM_connection c
  38
  39 const char *
  40 ZOOM_connection_option_get(c, key)
  41         ZOOM_connection c
  42         const char *    key
  43
  44 void
  45 ZOOM_connection_option_set(c, key, val)
  46         ZOOM_connection c
  47         const char *    key
  48         const char *    val
  49
  50 void
  51 ZOOM_connection_option_setl(c, key, val, len)
  52         ZOOM_connection c
  53         const char *    key
  54         const char *    val
  55         int     len
  56
  57 # The reference parameters, `cp' and `addinfo', need to already have
  58 # values when this function is called, otherwise an "uninitialised
  59 # value" warning is generated.  As far as I can see, there is no way
  60 # around this: no way to specify in a prototype that an argument is
  61 # allowed to be undefined, for example.  Since these function will
  62 # never be called directly by well-behaved client code, but only by
  63 # our own wrapper classes, I think we can live with that.
  64 #
  65 # The poxing about with cpp and caddinfo is due to Perl XS's lack of
  66 # support for const char**, but who can blame it?  If you ask me, the
  67 # whole "const" thing was well-intentioned by ghastly mistake.
  68 #
  69 int
  70 ZOOM_connection_error(c, cp, addinfo)
  71         ZOOM_connection c
  72         char* &cp
  73         char* &addinfo
  74         CODE:
  75                 const char *ccp, *caddinfo;
  76                 RETVAL = ZOOM_connection_error(c, &ccp, &caddinfo);
  77                 cp = (char*) ccp;
  78                 addinfo = (char*) caddinfo;
  79         OUTPUT:
  80                 RETVAL
  81                 cp
  82                 addinfo
  83
  84 int
  85 ZOOM_connection_error_x(c, cp, addinfo, diagset)
  86         ZOOM_connection c
  87         const char **   cp
  88         const char **   addinfo
  89         const char **   diagset
  90
  91 int
  92 ZOOM_connection_errcode(c)
  93         ZOOM_connection c
  94
  95 const char *
  96 ZOOM_connection_errmsg(c)
  97         ZOOM_connection c
  98
  99 const char *
 100 ZOOM_connection_addinfo(c)
 101         ZOOM_connection c
 102
 103 const char *
 104 ZOOM_diag_str(error)
 105         int     error
 106
 107 int
 108 ZOOM_connection_last_event(cs)
 109         ZOOM_connection cs
 110
 111 ZOOM_resultset
 112 ZOOM_connection_search(arg0, q)
 113         ZOOM_connection arg0
 114         ZOOM_query      q
 115
 116 # "const" discarded from type of `q'
 117 ZOOM_resultset
 118 ZOOM_connection_search_pqf(c, q)
 119         ZOOM_connection c
 120         char *q
 121
 122 void
 123 ZOOM_resultset_destroy(r)
 124         ZOOM_resultset  r
 125
 126 const char *
 127 ZOOM_resultset_option_get(r, key)
 128         ZOOM_resultset  r
 129         const char *    key
 130
 131 void
 132 ZOOM_resultset_option_set(r, key, val)
 133         ZOOM_resultset  r
 134         const char *    key
 135         const char *    val
 136
 137 size_t
 138 ZOOM_resultset_size(r)
 139         ZOOM_resultset  r
 140
 141 void
 142 ZOOM_resultset_records(r, recs, start, count)
 143         ZOOM_resultset  r
 144         ZOOM_record *   recs
 145         size_t  start
 146         size_t  count
 147
 148 ZOOM_record
 149 ZOOM_resultset_record(s, pos)
 150         ZOOM_resultset  s
 151         size_t  pos
 152
 153 ZOOM_record
 154 ZOOM_resultset_record_immediate(s, pos)
 155         ZOOM_resultset  s
 156         size_t  pos
 157
 158 void
 159 ZOOM_resultset_cache_reset(r)
 160         ZOOM_resultset  r
 161
 162 const char *
 163 ZOOM_record_get(rec, type, len)
 164         ZOOM_record     rec
 165         const char *    type
 166         int *   len
 167
 168 void
 169 ZOOM_record_destroy(rec)
 170         ZOOM_record     rec
 171
 172 ZOOM_record
 173 ZOOM_record_clone(srec)
 174         ZOOM_record     srec
 175
 176 ZOOM_query
 177 ZOOM_query_create()
 178
 179 void
 180 ZOOM_query_destroy(s)
 181         ZOOM_query      s
 182
 183 int
 184 ZOOM_query_cql(s, str)
 185         ZOOM_query      s
 186         const char *    str
 187
 188 int
 189 ZOOM_query_prefix(s, str)
 190         ZOOM_query      s
 191         const char *    str
 192
 193 int
 194 ZOOM_query_sortby(s, criteria)
 195         ZOOM_query      s
 196         const char *    criteria
 197
 198 ZOOM_scanset
 199 ZOOM_connection_scan(c, startterm)
 200         ZOOM_connection c
 201         const char *    startterm
 202
 203 const char *
 204 ZOOM_scanset_term(scan, pos, occ, len)
 205         ZOOM_scanset    scan
 206         size_t  pos
 207         int *   occ
 208         int *   len
 209
 210 const char *
 211 ZOOM_scanset_display_term(scan, pos, occ, len)
 212         ZOOM_scanset    scan
 213         size_t  pos
 214         int *   occ
 215         int *   len
 216
 217 size_t
 218 ZOOM_scanset_size(scan)
 219         ZOOM_scanset    scan
 220
 221 void
 222 ZOOM_scanset_destroy(scan)
 223         ZOOM_scanset    scan
 224
 225 const char *
 226 ZOOM_scanset_option_get(scan, key)
 227         ZOOM_scanset    scan
 228         const char *    key
 229
 230 void
 231 ZOOM_scanset_option_set(scan, key, val)
 232         ZOOM_scanset    scan
 233         const char *    key
 234         const char *    val
 235
 236 ZOOM_package
 237 ZOOM_connection_package(c, options)
 238         ZOOM_connection c
 239         ZOOM_options    options
 240
 241 void
 242 ZOOM_package_destroy(p)
 243         ZOOM_package    p
 244
 245 void
 246 ZOOM_package_send(p, type)
 247         ZOOM_package    p
 248         const char *    type
 249
 250 const char *
 251 ZOOM_package_option_get(p, key)
 252         ZOOM_package    p
 253         const char *    key
 254
 255 void
 256 ZOOM_package_option_set(p, key, val)
 257         ZOOM_package    p
 258         const char *    key
 259         const char *    val
 260
 261 void
 262 ZOOM_resultset_sort(r, sort_type, sort_spec)
 263         ZOOM_resultset  r
 264         const char *    sort_type
 265         const char *    sort_spec
 266
 267 ZOOM_options_callback
 268 ZOOM_options_set_callback(opt, c, handle)
 269         ZOOM_options    opt
 270         ZOOM_options_callback   c
 271         void *  handle
 272
 273 ZOOM_options
 274 ZOOM_options_create()
 275
 276 ZOOM_options
 277 ZOOM_options_create_with_parent(parent)
 278         ZOOM_options    parent
 279
 280 ZOOM_options
 281 ZOOM_options_create_with_parent2(parent1, parent2)
 282         ZOOM_options    parent1
 283         ZOOM_options    parent2
 284
 285 const char *
 286 ZOOM_options_get(opt, name)
 287         ZOOM_options    opt
 288         const char *    name
 289
 290 void
 291 ZOOM_options_set(opt, name, v)
 292         ZOOM_options    opt
 293         const char *    name
 294         const char *    v
 295
 296 void
 297 ZOOM_options_setl(opt, name, value, len)
 298         ZOOM_options    opt
 299         const char *    name
 300         const char *    value
 301         int     len
 302
 303 void
 304 ZOOM_options_destroy(opt)
 305         ZOOM_options    opt
 306
 307 int
 308 ZOOM_options_get_bool(opt, name, defa)
 309         ZOOM_options    opt
 310         const char *    name
 311         int     defa
 312
 313 int
 314 ZOOM_options_get_int(opt, name, defa)
 315         ZOOM_options    opt
 316         const char *    name
 317         int     defa
 318
 319 void
 320 ZOOM_options_set_int(opt, name, value)
 321         ZOOM_options    opt
 322         const char *    name
 323         int     value
 324
 325 int
 326 ZOOM_event(no, cs)
 327         int     no
 328         ZOOM_connection *       cs
 329