Changes

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