-# $Id: ZOOM.pm,v 1.4 2005-10-12 09:44:46 mike Exp $
+# $Id: ZOOM.pm,v 1.9 2005-10-24 16:42:16 mike Exp $
use strict;
use warnings;
use Net::Z3950::ZOOM;
+package ZOOM;
+
+sub diag_str {
+ my($code) = @_;
+ return Net::Z3950::ZOOM::diag_str($code);
+}
+
+
# Member naming convention: hash-element names which begin with an
# underscore represent underlying ZOOM-C object descriptors; those
# which lack them represent Perl's ZOOM objects. (The same convention
# ----------------------------------------------------------------------------
+# The "Error" package contains constants returned as error-codes.
+package ZOOM::Error;
+sub NONE { Net::Z3950::ZOOM::ERROR_NONE }
+sub CONNECT { Net::Z3950::ZOOM::ERROR_CONNECT }
+sub MEMORY { Net::Z3950::ZOOM::ERROR_MEMORY }
+sub ENCODE { Net::Z3950::ZOOM::ERROR_ENCODE }
+sub DECODE { Net::Z3950::ZOOM::ERROR_DECODE }
+sub CONNECTION_LOST { Net::Z3950::ZOOM::ERROR_CONNECTION_LOST }
+sub INIT { Net::Z3950::ZOOM::ERROR_INIT }
+sub INTERNAL { Net::Z3950::ZOOM::ERROR_INTERNAL }
+sub TIMEOUT { Net::Z3950::ZOOM::ERROR_TIMEOUT }
+sub UNSUPPORTED_PROTOCOL { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_PROTOCOL }
+sub UNSUPPORTED_QUERY { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_QUERY }
+sub INVALID_QUERY { Net::Z3950::ZOOM::ERROR_INVALID_QUERY }
+
+# The "Event" package contains constants returned by last_event()
+package ZOOM::Event;
+sub NONE { Net::Z3950::ZOOM::EVENT_NONE }
+sub CONNECT { Net::Z3950::ZOOM::EVENT_CONNECT }
+sub SEND_DATA { Net::Z3950::ZOOM::EVENT_SEND_DATA }
+sub RECV_DATA { Net::Z3950::ZOOM::EVENT_RECV_DATA }
+sub TIMEOUT { Net::Z3950::ZOOM::EVENT_TIMEOUT }
+sub UNKNOWN { Net::Z3950::ZOOM::EVENT_UNKNOWN }
+sub SEND_APDU { Net::Z3950::ZOOM::EVENT_SEND_APDU }
+sub RECV_APDU { Net::Z3950::ZOOM::EVENT_RECV_APDU }
+sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
+sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
+
+
+# ----------------------------------------------------------------------------
+
package ZOOM::Exception;
sub new {
my $class = shift();
my($code, $message, $addinfo) = @_;
+ ### support diag-set, too
return bless {
code => $code,
sub code {
my $this = shift();
- return $this->code();
+ return $this->{code};
}
sub message {
my $this = shift();
- return $this->message();
+ return $this->{message};
}
sub addinfo {
my $this = shift();
- return $this->addinfo();
+ return $this->{addinfo};
+}
+
+
+# ----------------------------------------------------------------------------
+
+package ZOOM::Options;
+
+sub new {
+ my $class = shift();
+ my($p1, $p2) = @_;
+
+ my $opts;
+ if (@_ == 0) {
+ $opts = Net::Z3950::ZOOM::options_create();
+ } elsif (@_ == 1) {
+ $opts = Net::Z3950::ZOOM::options_create_with_parent($p1->_opts());
+ } elsif (@_ == 2) {
+ $opts = Net::Z3950::ZOOM::options_create_with_parent2($p1->_opts(),
+ $p2->_opts());
+ } else {
+ die "can't make $class object with more than 2 parents";
+ }
+
+ return bless {
+ _opts => $opts,
+ }, $class;
+}
+
+sub _opts {
+ my $this = shift();
+
+ my $_opts = $this->{_opts};
+ die "{_opts} undefined: has this Options block been destroy()ed?"
+ if !defined $_opts;
+
+ return $_opts;
+}
+
+sub option {
+ my $this = shift();
+ my($key, $value) = @_;
+
+ my $oldval = Net::Z3950::ZOOM::options_get($this->_opts(), $key);
+ Net::Z3950::ZOOM::options_set($this->_opts(), $key, $value)
+ if defined $value;
+
+ return $oldval;
+}
+
+sub option_binary {
+ my $this = shift();
+ my($key, $value) = @_;
+
+ my $dummylen = 0;
+ my $oldval = Net::Z3950::ZOOM::options_getl($this->_opts(),
+ $key, $dummylen);
+ Net::Z3950::ZOOM::options_setl($this->_opts(), $key,
+ $value, length($value))
+ if defined $value;
+
+ return $oldval;
+}
+
+# This is a bit stupid, since the scalar values that Perl returns from
+# option() can be used as a boolean; but it's just possible that some
+# applications will rely on ZOOM_options_get_bool()'s idiosyncratic
+# interpretation of what constitutes truth.
+#
+sub bool {
+ my $this = shift();
+ my($key, $default) = @_;
+
+ return Net::Z3950::ZOOM::options_get_bool($this->_opts(), $key, $default);
+}
+
+# .. and the next two are even more stupid
+sub int {
+ my $this = shift();
+ my($key, $default) = @_;
+
+ return Net::Z3950::ZOOM::options_get_int($this->_opts(), $key, $default);
+}
+
+sub set_int {
+ my $this = shift();
+ my($key, $value) = @_;
+
+ Net::Z3950::ZOOM::options_set_int($this->_opts(), $key, $value);
+}
+
+# ### Feel guilty. Feel very, very guilty. I've not been able to
+# get the callback memory-management right in "ZOOM.xs", with
+# the result that the values of $function and $udata passed into
+# this function, which are on the stack, have sometimes been
+# freed by the time they're used by __ZOOM_option_callback(),
+# with hilarious results. To avoid this, I copy the values into
+# module-scoped globals, and pass _those_ into the extension
+# function. To avoid overwriting those globals by subsequent
+# calls, I keep all the old ones, pushed onto the @_function and
+# @_udata arrays, which means that THIS FUNCTION LEAKS MEMORY
+# LIKE IT'S GOING OUT OF FASHION. Not nice. One day, I should
+# fix this, but for now there's more important fish to fry.
+#
+my(@_function, @_udata);
+sub set_callback {
+ my $o1 = shift();
+ my($function, $udata) = @_;
+
+ push @_function, $function;
+ push @_udata, $udata;
+ Net::Z3950::ZOOM::options_set_callback($o1->_opts(),
+ $_function[-1], $_udata[-1]);
+}
+
+sub destroy {
+ my $this = shift();
+
+ Net::Z3950::ZOOM::options_destroy($this->_opts());
+ $this->{_opts} = undef;
}
};
}
+sub create {
+ my $class = shift();
+ my($options) = @_;
+
+ my $_conn = Net::Z3950::ZOOM::connection_create($options->_opts());
+ return bless {
+ host => undef,
+ port => undef,
+ _conn => $_conn,
+ };
+}
+
# PRIVATE within this class
sub _conn {
my $this = shift();
return $_conn;
}
+sub error_x {
+ my $this = shift();
+
+ my($errcode, $errmsg, $addinfo, $diagset) = (undef, "dummy", "dummy", "d");
+ $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
+ $addinfo, $diagset);
+ return ($errcode, $errmsg, $addinfo, $diagset);
+}
+
+sub errcode {
+ my $this = shift();
+ return Net::Z3950::ZOOM::connection_errcode($this->_conn());
+}
+
+sub errmsg {
+ my $this = shift();
+ return Net::Z3950::ZOOM::connection_errmsg($this->_conn());
+}
+
+sub addinfo {
+ my $this = shift();
+ return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
+}
+
+sub connect {
+ my $this = shift();
+ my($host, $port) = @_;
+
+ Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
+ my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
+ $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
+ $errmsg, $addinfo);
+ die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
+ # No return value
+}
+
sub option {
my $this = shift();
my($key, $value) = @_;
return $oldval;
}
+sub option_binary {
+ my $this = shift();
+ my($key, $value) = @_;
+
+ my $dummylen = 0;
+ my $oldval = Net::Z3950::ZOOM::connection_option_getl($this->_conn(),
+ $key, $dummylen);
+ Net::Z3950::ZOOM::connection_option_setl($this->_conn(), $key,
+ $value, length($value))
+ if defined $value;
+
+ return $oldval;
+}
+
+
sub search_pqf {
my $this = shift();
my($query) = @_;
# ----------------------------------------------------------------------------
+package ZOOM::Query;
+
+sub new {
+ my $class = shift();
+ die "You can't create $class objects: it's a virtual base class";
+
+}
+
+
+package ZOOM::Query::RPN;
+
+sub new {
+ my $class = shift();
+
+ ### Er ...
+}
+
+
+# ----------------------------------------------------------------------------
+
package ZOOM::ResultSet;
sub new {