scriptindex: date=unix is now a no-op for empty input
[xapian.git] / xapian-bindings / NEWS
blobb47b573d0b0d183273caeca1ac7d28d05b530cf7
1 Xapian-bindings 1.4.8 (2018-10-25):
3 Perl:
5 * Wrap new STEM_SOME_FULL_POS constant.
7 * Add STEM_ALL_Z to qpstem export tag and POD docs.
9 * Fix Perl bindings documentation typos.
11 Python:
13 * Fix RST formatting warning during build.
14     
15 Python3:
17 * Fix RST formatting warning during build.
18     
19 Xapian-bindings 1.4.7 (2018-07-19):
21 Ruby:
23 * Fix -Wconversion-null warnings with newer GCC.
25 Xapian-bindings 1.4.6 (2018-07-02):
27 Documentation:
29 * Stop using "probabilistic" to mean "weighted" - we've supported other
30   families of weighting schemes since 1.3.2.
32 Packaging:
34 * Use https for tarball URLs in .spec files.  This provides protection against
35   MITM attacks on people building packages using these spec files, and is also
36   slightly more efficient as the http: URLs redirect to the https: versions
37   anyway.
39 CSharp:
41 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
42   with older SWIG, but it does with current versions, and using it means that
43   we skip any return value translation logic when an exception has been thrown.
45 Java:
47 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
48   with older SWIG, but it does with current versions, and using it means that
49   we skip any return value translation logic when an exception has been thrown.
51 * Fix leaks in binary std::string typemaps.  These are used for document values
52   and serialised data.
54 * Improve VPATH build.  Previously we looked for class files and java sources
55   in srcdir first, then in builddir.  That's backwards from how autotools
56   VPATH builds search for targets and prerequisites so reverse this order to
57   make handling of Java files more consistent.
59 Perl:
61 * Invoke prove via the App::Prove module.  This avoids potentially using
62   prove from a different Perl installation to perl (previously the user
63   needed to manually specify the corresponding PROVE= if they specify PERL= to
64   configure).  In particular this is useful on macOS when using Perl from
65   homebrew.
67 * Improve Perl Enquire::set_docid_order documentation by syncing improvements
68   from the C++ API docs.
70 Python:
72 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
73   James Aylett.
75 * Suppress clang -Wdeprecated-register warnings about uses register in C code
76   in Python.h.  We can't do anything about these other than suppress them.
78 Python3:
80 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
81   James Aylett.
83 * Suppress clang -Wdeprecated-register warnings about uses register in C code
84   in Python.h.  We can't do anything about these other than suppress them
85   (and they appear to have been removed in Python 3.4 and later).
87 * Remove unused MSet::__cmp__ extend method.  This was used in Python 2, but
88   Python 3 does things differently.  There doesn't seem a good reason to
89   provide comparison operations for MSet objects, and we don't for other
90   classes, so let's just drop this feature - it seems nobody has noticed it has
91   gone.
93 * Simplify generated wrapper post-processing.
95 Xapian-bindings 1.4.5 (2017-10-16):
97 Documentation:
99 * HACKING: Add details of Debian PHP7 packages to install for development.
101 General:
103 * Use a pattern match to ignore methods meant for internal use only rather
104   than having to list them all - they're consistently named to end with an
105   underscore.
107 * Stop using deprecated Xapian::percent typedef in bindings-specific code.
108   Deprecation warnings are suppressed when building the bindings (because the
109   bindings usually still need to wrap deprecated C++ features) so this probably
110   has no user-visible consequences.
112 Java:
114 * Fix JNI code to be compatible with Java 6 and earlier, where the final
115   parameter of SetByteArrayRegion() was not const.  This also seems to affect
116   GCJ (though GCJ was removed in GCC 7).  The incompatibility was introduced in
117   1.4.4.
119 Lua:
121 * Support subclassing of RangeProcessor in Lua.
123 Perl:
125 * Add CLONE_SKIP to RangeProcessor and subclases to avoid double deletion
126   if the Perl threads module is in use.
128 * Keep references for set RangeProcessor objects, like how we do for
129   ValueRangeProcessor and various other functor objects.
131 * Use RangeProcessor instead of ValueRangeProcessor in perl examples, as
132   ValueRangeProcessor is now deprecated.
134 PHP:
136 * Keep references for set RangeProcessor objects, like how we do for
137   ValueRangeProcessor and various other functor objects.
139 * Add type hints to QueryParser::add_rangeprocessor().
141 PHP7:
143 * Keep references for set RangeProcessor objects, like how we do for
144   ValueRangeProcessor and various other functor objects.
146 * Add type hints to QueryParser::add_rangeprocessor().
148 * Fix PHP7 "make check" to use right path separator.  It was using the PHP5
149   one, which in general is going to be the same but we won't have probed for
150   that unless we're also building the PHP5 bindings, which means "make check"
151   failed for PHP7 unless you also had the PHP5 bindings enabled.
153 Python3:
155 * Fix "make check" under Python 3.2, which was broken in 1.4.4 because Python
156   3.2 doesn't support the u'foo' syntax.
158 * Copy over Python2 check which aims to catch any internal functions, methods,
159   constants, etc which have accidentally been wrapped.
161 Ruby:
163 * Fix dependency generation for Ruby SWIG command (only relevant at all if
164   you configure with --enable-maintainer-mode).
166 Xapian-bindings 1.4.4 (2017-04-19):
168 General:
170 * Update tests for xapian-core changes to avoid unnecessary "0 *" in query
171   descriptions in certain cases.
173 Packaging:
175 * Ship java.i in tarball.
177 Java:
179 * Handle object serialisations and document values as Java byte[].  These will
180   usually contain binary data, so Java String doesn't work well and byte[] is a
181   much better fit.
183 * Correct various errors in java examples and documentation on how to run them.
185 * Fix java examples not to abuse doc values as fields - use the document data
186   instead.
188 * "make clean" now removes additional class files.
190 PHP7:
192 * Update version of SWIG required to >= 3.0.12 so that the code generated
193   for PHP7 no longer results in a segmentation fault on module unload with
194   PHP 7.1.  Fixes #748, reported by Victor Sakovich.
196 Python:
198 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
199   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
200   https://bugs.debian.org/849722
202 * Fix configure --with-python to fail if sphinx isn't found.  Patch from
203   Patricio Paez.  Fixes #749.
205 Python3:
207 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
208   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
209   https://bugs.debian.org/849722
211 Xapian-bindings 1.4.3 (2017-01-25):
213 Python:
215 * Remove compatibility code for Python < 2.5 - 1.4.x requires Python >= 2.6.
217 * Avoid unnecessary pointer indirection in XapianSWIG_anystring() helper
218   function, which should be a little more efficient and makes the Python 2
219   code more closely match the Python 3 code.
221 Ruby:
223 * "make clean" should only remove docs/xapian.rb if configure option
224   --enable-documentation was used to enable all rules to rebuild documentation.
225   Reported by Samuel Williams on xapian-discuss.
227 * Fix make rule for running rdoc for the cases where srcdir != builddir.
229 * Use 'test a = b' rather than 'test a == b' - the former is portable, the
230   latter a bashism.  In many cases the autotools will set SHELL = /bin/bash in
231   the makefiles, but if it doesn't and /bin/sh isn't bash, then this will
232   cause "make install" and "make uninstall" to fail for the Ruby bindings.
234 Xapian-bindings 1.4.2 (2016-12-26):
236 General:
238 * configure: Fail with clear error with xapian-core < 1.4.0.
240 * Work around OS X "System Integrity Protection".  We can't address the problem
241   of being unable to run tests against an uninstalled tree when the interpreter
242   is in a system directory (you have to "make install" in xapian-core for that
243   case), but we can at least make this work for interpreters which aren't in
244   system directories.
246 Java:
248 * Disable parallel make for java subdirectory as it causes random build
249   failures.  Reported by Lucas Nussbaum in https://bugs.debian.org/848733
251 * Disable automatic use of -Xcheck:jni for now as it seems to report false
252   positives with OpenJDK 8 and 9.
254 PHP:
256 * Generates smaller PHP wrappers by only emitting each unique arginfo
257   combination once (~6% saving in stripped extension module size for
258   PHP7 on x86_64 Linux).
260 * Fix to work again with a version of PHP5 built with ZTS enabled (which is the
261   default on Microsoft Windows).
263 * Add support for PHP7.
265 * Drop workaround for PHP4 from test code.
267 Python:
269 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
270   from a command line Python code snippet.  Reported by Alex Dunn in
271   https://github.com/xapian/xapian/pull/126 and solved with help from James
272   Aylett.
274 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
275   need to keep such a reference (as we already do for ValueRangeProcessor and
276   several other classes).
278 Python3:
280 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
281   from a command line Python code snippet.  Reported by Alex Dunn in
282   https://github.com/xapian/xapian/pull/126 and solved with help from James
283   Aylett.
285 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
286   need to keep such a reference (as we already do for ValueRangeProcessor and
287   several other classes).
289 Ruby:
291 * Use more conventional Ruby variable names in the examples (Ruby convention
292   uses underscores not camelcase) and fix comma/space transposition in a couple
293   of places.
295 Xapian-bindings 1.4.1 (2016-10-21):
297 Documentation:
299 * Fix --disable-documentation - in maintainer-mode, we still tried to make
300   docs/index.html for most of the bindings, which failed because the rule to do
301   so was disabled.
303 General:
305 * Update for additions to C++ API.
307 * When a backend is disabled in the xapian-core we're building against, we
308   have a stub version of any factory functions so the bindings still have
309   something to wrap.  Update these for 1.4:
310   + Disable stub for InMemory::open() when
311     XAPIAN_BINDINGS_SKIP_DEPRECATED_DB_FACTORIES is defined (Perl, Python3).
312   + Add new optional flags parameter to both overloaded forms of
313     Remote::open_writable().
315 Portability:
317 * Drop compiler options that are no longer useful:
318   + -fshow-column is the default in all GCC versions we now support
319     (checked as GCC 4.6).
320   + -Wno-long-long is no longer necessary now that we require C++11 where
321     "long long" is a standard type.
323 Java:
325 * Use a cleaner technique to insert the Java code to load JNI library into the
326   generated wrapper - we now use "%pragma(java) jniclasscode" instead of using
327   Perl to post-process the generated wrapper.  Suggested by James Aylett.
329 * Run Java tests with -Xcheck:jni if supported, which should help catch any
330   any bugs in the JNI code.
332 * Fix configure to find jni_md.h under Cygwin.  There doesn't seem to be an way
333   to automatically determine the machine-dependent JNI include path, so add
334   another case to use "win32" on Cygwin.  Reported by John Bankert on
335   xapian-discuss.
337 * Add more special cases to find jni_md.h on Cygwin, OS X, *BSD, AIX.
338   There doesn't seem to be an explicit list of these directories anywhere, but
339   grepping the OpenJDK 8 source code finds additional values "darwin" and
340   "aix", *BSD seems to use "bsd", and Cygwin uses "win32" (reported by John
341   Bankert on xapian-discuss).
343 * Generate xapian.jar rather than xapian_jni.jar - the fact that JNI is
344   involved is really just an implementation detail.
346 * SmokeTest.java: Add simple test of subclassing FieldProcessor.
348 Perl:
350 * Merge Perl POD doc improvements from Search::Xapian.  The most notable
351   improvement is a number of methods previously lacking docs now have them.
353 * Fix typo in POD docs for Perl bindings ("outputing" -> "outputting").
354   Reported by knowledgejunkie in #730.
356 Python:
358 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
360 * Fix Python2 bindings to work out of the box.  SWIG changed the code it
361   generates for importing the compiled module in a recent version, and
362   the newer code no longer works with the wrapper renamed to
363   xapian/__init__.py.  There's currently no way to configure SWIG to produce
364   what we need so for now we run a "fixup" script over the generated wrapper
365   which replaces the complex import code with a single statement which does
366   what we want.  It also strips out various unneeded code, mostly to do with
367   handling Python 3.x (which we don't need since we have an entirely
368   separate set of bindings for that).  Reported by James Aylett in #731.
369   The way we were importing the bindings to generate the .pyc and .pyo
370   files was masking this problem, so rework that as suggested by James.
372 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
373   parallel builds (make -j) may attempt to schedule the sphinx doc build before
374   the relevant wrapper has been compiled and moved into position.  This won't
375   result in a build failure, but will silently omit API docs that sphinx
376   would otherwise include.  Patch from James Aylett.
378 * doxy2swig: Specify encoding when reading doxygen's XML output so UTF-8 in
379   doxygen comments is handled.  Patch from Vivek Pal.
381 * Specify Python2 wrapper encoding is UTF-8.  This is needed when we pick up
382   doxygen comments from the C++ API which contain UTF-8.  For Python3, the
383   default source encoding is UTF-8, so we don't need the equivalent change
384   there.
386 Python3:
388 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
390 * Fix Python3 bindings to work out of the box.  SWIG changed the code it
391   generates for importing the compiled module in a recent version, and
392   the newer code no longer works with the wrapper renamed to
393   xapian/__init__.py.  There's currently no way to configure SWIG to produce
394   what we need so for now we run a "fixup" script over the generated wrapper
395   which replaces the complex import code with a single statement which does
396   what we want.  It also strips out various unneeded code, mostly to do with
397   handling Python 2.x (which we don't need since we have an entirely
398   separate set of bindings for that).  Reported by James Aylett in #731.
399   The way we were importing the bindings to generate the .pyc and .pyo
400   files was masking this problem, so rework that as suggested by James.
402 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
403   parallel builds (make -j) may attempt to schedule the sphinx doc build before
404   the relevant wrapper has been compiled and moved into position.  This won't
405   result in a build failure, but will silently omit API docs that sphinx
406   would otherwise include.  Patch from James Aylett.
408 * Fix memory leak converting string from Python to C++.
409   XapianSWIG_anystring_as_ptr() was failing to flag the returned value as
410   allocated, so it wasn't being deleted.  Reported by Sean Robinson in #729.
412 Xapian-bindings 1.4.0 (2016-06-24):
414 Documentation:
416 * Mark SWIG-generated Java and Perl bindings as "experimental" until we've
417   had a chance to sort out any remaining changes we want to make.
419 Xapian-bindings 1.3.7 (2016-06-01):
421 Documentation:
423 * Remove long out-dated reference to tinderbox.
425 General:
427 * Use SWIG 3.0.9 to generate the bindings.  There's nothing very important to
428   us in the changes since the git snapshot we were using - mostly this means
429   we're using a released version, which seems preferable.
431 Tcl:
433 * Fix segfault in tcl bindings "make check".  The location of tclConfig.sh
434   wasn't being found, so libtclstub wasn't being linked to, which is required
435   with Tcl >= 8.6.
437 Xapian-bindings 1.3.6 (2016-05-09):
439 General:
441 * Update for changes to the C++ API.
443 * Use WritableDatabase::commit() instead of flush() in testcases, as the
444   latter is now formally deprecated.
446 Java:
448 * Fix syntax error in SmokeTest.java, introduced by the DB_BACKEND_INMEMORY
449   change.  Noted on #xapian-discuss by Aakash Muttineni.
451 * Update Java TODO list.
453 * SmokeTest.java: Port over version checks from SmokeTest.cs.
455 * Update list of recently tested JDK versions.
457 Lua:
459 * Note Lua bindings work with Lua 5.3.
461 Perl:
463 * Explicitly specify POD docs encoding as utf8.  Fixes warning in generated
464   HTML docs.
466 * Convert POD to HTML when building from a source tarball - the conversion
467   code comes as standard with Perl.  In 1.3.5 we were failing to ship the HTML
468   output, as reported by Anthony Basile.
470 * For extra robustness, convert POD to HTML using the bundled Pod::Html module
471   from the Perl interpreter found by configure, rather than assuming pod2html
472   is on PATH, and the right one (this matters more now that it's not just
473   people building from git who build these docs).
475 * Improve Perl bindings POD documentation.
477 * Remove workaround for Perl macro vs C++11 header.  SWIG 3.0.6 and later adds
478   a different workaround to the generated C++ wrapper file, and we require SWIG
479   3.0.8 for a Python fix, so we no longer need our workaround.
481 Python:
483 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
484   system, so I'm guessing this is now required due to a change in the code SWIG
485   generates.
487 Python3:
489 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
490   system, so I'm guessing this is now required due to a change in the code SWIG
491   generates.
493 * Fix install location for python3 docs.  They were being install to the same
494   path as the python docs - now the path includes "python3" instead of
495   "python".
497 Ruby:
499 * Increase minimum Ruby version to 2.1, as older versions are no longer
500   supported by the Ruby developers.
502 Xapian-bindings 1.3.5 (2016-04-01):
504 This release includes all changes from 1.2.23 which are relevant.
506 Documentation:
508 * Fix to install docs when not in maintainer-mode.
510 * Note open_stub() is deprecated (most of the bindings already noted this, but
511   now ruby and tcl do too).
513 General:
515 * Update for changes to the C++ API.
517 * PostingSource is now fully wrapped for the bindings.  Fixes #499, reported by
518   Joost Cassee.
520 * Ship swig-depcomp and doxy2swig scripts in the source tarball.
522 * Add installcheck-local make targets for most languages - these run the
523   testsuites using the installed bindings.
525 CSharp:
527 * configure: Stop checking for obsolete mono compiler names - gmcs, smcs and
528   dmcs were all deprecated in Mono 2.11.
530 * configure: Strip out handling of DotGNU - it's been inactive for years, and
531   was officially "decommissioned" in December 2012.
533 * README: Update list of mono versions recently tested with.
535 Lua:
537 * smoketest.lua: Fix to work with newer lua - coercing a number to a string
538   now appends ".0" for whole numbers.
540 Perl:
542 * Run pod2html with explicit --podpath=. - recent versions of pod2html seem to
543   need this to correctly handle references to other Xapian classes.  Reported
544   on #xapian-discuss by HowManny and abhishek_rand0wn.
546 Python:
548 * Run sphinx at build time.  It's an extra tool for people building from source
549   to have to install, but its output is rather large (this change reduces our
550   tar.xz size by ~20%), and its output includes a source-less minified copy of
551   jquery.
553 Python3:
555 * Run sphinx at build time.  It's an extra tool for people building from source
556   to have to install, but its output is rather large (this change reduces our
557   tar.xz size by ~20%), and its output includes a source-less minified copy of
558   jquery.
560 * Fix handling of integer values larger than a C int by bootstraping with a
561   newer version of SWIG.  Fixes #703, reported by Barry Warsaw.
563 * Remove xapian.inmemory_open() - we've deprecated the corresponding C++
564   function, and the Python3 bindings haven't yet had a stable release.
566 Ruby:
568 * Run rdoc at build time - it is included as part of the Ruby core
569   distribution, so we can assume it is available if ruby is, and avoid shipping
570   its rather large generated output in our source tarball.
572 Xapian-bindings 1.3.4 (2016-01-01):
574 This release includes all changes from 1.2.22 which are relevant.
576 General:
578 * Wrap new and changed features in C++ API.
580 * PostingSource set_maxweight() is now accessible to the bindings.  Fixes #498,
581   reported by Richard Boulton.
583 * configure script now defaults to looking for xapian-config-1.3.  This is now
584   automatically done for development series (odd middle component of the
585   version number), but not for stable series (even middle component).  Fixes
586   #695, reported by Jorge C. Leitão
588 PHP:
590 * Make PHP 5.5 the minimum officially supported version, as 5.4 has now reached
591   EOL.
593 * In the examples, when iterating an MSet with foreach, don't throw the docid
594   away as $dummy, put it in $docid and use it - the code looks cleaner, and
595   this avoids an extra call to C++ to get the docid on each iteration.
597 Python:
599 * Drop support for Python 2.5.
601 Python3:
603 * Document installation of Python 3 bindings.  Fixes #694, reported by Jorge C.
604   Leitão.
606 * Fix testsuite for changes in Python 3.5.  Fixes #690, patch from UsusDei.
608 * Handle renaming of .pyo to .opt-1.pyc files due to PEP-0488.  Fixes #689,
609   patch from UsusDei.
611 * Fix Python 3 version check to accept 3.10.
613 Xapian-bindings 1.3.3 (2015-06-01):
615 This release includes all changes from 1.2.20-1.2.21 which are relevant.
617 Documentation:
619 * INSTALL: IRIX is past EOL so drop information about IRIX make.
621 General:
623 * Add DB_RETRY_LOCK as a constant to wrap.
625 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
627 * Fix "make install" from a git tree configured with --disable-documentation.
628   (Fixes #658, reported by Germán M. Bravo)
630 * Fix "make install" when building from git with --disable-documentation.
632 * Fix to handle a VPATH build from a tarball when the generated docs will be in
633   $(srcdir).
635 * Update testcases for lazy wildcard expansion change in xapian-core.
637 * Update for addition of XAPIAN_NOEXCEPT.
639 * Don't wrap internal methods of Xapian::Weight.
641 Portability:
643 * Require a compiler with good C++11 support, like xapian-core now does.
645 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
646   doxygen.
648 * configure: Update check for -fvisibility to match xapian-core's.
650 CSharp:
652 * Fix configure test for whether $CLI can run CSharp programs - previously it
653   would always fail, which would mean that the CSharp tests wouldn't be run on
654   platforms where CSharp programs can't be run directly.
656 Java:
658 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
660 Lua:
662 * The Lua bindings are no longer considered to be "experimental" (in reality
663   they haven't been for some time).
665 Perl:
667 * Add a "LICENSE" section to the main POD.
669 * Add 'use strict' to all testcases, and add missing instances of 'my' that
670   this change uncovered.
672 * Wrap new WILDCARD_LIMIT_* constants as constants.
674 Python:
676 * Don't release the GIL when constructing a Query object from a sequence of
677   Query objects and/or strings.
679 * python/smoketest.py: Add new testcase to catch any internal functions,
680   methods, constants, etc which have accidentally been wrapped.
682 Python3:
684 * The Python3 bindings are no longer considered to be "experimental".
686 * Don't release the GIL when constructing a Query object from a sequence of
687   Query objects and/or strings.  (fixes #346)
689 * python3/pythontest.py: Expand comment about disabling test_import_star under
690   threads.
692 Tcl:
694 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
695   version added ::tcl::pkgconfig, which makes the configure tests simpler and
696   more reliable.
698 * Adjust precedence of the typecheck typemap for wrapping constructing a query
699   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
700   constructor correctly.
702 Xapian-bindings 1.3.2 (2014-11-24):
704 This release includes all changes from 1.2.16-1.2.19 which are relevant.
706 Documentation:
708 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
710 * Update for deprecation of Xapian::Chert::open().
712 * Update for renaming of "brass" backend to "glass".
714 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
715   updated" information isn't all that informative anyway - there can still be
716   stale information even if the file was updated very recently.
718 General:
720 * Releases and snapshots are now bootstrapped using a more recent version of
721   SWIG (a git snapshot from after the 3.0.3 release).
723 * configure: Fix SWIG version check to accept 3.x, and update the minimum
724   accepted version to be what we actually currently want.
726 * Wrap new C++ API features, and in particular all the new weighting schemes,
727   the changes to opening databases, and Xapian::Snipper.
729 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
730   argument which the C++ API takes.  If opts != 0, then output is sent to
731   stdout, otherwise no output is produced.
733 * Object descriptions are now always valid UTF-8. (see #620)
735 * Provide a SimpleStopper constructor which provides the ability to initialise
736   from a stopword list in a file.  Based on patch from Assem Chelli.
738 CSharp:
740 * README: Note that C# bindings now need .NET 2 or later (because that's what
741   SWIG-generated code now requires).
743 Java:
745 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
746   Anish Kanchan.  (see #616, reported by "Naveen")
748 Lua:
750 * Document that constants can now be accessed using CLASS.CONSTANT as well as
751   CLASS_CONSTANT.
753 Perl:
755 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
756   overlap with the hand-coded XS 'Search::Xapian' module.
758 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
759   during parallel builds.
761 * Use croak_sv() or ERRSV if defined.
763 PHP:
765 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
766   reached EOL.
768 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
769   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
770   `foreach ($it as $c)` works and allows iterating through the equivalent of
771   C++ operator* on the iterator.  (fixes#652)
773 * Fix handling of an exception thrown from a PHP implementation of
774   FieldProcessor::apply().
776 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
777   weight threshold.
779 * In current PHP releases, dl() is disabled in most SAPIs, and even where
780   available it will now only look in the configured extension directory.  The
781   upshot is that there no longer seems to be a sane way to install the PHP
782   bindings without being root.  Fixes #661, reported by Felix Ostmann.
784 Python2:
786 * The python testsuite already tested if any constants weren't marked with
787   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
788   clearly point to the actual problem.  Now we report the names of any
789   such constants.
791 * In the testsuite, use the xapian.WritableDatabase constructor rather than
792   chert_open() - that code dates back to when chert was the only disk-based
793   backend to support valuestreams, but flint was the default backend.
795 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
796   Germán M. Bravo in github PR59.
798 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
800 Python3:
802 * Python 3 support has been split off into its own subdirectory, and should now
803   be usable.  3.2 is the minimum supported version currently.  Existing code
804   will need updating for Python 3, and the wrapped API is necessarily different
805   in how Unicode is handled, so we've dropped deprecated features (such as
806   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
808 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
809   Germán M. Bravo in github PR59.
811 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
813 Ruby:
815 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
816   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
817   picking ruby 1.6.
819 Xapian-bindings 1.3.1 (2013-05-03):
821 This release includes all changes from 1.2.10-1.2.15 which are relevant.
823 Documentation:
825 * HACKING: Document Debian packages needed for each language.
827 General:
829 * Wrap new C++ API features.
831 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
832   unnecessary exception handling code where we call such functions and
833   methods.
835 * Tweak wrapping of Query from list constructor so the needed number of
836   elements get preallocated.
838 * Ignore Query(Query::Internal&) constructor, which is for internal use
839   only.
841 * For all languages except C# and Java, wrap the functions declared in
842   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
843   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
844   languages.
846 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
847   dependencies, and adjusts the generated dependencies to work in our build
848   system.
850 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
851   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
852   V=1' and 'make V=0' which are broadly equivalent and more standard.
854 * Fix the tests to work with the new automake parallel test driver.
856 Portability:
858 * Improve workaround which allows building against an uninstalled xapian-core
859   on OS X - this should now work with any uninstalled xapian-core (not only in
860   a tree with the same layout as an SVN or git checkout) and it also won't try
861   to build against "../xapian-core/.libs" just because it happens to exist.
862   (Fixes #322)
864 CSharp:
866 * configure: The variable to specify the interpreter is now CLI (was MONO, but
867   didn't actually work properly).
869 Java:
871 * Document that we aim to support JDK 1.6 (Java 6) and later.
873 * Avoid generating a temporary C++ vector of Query objects when constructing
874   a Query from a Java array of Query objects or a Java array of strings.
876 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
877   ValueIterator, and TermIterator.
879 * Add Enquire.getMatchingTerms().
881 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
882   building, e.g. "make JAVACFLAGS=-g".
884 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
885   with (the rather elderly) ECJ 3.3.1.
887 Perl:
889 * Fix PostingIterator wrapper to work.
891 * Update list of unwrapped things in POD documentation.
893 * Improve test coverage.
895 * perl/t/10query.t: Adjust regexp which checks expected error message to work
896   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
898 * Probe for the test running tool 'prove' in configure.
900 PHP:
902 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
903   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
904   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
905   compiled PHP module by 6%.
907 * php/smoketest.php: Add more tests of geospatial API.
909 Python:
911 * Drop support for Python 2.4.
913 * python/smoketest2.py: Add more testcases.
915 * python/smoketest2.py: Improve reporting of test failures for certain
916   testcases.
918 * Update Python 3 tests from Python 2 versions using 2to3.
920 Xapian-bindings 1.3.0 (2012-03-14):
922 Documentation:
924 * In maintainer builds, run doxygen to generate XML for the bindings in the
925   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
927 General:
929 * Wrap new geospatial API.
931 * Wrap new database checking API.
933 * Deprecated features scheduled for removal in 1.3.0 have been removed.
935 * Wrap ExpandDecider even if we don't have director support - there's a
936   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
937   needs some typemap work to actually get it usefully wrapped.
939 * configure:
941   + Add --disable-visibility option to match xapian-core.
943   + Add -fshow-column for GCC.
945   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
946     variable, so that it's easy to override it if you're getting a new warning
947     from SWIG but want to just ignore it for the time being.
949 * Exception handling now uses Error::get_description() rather than get_type +
950   ": " + get_msg().  In many cases this is the same, but if context or errno
951   are available, get_description() includes them.  Catch and report
952   std::exception rather than handling it as an unknown error (so in particular
953   std::bad_alloc will now be reported more helpfully).
955 CSharp:
957 * Avoid generating unwanted wrapper sources
958   SWIGTYPE_p_std__vectorT_std__string_t.cs and
959   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
961 Java:
963 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
964   bindings promoted in their place.  This means almost the entire C++ API is
965   now wrapped for Java, but the downside is there are some changes required
966   to existing code.  Overall we feel the short-term pain is worth the long
967   term benefits of having Java bindings which stay up to date.
969 * java/SmokeTest.java: Add test that string passing is zero byte safe.
971 Lua:
973 * Improve error messages.
975 Perl:
977 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
978   Perl 5.14.
980 * Fix Search::Xapian::Query->new() to work.
982 * Enable warnings for all test cases and make them fatal.
984 * Add "use Carp;" where we use functions from that module.
986 * Improve POD docs for Document and TermGenerator methods - "weight" is
987   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
989 * The Query constructor which takes an array of subqueries is now wrapped more
990   efficiently - previous a temporary C++ std::vector was built but now we avoid
991   doing this.
993 PHP:
995 * PHP >= 5.3 is now required.
997 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
999 * The XapianQuery constructor which takes an array of subqueries is now
1000   wrapped more efficiently - previous a temporary C++ std::vector was built
1001   but now we avoid doing this.
1003 Python:
1005 * Python >= 2.4 is now required.
1007 * Remove deprecated Stem_get_available_languages().
1009 * Hide away the deprecated non-pythonic iterators - we still need them to
1010   implement the pythonic iterators, so we can't entirely remove them.
1012 * Replace SWIG's thread locking with code which does nothing unless threads
1013   are already initialised, to avoid the overhead of thread locking in the
1014   common case of single-threaded Python code.  This seems to be about 5-10%
1015   faster for pythontest2.py modified to repeat the tests 100 times.
1017 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
1018   #364.
1020 * The Query constructor which takes an array of subqueries is now wrapped more
1021   efficiently - previous a temporary C++ std::vector was built but now we avoid
1022   doing this.
1024 Ruby:
1026 * The XapianQuery constructor which takes an array of subqueries is now
1027   wrapped more efficiently - previous a temporary C++ std::vector was built
1028   but now we avoid doing this.
1030 Tcl:
1032 * The XapianQuery constructor which takes an array of subqueries is now
1033   wrapped more efficiently - previous a temporary C++ std::vector was built
1034   but now we avoid doing this.
1036 Xapian-bindings 1.2.23 (2016-03-28):
1038 Documentation:
1040 * Update links to Xapian website and trac to use https, which is now supported,
1041   thanks to James Aylett.
1043 PHP:
1045 * Check that the PHP interpreter we find is actually PHP5, and if not look
1046   harder.  On current Debian unstable, php-config5 --php-binary reports
1047   /usr/bin/php which can be PHP7.
1049 * Document that PHP7 isn't currently supported, and explicitly check for and
1050   reject it in configure.
1052 Ruby:
1054 * configure: Stop preferring rdoc-1.8 to rdoc (this only happened in a
1055   fall-back case when rdoc wasn't found in the same directory as the ruby
1056   interpreter).
1058 Xapian-bindings 1.2.22 (2015-12-29):
1060 Documentation:
1062 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
1063   'git cherry-pick' from working as it should.  The git repo history should be
1064   sufficient for complying with GPLv2 2(a).
1066 General:
1068 * Stop wrapping internal methods of Xapian::Weight.
1070 * Return Error::get_description() rather than get_type + ": " + get_msg().  In
1071   many cases this is the same, but if context or errno are available,
1072   get_description() includes them.
1074 * Catch and report std::exception rather than handling it as an unknown error
1075   (so in particular std::bad_alloc will now be reported more helpfully).
1077 CSharp:
1079 * Fix configure test for whether $MONO can run CSharp programs - previously it
1080   would always fail, which would mean that the CSharp tests would only be run
1081   on systems where CSharp programs can be run directly.
1083 Lua:
1085 * Send stderr from lua version check to config.log instead of letting it appear
1086   on the terminal.
1088 PHP:
1090 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
1092 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
1093   constructors now work.
1095 Python:
1097 * Add new testcase to catch any internal functions, methods, constants, etc
1098   which have accidentally been wrapped.
1100 Xapian-bindings 1.2.21 (2015-05-20):
1102 Lua:
1104 * README: Remove note about the Lua bindings being experimental - it's not
1105   really been true for some time now.
1107 Perl:
1109 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
1111 * Add workaround for Perl defining a seed() macro which breaks compilation with
1112   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
1113   classes with a method called seed).
1115 * Update list of unwrapped things in POD documentation.
1117 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1118   during parallel builds.
1120 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
1122 * Add test that we can create all the stemmers returned by
1123   Stem::get_available_languages().
1125 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
1126   likely due to external reasons, like incompatible compiler flags being taken
1127   from Perl's Config module, due to Perl having been built with a different
1128   compiler to Xapian.
1130 * Use croak_sv() or ERRSV if defined.
1132 PHP:
1134 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
1135   was fixed in 1.2.19.
1137 Python:
1139 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
1140   stable release 1.4.0.
1142 Ruby:
1144 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
1146 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
1147   https://bugs.debian.org/782270
1149 Xapian-bindings 1.2.20 (2015-03-04):
1151 Portability:
1153 * configure: Avoid using \? in sed command in Lua detection - it isn't
1154   supported by all sed implementations.
1156 Lua:
1158 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
1159   being specified without a leading '.'.
1161 * configure: Add an example of specifying LUA_SO to --help output.
1163 PHP:
1165 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
1166   1.2.19.
1168 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1169   available it will now only look in the configured extension directory.  The
1170   upshot is that there no longer seems to be a sane way to install the PHP
1171   bindings without being root, so update the documentation to reflect this.
1172   Fixes #661, reported by Felix Ostmann.
1174 Xapian-bindings 1.2.19 (2014-10-21):
1176 PHP:
1178 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
1179   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
1180   Gottfried)
1182 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
1183   which were getting incorrectly wrapped such that they didn't actually do
1184   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
1185   reference tracking fix in 1.2.14.
1187 Ruby:
1189 * README: Note that Ruby 2.1 works too.
1191 Xapian-bindings 1.2.18 (2014-06-22):
1193 Documentation:
1195 * README: Add links to Erlang and Node.js bindings.
1197 Lua:
1199 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
1200   expected), which most of the calls already used, and fix up the few calls
1201   which passed (expected, got).
1203 PHP:
1205 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
1206   that MatchDecider returns an MSet with the expected docid in.  Luckily this
1207   wasn't masking a test failure.
1209 Python:
1211 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
1212   - chert is the default backend now, and both chert and brass support the
1213   required functionality for the tests which do this, so this just needlessly
1214   causes the tests to fail if chert is disabled in xapian-core.
1216 * configure: If the Python version is too new or too old, only report it once
1217   not twice.
1219 Ruby:
1221 * configure: Fix Ruby bindings to build on Windows (and other platforms where
1222   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
1224 Xapian-bindings 1.2.17 (2014-01-29):
1226 Portability:
1228 * Improve workaround which allows building against an uninstalled xapian-core
1229   on OS X - this should now work with any uninstalled xapian-core (not only in
1230   a tree with the same layout as an SVN or git checkout) and it also won't try
1231   to build against "../xapian-core/.libs" just because it happens to exist.
1232   (Backported from 1.3.1; fixes #322)
1234 Python:
1236 * configure: Some distros now point /usr/bin/python at Python 3, so the check
1237   for a Python 2 interpreter now checks for 'python2' first, and checks that
1238   the version of found interpreter is 2.x.
1240 Ruby:
1242 * Tweak configure to work with Ruby 2.0.
1244 Tcl:
1246 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
1247   in http://bugs.debian.org/724830).
1249 * Use a better check for TCL_INC for Tcl 8.5 and later.
1251 Xapian-bindings 1.2.16 (2013-12-04):
1253 Documentation:
1255 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
1257 General:
1259 * Compress source tarballs with xz instead of gzip.
1261 * configure: Handle git snapshot naming.
1263 Portability:
1265 * configure: Update list of platforms where we tell libtool not to link in
1266   deplibs to match the list used for xapian-core.
1268 Perl:
1270 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
1271   GCC 4.7 warning).
1273 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
1274   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
1276 PHP:
1278 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
1279   with a message explaining this.
1281 Python:
1283 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
1285 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
1287 * pythontest.py: Fix testcase checking we get an exception from using
1288   non-random-access iterators after then have advanced - previously these
1289   didn't actually test as fully as intended.
1291 Ruby:
1293 * Omit internal classes and methods from the rdocs.
1295 Xapian-bindings 1.2.15 (2013-04-16):
1297 General:
1299 * Fix configure --enable-quiet option to actually work for the bindings.
1301 Perl:
1303 * Fix doc typo: "as as" -> "as a"
1305 Ruby:
1307 * Fix deprecation warning in configure from Ruby 1.9.3.
1309 Xapian-bindings 1.2.14 (2013-03-14):
1311 Python:
1313 * Fix typo in doccomment.
1315 PHP:
1317 * Keep references to the PHP wrapper object when an object is set on another
1318   object.  (fixes #614)
1320 Tcl:
1322 * Allow TCL_INC to be passed to configure.  (fixes #612)
1324 Xapian-bindings 1.2.13 (2012-11-09):
1326 CSharp:
1328 * configure: Overhaul checks for C# tools to use modern names in preference.
1330 Lua:
1332 * Fix examples to use str(query) to get the query description.  (Fixes #600)
1334 * Document that get_description() is mapped to str(), and end() to _end().
1336 * Fix functor wrappers which return strings to be zero-byte clean.
1338 Perl:
1340 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
1341   1.2's XS Search::Xapian.  (ticket#607)
1343 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
1344   is deprecated.
1346 PHP:
1348 * Document that subclassing Xapian classes in PHP currently doesn't work with
1349   PHP 5.4.
1351 Xapian-bindings 1.2.12 (2012-06-27):
1353 No changes since 1.2.11 except to bump the version - this release was made to
1354 fix an incorrect library version information update in xapian-core 1.2.11.
1356 Xapian-bindings 1.2.11 (2012-06-26):
1358 General:
1360 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
1362 Perl:
1364 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
1365   av_fetch() (spotted due to GCC 4.7 warning).
1367 PHP:
1369 * Fix "make check" to work for PHP when building from a release tarball with
1370   srcdir != builddir.
1372 * Work around "undefined symbol: zend_error_noreturn" error.
1374 Xapian-bindings 1.2.10 (2012-05-09):
1376 CSharp:
1378 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
1379   us to do this instead of setting them in AssemblyInfo.cs.
1381 * Use diff's -c option when comparing the files SWIG generated against those we
1382   were expecting to get as the output should be easier to understand.
1384 * Sort both the lists of expected and of found SWIG-generated sources with
1385   Perl, to avoid problems with locale-specific sort orders.
1387 Java-SWIG:
1389 * Remove now superfluous old check that SWIG generated at least the sources we
1390   want - we now check it generated *exactly* the sources we want.
1392 * Use diff's -c option when comparing the files SWIG generated against those we
1393   were expecting to get as the output should be easier to understand.
1395 * Sort both the lists of expected and of found SWIG-generated sources with
1396   Perl, to avoid problems with locale-specific sort orders.
1398 Lua:
1400 * Now works with Lua 5.2.
1402 * "require 'xapian'" now returns the module table.  (ticket #593)
1404 * lua/smoketest.lua: Improve reporting of test failures.
1406 Perl:
1408 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
1410 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
1411   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
1413 Python:
1415 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
1416   iteration features which have been removed on trunk.  This also fixes a
1417   segfault if there are no matches and no documents are explicitly marked as
1418   relevant.
1420 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
1421   way to rerun tests with verbose output.
1423 Ruby:
1425 * configure: Make sure the ruby subdirectory exists before trying to create
1426   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
1428 Xapian-bindings 1.2.9 (2012-03-08):
1430 Java:
1432 * configure: Fix test for jni.h to try looking for jni.h relative to the real
1433   location of javac, which should work for more JDKs.
1435 Lua:
1437 * Handle an exception from C++ by raising a xapian.Error object as an error in
1438   Lua.
1440 * Rename get_description() methods to __tostring(), so that you can use write
1441   tostring(obj) in Lua.
1443 * configure: Honour LUA_LIB if already set.  Fixes #581.
1445 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
1446   support platforms where the compiled Lua module isn't called .so.
1448 Perl:
1450 * Add tests of Document::get_docid().
1452 PHP:
1454 * Add a test that Query constructor taking OP_NEAR with a window size works.
1456 Python:
1458 * python/testsuite2.py: Don't run off the traceback looking for a test function
1459   if the exception wasn't from a test function.
1461 Xapian-bindings 1.2.8 (2011-12-13):
1463 Lua:
1465 * Wrap user-subclassable functor objects by allowing the user to pass a
1466   Lua function where the functor object would be passed in the C++ API.
1468 PHP:
1470 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
1472 * The PHP bindings will now work again with a version of PHP built with ZTS
1473   enabled (which is the default on Microsoft Windows).  This was broken by
1474   the changes to support subclassing in PHP in the version of SWIG used since
1475   1.2.6.
1477 Python:
1479 * Add a module docstring.  (Fixes bug #573)
1481 * The python testsuite now checks for object leaks during each testcase.
1483 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
1484   only check for leaks the second time to avoid falsely reporting a leak when
1485   some cached value gets initialised under Python 2.5.
1487 Ruby:
1489 * Wrap optional prefix parameter to Database::allterms.
1491 Xapian-bindings 1.2.7 (2011-08-10):
1493 Documentation:
1495 * INSTALL: Pull in a few updates from the latest version of the automake
1496   document which this file was originally based on.  Add in the missing
1497   copyright and licensing information.
1499 * INSTALL: Add --with-lua to list of options.
1501 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
1502   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
1503   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
1504   supported platforms in the README.
1506 * HACKING: Update and start section on deprecation warnings for the bindings.
1508 General:
1510 * Add missing wrappers for Database::has_positions() and
1511   TermIterator::positionlist_count(), and correct the return type of
1512   Database::get_doclength() from double to Xapian::termcount.
1514 CSharp:
1516 * README: Note a recent version of Mono which we've tested the C# bindings
1517   with.
1519 * Check that exactly the sources we expect are generated, and add some sources
1520   which were missing from the list.
1522 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
1523   gets removed.
1525 * Fix iterator ++ and -- so that the reference to the object isn't released
1526   prematurely, which was causing an occasional crash if the garbage collection
1527   happened at just the wrong moment,
1529 * Add test coverage for QueryParser.ParseQuery() with flags argument.
1531 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1533 Java:
1535 * SmokeTest.java: Fix == comparisons with strings to use equals().
1537 * Add test that string passing is zero byte safe.
1539 * Fix MyExpandDecider.accept() to really check the passed parameter.
1541 Java-SWIG:
1543 * Put the SWIG-generated Java bindings in package org.xapian.
1545 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1547 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
1549 * Add test that string passing is zero byte safe.
1551 * Fix MyExpandDecider.accept() to really check the passed parameter.
1553 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
1555 * Create an HTML documentation page based on java/README.
1557 * Copy java examples from the hand-coded JNI ones.
1559 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
1561 * Check that exactly the sources we expect are generated, and add some sources
1562   which were missing from the list.
1564 Lua:
1566 * Merge latest Lua changes from Xiaona Han.
1568 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
1570 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
1571   matches.
1573 Perl:
1575 * Sync updates to examples from XS Search::Xapian:
1577   + Require Perl >= 5.6 so we can "use warnings;".
1579   + Loop over file using while() (which reads a line per iteration) not
1580     foreach() (which reads the whole file up front).
1582 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
1583   and Search::Xapian::Query::MatchNothing).  (ticket#158)
1585 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
1587 * perl/Makefile.am: Fix "make check".
1589 * perl/t/symbol-test.t: Fix to work when built against an installed
1590   xapian-core.  (ticket#558)
1592 PHP:
1594 * php/smoketest.php: Install an error handler so the test fails if there are
1595   any errors, warnings, notices, etc.
1597 * Change PHP examples and test program to use 'include "xapian.php"' like user
1598   code should (rather than 'include "php5/xapian.php"' as they did previously).
1600 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
1601   XapianQuery::MatchNothing(). (ticket#158)
1603 Ruby:
1605 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
1607 Xapian-bindings 1.2.6 (2011-06-12):
1609 General:
1611 * SWIG-based bindings are now generated with a newer version of SWIG
1612   (ticket#538).
1614 Portability:
1616 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
1617   .jnilib extension as we do for older versions.
1619 CSharp:
1621 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
1623 Java:
1625 * Fix memory leaks when functions taking string parameters throw exceptions.
1627 * Previously a hash table was used to map Java objects to C++ ones, but we
1628   now just cast the address of the C++ object to a jlong (which is 64 bits
1629   so will hold a pointer on current platforms).  This is more efficient and
1630   avoids the need for thread locks around accesses to the hash table.
1632 * Remove explicit checks for NULL around calls to delete.
1634 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
1635   during parallel builds.
1637 Lua:
1639 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
1640   year.  The current support should be regarded as experimental - it passes
1641   its automated tests, but the details of the Lua API are likely to evolve as
1642   the project progresses.
1644 Perl:
1646 * README: say that Perl bindings probably need Perl 5.8 or later.
1648 PHP:
1650 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
1652 Python:
1654 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
1655   all the garbage, so repeat until no further objects are freed.
1656   (http://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
1658 Ruby:
1660 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
1661   the compaction tests for these versions.
1663 Xapian-bindings 1.2.5 (2011-04-04):
1665 Documentation:
1667 * README: Update info on SWIG-based Perl bindings.
1669 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
1670   section with better equivalent from xapian-core/INSTALL.
1672 General:
1674 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
1676 * configure: If xapian-core is a different release series, promote the
1677   mismatched versions warning to an error.
1679 Portability:
1681 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
1682   10.4 on x86, as the default if unset on these versions is the current OS
1683   version.  (ticket#541)
1685 * python/pythontest2.py: In test_compactor(), close any open databases before
1686   removing the directory as you can't delete an open database on Microsoft
1687   Windows.  (ticket#526)
1689 CSharp:
1691 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
1693 * Clarify the licence is GPL "version 2 or later" in the meta information
1694   we put in the module.
1696 Python:
1698 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
1699   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
1700   accidentally left an older version of get_matching_terms() exposed.
1702 * Remove broken implementation of MSet.__contains__.  This appears never to
1703   have worked, and to have been broken for at least the past 3.5 years without
1704   anyone mentioning it, and is probably of little use anyway, so no need to
1705   deprecate.
1707 * python/docs/index.html: Document that MSet.items and ESet.items are
1708   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
1709   the tuple returned by MSet.items.  (ticket#531)
1711 * Add test coverage for mset.items.
1713 Ruby:
1715 * Add test coverage for Xapian::Compactor.
1717 * Handle an empty response to $RUBY --version specially.  This gives a less
1718   opaque error in cases where the user specified RUBY but the value given
1719   wasn't an executable file.
1721 Xapian-bindings 1.2.4 (2010-12-19):
1723 General:
1725 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
1726   virtual method is wrapped for subclassing for Python and Ruby currently.
1728 * Eliminate separate Makefile.am in the docs subdirectory of each language
1729   subdirectory and just inline any rules into the main sub-Makefile.am, which
1730   allows more of the build to run in parallel.
1732 * Don't ship some files which are generated at build time.
1734 * configure: Need python in maintainer mode to run doxy2swig.py.
1736 Packaging:
1738 * RPM: Package the Perl bindings.
1740 * RPM: Don't package _XapianSharp.la.
1742 Portability:
1744 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
1745   uninstalled Xapian library.  See ticket #322.
1747 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1749 CSharp:
1751 * Don't install _XapianSharp.la.
1753 Perl:
1755 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
1756   GSoC 2009.  These are close to being a compatible replacement for the
1757   hand-coded XS bindings in Search::Xapian but also offer a more complete
1758   wrapping of the C++ API.  We're planning to replace the XS bindings with the
1759   SWIG ones for easier maintenance.  We encourage you to try them and let us
1760   know how you get on - particularly if you find cases where code which works
1761   with the XS bindings doesn't work with the SWIG ones.
1763 PHP:
1765 * Document that iterators shouldn't be dereferenced or advanced when at their
1766   end points (ticket#520).
1768 Python:
1770 * Fix memory leaks in typemaps which return Python lists.
1772 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
1773   supported.
1775 * configure: Use sys.version_info tuple, rather than string splicing which
1776   assumes the Python "major.minor" is 3 characters (which would fail if Python
1777   2.10 were ever released, for example).
1779 Xapian-bindings 1.2.3 (2010-08-24):
1781 Packaging:
1783 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
1785 Xapian-bindings 1.2.2 (2010-06-27):
1787 * No user-visible change except for bumping the version to indicate
1788   compatibility with Xapian-core 1.2.2.
1790 Xapian-bindings 1.2.1 (2010-06-22):
1792 This release includes all changes from 1.0.21 which are relevant.
1794 General:
1796 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
1797   Python.  (ticket#448)
1799 Guile:
1801 * Remove non-functional disabled guile bindings left over from Open Muscat
1802   days - if someone wanted to add guile bindings, it would be easier to start
1803   from scratch.
1805 Java-SWIG:
1807 * Update list of generated java sources in the SWIG-based Java bindings.
1809 PHP:
1811 * zend_throw_exception() returns, so return control to PHP directly after
1812   calling it to avoid needless extra work and possible issues.
1814 Python:
1816 * Fix "from xapian import *".  (ticket#477)
1818 * Fix testcase weight_normalise - a change in xapian-core means that
1819   get_max_possible() can now return zero for a non-existent term, so don't
1820   blindly calculate the reciprocal of it.
1822 * python/replicationtest2.py: Extend to check that changesets get applied
1823   correctly.
1825 * python/smoketest2.py: Check len(mset) works (improving test coverage of
1826   Python-specific wrapping).
1828 Xapian-bindings 1.2.0 (2010-04-28):
1830 This release includes all changes from 1.0.20 which are relevant.
1832 Portability:
1834 * configure: Tell libtool not to link in deplibs on platforms where we know
1835   they aren't needed.
1837 * configure: On Linux, extract the library search path from ldconfig which
1838   gives us the default entries reliably.
1840 Xapian-bindings 1.1.5 (2010-04-15):
1842 This release includes all changes from 1.0.19 which are relevant.
1844 Tcl:
1846 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
1847   sidestep the whole destructor issue.  (ticket#62)
1849 Xapian-bindings 1.1.4 (2010-02-15):
1851 This release includes all changes from 1.0.18 which are relevant.
1853 General:
1855 * Update for the new Brass backend and other C++ API changes.
1857 * Wrap Database::get_doclength_lower_bound(),
1858   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
1859   Database::valuestream_begin() and Database::valuestream_end() for all
1860   languages. (ticket#431)
1862 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
1864 Python:
1866 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
1867   object which dereferences to a ValueStreamItem object,
1869 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
1871 Ruby:
1873 * Add safe wrapper for the valuestream iterator.
1875 Xapian-bindings 1.1.3 (2009-11-18):
1877 This release includes all changes from 1.0.15-1.0.17 which are relevant.
1879 General:
1881 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
1882   specified.
1884 * Wrap the new MatchSpy class, and associated features.
1886 * Don't wrap PostingSource::serialise(), Weight::serialise() and
1887   Weight::unserialise() as they aren't useful from the bindings.
1889 * Update for the Sorter to KeyMaker changes.
1891 PHP:
1893 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
1894   as it standardly is on Microsoft Windows.  Fixes #411.
1896 * Merged the PHP "smoketest" back together now we don't need to support
1897   PHP4 now.
1899 Python:
1901 * Fix a memory leak on error (in theory - we've not got a way to generate this
1902   error, so haven't been able to reproduce the leak or test the fix).
1904 Xapian-bindings 1.1.2 (2009-07-23):
1906 This release includes all changes from 1.0.14 which are relevant to trunk.
1908 Python:
1910 * Several changes towards fully supporting Python 3, but more work is required.
1911   (ticket#246)
1913 Xapian-bindings 1.1.1 (2009-06-09):
1915 This release includes all changes from 1.0.13 which are relevant to trunk.
1917 General:
1919 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
1921 CSharp:
1923 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1924   C# yet, and to use Query("") and Query() instead.
1926 * configure: If we don't find a C# compiler, don't test an empty command name
1927   further which saves a fork and avoids an odd looking message.
1929 PHP:
1931 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1932   PHP yet, and to use Query("") and Query() instead.
1934 Python:
1936 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
1937   are wrapped (ticket#158).
1939 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
1940   expect SYNONYM in generated query.
1942 Ruby:
1944 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1945   Ruby yet, and to use Query("") and Query() instead.
1947 Tcl:
1949 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
1950   are wrapped (ticket#158).
1952 Xapian-bindings 1.1.0 (2009-04-22):
1954 Documentation:
1956 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
1957   the instructions to suggest users use this standard location for installing
1958   without root access.
1960 General:
1962 * All deprecated features slated for removal in 1.1.0 have been removed.
1964 * All new C++ API features have been wrapped.  Also, since we now supply some
1965   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
1966   these can be passed in even for languages for which SWIG doesn't support
1967   subclassing.
1969 Packaging:
1971 * xapian-bindings.spec: Updated to reflect the new Python packaging.
1973 Portability:
1975 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
1976   to put the compiler into ISO C++ mode).
1978 PHP:
1980 * PHP4 support has been removed, since PHP4 is no longer supported upstream
1981   as of 2008-08-08.
1983 Python:
1985 * Python 2.3 or later is now required.  2.2 is essentially unsupported
1986   upstream.
1988 * The import method used has been changed (by using a newer SWIG version)
1989   and no longer gives a warning with Python 2.6.
1991 * Initial support for Python 3.0 has been added.  This currently doesn't
1992   work correctly and should be treated as experimental. (ticket#346)
1994 * The newer SWIG version handles exceptions in director methods correctly
1995   so we no longer need our workaround for ticket #289.
1997 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
1998   wrapped for Python as Database.metadata_keys().
2000 * The Python bindings are now installed as a python package, with the
2001   files in a xapian subdirectory, hiding the internal _xapian module
2002   better.
2004 * Python now flags deprecation warnings for the single argument form and old
2005   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
2006   friends.
2008 Xapian-bindings 1.0.23 (2011-01-14):
2010 Portability:
2012 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
2014 PHP:
2016 * Document that iterators shouldn't be dereferenced or advanced when at their
2017   end points (ticket#520).
2019 Python:
2021 * Fix memory leaks in typemaps which return Python lists.
2023 Xapian-bindings 1.0.22 (2010-10-03):
2025 Packaging:
2027 * RPM: Don't package _XapianSharp.la.
2029 CSharp:
2031 * Don't install _XapianSharp.la.
2033 Python:
2035 * configure: Use sys.version_info tuple, rather than string splicing which
2036   assumes the Python "major.minor" is 3 characters (which would fail if Python
2037   2.10 were ever released, for example).
2039 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
2040   testcase in pythontest.py.
2042 Xapian-bindings 1.0.21 (2010-06-18):
2044 Python:
2046 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
2047   can't be written to. (ticket#297)
2049 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
2051 * Add test to check that "from xapian import *" works.
2053 Xapian-bindings 1.0.20 (2010-04-27):
2055 Python:
2057 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
2058   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
2059   trap to delete them after running tests for older versions of Python.
2060   (ticket#315)
2062 Ruby:
2064 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
2066 Xapian-bindings 1.0.19 (2010-04-15):
2068 Tcl:
2070 * tcl8/docs/index.html: Improve wording in a few places.
2072 Xapian-bindings 1.0.18 (2010-02-14):
2074 General:
2076 * Wrap new C++ API method Document::add_boolean_term().
2078 Ruby:
2080 * Generate entries in the Ruby rdocs for all classes which aren't documented
2081   because of Ruby-specific methods.  Fixes ticket#417.
2083 * Avoid absolute paths in the generated rdocs.
2085 Xapian-bindings 1.0.17 (2009-11-18):
2087 Packaging:
2089 * Improve RPM package summaries - the files are needed to *use* scripts as well
2090   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
2091   conventional.
2093 Portability:
2095 * python/Makefile.am: Restore the "./" path to the sourced file
2096   libtoolconfig.tmp as ksh requires it.
2098 Java:
2100 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
2102 Xapian-bindings 1.0.16 (2009-09-10):
2104 Python:
2106 * Improved docstrings for QueryParser::set_default_op() and
2107   QueryParser::get_default_op() (automatically generated from changes in
2108   xapian-core).
2110 Xapian-bindings 1.0.15 (2009-08-26):
2112 Python:
2114 * Don't break long words when wrapping text in the generated API documentation
2115   comments as this was causing identifiers to be broken in two.
2117 Xapian-bindings 1.0.14 (2009-07-21):
2119 General:
2121 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
2122   and the only side-effect was an odd looking message.
2124 Python:
2126 * Rename methods at build-time using SWIG rather than a run-time in Python, as
2127   the latter approach adds a small time overhead when the module is being
2128   loaded.
2130 Ruby:
2132 * Fix to accept an integer value > MAXINT for a double parameter.
2134 Xapian-bindings 1.0.13 (2009-05-23):
2136 Packaging:
2138 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
2139   _XapianSharp.so in 1.0.11.
2141 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
2142   bindings since 1.0.6.
2144 PHP:
2146 * Backport fix from SWIG SVN for misuse of formatted error function in
2147   SWIG-generated code.
2149 Python:
2151 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
2152   Python's Global Interpreter Lock (GIL) in situations where we know that it
2153   will already be locked.  This avoids some dead-locks with mod_python (due to
2154   mod_python bugs which are apparently unlikely to ever be fixed), and results
2155   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
2156   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
2157   faster). (ticket#185)
2159 * README,python/docs/index.html: Update documentation of the above mod_python
2160   issue and also document the related mod_wsgi issue.  The status is now that
2161   everything seems to work if you stick to the main interpreter (ticket#364).
2163 * Backport fix from SWIG SVN for misuse of formatted error function in
2164   SWIG-generated code.
2166 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
2167   second parameter, not the third.
2169 * python/docs/examples/simplematchdecider.py,
2170   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
2171   clearer code.
2173 Ruby:
2175 * README: Note that the testsuite fails due to a bug in the test/unit module in
2176   Ruby 1.9.0, but applications using the bindings should work, and that the
2177   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
2178   appears to be completely dead both upstream and in the wild.
2180 Xapian-bindings 1.0.12 (2009-04-19):
2182 Documentation:
2184 * INSTALL: Add a note about being able to pass variables to configure to pick
2185   which of several parallel installations of a language to build for.
2187 Python:
2189 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
2190   test to avoid failing due to rounding differences.
2192 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
2193   stop the whole testsuite, not just the currently running testcase.
2195 Xapian-bindings 1.0.11 (2009-03-15):
2197 Documentation:
2199 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
2200   Python 3, and possible current issues with Ruby 1.9.
2202 Portability:
2204 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
2205   Cygwin.
2207 Python:
2209 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
2210   latter is deprecated, and support was removed in 1.0.0).
2212 * Add support for using the new name ("reverse") for the second argument of
2213   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
2214   The old name ("ascending") is still supported, but will be deprecated in
2215   1.1.0.
2217 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
2218   which get set on other objects to avoid segmentation faults if they go out
2219   of scope before the object they are set on does.  (ticket#341)
2221 Ruby:
2223 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
2224   fails so "make check" doesn't pass, but code using the bindings should work.
2226 Xapian-bindings 1.0.10 (2008-12-23):
2228 Python:
2230 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
2231   as things stand (upstream fix for Debian bug 506090).
2233 Xapian-bindings 1.0.9 (2008-10-31):
2235 General:
2237 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
2239 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
2240   methods.
2242 Xapian-bindings 1.0.8 (2008-09-04):
2244 General:
2246 * configure: Report bug report URL in --help output.
2248 Python:
2250 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
2251   (bug#289)
2253 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
2255 Xapian-bindings 1.0.7 (2008-07-14):
2257 Documentation:
2259 * Document how all the database factory functions and library version functions
2260   are wrapped for all languages.
2262 General:
2264 * Fix to build against a xapian-core which has quartz and/or flint disabled.
2266 * The "program" version of Remote::open() has been wrapped for some time, so
2267   update the documentation which said it wasn't.
2269 Packaging:
2271 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
2273 Portability:
2275 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
2276   different module extension rather than our own ugly bodge.
2278 Java:
2280 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
2281   simple to make C++ to Java work though.
2283 PHP:
2285 * Add test that OP_VALUE_GE works for PHP.
2287 Python:
2289 * Several corrections to the Python documentation.
2291 * configure: Fix problem with building under mingw.
2293 Ruby:
2295 * Include simplematchdecider.rb example.
2297 * smoketest.rb: Test the version reporting functions.
2299 Tcl:
2301 * Include simpleexpand.tcl example.
2303 * Fix where the Tcl module gets installed.
2305 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
2307 Xapian-bindings 1.0.6 (2008-03-17):
2309 General:
2311 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
2312   used with.
2314 * configure: Correct the required SWIG version given in an error message.
2316 PHP:
2318 * php/smoketest.php: Add note that this script should be run using 'make check'
2319   in the build tree (rather than trying to copy it to a webserver as someone
2320   recently tried to).
2322 * php/smoketest.php: Fix to work under PHP4.
2324 Python:
2326 * The Python module now always has the extension which Python expects, which
2327   fixes a failure on Mac OS X.
2329 Ruby:
2331 * Automatically install/uninstall the Ruby rdoc-generated documentation along
2332   with the ruby bindings.
2334 Tcl:
2336 * configure: Sort out the default value of TCL_LIB, which could end up being
2337   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
2339 Xapian-bindings 1.0.5 (2007-12-21):
2341 General:
2343 * Wrap Xapian::Sorter and subclasses.
2345 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
2346   and Enquire::set_sort_by_relevance_then_key().
2348 * Factor out the code to protect multitarget rules against parallel make, and
2349   fix it to handle the source being changed while the rule is executing, and to
2350   correctly return an error code if we fail while trying to recover from the
2351   removal of a target of a multi-target rule.
2353 * configure: Improve the clarity of the error given when none of the tools
2354   needed for any supported language are found.
2356 * configure: SWIG 1.3.32 has now been released, so require at least this
2357   released version for maintainer builds.
2359 Java:
2361 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
2362   GCC 4.3.
2364 * configure: Log the output of trying to compile conftest.java in config.log;
2365   if the test fails, report whether the failure was compiling or running the
2366   test program.
2368 * Check for directory existence rather than calling mkdir unconditionally as
2369   despite the "(ignored)", the error message seems to confuse some people.
2371 PHP:
2373 * Add feature test for XapianMultiValueSorter.
2375 * php/smoketest5.php: Fix use of Database_get_document to new style OO
2376   interface.  Fix the error reported when the PHP5 exception test fails.
2378 * php/smoketest.php: Add feature test to confirm that optional arguments to
2379   XapianQuery's "term" constructor are wrapped.
2381 Python:
2383 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
2384   these properties build a python list, so dropping the GIL isn't safe and
2385   may cause undefined behaviour in multithreaded environments.
2387 * configure: Update error message to reflect requirement for at least python
2388   2.2.
2390 * configure: Change "print foo" to "print(foo)" in python version checks, for
2391   compatibility with python 3.0.
2393 Ruby:
2395 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
2396   previously incorrect).
2398 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
2399   ruby/docs/index.html previously had a dead link to.
2401 Tcl:
2403 * configure: Overhaul code to find tcl.h since the old version no longer worked
2404   with Debian unstable.
2406 * tcl8/docs/index.html: Update documentation to cover flint and mention that
2407   quartz is now deprecated.
2409 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
2410   throws QueryParserError instead.
2412 Xapian-bindings 1.0.4 (2007-10-30):
2414 General:
2416 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
2417   Add feature tests for all languages.
2419 * The "bindings.html" file documenting each of the bindings has been renamed to
2420   "index.html".
2422 Packaging:
2424 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
2425   older distros.
2427 Portability:
2429 * Fix warnings when compiling with GCC 4.2.
2431 PHP:
2433 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
2434   and methods/functions which return a wrapped class.
2436 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
2437   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
2439 * Document how non-class functions are wrapped.
2441 * Fix wrapping of NumberValueRangeProcessor for PHP4.
2443 * smoketest.php: Split the regression test for bug#193 into separate
2444   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
2446 Python:
2448 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
2449   non-pythonic iterators.  Make it clearer that the "sequence API" is
2450   deprecated.
2452 * Add test of a custom ValueRangeProcessor (ie, one written in python).
2454 * Update the examples to use the new-style attributes to access MSet item
2455   values rather than the old-style MSET_* constants.
2457 * Document MSET_DOCUMENT.
2459 Ruby:
2461 * smoketest.rb: Rename test of metadata access methods which had been named the
2462   same as the matchdecider test due to a copy-and-paste error.
2464 Xapian-bindings 1.0.3 (2007-09-28):
2466 General:
2468 * Wrap new methods Database::get_metadata() and
2469   WritableDatabase::set_metadata().
2471 * "make uninstall" now removes the loadable module we install for each of
2472   the bindings.
2474 * "make distcheck" now works.
2476 * Distribution tarballs are now in the POSIX "ustar" format since it saves
2477   about 40KB and we need to use it for xapian-core anyway.
2479 Packaging:
2481 * RPMs: Package xapian.php.
2483 CSharp:
2485 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
2486   usefully used currently.
2488 Java:
2490 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
2491   C++ library.
2493 * "make clean" now removes the class files generated for inner classes.
2495 PHP:
2497 * Add feature test for DateValueRangeProcessor when used with QueryParser.
2499 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
2500   isn't actually very useful, since you can't subclass it in PHP currently.
2502 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
2503   if the third parameter was specified and a floating point number (e.g. 0.0).
2505 * php/docs/bindings.html: Fix errors in example code.
2507 Python:
2509 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
2510   Python which takes two strings and returns a 3-tuple (value_number,
2511   modified_begin, modified_end).  Previously this always failed with a
2512   type error, so this doesn't break existing code.
2514 * python/pythontest.py: Interpret any commandline arguments as a list of
2515   tests to be run (the default is to run all tests).
2517 * README,python/docs/bindings.html: Add a note about the problems with
2518   mod-python (as described in bug #185).
2520 * python/pythontest.py: Delete the database handles before deleting a database
2521   to fix problems running the Python tests on MS Windows (bug#179).
2523 * "make clean" now removes testsuite.pyc.
2525 Ruby:
2527 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
2528   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
2529   now the site-specific directories, which is more correct when building
2530   from source.  Debian packages, etc can override this by setting RUBY_LIB and
2531   RUBY_LIB_ARCH.
2533 Tcl:
2535 * Check for TCL_LIB in the environment or on the configure command-line to
2536   allow installing without root access more cleanly.
2538 Xapian-bindings 1.0.2 (2007-07-05):
2540 Documentation:
2542 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
2543   phpextdir.
2545 * Remove documentation of removed "--with-swig" configure option.
2547 General:
2549 * Add methods of NumberValueRangeProcessor for serialising and
2550   unserialising doubles.
2552 * Add methods and constants supporting spelling correction and synonyms.
2554 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
2555   to ensure that it works with uninstalled copies of Xapian.
2557 * Value of PYTHON_LIB supplied to configure is now respected - previously
2558   it was documented, but ignored.
2560 * Add support for supplying PHP_EXTENSION_DIR to configure.
2562 * Change to using "%include", rather than reproducing contents of header
2563   files, for "queryparser.h", "document.h" and "postingiterator.h".
2565 * Add new form of get_mset() which allows a matchspy matchdecider to be
2566   set.
2568 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
2569   explode.  Add in a missing "mv" in the command for installing tcl8
2570   documentation.
2572 CSharp:
2574 * Fix rule handling parallel make to include xapian_wrap.h
2576 PHP:
2578 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
2579   doesn't seem to be a standard location, but this works for Debian at
2580   least, and it seems better to at least try to install it.
2582 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
2583   prefix for PHP4.
2585 Python:
2587 * Fix a threading problem: the GIL was not being acquired in the exception
2588   handling code before setting the Python exception state, leading to
2589   various memory corruption symptoms in threaded programs.
2591 * Add special iterators to Database for synonyms, synonym_keys and
2592   spellings.
2594 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
2595   synonym iterators and spelling iterators.
2597 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
2598   the expected description to make the tests more readable.
2600 Xapian-bindings 1.0.1 (2007-06-11):
2602 Documentation:
2604 * NEWS: Fix the recent headings which said "Xapian-core" to say
2605   "Xapian-bindings".
2607 General:
2609 * Wrap Xapian::Query constructor for creating ValueRange queries.
2611 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
2612   which take a prefix.
2614 Packaging:
2616 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
2617   %{buildroot} prefix on most files which we then have to work around.
2619 CSharp:
2621 * SimpleIndex now uses Xapian.TermGenerator.
2623 * SimpleSearch now uses Xapian.QueryParser.
2625 * New SimpleExpand example.
2627 * Document explicitly how STEM_SOME constants are currently wrapped.
2629 * Update GetTermName() reference in documentation to GetTerm().
2631 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
2632   their CVS repo, and the fix should be in their 0.8.2 release.
2634 Java:
2636 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
2637   looked at, but in fact its value was read but ignored.  We now use it as the
2638   first place to look for jni.h.
2640 * configure will now automatically add an extra "-I" for the
2641   linux/solaris/win32 subdirectory which Sun's JDK requires.
2643 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
2644   "precious" so their values are preserved for when configure is automatically
2645   rerun.
2647 PHP:
2649 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
2651 * The PHP examples have been rewritten to be clearer and to make use of the
2652   new XapianTermGenerator class.
2654 Python:
2656 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
2658 * Add support for prefix-restricted pythonic allterms iterators.
2660 * Update documentation in a couple of places to refer to updated replacements
2661   for MSetIterator.
2663 * Change testsuite output to be more vim-friendly (vim should be able to jump
2664   to the right lines now).
2666 * __str__ on Xapian::Error now includes extra information in some cases (the
2667   error_string and context, if they are set).
2669 * python/smoketest.py: Eliminate uses of the legacy sequence API.
2671 * python/pythontest.py: The legacy sequence API is only supported for Python
2672   2.3 and later, so don't run tests for it when running under Python 2.2.
2674 * We now generate and install xapian.pyo as well as xapian.pyc.
2676 Ruby:
2678 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
2679   classes.
2681 * Add missing rename for the C++ TermGenerator::set_document() method so it can
2682   be used as "tg.document = doc" in Ruby.
2684 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
2686 Tcl:
2688 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
2689   feedback, based on C++ simpleexpand.cc.
2691 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
2692   TermGenerator class.
2694 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
2695   QueryParser class.
2697 * tcl8/docs/bindings.html: Document how constants are wrapped.
2699 * Update smoketest and examples to require version 1.0.0 - previously this
2700   required 0.9.6, which failed since TCL doesn't accept differing major
2701   version numbers.
2703 * pkgIndex.tcl is now generated by configure.
2705 Packaging:
2707 * The required automake version has been lowered to 1.8.3, so RPMs can now be
2708   built on RHEL 4 and SLES 9.
2710 Xapian-bindings 1.0.0 (2007-05-17):
2712 Documentation:
2714 * Document Unicode support for each language.
2716 * Assorted minor improvements and typo fixes.
2718 General:
2720 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
2721   it, for languages where SWIG supports directors.
2723 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
2724   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
2725   allows the "default_prefix" argument to be supplied, QueryParser flags
2726   FLAG_PURE_NOT and FLAG_PARTIAL.
2728 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2730 * Remove wrappers for deprecated features removed from the C++ API (see
2731   docs/deprecation.html in xapian-core for full details and upgrade
2732   information).
2734 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
2736 * QueryParserError is now a real error, so remove special handling for "const
2737   char *" exceptions.
2739 * Use a stamp file in "make" rules with multiple targets so that parallel
2740   make works.
2742 * configure: Now quotes $PYTHON, etc so that you can specify a program with
2743   arguments.
2745 * configure: If the user specifies a program which doesn't exist (e.g.
2746   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
2748 * configure: Disable probes for f77, gcj, and rc completely by preventing
2749   the probe code from even appearing in configure - this reduces the size of
2750   configure by 28% and should speed it up significantly.
2752 * configure: If the version check against the xapian-core version detects a
2753   mismatch, we now issue a warning rather than a hard error since if you're
2754   careful this can work.  The warning is issued late on in configure, so it's
2755   harder for the user to miss.
2757 * configure: The --with-swig option has been removed.  It no longer has a
2758   purpose as we now ship the files which are generated by SWIG.
2760 Portability:
2762 * The PHP bindings can now be built with MSVC for Microsoft Windows.
2764 CSharp:
2766 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
2767   than mcs to avoid segmentation faults at runtime due to unimplemented
2768   features in mcs.  Document this, and update configure to prefer gmcs.
2770 * The return type of MatchDecider::operator() is now `bool' rather than `int'
2771   (in line with the same change in the C++ API).
2773 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
2775 Java:
2777 * The Java bindings have been updated to use C++ replacements for deprecated
2778   methods, so they still build.  The Java wrappers still provide the old
2779   deprecated names for now though.  The longer term plan is to replace the
2780   hand-written JNI with SWIG generated wrappers (work has now begun on this)
2781   which is likely to require some API changes, and it seems more sensible to
2782   make any changes to align with C++ API changes at the same time.
2784 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
2785   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
2787 PHP:
2789 * Fix undefined behaviour in get_matching_terms().
2791 * Document the (existing) renaming of methods which are PHP reserved words
2792   (empty() to is_empty() and clone() to clone_object()).
2794 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2796 Python:
2798 * The Python bindings now throw exceptions as classes with a hierarchy which
2799   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
2800   base class inherits from the standard Python Exception class.
2802 * All Python methods which accept strings can now be passed either a unicode
2803   object or a simple string.  Strings are returned as simple strings: unicode
2804   input will be returned as utf-8 encoded output.  The documentation now
2805   contains a "Unicode" section.
2807 * The Python bindings should now be usable more efficiently from threaded
2808   Python applications since we now use SWIG's -threads option when generating
2809   them, so that the GIL is released during long-running Xapian operations
2810   (bug#137).
2812 * Most classes, methods, functions, etc now have docstrings which are either
2813   automatically extracted from the C++ documentation comments, or overridden by
2814   more appropriate versions.
2816 * Most of the Pythonic iterators now return an object instead of a sequence,
2817   which means they now lazily fetch the information which previously had to be
2818   fetched to put it in the sequence.  The old sequence API is supported for
2819   compatibility, but is scheduled for removal in Xapian 1.1.0.
2821 * Those Python iterators which have skip_to() methods now return the item
2822   skipped to, and next() will return the following item.  Previously, they
2823   returned None, and next() returned the item skipped to.  Several bugs in the
2824   skip_to() wrappers were fixed.
2826 * Because of the lazy access, some objects returned by iterators will raise
2827   an error if the lazy evaluation happens after the iterator has moved on
2828   (since the underlying Xapian API doesn't allow efficient access to the
2829   information in this situation).  The exact semantics are defined in the
2830   docstrings for each iterator.
2832 * Those Pythonic iterators which return only a list of terms now return
2833   simple strings, instead of a sequence or an object containing the term.  This
2834   is an incompatible change with earlier releases.  The affected iterators are
2835   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
2836   QueryParser.unstemlist.
2838 * The contents of an MSet can now be iterated in the standard Python way.
2839   The iteration will return MSetItem objects.  The __contains__ and __getitem__
2840   methods are also implemented, allowing the "in" and [] operators to work.
2841   MSet.__getitem__ is a synonym for MSet.get_hit.
2843 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
2844   so that lazy access to its attributes is supported.  MSetItem has some
2845   deprecated methods which mimic the MSetIterator interface to allow old code
2846   to work without modification until release 1.1.0.
2848 * MSetItem provides access to the collapse_key and collapse_count, which
2849   weren't accessible from the sequence returned by the iterators before this
2850   release.
2852 * Out-of-range access to MSets will now raise an IndexError - it used to
2853   cause undefined behaviour (usually a crash).
2855 * The Python testsuite is now much more extensive, and supports colour output
2856   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
2857   features are separated out, so that they can easily be removed when the
2858   features are removed.  The Python tests currently focus mainly on Python
2859   specific iterators and related functionality - general Xapian behaviour is
2860   tested by the C++ testsuite.
2862 * The pure Python code in the bindings now uses new-style classes, since we
2863   have required Python >= 2.2 since Xapian release 0.9.9.
2865 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
2866   instead.
2868 * The get_description() method which many classes support has been deprecated
2869   in favour of new more pythonic __str__ methods, so that the str() builtin can
2870   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
2872 Ruby:
2874 * We no longer regard the Ruby bindings as "beta quality", so remove the
2875   warning from their documentation.
2877 * Document that that C++ operator() becomes the method "call" in Ruby.
2879 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
2880   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
2882 Tcl:
2884 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2886 Xapian-bindings 0.9.10.1 (2007-04-04):
2888 PHP:
2890 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
2891   default parameters.  The most notable case was a missing Query constructor
2892   which meant that QueryParser was unusable.
2894 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
2895   (which mostly seems to mean the MS Windows version).
2897 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
2898   seems to mean the MS Windows version).
2900 * Add note to the documentation that PHP examples are written for CLI version
2901   of PHP, but that the bindings work with any version.
2903 * Add check to all PHP examples that they are being run under a CLI version of
2904   PHP.
2906 Python:
2908 * simpleexpand.py: Print each term's expand weight as a floating point value,
2909   not an integer.
2911 Ruby:
2913 * INSTALL: document how to install Xapian's Ruby bindings in your home
2914   directory.
2916 Xapian-bindings 0.9.10 (2007-03-04):
2918 Java:
2920 * Under Mac OS X, automatically look in the standard location for jni.h,
2921   and automatically rename the JNI library we build to ".jnilib", as is
2922   required by the OS X JVM.
2924 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
2925   to add the linux header directory to the include path when using this JDK.
2927 * Add missing default constructor for RSet class - it's not much use without
2928   this!
2930 * Fix Enquire.getESet() to actually work.
2932 * Fix bug in ESetIterator.hasNext().
2934 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
2936 * Fix memory leak with some JVMs in the "Query from array" constructor.
2938 * Fix memory leak in Enquire.setQuery().
2940 * SmokeTest.java: Add regression tests for RSet default constructor,
2941   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
2942   Add feature tests for Enquire.getQuery(), and to make sure we get passed
2943   the right document in a java subclass of MatchDecider.
2945 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
2946   respective variables are set.
2948 PHP:
2950 * Update the documentation to fix out-of-date information and document the
2951   differences between the PHP4 and PHP5 wrappers.
2953 * Update the examples to use the new Object Oriented API, and provide versions
2954   for both PHP4 and PHP5.
2956 * Add a "simpleexpand" example.
2958 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
2959   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
2960   new name, but keep the old name for now for backward compatibility.
2962 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
2963   interpreter - this works with PHP5.
2965 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
2966   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
2967   directory may not exist and "make install" will create it.
2969 * configure: If zend.h isn't found and configure was run with "--with-php",
2970   exit with an error rather than automatically disabling PHP support.
2972 Python:
2974 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
2976 Packaging:
2978 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
2979   various "--without" options in a comment at the start of the .spec file.
2981 * RPMs: Remove "." from the end of the Summary.
2983 Xapian-bindings 0.9.9 (2006-11-09):
2985 Documentation:
2987 * Ship our custom INSTALL file rather than the generic one from autoconf which
2988   we've accidentally been shipping instead since 0.9.5.
2990 General:
2992 * Wrap Flint::open() and Flint::open_writable().
2994 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
2995   suitable).
2997 Python:
2999 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
3000   bit platforms with Python 2.5.
3002 Packaging:
3004 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
3006 * RPMs: The Python bindings now require Python >= 2.2.
3008 Portability:
3010 * configure: Remove unnecessary backticks from tclsh version test.
3012 Xapian-bindings 0.9.8 (2006-11-02):
3014 General:
3016 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
3017   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
3019 * The C++ method QueryParser::parse_query() current throws "std:string"
3020   exceptions if there's a parse error.  Previously the bindings didn't catch
3021   these.  Now we catch them and handle them as if they were exceptions of
3022   type Xapian::QueryParserError (in anticipation of this changing in
3023   xapian-core).  Added testcases for this for PHP, Python, and C#.
3025 * configure: Note that SWIG is only useful for Xapian developers in --help
3026   output.
3028 * configure: If we failed to find any languages to build for, give a more
3029   helpful message.
3031 CSharp:
3033 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
3035 Java:
3037 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
3038   work rather than using the cached failure of the first jni.h check.
3040 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
3042 * SmokeTest.java: Avoid gcj "set but not used" warning.
3044 PHP:
3046 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
3048 * smoketest4.php,smoketest5.php: Check the exception message given by the
3049   DocNotFoundError testcase.
3051 Python:
3053 * Drop support for Python 2.1.
3055 Xapian-bindings 0.9.7 (2006-10-10):
3057 Documentation:
3059 * NEWS: Fix the recent headings which said "Xapian-core" to say
3060   "Xapian-bindings".
3062 General:
3064 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
3065   configure.ac.
3067 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
3068   compiling SWIG generated code which makes the compiled modules a few percent
3069   smaller and perhaps a little faster.
3071 * Wrap the newly implemented transaction API.
3073 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
3074   (this option was supposed to be used to compile the Python bindings from
3075   0.9.3 onwards, but this wasn't actually working correctly).
3077 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
3079 * In maintainer-mode, "make clean" now removes the SWIG generated files
3080   which would otherwise only be removed on "make maintainer-clean".
3082 CSharp:
3084 * Xapian::MatchDecider can now be subclassed in C#.
3086 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
3087   to use it.  This has been fixed and a regression test added.
3089 * SmokeTest.cs: Added exception handling test.
3091 Java:
3093 * Correct two misuses of delete to delete[].  Fixes bug#78.
3095 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
3096   Debian and Ubuntu boxes at least.
3098 PHP:
3100 * We now generate class wrappers for PHP5.
3102 * We now generate proxy classes for PHP4, which is an incompatible change
3103   from previous versions of xapian-bindings.  A perl script to upgrade
3104   your scripts is included.
3106 * smoketest.php:
3108   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
3109     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
3111   + Rely on xapian.php to load the extension module for us.
3113   + Fix error messages to show PHP code, not Python code.
3115 * When running smoketest.php, pass the "-q" option to php, which suppresses
3116   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
3117   recent versions of PHP.
3119 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
3120   the PHP interpreter not to be found in some cases when it was actually
3121   available, but it's only used to run the smoketest not for building the
3122   bindings.
3124 Python:
3126 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
3127   and also report the check and its result to the user.
3129 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
3130   built, so add an explicit dependency so that this works reliably in parallel
3131   builds.  Fixes bug#77.
3133 * In examples and documentation, don't call the MatchDecider class/object
3134   "matcher", since we use the term "matcher" to mean something else in
3135   the library documentation.
3137 * smoketest.py:
3139   + Add test of exception handling.
3141   + Add test that MatchDecider can be subclassed successfully.
3143 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
3144   pythonic iterator class.
3146 Ruby:
3148 * Xapian::MatchDecider can now be subclassed in Ruby.
3150 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
3151   (with no "ruby" alias) on Ubuntu dapper at least.
3153 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
3154   since we may have less than 10 matches, so say "1-<N>" instead.
3156 * simplematchdecider.rb: Implemented.
3158 Tcl:
3160 * Implement saner exception handling for Tcl and document it.
3162 * smoketest.tcl:
3164   + Add check that xapian::Query_OP_ELITE_SET has the right value.
3166   + Rework how the smoketest gets run to eliminate special code for using
3167     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
3168     to be run using installed bindings, and also makes it a better example
3169     program.
3171   + Add test for exception handling.
3173   + Send error messages to stderr.
3175   + Add comment about Tcl storing zero bytes as \xc0\x80.
3177 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
3179 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
3180   used for the Tcl bindings.
3182 Xapian-bindings 0.9.6 (2006-05-15):
3184 Documentation:
3186 * INSTALL: Add section describing how to install without root access.
3188 General:
3190 * Updated to reflect the renaming of Xapian::xapian_version_string and
3191   companions to Xapian::version_string.
3193 * Wrap optional length parameter to Enquire::set_query().
3195 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
3196   consistency.  Keep get_document_id as an alias for now for backward
3197   compatibility.
3199 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
3200   probably a largely harmless error).
3202 * Stop SWIG from adding exception handling wrappers to the calls which return
3203   version strings, since they can't throw exceptions.
3205 * xapian.i: Removed superfluous "const" from return type "docid" which is just
3206   a typedef for an unsigned integer type.
3208 * configure: Add some missing "checking ..." messages so the user has more idea
3209   what is going on.
3211 * Language specific util.i files can now define
3212   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
3213   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
3214   are provided for each language.  This avoids needing to keep this
3215   information in two different places.
3217 * xapian.i: Uncomment commented-out parameter names and fix duplicate
3218   parameter names (for the benefit of bindings which use the parameter names,
3219   like the OO PHP5 patch for SWIG I'm working on...)
3221 Portability:
3223 * configure: Fix warning flags passed for Intel C++ compiler.
3225 CSharp:
3227 * We now support building with Portable.NET.
3229 * Note that the passing of strings from C# into Xapian and back isn't currently
3230   zero byte safe.  If you try to handle string containing zero bytes, you'll
3231   find they get truncated at the zero byte.
3233 * C# bindings now build and pass tests when srcdir != builddir.
3235 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
3236   always say "CSharp" instead.
3238 * Not all machines are set up to run compiled C# programs when invoked
3239   directly, so get configure to check if we can, and otherwise see if using
3240   mono or ilrun works.  If not, just skip the C# tests.
3242 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
3243   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
3244   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
3246 * Move the C# specific %rename list to csharp/util.i.
3248 * Store the strong name key in the key container so we reuse it for later
3249   builds.
3251 * Wrap the version functions as more sensible names and document them (and
3252   continue to provide the older undocumented names for now just in case anyone
3253   was using them.)
3255 * Set the version of XapianSharp.dll correctly when building a snapshot from
3256   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
3258 * SmokeTest.cs: Add test of version functions.
3260 Guile:
3262 * The Guile bindings don't work and aren't being actively worked on, so we're
3263   no longer including them in the distributed tarball to avoid disappointing
3264   users who notice a "guile" subdirectory.  It also makes the download smaller.
3266 Java:
3268 * Simplify (and improve portability of) run-java-test by using "libtool
3269   --mode=execute"'s -dlopen option.
3271 * Need to make sure "built" subdirectory exists or building from clean fails.
3273 * Fix "make check" to work when srcdir != builddir.
3275 PHP:
3277 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
3278   4.3.10), so use "php -n" and then set the options we specifically want using
3279   "-d".
3281 * Fix the smoketest invocation to work better when srcdir != builddir.
3283 * Look for PHP interpreter first in prefix given by "php-config --prefix".
3285 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
3287 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
3289 * smoketest.php:
3291   + Add test for version reporting functions
3293   + If a test fails, say which one to aid debugging.
3295   + Added simple test that zero-bytes are handled correctly when passing
3296     strings to and from Xapian.
3298 Python:
3300 * README: Note that Python bindings have been built with MSVC.
3302 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
3303   to make them executable (they don't have a #! line).
3305 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
3306   "mymatchdecider".  Add description of what this example does.
3308 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
3310 * smoketest.py: Added simple test that zero-bytes are handled when passing
3311   strings to and from Xapian.
3313 Ruby:
3315 * Added new Ruby bindings from Paul Legato.
3317 Tcl:
3319 * smoketest.tcl:
3321   + Add test for version reporting functions
3323   + If a test fails, say which one to aid debugging.
3325   + Added simple test that zero-bytes are handled correctly when passing
3326     strings to and from Xapian.
3328 Xapian-bindings 0.9.5 (2006-04-08):
3330 Documentation:
3332 * HACKING,README: Split off HACKING to contain information which is only
3333   relevant to those wishing to modify the bindings.
3335 General:
3337 * SWIG-based bindings are now built with SWIG 1.3.29.
3339 * configure: Report which languages we're building bindings for just before
3340   configure finishes.
3342 * xapian.i: Make the stub definitions for disabled backends static.
3344 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
3345   message.
3347 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
3349 Packaging:
3351 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
3352   Python bindings to support 64 bit systems.
3354 * RPMs: Package the C# bindings.
3356 Portability:
3358 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
3359   different name.
3361 * configure: Detect Intel's C++ compiler and set suitable warning flags to
3362   avoid noise from compiling generated code.
3364 CSharp:
3366 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
3368 Guile:
3370 * configure: Disable --with-guile since Guile support doesn't currently work.
3372 Java:
3374 * Override deprecation warnings for Xapian methods/functions/etc.
3376 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
3377   have some idea what went wrong!
3379 * Rework how we include headers to get hash_map to avoid compiler warnings
3380   since it's usually not in the std namespace nowadays.
3382 * Previously the "all" target also ran the "install" target, but this has
3383   proved very problematic, so change "make check" to use the uninstalled JNI
3384   glue library, and update the instructions to say that "make install" is now
3385   required.
3387 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
3388   .class files.
3390 * README: Note that some platforms need "-pthread" or similar flags.
3392 * Add a new Query constructor wrapper which take an OP_xxx and an array of
3393   Query objects.
3395 * Compiling a .java file to a .class file now deletes the .jar file to ensure
3396   it gets updated.
3398 PHP:
3400 * php -n avoids reading any php.ini, but the compiled in default may be to
3401   enable the dubiously named "safe_mode" which prevents dl() being used so
3402   "make check" fails.  So instead provide a very simple php.ini which turns off
3403   safe_mode and makes sure enable_dl is on.
3405 * Fix handling of bool parameters when resolving overloaded methods and/or
3406   default arguments.  This fixes Enquire_sort_by_value() to work when the
3407   second argument is specified.  Added regression test for this case.
3409 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
3411 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
3412   passed by reference.  Fixes bug#74.
3414 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
3415   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
3417 Python:
3419 * Use the fairly new "swig -O" option for the "modern" python bindings as
3420   it generates a smaller glue library and runs faster.  Some of the features
3421   enabled also work on python 2.1, so enable these for the "olde" bindings.
3423 * configure: Catch the case where the user has python installed but not the
3424   module "distutils.sysconfig" and explain that they probably need to install a
3425   python-dev or python-devel package.
3427 * "make check" now works in VPATH builds.
3429 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
3430   know which check it was!
3432 * smoketest.py: catch Exception objects and print them.
3434 * smoketest.py: Add feature tests for the various pythonic iterator
3435   wrappers
3437 * python/docs/bindings.html: Document the Pythonic iterators.
3439 * Fix TermIter not to try to read termfreqs or positions if they aren't
3440   meaningful for the current TermIter.
3442 Xapian-bindings 0.9.4 (2006-02-21):
3444 Documentation:
3446 * COPYING: Updated FSF address.
3448 General:
3450 * Wrap Stopper::get_description().
3452 * Wrap xapian_version_string() and related functions.
3454 Portability:
3456 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
3457   run from "make" too.
3459 PHP:
3461 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
3462   default on Windows).
3464 Python:
3466 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
3468 Xapian-bindings 0.9.3 (2006-02-16):
3470 Documentation:
3472 * README: Updated and expanded (now covers supported platforms, and lists
3473   criteria which bindings for an additional language need to fulfil before
3474   we're likely to accept them).
3476 * INSTALL: Updated and improved.
3478 * TODO: Move C#-specific TODO to top level so we can track to-do items for
3479   all languages.
3481 General:
3483 * configure: Change how the user selects which bindings to build.  If no
3484   --with* arguments are passed, then we default to building bindings we detect
3485   the required tools for (as before).  But instead of requiring the user to
3486   deselect all bindings they don't actually want, we now let them select the
3487   bindings they do want.  So "./configure --with-python" will only build the
3488   python bindings (and will fail if the required tools aren't installed).
3490 * Every wrapped method contains exception handling code.  The bulk of this
3491   is now factored out into a single helper function, which cuts the compile
3492   time by around a factor of 3 and halves the size of the stripped library
3493   (figures are for Tcl on x86_64).
3495 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
3496   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
3498 * configure: Bump required SWIG version to 1.3.28 and drop the special
3499   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
3500   SWIG to install the bindings - SWIG is run by the Xapian developers
3501   so these updated requirements are only relevant if you want to modify
3502   the bindings.
3504 * Eliminate separate Makefile in each examples subdirectory, which makes the
3505   build system simpler, smaller, and a little faster.
3507 * xapian.i: Include default constructors for all classes so that SWIG knows it
3508   doesn't have to use SwigValueWrapper for them, which makes the bindings code
3509   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
3510   std::pair<...>.
3512 * configure: Document special environmental variables which configure
3513   recognises.  Enhance handling of environmental variables so you can
3514   e.g. './configure PYTHON=python23' (previously you had to give a full
3515   path in such environmental variables or they would be ignored.
3517 Packaging:
3519 * RPM spec file:
3521   + Automatically detect the python version.
3523   + Rename "php4" references to "php".
3525   + Automatically detect the PHP extension directory.
3527   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
3529   + Add support for "--without php" and --without tcl8" options to rpmbuild.
3531 Portability:
3533 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
3534   10.3.  This is required to link the bindings, and it doesn't seem to be
3535   possible to link them on 10.1 or 10.2 anyway.
3537 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
3538   to be explicitly specified and libtool correctly handles platforms where it
3539   would have been implicitly linked with anyway.
3541 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
3543 * configure: Add missing ";;" on the last alternative in some case statements.
3545 * Only pass -no-undefined on platforms where it is required in order to link a
3546   shared library at all (it causes problems on Mac OS X in some cases).
3548 CSharp:
3550 * This release includes a lot of improvements for the C# bindings.  They're
3551   now pretty much on a par with the other language bindings.
3553 * Added documentation and examples.
3555 * Method and function names are now renamed to match C# conventions
3556   (e.g. from get_description() to GetDescription()).  This is obviously an
3557   incompatible change, but the C# bindings haven't been suitable for real world
3558   use prior to this release.
3560 * Optional parameters are now wrapped so no longer need be specified
3561   explicitly.
3563 * Overload ++ and -- for iterators.
3565 * Overload == and != for iterators.  Now comparisons with the end iterator
3566   work as expected, and SmokeTest passes.
3568 * SmokeTest now reports exceptions verbosely.
3570 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
3571   similarly for other database factory functions.
3573 * Heed compatibility warnings from mcs and use different forms for
3574   command-line switches to the C# compiler (presumably for compatibility with
3575   Microsoft's compiler, though the warnings don't actually say that
3576   explicitly).
3578 Guile:
3580 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
3581   zero-byte safe.  The guile bindings are still a long way from actually
3582   working though.
3584 Java:
3586 * Wrap optional second parameter (query length) to Enquire::set_query().
3588 * configure now probes for the Java path separator, which we then use to
3589   separate entries in the java -classpath command line option so we can
3590   build on platforms where it isn't ":".
3592 * SmokeTest.java: Expand to test more features.
3594 * java/README:
3596   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
3598   + Add note about how wrapped methods are named.
3600 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
3601   validity check.
3603 * Query.java: Comment out unused code.
3605 * Fixed memory leak in Query-from-array-of-strings constructor.
3607 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
3608   Xapian::Error subclasses can tell you their typename directly (using
3609   get_type()).
3611 PHP:
3613 * Some problems with overloaded methods in PHP have been fixed by a major
3614   overhaul of SWIG's PHP support.  So we no longer rename such methods
3615   for PHP.  This is an incompatible change, but it's easy to update your
3616   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
3618 * Previously the documentation and simpleindex.php suggested that you
3619   should call delete_CLASS().  This was incorrect and resulted in a
3620   double-free() in some cases, so we've fixed the documentation and
3621   examples and eliminated the delete_CLASS() wrappers.  This is another
3622   incompatible change, but again easy to update for.
3624 * We now support PHP5 as well as PHP4, so the configure test now looks
3625   for either and all references to "PHP4" or "php4" have been adjusted.
3627 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
3628   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
3629   warning and making the method return "Null".  This isn't ideal, but it's
3630   the best we can easily do without proper exceptions.
3632 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
3633   empty php.ini in srcdir (which we were failing to distribute anyway), use
3634   "$(PHP) -n" which tells PHP not to use any php.ini file.
3636 * Update PHP documentation to include new features.
3638 * Redo Xapian section in phpinfo() to look more like most other modules.
3640 * You can now construct a Query object from an array of strings or Query
3641   objects (or even a mixture).
3643 * PHP examples now give a more useful error message if a database can't be
3644   opened.
3646 * smoketest.php: Expanded the tests performed, including feature tests for
3647   the new Query-from-list constuctor.
3649 * simplesearch.php: Use newly wrapped Query-from-list constructor.
3651 * Use std::string::data() instead of c_str() as it may be more efficient for
3652   some STL implementations.
3654 * Enquire::get_matching_terms() now generates the PHP list directly from the
3655   TermIterator rather than constructing a temporary C++ std::list, which is
3656   faster and requires less temporary memory.
3658 Python:
3660 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
3661   once again (it has been broken since 0.9.0).  Added a regression test to
3662   help keep this working.
3664 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
3665   instead of a list).  Also the sequence can contain xapian.Query objects or
3666   strings or a mixture.  Documented these enhancements.
3668 * smoketest.py: Expanded the tests performed.
3670 * Convert C++ strings to python ones in a zero-byte clean way.
3672 * Added more error checking of the results of calls into the python
3673   interpreter.
3675 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
3676   itself is compiled with this option to avoid problems and it appears we ought
3677   to use it too to avoid the risk of hitting the same problems, although I'm
3678   not aware of anyone actually encountering such problems).
3680 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
3681   avoid creating a broken xapian.pyc is the shared library can't be loaded for
3682   some reason.
3684 * Enquire::get_matching_terms() now generates the Python list directly from the
3685   TermIterator rather than constructing a temporary C++ std::list, which is
3686   faster and requires less temporary memory.
3688 Tcl:
3690 * Terms with a leading underscore now work (thanks to changes in SWIG).
3692 * Implement custom typemaps for Tcl, so that you can now construct a Query from
3693   a list of Query objects and/or strings, and Enquire::get_matching_terms is
3694   now wrapped.
3696 * simplesearch.tcl: Use the new Query from list constructor.
3698 * simplesearch.tcl: Fix to lowercase and stem query terms.
3700 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
3702 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
3704 Xapian-bindings 0.9.2 (2005-07-15):
3706 General:
3708 * Added wrappers for new optional flags argument to QueryParser::parse_query().
3710 CSharp:
3712 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
3713   another tool with the same name.
3715 Java:
3717 * Include SmokeTest.java in the distribution so "make check" works.
3719 * Added success report for Sun java 1.4.1_01a.
3721 Python:
3723 * When converting a python list to vector<string> we know the number of elements
3724   so reserve that number in the vector.
3726 Xapian-bindings 0.9.1 (2005-06-06):
3728 General:
3730 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
3732 Tcl:
3734 * Updated documentation to include information from Michael Schlenker about how
3735   to delete a database object such that the destructor gets called.
3737 Xapian-bindings 0.9.0 (2005-05-13):
3739 General:
3741 * Updated SWIG-based bindings to latest Xapian API
3743 * Improve support for building the bindings on MS Windows:
3745   + Provide stub versions of any backend functions which are disabled in the
3746     library we're wrapping to avoid a link failure on MS Windows (where the
3747     remote backend is automatically disabled).  These stubs just throw
3748     Xapian::FeatureUnavailableError.
3750   + Add -no-undefined to *_la_LDFLAGS.
3752   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
3753     appropriate.
3755   + For python, paths for finding headers and installing libraries are now
3756     handled so they work on MS Windows; an extra static library needs to be
3757     linked in too.
3759 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
3760   for disabled backends).
3762 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
3763   being useful functionality.
3765 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
3766   introduced in future get fixed.
3768 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
3769   have.
3771 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
3772   1.3.22 for as more recent versions don't work with methods with optional
3773   arguments - the arguments become non-optional!)
3775 Guile:
3777 * configure: Disable guile by default, as it needs more work.
3779 Java:
3781 * Updated to compile against 0.9.0 API.
3783 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
3785 * Wrap optional parameters to Query(term) constructor.
3787 PHP4:
3789 * For PHP4, rename default Database constructor to Database_empty
3790   instead of suppressing the much more useful Database(const string &path)
3791   constructor.
3793 * Use a blank config file when running PHP4 tests to avoid problems
3794   when the bindings are already installed as an extension which is
3795   loaded automatically in the default config.
3797 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
3798   it probably just means it's not in PATH.  We only need it for running tests,
3799   so substitute a trivial shell script which just exits with code 77 so PHP
3800   tests are skipped (previously we substituted "missing" which caused the tests
3801   to fail).
3803 Python:
3805 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
3806   and ValueIter.
3808 * configure: If python is found, also check that Python.h exists (it may not be
3809   if the python-dev package (or similar) isn't installed).
3811 Xapian-bindings 0.8.5.1 (2005-02-23):
3813 General:
3815 * configure: Run compiler feature tests using the C++ compiler, not the C
3816   compiler.
3818 * Allow bindings version to have an extra "patchlevel", yet still match with
3819   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
3821 Java:
3823 * Added a missing .java source file and removed several unused ones.
3825 * Fixed several glitches in the java bindings automake build system.
3827 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
3828   warnings in generated code (we were carefully passing "-Wunused"
3829   which is the opposite of what is needed!)
3831 * Fixed a couple of warnings from GCJ.
3833 * Wrapped a few missing methods added since Eric created the bindings.  There
3834   are still some missing methods - there's now a (probably incomplete) list in
3835   java/README.
3837 * Added various useful bits of information to java/README.
3839 * Tweaked SimpleSearch.java to be more like the C++ version.
3841 PHP4:
3843 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
3844   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
3845   a more recent version.
3847 * configure: Check for "php" as a program name as well as "php4", and
3848   fall-back to missing so the error message from "make check" is better.
3850 Xapian-bindings 0.8.5 (2004-12-23):
3852 General:
3854 * INSTALL: Added non-generic installation instructions.
3856 Python:
3858 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
3859   the same directory as xapian.py, but Makefile.am was looking in current
3860   directory when installing it.  Additionally, VPATH builds were broken.
3861   These problems were introduced by changes in 0.8.4.
3863 Xapian-bindings 0.8.4 (2004-12-08):
3865 General:
3867 * README: Now clearly says which languages we currently support, which people
3868   are working on, etc.
3870 * Instead of requiring the user to have a really recent SWIG installed, ship
3871   the files SWIG generates.  Disable all the SWIG rules unless configure is run
3872   with --enable-maintainer-mode to make sure they aren't triggered accidentally
3873   (e.g. by make with dodgy VPATH).
3875 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
3876   needed if you just want to install the bindings).
3878 * Wrap the new Database and WritableDatabase constructors which replace
3879   Auto::open().
3881 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
3882   (for example, simpleexpand.py needs it).
3884 * In the Query constructor which takes a vector of terms, only call set_window
3885   if window is non-zero.  Otherwise things go wrong if we're passed an empty
3886   vector.
3888 * Second argument to Document::add_posting() isn't optional, but xapian.i
3889   indicated that it was.
3891 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
3892   Deriving your own weight class in the scripting language isn't currently
3893   supported.
3895 * xapian.i: %name is deprecated, so use %rename instead.  This also works
3896   around a bug in SWIG 1.3.23.
3898 * configure: Removed pointless probe for a C compiler - everything we compile
3899   is C++.
3901 * configure: Reinstated the check that the bindings version matches the version
3902   of the xapian library.  It was added in 0.8.2, but accidentally removed in
3903   0.8.3.
3905 * Use newly added option `xapian-config --swigflags` which (a) avoids always
3906   passing -I/usr/include which could cause problems if we're using a Xapian
3907   install not in /usr and there's another one in /usr and (b) avoids problems
3908   if `xapian-config --cxxflags` contains flags other than -I<something>.
3910 CSharp:
3912 * Richard Boulton has put together bindings for C#.  These build successfully
3913   with the Mono tools, but the smoketest currently fails.  Unclear if the
3914   problem is the bindings or the smoketest code.
3916 Guile:
3918 * The guile bindings now build successfully, so we've enabled the guile
3919   detection machinery in configure.  They're untested though (we don't
3920   know guile!) so success or failure reports are encouraged!
3922 PHP4:
3924 * Mention the example scripts near the start of the documentation, not right at
3925   the end.
3927 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3928   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3929   mention!
3931 Python:
3933 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
3934   work in Python.
3936 * Changed examples to use the newly wrapped Query from list of terms ctor.
3938 * Mention the example scripts near the start of the documentation, not right at
3939   the end.
3941 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
3942   SWIG.
3944 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3945   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3946   mention!
3948 * Mention simpleexpand example in documentation.
3950 * Examples now report messages for Xapian exceptions.
3952 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
3954 * Make the example MatchDecider exclude documents matching a value, rather than
3955   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
3956   don't want examples to mislead like that.
3958 * python/docs/bindings.html: Note that you can construct a query
3959   from a list of terms, even if you can't from a list of queries.
3960   Add HTML links to the examples.
3962 * simpleindex.py: Trim spaces from the start as well as from the end of each
3963   line.  Simplify the loop slightly.
3965 Tcl:
3967 * Wrap in a tcl8 namespace "Xapian".
3969 * Added a smoketest.
3971 * Translated simpleindex and simplesearch into Tcl.
3973 * Set the Tcl package version.
3975 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
3977 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
3979 * Added documentation for tcl8 bindings.
3981 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
3982   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
3983   version (was 8.0).
3985 * configure.ac: Noted that the bindings can easily be compiled for use with
3986   Tcl 8.0, in case anybody needs that for some reason.
3988 * Don't wrap the factory functions which return a quartz WritableDatabase as
3989   the destructor never gets called so changes aren't flushed and the lock file
3990   isn't removed.
3992 Xapian-bindings 0.8.3 (2004-09-20):
3994 General:
3996 * Fixed mismatching versions of libtool used to produce configure and
3997   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
3998   names.
4000 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
4001   PHP4, and Tcl bindings.
4003 Java:
4005 * Pass -classpath to javac to fix build problems.
4007 * Make sure errors subdirectory is built before we try to build the jar file.
4009 * Fixed "make install" to not give libtool error.
4011 PHP4:
4013 * Include PHP4 documentation and exmples in the tarball.
4015 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
4016   change from 0.8.2 - it turns out we only need to pass these flags if we use
4017   swig's -noruntime option (which we don't do).
4019 Python:
4021 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
4022   faster Python wrapper code.
4024 Tcl:
4026 * Don't install xapian.la.
4028 * Improved configure check for tcl.h to work with Fedora Core 2.
4030 Xapian-bindings 0.8.2 (2004-09-13):
4032 General:
4034 * Added wrappers for recently added methods: ESet::back() and
4035   Database::get_lastdocid(), and wrap the new optional third parameter
4036   to Enquire::set_sorting().
4038 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
4040 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
4042 * Wrap Quartz, InMemory, and Remote database factory functions as
4043   quartz_open(), inmemory_open(), and remote_open().
4045 * Added missing wrappers for static Stem::get_available_languages() and
4046   Stem::get_description().
4048 * Wrap renamed method Query::empty() (was Query::is_empty()).
4050 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
4051   as an alias for now).
4053 * Require autoconf 2.59 and automake 1.8.5.
4055 * configure: Added check that the bindings version matches the version of
4056   the xapian library.
4058 * configure: Check if we're using GCC and only pass GCC specific warning
4059   control options if we are.
4061 * configure: When running with GCC, also pass -Wno-uninitialized so the
4062   SWIG glue builds without warnings.
4064 * README: Updated list of languages which SWIG supports.
4066 PHP4:
4068 * Document that the 2 argument form of Xapian::Auto::open() for opening a
4069   writable database is wrapped as open_writable() (bug #32).
4071 * Include Xapian version in output from phpinfo().
4073 * Build the SWIG glue library like we build the others rather than using
4074   SWIG's -phpfull option.  This avoids problems with newer automake versions
4075   and means we can build against an uninstalled xapian library.
4077 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
4078   Fixed documentation of how Xapian::Query::OP_* are wrapped.
4080 * Use special SWIG PHP ldflags when linking the PHP glue library.
4082 * simplesearch.py now works with multi-term queries.
4084 * Added documentation on how to install the PHP4 bindings.
4086 * Added a simple testcase to at least ensure the PHP4 bindings can be
4087   initialised and some simple operations work.
4089 Python:
4091 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
4093 * Don't install _xapian.la and _xapian.a.
4095 * Byte compile xapian.py to xapian.pyc and install it.
4097 * Suppress SWIG warning about MatchDecider::operator() director discarding
4098   const.
4100 * "make clean" no longer leaves "xapian_wrap.h" behind.
4102 * Added a simple testcase to at least ensure the python bindings can be
4103   initialised and some simple operations work.
4105 Tcl8:
4107 * configure: Disable building tcl8 bindings if the headers are missing
4108   (probably because the tcl8.X-dev package isn't installed).
4110 Xapian-bindings 0.8.1 (2004-06-30):
4112 General:
4114 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
4116 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
4117   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
4118   doesn't emit -I/usr/include in this situation (because it causes problems
4119   with some GCC versions).
4121 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
4122   not just a subset.
4124 Java:
4126 * Removed wrappers for unused error classes which have been pruned from C++.
4128 * Make finalize() methods of Database and WritableDatabase public so they can
4129   be called from by the user.
4131 * Document Document.add_term_nopos() as deprecated.
4133 PHP4:
4135 * Make sure that PHP bindings build a module which exports get_module() so PHP
4136   is able to load it.
4138 * Configure now checks that phpize can actually be run, rather than just that
4139   it's executable (test -x isn't portable anyhow).
4141 * Added basic documentation and examples to PHP4 bindings.
4143 * Rename overloaded methods and constructors.
4145 * Add simple access to the prefixes map in QueryParser.
4147 * Correct simpleindex ports to never generate empty termnames.
4149 Python:
4151 * configure: Use $PYTHON instead of python when running python to determine
4152   library and include paths and version number.
4154 * Actually ship python examples and documentation.
4156 Xapian-bindings 0.8.0 (2004-04-20):
4158 * README: Started collecting information on supporting Xapian from even
4159   more languages.
4161 * Added configure tests to enable bindings only where the necessary tools
4162   are installed and have a supported version.  ./configure --without-LANGUAGE
4163   allows particular languages to be forcibly disabled.
4165 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
4167 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
4169 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
4170   have been well tested, but integration with the xapian-bindings configure
4171   system hasn't been tested at all - please alert us to any problems.
4173 * Xapian can now be used from TCL.
4175 * Python: MSet now provides a Python iterator.
4177 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
4179 * Python: enable directors for MatchDecider, to allow subclassing in Python.
4181 * Python: Added basic documentation, and some examples.