Add appveyor CI build
[xapian.git] / xapian-bindings / NEWS
blobed4e4d61f54c2e01ef971669ffa586ad5efde7ec
1 Xapian-bindings 1.4.5 (2017-10-16):
3 Documentation:
5 * HACKING: Add details of Debian PHP7 packages to install for development.
7 General:
9 * Use a pattern match to ignore methods meant for internal use only rather
10   than having to list them all - they're consistently named to end with an
11   underscore.
13 * Stop using deprecated Xapian::percent typedef in bindings-specific code.
14   Deprecation warnings are suppressed when building the bindings (because the
15   bindings usually still need to wrap deprecated C++ features) so this probably
16   has no user-visible consequences.
18 Java:
20 * Fix JNI code to be compatible with Java 6 and earlier, where the final
21   parameter of SetByteArrayRegion() was not const.  This also seems to affect
22   GCJ (though GCJ was removed in GCC 7).  The incompatibility was introduced in
23   1.4.4.
25 Lua:
27 * Support subclassing of RangeProcessor in Lua.
29 Perl:
31 * Add CLONE_SKIP to RangeProcessor and subclases to avoid double deletion
32   if the Perl threads module is in use.
34 * Keep references for set RangeProcessor objects, like how we do for
35   ValueRangeProcessor and various other functor objects.
37 * Use RangeProcessor instead of ValueRangeProcessor in perl examples, as
38   ValueRangeProcessor is now deprecated.
40 PHP:
42 * Keep references for set RangeProcessor objects, like how we do for
43   ValueRangeProcessor and various other functor objects.
45 * Add type hints to QueryParser::add_rangeprocessor().
47 PHP7:
49 * Keep references for set RangeProcessor objects, like how we do for
50   ValueRangeProcessor and various other functor objects.
52 * Add type hints to QueryParser::add_rangeprocessor().
54 * Fix PHP7 "make check" to use right path separator.  It was using the PHP5
55   one, which in general is going to be the same but we won't have probed for
56   that unless we're also building the PHP5 bindings, which means "make check"
57   failed for PHP7 unless you also had the PHP5 bindings enabled.
59 Python3:
61 * Fix "make check" under Python 3.2, which was broken in 1.4.4 because Python
62   3.2 doesn't support the u'foo' syntax.
64 * Copy over Python2 check which aims to catch any internal functions, methods,
65   constants, etc which have accidentally been wrapped.
67 Ruby:
69 * Fix dependency generation for Ruby SWIG command (only relevant at all if
70   you configure with --enable-maintainer-mode).
72 Xapian-bindings 1.4.4 (2017-04-19):
74 General:
76 * Update tests for xapian-core changes to avoid unnecessary "0 *" in query
77   descriptions in certain cases.
79 Packaging:
81 * Ship java.i in tarball.
83 Java:
85 * Handle object serialisations and document values as Java byte[].  These will
86   usually contain binary data, so Java String doesn't work well and byte[] is a
87   much better fit.
89 * Correct various errors in java examples and documentation on how to run them.
91 * Fix java examples not to abuse doc values as fields - use the document data
92   instead.
94 * "make clean" now removes additional class files.
96 PHP7:
98 * Update version of SWIG required to >= 3.0.12 so that the code generated
99   for PHP7 no longer results in a segmentation fault on module unload with
100   PHP 7.1.  Fixes #748, reported by Victor Sakovich.
102 Python:
104 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
105   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
106   https://bugs.debian.org/849722
108 * Fix configure --with-python to fail if sphinx isn't found.  Patch from
109   Patricio Paez.  Fixes #749.
111 Python3:
113 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
114   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
115   https://bugs.debian.org/849722
117 Xapian-bindings 1.4.3 (2017-01-25):
119 Python:
121 * Remove compatibility code for Python < 2.5 - 1.4.x requires Python >= 2.6.
123 * Avoid unnecessary pointer indirection in XapianSWIG_anystring() helper
124   function, which should be a little more efficient and makes the Python 2
125   code more closely match the Python 3 code.
127 Ruby:
129 * "make clean" should only remove docs/xapian.rb if configure option
130   --enable-documentation was used to enable all rules to rebuild documentation.
131   Reported by Samuel Williams on xapian-discuss.
133 * Fix make rule for running rdoc for the cases where srcdir != builddir.
135 * Use 'test a = b' rather than 'test a == b' - the former is portable, the
136   latter a bashism.  In many cases the autotools will set SHELL = /bin/bash in
137   the makefiles, but if it doesn't and /bin/sh isn't bash, then this will
138   cause "make install" and "make uninstall" to fail for the Ruby bindings.
140 Xapian-bindings 1.4.2 (2016-12-26):
142 General:
144 * configure: Fail with clear error with xapian-core < 1.4.0.
146 * Work around OS X "System Integrity Protection".  We can't address the problem
147   of being unable to run tests against an uninstalled tree when the interpreter
148   is in a system directory (you have to "make install" in xapian-core for that
149   case), but we can at least make this work for interpreters which aren't in
150   system directories.
152 Java:
154 * Disable parallel make for java subdirectory as it causes random build
155   failures.  Reported by Lucas Nussbaum in https://bugs.debian.org/848733
157 * Disable automatic use of -Xcheck:jni for now as it seems to report false
158   positives with OpenJDK 8 and 9.
160 PHP:
162 * Generates smaller PHP wrappers by only emitting each unique arginfo
163   combination once (~6% saving in stripped extension module size for
164   PHP7 on x86_64 Linux).
166 * Fix to work again with a version of PHP5 built with ZTS enabled (which is the
167   default on Microsoft Windows).
169 * Add support for PHP7.
171 * Drop workaround for PHP4 from test code.
173 Python:
175 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
176   from a command line Python code snippet.  Reported by Alex Dunn in
177   https://github.com/xapian/xapian/pull/126 and solved with help from James
178   Aylett.
180 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
181   need to keep such a reference (as we already do for ValueRangeProcessor and
182   several other classes).
184 Python3:
186 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
187   from a command line Python code snippet.  Reported by Alex Dunn in
188   https://github.com/xapian/xapian/pull/126 and solved with help from James
189   Aylett.
191 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
192   need to keep such a reference (as we already do for ValueRangeProcessor and
193   several other classes).
195 Ruby:
197 * Use more conventional Ruby variable names in the examples (Ruby convention
198   uses underscores not camelcase) and fix comma/space transposition in a couple
199   of places.
201 Xapian-bindings 1.4.1 (2016-10-21):
203 Documentation:
205 * Fix --disable-documentation - in maintainer-mode, we still tried to make
206   docs/index.html for most of the bindings, which failed because the rule to do
207   so was disabled.
209 General:
211 * Update for additions to C++ API.
213 * When a backend is disabled in the xapian-core we're building against, we
214   have a stub version of any factory functions so the bindings still have
215   something to wrap.  Update these for 1.4:
216   + Disable stub for InMemory::open() when
217     XAPIAN_BINDINGS_SKIP_DEPRECATED_DB_FACTORIES is defined (Perl, Python3).
218   + Add new optional flags parameter to both overloaded forms of
219     Remote::open_writable().
221 Portability:
223 * Drop compiler options that are no longer useful:
224   + -fshow-column is the default in all GCC versions we now support
225     (checked as GCC 4.6).
226   + -Wno-long-long is no longer necessary now that we require C++11 where
227     "long long" is a standard type.
229 Java:
231 * Use a cleaner technique to insert the Java code to load JNI library into the
232   generated wrapper - we now use "%pragma(java) jniclasscode" instead of using
233   Perl to post-process the generated wrapper.  Suggested by James Aylett.
235 * Run Java tests with -Xcheck:jni if supported, which should help catch any
236   any bugs in the JNI code.
238 * Fix configure to find jni_md.h under Cygwin.  There doesn't seem to be an way
239   to automatically determine the machine-dependent JNI include path, so add
240   another case to use "win32" on Cygwin.  Reported by John Bankert on
241   xapian-discuss.
243 * Add more special cases to find jni_md.h on Cygwin, OS X, *BSD, AIX.
244   There doesn't seem to be an explicit list of these directories anywhere, but
245   grepping the OpenJDK 8 source code finds additional values "darwin" and
246   "aix", *BSD seems to use "bsd", and Cygwin uses "win32" (reported by John
247   Bankert on xapian-discuss).
249 * Generate xapian.jar rather than xapian_jni.jar - the fact that JNI is
250   involved is really just an implementation detail.
252 * SmokeTest.java: Add simple test of subclassing FieldProcessor.
254 Perl:
256 * Merge Perl POD doc improvements from Search::Xapian.  The most notable
257   improvement is a number of methods previously lacking docs now have them.
259 * Fix typo in POD docs for Perl bindings ("outputing" -> "outputting").
260   Reported by knowledgejunkie in #730.
262 Python:
264 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
266 * Fix Python2 bindings to work out of the box.  SWIG changed the code it
267   generates for importing the compiled module in a recent version, and
268   the newer code no longer works with the wrapper renamed to
269   xapian/__init__.py.  There's currently no way to configure SWIG to produce
270   what we need so for now we run a "fixup" script over the generated wrapper
271   which replaces the complex import code with a single statement which does
272   what we want.  It also strips out various unneeded code, mostly to do with
273   handling Python 3.x (which we don't need since we have an entirely
274   separate set of bindings for that).  Reported by James Aylett in #731.
275   The way we were importing the bindings to generate the .pyc and .pyo
276   files was masking this problem, so rework that as suggested by James.
278 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
279   parallel builds (make -j) may attempt to schedule the sphinx doc build before
280   the relevant wrapper has been compiled and moved into position.  This won't
281   result in a build failure, but will silently omit API docs that sphinx
282   would otherwise include.  Patch from James Aylett.
284 * doxy2swig: Specify encoding when reading doxygen's XML output so UTF-8 in
285   doxygen comments is handled.  Patch from Vivek Pal.
287 * Specify Python2 wrapper encoding is UTF-8.  This is needed when we pick up
288   doxygen comments from the C++ API which contain UTF-8.  For Python3, the
289   default source encoding is UTF-8, so we don't need the equivalent change
290   there.
292 Python3:
294 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
296 * Fix Python3 bindings to work out of the box.  SWIG changed the code it
297   generates for importing the compiled module in a recent version, and
298   the newer code no longer works with the wrapper renamed to
299   xapian/__init__.py.  There's currently no way to configure SWIG to produce
300   what we need so for now we run a "fixup" script over the generated wrapper
301   which replaces the complex import code with a single statement which does
302   what we want.  It also strips out various unneeded code, mostly to do with
303   handling Python 2.x (which we don't need since we have an entirely
304   separate set of bindings for that).  Reported by James Aylett in #731.
305   The way we were importing the bindings to generate the .pyc and .pyo
306   files was masking this problem, so rework that as suggested by James.
308 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
309   parallel builds (make -j) may attempt to schedule the sphinx doc build before
310   the relevant wrapper has been compiled and moved into position.  This won't
311   result in a build failure, but will silently omit API docs that sphinx
312   would otherwise include.  Patch from James Aylett.
314 * Fix memory leak converting string from Python to C++.
315   XapianSWIG_anystring_as_ptr() was failing to flag the returned value as
316   allocated, so it wasn't being deleted.  Reported by Sean Robinson in #729.
318 Xapian-bindings 1.4.0 (2016-06-24):
320 Documentation:
322 * Mark SWIG-generated Java and Perl bindings as "experimental" until we've
323   had a chance to sort out any remaining changes we want to make.
325 Xapian-bindings 1.3.7 (2016-06-01):
327 Documentation:
329 * Remove long out-dated reference to tinderbox.
331 General:
333 * Use SWIG 3.0.9 to generate the bindings.  There's nothing very important to
334   us in the changes since the git snapshot we were using - mostly this means
335   we're using a released version, which seems preferable.
337 Tcl:
339 * Fix segfault in tcl bindings "make check".  The location of tclConfig.sh
340   wasn't being found, so libtclstub wasn't being linked to, which is required
341   with Tcl >= 8.6.
343 Xapian-bindings 1.3.6 (2016-05-09):
345 General:
347 * Update for changes to the C++ API.
349 * Use WritableDatabase::commit() instead of flush() in testcases, as the
350   latter is now formally deprecated.
352 Java:
354 * Fix syntax error in SmokeTest.java, introduced by the DB_BACKEND_INMEMORY
355   change.  Noted on #xapian-discuss by Aakash Muttineni.
357 * Update Java TODO list.
359 * SmokeTest.java: Port over version checks from SmokeTest.cs.
361 * Update list of recently tested JDK versions.
363 Lua:
365 * Note Lua bindings work with Lua 5.3.
367 Perl:
369 * Explicitly specify POD docs encoding as utf8.  Fixes warning in generated
370   HTML docs.
372 * Convert POD to HTML when building from a source tarball - the conversion
373   code comes as standard with Perl.  In 1.3.5 we were failing to ship the HTML
374   output, as reported by Anthony Basile.
376 * For extra robustness, convert POD to HTML using the bundled Pod::Html module
377   from the Perl interpreter found by configure, rather than assuming pod2html
378   is on PATH, and the right one (this matters more now that it's not just
379   people building from git who build these docs).
381 * Improve Perl bindings POD documentation.
383 * Remove workaround for Perl macro vs C++11 header.  SWIG 3.0.6 and later adds
384   a different workaround to the generated C++ wrapper file, and we require SWIG
385   3.0.8 for a Python fix, so we no longer need our workaround.
387 Python:
389 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
390   system, so I'm guessing this is now required due to a change in the code SWIG
391   generates.
393 Python3:
395 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
396   system, so I'm guessing this is now required due to a change in the code SWIG
397   generates.
399 * Fix install location for python3 docs.  They were being install to the same
400   path as the python docs - now the path includes "python3" instead of
401   "python".
403 Ruby:
405 * Increase minimum Ruby version to 2.1, as older versions are no longer
406   supported by the Ruby developers.
408 Xapian-bindings 1.3.5 (2016-04-01):
410 This release includes all changes from 1.2.23 which are relevant.
412 Documentation:
414 * Fix to install docs when not in maintainer-mode.
416 * Note open_stub() is deprecated (most of the bindings already noted this, but
417   now ruby and tcl do too).
419 General:
421 * Update for changes to the C++ API.
423 * PostingSource is now fully wrapped for the bindings.  Fixes #499, reported by
424   Joost Cassee.
426 * Ship swig-depcomp and doxy2swig scripts in the source tarball.
428 * Add installcheck-local make targets for most languages - these run the
429   testsuites using the installed bindings.
431 CSharp:
433 * configure: Stop checking for obsolete mono compiler names - gmcs, smcs and
434   dmcs were all deprecated in Mono 2.11.
436 * configure: Strip out handling of DotGNU - it's been inactive for years, and
437   was officially "decommissioned" in December 2012.
439 * README: Update list of mono versions recently tested with.
441 Lua:
443 * smoketest.lua: Fix to work with newer lua - coercing a number to a string
444   now appends ".0" for whole numbers.
446 Perl:
448 * Run pod2html with explicit --podpath=. - recent versions of pod2html seem to
449   need this to correctly handle references to other Xapian classes.  Reported
450   on #xapian-discuss by HowManny and abhishek_rand0wn.
452 Python:
454 * Run sphinx at build time.  It's an extra tool for people building from source
455   to have to install, but its output is rather large (this change reduces our
456   tar.xz size by ~20%), and its output includes a source-less minified copy of
457   jquery.
459 Python3:
461 * Run sphinx at build time.  It's an extra tool for people building from source
462   to have to install, but its output is rather large (this change reduces our
463   tar.xz size by ~20%), and its output includes a source-less minified copy of
464   jquery.
466 * Fix handling of integer values larger than a C int by bootstraping with a
467   newer version of SWIG.  Fixes #703, reported by Barry Warsaw.
469 * Remove xapian.inmemory_open() - we've deprecated the corresponding C++
470   function, and the Python3 bindings haven't yet had a stable release.
472 Ruby:
474 * Run rdoc at build time - it is included as part of the Ruby core
475   distribution, so we can assume it is available if ruby is, and avoid shipping
476   its rather large generated output in our source tarball.
478 Xapian-bindings 1.3.4 (2016-01-01):
480 This release includes all changes from 1.2.22 which are relevant.
482 Documentation:
484 General:
486 * Wrap new and changed features in C++ API.
488 * PostingSource set_maxweight() is now accessible to the bindings.  Fixes #498,
489   reported by Richard Boulton.
491 * configure script now defaults to looking for xapian-config-1.3.  This is now
492   automatically done for development series (odd middle component of the
493   version number), but not for stable series (even middle component).  Fixes
494   #695, reported by Jorge C. Leitão
496 PHP:
498 * Make PHP 5.5 the minimum officially supported version, as 5.4 has now reached
499   EOL.
501 * In the examples, when iterating an MSet with foreach, don't throw the docid
502   away as $dummy, put it in $docid and use it - the code looks cleaner, and
503   this avoids an extra call to C++ to get the docid on each iteration.
505 Python:
507 * Drop support for Python 2.5.
509 Python3:
511 * Document installation of Python 3 bindings.  Fixes #694, reported by Jorge C.
512   Leitão.
514 * Fix testsuite for changes in Python 3.5.  Fixes #690, patch from UsusDei.
516 * Handle renaming of .pyo to .opt-1.pyc files due to PEP-0488.  Fixes #689,
517   patch from UsusDei.
519 * Fix Python 3 version check to accept 3.10.
521 Xapian-bindings 1.3.3 (2015-06-01):
523 This release includes all changes from 1.2.20-1.2.21 which are relevant.
525 Documentation:
527 * INSTALL: IRIX is past EOL so drop information about IRIX make.
529 General:
531 * Add DB_RETRY_LOCK as a constant to wrap.
533 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
535 * Fix "make install" from a git tree configured with --disable-documentation.
536   (Fixes #658, reported by Germán M. Bravo)
538 * Fix "make install" when building from git with --disable-documentation.
540 * Fix to handle a VPATH build from a tarball when the generated docs will be in
541   $(srcdir).
543 * Update testcases for lazy wildcard expansion change in xapian-core.
545 * Update for addition of XAPIAN_NOEXCEPT.
547 * Don't wrap internal methods of Xapian::Weight.
549 Portability:
551 * Require a compiler with good C++11 support, like xapian-core now does.
553 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
554   doxygen.
556 * configure: Update check for -fvisibility to match xapian-core's.
558 CSharp:
560 * Fix configure test for whether $CLI can run CSharp programs - previously it
561   would always fail, which would mean that the CSharp tests wouldn't be run on
562   platforms where CSharp programs can't be run directly.
564 Java:
566 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
568 Lua:
570 * The Lua bindings are no longer considered to be "experimental" (in reality
571   they haven't been for some time).
573 Perl:
575 * Add a "LICENSE" section to the main POD.
577 * Add 'use strict' to all testcases, and add missing instances of 'my' that
578   this change uncovered.
580 * Wrap new WILDCARD_LIMIT_* constants as constants.
582 Python:
584 * Don't release the GIL when constructing a Query object from a sequence of
585   Query objects and/or strings.
587 * python/smoketest.py: Add new testcase to catch any internal functions,
588   methods, constants, etc which have accidentally been wrapped.
590 Python3:
592 * The Python3 bindings are no longer considered to be "experimental".
594 * Don't release the GIL when constructing a Query object from a sequence of
595   Query objects and/or strings.  (fixes #346)
597 * python3/pythontest.py: Expand comment about disabling test_import_star under
598   threads.
600 Tcl:
602 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
603   version added ::tcl::pkgconfig, which makes the configure tests simpler and
604   more reliable.
606 * Adjust precedence of the typecheck typemap for wrapping constructing a query
607   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
608   constructor correctly.
610 Xapian-bindings 1.3.2 (2014-11-24):
612 This release includes all changes from 1.2.16-1.2.19 which are relevant.
614 Documentation:
616 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
618 * Update for deprecation of Xapian::Chert::open().
620 * Update for renaming of "brass" backend to "glass".
622 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
623   updated" information isn't all that informative anyway - there can still be
624   stale information even if the file was updated very recently.
626 General:
628 * Releases and snapshots are now bootstrapped using a more recent version of
629   SWIG (a git snapshot from after the 3.0.3 release).
631 * configure: Fix SWIG version check to accept 3.x, and update the minimum
632   accepted version to be what we actually currently want.
634 * Wrap new C++ API features, and in particular all the new weighting schemes,
635   the changes to opening databases, and Xapian::Snipper.
637 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
638   argument which the C++ API takes.  If opts != 0, then output is sent to
639   stdout, otherwise no output is produced.
641 * Object descriptions are now always valid UTF-8. (see #620)
643 * Provide a SimpleStopper constructor which provides the ability to initialise
644   from a stopword list in a file.  Based on patch from Assem Chelli.
646 CSharp:
648 * README: Note that C# bindings now need .NET 2 or later (because that's what
649   SWIG-generated code now requires).
651 Java:
653 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
654   Anish Kanchan.  (see #616, reported by "Naveen")
656 Lua:
658 * Document that constants can now be accessed using CLASS.CONSTANT as well as
659   CLASS_CONSTANT.
661 Perl:
663 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
664   overlap with the hand-coded XS 'Search::Xapian' module.
666 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
667   during parallel builds.
669 * Use croak_sv() or ERRSV if defined.
671 PHP:
673 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
674   reached EOL.
676 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
677   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
678   `foreach ($it as $c)` works and allows iterating through the equivalent of
679   C++ operator* on the iterator.  (fixes#652)
681 * Fix handling of an exception thrown from a PHP implementation of
682   FieldProcessor::apply().
684 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
685   weight threshold.
687 * In current PHP releases, dl() is disabled in most SAPIs, and even where
688   available it will now only look in the configured extension directory.  The
689   upshot is that there no longer seems to be a sane way to install the PHP
690   bindings without being root.  Fixes #661, reported by Felix Ostmann.
692 Python2:
694 * The python testsuite already tested if any constants weren't marked with
695   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
696   clearly point to the actual problem.  Now we report the names of any
697   such constants.
699 * In the testsuite, use the xapian.WritableDatabase constructor rather than
700   chert_open() - that code dates back to when chert was the only disk-based
701   backend to support valuestreams, but flint was the default backend.
703 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
704   Germán M. Bravo in github PR59.
706 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
708 Python3:
710 * Python 3 support has been split off into its own subdirectory, and should now
711   be usable.  3.2 is the minimum supported version currently.  Existing code
712   will need updating for Python 3, and the wrapped API is necessarily different
713   in how Unicode is handled, so we've dropped deprecated features (such as
714   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
716 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
717   Germán M. Bravo in github PR59.
719 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
721 Ruby:
723 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
724   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
725   picking ruby 1.6.
727 Xapian-bindings 1.3.1 (2013-05-03):
729 This release includes all changes from 1.2.10-1.2.15 which are relevant.
731 Documentation:
733 * HACKING: Document Debian packages needed for each language.
735 General:
737 * Wrap new C++ API features.
739 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
740   unnecessary exception handling code where we call such functions and
741   methods.
743 * Tweak wrapping of Query from list constructor so the needed number of
744   elements get preallocated.
746 * Ignore Query(Query::Internal&) constructor, which is for internal use
747   only.
749 * For all languages except C# and Java, wrap the functions declared in
750   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
751   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
752   languages.
754 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
755   dependencies, and adjusts the generated dependencies to work in our build
756   system.
758 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
759   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
760   V=1' and 'make V=0' which are broadly equivalent and more standard.
762 * Fix the tests to work with the new automake parallel test driver.
764 Portability:
766 * Improve workaround which allows building against an uninstalled xapian-core
767   on OS X - this should now work with any uninstalled xapian-core (not only in
768   a tree with the same layout as an SVN or git checkout) and it also won't try
769   to build against "../xapian-core/.libs" just because it happens to exist.
770   (Fixes #322)
772 CSharp:
774 * configure: The variable to specify the interpreter is now CLI (was MONO, but
775   didn't actually work properly).
777 Java:
779 * Document that we aim to support JDK 1.6 (Java 6) and later.
781 * Avoid generating a temporary C++ vector of Query objects when constructing
782   a Query from a Java array of Query objects or a Java array of strings.
784 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
785   ValueIterator, and TermIterator.
787 * Add Enquire.getMatchingTerms().
789 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
790   building, e.g. "make JAVACFLAGS=-g".
792 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
793   with (the rather elderly) ECJ 3.3.1.
795 Perl:
797 * Fix PostingIterator wrapper to work.
799 * Update list of unwrapped things in POD documentation.
801 * Improve test coverage.
803 * perl/t/10query.t: Adjust regexp which checks expected error message to work
804   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
806 * Probe for the test running tool 'prove' in configure.
808 PHP:
810 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
811   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
812   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
813   compiled PHP module by 6%.
815 * php/smoketest.php: Add more tests of geospatial API.
817 Python:
819 * Drop support for Python 2.4.
821 * python/smoketest2.py: Add more testcases.
823 * python/smoketest2.py: Improve reporting of test failures for certain
824   testcases.
826 * Update Python 3 tests from Python 2 versions using 2to3.
828 Xapian-bindings 1.3.0 (2012-03-14):
830 Documentation:
832 * In maintainer builds, run doxygen to generate XML for the bindings in the
833   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
835 General:
837 * Wrap new geospatial API.
839 * Wrap new database checking API.
841 * Deprecated features scheduled for removal in 1.3.0 have been removed.
843 * Wrap ExpandDecider even if we don't have director support - there's a
844   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
845   needs some typemap work to actually get it usefully wrapped.
847 * configure:
849   + Add --disable-visibility option to match xapian-core.
851   + Add -fshow-column for GCC.
853   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
854     variable, so that it's easy to override it if you're getting a new warning
855     from SWIG but want to just ignore it for the time being.
857 * Exception handling now uses Error::get_description() rather than get_type +
858   ": " + get_msg().  In many cases this is the same, but if context or errno
859   are available, get_description() includes them.  Catch and report
860   std::exception rather than handling it as an unknown error (so in particular
861   std::bad_alloc will now be reported more helpfully).
863 CSharp:
865 * Avoid generating unwanted wrapper sources
866   SWIGTYPE_p_std__vectorT_std__string_t.cs and
867   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
869 Java:
871 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
872   bindings promoted in their place.  This means almost the entire C++ API is
873   now wrapped for Java, but the downside is there are some changes required
874   to existing code.  Overall we feel the short-term pain is worth the long
875   term benefits of having Java bindings which stay up to date.
877 * java/SmokeTest.java: Add test that string passing is zero byte safe.
879 Lua:
881 * Improve error messages.
883 Perl:
885 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
886   Perl 5.14.
888 * Fix Search::Xapian::Query->new() to work.
890 * Enable warnings for all test cases and make them fatal.
892 * Add "use Carp;" where we use functions from that module.
894 * Improve POD docs for Document and TermGenerator methods - "weight" is
895   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
897 * The Query constructor which takes an array of subqueries is now wrapped more
898   efficiently - previous a temporary C++ std::vector was built but now we avoid
899   doing this.
901 PHP:
903 * PHP >= 5.3 is now required.
905 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
907 * The XapianQuery constructor which takes an array of subqueries is now
908   wrapped more efficiently - previous a temporary C++ std::vector was built
909   but now we avoid doing this.
911 Python:
913 * Python >= 2.4 is now required.
915 * Remove deprecated Stem_get_available_languages().
917 * Hide away the deprecated non-pythonic iterators - we still need them to
918   implement the pythonic iterators, so we can't entirely remove them.
920 * Replace SWIG's thread locking with code which does nothing unless threads
921   are already initialised, to avoid the overhead of thread locking in the
922   common case of single-threaded Python code.  This seems to be about 5-10%
923   faster for pythontest2.py modified to repeat the tests 100 times.
925 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
926   #364.
928 * The Query constructor which takes an array of subqueries is now wrapped more
929   efficiently - previous a temporary C++ std::vector was built but now we avoid
930   doing this.
932 Ruby:
934 * The XapianQuery constructor which takes an array of subqueries is now
935   wrapped more efficiently - previous a temporary C++ std::vector was built
936   but now we avoid doing this.
938 Tcl:
940 * The XapianQuery constructor which takes an array of subqueries is now
941   wrapped more efficiently - previous a temporary C++ std::vector was built
942   but now we avoid doing this.
944 Xapian-bindings 1.2.23 (2016-03-28):
946 Documentation:
948 * Update links to Xapian website and trac to use https, which is now supported,
949   thanks to James Aylett.
951 PHP:
953 * Check that the PHP interpreter we find is actually PHP5, and if not look
954   harder.  On current Debian unstable, php-config5 --php-binary reports
955   /usr/bin/php which can be PHP7.
957 * Document that PHP7 isn't currently supported, and explicitly check for and
958   reject it in configure.
960 Ruby:
962 * configure: Stop preferring rdoc-1.8 to rdoc (this only happened in a
963   fall-back case when rdoc wasn't found in the same directory as the ruby
964   interpreter).
966 Xapian-bindings 1.2.22 (2015-12-29):
968 Documentation:
970 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
971   'git cherry-pick' from working as it should.  The git repo history should be
972   sufficient for complying with GPLv2 2(a).
974 General:
976 * Stop wrapping internal methods of Xapian::Weight.
978 * Return Error::get_description() rather than get_type + ": " + get_msg().  In
979   many cases this is the same, but if context or errno are available,
980   get_description() includes them.
982 * Catch and report std::exception rather than handling it as an unknown error
983   (so in particular std::bad_alloc will now be reported more helpfully).
985 CSharp:
987 * Fix configure test for whether $MONO can run CSharp programs - previously it
988   would always fail, which would mean that the CSharp tests would only be run
989   on systems where CSharp programs can be run directly.
991 Lua:
993 * Send stderr from lua version check to config.log instead of letting it appear
994   on the terminal.
996 PHP:
998 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
1000 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
1001   constructors now work.
1003 Python:
1005 * Add new testcase to catch any internal functions, methods, constants, etc
1006   which have accidentally been wrapped.
1008 Xapian-bindings 1.2.21 (2015-05-20):
1010 Lua:
1012 * README: Remove note about the Lua bindings being experimental - it's not
1013   really been true for some time now.
1015 Perl:
1017 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
1019 * Add workaround for Perl defining a seed() macro which breaks compilation with
1020   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
1021   classes with a method called seed).
1023 * Update list of unwrapped things in POD documentation.
1025 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1026   during parallel builds.
1028 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
1030 * Add test that we can create all the stemmers returned by
1031   Stem::get_available_languages().
1033 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
1034   likely due to external reasons, like incompatible compiler flags being taken
1035   from Perl's Config module, due to Perl having been built with a different
1036   compiler to Xapian.
1038 * Use croak_sv() or ERRSV if defined.
1040 PHP:
1042 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
1043   was fixed in 1.2.19.
1045 Python:
1047 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
1048   stable release 1.4.0.
1050 Ruby:
1052 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
1054 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
1055   https://bugs.debian.org/782270
1057 Xapian-bindings 1.2.20 (2015-03-04):
1059 Portability:
1061 * configure: Avoid using \? in sed command in Lua detection - it isn't
1062   supported by all sed implementations.
1064 Lua:
1066 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
1067   being specified without a leading '.'.
1069 * configure: Add an example of specifying LUA_SO to --help output.
1071 PHP:
1073 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
1074   1.2.19.
1076 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1077   available it will now only look in the configured extension directory.  The
1078   upshot is that there no longer seems to be a sane way to install the PHP
1079   bindings without being root, so update the documentation to reflect this.
1080   Fixes #661, reported by Felix Ostmann.
1082 Xapian-bindings 1.2.19 (2014-10-21):
1084 PHP:
1086 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
1087   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
1088   Gottfried)
1090 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
1091   which were getting incorrectly wrapped such that they didn't actually do
1092   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
1093   reference tracking fix in 1.2.14.
1095 Ruby:
1097 * README: Note that Ruby 2.1 works too.
1099 Xapian-bindings 1.2.18 (2014-06-22):
1101 Documentation:
1103 * README: Add links to Erlang and Node.js bindings.
1105 Lua:
1107 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
1108   expected), which most of the calls already used, and fix up the few calls
1109   which passed (expected, got).
1111 PHP:
1113 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
1114   that MatchDecider returns an MSet with the expected docid in.  Luckily this
1115   wasn't masking a test failure.
1117 Python:
1119 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
1120   - chert is the default backend now, and both chert and brass support the
1121   required functionality for the tests which do this, so this just needlessly
1122   causes the tests to fail if chert is disabled in xapian-core.
1124 * configure: If the Python version is too new or too old, only report it once
1125   not twice.
1127 Ruby:
1129 * configure: Fix Ruby bindings to build on Windows (and other platforms where
1130   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
1132 Xapian-bindings 1.2.17 (2014-01-29):
1134 Portability:
1136 * Improve workaround which allows building against an uninstalled xapian-core
1137   on OS X - this should now work with any uninstalled xapian-core (not only in
1138   a tree with the same layout as an SVN or git checkout) and it also won't try
1139   to build against "../xapian-core/.libs" just because it happens to exist.
1140   (Backported from 1.3.1; fixes #322)
1142 Python:
1144 * configure: Some distros now point /usr/bin/python at Python 3, so the check
1145   for a Python 2 interpreter now checks for 'python2' first, and checks that
1146   the version of found interpreter is 2.x.
1148 Ruby:
1150 * Tweak configure to work with Ruby 2.0.
1152 Tcl:
1154 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
1155   in http://bugs.debian.org/724830).
1157 * Use a better check for TCL_INC for Tcl 8.5 and later.
1159 Xapian-bindings 1.2.16 (2013-12-04):
1161 Documentation:
1163 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
1165 General:
1167 * Compress source tarballs with xz instead of gzip.
1169 * configure: Handle git snapshot naming.
1171 Portability:
1173 * configure: Update list of platforms where we tell libtool not to link in
1174   deplibs to match the list used for xapian-core.
1176 Perl:
1178 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
1179   GCC 4.7 warning).
1181 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
1182   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
1184 PHP:
1186 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
1187   with a message explaining this.
1189 Python:
1191 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
1193 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
1195 * pythontest.py: Fix testcase checking we get an exception from using
1196   non-random-access iterators after then have advanced - previously these
1197   didn't actually test as fully as intended.
1199 Ruby:
1201 * Omit internal classes and methods from the rdocs.
1203 Xapian-bindings 1.2.15 (2013-04-16):
1205 General:
1207 * Fix configure --enable-quiet option to actually work for the bindings.
1209 Perl:
1211 * Fix doc typo: "as as" -> "as a"
1213 Ruby:
1215 * Fix deprecation warning in configure from Ruby 1.9.3.
1217 Xapian-bindings 1.2.14 (2013-03-14):
1219 Python:
1221 * Fix typo in doccomment.
1223 PHP:
1225 * Keep references to the PHP wrapper object when an object is set on another
1226   object.  (fixes #614)
1228 Tcl:
1230 * Allow TCL_INC to be passed to configure.  (fixes #612)
1232 Xapian-bindings 1.2.13 (2012-11-09):
1234 CSharp:
1236 * configure: Overhaul checks for C# tools to use modern names in preference.
1238 Lua:
1240 * Fix examples to use str(query) to get the query description.  (Fixes #600)
1242 * Document that get_description() is mapped to str(), and end() to _end().
1244 * Fix functor wrappers which return strings to be zero-byte clean.
1246 Perl:
1248 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
1249   1.2's XS Search::Xapian.  (ticket#607)
1251 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
1252   is deprecated.
1254 PHP:
1256 * Document that subclassing Xapian classes in PHP currently doesn't work with
1257   PHP 5.4.
1259 Xapian-bindings 1.2.12 (2012-06-27):
1261 No changes since 1.2.11 except to bump the version - this release was made to
1262 fix an incorrect library version information update in xapian-core 1.2.11.
1264 Xapian-bindings 1.2.11 (2012-06-26):
1266 General:
1268 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
1270 Perl:
1272 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
1273   av_fetch() (spotted due to GCC 4.7 warning).
1275 PHP:
1277 * Fix "make check" to work for PHP when building from a release tarball with
1278   srcdir != builddir.
1280 * Work around "undefined symbol: zend_error_noreturn" error.
1282 Xapian-bindings 1.2.10 (2012-05-09):
1284 CSharp:
1286 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
1287   us to do this instead of setting them in AssemblyInfo.cs.
1289 * Use diff's -c option when comparing the files SWIG generated against those we
1290   were expecting to get as the output should be easier to understand.
1292 * Sort both the lists of expected and of found SWIG-generated sources with
1293   Perl, to avoid problems with locale-specific sort orders.
1295 Java-SWIG:
1297 * Remove now superfluous old check that SWIG generated at least the sources we
1298   want - we now check it generated *exactly* the sources we want.
1300 * Use diff's -c option when comparing the files SWIG generated against those we
1301   were expecting to get as the output should be easier to understand.
1303 * Sort both the lists of expected and of found SWIG-generated sources with
1304   Perl, to avoid problems with locale-specific sort orders.
1306 Lua:
1308 * Now works with Lua 5.2.
1310 * "require 'xapian'" now returns the module table.  (ticket #593)
1312 * lua/smoketest.lua: Improve reporting of test failures.
1314 Perl:
1316 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
1318 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
1319   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
1321 Python:
1323 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
1324   iteration features which have been removed on trunk.  This also fixes a
1325   segfault if there are no matches and no documents are explicitly marked as
1326   relevant.
1328 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
1329   way to rerun tests with verbose output.
1331 Ruby:
1333 * configure: Make sure the ruby subdirectory exists before trying to create
1334   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
1336 Xapian-bindings 1.2.9 (2012-03-08):
1338 Java:
1340 * configure: Fix test for jni.h to try looking for jni.h relative to the real
1341   location of javac, which should work for more JDKs.
1343 Lua:
1345 * Handle an exception from C++ by raising a xapian.Error object as an error in
1346   Lua.
1348 * Rename get_description() methods to __tostring(), so that you can use write
1349   tostring(obj) in Lua.
1351 * configure: Honour LUA_LIB if already set.  Fixes #581.
1353 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
1354   support platforms where the compiled Lua module isn't called .so.
1356 Perl:
1358 * Add tests of Document::get_docid().
1360 PHP:
1362 * Add a test that Query constructor taking OP_NEAR with a window size works.
1364 Python:
1366 * python/testsuite2.py: Don't run off the traceback looking for a test function
1367   if the exception wasn't from a test function.
1369 Xapian-bindings 1.2.8 (2011-12-13):
1371 Lua:
1373 * Wrap user-subclassable functor objects by allowing the user to pass a
1374   Lua function where the functor object would be passed in the C++ API.
1376 PHP:
1378 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
1380 * The PHP bindings will now work again with a version of PHP built with ZTS
1381   enabled (which is the default on Microsoft Windows).  This was broken by
1382   the changes to support subclassing in PHP in the version of SWIG used since
1383   1.2.6.
1385 Python:
1387 * Add a module docstring.  (Fixes bug #573)
1389 * The python testsuite now checks for object leaks during each testcase.
1391 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
1392   only check for leaks the second time to avoid falsely reporting a leak when
1393   some cached value gets initialised under Python 2.5.
1395 Ruby:
1397 * Wrap optional prefix parameter to Database::allterms.
1399 Xapian-bindings 1.2.7 (2011-08-10):
1401 Documentation:
1403 * INSTALL: Pull in a few updates from the latest version of the automake
1404   document which this file was originally based on.  Add in the missing
1405   copyright and licensing information.
1407 * INSTALL: Add --with-lua to list of options.
1409 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
1410   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
1411   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
1412   supported platforms in the README.
1414 * HACKING: Update and start section on deprecation warnings for the bindings.
1416 General:
1418 * Add missing wrappers for Database::has_positions() and
1419   TermIterator::positionlist_count(), and correct the return type of
1420   Database::get_doclength() from double to Xapian::termcount.
1422 CSharp:
1424 * README: Note a recent version of Mono which we've tested the C# bindings
1425   with.
1427 * Check that exactly the sources we expect are generated, and add some sources
1428   which were missing from the list.
1430 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
1431   gets removed.
1433 * Fix iterator ++ and -- so that the reference to the object isn't released
1434   prematurely, which was causing an occasional crash if the garbage collection
1435   happened at just the wrong moment,
1437 * Add test coverage for QueryParser.ParseQuery() with flags argument.
1439 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1441 Java:
1443 * SmokeTest.java: Fix == comparisons with strings to use equals().
1445 * Add test that string passing is zero byte safe.
1447 * Fix MyExpandDecider.accept() to really check the passed parameter.
1449 Java-SWIG:
1451 * Put the SWIG-generated Java bindings in package org.xapian.
1453 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1455 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
1457 * Add test that string passing is zero byte safe.
1459 * Fix MyExpandDecider.accept() to really check the passed parameter.
1461 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
1463 * Create an HTML documentation page based on java/README.
1465 * Copy java examples from the hand-coded JNI ones.
1467 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
1469 * Check that exactly the sources we expect are generated, and add some sources
1470   which were missing from the list.
1472 Lua:
1474 * Merge latest Lua changes from Xiaona Han.
1476 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
1478 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
1479   matches.
1481 Perl:
1483 * Sync updates to examples from XS Search::Xapian:
1485   + Require Perl >= 5.6 so we can "use warnings;".
1487   + Loop over file using while() (which reads a line per iteration) not
1488     foreach() (which reads the whole file up front).
1490 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
1491   and Search::Xapian::Query::MatchNothing).  (ticket#158)
1493 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
1495 * perl/Makefile.am: Fix "make check".
1497 * perl/t/symbol-test.t: Fix to work when built against an installed
1498   xapian-core.  (ticket#558)
1500 PHP:
1502 * php/smoketest.php: Install an error handler so the test fails if there are
1503   any errors, warnings, notices, etc.
1505 * Change PHP examples and test program to use 'include "xapian.php"' like user
1506   code should (rather than 'include "php5/xapian.php"' as they did previously).
1508 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
1509   XapianQuery::MatchNothing(). (ticket#158)
1511 Ruby:
1513 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
1515 Xapian-bindings 1.2.6 (2011-06-12):
1517 General:
1519 * SWIG-based bindings are now generated with a newer version of SWIG
1520   (ticket#538).
1522 Portability:
1524 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
1525   .jnilib extension as we do for older versions.
1527 CSharp:
1529 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
1531 Java:
1533 * Fix memory leaks when functions taking string parameters throw exceptions.
1535 * Previously a hash table was used to map Java objects to C++ ones, but we
1536   now just cast the address of the C++ object to a jlong (which is 64 bits
1537   so will hold a pointer on current platforms).  This is more efficient and
1538   avoids the need for thread locks around accesses to the hash table.
1540 * Remove explicit checks for NULL around calls to delete.
1542 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
1543   during parallel builds.
1545 Lua:
1547 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
1548   year.  The current support should be regarded as experimental - it passes
1549   its automated tests, but the details of the Lua API are likely to evolve as
1550   the project progresses.
1552 Perl:
1554 * README: say that Perl bindings probably need Perl 5.8 or later.
1556 PHP:
1558 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
1560 Python:
1562 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
1563   all the garbage, so repeat until no further objects are freed.
1564   (http://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
1566 Ruby:
1568 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
1569   the compaction tests for these versions.
1571 Xapian-bindings 1.2.5 (2011-04-04):
1573 Documentation:
1575 * README: Update info on SWIG-based Perl bindings.
1577 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
1578   section with better equivalent from xapian-core/INSTALL.
1580 General:
1582 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
1584 * configure: If xapian-core is a different release series, promote the
1585   mismatched versions warning to an error.
1587 Portability:
1589 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
1590   10.4 on x86, as the default if unset on these versions is the current OS
1591   version.  (ticket#541)
1593 * python/pythontest2.py: In test_compactor(), close any open databases before
1594   removing the directory as you can't delete an open database on Microsoft
1595   Windows.  (ticket#526)
1597 CSharp:
1599 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
1601 * Clarify the licence is GPL "version 2 or later" in the meta information
1602   we put in the module.
1604 Python:
1606 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
1607   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
1608   accidentally left an older version of get_matching_terms() exposed.
1610 * Remove broken implementation of MSet.__contains__.  This appears never to
1611   have worked, and to have been broken for at least the past 3.5 years without
1612   anyone mentioning it, and is probably of little use anyway, so no need to
1613   deprecate.
1615 * python/docs/index.html: Document that MSet.items and ESet.items are
1616   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
1617   the tuple returned by MSet.items.  (ticket#531)
1619 * Add test coverage for mset.items.
1621 Ruby:
1623 * Add test coverage for Xapian::Compactor.
1625 * Handle an empty response to $RUBY --version specially.  This gives a less
1626   opaque error in cases where the user specified RUBY but the value given
1627   wasn't an executable file.
1629 Xapian-bindings 1.2.4 (2010-12-19):
1631 General:
1633 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
1634   virtual method is wrapped for subclassing for Python and Ruby currently.
1636 * Eliminate separate Makefile.am in the docs subdirectory of each language
1637   subdirectory and just inline any rules into the main sub-Makefile.am, which
1638   allows more of the build to run in parallel.
1640 * Don't ship some files which are generated at build time.
1642 * configure: Need python in maintainer mode to run doxy2swig.py.
1644 Packaging:
1646 * RPM: Package the Perl bindings.
1648 * RPM: Don't package _XapianSharp.la.
1650 Portability:
1652 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
1653   uninstalled Xapian library.  See ticket #322.
1655 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1657 CSharp:
1659 * Don't install _XapianSharp.la.
1661 Perl:
1663 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
1664   GSoC 2009.  These are close to being a compatible replacement for the
1665   hand-coded XS bindings in Search::Xapian but also offer a more complete
1666   wrapping of the C++ API.  We're planning to replace the XS bindings with the
1667   SWIG ones for easier maintenance.  We encourage you to try them and let us
1668   know how you get on - particularly if you find cases where code which works
1669   with the XS bindings doesn't work with the SWIG ones.
1671 PHP:
1673 * Document that iterators shouldn't be dereferenced or advanced when at their
1674   end points (ticket#520).
1676 Python:
1678 * Fix memory leaks in typemaps which return Python lists.
1680 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
1681   supported.
1683 * configure: Use sys.version_info tuple, rather than string splicing which
1684   assumes the Python "major.minor" is 3 characters (which would fail if Python
1685   2.10 were ever released, for example).
1687 Xapian-bindings 1.2.3 (2010-08-24):
1689 Packaging:
1691 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
1693 Xapian-bindings 1.2.2 (2010-06-27):
1695 * No user-visible change except for bumping the version to indicate
1696   compatibility with Xapian-core 1.2.2.
1698 Xapian-bindings 1.2.1 (2010-06-22):
1700 This release includes all changes from 1.0.21 which are relevant.
1702 General:
1704 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
1705   Python.  (ticket#448)
1707 Guile:
1709 * Remove non-functional disabled guile bindings left over from Open Muscat
1710   days - if someone wanted to add guile bindings, it would be easier to start
1711   from scratch.
1713 Java-SWIG:
1715 * Update list of generated java sources in the SWIG-based Java bindings.
1717 PHP:
1719 * zend_throw_exception() returns, so return control to PHP directly after
1720   calling it to avoid needless extra work and possible issues.
1722 Python:
1724 * Fix "from xapian import *".  (ticket#477)
1726 * Fix testcase weight_normalise - a change in xapian-core means that
1727   get_max_possible() can now return zero for a non-existent term, so don't
1728   blindly calculate the reciprocal of it.
1730 * python/replicationtest2.py: Extend to check that changesets get applied
1731   correctly.
1733 * python/smoketest2.py: Check len(mset) works (improving test coverage of
1734   Python-specific wrapping).
1736 Xapian-bindings 1.2.0 (2010-04-28):
1738 This release includes all changes from 1.0.20 which are relevant.
1740 Portability:
1742 * configure: Tell libtool not to link in deplibs on platforms where we know
1743   they aren't needed.
1745 * configure: On Linux, extract the library search path from ldconfig which
1746   gives us the default entries reliably.
1748 Xapian-bindings 1.1.5 (2010-04-15):
1750 This release includes all changes from 1.0.19 which are relevant.
1752 Tcl:
1754 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
1755   sidestep the whole destructor issue.  (ticket#62)
1757 Xapian-bindings 1.1.4 (2010-02-15):
1759 This release includes all changes from 1.0.18 which are relevant.
1761 General:
1763 * Update for the new Brass backend and other C++ API changes.
1765 * Wrap Database::get_doclength_lower_bound(),
1766   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
1767   Database::valuestream_begin() and Database::valuestream_end() for all
1768   languages. (ticket#431)
1770 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
1772 Python:
1774 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
1775   object which dereferences to a ValueStreamItem object,
1777 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
1779 Ruby:
1781 * Add safe wrapper for the valuestream iterator.
1783 Xapian-bindings 1.1.3 (2009-11-18):
1785 This release includes all changes from 1.0.15-1.0.17 which are relevant.
1787 General:
1789 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
1790   specified.
1792 * Wrap the new MatchSpy class, and associated features.
1794 * Don't wrap PostingSource::serialise(), Weight::serialise() and
1795   Weight::unserialise() as they aren't useful from the bindings.
1797 * Update for the Sorter to KeyMaker changes.
1799 PHP:
1801 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
1802   as it standardly is on Microsoft Windows.  Fixes #411.
1804 * Merged the PHP "smoketest" back together now we don't need to support
1805   PHP4 now.
1807 Python:
1809 * Fix a memory leak on error (in theory - we've not got a way to generate this
1810   error, so haven't been able to reproduce the leak or test the fix).
1812 Xapian-bindings 1.1.2 (2009-07-23):
1814 This release includes all changes from 1.0.14 which are relevant to trunk.
1816 Python:
1818 * Several changes towards fully supporting Python 3, but more work is required.
1819   (ticket#246)
1821 Xapian-bindings 1.1.1 (2009-06-09):
1823 This release includes all changes from 1.0.13 which are relevant to trunk.
1825 General:
1827 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
1829 CSharp:
1831 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1832   C# yet, and to use Query("") and Query() instead.
1834 * configure: If we don't find a C# compiler, don't test an empty command name
1835   further which saves a fork and avoids an odd looking message.
1837 PHP:
1839 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1840   PHP yet, and to use Query("") and Query() instead.
1842 Python:
1844 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
1845   are wrapped (ticket#158).
1847 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
1848   expect SYNONYM in generated query.
1850 Ruby:
1852 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1853   Ruby yet, and to use Query("") and Query() instead.
1855 Tcl:
1857 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
1858   are wrapped (ticket#158).
1860 Xapian-bindings 1.1.0 (2009-04-22):
1862 Documentation:
1864 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
1865   the instructions to suggest users use this standard location for installing
1866   without root access.
1868 General:
1870 * All deprecated features slated for removal in 1.1.0 have been removed.
1872 * All new C++ API features have been wrapped.  Also, since we now supply some
1873   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
1874   these can be passed in even for languages for which SWIG doesn't support
1875   subclassing.
1877 Packaging:
1879 * xapian-bindings.spec: Updated to reflect the new Python packaging.
1881 Portability:
1883 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
1884   to put the compiler into ISO C++ mode).
1886 PHP:
1888 * PHP4 support has been removed, since PHP4 is no longer supported upstream
1889   as of 2008-08-08.
1891 Python:
1893 * Python 2.3 or later is now required.  2.2 is essentially unsupported
1894   upstream.
1896 * The import method used has been changed (by using a newer SWIG version)
1897   and no longer gives a warning with Python 2.6.
1899 * Initial support for Python 3.0 has been added.  This currently doesn't
1900   work correctly and should be treated as experimental. (ticket#346)
1902 * The newer SWIG version handles exceptions in director methods correctly
1903   so we no longer need our workaround for ticket #289.
1905 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
1906   wrapped for Python as Database.metadata_keys().
1908 * The Python bindings are now installed as a python package, with the
1909   files in a xapian subdirectory, hiding the internal _xapian module
1910   better.
1912 * Python now flags deprecation warnings for the single argument form and old
1913   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
1914   friends.
1916 Xapian-bindings 1.0.23 (2011-01-14):
1918 Portability:
1920 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1922 PHP:
1924 * Document that iterators shouldn't be dereferenced or advanced when at their
1925   end points (ticket#520).
1927 Python:
1929 * Fix memory leaks in typemaps which return Python lists.
1931 Xapian-bindings 1.0.22 (2010-10-03):
1933 Packaging:
1935 * RPM: Don't package _XapianSharp.la.
1937 CSharp:
1939 * Don't install _XapianSharp.la.
1941 Python:
1943 * configure: Use sys.version_info tuple, rather than string splicing which
1944   assumes the Python "major.minor" is 3 characters (which would fail if Python
1945   2.10 were ever released, for example).
1947 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
1948   testcase in pythontest.py.
1950 Xapian-bindings 1.0.21 (2010-06-18):
1952 Python:
1954 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
1955   can't be written to. (ticket#297)
1957 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
1959 * Add test to check that "from xapian import *" works.
1961 Xapian-bindings 1.0.20 (2010-04-27):
1963 Python:
1965 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
1966   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
1967   trap to delete them after running tests for older versions of Python.
1968   (ticket#315)
1970 Ruby:
1972 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
1974 Xapian-bindings 1.0.19 (2010-04-15):
1976 Tcl:
1978 * tcl8/docs/index.html: Improve wording in a few places.
1980 Xapian-bindings 1.0.18 (2010-02-14):
1982 General:
1984 * Wrap new C++ API method Document::add_boolean_term().
1986 Ruby:
1988 * Generate entries in the Ruby rdocs for all classes which aren't documented
1989   because of Ruby-specific methods.  Fixes ticket#417.
1991 * Avoid absolute paths in the generated rdocs.
1993 Xapian-bindings 1.0.17 (2009-11-18):
1995 Packaging:
1997 * Improve RPM package summaries - the files are needed to *use* scripts as well
1998   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
1999   conventional.
2001 Portability:
2003 * python/Makefile.am: Restore the "./" path to the sourced file
2004   libtoolconfig.tmp as ksh requires it.
2006 Java:
2008 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
2010 Xapian-bindings 1.0.16 (2009-09-10):
2012 Python:
2014 * Improved docstrings for QueryParser::set_default_op() and
2015   QueryParser::get_default_op() (automatically generated from changes in
2016   xapian-core).
2018 Xapian-bindings 1.0.15 (2009-08-26):
2020 Python:
2022 * Don't break long words when wrapping text in the generated API documentation
2023   comments as this was causing identifiers to be broken in two.
2025 Xapian-bindings 1.0.14 (2009-07-21):
2027 General:
2029 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
2030   and the only side-effect was an odd looking message.
2032 Python:
2034 * Rename methods at build-time using SWIG rather than a run-time in Python, as
2035   the latter approach adds a small time overhead when the module is being
2036   loaded.
2038 Ruby:
2040 * Fix to accept an integer value > MAXINT for a double parameter.
2042 Xapian-bindings 1.0.13 (2009-05-23):
2044 Packaging:
2046 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
2047   _XapianSharp.so in 1.0.11.
2049 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
2050   bindings since 1.0.6.
2052 PHP:
2054 * Backport fix from SWIG SVN for misuse of formatted error function in
2055   SWIG-generated code.
2057 Python:
2059 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
2060   Python's Global Interpreter Lock (GIL) in situations where we know that it
2061   will already be locked.  This avoids some dead-locks with mod_python (due to
2062   mod_python bugs which are apparently unlikely to ever be fixed), and results
2063   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
2064   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
2065   faster). (ticket#185)
2067 * README,python/docs/index.html: Update documentation of the above mod_python
2068   issue and also document the related mod_wsgi issue.  The status is now that
2069   everything seems to work if you stick to the main interpreter (ticket#364).
2071 * Backport fix from SWIG SVN for misuse of formatted error function in
2072   SWIG-generated code.
2074 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
2075   second parameter, not the third.
2077 * python/docs/examples/simplematchdecider.py,
2078   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
2079   clearer code.
2081 Ruby:
2083 * README: Note that the testsuite fails due to a bug in the test/unit module in
2084   Ruby 1.9.0, but applications using the bindings should work, and that the
2085   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
2086   appears to be completely dead both upstream and in the wild.
2088 Xapian-bindings 1.0.12 (2009-04-19):
2090 Documentation:
2092 * INSTALL: Add a note about being able to pass variables to configure to pick
2093   which of several parallel installations of a language to build for.
2095 Python:
2097 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
2098   test to avoid failing due to rounding differences.
2100 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
2101   stop the whole testsuite, not just the currently running testcase.
2103 Xapian-bindings 1.0.11 (2009-03-15):
2105 Documentation:
2107 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
2108   Python 3, and possible current issues with Ruby 1.9.
2110 Portability:
2112 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
2113   Cygwin.
2115 Python:
2117 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
2118   latter is deprecated, and support was removed in 1.0.0).
2120 * Add support for using the new name ("reverse") for the second argument of
2121   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
2122   The old name ("ascending") is still supported, but will be deprecated in
2123   1.1.0.
2125 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
2126   which get set on other objects to avoid segmentation faults if they go out
2127   of scope before the object they are set on does.  (ticket#341)
2129 Ruby:
2131 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
2132   fails so "make check" doesn't pass, but code using the bindings should work.
2134 Xapian-bindings 1.0.10 (2008-12-23):
2136 Python:
2138 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
2139   as things stand (upstream fix for Debian bug 506090).
2141 Xapian-bindings 1.0.9 (2008-10-31):
2143 General:
2145 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
2147 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
2148   methods.
2150 Xapian-bindings 1.0.8 (2008-09-04):
2152 General:
2154 * configure: Report bug report URL in --help output.
2156 Python:
2158 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
2159   (bug#289)
2161 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
2163 Xapian-bindings 1.0.7 (2008-07-14):
2165 Documentation:
2167 * Document how all the database factory functions and library version functions
2168   are wrapped for all languages.
2170 General:
2172 * Fix to build against a xapian-core which has quartz and/or flint disabled.
2174 * The "program" version of Remote::open() has been wrapped for some time, so
2175   update the documentation which said it wasn't.
2177 Packaging:
2179 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
2181 Portability:
2183 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
2184   different module extension rather than our own ugly bodge.
2186 Java:
2188 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
2189   simple to make C++ to Java work though.
2191 PHP:
2193 * Add test that OP_VALUE_GE works for PHP.
2195 Python:
2197 * Several corrections to the Python documentation.
2199 * configure: Fix problem with building under mingw.
2201 Ruby:
2203 * Include simplematchdecider.rb example.
2205 * smoketest.rb: Test the version reporting functions.
2207 Tcl:
2209 * Include simpleexpand.tcl example.
2211 * Fix where the Tcl module gets installed.
2213 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
2215 Xapian-bindings 1.0.6 (2008-03-17):
2217 General:
2219 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
2220   used with.
2222 * configure: Correct the required SWIG version given in an error message.
2224 PHP:
2226 * php/smoketest.php: Add note that this script should be run using 'make check'
2227   in the build tree (rather than trying to copy it to a webserver as someone
2228   recently tried to).
2230 * php/smoketest.php: Fix to work under PHP4.
2232 Python:
2234 * The Python module now always has the extension which Python expects, which
2235   fixes a failure on Mac OS X.
2237 Ruby:
2239 * Automatically install/uninstall the Ruby rdoc-generated documentation along
2240   with the ruby bindings.
2242 Tcl:
2244 * configure: Sort out the default value of TCL_LIB, which could end up being
2245   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
2247 Xapian-bindings 1.0.5 (2007-12-21):
2249 General:
2251 * Wrap Xapian::Sorter and subclasses.
2253 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
2254   and Enquire::set_sort_by_relevance_then_key().
2256 * Factor out the code to protect multitarget rules against parallel make, and
2257   fix it to handle the source being changed while the rule is executing, and to
2258   correctly return an error code if we fail while trying to recover from the
2259   removal of a target of a multi-target rule.
2261 * configure: Improve the clarity of the error given when none of the tools
2262   needed for any supported language are found.
2264 * configure: SWIG 1.3.32 has now been released, so require at least this
2265   released version for maintainer builds.
2267 Java:
2269 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
2270   GCC 4.3.
2272 * configure: Log the output of trying to compile conftest.java in config.log;
2273   if the test fails, report whether the failure was compiling or running the
2274   test program.
2276 * Check for directory existence rather than calling mkdir unconditionally as
2277   despite the "(ignored)", the error message seems to confuse some people.
2279 PHP:
2281 * Add feature test for XapianMultiValueSorter.
2283 * php/smoketest5.php: Fix use of Database_get_document to new style OO
2284   interface.  Fix the error reported when the PHP5 exception test fails.
2286 * php/smoketest.php: Add feature test to confirm that optional arguments to
2287   XapianQuery's "term" constructor are wrapped.
2289 Python:
2291 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
2292   these properties build a python list, so dropping the GIL isn't safe and
2293   may cause undefined behaviour in multithreaded environments.
2295 * configure: Update error message to reflect requirement for at least python
2296   2.2.
2298 * configure: Change "print foo" to "print(foo)" in python version checks, for
2299   compatibility with python 3.0.
2301 Ruby:
2303 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
2304   previously incorrect).
2306 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
2307   ruby/docs/index.html previously had a dead link to.
2309 Tcl:
2311 * configure: Overhaul code to find tcl.h since the old version no longer worked
2312   with Debian unstable.
2314 * tcl8/docs/index.html: Update documentation to cover flint and mention that
2315   quartz is now deprecated.
2317 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
2318   throws QueryParserError instead.
2320 Xapian-bindings 1.0.4 (2007-10-30):
2322 General:
2324 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
2325   Add feature tests for all languages.
2327 * The "bindings.html" file documenting each of the bindings has been renamed to
2328   "index.html".
2330 Packaging:
2332 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
2333   older distros.
2335 Portability:
2337 * Fix warnings when compiling with GCC 4.2.
2339 PHP:
2341 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
2342   and methods/functions which return a wrapped class.
2344 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
2345   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
2347 * Document how non-class functions are wrapped.
2349 * Fix wrapping of NumberValueRangeProcessor for PHP4.
2351 * smoketest.php: Split the regression test for bug#193 into separate
2352   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
2354 Python:
2356 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
2357   non-pythonic iterators.  Make it clearer that the "sequence API" is
2358   deprecated.
2360 * Add test of a custom ValueRangeProcessor (ie, one written in python).
2362 * Update the examples to use the new-style attributes to access MSet item
2363   values rather than the old-style MSET_* constants.
2365 * Document MSET_DOCUMENT.
2367 Ruby:
2369 * smoketest.rb: Rename test of metadata access methods which had been named the
2370   same as the matchdecider test due to a copy-and-paste error.
2372 Xapian-bindings 1.0.3 (2007-09-28):
2374 General:
2376 * Wrap new methods Database::get_metadata() and
2377   WritableDatabase::set_metadata().
2379 * "make uninstall" now removes the loadable module we install for each of
2380   the bindings.
2382 * "make distcheck" now works.
2384 * Distribution tarballs are now in the POSIX "ustar" format since it saves
2385   about 40KB and we need to use it for xapian-core anyway.
2387 Packaging:
2389 * RPMs: Package xapian.php.
2391 CSharp:
2393 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
2394   usefully used currently.
2396 Java:
2398 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
2399   C++ library.
2401 * "make clean" now removes the class files generated for inner classes.
2403 PHP:
2405 * Add feature test for DateValueRangeProcessor when used with QueryParser.
2407 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
2408   isn't actually very useful, since you can't subclass it in PHP currently.
2410 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
2411   if the third parameter was specified and a floating point number (e.g. 0.0).
2413 * php/docs/bindings.html: Fix errors in example code.
2415 Python:
2417 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
2418   Python which takes two strings and returns a 3-tuple (value_number,
2419   modified_begin, modified_end).  Previously this always failed with a
2420   type error, so this doesn't break existing code.
2422 * python/pythontest.py: Interpret any commandline arguments as a list of
2423   tests to be run (the default is to run all tests).
2425 * README,python/docs/bindings.html: Add a note about the problems with
2426   mod-python (as described in bug #185).
2428 * python/pythontest.py: Delete the database handles before deleting a database
2429   to fix problems running the Python tests on MS Windows (bug#179).
2431 * "make clean" now removes testsuite.pyc.
2433 Ruby:
2435 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
2436   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
2437   now the site-specific directories, which is more correct when building
2438   from source.  Debian packages, etc can override this by setting RUBY_LIB and
2439   RUBY_LIB_ARCH.
2441 Tcl:
2443 * Check for TCL_LIB in the environment or on the configure command-line to
2444   allow installing without root access more cleanly.
2446 Xapian-bindings 1.0.2 (2007-07-05):
2448 Documentation:
2450 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
2451   phpextdir.
2453 * Remove documentation of removed "--with-swig" configure option.
2455 General:
2457 * Add methods of NumberValueRangeProcessor for serialising and
2458   unserialising doubles.
2460 * Add methods and constants supporting spelling correction and synonyms.
2462 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
2463   to ensure that it works with uninstalled copies of Xapian.
2465 * Value of PYTHON_LIB supplied to configure is now respected - previously
2466   it was documented, but ignored.
2468 * Add support for supplying PHP_EXTENSION_DIR to configure.
2470 * Change to using "%include", rather than reproducing contents of header
2471   files, for "queryparser.h", "document.h" and "postingiterator.h".
2473 * Add new form of get_mset() which allows a matchspy matchdecider to be
2474   set.
2476 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
2477   explode.  Add in a missing "mv" in the command for installing tcl8
2478   documentation.
2480 CSharp:
2482 * Fix rule handling parallel make to include xapian_wrap.h
2484 PHP:
2486 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
2487   doesn't seem to be a standard location, but this works for Debian at
2488   least, and it seems better to at least try to install it.
2490 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
2491   prefix for PHP4.
2493 Python:
2495 * Fix a threading problem: the GIL was not being acquired in the exception
2496   handling code before setting the Python exception state, leading to
2497   various memory corruption symptoms in threaded programs.
2499 * Add special iterators to Database for synonyms, synonym_keys and
2500   spellings.
2502 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
2503   synonym iterators and spelling iterators.
2505 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
2506   the expected description to make the tests more readable.
2508 Xapian-bindings 1.0.1 (2007-06-11):
2510 Documentation:
2512 * NEWS: Fix the recent headings which said "Xapian-core" to say
2513   "Xapian-bindings".
2515 General:
2517 * Wrap Xapian::Query constructor for creating ValueRange queries.
2519 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
2520   which take a prefix.
2522 Packaging:
2524 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
2525   %{buildroot} prefix on most files which we then have to work around.
2527 CSharp:
2529 * SimpleIndex now uses Xapian.TermGenerator.
2531 * SimpleSearch now uses Xapian.QueryParser.
2533 * New SimpleExpand example.
2535 * Document explicitly how STEM_SOME constants are currently wrapped.
2537 * Update GetTermName() reference in documentation to GetTerm().
2539 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
2540   their CVS repo, and the fix should be in their 0.8.2 release.
2542 Java:
2544 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
2545   looked at, but in fact its value was read but ignored.  We now use it as the
2546   first place to look for jni.h.
2548 * configure will now automatically add an extra "-I" for the
2549   linux/solaris/win32 subdirectory which Sun's JDK requires.
2551 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
2552   "precious" so their values are preserved for when configure is automatically
2553   rerun.
2555 PHP:
2557 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
2559 * The PHP examples have been rewritten to be clearer and to make use of the
2560   new XapianTermGenerator class.
2562 Python:
2564 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
2566 * Add support for prefix-restricted pythonic allterms iterators.
2568 * Update documentation in a couple of places to refer to updated replacements
2569   for MSetIterator.
2571 * Change testsuite output to be more vim-friendly (vim should be able to jump
2572   to the right lines now).
2574 * __str__ on Xapian::Error now includes extra information in some cases (the
2575   error_string and context, if they are set).
2577 * python/smoketest.py: Eliminate uses of the legacy sequence API.
2579 * python/pythontest.py: The legacy sequence API is only supported for Python
2580   2.3 and later, so don't run tests for it when running under Python 2.2.
2582 * We now generate and install xapian.pyo as well as xapian.pyc.
2584 Ruby:
2586 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
2587   classes.
2589 * Add missing rename for the C++ TermGenerator::set_document() method so it can
2590   be used as "tg.document = doc" in Ruby.
2592 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
2594 Tcl:
2596 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
2597   feedback, based on C++ simpleexpand.cc.
2599 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
2600   TermGenerator class.
2602 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
2603   QueryParser class.
2605 * tcl8/docs/bindings.html: Document how constants are wrapped.
2607 * Update smoketest and examples to require version 1.0.0 - previously this
2608   required 0.9.6, which failed since TCL doesn't accept differing major
2609   version numbers.
2611 * pkgIndex.tcl is now generated by configure.
2613 Packaging:
2615 * The required automake version has been lowered to 1.8.3, so RPMs can now be
2616   built on RHEL 4 and SLES 9.
2618 Xapian-bindings 1.0.0 (2007-05-17):
2620 Documentation:
2622 * Document Unicode support for each language.
2624 * Assorted minor improvements and typo fixes.
2626 General:
2628 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
2629   it, for languages where SWIG supports directors.
2631 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
2632   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
2633   allows the "default_prefix" argument to be supplied, QueryParser flags
2634   FLAG_PURE_NOT and FLAG_PARTIAL.
2636 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2638 * Remove wrappers for deprecated features removed from the C++ API (see
2639   docs/deprecation.html in xapian-core for full details and upgrade
2640   information).
2642 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
2644 * QueryParserError is now a real error, so remove special handling for "const
2645   char *" exceptions.
2647 * Use a stamp file in "make" rules with multiple targets so that parallel
2648   make works.
2650 * configure: Now quotes $PYTHON, etc so that you can specify a program with
2651   arguments.
2653 * configure: If the user specifies a program which doesn't exist (e.g.
2654   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
2656 * configure: Disable probes for f77, gcj, and rc completely by preventing
2657   the probe code from even appearing in configure - this reduces the size of
2658   configure by 28% and should speed it up significantly.
2660 * configure: If the version check against the xapian-core version detects a
2661   mismatch, we now issue a warning rather than a hard error since if you're
2662   careful this can work.  The warning is issued late on in configure, so it's
2663   harder for the user to miss.
2665 * configure: The --with-swig option has been removed.  It no longer has a
2666   purpose as we now ship the files which are generated by SWIG.
2668 Portability:
2670 * The PHP bindings can now be built with MSVC for Microsoft Windows.
2672 CSharp:
2674 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
2675   than mcs to avoid segmentation faults at runtime due to unimplemented
2676   features in mcs.  Document this, and update configure to prefer gmcs.
2678 * The return type of MatchDecider::operator() is now `bool' rather than `int'
2679   (in line with the same change in the C++ API).
2681 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
2683 Java:
2685 * The Java bindings have been updated to use C++ replacements for deprecated
2686   methods, so they still build.  The Java wrappers still provide the old
2687   deprecated names for now though.  The longer term plan is to replace the
2688   hand-written JNI with SWIG generated wrappers (work has now begun on this)
2689   which is likely to require some API changes, and it seems more sensible to
2690   make any changes to align with C++ API changes at the same time.
2692 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
2693   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
2695 PHP:
2697 * Fix undefined behaviour in get_matching_terms().
2699 * Document the (existing) renaming of methods which are PHP reserved words
2700   (empty() to is_empty() and clone() to clone_object()).
2702 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2704 Python:
2706 * The Python bindings now throw exceptions as classes with a hierarchy which
2707   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
2708   base class inherits from the standard Python Exception class.
2710 * All Python methods which accept strings can now be passed either a unicode
2711   object or a simple string.  Strings are returned as simple strings: unicode
2712   input will be returned as utf-8 encoded output.  The documentation now
2713   contains a "Unicode" section.
2715 * The Python bindings should now be usable more efficiently from threaded
2716   Python applications since we now use SWIG's -threads option when generating
2717   them, so that the GIL is released during long-running Xapian operations
2718   (bug#137).
2720 * Most classes, methods, functions, etc now have docstrings which are either
2721   automatically extracted from the C++ documentation comments, or overridden by
2722   more appropriate versions.
2724 * Most of the Pythonic iterators now return an object instead of a sequence,
2725   which means they now lazily fetch the information which previously had to be
2726   fetched to put it in the sequence.  The old sequence API is supported for
2727   compatibility, but is scheduled for removal in Xapian 1.1.0.
2729 * Those Python iterators which have skip_to() methods now return the item
2730   skipped to, and next() will return the following item.  Previously, they
2731   returned None, and next() returned the item skipped to.  Several bugs in the
2732   skip_to() wrappers were fixed.
2734 * Because of the lazy access, some objects returned by iterators will raise
2735   an error if the lazy evaluation happens after the iterator has moved on
2736   (since the underlying Xapian API doesn't allow efficient access to the
2737   information in this situation).  The exact semantics are defined in the
2738   docstrings for each iterator.
2740 * Those Pythonic iterators which return only a list of terms now return
2741   simple strings, instead of a sequence or an object containing the term.  This
2742   is an incompatible change with earlier releases.  The affected iterators are
2743   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
2744   QueryParser.unstemlist.
2746 * The contents of an MSet can now be iterated in the standard Python way.
2747   The iteration will return MSetItem objects.  The __contains__ and __getitem__
2748   methods are also implemented, allowing the "in" and [] operators to work.
2749   MSet.__getitem__ is a synonym for MSet.get_hit.
2751 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
2752   so that lazy access to its attributes is supported.  MSetItem has some
2753   deprecated methods which mimic the MSetIterator interface to allow old code
2754   to work without modification until release 1.1.0.
2756 * MSetItem provides access to the collapse_key and collapse_count, which
2757   weren't accessible from the sequence returned by the iterators before this
2758   release.
2760 * Out-of-range access to MSets will now raise an IndexError - it used to
2761   cause undefined behaviour (usually a crash).
2763 * The Python testsuite is now much more extensive, and supports colour output
2764   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
2765   features are separated out, so that they can easily be removed when the
2766   features are removed.  The Python tests currently focus mainly on Python
2767   specific iterators and related functionality - general Xapian behaviour is
2768   tested by the C++ testsuite.
2770 * The pure Python code in the bindings now uses new-style classes, since we
2771   have required Python >= 2.2 since Xapian release 0.9.9.
2773 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
2774   instead.
2776 * The get_description() method which many classes support has been deprecated
2777   in favour of new more pythonic __str__ methods, so that the str() builtin can
2778   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
2780 Ruby:
2782 * We no longer regard the Ruby bindings as "beta quality", so remove the
2783   warning from their documentation.
2785 * Document that that C++ operator() becomes the method "call" in Ruby.
2787 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
2788   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
2790 Tcl:
2792 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2794 Xapian-bindings 0.9.10.1 (2007-04-04):
2796 PHP:
2798 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
2799   default parameters.  The most notable case was a missing Query constructor
2800   which meant that QueryParser was unusable.
2802 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
2803   (which mostly seems to mean the MS Windows version).
2805 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
2806   seems to mean the MS Windows version).
2808 * Add note to the documentation that PHP examples are written for CLI version
2809   of PHP, but that the bindings work with any version.
2811 * Add check to all PHP examples that they are being run under a CLI version of
2812   PHP.
2814 Python:
2816 * simpleexpand.py: Print each term's expand weight as a floating point value,
2817   not an integer.
2819 Ruby:
2821 * INSTALL: document how to install Xapian's Ruby bindings in your home
2822   directory.
2824 Xapian-bindings 0.9.10 (2007-03-04):
2826 Java:
2828 * Under Mac OS X, automatically look in the standard location for jni.h,
2829   and automatically rename the JNI library we build to ".jnilib", as is
2830   required by the OS X JVM.
2832 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
2833   to add the linux header directory to the include path when using this JDK.
2835 * Add missing default constructor for RSet class - it's not much use without
2836   this!
2838 * Fix Enquire.getESet() to actually work.
2840 * Fix bug in ESetIterator.hasNext().
2842 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
2844 * Fix memory leak with some JVMs in the "Query from array" constructor.
2846 * Fix memory leak in Enquire.setQuery().
2848 * SmokeTest.java: Add regression tests for RSet default constructor,
2849   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
2850   Add feature tests for Enquire.getQuery(), and to make sure we get passed
2851   the right document in a java subclass of MatchDecider.
2853 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
2854   respective variables are set.
2856 PHP:
2858 * Update the documentation to fix out-of-date information and document the
2859   differences between the PHP4 and PHP5 wrappers.
2861 * Update the examples to use the new Object Oriented API, and provide versions
2862   for both PHP4 and PHP5.
2864 * Add a "simpleexpand" example.
2866 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
2867   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
2868   new name, but keep the old name for now for backward compatibility.
2870 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
2871   interpreter - this works with PHP5.
2873 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
2874   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
2875   directory may not exist and "make install" will create it.
2877 * configure: If zend.h isn't found and configure was run with "--with-php",
2878   exit with an error rather than automatically disabling PHP support.
2880 Python:
2882 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
2884 Packaging:
2886 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
2887   various "--without" options in a comment at the start of the .spec file.
2889 * RPMs: Remove "." from the end of the Summary.
2891 Xapian-bindings 0.9.9 (2006-11-09):
2893 Documentation:
2895 * Ship our custom INSTALL file rather than the generic one from autoconf which
2896   we've accidentally been shipping instead since 0.9.5.
2898 General:
2900 * Wrap Flint::open() and Flint::open_writable().
2902 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
2903   suitable).
2905 Python:
2907 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
2908   bit platforms with Python 2.5.
2910 Packaging:
2912 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
2914 * RPMs: The Python bindings now require Python >= 2.2.
2916 Portability:
2918 * configure: Remove unnecessary backticks from tclsh version test.
2920 Xapian-bindings 0.9.8 (2006-11-02):
2922 General:
2924 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
2925   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
2927 * The C++ method QueryParser::parse_query() current throws "std:string"
2928   exceptions if there's a parse error.  Previously the bindings didn't catch
2929   these.  Now we catch them and handle them as if they were exceptions of
2930   type Xapian::QueryParserError (in anticipation of this changing in
2931   xapian-core).  Added testcases for this for PHP, Python, and C#.
2933 * configure: Note that SWIG is only useful for Xapian developers in --help
2934   output.
2936 * configure: If we failed to find any languages to build for, give a more
2937   helpful message.
2939 CSharp:
2941 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
2943 Java:
2945 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
2946   work rather than using the cached failure of the first jni.h check.
2948 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
2950 * SmokeTest.java: Avoid gcj "set but not used" warning.
2952 PHP:
2954 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
2956 * smoketest4.php,smoketest5.php: Check the exception message given by the
2957   DocNotFoundError testcase.
2959 Python:
2961 * Drop support for Python 2.1.
2963 Xapian-bindings 0.9.7 (2006-10-10):
2965 Documentation:
2967 * NEWS: Fix the recent headings which said "Xapian-core" to say
2968   "Xapian-bindings".
2970 General:
2972 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
2973   configure.ac.
2975 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
2976   compiling SWIG generated code which makes the compiled modules a few percent
2977   smaller and perhaps a little faster.
2979 * Wrap the newly implemented transaction API.
2981 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
2982   (this option was supposed to be used to compile the Python bindings from
2983   0.9.3 onwards, but this wasn't actually working correctly).
2985 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
2987 * In maintainer-mode, "make clean" now removes the SWIG generated files
2988   which would otherwise only be removed on "make maintainer-clean".
2990 CSharp:
2992 * Xapian::MatchDecider can now be subclassed in C#.
2994 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
2995   to use it.  This has been fixed and a regression test added.
2997 * SmokeTest.cs: Added exception handling test.
2999 Java:
3001 * Correct two misuses of delete to delete[].  Fixes bug#78.
3003 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
3004   Debian and Ubuntu boxes at least.
3006 PHP:
3008 * We now generate class wrappers for PHP5.
3010 * We now generate proxy classes for PHP4, which is an incompatible change
3011   from previous versions of xapian-bindings.  A perl script to upgrade
3012   your scripts is included.
3014 * smoketest.php:
3016   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
3017     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
3019   + Rely on xapian.php to load the extension module for us.
3021   + Fix error messages to show PHP code, not Python code.
3023 * When running smoketest.php, pass the "-q" option to php, which suppresses
3024   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
3025   recent versions of PHP.
3027 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
3028   the PHP interpreter not to be found in some cases when it was actually
3029   available, but it's only used to run the smoketest not for building the
3030   bindings.
3032 Python:
3034 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
3035   and also report the check and its result to the user.
3037 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
3038   built, so add an explicit dependency so that this works reliably in parallel
3039   builds.  Fixes bug#77.
3041 * In examples and documentation, don't call the MatchDecider class/object
3042   "matcher", since we use the term "matcher" to mean something else in
3043   the library documentation.
3045 * smoketest.py:
3047   + Add test of exception handling.
3049   + Add test that MatchDecider can be subclassed successfully.
3051 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
3052   pythonic iterator class.
3054 Ruby:
3056 * Xapian::MatchDecider can now be subclassed in Ruby.
3058 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
3059   (with no "ruby" alias) on Ubuntu dapper at least.
3061 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
3062   since we may have less than 10 matches, so say "1-<N>" instead.
3064 * simplematchdecider.rb: Implemented.
3066 Tcl:
3068 * Implement saner exception handling for Tcl and document it.
3070 * smoketest.tcl:
3072   + Add check that xapian::Query_OP_ELITE_SET has the right value.
3074   + Rework how the smoketest gets run to eliminate special code for using
3075     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
3076     to be run using installed bindings, and also makes it a better example
3077     program.
3079   + Add test for exception handling.
3081   + Send error messages to stderr.
3083   + Add comment about Tcl storing zero bytes as \xc0\x80.
3085 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
3087 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
3088   used for the Tcl bindings.
3090 Xapian-bindings 0.9.6 (2006-05-15):
3092 Documentation:
3094 * INSTALL: Add section describing how to install without root access.
3096 General:
3098 * Updated to reflect the renaming of Xapian::xapian_version_string and
3099   companions to Xapian::version_string.
3101 * Wrap optional length parameter to Enquire::set_query().
3103 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
3104   consistency.  Keep get_document_id as an alias for now for backward
3105   compatibility.
3107 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
3108   probably a largely harmless error).
3110 * Stop SWIG from adding exception handling wrappers to the calls which return
3111   version strings, since they can't throw exceptions.
3113 * xapian.i: Removed superfluous "const" from return type "docid" which is just
3114   a typedef for an unsigned integer type.
3116 * configure: Add some missing "checking ..." messages so the user has more idea
3117   what is going on.
3119 * Language specific util.i files can now define
3120   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
3121   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
3122   are provided for each language.  This avoids needing to keep this
3123   information in two different places.
3125 * xapian.i: Uncomment commented-out parameter names and fix duplicate
3126   parameter names (for the benefit of bindings which use the parameter names,
3127   like the OO PHP5 patch for SWIG I'm working on...)
3129 Portability:
3131 * configure: Fix warning flags passed for Intel C++ compiler.
3133 CSharp:
3135 * We now support building with Portable.NET.
3137 * Note that the passing of strings from C# into Xapian and back isn't currently
3138   zero byte safe.  If you try to handle string containing zero bytes, you'll
3139   find they get truncated at the zero byte.
3141 * C# bindings now build and pass tests when srcdir != builddir.
3143 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
3144   always say "CSharp" instead.
3146 * Not all machines are set up to run compiled C# programs when invoked
3147   directly, so get configure to check if we can, and otherwise see if using
3148   mono or ilrun works.  If not, just skip the C# tests.
3150 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
3151   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
3152   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
3154 * Move the C# specific %rename list to csharp/util.i.
3156 * Store the strong name key in the key container so we reuse it for later
3157   builds.
3159 * Wrap the version functions as more sensible names and document them (and
3160   continue to provide the older undocumented names for now just in case anyone
3161   was using them.)
3163 * Set the version of XapianSharp.dll correctly when building a snapshot from
3164   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
3166 * SmokeTest.cs: Add test of version functions.
3168 Guile:
3170 * The Guile bindings don't work and aren't being actively worked on, so we're
3171   no longer including them in the distributed tarball to avoid disappointing
3172   users who notice a "guile" subdirectory.  It also makes the download smaller.
3174 Java:
3176 * Simplify (and improve portability of) run-java-test by using "libtool
3177   --mode=execute"'s -dlopen option.
3179 * Need to make sure "built" subdirectory exists or building from clean fails.
3181 * Fix "make check" to work when srcdir != builddir.
3183 PHP:
3185 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
3186   4.3.10), so use "php -n" and then set the options we specifically want using
3187   "-d".
3189 * Fix the smoketest invocation to work better when srcdir != builddir.
3191 * Look for PHP interpreter first in prefix given by "php-config --prefix".
3193 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
3195 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
3197 * smoketest.php:
3199   + Add test for version reporting functions
3201   + If a test fails, say which one to aid debugging.
3203   + Added simple test that zero-bytes are handled correctly when passing
3204     strings to and from Xapian.
3206 Python:
3208 * README: Note that Python bindings have been built with MSVC.
3210 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
3211   to make them executable (they don't have a #! line).
3213 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
3214   "mymatchdecider".  Add description of what this example does.
3216 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
3218 * smoketest.py: Added simple test that zero-bytes are handled when passing
3219   strings to and from Xapian.
3221 Ruby:
3223 * Added new Ruby bindings from Paul Legato.
3225 Tcl:
3227 * smoketest.tcl:
3229   + Add test for version reporting functions
3231   + If a test fails, say which one to aid debugging.
3233   + Added simple test that zero-bytes are handled correctly when passing
3234     strings to and from Xapian.
3236 Xapian-bindings 0.9.5 (2006-04-08):
3238 Documentation:
3240 * HACKING,README: Split off HACKING to contain information which is only
3241   relevant to those wishing to modify the bindings.
3243 General:
3245 * SWIG-based bindings are now built with SWIG 1.3.29.
3247 * configure: Report which languages we're building bindings for just before
3248   configure finishes.
3250 * xapian.i: Make the stub definitions for disabled backends static.
3252 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
3253   message.
3255 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
3257 Packaging:
3259 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
3260   Python bindings to support 64 bit systems.
3262 * RPMs: Package the C# bindings.
3264 Portability:
3266 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
3267   different name.
3269 * configure: Detect Intel's C++ compiler and set suitable warning flags to
3270   avoid noise from compiling generated code.
3272 CSharp:
3274 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
3276 Guile:
3278 * configure: Disable --with-guile since Guile support doesn't currently work.
3280 Java:
3282 * Override deprecation warnings for Xapian methods/functions/etc.
3284 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
3285   have some idea what went wrong!
3287 * Rework how we include headers to get hash_map to avoid compiler warnings
3288   since it's usually not in the std namespace nowadays.
3290 * Previously the "all" target also ran the "install" target, but this has
3291   proved very problematic, so change "make check" to use the uninstalled JNI
3292   glue library, and update the instructions to say that "make install" is now
3293   required.
3295 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
3296   .class files.
3298 * README: Note that some platforms need "-pthread" or similar flags.
3300 * Add a new Query constructor wrapper which take an OP_xxx and an array of
3301   Query objects.
3303 * Compiling a .java file to a .class file now deletes the .jar file to ensure
3304   it gets updated.
3306 PHP:
3308 * php -n avoids reading any php.ini, but the compiled in default may be to
3309   enable the dubiously named "safe_mode" which prevents dl() being used so
3310   "make check" fails.  So instead provide a very simple php.ini which turns off
3311   safe_mode and makes sure enable_dl is on.
3313 * Fix handling of bool parameters when resolving overloaded methods and/or
3314   default arguments.  This fixes Enquire_sort_by_value() to work when the
3315   second argument is specified.  Added regression test for this case.
3317 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
3319 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
3320   passed by reference.  Fixes bug#74.
3322 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
3323   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
3325 Python:
3327 * Use the fairly new "swig -O" option for the "modern" python bindings as
3328   it generates a smaller glue library and runs faster.  Some of the features
3329   enabled also work on python 2.1, so enable these for the "olde" bindings.
3331 * configure: Catch the case where the user has python installed but not the
3332   module "distutils.sysconfig" and explain that they probably need to install a
3333   python-dev or python-devel package.
3335 * "make check" now works in VPATH builds.
3337 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
3338   know which check it was!
3340 * smoketest.py: catch Exception objects and print them.
3342 * smoketest.py: Add feature tests for the various pythonic iterator
3343   wrappers
3345 * python/docs/bindings.html: Document the Pythonic iterators.
3347 * Fix TermIter not to try to read termfreqs or positions if they aren't
3348   meaningful for the current TermIter.
3350 Xapian-bindings 0.9.4 (2006-02-21):
3352 Documentation:
3354 * COPYING: Updated FSF address.
3356 General:
3358 * Wrap Stopper::get_description().
3360 * Wrap xapian_version_string() and related functions.
3362 Portability:
3364 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
3365   run from "make" too.
3367 PHP:
3369 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
3370   default on Windows).
3372 Python:
3374 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
3376 Xapian-bindings 0.9.3 (2006-02-16):
3378 Documentation:
3380 * README: Updated and expanded (now covers supported platforms, and lists
3381   criteria which bindings for an additional language need to fulfil before
3382   we're likely to accept them).
3384 * INSTALL: Updated and improved.
3386 * TODO: Move C#-specific TODO to top level so we can track to-do items for
3387   all languages.
3389 General:
3391 * configure: Change how the user selects which bindings to build.  If no
3392   --with* arguments are passed, then we default to building bindings we detect
3393   the required tools for (as before).  But instead of requiring the user to
3394   deselect all bindings they don't actually want, we now let them select the
3395   bindings they do want.  So "./configure --with-python" will only build the
3396   python bindings (and will fail if the required tools aren't installed).
3398 * Every wrapped method contains exception handling code.  The bulk of this
3399   is now factored out into a single helper function, which cuts the compile
3400   time by around a factor of 3 and halves the size of the stripped library
3401   (figures are for Tcl on x86_64).
3403 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
3404   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
3406 * configure: Bump required SWIG version to 1.3.28 and drop the special
3407   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
3408   SWIG to install the bindings - SWIG is run by the Xapian developers
3409   so these updated requirements are only relevant if you want to modify
3410   the bindings.
3412 * Eliminate separate Makefile in each examples subdirectory, which makes the
3413   build system simpler, smaller, and a little faster.
3415 * xapian.i: Include default constructors for all classes so that SWIG knows it
3416   doesn't have to use SwigValueWrapper for them, which makes the bindings code
3417   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
3418   std::pair<...>.
3420 * configure: Document special environmental variables which configure
3421   recognises.  Enhance handling of environmental variables so you can
3422   e.g. './configure PYTHON=python23' (previously you had to give a full
3423   path in such environmental variables or they would be ignored.
3425 Packaging:
3427 * RPM spec file:
3429   + Automatically detect the python version.
3431   + Rename "php4" references to "php".
3433   + Automatically detect the PHP extension directory.
3435   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
3437   + Add support for "--without php" and --without tcl8" options to rpmbuild.
3439 Portability:
3441 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
3442   10.3.  This is required to link the bindings, and it doesn't seem to be
3443   possible to link them on 10.1 or 10.2 anyway.
3445 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
3446   to be explicitly specified and libtool correctly handles platforms where it
3447   would have been implicitly linked with anyway.
3449 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
3451 * configure: Add missing ";;" on the last alternative in some case statements.
3453 * Only pass -no-undefined on platforms where it is required in order to link a
3454   shared library at all (it causes problems on Mac OS X in some cases).
3456 CSharp:
3458 * This release includes a lot of improvements for the C# bindings.  They're
3459   now pretty much on a par with the other language bindings.
3461 * Added documentation and examples.
3463 * Method and function names are now renamed to match C# conventions
3464   (e.g. from get_description() to GetDescription()).  This is obviously an
3465   incompatible change, but the C# bindings haven't been suitable for real world
3466   use prior to this release.
3468 * Optional parameters are now wrapped so no longer need be specified
3469   explicitly.
3471 * Overload ++ and -- for iterators.
3473 * Overload == and != for iterators.  Now comparisons with the end iterator
3474   work as expected, and SmokeTest passes.
3476 * SmokeTest now reports exceptions verbosely.
3478 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
3479   similarly for other database factory functions.
3481 * Heed compatibility warnings from mcs and use different forms for
3482   command-line switches to the C# compiler (presumably for compatibility with
3483   Microsoft's compiler, though the warnings don't actually say that
3484   explicitly).
3486 Guile:
3488 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
3489   zero-byte safe.  The guile bindings are still a long way from actually
3490   working though.
3492 Java:
3494 * Wrap optional second parameter (query length) to Enquire::set_query().
3496 * configure now probes for the Java path separator, which we then use to
3497   separate entries in the java -classpath command line option so we can
3498   build on platforms where it isn't ":".
3500 * SmokeTest.java: Expand to test more features.
3502 * java/README:
3504   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
3506   + Add note about how wrapped methods are named.
3508 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
3509   validity check.
3511 * Query.java: Comment out unused code.
3513 * Fixed memory leak in Query-from-array-of-strings constructor.
3515 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
3516   Xapian::Error subclasses can tell you their typename directly (using
3517   get_type()).
3519 PHP:
3521 * Some problems with overloaded methods in PHP have been fixed by a major
3522   overhaul of SWIG's PHP support.  So we no longer rename such methods
3523   for PHP.  This is an incompatible change, but it's easy to update your
3524   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
3526 * Previously the documentation and simpleindex.php suggested that you
3527   should call delete_CLASS().  This was incorrect and resulted in a
3528   double-free() in some cases, so we've fixed the documentation and
3529   examples and eliminated the delete_CLASS() wrappers.  This is another
3530   incompatible change, but again easy to update for.
3532 * We now support PHP5 as well as PHP4, so the configure test now looks
3533   for either and all references to "PHP4" or "php4" have been adjusted.
3535 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
3536   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
3537   warning and making the method return "Null".  This isn't ideal, but it's
3538   the best we can easily do without proper exceptions.
3540 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
3541   empty php.ini in srcdir (which we were failing to distribute anyway), use
3542   "$(PHP) -n" which tells PHP not to use any php.ini file.
3544 * Update PHP documentation to include new features.
3546 * Redo Xapian section in phpinfo() to look more like most other modules.
3548 * You can now construct a Query object from an array of strings or Query
3549   objects (or even a mixture).
3551 * PHP examples now give a more useful error message if a database can't be
3552   opened.
3554 * smoketest.php: Expanded the tests performed, including feature tests for
3555   the new Query-from-list constuctor.
3557 * simplesearch.php: Use newly wrapped Query-from-list constructor.
3559 * Use std::string::data() instead of c_str() as it may be more efficient for
3560   some STL implementations.
3562 * Enquire::get_matching_terms() now generates the PHP list directly from the
3563   TermIterator rather than constructing a temporary C++ std::list, which is
3564   faster and requires less temporary memory.
3566 Python:
3568 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
3569   once again (it has been broken since 0.9.0).  Added a regression test to
3570   help keep this working.
3572 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
3573   instead of a list).  Also the sequence can contain xapian.Query objects or
3574   strings or a mixture.  Documented these enhancements.
3576 * smoketest.py: Expanded the tests performed.
3578 * Convert C++ strings to python ones in a zero-byte clean way.
3580 * Added more error checking of the results of calls into the python
3581   interpreter.
3583 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
3584   itself is compiled with this option to avoid problems and it appears we ought
3585   to use it too to avoid the risk of hitting the same problems, although I'm
3586   not aware of anyone actually encountering such problems).
3588 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
3589   avoid creating a broken xapian.pyc is the shared library can't be loaded for
3590   some reason.
3592 * Enquire::get_matching_terms() now generates the Python list directly from the
3593   TermIterator rather than constructing a temporary C++ std::list, which is
3594   faster and requires less temporary memory.
3596 Tcl:
3598 * Terms with a leading underscore now work (thanks to changes in SWIG).
3600 * Implement custom typemaps for Tcl, so that you can now construct a Query from
3601   a list of Query objects and/or strings, and Enquire::get_matching_terms is
3602   now wrapped.
3604 * simplesearch.tcl: Use the new Query from list constructor.
3606 * simplesearch.tcl: Fix to lowercase and stem query terms.
3608 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
3610 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
3612 Xapian-bindings 0.9.2 (2005-07-15):
3614 General:
3616 * Added wrappers for new optional flags argument to QueryParser::parse_query().
3618 CSharp:
3620 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
3621   another tool with the same name.
3623 Java:
3625 * Include SmokeTest.java in the distribution so "make check" works.
3627 * Added success report for Sun java 1.4.1_01a.
3629 Python:
3631 * When converting a python list to vector<string> we know the number of elements
3632   so reserve that number in the vector.
3634 Xapian-bindings 0.9.1 (2005-06-06):
3636 General:
3638 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
3640 Tcl:
3642 * Updated documentation to include information from Michael Schlenker about how
3643   to delete a database object such that the destructor gets called.
3645 Xapian-bindings 0.9.0 (2005-05-13):
3647 General:
3649 * Updated SWIG-based bindings to latest Xapian API
3651 * Improve support for building the bindings on MS Windows:
3653   + Provide stub versions of any backend functions which are disabled in the
3654     library we're wrapping to avoid a link failure on MS Windows (where the
3655     remote backend is automatically disabled).  These stubs just throw
3656     Xapian::FeatureUnavailableError.
3658   + Add -no-undefined to *_la_LDFLAGS.
3660   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
3661     appropriate.
3663   + For python, paths for finding headers and installing libraries are now
3664     handled so they work on MS Windows; an extra static library needs to be
3665     linked in too.
3667 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
3668   for disabled backends).
3670 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
3671   being useful functionality.
3673 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
3674   introduced in future get fixed.
3676 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
3677   have.
3679 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
3680   1.3.22 for as more recent versions don't work with methods with optional
3681   arguments - the arguments become non-optional!)
3683 Guile:
3685 * configure: Disable guile by default, as it needs more work.
3687 Java:
3689 * Updated to compile against 0.9.0 API.
3691 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
3693 * Wrap optional parameters to Query(term) constructor.
3695 PHP4:
3697 * For PHP4, rename default Database constructor to Database_empty
3698   instead of suppressing the much more useful Database(const string &path)
3699   constructor.
3701 * Use a blank config file when running PHP4 tests to avoid problems
3702   when the bindings are already installed as an extension which is
3703   loaded automatically in the default config.
3705 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
3706   it probably just means it's not in PATH.  We only need it for running tests,
3707   so substitute a trivial shell script which just exits with code 77 so PHP
3708   tests are skipped (previously we substituted "missing" which caused the tests
3709   to fail).
3711 Python:
3713 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
3714   and ValueIter.
3716 * configure: If python is found, also check that Python.h exists (it may not be
3717   if the python-dev package (or similar) isn't installed).
3719 Xapian-bindings 0.8.5.1 (2005-02-23):
3721 General:
3723 * configure: Run compiler feature tests using the C++ compiler, not the C
3724   compiler.
3726 * Allow bindings version to have an extra "patchlevel", yet still match with
3727   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
3729 Java:
3731 * Added a missing .java source file and removed several unused ones.
3733 * Fixed several glitches in the java bindings automake build system.
3735 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
3736   warnings in generated code (we were carefully passing "-Wunused"
3737   which is the opposite of what is needed!)
3739 * Fixed a couple of warnings from GCJ.
3741 * Wrapped a few missing methods added since Eric created the bindings.  There
3742   are still some missing methods - there's now a (probably incomplete) list in
3743   java/README.
3745 * Added various useful bits of information to java/README.
3747 * Tweaked SimpleSearch.java to be more like the C++ version.
3749 PHP4:
3751 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
3752   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
3753   a more recent version.
3755 * configure: Check for "php" as a program name as well as "php4", and
3756   fall-back to missing so the error message from "make check" is better.
3758 Xapian-bindings 0.8.5 (2004-12-23):
3760 General:
3762 * INSTALL: Added non-generic installation instructions.
3764 Python:
3766 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
3767   the same directory as xapian.py, but Makefile.am was looking in current
3768   directory when installing it.  Additionally, VPATH builds were broken.
3769   These problems were introduced by changes in 0.8.4.
3771 Xapian-bindings 0.8.4 (2004-12-08):
3773 General:
3775 * README: Now clearly says which languages we currently support, which people
3776   are working on, etc.
3778 * Instead of requiring the user to have a really recent SWIG installed, ship
3779   the files SWIG generates.  Disable all the SWIG rules unless configure is run
3780   with --enable-maintainer-mode to make sure they aren't triggered accidentally
3781   (e.g. by make with dodgy VPATH).
3783 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
3784   needed if you just want to install the bindings).
3786 * Wrap the new Database and WritableDatabase constructors which replace
3787   Auto::open().
3789 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
3790   (for example, simpleexpand.py needs it).
3792 * In the Query constructor which takes a vector of terms, only call set_window
3793   if window is non-zero.  Otherwise things go wrong if we're passed an empty
3794   vector.
3796 * Second argument to Document::add_posting() isn't optional, but xapian.i
3797   indicated that it was.
3799 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
3800   Deriving your own weight class in the scripting language isn't currently
3801   supported.
3803 * xapian.i: %name is deprecated, so use %rename instead.  This also works
3804   around a bug in SWIG 1.3.23.
3806 * configure: Removed pointless probe for a C compiler - everything we compile
3807   is C++.
3809 * configure: Reinstated the check that the bindings version matches the version
3810   of the xapian library.  It was added in 0.8.2, but accidentally removed in
3811   0.8.3.
3813 * Use newly added option `xapian-config --swigflags` which (a) avoids always
3814   passing -I/usr/include which could cause problems if we're using a Xapian
3815   install not in /usr and there's another one in /usr and (b) avoids problems
3816   if `xapian-config --cxxflags` contains flags other than -I<something>.
3818 CSharp:
3820 * Richard Boulton has put together bindings for C#.  These build successfully
3821   with the Mono tools, but the smoketest currently fails.  Unclear if the
3822   problem is the bindings or the smoketest code.
3824 Guile:
3826 * The guile bindings now build successfully, so we've enabled the guile
3827   detection machinery in configure.  They're untested though (we don't
3828   know guile!) so success or failure reports are encouraged!
3830 PHP4:
3832 * Mention the example scripts near the start of the documentation, not right at
3833   the end.
3835 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3836   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3837   mention!
3839 Python:
3841 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
3842   work in Python.
3844 * Changed examples to use the newly wrapped Query from list of terms ctor.
3846 * Mention the example scripts near the start of the documentation, not right at
3847   the end.
3849 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
3850   SWIG.
3852 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3853   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3854   mention!
3856 * Mention simpleexpand example in documentation.
3858 * Examples now report messages for Xapian exceptions.
3860 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
3862 * Make the example MatchDecider exclude documents matching a value, rather than
3863   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
3864   don't want examples to mislead like that.
3866 * python/docs/bindings.html: Note that you can construct a query
3867   from a list of terms, even if you can't from a list of queries.
3868   Add HTML links to the examples.
3870 * simpleindex.py: Trim spaces from the start as well as from the end of each
3871   line.  Simplify the loop slightly.
3873 Tcl:
3875 * Wrap in a tcl8 namespace "Xapian".
3877 * Added a smoketest.
3879 * Translated simpleindex and simplesearch into Tcl.
3881 * Set the Tcl package version.
3883 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
3885 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
3887 * Added documentation for tcl8 bindings.
3889 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
3890   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
3891   version (was 8.0).
3893 * configure.ac: Noted that the bindings can easily be compiled for use with
3894   Tcl 8.0, in case anybody needs that for some reason.
3896 * Don't wrap the factory functions which return a quartz WritableDatabase as
3897   the destructor never gets called so changes aren't flushed and the lock file
3898   isn't removed.
3900 Xapian-bindings 0.8.3 (2004-09-20):
3902 General:
3904 * Fixed mismatching versions of libtool used to produce configure and
3905   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
3906   names.
3908 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
3909   PHP4, and Tcl bindings.
3911 Java:
3913 * Pass -classpath to javac to fix build problems.
3915 * Make sure errors subdirectory is built before we try to build the jar file.
3917 * Fixed "make install" to not give libtool error.
3919 PHP4:
3921 * Include PHP4 documentation and exmples in the tarball.
3923 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
3924   change from 0.8.2 - it turns out we only need to pass these flags if we use
3925   swig's -noruntime option (which we don't do).
3927 Python:
3929 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
3930   faster Python wrapper code.
3932 Tcl:
3934 * Don't install xapian.la.
3936 * Improved configure check for tcl.h to work with Fedora Core 2.
3938 Xapian-bindings 0.8.2 (2004-09-13):
3940 General:
3942 * Added wrappers for recently added methods: ESet::back() and
3943   Database::get_lastdocid(), and wrap the new optional third parameter
3944   to Enquire::set_sorting().
3946 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
3948 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
3950 * Wrap Quartz, InMemory, and Remote database factory functions as
3951   quartz_open(), inmemory_open(), and remote_open().
3953 * Added missing wrappers for static Stem::get_available_languages() and
3954   Stem::get_description().
3956 * Wrap renamed method Query::empty() (was Query::is_empty()).
3958 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
3959   as an alias for now).
3961 * Require autoconf 2.59 and automake 1.8.5.
3963 * configure: Added check that the bindings version matches the version of
3964   the xapian library.
3966 * configure: Check if we're using GCC and only pass GCC specific warning
3967   control options if we are.
3969 * configure: When running with GCC, also pass -Wno-uninitialized so the
3970   SWIG glue builds without warnings.
3972 * README: Updated list of languages which SWIG supports.
3974 PHP4:
3976 * Document that the 2 argument form of Xapian::Auto::open() for opening a
3977   writable database is wrapped as open_writable() (bug #32).
3979 * Include Xapian version in output from phpinfo().
3981 * Build the SWIG glue library like we build the others rather than using
3982   SWIG's -phpfull option.  This avoids problems with newer automake versions
3983   and means we can build against an uninstalled xapian library.
3985 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
3986   Fixed documentation of how Xapian::Query::OP_* are wrapped.
3988 * Use special SWIG PHP ldflags when linking the PHP glue library.
3990 * simplesearch.py now works with multi-term queries.
3992 * Added documentation on how to install the PHP4 bindings.
3994 * Added a simple testcase to at least ensure the PHP4 bindings can be
3995   initialised and some simple operations work.
3997 Python:
3999 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
4001 * Don't install _xapian.la and _xapian.a.
4003 * Byte compile xapian.py to xapian.pyc and install it.
4005 * Suppress SWIG warning about MatchDecider::operator() director discarding
4006   const.
4008 * "make clean" no longer leaves "xapian_wrap.h" behind.
4010 * Added a simple testcase to at least ensure the python bindings can be
4011   initialised and some simple operations work.
4013 Tcl8:
4015 * configure: Disable building tcl8 bindings if the headers are missing
4016   (probably because the tcl8.X-dev package isn't installed).
4018 Xapian-bindings 0.8.1 (2004-06-30):
4020 General:
4022 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
4024 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
4025   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
4026   doesn't emit -I/usr/include in this situation (because it causes problems
4027   with some GCC versions).
4029 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
4030   not just a subset.
4032 Java:
4034 * Removed wrappers for unused error classes which have been pruned from C++.
4036 * Make finalize() methods of Database and WritableDatabase public so they can
4037   be called from by the user.
4039 * Document Document.add_term_nopos() as deprecated.
4041 PHP4:
4043 * Make sure that PHP bindings build a module which exports get_module() so PHP
4044   is able to load it.
4046 * Configure now checks that phpize can actually be run, rather than just that
4047   it's executable (test -x isn't portable anyhow).
4049 * Added basic documentation and examples to PHP4 bindings.
4051 * Rename overloaded methods and constructors.
4053 * Add simple access to the prefixes map in QueryParser.
4055 * Correct simpleindex ports to never generate empty termnames.
4057 Python:
4059 * configure: Use $PYTHON instead of python when running python to determine
4060   library and include paths and version number.
4062 * Actually ship python examples and documentation.
4064 Xapian-bindings 0.8.0 (2004-04-20):
4066 * README: Started collecting information on supporting Xapian from even
4067   more languages.
4069 * Added configure tests to enable bindings only where the necessary tools
4070   are installed and have a supported version.  ./configure --without-LANGUAGE
4071   allows particular languages to be forcibly disabled.
4073 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
4075 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
4077 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
4078   have been well tested, but integration with the xapian-bindings configure
4079   system hasn't been tested at all - please alert us to any problems.
4081 * Xapian can now be used from TCL.
4083 * Python: MSet now provides a Python iterator.
4085 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
4087 * Python: enable directors for MatchDecider, to allow subclassing in Python.
4089 * Python: Added basic documentation, and some examples.