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