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