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