Support: quest -f cjk_ngram
[xapian.git] / xapian-bindings / NEWS
blob8bbdb4d11efd3f37093b8eed7bd7fa624423411c
1 Xapian-bindings 1.3.3 (2015-06-01):
3 This release includes all changes from 1.2.20-1.2.21 which are relevant.
5 Documentation:
7 * INSTALL: IRIX is past EOL so drop information about IRIX make.
9 General:
11 * Add DB_RETRY_LOCK as a constant to wrap.
13 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
15 * Fix "make install" from a git tree configured with --disable-documentation.
16   (Fixes #658, reported by German M. Bravo)
18 * Fix "make install" when building from git with --disable-documentation.
20 * Fix to handle a VPATH build from a tarball when the generated docs will be in
21   $(srcdir).
23 * Update testcases for lazy wildcard expansion change in xapian-core.
25 * Update for addition of XAPIAN_NOEXCEPT.
27 * Don't wrap internal methods of Xapian::Weight.
29 Portability:
31 * Require a compiler with good C++11 support, like xapian-core now does.
33 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
34   doxygen.
36 * configure: Update check for -fvisibility to match xapian-core's.
38 CSharp:
40 * Fix configure test for whether $CLI can run CSharp programs - previously it
41   would always fail, which would mean that the CSharp tests wouldn't be run on
42   platforms where CSharp programs can't be run directly.
44 Java:
46 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
48 Lua:
50 * The Lua bindings are no longer considered to be "experimental" (in reality
51   they haven't been for some time).
53 Perl:
55 * Add a "LICENSE" section to the main POD.
57 * Add 'use strict' to all testcases, and add missing instances of 'my' that
58   this change uncovered.
60 * Wrap new WILDCARD_LIMIT_* constants as constants.
62 Python:
64 * Don't release the GIL when constructing a Query object from a sequence of
65   Query objects and/or strings.
67 * python/smoketest.py: Add new testcase to catch any internal functions,
68   methods, constants, etc which have accidentally been wrapped.
70 Python3:
72 * The Python3 bindings are no longer considered to be "experimental".
74 * Don't release the GIL when constructing a Query object from a sequence of
75   Query objects and/or strings.  (fixes #346)
77 * python3/pythontest.py: Expand comment about disabling test_import_star under
78   threads.
80 Tcl:
82 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
83   version added ::tcl::pkgconfig, which makes the configure tests simpler and
84   more reliable.
86 * Adjust precedence of the typecheck typemap for wrapping constructing a query
87   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
88   constructor correctly.
90 Xapian-bindings 1.3.2 (2014-11-24):
92 This release includes all changes from 1.2.16-1.2.19 which are relevant.
94 Documentation:
96 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
98 * Update for deprecation of Xapian::Chert::open().
100 * Update for renaming of "brass" backend to "glass".
102 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
103   updated" information isn't all that informative anyway - there can still be
104   stale information even if the file was updated very recently.
106 General:
108 * Releases and snapshots are now bootstrapped using a more recent version of
109   SWIG (a git snapshot from after the 3.0.3 release).
111 * configure: Fix SWIG version check to accept 3.x, and update the minimum
112   accepted version to be what we actually currently want.
114 * Wrap new C++ API features, and in particular all the new weighting schemes,
115   the changes to opening databases, and Xapian::Snipper.
117 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
118   argument which the C++ API takes.  If opts != 0, then output is sent to
119   stdout, otherwise no output is produced.
121 * Object descriptions are now always valid UTF-8. (see #620)
123 * Provide a SimpleStopper constructor which provides the ability to initialise
124   from a stopword list in a file.  Based on patch from Assem Chelli.
126 CSharp:
128 * README: Note that C# bindings now need .NET 2 or later (because that's what
129   SWIG-generated code now requires).
131 Java:
133 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
134   Anish Kanchan.  (see #616, reported by "Naveen")
136 Lua:
138 * Document that constants can now be accessed using CLASS.CONSTANT as well as
139   CLASS_CONSTANT.
141 Perl:
143 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
144   overlap with the hand-coded XS 'Search::Xapian' module.
146 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
147   during parallel builds.
149 * Use croak_sv() or ERRSV if defined.
151 PHP:
153 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
154   reached EOL.
156 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
157   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
158   `foreach ($it as $c)` works and allows iterating through the equivalent of
159   C++ operator* on the iterator.  (fixes#652)
161 * Fix handling of an exception thrown from a PHP implementation of
162   FieldProcessor::apply().
164 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
165   weight threshold.
167 * In current PHP releases, dl() is disabled in most SAPIs, and even where
168   available it will now only look in the configured extension directory.  The
169   upshot is that there no longer seems to be a sane way to install the PHP
170   bindings without being root.  Fixes #661, reported by Felix Ostmann.
172 Python2:
174 * The python testsuite already tested if any constants weren't marked with
175   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
176   clearly point to the actual problem.  Now we report the names of any
177   such constants.
179 * In the testsuite, use the xapian.WritableDatabase constructor rather than
180   chert_open() - that code dates back to when chert was the only disk-based
181   backend to support valuestreams, but flint was the default backend.
183 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
184   Germán M. Bravo in github PR59.
186 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
188 Python3:
190 * Python 3 support has been split off into its own subdirectory, and should now
191   be usable.  3.2 is the minimum supported version currently.  Existing code
192   will need updating for Python 3, and the wrapped API is necessarily different
193   in how Unicode is handled, so we've dropped deprecated features (such as
194   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
196 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
197   Germán M. Bravo in github PR59.
199 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
201 Ruby:
203 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
204   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
205   picking ruby 1.6.
207 Xapian-bindings 1.3.1 (2013-05-03):
209 This release includes all changes from 1.2.10-1.2.15 which are relevant.
211 Documentation:
213 * HACKING: Document Debian packages needed for each language.
215 General:
217 * Wrap new C++ API features.
219 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
220   unnecessary exception handling code where we call such functions and
221   methods.
223 * Tweak wrapping of Query from list constructor so the needed number of
224   elements get preallocated.
226 * Ignore Query(Query::Internal&) constructor, which is for internal use
227   only.
229 * For all languages except C# and Java, wrap the functions declared in
230   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
231   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
232   languages.
234 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
235   dependencies, and adjusts the generated dependencies to work in our build
236   system.
238 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
239   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
240   V=1' and 'make V=0' which are broadly equivalent and more standard.
242 * Fix the tests to work with the new automake parallel test driver.
244 Portability:
246 * Improve workaround which allows building against an uninstalled xapian-core
247   on OS X - this should now work with any uninstalled xapian-core (not only in
248   a tree with the same layout as an SVN or git checkout) and it also won't try
249   to build against "../xapian-core/.libs" just because it happens to exist.
250   (Fixes #322)
252 CSharp:
254 * configure: The variable to specify the interpreter is now CLI (was MONO, but
255   didn't actually work properly).
257 Java:
259 * Document that we aim to support JDK 1.6 (Java 6) and later.
261 * Avoid generating a temporary C++ vector of Query objects when constructing
262   a Query from a Java array of Query objects or a Java array of strings.
264 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
265   ValueIterator, and TermIterator.
267 * Add Enquire.getMatchingTerms().
269 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
270   building, e.g. "make JAVACFLAGS=-g".
272 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
273   with (the rather elderly) ECJ 3.3.1.
275 Perl:
277 * Fix PostingIterator wrapper to work.
279 * Update list of unwrapped things in POD documentation.
281 * Improve test coverage.
283 * perl/t/10query.t: Adjust regexp which checks expected error message to work
284   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
286 * Probe for the test running tool 'prove' in configure.
288 PHP:
290 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
291   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
292   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
293   compiled PHP module by 6%.
295 * php/smoketest.php: Add more tests of geospatial API.
297 Python:
299 * Drop support for Python 2.4.
301 * python/smoketest2.py: Add more testcases.
303 * python/smoketest2.py: Improve reporting of test failures for certain
304   testcases.
306 * Update Python 3 tests from Python 2 versions using 2to3.
308 Xapian-bindings 1.3.0 (2012-03-14):
310 Documentation:
312 * In maintainer builds, run doxygen to generate XML for the bindings in the
313   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
315 General:
317 * Wrap new geospatial API.
319 * Wrap new database checking API.
321 * Deprecated features scheduled for removal in 1.3.0 have been removed.
323 * Wrap ExpandDecider even if we don't have director support - there's a
324   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
325   needs some typemap work to actually get it usefully wrapped.
327 * configure:
329   + Add --disable-visibility option to match xapian-core.
331   + Add -fshow-column for GCC.
333   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
334     variable, so that it's easy to override it if you're getting a new warning
335     from SWIG but want to just ignore it for the time being.
337 * Exception handling now uses Error::get_description() rather than get_type +
338   ": " + get_msg().  In many cases this is the same, but if context or errno
339   are available, get_description() includes them.  Catch and report
340   std::exception rather than handling it as an unknown error (so in particular
341   std::bad_alloc will now be reported more helpfully).
343 CSharp:
345 * Avoid generating unwanted wrapper sources
346   SWIGTYPE_p_std__vectorT_std__string_t.cs and
347   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
349 Java:
351 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
352   bindings promoted in their place.  This means almost the entire C++ API is
353   now wrapped for Java, but the downside is there are some changes required
354   to existing code.  Overall we feel the short-term pain is worth the long
355   term benefits of having Java bindings which stay up to date.
357 * java/SmokeTest.java: Add test that string passing is zero byte safe.
359 Lua:
361 * Improve error messages.
363 Perl:
365 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
366   Perl 5.14.
368 * Fix Search::Xapian::Query->new() to work.
370 * Enable warnings for all test cases and make them fatal.
372 * Add "use Carp;" where we use functions from that module.
374 * Improve POD docs for Document and TermGenerator methods - "weight" is
375   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
377 * The Query constructor which takes an array of subqueries is now wrapped more
378   efficiently - previous a temporary C++ std::vector was built but now we avoid
379   doing this.
381 PHP:
383 * PHP >= 5.3 is now required.
385 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
387 * The XapianQuery constructor which takes an array of subqueries is now
388   wrapped more efficiently - previous a temporary C++ std::vector was built
389   but now we avoid doing this.
391 Python:
393 * Python >= 2.4 is now required.
395 * Remove deprecated Stem_get_available_languages().
397 * Hide away the deprecated non-pythonic iterators - we still need them to
398   implement the pythonic iterators, so we can't entirely remove them.
400 * Replace SWIG's thread locking with code which does nothing unless threads
401   are already initialised, to avoid the overhead of thread locking in the
402   common case of single-threaded Python code.  This seems to be about 5-10%
403   faster for pythontest2.py modified to repeat the tests 100 times.
405 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
406   #364.
408 * The Query constructor which takes an array of subqueries is now wrapped more
409   efficiently - previous a temporary C++ std::vector was built but now we avoid
410   doing this.
412 Ruby:
414 * The XapianQuery constructor which takes an array of subqueries is now
415   wrapped more efficiently - previous a temporary C++ std::vector was built
416   but now we avoid doing this.
418 Tcl:
420 * The XapianQuery constructor which takes an array of subqueries is now
421   wrapped more efficiently - previous a temporary C++ std::vector was built
422   but now we avoid doing this.
424 Xapian-bindings 1.2.21 (2015-05-20):
426 Lua:
428 * README: Remove note about the Lua bindings being experimental - it's not
429   really been true for some time now.
431 Perl:
433 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
435 * Add workaround for Perl defining a seed() macro which breaks compilation with
436   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
437   classes with a method called seed).
439 * Update list of unwrapped things in POD documentation.
441 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
442   during parallel builds.
444 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
446 * Add test that we can create all the stemmers returned by
447   Stem::get_available_languages().
449 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
450   likely due to external reasons, like incompatible compiler flags being taken
451   from Perl's Config module, due to Perl having been built with a different
452   compiler to Xapian.
454 * Use croak_sv() or ERRSV if defined.
456 PHP:
458 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
459   was fixed in 1.2.19.
461 Python:
463 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
464   stable release 1.4.0.
466 Ruby:
468 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
470 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
471   https://bugs.debian.org/782270
473 Xapian-bindings 1.2.20 (2015-03-04):
475 Portability:
477 * configure: Avoid using \? in sed command in Lua detection - it isn't
478   supported by all sed implementations.
480 Lua:
482 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
483   being specified without a leading '.'.
485 * configure: Add an example of specifying LUA_SO to --help output.
487 PHP:
489 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
490   1.2.19.
492 * In current PHP releases, dl() is disabled in most SAPIs, and even where
493   available it will now only look in the configured extension directory.  The
494   upshot is that there no longer seems to be a sane way to install the PHP
495   bindings without being root, so update the documentation to reflect this.
496   Fixes #661, reported by Felix Ostmann.
498 Xapian-bindings 1.2.19 (2014-10-21):
500 PHP:
502 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
503   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
504   Gottfried)
506 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
507   which were getting incorrectly wrapped such that they didn't actually do
508   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
509   reference tracking fix in 1.2.14.
511 Ruby:
513 * README: Note that Ruby 2.1 works too.
515 Xapian-bindings 1.2.18 (2014-06-22):
517 Documentation:
519 * README: Add links to Erlang and Node.js bindings.
521 Lua:
523 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
524   expected), which most of the calls already used, and fix up the few calls
525   which passed (expected, got).
527 PHP:
529 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
530   that MatchDecider returns an MSet with the expected docid in.  Luckily this
531   wasn't masking a test failure.
533 Python:
535 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
536   - chert is the default backend now, and both chert and brass support the
537   required functionality for the tests which do this, so this just needlessly
538   causes the tests to fail if chert is disabled in xapian-core.
540 * configure: If the Python version is too new or too old, only report it once
541   not twice.
543 Ruby:
545 * configure: Fix Ruby bindings to build on Windows (and other platforms where
546   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
548 Xapian-bindings 1.2.17 (2014-01-29):
550 Portability:
552 * Improve workaround which allows building against an uninstalled xapian-core
553   on OS X - this should now work with any uninstalled xapian-core (not only in
554   a tree with the same layout as an SVN or git checkout) and it also won't try
555   to build against "../xapian-core/.libs" just because it happens to exist.
556   (Backported from 1.3.1; fixes #322)
558 Python:
560 * configure: Some distros now point /usr/bin/python at Python 3, so the check
561   for a Python 2 interpreter now checks for 'python2' first, and checks that
562   the version of found interpreter is 2.x.
564 Ruby:
566 * Tweak configure to work with Ruby 2.0.
568 Tcl:
570 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
571   in http://bugs.debian.org/724830).
573 * Use a better check for TCL_INC for Tcl 8.5 and later.
575 Xapian-bindings 1.2.16 (2013-12-04):
577 Documentation:
579 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
581 General:
583 * Compress source tarballs with xz instead of gzip.
585 * configure: Handle git snapshot naming.
587 Portability:
589 * configure: Update list of platforms where we tell libtool not to link in
590   deplibs to match the list used for xapian-core.
592 Perl:
594 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
595   GCC 4.7 warning).
597 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
598   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
600 PHP:
602 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
603   with a message explaining this.
605 Python:
607 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
609 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
611 * pythontest.py: Fix testcase checking we get an exception from using
612   non-random-access iterators after then have advanced - previously these
613   didn't actually test as fully as intended.
615 Ruby:
617 * Omit internal classes and methods from the rdocs.
619 Xapian-bindings 1.2.15 (2013-04-16):
621 General:
623 * Fix configure --enable-quiet option to actually work for the bindings.
625 Perl:
627 * Fix doc typo: "as as" -> "as a"
629 Ruby:
631 * Fix deprecation warning in configure from Ruby 1.9.3.
633 Xapian-bindings 1.2.14 (2013-03-14):
635 Python:
637 * Fix typo in doccomment.
639 PHP:
641 * Keep references to the PHP wrapper object when an object is set on another
642   object.  (fixes #614)
644 Tcl:
646 * Allow TCL_INC to be passed to configure.  (fixes #612)
648 Xapian-bindings 1.2.13 (2012-11-09):
650 CSharp:
652 * configure: Overhaul checks for C# tools to use modern names in preference.
654 Lua:
656 * Fix examples to use str(query) to get the query description.  (Fixes #600)
658 * Document that get_description() is mapped to str(), and end() to _end().
660 * Fix functor wrappers which return strings to be zero-byte clean.
662 Perl:
664 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
665   1.2's XS Search::Xapian.  (ticket#607)
667 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
668   is deprecated.
670 PHP:
672 * Document that subclassing Xapian classes in PHP currently doesn't work with
673   PHP 5.4.
675 Xapian-bindings 1.2.12 (2012-06-27):
677 No changes since 1.2.11 except to bump the version - this release was made to
678 fix an incorrect library version information update in xapian-core 1.2.11.
680 Xapian-bindings 1.2.11 (2012-06-26):
682 General:
684 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
686 Perl:
688 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
689   av_fetch() (spotted due to GCC 4.7 warning).
691 PHP:
693 * Fix "make check" to work for PHP when building from a release tarball with
694   srcdir != builddir.
696 * Work around "undefined symbol: zend_error_noreturn" error.
698 Xapian-bindings 1.2.10 (2012-05-09):
700 CSharp:
702 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
703   us to do this instead of setting them in AssemblyInfo.cs.
705 * Use diff's -c option when comparing the files SWIG generated against those we
706   were expecting to get as the output should be easier to understand.
708 * Sort both the lists of expected and of found SWIG-generated sources with
709   Perl, to avoid problems with locale-specific sort orders.
711 Java-SWIG:
713 * Remove now superfluous old check that SWIG generated at least the sources we
714   want - we now check it generated *exactly* the sources we want.
716 * Use diff's -c option when comparing the files SWIG generated against those we
717   were expecting to get as the output should be easier to understand.
719 * Sort both the lists of expected and of found SWIG-generated sources with
720   Perl, to avoid problems with locale-specific sort orders.
722 Lua:
724 * Now works with Lua 5.2.
726 * "require 'xapian'" now returns the module table.  (ticket #593)
728 * lua/smoketest.lua: Improve reporting of test failures.
730 Perl:
732 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
734 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
735   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
737 Python:
739 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
740   iteration features which have been removed on trunk.  This also fixes a
741   segfault if there are no matches and no documents are explicitly marked as
742   relevant.
744 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
745   way to rerun tests with verbose output.
747 Ruby:
749 * configure: Make sure the ruby subdirectory exists before trying to create
750   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
752 Xapian-bindings 1.2.9 (2012-03-08):
754 Java:
756 * configure: Fix test for jni.h to try looking for jni.h relative to the real
757   location of javac, which should work for more JDKs.
759 Lua:
761 * Handle an exception from C++ by raising a xapian.Error object as an error in
762   Lua.
764 * Rename get_description() methods to __tostring(), so that you can use write
765   tostring(obj) in Lua.
767 * configure: Honour LUA_LIB if already set.  Fixes #581.
769 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
770   support platforms where the compiled Lua module isn't called .so.
772 Perl:
774 * Add tests of Document::get_docid().
776 PHP:
778 * Add a test that Query constructor taking OP_NEAR with a window size works.
780 Python:
782 * python/testsuite2.py: Don't run off the traceback looking for a test function
783   if the exception wasn't from a test function.
785 Xapian-bindings 1.2.8 (2011-12-13):
787 Lua:
789 * Wrap user-subclassable functor objects by allowing the user to pass a
790   Lua function where the functor object would be passed in the C++ API.
792 PHP:
794 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
796 * The PHP bindings will now work again with a version of PHP built with ZTS
797   enabled (which is the default on Microsoft Windows).  This was broken by
798   the changes to support subclassing in PHP in the version of SWIG used since
799   1.2.6.
801 Python:
803 * Add a module docstring.  (Fixes bug #573)
805 * The python testsuite now checks for object leaks during each testcase.
807 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
808   only check for leaks the second time to avoid falsely reporting a leak when
809   some cached value gets initialised under Python 2.5.
811 Ruby:
813 * Wrap optional prefix parameter to Database::allterms.
815 Xapian-bindings 1.2.7 (2011-08-10):
817 Documentation:
819 * INSTALL: Pull in a few updates from the latest version of the automake
820   document which this file was originally based on.  Add in the missing
821   copyright and licensing information.
823 * INSTALL: Add --with-lua to list of options.
825 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
826   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
827   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
828   supported platforms in the README.
830 * HACKING: Update and start section on deprecation warnings for the bindings.
832 General:
834 * Add missing wrappers for Database::has_positions() and
835   TermIterator::positionlist_count(), and correct the return type of
836   Database::get_doclength() from double to Xapian::termcount.
838 CSharp:
840 * README: Note a recent version of Mono which we've tested the C# bindings
841   with.
843 * Check that exactly the sources we expect are generated, and add some sources
844   which were missing from the list.
846 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
847   gets removed.
849 * Fix iterator ++ and -- so that the reference to the object isn't released
850   prematurely, which was causing an occasional crash if the garbage collection
851   happened at just the wrong moment,
853 * Add test coverage for QueryParser.ParseQuery() with flags argument.
855 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
857 Java:
859 * SmokeTest.java: Fix == comparisons with strings to use equals().
861 * Add test that string passing is zero byte safe.
863 * Fix MyExpandDecider.accept() to really check the passed parameter.
865 Java-SWIG:
867 * Put the SWIG-generated Java bindings in package org.xapian.
869 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
871 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
873 * Add test that string passing is zero byte safe.
875 * Fix MyExpandDecider.accept() to really check the passed parameter.
877 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
879 * Create an HTML documentation page based on java/README.
881 * Copy java examples from the hand-coded JNI ones.
883 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
885 * Check that exactly the sources we expect are generated, and add some sources
886   which were missing from the list.
888 Lua:
890 * Merge latest Lua changes from Xiaona Han.
892 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
894 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
895   matches.
897 Perl:
899 * Sync updates to examples from XS Search::Xapian:
901   + Require Perl >= 5.6 so we can "use warnings;".
903   + Loop over file using while() (which reads a line per iteration) not
904     foreach() (which reads the whole file up front).
906 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
907   and Search::Xapian::Query::MatchNothing).  (ticket#158)
909 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
911 * perl/Makefile.am: Fix "make check".
913 * perl/t/symbol-test.t: Fix to work when built against an installed
914   xapian-core.  (ticket#558)
916 PHP:
918 * php/smoketest.php: Install an error handler so the test fails if there are
919   any errors, warnings, notices, etc.
921 * Change PHP examples and test program to use 'include "xapian.php"' like user
922   code should (rather than 'include "php5/xapian.php"' as they did previously).
924 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
925   XapianQuery::MatchNothing(). (ticket#158)
927 Ruby:
929 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
931 Xapian-bindings 1.2.6 (2011-06-12):
933 General:
935 * SWIG-based bindings are now generated with a newer version of SWIG
936   (ticket#538).
938 Portability:
940 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
941   .jnilib extension as we do for older versions.
943 CSharp:
945 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
947 Java:
949 * Fix memory leaks when functions taking string parameters throw exceptions.
951 * Previously a hash table was used to map Java objects to C++ ones, but we
952   now just cast the address of the C++ object to a jlong (which is 64 bits
953   so will hold a pointer on current platforms).  This is more efficient and
954   avoids the need for thread locks around accesses to the hash table.
956 * Remove explicit checks for NULL around calls to delete.
958 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
959   during parallel builds.
961 Lua:
963 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
964   year.  The current support should be regarded as experimental - it passes
965   its automated tests, but the details of the Lua API are likely to evolve as
966   the project progresses.
968 Perl:
970 * README: say that Perl bindings probably need Perl 5.8 or later.
972 PHP:
974 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
976 Python:
978 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
979   all the garbage, so repeat until no further objects are freed.
980   (http://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
982 Ruby:
984 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
985   the compaction tests for these versions.
987 Xapian-bindings 1.2.5 (2011-04-04):
989 Documentation:
991 * README: Update info on SWIG-based Perl bindings.
993 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
994   section with better equivalent from xapian-core/INSTALL.
996 General:
998 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
1000 * configure: If xapian-core is a different release series, promote the
1001   mismatched versions warning to an error.
1003 Portability:
1005 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
1006   10.4 on x86, as the default if unset on these versions is the current OS
1007   version.  (ticket#541)
1009 * python/pythontest2.py: In test_compactor(), close any open databases before
1010   removing the directory as you can't delete an open database on Microsoft
1011   Windows.  (ticket#526)
1013 CSharp:
1015 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
1017 * Clarify the licence is GPL "version 2 or later" in the meta information
1018   we put in the module.
1020 Python:
1022 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
1023   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
1024   accidentally left an older version of get_matching_terms() exposed.
1026 * Remove broken implementation of MSet.__contains__.  This appears never to
1027   have worked, and to have been broken for at least the past 3.5 years without
1028   anyone mentioning it, and is probably of little use anyway, so no need to
1029   deprecate.
1031 * python/docs/index.html: Document that MSet.items and ESet.items are
1032   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
1033   the tuple returned by MSet.items.  (ticket#531)
1035 * Add test coverage for mset.items.
1037 Ruby:
1039 * Add test coverage for Xapian::Compactor.
1041 * Handle an empty response to $RUBY --version specially.  This gives a less
1042   opaque error in cases where the user specified RUBY but the value given
1043   wasn't an executable file.
1045 Xapian-bindings 1.2.4 (2010-12-19):
1047 General:
1049 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
1050   virtual method is wrapped for subclassing for Python and Ruby currently.
1052 * Eliminate separate Makefile.am in the docs subdirectory of each language
1053   subdirectory and just inline any rules into the main sub-Makefile.am, which
1054   allows more of the build to run in parallel.
1056 * Don't ship some files which are generated at build time.
1058 * configure: Need python in maintainer mode to run doxy2swig.py.
1060 Packaging:
1062 * RPM: Package the Perl bindings.
1064 * RPM: Don't package _XapianSharp.la.
1066 Portability:
1068 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
1069   uninstalled Xapian library.  See ticket #322.
1071 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1073 CSharp:
1075 * Don't install _XapianSharp.la.
1077 Perl:
1079 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
1080   GSoC 2009.  These are close to being a compatible replacement for the
1081   hand-coded XS bindings in Search::Xapian but also offer a more complete
1082   wrapping of the C++ API.  We're planning to replace the XS bindings with the
1083   SWIG ones for easier maintenance.  We encourage you to try them and let us
1084   know how you get on - particularly if you find cases where code which works
1085   with the XS bindings doesn't work with the SWIG ones.
1087 PHP:
1089 * Document that iterators shouldn't be dereferenced or advanced when at their
1090   end points (ticket#520).
1092 Python:
1094 * Fix memory leaks in typemaps which return Python lists.
1096 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
1097   supported.
1099 * configure: Use sys.version_info tuple, rather than string splicing which
1100   assumes the Python "major.minor" is 3 characters (which would fail if Python
1101   2.10 were ever released, for example).
1103 Xapian-bindings 1.2.3 (2010-08-24):
1105 Packaging:
1107 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
1109 Xapian-bindings 1.2.2 (2010-06-27):
1111 * No user-visible change except for bumping the version to indicate
1112   compatibility with Xapian-core 1.2.2.
1114 Xapian-bindings 1.2.1 (2010-06-22):
1116 This release includes all changes from 1.0.21 which are relevant.
1118 General:
1120 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
1121   Python.  (ticket#448)
1123 Guile:
1125 * Remove non-functional disabled guile bindings left over from Open Muscat
1126   days - if someone wanted to add guile bindings, it would be easier to start
1127   from scratch.
1129 Java-SWIG:
1131 * Update list of generated java sources in the SWIG-based Java bindings.
1133 PHP:
1135 * zend_throw_exception() returns, so return control to PHP directly after
1136   calling it to avoid needless extra work and possible issues.
1138 Python:
1140 * Fix "from xapian import *".  (ticket#477)
1142 * Fix testcase weight_normalise - a change in xapian-core means that
1143   get_max_possible() can now return zero for a non-existent term, so don't
1144   blindly calculate the reciprocal of it.
1146 * python/replicationtest2.py: Extend to check that changesets get applied
1147   correctly.
1149 * python/smoketest2.py: Check len(mset) works (improving test coverage of
1150   Python-specific wrapping).
1152 Xapian-bindings 1.2.0 (2010-04-28):
1154 This release includes all changes from 1.0.20 which are relevant.
1156 Portability:
1158 * configure: Tell libtool not to link in deplibs on platforms where we know
1159   they aren't needed.
1161 * configure: On Linux, extract the library search path from ldconfig which
1162   gives us the default entries reliably.
1164 Xapian-bindings 1.1.5 (2010-04-15):
1166 This release includes all changes from 1.0.19 which are relevant.
1168 Tcl:
1170 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
1171   sidestep the whole destructor issue.  (ticket#62)
1173 Xapian-bindings 1.1.4 (2010-02-15):
1175 This release includes all changes from 1.0.18 which are relevant.
1177 General:
1179 * Update for the new Brass backend and other C++ API changes.
1181 * Wrap Database::get_doclength_lower_bound(),
1182   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
1183   Database::valuestream_begin() and Database::valuestream_end() for all
1184   languages. (ticket#431)
1186 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
1188 Python:
1190 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
1191   object which dereferences to a ValueStreamItem object,
1193 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
1195 Ruby:
1197 * Add safe wrapper for the valuestream iterator.
1199 Xapian-bindings 1.1.3 (2009-11-18):
1201 This release includes all changes from 1.0.15-1.0.17 which are relevant.
1203 General:
1205 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
1206   specified.
1208 * Wrap the new MatchSpy class, and associated features.
1210 * Don't wrap PostingSource::serialise(), Weight::serialise() and
1211   Weight::unserialise() as they aren't useful from the bindings.
1213 * Update for the Sorter to KeyMaker changes.
1215 PHP:
1217 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
1218   as it standardly is on Microsoft Windows.  Fixes #411.
1220 * Merged the PHP "smoketest" back together now we don't need to support
1221   PHP4 now.
1223 Python:
1225 * Fix a memory leak on error (in theory - we've not got a way to generate this
1226   error, so haven't been able to reproduce the leak or test the fix).
1228 Xapian-bindings 1.1.2 (2009-07-23):
1230 This release includes all changes from 1.0.14 which are relevant to trunk.
1232 Python:
1234 * Several changes towards fully supporting Python 3, but more work is required.
1235   (ticket#246)
1237 Xapian-bindings 1.1.1 (2009-06-09):
1239 This release includes all changes from 1.0.13 which are relevant to trunk.
1241 General:
1243 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
1245 CSharp:
1247 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1248   C# yet, and to use Query("") and Query() instead.
1250 * configure: If we don't find a C# compiler, don't test an empty command name
1251   further which saves a fork and avoids an odd looking message.
1253 PHP:
1255 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1256   PHP yet, and to use Query("") and Query() instead.
1258 Python:
1260 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
1261   are wrapped (ticket#158).
1263 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
1264   expect SYNONYM in generated query.
1266 Ruby:
1268 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1269   Ruby yet, and to use Query("") and Query() instead.
1271 Tcl:
1273 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
1274   are wrapped (ticket#158).
1276 Xapian-bindings 1.1.0 (2009-04-22):
1278 Documentation:
1280 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
1281   the instructions to suggest users use this standard location for installing
1282   without root access.
1284 General:
1286 * All deprecated features slated for removal in 1.1.0 have been removed.
1288 * All new C++ API features have been wrapped.  Also, since we now supply some
1289   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
1290   these can be passed in even for languages for which SWIG doesn't support
1291   subclassing.
1293 Packaging:
1295 * xapian-bindings.spec: Updated to reflect the new Python packaging.
1297 Portability:
1299 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
1300   to put the compiler into ISO C++ mode).
1302 PHP:
1304 * PHP4 support has been removed, since PHP4 is no longer supported upstream
1305   as of 2008-08-08.
1307 Python:
1309 * Python 2.3 or later is now required.  2.2 is essentially unsupported
1310   upstream.
1312 * The import method used has been changed (by using a newer SWIG version)
1313   and no longer gives a warning with Python 2.6.
1315 * Initial support for Python 3.0 has been added.  This currently doesn't
1316   work correctly and should be treated as experimental. (ticket#346)
1318 * The newer SWIG version handles exceptions in director methods correctly
1319   so we no longer need our workaround for ticket #289.
1321 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
1322   wrapped for Python as Database.metadata_keys().
1324 * The Python bindings are now installed as a python package, with the
1325   files in a xapian subdirectory, hiding the internal _xapian module
1326   better.
1328 * Python now flags deprecation warnings for the single argument form and old
1329   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
1330   friends.
1332 Xapian-bindings 1.0.23 (2011-01-14):
1334 Portability:
1336 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1338 PHP:
1340 * Document that iterators shouldn't be dereferenced or advanced when at their
1341   end points (ticket#520).
1343 Python:
1345 * Fix memory leaks in typemaps which return Python lists.
1347 Xapian-bindings 1.0.22 (2010-10-03):
1349 Packaging:
1351 * RPM: Don't package _XapianSharp.la.
1353 CSharp:
1355 * Don't install _XapianSharp.la.
1357 Python:
1359 * configure: Use sys.version_info tuple, rather than string splicing which
1360   assumes the Python "major.minor" is 3 characters (which would fail if Python
1361   2.10 were ever released, for example).
1363 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
1364   testcase in pythontest.py.
1366 Xapian-bindings 1.0.21 (2010-06-18):
1368 Python:
1370 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
1371   can't be written to. (ticket#297)
1373 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
1375 * Add test to check that "from xapian import *" works.
1377 Xapian-bindings 1.0.20 (2010-04-27):
1379 Python:
1381 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
1382   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
1383   trap to delete them after running tests for older versions of Python.
1384   (ticket#315)
1386 Ruby:
1388 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
1390 Xapian-bindings 1.0.19 (2010-04-15):
1392 Tcl:
1394 * tcl8/docs/index.html: Improve wording in a few places.
1396 Xapian-bindings 1.0.18 (2010-02-14):
1398 General:
1400 * Wrap new C++ API method Document::add_boolean_term().
1402 Ruby:
1404 * Generate entries in the Ruby rdocs for all classes which aren't documented
1405   because of Ruby-specific methods.  Fixes ticket#417.
1407 * Avoid absolute paths in the generated rdocs.
1409 Xapian-bindings 1.0.17 (2009-11-18):
1411 Packaging:
1413 * Improve RPM package summaries - the files are needed to *use* scripts as well
1414   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
1415   conventional.
1417 Portability:
1419 * python/Makefile.am: Restore the "./" path to the sourced file
1420   libtoolconfig.tmp as ksh requires it.
1422 Java:
1424 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
1426 Xapian-bindings 1.0.16 (2009-09-10):
1428 Python:
1430 * Improved docstrings for QueryParser::set_default_op() and
1431   QueryParser::get_default_op() (automatically generated from changes in
1432   xapian-core).
1434 Xapian-bindings 1.0.15 (2009-08-26):
1436 Python:
1438 * Don't break long words when wrapping text in the generated API documentation
1439   comments as this was causing identifiers to be broken in two.
1441 Xapian-bindings 1.0.14 (2009-07-21):
1443 General:
1445 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
1446   and the only side-effect was an odd looking message.
1448 Python:
1450 * Rename methods at build-time using SWIG rather than a run-time in Python, as
1451   the latter approach adds a small time overhead when the module is being
1452   loaded.
1454 Ruby:
1456 * Fix to accept an integer value > MAXINT for a double parameter.
1458 Xapian-bindings 1.0.13 (2009-05-23):
1460 Packaging:
1462 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
1463   _XapianSharp.so in 1.0.11.
1465 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
1466   bindings since 1.0.6.
1468 PHP:
1470 * Backport fix from SWIG SVN for misuse of formatted error function in
1471   SWIG-generated code.
1473 Python:
1475 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
1476   Python's Global Interpreter Lock (GIL) in situations where we know that it
1477   will already be locked.  This avoids some dead-locks with mod_python (due to
1478   mod_python bugs which are apparently unlikely to ever be fixed), and results
1479   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
1480   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
1481   faster). (ticket#185)
1483 * README,python/docs/index.html: Update documentation of the above mod_python
1484   issue and also document the related mod_wsgi issue.  The status is now that
1485   everything seems to work if you stick to the main interpreter (ticket#364).
1487 * Backport fix from SWIG SVN for misuse of formatted error function in
1488   SWIG-generated code.
1490 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
1491   second parameter, not the third.
1493 * python/docs/examples/simplematchdecider.py,
1494   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
1495   clearer code.
1497 Ruby:
1499 * README: Note that the testsuite fails due to a bug in the test/unit module in
1500   Ruby 1.9.0, but applications using the bindings should work, and that the
1501   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
1502   appears to be completely dead both upstream and in the wild.
1504 Xapian-bindings 1.0.12 (2009-04-19):
1506 Documentation:
1508 * INSTALL: Add a note about being able to pass variables to configure to pick
1509   which of several parallel installations of a language to build for.
1511 Python:
1513 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
1514   test to avoid failing due to rounding differences.
1516 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
1517   stop the whole testsuite, not just the currently running testcase.
1519 Xapian-bindings 1.0.11 (2009-03-15):
1521 Documentation:
1523 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
1524   Python 3, and possible current issues with Ruby 1.9.
1526 Portability:
1528 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
1529   Cygwin.
1531 Python:
1533 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
1534   latter is deprecated, and support was removed in 1.0.0).
1536 * Add support for using the new name ("reverse") for the second argument of
1537   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
1538   The old name ("ascending") is still supported, but will be deprecated in
1539   1.1.0.
1541 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
1542   which get set on other objects to avoid segmentation faults if they go out
1543   of scope before the object they are set on does.  (ticket#341)
1545 Ruby:
1547 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
1548   fails so "make check" doesn't pass, but code using the bindings should work.
1550 Xapian-bindings 1.0.10 (2008-12-23):
1552 Python:
1554 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
1555   as things stand (upstream fix for Debian bug 506090).
1557 Xapian-bindings 1.0.9 (2008-10-31):
1559 General:
1561 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
1563 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
1564   methods.
1566 Xapian-bindings 1.0.8 (2008-09-04):
1568 General:
1570 * configure: Report bug report URL in --help output.
1572 Python:
1574 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
1575   (bug#289)
1577 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
1579 Xapian-bindings 1.0.7 (2008-07-14):
1581 Documentation:
1583 * Document how all the database factory functions and library version functions
1584   are wrapped for all languages.
1586 General:
1588 * Fix to build against a xapian-core which has quartz and/or flint disabled.
1590 * The "program" version of Remote::open() has been wrapped for some time, so
1591   update the documentation which said it wasn't.
1593 Packaging:
1595 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
1597 Portability:
1599 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
1600   different module extension rather than our own ugly bodge.
1602 Java:
1604 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
1605   simple to make C++ to Java work though.
1607 PHP:
1609 * Add test that OP_VALUE_GE works for PHP.
1611 Python:
1613 * Several corrections to the Python documentation.
1615 * configure: Fix problem with building under mingw.
1617 Ruby:
1619 * Include simplematchdecider.rb example.
1621 * smoketest.rb: Test the version reporting functions.
1623 Tcl:
1625 * Include simpleexpand.tcl example.
1627 * Fix where the Tcl module gets installed.
1629 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
1631 Xapian-bindings 1.0.6 (2008-03-17):
1633 General:
1635 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
1636   used with.
1638 * configure: Correct the required SWIG version given in an error message.
1640 PHP:
1642 * php/smoketest.php: Add note that this script should be run using 'make check'
1643   in the build tree (rather than trying to copy it to a webserver as someone
1644   recently tried to).
1646 * php/smoketest.php: Fix to work under PHP4.
1648 Python:
1650 * The Python module now always has the extension which Python expects, which
1651   fixes a failure on Mac OS X.
1653 Ruby:
1655 * Automatically install/uninstall the Ruby rdoc-generated documentation along
1656   with the ruby bindings.
1658 Tcl:
1660 * configure: Sort out the default value of TCL_LIB, which could end up being
1661   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
1663 Xapian-bindings 1.0.5 (2007-12-21):
1665 General:
1667 * Wrap Xapian::Sorter and subclasses.
1669 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
1670   and Enquire::set_sort_by_relevance_then_key().
1672 * Factor out the code to protect multitarget rules against parallel make, and
1673   fix it to handle the source being changed while the rule is executing, and to
1674   correctly return an error code if we fail while trying to recover from the
1675   removal of a target of a multi-target rule.
1677 * configure: Improve the clarity of the error given when none of the tools
1678   needed for any supported language are found.
1680 * configure: SWIG 1.3.32 has now been released, so require at least this
1681   released version for maintainer builds.
1683 Java:
1685 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
1686   GCC 4.3.
1688 * configure: Log the output of trying to compile conftest.java in config.log;
1689   if the test fails, report whether the failure was compiling or running the
1690   test program.
1692 * Check for directory existence rather than calling mkdir unconditionally as
1693   despite the "(ignored)", the error message seems to confuse some people.
1695 PHP:
1697 * Add feature test for XapianMultiValueSorter.
1699 * php/smoketest5.php: Fix use of Database_get_document to new style OO
1700   interface.  Fix the error reported when the PHP5 exception test fails.
1702 * php/smoketest.php: Add feature test to confirm that optional arguments to
1703   XapianQuery's "term" constructor are wrapped.
1705 Python:
1707 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
1708   these properties build a python list, so dropping the GIL isn't safe and
1709   may cause undefined behaviour in multithreaded environments.
1711 * configure: Update error message to reflect requirement for at least python
1712   2.2.
1714 * configure: Change "print foo" to "print(foo)" in python version checks, for
1715   compatibility with python 3.0.
1717 Ruby:
1719 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
1720   previously incorrect).
1722 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
1723   ruby/docs/index.html previously had a dead link to.
1725 Tcl:
1727 * configure: Overhaul code to find tcl.h since the old version no longer worked
1728   with Debian unstable.
1730 * tcl8/docs/index.html: Update documentation to cover flint and mention that
1731   quartz is now deprecated.
1733 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
1734   throws QueryParserError instead.
1736 Xapian-bindings 1.0.4 (2007-10-30):
1738 General:
1740 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
1741   Add feature tests for all languages.
1743 * The "bindings.html" file documenting each of the bindings has been renamed to
1744   "index.html".
1746 Packaging:
1748 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
1749   older distros.
1751 Portability:
1753 * Fix warnings when compiling with GCC 4.2.
1755 PHP:
1757 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
1758   and methods/functions which return a wrapped class.
1760 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
1761   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
1763 * Document how non-class functions are wrapped.
1765 * Fix wrapping of NumberValueRangeProcessor for PHP4.
1767 * smoketest.php: Split the regression test for bug#193 into separate
1768   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
1770 Python:
1772 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
1773   non-pythonic iterators.  Make it clearer that the "sequence API" is
1774   deprecated.
1776 * Add test of a custom ValueRangeProcessor (ie, one written in python).
1778 * Update the examples to use the new-style attributes to access MSet item
1779   values rather than the old-style MSET_* constants.
1781 * Document MSET_DOCUMENT.
1783 Ruby:
1785 * smoketest.rb: Rename test of metadata access methods which had been named the
1786   same as the matchdecider test due to a copy-and-paste error.
1788 Xapian-bindings 1.0.3 (2007-09-28):
1790 General:
1792 * Wrap new methods Database::get_metadata() and
1793   WritableDatabase::set_metadata().
1795 * "make uninstall" now removes the loadable module we install for each of
1796   the bindings.
1798 * "make distcheck" now works.
1800 * Distribution tarballs are now in the POSIX "ustar" format since it saves
1801   about 40KB and we need to use it for xapian-core anyway.
1803 Packaging:
1805 * RPMs: Package xapian.php.
1807 CSharp:
1809 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
1810   usefully used currently.
1812 Java:
1814 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
1815   C++ library.
1817 * "make clean" now removes the class files generated for inner classes.
1819 PHP:
1821 * Add feature test for DateValueRangeProcessor when used with QueryParser.
1823 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
1824   isn't actually very useful, since you can't subclass it in PHP currently.
1826 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
1827   if the third parameter was specified and a floating point number (e.g. 0.0).
1829 * php/docs/bindings.html: Fix errors in example code.
1831 Python:
1833 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
1834   Python which takes two strings and returns a 3-tuple (value_number,
1835   modified_begin, modified_end).  Previously this always failed with a
1836   type error, so this doesn't break existing code.
1838 * python/pythontest.py: Interpret any commandline arguments as a list of
1839   tests to be run (the default is to run all tests).
1841 * README,python/docs/bindings.html: Add a note about the problems with
1842   mod-python (as described in bug #185).
1844 * python/pythontest.py: Delete the database handles before deleting a database
1845   to fix problems running the Python tests on MS Windows (bug#179).
1847 * "make clean" now removes testsuite.pyc.
1849 Ruby:
1851 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
1852   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
1853   now the site-specific directories, which is more correct when building
1854   from source.  Debian packages, etc can override this by setting RUBY_LIB and
1855   RUBY_LIB_ARCH.
1857 Tcl:
1859 * Check for TCL_LIB in the environment or on the configure command-line to
1860   allow installing without root access more cleanly.
1862 Xapian-bindings 1.0.2 (2007-07-05):
1864 Documentation:
1866 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
1867   phpextdir.
1869 * Remove documentation of removed "--with-swig" configure option.
1871 General:
1873 * Add methods of NumberValueRangeProcessor for serialising and
1874   unserialising doubles.
1876 * Add methods and constants supporting spelling correction and synonyms.
1878 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
1879   to ensure that it works with uninstalled copies of Xapian.
1881 * Value of PYTHON_LIB supplied to configure is now respected - previously
1882   it was documented, but ignored.
1884 * Add support for supplying PHP_EXTENSION_DIR to configure.
1886 * Change to using "%include", rather than reproducing contents of header
1887   files, for "queryparser.h", "document.h" and "postingiterator.h".
1889 * Add new form of get_mset() which allows a matchspy matchdecider to be
1890   set.
1892 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
1893   explode.  Add in a missing "mv" in the command for installing tcl8
1894   documentation.
1896 CSharp:
1898 * Fix rule handling parallel make to include xapian_wrap.h
1900 PHP:
1902 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
1903   doesn't seem to be a standard location, but this works for Debian at
1904   least, and it seems better to at least try to install it.
1906 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
1907   prefix for PHP4.
1909 Python:
1911 * Fix a threading problem: the GIL was not being acquired in the exception
1912   handling code before setting the Python exception state, leading to
1913   various memory corruption symptoms in threaded programs.
1915 * Add special iterators to Database for synonyms, synonym_keys and
1916   spellings.
1918 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
1919   synonym iterators and spelling iterators.
1921 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
1922   the expected description to make the tests more readable.
1924 Xapian-bindings 1.0.1 (2007-06-11):
1926 Documentation:
1928 * NEWS: Fix the recent headings which said "Xapian-core" to say
1929   "Xapian-bindings".
1931 General:
1933 * Wrap Xapian::Query constructor for creating ValueRange queries.
1935 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
1936   which take a prefix.
1938 Packaging:
1940 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
1941   %{buildroot} prefix on most files which we then have to work around.
1943 CSharp:
1945 * SimpleIndex now uses Xapian.TermGenerator.
1947 * SimpleSearch now uses Xapian.QueryParser.
1949 * New SimpleExpand example.
1951 * Document explicitly how STEM_SOME constants are currently wrapped.
1953 * Update GetTermName() reference in documentation to GetTerm().
1955 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
1956   their CVS repo, and the fix should be in their 0.8.2 release.
1958 Java:
1960 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
1961   looked at, but in fact its value was read but ignored.  We now use it as the
1962   first place to look for jni.h.
1964 * configure will now automatically add an extra "-I" for the
1965   linux/solaris/win32 subdirectory which Sun's JDK requires.
1967 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
1968   "precious" so their values are preserved for when configure is automatically
1969   rerun.
1971 PHP:
1973 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
1975 * The PHP examples have been rewritten to be clearer and to make use of the
1976   new XapianTermGenerator class.
1978 Python:
1980 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
1982 * Add support for prefix-restricted pythonic allterms iterators.
1984 * Update documentation in a couple of places to refer to updated replacements
1985   for MSetIterator.
1987 * Change testsuite output to be more vim-friendly (vim should be able to jump
1988   to the right lines now).
1990 * __str__ on Xapian::Error now includes extra information in some cases (the
1991   error_string and context, if they are set).
1993 * python/smoketest.py: Eliminate uses of the legacy sequence API.
1995 * python/pythontest.py: The legacy sequence API is only supported for Python
1996   2.3 and later, so don't run tests for it when running under Python 2.2.
1998 * We now generate and install xapian.pyo as well as xapian.pyc.
2000 Ruby:
2002 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
2003   classes.
2005 * Add missing rename for the C++ TermGenerator::set_document() method so it can
2006   be used as "tg.document = doc" in Ruby.
2008 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
2010 Tcl:
2012 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
2013   feedback, based on C++ simpleexpand.cc.
2015 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
2016   TermGenerator class.
2018 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
2019   QueryParser class.
2021 * tcl8/docs/bindings.html: Document how constants are wrapped.
2023 * Update smoketest and examples to require version 1.0.0 - previously this
2024   required 0.9.6, which failed since TCL doesn't accept differing major
2025   version numbers.
2027 * pkgIndex.tcl is now generated by configure.
2029 Packaging:
2031 * The required automake version has been lowered to 1.8.3, so RPMs can now be
2032   built on RHEL 4 and SLES 9.
2034 Xapian-bindings 1.0.0 (2007-05-17):
2036 Documentation:
2038 * Document Unicode support for each language.
2040 * Assorted minor improvements and typo fixes.
2042 General:
2044 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
2045   it, for languages where SWIG supports directors.
2047 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
2048   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
2049   allows the "default_prefix" argument to be supplied, QueryParser flags
2050   FLAG_PURE_NOT and FLAG_PARTIAL.
2052 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2054 * Remove wrappers for deprecated features removed from the C++ API (see
2055   docs/deprecation.html in xapian-core for full details and upgrade
2056   information).
2058 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
2060 * QueryParserError is now a real error, so remove special handling for "const
2061   char *" exceptions.
2063 * Use a stamp file in "make" rules with multiple targets so that parallel
2064   make works.
2066 * configure: Now quotes $PYTHON, etc so that you can specify a program with
2067   arguments.
2069 * configure: If the user specifies a program which doesn't exist (e.g.
2070   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
2072 * configure: Disable probes for f77, gcj, and rc completely by preventing
2073   the probe code from even appearing in configure - this reduces the size of
2074   configure by 28% and should speed it up significantly.
2076 * configure: If the version check against the xapian-core version detects a
2077   mismatch, we now issue a warning rather than a hard error since if you're
2078   careful this can work.  The warning is issued late on in configure, so it's
2079   harder for the user to miss.
2081 * configure: The --with-swig option has been removed.  It no longer has a
2082   purpose as we now ship the files which are generated by SWIG.
2084 Portability:
2086 * The PHP bindings can now be built with MSVC for Microsoft Windows.
2088 CSharp:
2090 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
2091   than mcs to avoid segmentation faults at runtime due to unimplemented
2092   features in mcs.  Document this, and update configure to prefer gmcs.
2094 * The return type of MatchDecider::operator() is now `bool' rather than `int'
2095   (in line with the same change in the C++ API).
2097 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
2099 Java:
2101 * The Java bindings have been updated to use C++ replacements for deprecated
2102   methods, so they still build.  The Java wrappers still provide the old
2103   deprecated names for now though.  The longer term plan is to replace the
2104   hand-written JNI with SWIG generated wrappers (work has now begun on this)
2105   which is likely to require some API changes, and it seems more sensible to
2106   make any changes to align with C++ API changes at the same time.
2108 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
2109   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
2111 PHP:
2113 * Fix undefined behaviour in get_matching_terms().
2115 * Document the (existing) renaming of methods which are PHP reserved words
2116   (empty() to is_empty() and clone() to clone_object()).
2118 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2120 Python:
2122 * The Python bindings now throw exceptions as classes with a hierarchy which
2123   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
2124   base class inherits from the standard Python Exception class.
2126 * All Python methods which accept strings can now be passed either a unicode
2127   object or a simple string.  Strings are returned as simple strings: unicode
2128   input will be returned as utf-8 encoded output.  The documentation now
2129   contains a "Unicode" section.
2131 * The Python bindings should now be usable more efficiently from threaded
2132   Python applications since we now use SWIG's -threads option when generating
2133   them, so that the GIL is released during long-running Xapian operations
2134   (bug#137).
2136 * Most classes, methods, functions, etc now have docstrings which are either
2137   automatically extracted from the C++ documentation comments, or overridden by
2138   more appropriate versions.
2140 * Most of the Pythonic iterators now return an object instead of a sequence,
2141   which means they now lazily fetch the information which previously had to be
2142   fetched to put it in the sequence.  The old sequence API is supported for
2143   compatibility, but is scheduled for removal in Xapian 1.1.0.
2145 * Those Python iterators which have skip_to() methods now return the item
2146   skipped to, and next() will return the following item.  Previously, they
2147   returned None, and next() returned the item skipped to.  Several bugs in the
2148   skip_to() wrappers were fixed.
2150 * Because of the lazy access, some objects returned by iterators will raise
2151   an error if the lazy evaluation happens after the iterator has moved on
2152   (since the underlying Xapian API doesn't allow efficient access to the
2153   information in this situation).  The exact semantics are defined in the
2154   docstrings for each iterator.
2156 * Those Pythonic iterators which return only a list of terms now return
2157   simple strings, instead of a sequence or an object containing the term.  This
2158   is an incompatible change with earlier releases.  The affected iterators are
2159   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
2160   QueryParser.unstemlist.
2162 * The contents of an MSet can now be iterated in the standard Python way.
2163   The iteration will return MSetItem objects.  The __contains__ and __getitem__
2164   methods are also implemented, allowing the "in" and [] operators to work.
2165   MSet.__getitem__ is a synonym for MSet.get_hit.
2167 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
2168   so that lazy access to its attributes is supported.  MSetItem has some
2169   deprecated methods which mimic the MSetIterator interface to allow old code
2170   to work without modification until release 1.1.0.
2172 * MSetItem provides access to the collapse_key and collapse_count, which
2173   weren't accessible from the sequence returned by the iterators before this
2174   release.
2176 * Out-of-range access to MSets will now raise an IndexError - it used to
2177   cause undefined behaviour (usually a crash).
2179 * The Python testsuite is now much more extensive, and supports colour output
2180   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
2181   features are separated out, so that they can easily be removed when the
2182   features are removed.  The Python tests currently focus mainly on Python
2183   specific iterators and related functionality - general Xapian behaviour is
2184   tested by the C++ testsuite.
2186 * The pure Python code in the bindings now uses new-style classes, since we
2187   have required Python >= 2.2 since Xapian release 0.9.9.
2189 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
2190   instead.
2192 * The get_description() method which many classes support has been deprecated
2193   in favour of new more pythonic __str__ methods, so that the str() builtin can
2194   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
2196 Ruby:
2198 * We no longer regard the Ruby bindings as "beta quality", so remove the
2199   warning from their documentation.
2201 * Document that that C++ operator() becomes the method "call" in Ruby.
2203 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
2204   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
2206 Tcl:
2208 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2210 Xapian-bindings 0.9.10.1 (2007-04-04):
2212 PHP:
2214 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
2215   default parameters.  The most notable case was a missing Query constructor
2216   which meant that QueryParser was unusable.
2218 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
2219   (which mostly seems to mean the MS Windows version).
2221 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
2222   seems to mean the MS Windows version).
2224 * Add note to the documentation that PHP examples are written for CLI version
2225   of PHP, but that the bindings work with any version.
2227 * Add check to all PHP examples that they are being run under a CLI version of
2228   PHP.
2230 Python:
2232 * simpleexpand.py: Print each term's expand weight as a floating point value,
2233   not an integer.
2235 Ruby:
2237 * INSTALL: document how to install Xapian's Ruby bindings in your home
2238   directory.
2240 Xapian-bindings 0.9.10 (2007-03-04):
2242 Java:
2244 * Under Mac OS X, automatically look in the standard location for jni.h,
2245   and automatically rename the JNI library we build to ".jnilib", as is
2246   required by the OS X JVM.
2248 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
2249   to add the linux header directory to the include path when using this JDK.
2251 * Add missing default constructor for RSet class - it's not much use without
2252   this!
2254 * Fix Enquire.getESet() to actually work.
2256 * Fix bug in ESetIterator.hasNext().
2258 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
2260 * Fix memory leak with some JVMs in the "Query from array" constructor.
2262 * Fix memory leak in Enquire.setQuery().
2264 * SmokeTest.java: Add regression tests for RSet default constructor,
2265   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
2266   Add feature tests for Enquire.getQuery(), and to make sure we get passed
2267   the right document in a java subclass of MatchDecider.
2269 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
2270   respective variables are set.
2272 PHP:
2274 * Update the documentation to fix out-of-date information and document the
2275   differences between the PHP4 and PHP5 wrappers.
2277 * Update the examples to use the new Object Oriented API, and provide versions
2278   for both PHP4 and PHP5.
2280 * Add a "simpleexpand" example.
2282 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
2283   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
2284   new name, but keep the old name for now for backward compatibility.
2286 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
2287   interpreter - this works with PHP5.
2289 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
2290   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
2291   directory may not exist and "make install" will create it.
2293 * configure: If zend.h isn't found and configure was run with "--with-php",
2294   exit with an error rather than automatically disabling PHP support.
2296 Python:
2298 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
2300 Packaging:
2302 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
2303   various "--without" options in a comment at the start of the .spec file.
2305 * RPMs: Remove "." from the end of the Summary.
2307 Xapian-bindings 0.9.9 (2006-11-09):
2309 Documentation:
2311 * Ship our custom INSTALL file rather than the generic one from autoconf which
2312   we've accidentally been shipping instead since 0.9.5.
2314 General:
2316 * Wrap Flint::open() and Flint::open_writable().
2318 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
2319   suitable).
2321 Python:
2323 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
2324   bit platforms with Python 2.5.
2326 Packaging:
2328 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
2330 * RPMs: The Python bindings now require Python >= 2.2.
2332 Portability:
2334 * configure: Remove unnecessary backticks from tclsh version test.
2336 Xapian-bindings 0.9.8 (2006-11-02):
2338 General:
2340 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
2341   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
2343 * The C++ method QueryParser::parse_query() current throws "std:string"
2344   exceptions if there's a parse error.  Previously the bindings didn't catch
2345   these.  Now we catch them and handle them as if they were exceptions of
2346   type Xapian::QueryParserError (in anticipation of this changing in
2347   xapian-core).  Added testcases for this for PHP, Python, and C#.
2349 * configure: Note that SWIG is only useful for Xapian developers in --help
2350   output.
2352 * configure: If we failed to find any languages to build for, give a more
2353   helpful message.
2355 CSharp:
2357 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
2359 Java:
2361 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
2362   work rather than using the cached failure of the first jni.h check.
2364 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
2366 * SmokeTest.java: Avoid gcj "set but not used" warning.
2368 PHP:
2370 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
2372 * smoketest4.php,smoketest5.php: Check the exception message given by the
2373   DocNotFoundError testcase.
2375 Python:
2377 * Drop support for Python 2.1.
2379 Xapian-bindings 0.9.7 (2006-10-10):
2381 Documentation:
2383 * NEWS: Fix the recent headings which said "Xapian-core" to say
2384   "Xapian-bindings".
2386 General:
2388 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
2389   configure.ac.
2391 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
2392   compiling SWIG generated code which makes the compiled modules a few percent
2393   smaller and perhaps a little faster.
2395 * Wrap the newly implemented transaction API.
2397 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
2398   (this option was supposed to be used to compile the Python bindings from
2399   0.9.3 onwards, but this wasn't actually working correctly).
2401 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
2403 * In maintainer-mode, "make clean" now removes the SWIG generated files
2404   which would otherwise only be removed on "make maintainer-clean".
2406 CSharp:
2408 * Xapian::MatchDecider can now be subclassed in C#.
2410 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
2411   to use it.  This has been fixed and a regression test added.
2413 * SmokeTest.cs: Added exception handling test.
2415 Java:
2417 * Correct two misuses of delete to delete[].  Fixes bug#78.
2419 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
2420   Debian and Ubuntu boxes at least.
2422 PHP:
2424 * We now generate class wrappers for PHP5.
2426 * We now generate proxy classes for PHP4, which is an incompatible change
2427   from previous versions of xapian-bindings.  A perl script to upgrade
2428   your scripts is included.
2430 * smoketest.php:
2432   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
2433     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
2435   + Rely on xapian.php to load the extension module for us.
2437   + Fix error messages to show PHP code, not Python code.
2439 * When running smoketest.php, pass the "-q" option to php, which suppresses
2440   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
2441   recent versions of PHP.
2443 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
2444   the PHP interpreter not to be found in some cases when it was actually
2445   available, but it's only used to run the smoketest not for building the
2446   bindings.
2448 Python:
2450 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
2451   and also report the check and its result to the user.
2453 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
2454   built, so add an explicit dependency so that this works reliably in parallel
2455   builds.  Fixes bug#77.
2457 * In examples and documentation, don't call the MatchDecider class/object
2458   "matcher", since we use the term "matcher" to mean something else in
2459   the library documentation.
2461 * smoketest.py:
2463   + Add test of exception handling.
2465   + Add test that MatchDecider can be subclassed successfully.
2467 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
2468   pythonic iterator class.
2470 Ruby:
2472 * Xapian::MatchDecider can now be subclassed in Ruby.
2474 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
2475   (with no "ruby" alias) on Ubuntu dapper at least.
2477 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
2478   since we may have less than 10 matches, so say "1-<N>" instead.
2480 * simplematchdecider.rb: Implemented.
2482 Tcl:
2484 * Implement saner exception handling for Tcl and document it.
2486 * smoketest.tcl:
2488   + Add check that xapian::Query_OP_ELITE_SET has the right value.
2490   + Rework how the smoketest gets run to eliminate special code for using
2491     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
2492     to be run using installed bindings, and also makes it a better example
2493     program.
2495   + Add test for exception handling.
2497   + Send error messages to stderr.
2499   + Add comment about Tcl storing zero bytes as \xc0\x80.
2501 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
2503 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
2504   used for the Tcl bindings.
2506 Xapian-bindings 0.9.6 (2006-05-15):
2508 Documentation:
2510 * INSTALL: Add section describing how to install without root access.
2512 General:
2514 * Updated to reflect the renaming of Xapian::xapian_version_string and
2515   companions to Xapian::version_string.
2517 * Wrap optional length parameter to Enquire::set_query().
2519 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
2520   consistency.  Keep get_document_id as an alias for now for backward
2521   compatibility.
2523 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
2524   probably a largely harmless error).
2526 * Stop SWIG from adding exception handling wrappers to the calls which return
2527   version strings, since they can't throw exceptions.
2529 * xapian.i: Removed superfluous "const" from return type "docid" which is just
2530   a typedef for an unsigned integer type.
2532 * configure: Add some missing "checking ..." messages so the user has more idea
2533   what is going on.
2535 * Language specific util.i files can now define
2536   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
2537   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
2538   are provided for each language.  This avoids needing to keep this
2539   information in two different places.
2541 * xapian.i: Uncomment commented-out parameter names and fix duplicate
2542   parameter names (for the benefit of bindings which use the parameter names,
2543   like the OO PHP5 patch for SWIG I'm working on...)
2545 Portability:
2547 * configure: Fix warning flags passed for Intel C++ compiler.
2549 CSharp:
2551 * We now support building with Portable.NET.
2553 * Note that the passing of strings from C# into Xapian and back isn't currently
2554   zero byte safe.  If you try to handle string containing zero bytes, you'll
2555   find they get truncated at the zero byte.
2557 * C# bindings now build and pass tests when srcdir != builddir.
2559 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
2560   always say "CSharp" instead.
2562 * Not all machines are set up to run compiled C# programs when invoked
2563   directly, so get configure to check if we can, and otherwise see if using
2564   mono or ilrun works.  If not, just skip the C# tests.
2566 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
2567   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
2568   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
2570 * Move the C# specific %rename list to csharp/util.i.
2572 * Store the strong name key in the key container so we reuse it for later
2573   builds.
2575 * Wrap the version functions as more sensible names and document them (and
2576   continue to provide the older undocumented names for now just in case anyone
2577   was using them.)
2579 * Set the version of XapianSharp.dll correctly when building a snapshot from
2580   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
2582 * SmokeTest.cs: Add test of version functions.
2584 Guile:
2586 * The Guile bindings don't work and aren't being actively worked on, so we're
2587   no longer including them in the distributed tarball to avoid disappointing
2588   users who notice a "guile" subdirectory.  It also makes the download smaller.
2590 Java:
2592 * Simplify (and improve portability of) run-java-test by using "libtool
2593   --mode=execute"'s -dlopen option.
2595 * Need to make sure "built" subdirectory exists or building from clean fails.
2597 * Fix "make check" to work when srcdir != builddir.
2599 PHP:
2601 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
2602   4.3.10), so use "php -n" and then set the options we specifically want using
2603   "-d".
2605 * Fix the smoketest invocation to work better when srcdir != builddir.
2607 * Look for PHP interpreter first in prefix given by "php-config --prefix".
2609 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
2611 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
2613 * smoketest.php:
2615   + Add test for version reporting functions
2617   + If a test fails, say which one to aid debugging.
2619   + Added simple test that zero-bytes are handled correctly when passing
2620     strings to and from Xapian.
2622 Python:
2624 * README: Note that Python bindings have been built with MSVC.
2626 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
2627   to make them executable (they don't have a #! line).
2629 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
2630   "mymatchdecider".  Add description of what this example does.
2632 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
2634 * smoketest.py: Added simple test that zero-bytes are handled when passing
2635   strings to and from Xapian.
2637 Ruby:
2639 * Added new Ruby bindings from Paul Legato.
2641 Tcl:
2643 * smoketest.tcl:
2645   + Add test for version reporting functions
2647   + If a test fails, say which one to aid debugging.
2649   + Added simple test that zero-bytes are handled correctly when passing
2650     strings to and from Xapian.
2652 Xapian-bindings 0.9.5 (2006-04-08):
2654 Documentation:
2656 * HACKING,README: Split off HACKING to contain information which is only
2657   relevant to those wishing to modify the bindings.
2659 General:
2661 * SWIG-based bindings are now built with SWIG 1.3.29.
2663 * configure: Report which languages we're building bindings for just before
2664   configure finishes.
2666 * xapian.i: Make the stub definitions for disabled backends static.
2668 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
2669   message.
2671 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
2673 Packaging:
2675 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
2676   Python bindings to support 64 bit systems.
2678 * RPMs: Package the C# bindings.
2680 Portability:
2682 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
2683   different name.
2685 * configure: Detect Intel's C++ compiler and set suitable warning flags to
2686   avoid noise from compiling generated code.
2688 CSharp:
2690 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
2692 Guile:
2694 * configure: Disable --with-guile since Guile support doesn't currently work.
2696 Java:
2698 * Override deprecation warnings for Xapian methods/functions/etc.
2700 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
2701   have some idea what went wrong!
2703 * Rework how we include headers to get hash_map to avoid compiler warnings
2704   since it's usually not in the std namespace nowadays.
2706 * Previously the "all" target also ran the "install" target, but this has
2707   proved very problematic, so change "make check" to use the uninstalled JNI
2708   glue library, and update the instructions to say that "make install" is now
2709   required.
2711 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
2712   .class files.
2714 * README: Note that some platforms need "-pthread" or similar flags.
2716 * Add a new Query constructor wrapper which take an OP_xxx and an array of
2717   Query objects.
2719 * Compiling a .java file to a .class file now deletes the .jar file to ensure
2720   it gets updated.
2722 PHP:
2724 * php -n avoids reading any php.ini, but the compiled in default may be to
2725   enable the dubiously named "safe_mode" which prevents dl() being used so
2726   "make check" fails.  So instead provide a very simple php.ini which turns off
2727   safe_mode and makes sure enable_dl is on.
2729 * Fix handling of bool parameters when resolving overloaded methods and/or
2730   default arguments.  This fixes Enquire_sort_by_value() to work when the
2731   second argument is specified.  Added regression test for this case.
2733 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
2735 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
2736   passed by reference.  Fixes bug#74.
2738 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
2739   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
2741 Python:
2743 * Use the fairly new "swig -O" option for the "modern" python bindings as
2744   it generates a smaller glue library and runs faster.  Some of the features
2745   enabled also work on python 2.1, so enable these for the "olde" bindings.
2747 * configure: Catch the case where the user has python installed but not the
2748   module "distutils.sysconfig" and explain that they probably need to install a
2749   python-dev or python-devel package.
2751 * "make check" now works in VPATH builds.
2753 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
2754   know which check it was!
2756 * smoketest.py: catch Exception objects and print them.
2758 * smoketest.py: Add feature tests for the various pythonic iterator
2759   wrappers
2761 * python/docs/bindings.html: Document the Pythonic iterators.
2763 * Fix TermIter not to try to read termfreqs or positions if they aren't
2764   meaningful for the current TermIter.
2766 Xapian-bindings 0.9.4 (2006-02-21):
2768 Documentation:
2770 * COPYING: Updated FSF address.
2772 General:
2774 * Wrap Stopper::get_description().
2776 * Wrap xapian_version_string() and related functions.
2778 Portability:
2780 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
2781   run from "make" too.
2783 PHP:
2785 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
2786   default on Windows).
2788 Python:
2790 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
2792 Xapian-bindings 0.9.3 (2006-02-16):
2794 Documentation:
2796 * README: Updated and expanded (now covers supported platforms, and lists
2797   criteria which bindings for an additional language need to fulfil before
2798   we're likely to accept them).
2800 * INSTALL: Updated and improved.
2802 * TODO: Move C#-specific TODO to top level so we can track to-do items for
2803   all languages.
2805 General:
2807 * configure: Change how the user selects which bindings to build.  If no
2808   --with* arguments are passed, then we default to building bindings we detect
2809   the required tools for (as before).  But instead of requiring the user to
2810   deselect all bindings they don't actually want, we now let them select the
2811   bindings they do want.  So "./configure --with-python" will only build the
2812   python bindings (and will fail if the required tools aren't installed).
2814 * Every wrapped method contains exception handling code.  The bulk of this
2815   is now factored out into a single helper function, which cuts the compile
2816   time by around a factor of 3 and halves the size of the stripped library
2817   (figures are for Tcl on x86_64).
2819 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
2820   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
2822 * configure: Bump required SWIG version to 1.3.28 and drop the special
2823   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
2824   SWIG to install the bindings - SWIG is run by the Xapian developers
2825   so these updated requirements are only relevant if you want to modify
2826   the bindings.
2828 * Eliminate separate Makefile in each examples subdirectory, which makes the
2829   build system simpler, smaller, and a little faster.
2831 * xapian.i: Include default constructors for all classes so that SWIG knows it
2832   doesn't have to use SwigValueWrapper for them, which makes the bindings code
2833   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
2834   std::pair<...>.
2836 * configure: Document special environmental variables which configure
2837   recognises.  Enhance handling of environmental variables so you can
2838   e.g. './configure PYTHON=python23' (previously you had to give a full
2839   path in such environmental variables or they would be ignored.
2841 Packaging:
2843 * RPM spec file:
2845   + Automatically detect the python version.
2847   + Rename "php4" references to "php".
2849   + Automatically detect the PHP extension directory.
2851   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
2853   + Add support for "--without php" and --without tcl8" options to rpmbuild.
2855 Portability:
2857 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
2858   10.3.  This is required to link the bindings, and it doesn't seem to be
2859   possible to link them on 10.1 or 10.2 anyway.
2861 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
2862   to be explicitly specified and libtool correctly handles platforms where it
2863   would have been implicitly linked with anyway.
2865 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
2867 * configure: Add missing ";;" on the last alternative in some case statements.
2869 * Only pass -no-undefined on platforms where it is required in order to link a
2870   shared library at all (it causes problems on Mac OS X in some cases).
2872 CSharp:
2874 * This release includes a lot of improvements for the C# bindings.  They're
2875   now pretty much on a par with the other language bindings.
2877 * Added documentation and examples.
2879 * Method and function names are now renamed to match C# conventions
2880   (e.g. from get_description() to GetDescription()).  This is obviously an
2881   incompatible change, but the C# bindings haven't been suitable for real world
2882   use prior to this release.
2884 * Optional parameters are now wrapped so no longer need be specified
2885   explicitly.
2887 * Overload ++ and -- for iterators.
2889 * Overload == and != for iterators.  Now comparisons with the end iterator
2890   work as expected, and SmokeTest passes.
2892 * SmokeTest now reports exceptions verbosely.
2894 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
2895   similarly for other database factory functions.
2897 * Heed compatibility warnings from mcs and use different forms for
2898   command-line switches to the C# compiler (presumably for compatibility with
2899   Microsoft's compiler, though the warnings don't actually say that
2900   explicitly).
2902 Guile:
2904 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
2905   zero-byte safe.  The guile bindings are still a long way from actually
2906   working though.
2908 Java:
2910 * Wrap optional second parameter (query length) to Enquire::set_query().
2912 * configure now probes for the Java path separator, which we then use to
2913   separate entries in the java -classpath command line option so we can
2914   build on platforms where it isn't ":".
2916 * SmokeTest.java: Expand to test more features.
2918 * java/README:
2920   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
2922   + Add note about how wrapped methods are named.
2924 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
2925   validity check.
2927 * Query.java: Comment out unused code.
2929 * Fixed memory leak in Query-from-array-of-strings constructor.
2931 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
2932   Xapian::Error subclasses can tell you their typename directly (using
2933   get_type()).
2935 PHP:
2937 * Some problems with overloaded methods in PHP have been fixed by a major
2938   overhaul of SWIG's PHP support.  So we no longer rename such methods
2939   for PHP.  This is an incompatible change, but it's easy to update your
2940   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
2942 * Previously the documentation and simpleindex.php suggested that you
2943   should call delete_CLASS().  This was incorrect and resulted in a
2944   double-free() in some cases, so we've fixed the documentation and
2945   examples and eliminated the delete_CLASS() wrappers.  This is another
2946   incompatible change, but again easy to update for.
2948 * We now support PHP5 as well as PHP4, so the configure test now looks
2949   for either and all references to "PHP4" or "php4" have been adjusted.
2951 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
2952   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
2953   warning and making the method return "Null".  This isn't ideal, but it's
2954   the best we can easily do without proper exceptions.
2956 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
2957   empty php.ini in srcdir (which we were failing to distribute anyway), use
2958   "$(PHP) -n" which tells PHP not to use any php.ini file.
2960 * Update PHP documentation to include new features.
2962 * Redo Xapian section in phpinfo() to look more like most other modules.
2964 * You can now construct a Query object from an array of strings or Query
2965   objects (or even a mixture).
2967 * PHP examples now give a more useful error message if a database can't be
2968   opened.
2970 * smoketest.php: Expanded the tests performed, including feature tests for
2971   the new Query-from-list constuctor.
2973 * simplesearch.php: Use newly wrapped Query-from-list constructor.
2975 * Use std::string::data() instead of c_str() as it may be more efficient for
2976   some STL implementations.
2978 * Enquire::get_matching_terms() now generates the PHP list directly from the
2979   TermIterator rather than constructing a temporary C++ std::list, which is
2980   faster and requires less temporary memory.
2982 Python:
2984 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
2985   once again (it has been broken since 0.9.0).  Added a regression test to
2986   help keep this working.
2988 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
2989   instead of a list).  Also the sequence can contain xapian.Query objects or
2990   strings or a mixture.  Documented these enhancements.
2992 * smoketest.py: Expanded the tests performed.
2994 * Convert C++ strings to python ones in a zero-byte clean way.
2996 * Added more error checking of the results of calls into the python
2997   interpreter.
2999 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
3000   itself is compiled with this option to avoid problems and it appears we ought
3001   to use it too to avoid the risk of hitting the same problems, although I'm
3002   not aware of anyone actually encountering such problems).
3004 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
3005   avoid creating a broken xapian.pyc is the shared library can't be loaded for
3006   some reason.
3008 * Enquire::get_matching_terms() now generates the Python list directly from the
3009   TermIterator rather than constructing a temporary C++ std::list, which is
3010   faster and requires less temporary memory.
3012 Tcl:
3014 * Terms with a leading underscore now work (thanks to changes in SWIG).
3016 * Implement custom typemaps for Tcl, so that you can now construct a Query from
3017   a list of Query objects and/or strings, and Enquire::get_matching_terms is
3018   now wrapped.
3020 * simplesearch.tcl: Use the new Query from list constructor.
3022 * simplesearch.tcl: Fix to lowercase and stem query terms.
3024 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
3026 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
3028 Xapian-bindings 0.9.2 (2005-07-15):
3030 General:
3032 * Added wrappers for new optional flags argument to QueryParser::parse_query().
3034 CSharp:
3036 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
3037   another tool with the same name.
3039 Java:
3041 * Include SmokeTest.java in the distribution so "make check" works.
3043 * Added success report for Sun java 1.4.1_01a.
3045 Python:
3047 * When converting a python list to vector<string> we know the number of elements
3048   so reserve that number in the vector.
3050 Xapian-bindings 0.9.1 (2005-06-06):
3052 General:
3054 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
3056 Tcl:
3058 * Updated documentation to include information from Michael Schlenker about how
3059   to delete a database object such that the destructor gets called.
3061 Xapian-bindings 0.9.0 (2005-05-13):
3063 General:
3065 * Updated SWIG-based bindings to latest Xapian API
3067 * Improve support for building the bindings on MS Windows:
3069   + Provide stub versions of any backend functions which are disabled in the
3070     library we're wrapping to avoid a link failure on MS Windows (where the
3071     remote backend is automatically disabled).  These stubs just throw
3072     Xapian::FeatureUnavailableError.
3074   + Add -no-undefined to *_la_LDFLAGS.
3076   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
3077     appropriate.
3079   + For python, paths for finding headers and installing libraries are now
3080     handled so they work on MS Windows; an extra static library needs to be
3081     linked in too.
3083 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
3084   for disabled backends).
3086 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
3087   being useful functionality.
3089 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
3090   introduced in future get fixed.
3092 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
3093   have.
3095 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
3096   1.3.22 for as more recent versions don't work with methods with optional
3097   arguments - the arguments become non-optional!)
3099 Guile:
3101 * configure: Disable guile by default, as it needs more work.
3103 Java:
3105 * Updated to compile against 0.9.0 API.
3107 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
3109 * Wrap optional parameters to Query(term) constructor.
3111 PHP4:
3113 * For PHP4, rename default Database constructor to Database_empty
3114   instead of suppressing the much more useful Database(const string &path)
3115   constructor.
3117 * Use a blank config file when running PHP4 tests to avoid problems
3118   when the bindings are already installed as an extension which is
3119   loaded automatically in the default config.
3121 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
3122   it probably just means it's not in PATH.  We only need it for running tests,
3123   so substitute a trivial shell script which just exits with code 77 so PHP
3124   tests are skipped (previously we substituted "missing" which caused the tests
3125   to fail).
3127 Python:
3129 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
3130   and ValueIter.
3132 * configure: If python is found, also check that Python.h exists (it may not be
3133   if the python-dev package (or similar) isn't installed).
3135 Xapian-bindings 0.8.5.1 (2005-02-23):
3137 General:
3139 * configure: Run compiler feature tests using the C++ compiler, not the C
3140   compiler.
3142 * Allow bindings version to have an extra "patchlevel", yet still match with
3143   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
3145 Java:
3147 * Added a missing .java source file and removed several unused ones.
3149 * Fixed several glitches in the java bindings automake build system.
3151 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
3152   warnings in generated code (we were carefully passing "-Wunused"
3153   which is the opposite of what is needed!)
3155 * Fixed a couple of warnings from GCJ.
3157 * Wrapped a few missing methods added since Eric created the bindings.  There
3158   are still some missing methods - there's now a (probably incomplete) list in
3159   java/README.
3161 * Added various useful bits of information to java/README.
3163 * Tweaked SimpleSearch.java to be more like the C++ version.
3165 PHP4:
3167 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
3168   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
3169   a more recent version.
3171 * configure: Check for "php" as a program name as well as "php4", and
3172   fall-back to missing so the error message from "make check" is better.
3174 Xapian-bindings 0.8.5 (2004-12-23):
3176 General:
3178 * INSTALL: Added non-generic installation instructions.
3180 Python:
3182 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
3183   the same directory as xapian.py, but Makefile.am was looking in current
3184   directory when installing it.  Additionally, VPATH builds were broken.
3185   These problems were introduced by changes in 0.8.4.
3187 Xapian-bindings 0.8.4 (2004-12-08):
3189 General:
3191 * README: Now clearly says which languages we currently support, which people
3192   are working on, etc.
3194 * Instead of requiring the user to have a really recent SWIG installed, ship
3195   the files SWIG generates.  Disable all the SWIG rules unless configure is run
3196   with --enable-maintainer-mode to make sure they aren't triggered accidentally
3197   (e.g. by make with dodgy VPATH).
3199 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
3200   needed if you just want to install the bindings).
3202 * Wrap the new Database and WritableDatabase constructors which replace
3203   Auto::open().
3205 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
3206   (for example, simpleexpand.py needs it).
3208 * In the Query constructor which takes a vector of terms, only call set_window
3209   if window is non-zero.  Otherwise things go wrong if we're passed an empty
3210   vector.
3212 * Second argument to Document::add_posting() isn't optional, but xapian.i
3213   indicated that it was.
3215 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
3216   Deriving your own weight class in the scripting language isn't currently
3217   supported.
3219 * xapian.i: %name is deprecated, so use %rename instead.  This also works
3220   around a bug in SWIG 1.3.23.
3222 * configure: Removed pointless probe for a C compiler - everything we compile
3223   is C++.
3225 * configure: Reinstated the check that the bindings version matches the version
3226   of the xapian library.  It was added in 0.8.2, but accidentally removed in
3227   0.8.3.
3229 * Use newly added option `xapian-config --swigflags` which (a) avoids always
3230   passing -I/usr/include which could cause problems if we're using a Xapian
3231   install not in /usr and there's another one in /usr and (b) avoids problems
3232   if `xapian-config --cxxflags` contains flags other than -I<something>.
3234 CSharp:
3236 * Richard Boulton has put together bindings for C#.  These build successfully
3237   with the Mono tools, but the smoketest currently fails.  Unclear if the
3238   problem is the bindings or the smoketest code.
3240 Guile:
3242 * The guile bindings now build successfully, so we've enabled the guile
3243   detection machinery in configure.  They're untested though (we don't
3244   know guile!) so success or failure reports are encouraged!
3246 PHP4:
3248 * Mention the example scripts near the start of the documentation, not right at
3249   the end.
3251 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3252   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3253   mention!
3255 Python:
3257 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
3258   work in Python.
3260 * Changed examples to use the newly wrapped Query from list of terms ctor.
3262 * Mention the example scripts near the start of the documentation, not right at
3263   the end.
3265 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
3266   SWIG.
3268 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3269   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3270   mention!
3272 * Mention simpleexpand example in documentation.
3274 * Examples now report messages for Xapian exceptions.
3276 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
3278 * Make the example MatchDecider exclude documents matching a value, rather than
3279   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
3280   don't want examples to mislead like that.
3282 * python/docs/bindings.html: Note that you can construct a query
3283   from a list of terms, even if you can't from a list of queries.
3284   Add HTML links to the examples.
3286 * simpleindex.py: Trim spaces from the start as well as from the end of each
3287   line.  Simplify the loop slightly.
3289 Tcl:
3291 * Wrap in a tcl8 namespace "Xapian".
3293 * Added a smoketest.
3295 * Translated simpleindex and simplesearch into Tcl.
3297 * Set the Tcl package version.
3299 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
3301 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
3303 * Added documentation for tcl8 bindings.
3305 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
3306   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
3307   version (was 8.0).
3309 * configure.ac: Noted that the bindings can easily be compiled for use with
3310   Tcl 8.0, in case anybody needs that for some reason.
3312 * Don't wrap the factory functions which return a quartz WritableDatabase as
3313   the destructor never gets called so changes aren't flushed and the lock file
3314   isn't removed.
3316 Xapian-bindings 0.8.3 (2004-09-20):
3318 General:
3320 * Fixed mismatching versions of libtool used to produce configure and
3321   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
3322   names.
3324 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
3325   PHP4, and Tcl bindings.
3327 Java:
3329 * Pass -classpath to javac to fix build problems.
3331 * Make sure errors subdirectory is built before we try to build the jar file.
3333 * Fixed "make install" to not give libtool error.
3335 PHP4:
3337 * Include PHP4 documentation and exmples in the tarball.
3339 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
3340   change from 0.8.2 - it turns out we only need to pass these flags if we use
3341   swig's -noruntime option (which we don't do).
3343 Python:
3345 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
3346   faster Python wrapper code.
3348 Tcl:
3350 * Don't install xapian.la.
3352 * Improved configure check for tcl.h to work with Fedora Core 2.
3354 Xapian-bindings 0.8.2 (2004-09-13):
3356 General:
3358 * Added wrappers for recently added methods: ESet::back() and
3359   Database::get_lastdocid(), and wrap the new optional third parameter
3360   to Enquire::set_sorting().
3362 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
3364 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
3366 * Wrap Quartz, InMemory, and Remote database factory functions as
3367   quartz_open(), inmemory_open(), and remote_open().
3369 * Added missing wrappers for static Stem::get_available_languages() and
3370   Stem::get_description().
3372 * Wrap renamed method Query::empty() (was Query::is_empty()).
3374 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
3375   as an alias for now).
3377 * Require autoconf 2.59 and automake 1.8.5.
3379 * configure: Added check that the bindings version matches the version of
3380   the xapian library.
3382 * configure: Check if we're using GCC and only pass GCC specific warning
3383   control options if we are.
3385 * configure: When running with GCC, also pass -Wno-uninitialized so the
3386   SWIG glue builds without warnings.
3388 * README: Updated list of languages which SWIG supports.
3390 PHP4:
3392 * Document that the 2 argument form of Xapian::Auto::open() for opening a
3393   writable database is wrapped as open_writable() (bug #32).
3395 * Include Xapian version in output from phpinfo().
3397 * Build the SWIG glue library like we build the others rather than using
3398   SWIG's -phpfull option.  This avoids problems with newer automake versions
3399   and means we can build against an uninstalled xapian library.
3401 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
3402   Fixed documentation of how Xapian::Query::OP_* are wrapped.
3404 * Use special SWIG PHP ldflags when linking the PHP glue library.
3406 * simplesearch.py now works with multi-term queries.
3408 * Added documentation on how to install the PHP4 bindings.
3410 * Added a simple testcase to at least ensure the PHP4 bindings can be
3411   initialised and some simple operations work.
3413 Python:
3415 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
3417 * Don't install _xapian.la and _xapian.a.
3419 * Byte compile xapian.py to xapian.pyc and install it.
3421 * Suppress SWIG warning about MatchDecider::operator() director discarding
3422   const.
3424 * "make clean" no longer leaves "xapian_wrap.h" behind.
3426 * Added a simple testcase to at least ensure the python bindings can be
3427   initialised and some simple operations work.
3429 Tcl8:
3431 * configure: Disable building tcl8 bindings if the headers are missing
3432   (probably because the tcl8.X-dev package isn't installed).
3434 Xapian-bindings 0.8.1 (2004-06-30):
3436 General:
3438 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
3440 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
3441   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
3442   doesn't emit -I/usr/include in this situation (because it causes problems
3443   with some GCC versions).
3445 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
3446   not just a subset.
3448 Java:
3450 * Removed wrappers for unused error classes which have been pruned from C++.
3452 * Make finalize() methods of Database and WritableDatabase public so they can
3453   be called from by the user.
3455 * Document Document.add_term_nopos() as deprecated.
3457 PHP4:
3459 * Make sure that PHP bindings build a module which exports get_module() so PHP
3460   is able to load it.
3462 * Configure now checks that phpize can actually be run, rather than just that
3463   it's executable (test -x isn't portable anyhow).
3465 * Added basic documentation and examples to PHP4 bindings.
3467 * Rename overloaded methods and constructors.
3469 * Add simple access to the prefixes map in QueryParser.
3471 * Correct simpleindex ports to never generate empty termnames.
3473 Python:
3475 * configure: Use $PYTHON instead of python when running python to determine
3476   library and include paths and version number.
3478 * Actually ship python examples and documentation.
3480 Xapian-bindings 0.8.0 (2004-04-20):
3482 * README: Started collecting information on supporting Xapian from even
3483   more languages.
3485 * Added configure tests to enable bindings only where the necessary tools
3486   are installed and have a supported version.  ./configure --without-LANGUAGE
3487   allows particular languages to be forcibly disabled.
3489 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
3491 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
3493 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
3494   have been well tested, but integration with the xapian-bindings configure
3495   system hasn't been tested at all - please alert us to any problems.
3497 * Xapian can now be used from TCL.
3499 * Python: MSet now provides a Python iterator.
3501 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
3503 * Python: enable directors for MatchDecider, to allow subclassing in Python.
3505 * Python: Added basic documentation, and some examples.