Changes

   1 $Id: Changes,v 1.44 2006-10-10 17:03:31 mike Exp $
   2
   3 Revision history for Perl extension Net::Z3950::ZOOM.
   4
   5 1.12  (IN PROGRESS)
   6         - Include the useful example program samples/zoom/zselect,
   7           which is installed as part of "make install".
   8         - Add ZOOM_connection_is_idle() and $conn->is_idle().
   9         - Require YAZ version 2.1.35, which is the first to provide
  10           ZOOM_connection_is_idle().
  11         - Fix bug in ZOOM::Connection class code that made the
  12           difficult to subclass -- when called as
  13           $class->SUPER::new(@_), the constructor blessed the new
  14           object into ZOOM::Connection rather than info the subclass.
  15         - ZOOM::Connection::create() may now take either a single
  16           argument, which is a ZOOM::Options object, or any even
  17           number of argument (including zero), which are key => value
  18           pairs of options to set.
  19         - ZOOM::Connection::new(), having been refactored to use
  20           create(), can now also take a ZOOM::Options argument.
  21                 ### These API changes need documenting.
  22
  23 1.11  Thu Aug 31 16:47:53 BST 2006
  24         - Require YAZ version 2.1.17, which has important ZOOM-C
  25           bug-fixes.
  26         - Do not use "-Wdeclaration-after-statement" compiler option,
  27           since this supported only by GCC (and only recent versions).
  28
  29 1.10  Thu Jun 15 16:42:47 BST 2006
  30         - No functional changes, but use Adam's modified API to
  31           ZOOM_query_ccl2rpn().  This incompatible change means that
  32           RELEASE 1.09 WILL NOT BUILD against any recent YAZ.
  33
  34 1.09  Tue Jun 13 17:44:43 2006
  35         - Add new function Net::Z3950::ZOOM::query_ccl2rpn(), for
  36           client-side CCL compilation.
  37         - Add new ZOOM::Query::CCL2RPN class, encapsulating CCL
  38           compiler functionality as a Query subclass.  This allows
  39           client-side CCL to be used for both search and scan.
  40         - Add two new error-codes, CCL_CONFIG and CCL_PARSE,
  41           returned by the client-side CCL facilities.
  42         - Supply a sample CCL profile file: samples/ccl/default.bib,
  43           copied from the same-named file distributed with YAZ.
  44         - The test-scripts t/12-query.t and t/22-query.t are extended
  45           to also test client-side CCL searching.
  46         - The test-scripts t/15-scan.t and t/25-scan.t are extended
  47           to also test client-side CCL scanning.
  48         - Documentation updated to describe use of CCL.
  49         - Add a nice, simple update client: samples/zoom/update.pl
  50
  51 1.08  Thu May 11 22:40:41 BST 2006
  52         - Requires version 2.1.11 of YAZ, not 2.0.11.  This is a
  53           bugfix: the old reliance on 2.0.11 was merely a typo.
  54
  55 1.07  Thu May 11 17:45:37 BST 2006
  56         - Makefile.PL checks for at least version 2.1.11 of YAZ, and
  57           refuses to build if it's not present.  Thanks to "gregor"
  58           (an otherwise anonymous CPAN tester) for notifying me of the
  59           previously poor reporting of failure when running against an
  60           earlier YAZ.
  61         - No changes to functionality or documentation.
  62
  63 1.06  Wed Apr 19 21:11:52 BST 2006
  64         - Avoid mixed statement/declaration in ZOOM.xs.  *sigh*  Why
  65           the heck GCC allows this by default I will never understand.
  66         - Add (commented out) OPTIMIZE option to Makefile.PL, to turn
  67           on -Wdeclaration-after-statement, which makes mixed
  68           statement/declaration illegal.
  69
  70 1.05  Wed Apr 12 13:31:27 BST 2006
  71         - Implementation of asynchronous events!  The Net::Z3950::ZOOM
  72           interface provides this through the event, last_event() and
  73           event_str() functions.  The ZOOM interface provides it
  74           through the ZOOM::event() and ZOOM:event_str() functions,
  75           and the ZOOM::Connection class's last_event() function.
  76         - New sample programs added illustrating both asynchronous
  77           interfaces: samples/net-z3950-zoom/zoomtst3.pl and
  78           samples/zoom/zoomtst3.pl respectively.  Additional sample
  79           programs "async.pl" and "trivial-async.pl" for the ZOOM
  80           interface only, the latter being a "shortest possible
  81           broadcast search application".
  82         - Added documentation on writing asynchronous applications.
  83         - Added test-scripts "t/19-events.t" and "t/29-event.t" for
  84           events on an asynchronous connection.
  85         - Fix ZOOM::Connection::new so that options are handled in
  86           accordance with the documentation: applied _before_ the
  87           connection is forged, so that "async" and similar options
  88           can take effect.
  89
  90 1.04  Mon Apr  3 14:56:11 BST 2006
  91         - The ZOOM-Perl layer now provides access to the underlying
  92           ZOOM-C's character-translation functionality, through new
  93           optional arguments to ZOOM::Record's render() and raw()
  94           methods, and a new underlying get() method.
  95
  96 1.03  Thu Mar  9 12:55:23 GMT 2006
  97         - Allow additional key => value pairs as arguments to the
  98           ZOOM::Connectoion constructor; these are added as Connection
  99           options before the protocol connection is forged.
 100
 101 1.02  Thu Mar  9 11:36:55 GMT 2006
 102         - Add interface to yaz_version().
 103         - Emit big warning at startup time if YAZ version is less than
 104           2.0.11 (which is what ZOOM-Perl 1.02 requires) unless the
 105           file /tmp/ignore-ZOOM-YAZ-version-mismatch exists.
 106         - Fix incorrect ZOOM-package URL in documentation.
 107         - Fix typo ("createdb" package) in documentation.
 108         - The ZOOM::Connection constructor may now be called with only
 109           a single argument (host-string) and does not require a
 110           dummy port-number argument.
 111
 112 1.01  Thu Dec 22 14:13:34 GMT 2005
 113         - Place some CODE: chunks in "ZOOM.xs" inside curly brackets
 114           so that the declarations they begin with are at the start of
 115           the block.  This avoid mixed code/declarations.  (The
 116           "correct" solution is to use INIT: clauses in the XS file,
 117           but they don't seem to work: the code in them is slapped
 118           down right next to the CODE:, so declarations are not
 119           acceptable there either.)
 120         - Add new function Net::Z3950::ZOOM::connection_scan1(), which
 121           uses a query object to indicate the start-term.  This opens
 122           the way for using CQL queries for scanning once the
 123           underlying ZOOM-C code supports this.
 124         - NOTE BACKWARDS-INCOMPATIBLE CHANGE: The ZOOM::Connection
 125           method scan() is renamed scan_pqf(), and a new scan() method
 126           is introduced which calls the underlying scan1() function.
 127           Thus the scan()/scan_pqf() dichotomy is consistent with that
 128           between search()/search_pqf().
 129         - The tests t/15-scan.t and t/25-scan.t now also test for
 130           scanning by CQL query.  To support these tests, a new files
 131           is added to the distribution, "samples/cql/pqf.properties"
 132         - Remove nonsensical clause about CQL sort-specifications from
 133           the documentation.
 134         - Add new function Net::Z3950::ZOOM::query_cql2rpn(), for
 135           client-side CQL compilation.
 136         - Add new ZOOM::Query::CQL2RPN class, encapsulating CQL
 137           compiler functionality as a Query subclass.
 138         - Add two new error-codes, CQL_PARSE and CQL_TRANSFORM,
 139           returned by the client-side CQL facilities.
 140         - The test-scripts t/12-query.t and t/22-query.t are extended
 141           to also test client-side CQL compilation.
 142         - Add all the yaz_log*() functions within the Net::Z3950::ZOOM
 143           namespace.
 144         - Add new ZOOM::Log class for logging, providing aliases for
 145           the functions in the Net::Z3950::ZOOM layer.
 146         - Add diagnostic set to rendering of Exception objects.
 147         - Documentation added for CQL compilation and logging.
 148
 149 1.00  Wed Dec 14 11:18:33 GMT 2005
 150         - First distributed version.
 151
 152 0.01  Fri Oct  7 16:14:20 2005
 153         - original version; created by h2xs 1.23 with options
 154                 --name=Net::Z3950::ZOOM --compat-version=5.8.0 \
 155                 --omit-constant --skip-exporter --skip-ppport \
 156                 --autogen-xsubs yaz/zoom.h -lyaz -lxml2
 157
 158 --
 159
 160 To be done in future releases:
 161         - Complete, test and document "update.pl"
 162         - Fix Net::Z3950::ZOOM::record_get() to use a struct datachunk
 163           _when_ appropriate, e.g. for "render" but probably not for
 164           "database" and "syntax".
 165         - Create old-style Net::Z3950 compatibility layer.
 166         - Fix memory leaks in callback functions for option sets.
 167         - Fix limitation that option-set callback functions must be
 168           specified as strings containing package-qualified function
 169           names.
 170