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