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