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