Update NEWS files with entries from 1.2.22
[xapian.git] / xapian-bindings / NEWS
blob06918861e38540767bad6d79d0a67e53a809a219
1 up to: b90c3ddb03eac37da64a07bd95efe38cb78910a8
3 Xapian-bindings 1.3.4 (2015-12-28):
5 This release includes all changes from 1.2.22 which are relevant.
7 Documentation:
9 General:
11 * Wrap new and changed features in C++ API.
13 * PostingSource set_maxweight() is now accessible to the bindings.  Fixes #498,
14   reported by Richard Boulton.
16 * configure script now defaults to looking for xapian-config-1.3.  This is now
17   automatically done for development series (odd middle component of the
18   version number), but not for stable series (even middle component).  Fixes
19   #695, reported by Jorge C. Leitão
21 Packaging:
23 Portability:
25 CSharp:
27 Java:
29 Lua:
31 Perl:
33 PHP:
35 * Make PHP 5.5 the minimum officially supported version, as 5.4 has now reached
36   EOL.
38 * In the examples, when iterating an MSet with foreach, don't throw the docid
39   away as $dummy, put it in $docid and use it - the code looks cleaner, and
40   this avoids an extra call to C++ to get the docid on each iteration.
42 Python:
44 * Drop support for Python 2.5.
46 Python3:
48 * Document installation of Python 3 bindings.  Fixes #694, reported by Jorge C.
49   Leitão.
51 * Fix testsuite for changes in Python 3.5.  Fixes #690, patch from UsusDei.
53 * Handle renaming of .pyo to .opt-1.pyc files due to PEP-0488.  Fixes #689,
54   patch from UsusDei.
56 * Fix Python 3 version check to accept 3.10.
58 Ruby:
60 Tcl:
62 Xapian-bindings 1.3.3 (2015-06-01):
64 This release includes all changes from 1.2.20-1.2.21 which are relevant.
66 Documentation:
68 * INSTALL: IRIX is past EOL so drop information about IRIX make.
70 General:
72 * Add DB_RETRY_LOCK as a constant to wrap.
74 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
76 * Fix "make install" from a git tree configured with --disable-documentation.
77   (Fixes #658, reported by German M. Bravo)
79 * Fix "make install" when building from git with --disable-documentation.
81 * Fix to handle a VPATH build from a tarball when the generated docs will be in
82   $(srcdir).
84 * Update testcases for lazy wildcard expansion change in xapian-core.
86 * Update for addition of XAPIAN_NOEXCEPT.
88 * Don't wrap internal methods of Xapian::Weight.
90 Portability:
92 * Require a compiler with good C++11 support, like xapian-core now does.
94 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
95   doxygen.
97 * configure: Update check for -fvisibility to match xapian-core's.
99 CSharp:
101 * Fix configure test for whether $CLI can run CSharp programs - previously it
102   would always fail, which would mean that the CSharp tests wouldn't be run on
103   platforms where CSharp programs can't be run directly.
105 Java:
107 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
109 Lua:
111 * The Lua bindings are no longer considered to be "experimental" (in reality
112   they haven't been for some time).
114 Perl:
116 * Add a "LICENSE" section to the main POD.
118 * Add 'use strict' to all testcases, and add missing instances of 'my' that
119   this change uncovered.
121 * Wrap new WILDCARD_LIMIT_* constants as constants.
123 Python:
125 * Don't release the GIL when constructing a Query object from a sequence of
126   Query objects and/or strings.
128 * python/smoketest.py: Add new testcase to catch any internal functions,
129   methods, constants, etc which have accidentally been wrapped.
131 Python3:
133 * The Python3 bindings are no longer considered to be "experimental".
135 * Don't release the GIL when constructing a Query object from a sequence of
136   Query objects and/or strings.  (fixes #346)
138 * python3/pythontest.py: Expand comment about disabling test_import_star under
139   threads.
141 Tcl:
143 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
144   version added ::tcl::pkgconfig, which makes the configure tests simpler and
145   more reliable.
147 * Adjust precedence of the typecheck typemap for wrapping constructing a query
148   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
149   constructor correctly.
151 Xapian-bindings 1.3.2 (2014-11-24):
153 This release includes all changes from 1.2.16-1.2.19 which are relevant.
155 Documentation:
157 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
159 * Update for deprecation of Xapian::Chert::open().
161 * Update for renaming of "brass" backend to "glass".
163 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
164   updated" information isn't all that informative anyway - there can still be
165   stale information even if the file was updated very recently.
167 General:
169 * Releases and snapshots are now bootstrapped using a more recent version of
170   SWIG (a git snapshot from after the 3.0.3 release).
172 * configure: Fix SWIG version check to accept 3.x, and update the minimum
173   accepted version to be what we actually currently want.
175 * Wrap new C++ API features, and in particular all the new weighting schemes,
176   the changes to opening databases, and Xapian::Snipper.
178 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
179   argument which the C++ API takes.  If opts != 0, then output is sent to
180   stdout, otherwise no output is produced.
182 * Object descriptions are now always valid UTF-8. (see #620)
184 * Provide a SimpleStopper constructor which provides the ability to initialise
185   from a stopword list in a file.  Based on patch from Assem Chelli.
187 CSharp:
189 * README: Note that C# bindings now need .NET 2 or later (because that's what
190   SWIG-generated code now requires).
192 Java:
194 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
195   Anish Kanchan.  (see #616, reported by "Naveen")
197 Lua:
199 * Document that constants can now be accessed using CLASS.CONSTANT as well as
200   CLASS_CONSTANT.
202 Perl:
204 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
205   overlap with the hand-coded XS 'Search::Xapian' module.
207 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
208   during parallel builds.
210 * Use croak_sv() or ERRSV if defined.
212 PHP:
214 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
215   reached EOL.
217 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
218   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
219   `foreach ($it as $c)` works and allows iterating through the equivalent of
220   C++ operator* on the iterator.  (fixes#652)
222 * Fix handling of an exception thrown from a PHP implementation of
223   FieldProcessor::apply().
225 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
226   weight threshold.
228 * In current PHP releases, dl() is disabled in most SAPIs, and even where
229   available it will now only look in the configured extension directory.  The
230   upshot is that there no longer seems to be a sane way to install the PHP
231   bindings without being root.  Fixes #661, reported by Felix Ostmann.
233 Python2:
235 * The python testsuite already tested if any constants weren't marked with
236   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
237   clearly point to the actual problem.  Now we report the names of any
238   such constants.
240 * In the testsuite, use the xapian.WritableDatabase constructor rather than
241   chert_open() - that code dates back to when chert was the only disk-based
242   backend to support valuestreams, but flint was the default backend.
244 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
245   Germán M. Bravo in github PR59.
247 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
249 Python3:
251 * Python 3 support has been split off into its own subdirectory, and should now
252   be usable.  3.2 is the minimum supported version currently.  Existing code
253   will need updating for Python 3, and the wrapped API is necessarily different
254   in how Unicode is handled, so we've dropped deprecated features (such as
255   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
257 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
258   Germán M. Bravo in github PR59.
260 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
262 Ruby:
264 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
265   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
266   picking ruby 1.6.
268 Xapian-bindings 1.3.1 (2013-05-03):
270 This release includes all changes from 1.2.10-1.2.15 which are relevant.
272 Documentation:
274 * HACKING: Document Debian packages needed for each language.
276 General:
278 * Wrap new C++ API features.
280 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
281   unnecessary exception handling code where we call such functions and
282   methods.
284 * Tweak wrapping of Query from list constructor so the needed number of
285   elements get preallocated.
287 * Ignore Query(Query::Internal&) constructor, which is for internal use
288   only.
290 * For all languages except C# and Java, wrap the functions declared in
291   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
292   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
293   languages.
295 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
296   dependencies, and adjusts the generated dependencies to work in our build
297   system.
299 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
300   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
301   V=1' and 'make V=0' which are broadly equivalent and more standard.
303 * Fix the tests to work with the new automake parallel test driver.
305 Portability:
307 * Improve workaround which allows building against an uninstalled xapian-core
308   on OS X - this should now work with any uninstalled xapian-core (not only in
309   a tree with the same layout as an SVN or git checkout) and it also won't try
310   to build against "../xapian-core/.libs" just because it happens to exist.
311   (Fixes #322)
313 CSharp:
315 * configure: The variable to specify the interpreter is now CLI (was MONO, but
316   didn't actually work properly).
318 Java:
320 * Document that we aim to support JDK 1.6 (Java 6) and later.
322 * Avoid generating a temporary C++ vector of Query objects when constructing
323   a Query from a Java array of Query objects or a Java array of strings.
325 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
326   ValueIterator, and TermIterator.
328 * Add Enquire.getMatchingTerms().
330 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
331   building, e.g. "make JAVACFLAGS=-g".
333 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
334   with (the rather elderly) ECJ 3.3.1.
336 Perl:
338 * Fix PostingIterator wrapper to work.
340 * Update list of unwrapped things in POD documentation.
342 * Improve test coverage.
344 * perl/t/10query.t: Adjust regexp which checks expected error message to work
345   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
347 * Probe for the test running tool 'prove' in configure.
349 PHP:
351 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
352   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
353   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
354   compiled PHP module by 6%.
356 * php/smoketest.php: Add more tests of geospatial API.
358 Python:
360 * Drop support for Python 2.4.
362 * python/smoketest2.py: Add more testcases.
364 * python/smoketest2.py: Improve reporting of test failures for certain
365   testcases.
367 * Update Python 3 tests from Python 2 versions using 2to3.
369 Xapian-bindings 1.3.0 (2012-03-14):
371 Documentation:
373 * In maintainer builds, run doxygen to generate XML for the bindings in the
374   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
376 General:
378 * Wrap new geospatial API.
380 * Wrap new database checking API.
382 * Deprecated features scheduled for removal in 1.3.0 have been removed.
384 * Wrap ExpandDecider even if we don't have director support - there's a
385   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
386   needs some typemap work to actually get it usefully wrapped.
388 * configure:
390   + Add --disable-visibility option to match xapian-core.
392   + Add -fshow-column for GCC.
394   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
395     variable, so that it's easy to override it if you're getting a new warning
396     from SWIG but want to just ignore it for the time being.
398 * Exception handling now uses Error::get_description() rather than get_type +
399   ": " + get_msg().  In many cases this is the same, but if context or errno
400   are available, get_description() includes them.  Catch and report
401   std::exception rather than handling it as an unknown error (so in particular
402   std::bad_alloc will now be reported more helpfully).
404 CSharp:
406 * Avoid generating unwanted wrapper sources
407   SWIGTYPE_p_std__vectorT_std__string_t.cs and
408   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
410 Java:
412 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
413   bindings promoted in their place.  This means almost the entire C++ API is
414   now wrapped for Java, but the downside is there are some changes required
415   to existing code.  Overall we feel the short-term pain is worth the long
416   term benefits of having Java bindings which stay up to date.
418 * java/SmokeTest.java: Add test that string passing is zero byte safe.
420 Lua:
422 * Improve error messages.
424 Perl:
426 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
427   Perl 5.14.
429 * Fix Search::Xapian::Query->new() to work.
431 * Enable warnings for all test cases and make them fatal.
433 * Add "use Carp;" where we use functions from that module.
435 * Improve POD docs for Document and TermGenerator methods - "weight" is
436   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
438 * The Query constructor which takes an array of subqueries is now wrapped more
439   efficiently - previous a temporary C++ std::vector was built but now we avoid
440   doing this.
442 PHP:
444 * PHP >= 5.3 is now required.
446 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
448 * The XapianQuery constructor which takes an array of subqueries is now
449   wrapped more efficiently - previous a temporary C++ std::vector was built
450   but now we avoid doing this.
452 Python:
454 * Python >= 2.4 is now required.
456 * Remove deprecated Stem_get_available_languages().
458 * Hide away the deprecated non-pythonic iterators - we still need them to
459   implement the pythonic iterators, so we can't entirely remove them.
461 * Replace SWIG's thread locking with code which does nothing unless threads
462   are already initialised, to avoid the overhead of thread locking in the
463   common case of single-threaded Python code.  This seems to be about 5-10%
464   faster for pythontest2.py modified to repeat the tests 100 times.
466 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
467   #364.
469 * The Query constructor which takes an array of subqueries is now wrapped more
470   efficiently - previous a temporary C++ std::vector was built but now we avoid
471   doing this.
473 Ruby:
475 * The XapianQuery constructor which takes an array of subqueries is now
476   wrapped more efficiently - previous a temporary C++ std::vector was built
477   but now we avoid doing this.
479 Tcl:
481 * The XapianQuery constructor which takes an array of subqueries is now
482   wrapped more efficiently - previous a temporary C++ std::vector was built
483   but now we avoid doing this.
485 Xapian-bindings 1.2.22 (2015-12-29):
487 Documentation:
489 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
490   'git cherry-pick' from working as it should.  The git repo history should be
491   sufficient for complying with GPLv2 2(a).
493 General:
495 * Stop wrapping internal methods of Xapian::Weight.
497 * Return Error::get_description() rather than get_type + ": " + get_msg().  In
498   many cases this is the same, but if context or errno are available,
499   get_description() includes them.
501 * Catch and report std::exception rather than handling it as an unknown error
502   (so in particular std::bad_alloc will now be reported more helpfully).
504 CSharp:
506 * Fix configure test for whether $MONO can run CSharp programs - previously it
507   would always fail, which would mean that the CSharp tests would only be run
508   on systems where CSharp programs can be run directly.
510 Lua:
512 * Send stderr from lua version check to config.log instead of letting it appear
513   on the terminal.
515 PHP:
517 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
519 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
520   constructors now work.
522 Python:
524 * Add new testcase to catch any internal functions, methods, constants, etc
525   which have accidentally been wrapped.
527 Xapian-bindings 1.2.21 (2015-05-20):
529 Lua:
531 * README: Remove note about the Lua bindings being experimental - it's not
532   really been true for some time now.
534 Perl:
536 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
538 * Add workaround for Perl defining a seed() macro which breaks compilation with
539   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
540   classes with a method called seed).
542 * Update list of unwrapped things in POD documentation.
544 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
545   during parallel builds.
547 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
549 * Add test that we can create all the stemmers returned by
550   Stem::get_available_languages().
552 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
553   likely due to external reasons, like incompatible compiler flags being taken
554   from Perl's Config module, due to Perl having been built with a different
555   compiler to Xapian.
557 * Use croak_sv() or ERRSV if defined.
559 PHP:
561 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
562   was fixed in 1.2.19.
564 Python:
566 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
567   stable release 1.4.0.
569 Ruby:
571 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
573 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
574   https://bugs.debian.org/782270
576 Xapian-bindings 1.2.20 (2015-03-04):
578 Portability:
580 * configure: Avoid using \? in sed command in Lua detection - it isn't
581   supported by all sed implementations.
583 Lua:
585 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
586   being specified without a leading '.'.
588 * configure: Add an example of specifying LUA_SO to --help output.
590 PHP:
592 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
593   1.2.19.
595 * In current PHP releases, dl() is disabled in most SAPIs, and even where
596   available it will now only look in the configured extension directory.  The
597   upshot is that there no longer seems to be a sane way to install the PHP
598   bindings without being root, so update the documentation to reflect this.
599   Fixes #661, reported by Felix Ostmann.
601 Xapian-bindings 1.2.19 (2014-10-21):
603 PHP:
605 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
606   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
607   Gottfried)
609 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
610   which were getting incorrectly wrapped such that they didn't actually do
611   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
612   reference tracking fix in 1.2.14.
614 Ruby:
616 * README: Note that Ruby 2.1 works too.
618 Xapian-bindings 1.2.18 (2014-06-22):
620 Documentation:
622 * README: Add links to Erlang and Node.js bindings.
624 Lua:
626 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
627   expected), which most of the calls already used, and fix up the few calls
628   which passed (expected, got).
630 PHP:
632 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
633   that MatchDecider returns an MSet with the expected docid in.  Luckily this
634   wasn't masking a test failure.
636 Python:
638 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
639   - chert is the default backend now, and both chert and brass support the
640   required functionality for the tests which do this, so this just needlessly
641   causes the tests to fail if chert is disabled in xapian-core.
643 * configure: If the Python version is too new or too old, only report it once
644   not twice.
646 Ruby:
648 * configure: Fix Ruby bindings to build on Windows (and other platforms where
649   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
651 Xapian-bindings 1.2.17 (2014-01-29):
653 Portability:
655 * Improve workaround which allows building against an uninstalled xapian-core
656   on OS X - this should now work with any uninstalled xapian-core (not only in
657   a tree with the same layout as an SVN or git checkout) and it also won't try
658   to build against "../xapian-core/.libs" just because it happens to exist.
659   (Backported from 1.3.1; fixes #322)
661 Python:
663 * configure: Some distros now point /usr/bin/python at Python 3, so the check
664   for a Python 2 interpreter now checks for 'python2' first, and checks that
665   the version of found interpreter is 2.x.
667 Ruby:
669 * Tweak configure to work with Ruby 2.0.
671 Tcl:
673 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
674   in http://bugs.debian.org/724830).
676 * Use a better check for TCL_INC for Tcl 8.5 and later.
678 Xapian-bindings 1.2.16 (2013-12-04):
680 Documentation:
682 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
684 General:
686 * Compress source tarballs with xz instead of gzip.
688 * configure: Handle git snapshot naming.
690 Portability:
692 * configure: Update list of platforms where we tell libtool not to link in
693   deplibs to match the list used for xapian-core.
695 Perl:
697 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
698   GCC 4.7 warning).
700 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
701   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
703 PHP:
705 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
706   with a message explaining this.
708 Python:
710 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
712 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
714 * pythontest.py: Fix testcase checking we get an exception from using
715   non-random-access iterators after then have advanced - previously these
716   didn't actually test as fully as intended.
718 Ruby:
720 * Omit internal classes and methods from the rdocs.
722 Xapian-bindings 1.2.15 (2013-04-16):
724 General:
726 * Fix configure --enable-quiet option to actually work for the bindings.
728 Perl:
730 * Fix doc typo: "as as" -> "as a"
732 Ruby:
734 * Fix deprecation warning in configure from Ruby 1.9.3.
736 Xapian-bindings 1.2.14 (2013-03-14):
738 Python:
740 * Fix typo in doccomment.
742 PHP:
744 * Keep references to the PHP wrapper object when an object is set on another
745   object.  (fixes #614)
747 Tcl:
749 * Allow TCL_INC to be passed to configure.  (fixes #612)
751 Xapian-bindings 1.2.13 (2012-11-09):
753 CSharp:
755 * configure: Overhaul checks for C# tools to use modern names in preference.
757 Lua:
759 * Fix examples to use str(query) to get the query description.  (Fixes #600)
761 * Document that get_description() is mapped to str(), and end() to _end().
763 * Fix functor wrappers which return strings to be zero-byte clean.
765 Perl:
767 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
768   1.2's XS Search::Xapian.  (ticket#607)
770 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
771   is deprecated.
773 PHP:
775 * Document that subclassing Xapian classes in PHP currently doesn't work with
776   PHP 5.4.
778 Xapian-bindings 1.2.12 (2012-06-27):
780 No changes since 1.2.11 except to bump the version - this release was made to
781 fix an incorrect library version information update in xapian-core 1.2.11.
783 Xapian-bindings 1.2.11 (2012-06-26):
785 General:
787 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
789 Perl:
791 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
792   av_fetch() (spotted due to GCC 4.7 warning).
794 PHP:
796 * Fix "make check" to work for PHP when building from a release tarball with
797   srcdir != builddir.
799 * Work around "undefined symbol: zend_error_noreturn" error.
801 Xapian-bindings 1.2.10 (2012-05-09):
803 CSharp:
805 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
806   us to do this instead of setting them in AssemblyInfo.cs.
808 * Use diff's -c option when comparing the files SWIG generated against those we
809   were expecting to get as the output should be easier to understand.
811 * Sort both the lists of expected and of found SWIG-generated sources with
812   Perl, to avoid problems with locale-specific sort orders.
814 Java-SWIG:
816 * Remove now superfluous old check that SWIG generated at least the sources we
817   want - we now check it generated *exactly* the sources we want.
819 * Use diff's -c option when comparing the files SWIG generated against those we
820   were expecting to get as the output should be easier to understand.
822 * Sort both the lists of expected and of found SWIG-generated sources with
823   Perl, to avoid problems with locale-specific sort orders.
825 Lua:
827 * Now works with Lua 5.2.
829 * "require 'xapian'" now returns the module table.  (ticket #593)
831 * lua/smoketest.lua: Improve reporting of test failures.
833 Perl:
835 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
837 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
838   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
840 Python:
842 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
843   iteration features which have been removed on trunk.  This also fixes a
844   segfault if there are no matches and no documents are explicitly marked as
845   relevant.
847 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
848   way to rerun tests with verbose output.
850 Ruby:
852 * configure: Make sure the ruby subdirectory exists before trying to create
853   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
855 Xapian-bindings 1.2.9 (2012-03-08):
857 Java:
859 * configure: Fix test for jni.h to try looking for jni.h relative to the real
860   location of javac, which should work for more JDKs.
862 Lua:
864 * Handle an exception from C++ by raising a xapian.Error object as an error in
865   Lua.
867 * Rename get_description() methods to __tostring(), so that you can use write
868   tostring(obj) in Lua.
870 * configure: Honour LUA_LIB if already set.  Fixes #581.
872 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
873   support platforms where the compiled Lua module isn't called .so.
875 Perl:
877 * Add tests of Document::get_docid().
879 PHP:
881 * Add a test that Query constructor taking OP_NEAR with a window size works.
883 Python:
885 * python/testsuite2.py: Don't run off the traceback looking for a test function
886   if the exception wasn't from a test function.
888 Xapian-bindings 1.2.8 (2011-12-13):
890 Lua:
892 * Wrap user-subclassable functor objects by allowing the user to pass a
893   Lua function where the functor object would be passed in the C++ API.
895 PHP:
897 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
899 * The PHP bindings will now work again with a version of PHP built with ZTS
900   enabled (which is the default on Microsoft Windows).  This was broken by
901   the changes to support subclassing in PHP in the version of SWIG used since
902   1.2.6.
904 Python:
906 * Add a module docstring.  (Fixes bug #573)
908 * The python testsuite now checks for object leaks during each testcase.
910 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
911   only check for leaks the second time to avoid falsely reporting a leak when
912   some cached value gets initialised under Python 2.5.
914 Ruby:
916 * Wrap optional prefix parameter to Database::allterms.
918 Xapian-bindings 1.2.7 (2011-08-10):
920 Documentation:
922 * INSTALL: Pull in a few updates from the latest version of the automake
923   document which this file was originally based on.  Add in the missing
924   copyright and licensing information.
926 * INSTALL: Add --with-lua to list of options.
928 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
929   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
930   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
931   supported platforms in the README.
933 * HACKING: Update and start section on deprecation warnings for the bindings.
935 General:
937 * Add missing wrappers for Database::has_positions() and
938   TermIterator::positionlist_count(), and correct the return type of
939   Database::get_doclength() from double to Xapian::termcount.
941 CSharp:
943 * README: Note a recent version of Mono which we've tested the C# bindings
944   with.
946 * Check that exactly the sources we expect are generated, and add some sources
947   which were missing from the list.
949 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
950   gets removed.
952 * Fix iterator ++ and -- so that the reference to the object isn't released
953   prematurely, which was causing an occasional crash if the garbage collection
954   happened at just the wrong moment,
956 * Add test coverage for QueryParser.ParseQuery() with flags argument.
958 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
960 Java:
962 * SmokeTest.java: Fix == comparisons with strings to use equals().
964 * Add test that string passing is zero byte safe.
966 * Fix MyExpandDecider.accept() to really check the passed parameter.
968 Java-SWIG:
970 * Put the SWIG-generated Java bindings in package org.xapian.
972 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
974 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
976 * Add test that string passing is zero byte safe.
978 * Fix MyExpandDecider.accept() to really check the passed parameter.
980 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
982 * Create an HTML documentation page based on java/README.
984 * Copy java examples from the hand-coded JNI ones.
986 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
988 * Check that exactly the sources we expect are generated, and add some sources
989   which were missing from the list.
991 Lua:
993 * Merge latest Lua changes from Xiaona Han.
995 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
997 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
998   matches.
1000 Perl:
1002 * Sync updates to examples from XS Search::Xapian:
1004   + Require Perl >= 5.6 so we can "use warnings;".
1006   + Loop over file using while() (which reads a line per iteration) not
1007     foreach() (which reads the whole file up front).
1009 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
1010   and Search::Xapian::Query::MatchNothing).  (ticket#158)
1012 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
1014 * perl/Makefile.am: Fix "make check".
1016 * perl/t/symbol-test.t: Fix to work when built against an installed
1017   xapian-core.  (ticket#558)
1019 PHP:
1021 * php/smoketest.php: Install an error handler so the test fails if there are
1022   any errors, warnings, notices, etc.
1024 * Change PHP examples and test program to use 'include "xapian.php"' like user
1025   code should (rather than 'include "php5/xapian.php"' as they did previously).
1027 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
1028   XapianQuery::MatchNothing(). (ticket#158)
1030 Ruby:
1032 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
1034 Xapian-bindings 1.2.6 (2011-06-12):
1036 General:
1038 * SWIG-based bindings are now generated with a newer version of SWIG
1039   (ticket#538).
1041 Portability:
1043 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
1044   .jnilib extension as we do for older versions.
1046 CSharp:
1048 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
1050 Java:
1052 * Fix memory leaks when functions taking string parameters throw exceptions.
1054 * Previously a hash table was used to map Java objects to C++ ones, but we
1055   now just cast the address of the C++ object to a jlong (which is 64 bits
1056   so will hold a pointer on current platforms).  This is more efficient and
1057   avoids the need for thread locks around accesses to the hash table.
1059 * Remove explicit checks for NULL around calls to delete.
1061 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
1062   during parallel builds.
1064 Lua:
1066 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
1067   year.  The current support should be regarded as experimental - it passes
1068   its automated tests, but the details of the Lua API are likely to evolve as
1069   the project progresses.
1071 Perl:
1073 * README: say that Perl bindings probably need Perl 5.8 or later.
1075 PHP:
1077 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
1079 Python:
1081 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
1082   all the garbage, so repeat until no further objects are freed.
1083   (http://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
1085 Ruby:
1087 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
1088   the compaction tests for these versions.
1090 Xapian-bindings 1.2.5 (2011-04-04):
1092 Documentation:
1094 * README: Update info on SWIG-based Perl bindings.
1096 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
1097   section with better equivalent from xapian-core/INSTALL.
1099 General:
1101 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
1103 * configure: If xapian-core is a different release series, promote the
1104   mismatched versions warning to an error.
1106 Portability:
1108 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
1109   10.4 on x86, as the default if unset on these versions is the current OS
1110   version.  (ticket#541)
1112 * python/pythontest2.py: In test_compactor(), close any open databases before
1113   removing the directory as you can't delete an open database on Microsoft
1114   Windows.  (ticket#526)
1116 CSharp:
1118 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
1120 * Clarify the licence is GPL "version 2 or later" in the meta information
1121   we put in the module.
1123 Python:
1125 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
1126   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
1127   accidentally left an older version of get_matching_terms() exposed.
1129 * Remove broken implementation of MSet.__contains__.  This appears never to
1130   have worked, and to have been broken for at least the past 3.5 years without
1131   anyone mentioning it, and is probably of little use anyway, so no need to
1132   deprecate.
1134 * python/docs/index.html: Document that MSet.items and ESet.items are
1135   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
1136   the tuple returned by MSet.items.  (ticket#531)
1138 * Add test coverage for mset.items.
1140 Ruby:
1142 * Add test coverage for Xapian::Compactor.
1144 * Handle an empty response to $RUBY --version specially.  This gives a less
1145   opaque error in cases where the user specified RUBY but the value given
1146   wasn't an executable file.
1148 Xapian-bindings 1.2.4 (2010-12-19):
1150 General:
1152 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
1153   virtual method is wrapped for subclassing for Python and Ruby currently.
1155 * Eliminate separate Makefile.am in the docs subdirectory of each language
1156   subdirectory and just inline any rules into the main sub-Makefile.am, which
1157   allows more of the build to run in parallel.
1159 * Don't ship some files which are generated at build time.
1161 * configure: Need python in maintainer mode to run doxy2swig.py.
1163 Packaging:
1165 * RPM: Package the Perl bindings.
1167 * RPM: Don't package _XapianSharp.la.
1169 Portability:
1171 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
1172   uninstalled Xapian library.  See ticket #322.
1174 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1176 CSharp:
1178 * Don't install _XapianSharp.la.
1180 Perl:
1182 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
1183   GSoC 2009.  These are close to being a compatible replacement for the
1184   hand-coded XS bindings in Search::Xapian but also offer a more complete
1185   wrapping of the C++ API.  We're planning to replace the XS bindings with the
1186   SWIG ones for easier maintenance.  We encourage you to try them and let us
1187   know how you get on - particularly if you find cases where code which works
1188   with the XS bindings doesn't work with the SWIG ones.
1190 PHP:
1192 * Document that iterators shouldn't be dereferenced or advanced when at their
1193   end points (ticket#520).
1195 Python:
1197 * Fix memory leaks in typemaps which return Python lists.
1199 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
1200   supported.
1202 * configure: Use sys.version_info tuple, rather than string splicing which
1203   assumes the Python "major.minor" is 3 characters (which would fail if Python
1204   2.10 were ever released, for example).
1206 Xapian-bindings 1.2.3 (2010-08-24):
1208 Packaging:
1210 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
1212 Xapian-bindings 1.2.2 (2010-06-27):
1214 * No user-visible change except for bumping the version to indicate
1215   compatibility with Xapian-core 1.2.2.
1217 Xapian-bindings 1.2.1 (2010-06-22):
1219 This release includes all changes from 1.0.21 which are relevant.
1221 General:
1223 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
1224   Python.  (ticket#448)
1226 Guile:
1228 * Remove non-functional disabled guile bindings left over from Open Muscat
1229   days - if someone wanted to add guile bindings, it would be easier to start
1230   from scratch.
1232 Java-SWIG:
1234 * Update list of generated java sources in the SWIG-based Java bindings.
1236 PHP:
1238 * zend_throw_exception() returns, so return control to PHP directly after
1239   calling it to avoid needless extra work and possible issues.
1241 Python:
1243 * Fix "from xapian import *".  (ticket#477)
1245 * Fix testcase weight_normalise - a change in xapian-core means that
1246   get_max_possible() can now return zero for a non-existent term, so don't
1247   blindly calculate the reciprocal of it.
1249 * python/replicationtest2.py: Extend to check that changesets get applied
1250   correctly.
1252 * python/smoketest2.py: Check len(mset) works (improving test coverage of
1253   Python-specific wrapping).
1255 Xapian-bindings 1.2.0 (2010-04-28):
1257 This release includes all changes from 1.0.20 which are relevant.
1259 Portability:
1261 * configure: Tell libtool not to link in deplibs on platforms where we know
1262   they aren't needed.
1264 * configure: On Linux, extract the library search path from ldconfig which
1265   gives us the default entries reliably.
1267 Xapian-bindings 1.1.5 (2010-04-15):
1269 This release includes all changes from 1.0.19 which are relevant.
1271 Tcl:
1273 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
1274   sidestep the whole destructor issue.  (ticket#62)
1276 Xapian-bindings 1.1.4 (2010-02-15):
1278 This release includes all changes from 1.0.18 which are relevant.
1280 General:
1282 * Update for the new Brass backend and other C++ API changes.
1284 * Wrap Database::get_doclength_lower_bound(),
1285   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
1286   Database::valuestream_begin() and Database::valuestream_end() for all
1287   languages. (ticket#431)
1289 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
1291 Python:
1293 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
1294   object which dereferences to a ValueStreamItem object,
1296 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
1298 Ruby:
1300 * Add safe wrapper for the valuestream iterator.
1302 Xapian-bindings 1.1.3 (2009-11-18):
1304 This release includes all changes from 1.0.15-1.0.17 which are relevant.
1306 General:
1308 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
1309   specified.
1311 * Wrap the new MatchSpy class, and associated features.
1313 * Don't wrap PostingSource::serialise(), Weight::serialise() and
1314   Weight::unserialise() as they aren't useful from the bindings.
1316 * Update for the Sorter to KeyMaker changes.
1318 PHP:
1320 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
1321   as it standardly is on Microsoft Windows.  Fixes #411.
1323 * Merged the PHP "smoketest" back together now we don't need to support
1324   PHP4 now.
1326 Python:
1328 * Fix a memory leak on error (in theory - we've not got a way to generate this
1329   error, so haven't been able to reproduce the leak or test the fix).
1331 Xapian-bindings 1.1.2 (2009-07-23):
1333 This release includes all changes from 1.0.14 which are relevant to trunk.
1335 Python:
1337 * Several changes towards fully supporting Python 3, but more work is required.
1338   (ticket#246)
1340 Xapian-bindings 1.1.1 (2009-06-09):
1342 This release includes all changes from 1.0.13 which are relevant to trunk.
1344 General:
1346 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
1348 CSharp:
1350 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1351   C# yet, and to use Query("") and Query() instead.
1353 * configure: If we don't find a C# compiler, don't test an empty command name
1354   further which saves a fork and avoids an odd looking message.
1356 PHP:
1358 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1359   PHP yet, and to use Query("") and Query() instead.
1361 Python:
1363 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
1364   are wrapped (ticket#158).
1366 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
1367   expect SYNONYM in generated query.
1369 Ruby:
1371 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1372   Ruby yet, and to use Query("") and Query() instead.
1374 Tcl:
1376 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
1377   are wrapped (ticket#158).
1379 Xapian-bindings 1.1.0 (2009-04-22):
1381 Documentation:
1383 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
1384   the instructions to suggest users use this standard location for installing
1385   without root access.
1387 General:
1389 * All deprecated features slated for removal in 1.1.0 have been removed.
1391 * All new C++ API features have been wrapped.  Also, since we now supply some
1392   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
1393   these can be passed in even for languages for which SWIG doesn't support
1394   subclassing.
1396 Packaging:
1398 * xapian-bindings.spec: Updated to reflect the new Python packaging.
1400 Portability:
1402 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
1403   to put the compiler into ISO C++ mode).
1405 PHP:
1407 * PHP4 support has been removed, since PHP4 is no longer supported upstream
1408   as of 2008-08-08.
1410 Python:
1412 * Python 2.3 or later is now required.  2.2 is essentially unsupported
1413   upstream.
1415 * The import method used has been changed (by using a newer SWIG version)
1416   and no longer gives a warning with Python 2.6.
1418 * Initial support for Python 3.0 has been added.  This currently doesn't
1419   work correctly and should be treated as experimental. (ticket#346)
1421 * The newer SWIG version handles exceptions in director methods correctly
1422   so we no longer need our workaround for ticket #289.
1424 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
1425   wrapped for Python as Database.metadata_keys().
1427 * The Python bindings are now installed as a python package, with the
1428   files in a xapian subdirectory, hiding the internal _xapian module
1429   better.
1431 * Python now flags deprecation warnings for the single argument form and old
1432   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
1433   friends.
1435 Xapian-bindings 1.0.23 (2011-01-14):
1437 Portability:
1439 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1441 PHP:
1443 * Document that iterators shouldn't be dereferenced or advanced when at their
1444   end points (ticket#520).
1446 Python:
1448 * Fix memory leaks in typemaps which return Python lists.
1450 Xapian-bindings 1.0.22 (2010-10-03):
1452 Packaging:
1454 * RPM: Don't package _XapianSharp.la.
1456 CSharp:
1458 * Don't install _XapianSharp.la.
1460 Python:
1462 * configure: Use sys.version_info tuple, rather than string splicing which
1463   assumes the Python "major.minor" is 3 characters (which would fail if Python
1464   2.10 were ever released, for example).
1466 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
1467   testcase in pythontest.py.
1469 Xapian-bindings 1.0.21 (2010-06-18):
1471 Python:
1473 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
1474   can't be written to. (ticket#297)
1476 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
1478 * Add test to check that "from xapian import *" works.
1480 Xapian-bindings 1.0.20 (2010-04-27):
1482 Python:
1484 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
1485   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
1486   trap to delete them after running tests for older versions of Python.
1487   (ticket#315)
1489 Ruby:
1491 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
1493 Xapian-bindings 1.0.19 (2010-04-15):
1495 Tcl:
1497 * tcl8/docs/index.html: Improve wording in a few places.
1499 Xapian-bindings 1.0.18 (2010-02-14):
1501 General:
1503 * Wrap new C++ API method Document::add_boolean_term().
1505 Ruby:
1507 * Generate entries in the Ruby rdocs for all classes which aren't documented
1508   because of Ruby-specific methods.  Fixes ticket#417.
1510 * Avoid absolute paths in the generated rdocs.
1512 Xapian-bindings 1.0.17 (2009-11-18):
1514 Packaging:
1516 * Improve RPM package summaries - the files are needed to *use* scripts as well
1517   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
1518   conventional.
1520 Portability:
1522 * python/Makefile.am: Restore the "./" path to the sourced file
1523   libtoolconfig.tmp as ksh requires it.
1525 Java:
1527 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
1529 Xapian-bindings 1.0.16 (2009-09-10):
1531 Python:
1533 * Improved docstrings for QueryParser::set_default_op() and
1534   QueryParser::get_default_op() (automatically generated from changes in
1535   xapian-core).
1537 Xapian-bindings 1.0.15 (2009-08-26):
1539 Python:
1541 * Don't break long words when wrapping text in the generated API documentation
1542   comments as this was causing identifiers to be broken in two.
1544 Xapian-bindings 1.0.14 (2009-07-21):
1546 General:
1548 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
1549   and the only side-effect was an odd looking message.
1551 Python:
1553 * Rename methods at build-time using SWIG rather than a run-time in Python, as
1554   the latter approach adds a small time overhead when the module is being
1555   loaded.
1557 Ruby:
1559 * Fix to accept an integer value > MAXINT for a double parameter.
1561 Xapian-bindings 1.0.13 (2009-05-23):
1563 Packaging:
1565 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
1566   _XapianSharp.so in 1.0.11.
1568 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
1569   bindings since 1.0.6.
1571 PHP:
1573 * Backport fix from SWIG SVN for misuse of formatted error function in
1574   SWIG-generated code.
1576 Python:
1578 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
1579   Python's Global Interpreter Lock (GIL) in situations where we know that it
1580   will already be locked.  This avoids some dead-locks with mod_python (due to
1581   mod_python bugs which are apparently unlikely to ever be fixed), and results
1582   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
1583   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
1584   faster). (ticket#185)
1586 * README,python/docs/index.html: Update documentation of the above mod_python
1587   issue and also document the related mod_wsgi issue.  The status is now that
1588   everything seems to work if you stick to the main interpreter (ticket#364).
1590 * Backport fix from SWIG SVN for misuse of formatted error function in
1591   SWIG-generated code.
1593 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
1594   second parameter, not the third.
1596 * python/docs/examples/simplematchdecider.py,
1597   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
1598   clearer code.
1600 Ruby:
1602 * README: Note that the testsuite fails due to a bug in the test/unit module in
1603   Ruby 1.9.0, but applications using the bindings should work, and that the
1604   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
1605   appears to be completely dead both upstream and in the wild.
1607 Xapian-bindings 1.0.12 (2009-04-19):
1609 Documentation:
1611 * INSTALL: Add a note about being able to pass variables to configure to pick
1612   which of several parallel installations of a language to build for.
1614 Python:
1616 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
1617   test to avoid failing due to rounding differences.
1619 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
1620   stop the whole testsuite, not just the currently running testcase.
1622 Xapian-bindings 1.0.11 (2009-03-15):
1624 Documentation:
1626 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
1627   Python 3, and possible current issues with Ruby 1.9.
1629 Portability:
1631 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
1632   Cygwin.
1634 Python:
1636 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
1637   latter is deprecated, and support was removed in 1.0.0).
1639 * Add support for using the new name ("reverse") for the second argument of
1640   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
1641   The old name ("ascending") is still supported, but will be deprecated in
1642   1.1.0.
1644 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
1645   which get set on other objects to avoid segmentation faults if they go out
1646   of scope before the object they are set on does.  (ticket#341)
1648 Ruby:
1650 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
1651   fails so "make check" doesn't pass, but code using the bindings should work.
1653 Xapian-bindings 1.0.10 (2008-12-23):
1655 Python:
1657 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
1658   as things stand (upstream fix for Debian bug 506090).
1660 Xapian-bindings 1.0.9 (2008-10-31):
1662 General:
1664 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
1666 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
1667   methods.
1669 Xapian-bindings 1.0.8 (2008-09-04):
1671 General:
1673 * configure: Report bug report URL in --help output.
1675 Python:
1677 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
1678   (bug#289)
1680 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
1682 Xapian-bindings 1.0.7 (2008-07-14):
1684 Documentation:
1686 * Document how all the database factory functions and library version functions
1687   are wrapped for all languages.
1689 General:
1691 * Fix to build against a xapian-core which has quartz and/or flint disabled.
1693 * The "program" version of Remote::open() has been wrapped for some time, so
1694   update the documentation which said it wasn't.
1696 Packaging:
1698 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
1700 Portability:
1702 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
1703   different module extension rather than our own ugly bodge.
1705 Java:
1707 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
1708   simple to make C++ to Java work though.
1710 PHP:
1712 * Add test that OP_VALUE_GE works for PHP.
1714 Python:
1716 * Several corrections to the Python documentation.
1718 * configure: Fix problem with building under mingw.
1720 Ruby:
1722 * Include simplematchdecider.rb example.
1724 * smoketest.rb: Test the version reporting functions.
1726 Tcl:
1728 * Include simpleexpand.tcl example.
1730 * Fix where the Tcl module gets installed.
1732 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
1734 Xapian-bindings 1.0.6 (2008-03-17):
1736 General:
1738 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
1739   used with.
1741 * configure: Correct the required SWIG version given in an error message.
1743 PHP:
1745 * php/smoketest.php: Add note that this script should be run using 'make check'
1746   in the build tree (rather than trying to copy it to a webserver as someone
1747   recently tried to).
1749 * php/smoketest.php: Fix to work under PHP4.
1751 Python:
1753 * The Python module now always has the extension which Python expects, which
1754   fixes a failure on Mac OS X.
1756 Ruby:
1758 * Automatically install/uninstall the Ruby rdoc-generated documentation along
1759   with the ruby bindings.
1761 Tcl:
1763 * configure: Sort out the default value of TCL_LIB, which could end up being
1764   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
1766 Xapian-bindings 1.0.5 (2007-12-21):
1768 General:
1770 * Wrap Xapian::Sorter and subclasses.
1772 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
1773   and Enquire::set_sort_by_relevance_then_key().
1775 * Factor out the code to protect multitarget rules against parallel make, and
1776   fix it to handle the source being changed while the rule is executing, and to
1777   correctly return an error code if we fail while trying to recover from the
1778   removal of a target of a multi-target rule.
1780 * configure: Improve the clarity of the error given when none of the tools
1781   needed for any supported language are found.
1783 * configure: SWIG 1.3.32 has now been released, so require at least this
1784   released version for maintainer builds.
1786 Java:
1788 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
1789   GCC 4.3.
1791 * configure: Log the output of trying to compile conftest.java in config.log;
1792   if the test fails, report whether the failure was compiling or running the
1793   test program.
1795 * Check for directory existence rather than calling mkdir unconditionally as
1796   despite the "(ignored)", the error message seems to confuse some people.
1798 PHP:
1800 * Add feature test for XapianMultiValueSorter.
1802 * php/smoketest5.php: Fix use of Database_get_document to new style OO
1803   interface.  Fix the error reported when the PHP5 exception test fails.
1805 * php/smoketest.php: Add feature test to confirm that optional arguments to
1806   XapianQuery's "term" constructor are wrapped.
1808 Python:
1810 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
1811   these properties build a python list, so dropping the GIL isn't safe and
1812   may cause undefined behaviour in multithreaded environments.
1814 * configure: Update error message to reflect requirement for at least python
1815   2.2.
1817 * configure: Change "print foo" to "print(foo)" in python version checks, for
1818   compatibility with python 3.0.
1820 Ruby:
1822 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
1823   previously incorrect).
1825 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
1826   ruby/docs/index.html previously had a dead link to.
1828 Tcl:
1830 * configure: Overhaul code to find tcl.h since the old version no longer worked
1831   with Debian unstable.
1833 * tcl8/docs/index.html: Update documentation to cover flint and mention that
1834   quartz is now deprecated.
1836 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
1837   throws QueryParserError instead.
1839 Xapian-bindings 1.0.4 (2007-10-30):
1841 General:
1843 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
1844   Add feature tests for all languages.
1846 * The "bindings.html" file documenting each of the bindings has been renamed to
1847   "index.html".
1849 Packaging:
1851 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
1852   older distros.
1854 Portability:
1856 * Fix warnings when compiling with GCC 4.2.
1858 PHP:
1860 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
1861   and methods/functions which return a wrapped class.
1863 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
1864   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
1866 * Document how non-class functions are wrapped.
1868 * Fix wrapping of NumberValueRangeProcessor for PHP4.
1870 * smoketest.php: Split the regression test for bug#193 into separate
1871   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
1873 Python:
1875 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
1876   non-pythonic iterators.  Make it clearer that the "sequence API" is
1877   deprecated.
1879 * Add test of a custom ValueRangeProcessor (ie, one written in python).
1881 * Update the examples to use the new-style attributes to access MSet item
1882   values rather than the old-style MSET_* constants.
1884 * Document MSET_DOCUMENT.
1886 Ruby:
1888 * smoketest.rb: Rename test of metadata access methods which had been named the
1889   same as the matchdecider test due to a copy-and-paste error.
1891 Xapian-bindings 1.0.3 (2007-09-28):
1893 General:
1895 * Wrap new methods Database::get_metadata() and
1896   WritableDatabase::set_metadata().
1898 * "make uninstall" now removes the loadable module we install for each of
1899   the bindings.
1901 * "make distcheck" now works.
1903 * Distribution tarballs are now in the POSIX "ustar" format since it saves
1904   about 40KB and we need to use it for xapian-core anyway.
1906 Packaging:
1908 * RPMs: Package xapian.php.
1910 CSharp:
1912 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
1913   usefully used currently.
1915 Java:
1917 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
1918   C++ library.
1920 * "make clean" now removes the class files generated for inner classes.
1922 PHP:
1924 * Add feature test for DateValueRangeProcessor when used with QueryParser.
1926 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
1927   isn't actually very useful, since you can't subclass it in PHP currently.
1929 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
1930   if the third parameter was specified and a floating point number (e.g. 0.0).
1932 * php/docs/bindings.html: Fix errors in example code.
1934 Python:
1936 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
1937   Python which takes two strings and returns a 3-tuple (value_number,
1938   modified_begin, modified_end).  Previously this always failed with a
1939   type error, so this doesn't break existing code.
1941 * python/pythontest.py: Interpret any commandline arguments as a list of
1942   tests to be run (the default is to run all tests).
1944 * README,python/docs/bindings.html: Add a note about the problems with
1945   mod-python (as described in bug #185).
1947 * python/pythontest.py: Delete the database handles before deleting a database
1948   to fix problems running the Python tests on MS Windows (bug#179).
1950 * "make clean" now removes testsuite.pyc.
1952 Ruby:
1954 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
1955   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
1956   now the site-specific directories, which is more correct when building
1957   from source.  Debian packages, etc can override this by setting RUBY_LIB and
1958   RUBY_LIB_ARCH.
1960 Tcl:
1962 * Check for TCL_LIB in the environment or on the configure command-line to
1963   allow installing without root access more cleanly.
1965 Xapian-bindings 1.0.2 (2007-07-05):
1967 Documentation:
1969 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
1970   phpextdir.
1972 * Remove documentation of removed "--with-swig" configure option.
1974 General:
1976 * Add methods of NumberValueRangeProcessor for serialising and
1977   unserialising doubles.
1979 * Add methods and constants supporting spelling correction and synonyms.
1981 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
1982   to ensure that it works with uninstalled copies of Xapian.
1984 * Value of PYTHON_LIB supplied to configure is now respected - previously
1985   it was documented, but ignored.
1987 * Add support for supplying PHP_EXTENSION_DIR to configure.
1989 * Change to using "%include", rather than reproducing contents of header
1990   files, for "queryparser.h", "document.h" and "postingiterator.h".
1992 * Add new form of get_mset() which allows a matchspy matchdecider to be
1993   set.
1995 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
1996   explode.  Add in a missing "mv" in the command for installing tcl8
1997   documentation.
1999 CSharp:
2001 * Fix rule handling parallel make to include xapian_wrap.h
2003 PHP:
2005 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
2006   doesn't seem to be a standard location, but this works for Debian at
2007   least, and it seems better to at least try to install it.
2009 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
2010   prefix for PHP4.
2012 Python:
2014 * Fix a threading problem: the GIL was not being acquired in the exception
2015   handling code before setting the Python exception state, leading to
2016   various memory corruption symptoms in threaded programs.
2018 * Add special iterators to Database for synonyms, synonym_keys and
2019   spellings.
2021 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
2022   synonym iterators and spelling iterators.
2024 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
2025   the expected description to make the tests more readable.
2027 Xapian-bindings 1.0.1 (2007-06-11):
2029 Documentation:
2031 * NEWS: Fix the recent headings which said "Xapian-core" to say
2032   "Xapian-bindings".
2034 General:
2036 * Wrap Xapian::Query constructor for creating ValueRange queries.
2038 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
2039   which take a prefix.
2041 Packaging:
2043 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
2044   %{buildroot} prefix on most files which we then have to work around.
2046 CSharp:
2048 * SimpleIndex now uses Xapian.TermGenerator.
2050 * SimpleSearch now uses Xapian.QueryParser.
2052 * New SimpleExpand example.
2054 * Document explicitly how STEM_SOME constants are currently wrapped.
2056 * Update GetTermName() reference in documentation to GetTerm().
2058 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
2059   their CVS repo, and the fix should be in their 0.8.2 release.
2061 Java:
2063 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
2064   looked at, but in fact its value was read but ignored.  We now use it as the
2065   first place to look for jni.h.
2067 * configure will now automatically add an extra "-I" for the
2068   linux/solaris/win32 subdirectory which Sun's JDK requires.
2070 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
2071   "precious" so their values are preserved for when configure is automatically
2072   rerun.
2074 PHP:
2076 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
2078 * The PHP examples have been rewritten to be clearer and to make use of the
2079   new XapianTermGenerator class.
2081 Python:
2083 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
2085 * Add support for prefix-restricted pythonic allterms iterators.
2087 * Update documentation in a couple of places to refer to updated replacements
2088   for MSetIterator.
2090 * Change testsuite output to be more vim-friendly (vim should be able to jump
2091   to the right lines now).
2093 * __str__ on Xapian::Error now includes extra information in some cases (the
2094   error_string and context, if they are set).
2096 * python/smoketest.py: Eliminate uses of the legacy sequence API.
2098 * python/pythontest.py: The legacy sequence API is only supported for Python
2099   2.3 and later, so don't run tests for it when running under Python 2.2.
2101 * We now generate and install xapian.pyo as well as xapian.pyc.
2103 Ruby:
2105 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
2106   classes.
2108 * Add missing rename for the C++ TermGenerator::set_document() method so it can
2109   be used as "tg.document = doc" in Ruby.
2111 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
2113 Tcl:
2115 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
2116   feedback, based on C++ simpleexpand.cc.
2118 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
2119   TermGenerator class.
2121 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
2122   QueryParser class.
2124 * tcl8/docs/bindings.html: Document how constants are wrapped.
2126 * Update smoketest and examples to require version 1.0.0 - previously this
2127   required 0.9.6, which failed since TCL doesn't accept differing major
2128   version numbers.
2130 * pkgIndex.tcl is now generated by configure.
2132 Packaging:
2134 * The required automake version has been lowered to 1.8.3, so RPMs can now be
2135   built on RHEL 4 and SLES 9.
2137 Xapian-bindings 1.0.0 (2007-05-17):
2139 Documentation:
2141 * Document Unicode support for each language.
2143 * Assorted minor improvements and typo fixes.
2145 General:
2147 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
2148   it, for languages where SWIG supports directors.
2150 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
2151   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
2152   allows the "default_prefix" argument to be supplied, QueryParser flags
2153   FLAG_PURE_NOT and FLAG_PARTIAL.
2155 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2157 * Remove wrappers for deprecated features removed from the C++ API (see
2158   docs/deprecation.html in xapian-core for full details and upgrade
2159   information).
2161 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
2163 * QueryParserError is now a real error, so remove special handling for "const
2164   char *" exceptions.
2166 * Use a stamp file in "make" rules with multiple targets so that parallel
2167   make works.
2169 * configure: Now quotes $PYTHON, etc so that you can specify a program with
2170   arguments.
2172 * configure: If the user specifies a program which doesn't exist (e.g.
2173   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
2175 * configure: Disable probes for f77, gcj, and rc completely by preventing
2176   the probe code from even appearing in configure - this reduces the size of
2177   configure by 28% and should speed it up significantly.
2179 * configure: If the version check against the xapian-core version detects a
2180   mismatch, we now issue a warning rather than a hard error since if you're
2181   careful this can work.  The warning is issued late on in configure, so it's
2182   harder for the user to miss.
2184 * configure: The --with-swig option has been removed.  It no longer has a
2185   purpose as we now ship the files which are generated by SWIG.
2187 Portability:
2189 * The PHP bindings can now be built with MSVC for Microsoft Windows.
2191 CSharp:
2193 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
2194   than mcs to avoid segmentation faults at runtime due to unimplemented
2195   features in mcs.  Document this, and update configure to prefer gmcs.
2197 * The return type of MatchDecider::operator() is now `bool' rather than `int'
2198   (in line with the same change in the C++ API).
2200 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
2202 Java:
2204 * The Java bindings have been updated to use C++ replacements for deprecated
2205   methods, so they still build.  The Java wrappers still provide the old
2206   deprecated names for now though.  The longer term plan is to replace the
2207   hand-written JNI with SWIG generated wrappers (work has now begun on this)
2208   which is likely to require some API changes, and it seems more sensible to
2209   make any changes to align with C++ API changes at the same time.
2211 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
2212   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
2214 PHP:
2216 * Fix undefined behaviour in get_matching_terms().
2218 * Document the (existing) renaming of methods which are PHP reserved words
2219   (empty() to is_empty() and clone() to clone_object()).
2221 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2223 Python:
2225 * The Python bindings now throw exceptions as classes with a hierarchy which
2226   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
2227   base class inherits from the standard Python Exception class.
2229 * All Python methods which accept strings can now be passed either a unicode
2230   object or a simple string.  Strings are returned as simple strings: unicode
2231   input will be returned as utf-8 encoded output.  The documentation now
2232   contains a "Unicode" section.
2234 * The Python bindings should now be usable more efficiently from threaded
2235   Python applications since we now use SWIG's -threads option when generating
2236   them, so that the GIL is released during long-running Xapian operations
2237   (bug#137).
2239 * Most classes, methods, functions, etc now have docstrings which are either
2240   automatically extracted from the C++ documentation comments, or overridden by
2241   more appropriate versions.
2243 * Most of the Pythonic iterators now return an object instead of a sequence,
2244   which means they now lazily fetch the information which previously had to be
2245   fetched to put it in the sequence.  The old sequence API is supported for
2246   compatibility, but is scheduled for removal in Xapian 1.1.0.
2248 * Those Python iterators which have skip_to() methods now return the item
2249   skipped to, and next() will return the following item.  Previously, they
2250   returned None, and next() returned the item skipped to.  Several bugs in the
2251   skip_to() wrappers were fixed.
2253 * Because of the lazy access, some objects returned by iterators will raise
2254   an error if the lazy evaluation happens after the iterator has moved on
2255   (since the underlying Xapian API doesn't allow efficient access to the
2256   information in this situation).  The exact semantics are defined in the
2257   docstrings for each iterator.
2259 * Those Pythonic iterators which return only a list of terms now return
2260   simple strings, instead of a sequence or an object containing the term.  This
2261   is an incompatible change with earlier releases.  The affected iterators are
2262   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
2263   QueryParser.unstemlist.
2265 * The contents of an MSet can now be iterated in the standard Python way.
2266   The iteration will return MSetItem objects.  The __contains__ and __getitem__
2267   methods are also implemented, allowing the "in" and [] operators to work.
2268   MSet.__getitem__ is a synonym for MSet.get_hit.
2270 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
2271   so that lazy access to its attributes is supported.  MSetItem has some
2272   deprecated methods which mimic the MSetIterator interface to allow old code
2273   to work without modification until release 1.1.0.
2275 * MSetItem provides access to the collapse_key and collapse_count, which
2276   weren't accessible from the sequence returned by the iterators before this
2277   release.
2279 * Out-of-range access to MSets will now raise an IndexError - it used to
2280   cause undefined behaviour (usually a crash).
2282 * The Python testsuite is now much more extensive, and supports colour output
2283   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
2284   features are separated out, so that they can easily be removed when the
2285   features are removed.  The Python tests currently focus mainly on Python
2286   specific iterators and related functionality - general Xapian behaviour is
2287   tested by the C++ testsuite.
2289 * The pure Python code in the bindings now uses new-style classes, since we
2290   have required Python >= 2.2 since Xapian release 0.9.9.
2292 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
2293   instead.
2295 * The get_description() method which many classes support has been deprecated
2296   in favour of new more pythonic __str__ methods, so that the str() builtin can
2297   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
2299 Ruby:
2301 * We no longer regard the Ruby bindings as "beta quality", so remove the
2302   warning from their documentation.
2304 * Document that that C++ operator() becomes the method "call" in Ruby.
2306 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
2307   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
2309 Tcl:
2311 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2313 Xapian-bindings 0.9.10.1 (2007-04-04):
2315 PHP:
2317 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
2318   default parameters.  The most notable case was a missing Query constructor
2319   which meant that QueryParser was unusable.
2321 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
2322   (which mostly seems to mean the MS Windows version).
2324 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
2325   seems to mean the MS Windows version).
2327 * Add note to the documentation that PHP examples are written for CLI version
2328   of PHP, but that the bindings work with any version.
2330 * Add check to all PHP examples that they are being run under a CLI version of
2331   PHP.
2333 Python:
2335 * simpleexpand.py: Print each term's expand weight as a floating point value,
2336   not an integer.
2338 Ruby:
2340 * INSTALL: document how to install Xapian's Ruby bindings in your home
2341   directory.
2343 Xapian-bindings 0.9.10 (2007-03-04):
2345 Java:
2347 * Under Mac OS X, automatically look in the standard location for jni.h,
2348   and automatically rename the JNI library we build to ".jnilib", as is
2349   required by the OS X JVM.
2351 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
2352   to add the linux header directory to the include path when using this JDK.
2354 * Add missing default constructor for RSet class - it's not much use without
2355   this!
2357 * Fix Enquire.getESet() to actually work.
2359 * Fix bug in ESetIterator.hasNext().
2361 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
2363 * Fix memory leak with some JVMs in the "Query from array" constructor.
2365 * Fix memory leak in Enquire.setQuery().
2367 * SmokeTest.java: Add regression tests for RSet default constructor,
2368   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
2369   Add feature tests for Enquire.getQuery(), and to make sure we get passed
2370   the right document in a java subclass of MatchDecider.
2372 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
2373   respective variables are set.
2375 PHP:
2377 * Update the documentation to fix out-of-date information and document the
2378   differences between the PHP4 and PHP5 wrappers.
2380 * Update the examples to use the new Object Oriented API, and provide versions
2381   for both PHP4 and PHP5.
2383 * Add a "simpleexpand" example.
2385 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
2386   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
2387   new name, but keep the old name for now for backward compatibility.
2389 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
2390   interpreter - this works with PHP5.
2392 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
2393   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
2394   directory may not exist and "make install" will create it.
2396 * configure: If zend.h isn't found and configure was run with "--with-php",
2397   exit with an error rather than automatically disabling PHP support.
2399 Python:
2401 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
2403 Packaging:
2405 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
2406   various "--without" options in a comment at the start of the .spec file.
2408 * RPMs: Remove "." from the end of the Summary.
2410 Xapian-bindings 0.9.9 (2006-11-09):
2412 Documentation:
2414 * Ship our custom INSTALL file rather than the generic one from autoconf which
2415   we've accidentally been shipping instead since 0.9.5.
2417 General:
2419 * Wrap Flint::open() and Flint::open_writable().
2421 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
2422   suitable).
2424 Python:
2426 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
2427   bit platforms with Python 2.5.
2429 Packaging:
2431 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
2433 * RPMs: The Python bindings now require Python >= 2.2.
2435 Portability:
2437 * configure: Remove unnecessary backticks from tclsh version test.
2439 Xapian-bindings 0.9.8 (2006-11-02):
2441 General:
2443 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
2444   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
2446 * The C++ method QueryParser::parse_query() current throws "std:string"
2447   exceptions if there's a parse error.  Previously the bindings didn't catch
2448   these.  Now we catch them and handle them as if they were exceptions of
2449   type Xapian::QueryParserError (in anticipation of this changing in
2450   xapian-core).  Added testcases for this for PHP, Python, and C#.
2452 * configure: Note that SWIG is only useful for Xapian developers in --help
2453   output.
2455 * configure: If we failed to find any languages to build for, give a more
2456   helpful message.
2458 CSharp:
2460 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
2462 Java:
2464 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
2465   work rather than using the cached failure of the first jni.h check.
2467 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
2469 * SmokeTest.java: Avoid gcj "set but not used" warning.
2471 PHP:
2473 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
2475 * smoketest4.php,smoketest5.php: Check the exception message given by the
2476   DocNotFoundError testcase.
2478 Python:
2480 * Drop support for Python 2.1.
2482 Xapian-bindings 0.9.7 (2006-10-10):
2484 Documentation:
2486 * NEWS: Fix the recent headings which said "Xapian-core" to say
2487   "Xapian-bindings".
2489 General:
2491 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
2492   configure.ac.
2494 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
2495   compiling SWIG generated code which makes the compiled modules a few percent
2496   smaller and perhaps a little faster.
2498 * Wrap the newly implemented transaction API.
2500 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
2501   (this option was supposed to be used to compile the Python bindings from
2502   0.9.3 onwards, but this wasn't actually working correctly).
2504 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
2506 * In maintainer-mode, "make clean" now removes the SWIG generated files
2507   which would otherwise only be removed on "make maintainer-clean".
2509 CSharp:
2511 * Xapian::MatchDecider can now be subclassed in C#.
2513 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
2514   to use it.  This has been fixed and a regression test added.
2516 * SmokeTest.cs: Added exception handling test.
2518 Java:
2520 * Correct two misuses of delete to delete[].  Fixes bug#78.
2522 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
2523   Debian and Ubuntu boxes at least.
2525 PHP:
2527 * We now generate class wrappers for PHP5.
2529 * We now generate proxy classes for PHP4, which is an incompatible change
2530   from previous versions of xapian-bindings.  A perl script to upgrade
2531   your scripts is included.
2533 * smoketest.php:
2535   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
2536     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
2538   + Rely on xapian.php to load the extension module for us.
2540   + Fix error messages to show PHP code, not Python code.
2542 * When running smoketest.php, pass the "-q" option to php, which suppresses
2543   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
2544   recent versions of PHP.
2546 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
2547   the PHP interpreter not to be found in some cases when it was actually
2548   available, but it's only used to run the smoketest not for building the
2549   bindings.
2551 Python:
2553 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
2554   and also report the check and its result to the user.
2556 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
2557   built, so add an explicit dependency so that this works reliably in parallel
2558   builds.  Fixes bug#77.
2560 * In examples and documentation, don't call the MatchDecider class/object
2561   "matcher", since we use the term "matcher" to mean something else in
2562   the library documentation.
2564 * smoketest.py:
2566   + Add test of exception handling.
2568   + Add test that MatchDecider can be subclassed successfully.
2570 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
2571   pythonic iterator class.
2573 Ruby:
2575 * Xapian::MatchDecider can now be subclassed in Ruby.
2577 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
2578   (with no "ruby" alias) on Ubuntu dapper at least.
2580 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
2581   since we may have less than 10 matches, so say "1-<N>" instead.
2583 * simplematchdecider.rb: Implemented.
2585 Tcl:
2587 * Implement saner exception handling for Tcl and document it.
2589 * smoketest.tcl:
2591   + Add check that xapian::Query_OP_ELITE_SET has the right value.
2593   + Rework how the smoketest gets run to eliminate special code for using
2594     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
2595     to be run using installed bindings, and also makes it a better example
2596     program.
2598   + Add test for exception handling.
2600   + Send error messages to stderr.
2602   + Add comment about Tcl storing zero bytes as \xc0\x80.
2604 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
2606 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
2607   used for the Tcl bindings.
2609 Xapian-bindings 0.9.6 (2006-05-15):
2611 Documentation:
2613 * INSTALL: Add section describing how to install without root access.
2615 General:
2617 * Updated to reflect the renaming of Xapian::xapian_version_string and
2618   companions to Xapian::version_string.
2620 * Wrap optional length parameter to Enquire::set_query().
2622 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
2623   consistency.  Keep get_document_id as an alias for now for backward
2624   compatibility.
2626 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
2627   probably a largely harmless error).
2629 * Stop SWIG from adding exception handling wrappers to the calls which return
2630   version strings, since they can't throw exceptions.
2632 * xapian.i: Removed superfluous "const" from return type "docid" which is just
2633   a typedef for an unsigned integer type.
2635 * configure: Add some missing "checking ..." messages so the user has more idea
2636   what is going on.
2638 * Language specific util.i files can now define
2639   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
2640   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
2641   are provided for each language.  This avoids needing to keep this
2642   information in two different places.
2644 * xapian.i: Uncomment commented-out parameter names and fix duplicate
2645   parameter names (for the benefit of bindings which use the parameter names,
2646   like the OO PHP5 patch for SWIG I'm working on...)
2648 Portability:
2650 * configure: Fix warning flags passed for Intel C++ compiler.
2652 CSharp:
2654 * We now support building with Portable.NET.
2656 * Note that the passing of strings from C# into Xapian and back isn't currently
2657   zero byte safe.  If you try to handle string containing zero bytes, you'll
2658   find they get truncated at the zero byte.
2660 * C# bindings now build and pass tests when srcdir != builddir.
2662 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
2663   always say "CSharp" instead.
2665 * Not all machines are set up to run compiled C# programs when invoked
2666   directly, so get configure to check if we can, and otherwise see if using
2667   mono or ilrun works.  If not, just skip the C# tests.
2669 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
2670   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
2671   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
2673 * Move the C# specific %rename list to csharp/util.i.
2675 * Store the strong name key in the key container so we reuse it for later
2676   builds.
2678 * Wrap the version functions as more sensible names and document them (and
2679   continue to provide the older undocumented names for now just in case anyone
2680   was using them.)
2682 * Set the version of XapianSharp.dll correctly when building a snapshot from
2683   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
2685 * SmokeTest.cs: Add test of version functions.
2687 Guile:
2689 * The Guile bindings don't work and aren't being actively worked on, so we're
2690   no longer including them in the distributed tarball to avoid disappointing
2691   users who notice a "guile" subdirectory.  It also makes the download smaller.
2693 Java:
2695 * Simplify (and improve portability of) run-java-test by using "libtool
2696   --mode=execute"'s -dlopen option.
2698 * Need to make sure "built" subdirectory exists or building from clean fails.
2700 * Fix "make check" to work when srcdir != builddir.
2702 PHP:
2704 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
2705   4.3.10), so use "php -n" and then set the options we specifically want using
2706   "-d".
2708 * Fix the smoketest invocation to work better when srcdir != builddir.
2710 * Look for PHP interpreter first in prefix given by "php-config --prefix".
2712 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
2714 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
2716 * smoketest.php:
2718   + Add test for version reporting functions
2720   + If a test fails, say which one to aid debugging.
2722   + Added simple test that zero-bytes are handled correctly when passing
2723     strings to and from Xapian.
2725 Python:
2727 * README: Note that Python bindings have been built with MSVC.
2729 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
2730   to make them executable (they don't have a #! line).
2732 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
2733   "mymatchdecider".  Add description of what this example does.
2735 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
2737 * smoketest.py: Added simple test that zero-bytes are handled when passing
2738   strings to and from Xapian.
2740 Ruby:
2742 * Added new Ruby bindings from Paul Legato.
2744 Tcl:
2746 * smoketest.tcl:
2748   + Add test for version reporting functions
2750   + If a test fails, say which one to aid debugging.
2752   + Added simple test that zero-bytes are handled correctly when passing
2753     strings to and from Xapian.
2755 Xapian-bindings 0.9.5 (2006-04-08):
2757 Documentation:
2759 * HACKING,README: Split off HACKING to contain information which is only
2760   relevant to those wishing to modify the bindings.
2762 General:
2764 * SWIG-based bindings are now built with SWIG 1.3.29.
2766 * configure: Report which languages we're building bindings for just before
2767   configure finishes.
2769 * xapian.i: Make the stub definitions for disabled backends static.
2771 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
2772   message.
2774 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
2776 Packaging:
2778 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
2779   Python bindings to support 64 bit systems.
2781 * RPMs: Package the C# bindings.
2783 Portability:
2785 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
2786   different name.
2788 * configure: Detect Intel's C++ compiler and set suitable warning flags to
2789   avoid noise from compiling generated code.
2791 CSharp:
2793 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
2795 Guile:
2797 * configure: Disable --with-guile since Guile support doesn't currently work.
2799 Java:
2801 * Override deprecation warnings for Xapian methods/functions/etc.
2803 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
2804   have some idea what went wrong!
2806 * Rework how we include headers to get hash_map to avoid compiler warnings
2807   since it's usually not in the std namespace nowadays.
2809 * Previously the "all" target also ran the "install" target, but this has
2810   proved very problematic, so change "make check" to use the uninstalled JNI
2811   glue library, and update the instructions to say that "make install" is now
2812   required.
2814 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
2815   .class files.
2817 * README: Note that some platforms need "-pthread" or similar flags.
2819 * Add a new Query constructor wrapper which take an OP_xxx and an array of
2820   Query objects.
2822 * Compiling a .java file to a .class file now deletes the .jar file to ensure
2823   it gets updated.
2825 PHP:
2827 * php -n avoids reading any php.ini, but the compiled in default may be to
2828   enable the dubiously named "safe_mode" which prevents dl() being used so
2829   "make check" fails.  So instead provide a very simple php.ini which turns off
2830   safe_mode and makes sure enable_dl is on.
2832 * Fix handling of bool parameters when resolving overloaded methods and/or
2833   default arguments.  This fixes Enquire_sort_by_value() to work when the
2834   second argument is specified.  Added regression test for this case.
2836 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
2838 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
2839   passed by reference.  Fixes bug#74.
2841 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
2842   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
2844 Python:
2846 * Use the fairly new "swig -O" option for the "modern" python bindings as
2847   it generates a smaller glue library and runs faster.  Some of the features
2848   enabled also work on python 2.1, so enable these for the "olde" bindings.
2850 * configure: Catch the case where the user has python installed but not the
2851   module "distutils.sysconfig" and explain that they probably need to install a
2852   python-dev or python-devel package.
2854 * "make check" now works in VPATH builds.
2856 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
2857   know which check it was!
2859 * smoketest.py: catch Exception objects and print them.
2861 * smoketest.py: Add feature tests for the various pythonic iterator
2862   wrappers
2864 * python/docs/bindings.html: Document the Pythonic iterators.
2866 * Fix TermIter not to try to read termfreqs or positions if they aren't
2867   meaningful for the current TermIter.
2869 Xapian-bindings 0.9.4 (2006-02-21):
2871 Documentation:
2873 * COPYING: Updated FSF address.
2875 General:
2877 * Wrap Stopper::get_description().
2879 * Wrap xapian_version_string() and related functions.
2881 Portability:
2883 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
2884   run from "make" too.
2886 PHP:
2888 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
2889   default on Windows).
2891 Python:
2893 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
2895 Xapian-bindings 0.9.3 (2006-02-16):
2897 Documentation:
2899 * README: Updated and expanded (now covers supported platforms, and lists
2900   criteria which bindings for an additional language need to fulfil before
2901   we're likely to accept them).
2903 * INSTALL: Updated and improved.
2905 * TODO: Move C#-specific TODO to top level so we can track to-do items for
2906   all languages.
2908 General:
2910 * configure: Change how the user selects which bindings to build.  If no
2911   --with* arguments are passed, then we default to building bindings we detect
2912   the required tools for (as before).  But instead of requiring the user to
2913   deselect all bindings they don't actually want, we now let them select the
2914   bindings they do want.  So "./configure --with-python" will only build the
2915   python bindings (and will fail if the required tools aren't installed).
2917 * Every wrapped method contains exception handling code.  The bulk of this
2918   is now factored out into a single helper function, which cuts the compile
2919   time by around a factor of 3 and halves the size of the stripped library
2920   (figures are for Tcl on x86_64).
2922 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
2923   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
2925 * configure: Bump required SWIG version to 1.3.28 and drop the special
2926   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
2927   SWIG to install the bindings - SWIG is run by the Xapian developers
2928   so these updated requirements are only relevant if you want to modify
2929   the bindings.
2931 * Eliminate separate Makefile in each examples subdirectory, which makes the
2932   build system simpler, smaller, and a little faster.
2934 * xapian.i: Include default constructors for all classes so that SWIG knows it
2935   doesn't have to use SwigValueWrapper for them, which makes the bindings code
2936   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
2937   std::pair<...>.
2939 * configure: Document special environmental variables which configure
2940   recognises.  Enhance handling of environmental variables so you can
2941   e.g. './configure PYTHON=python23' (previously you had to give a full
2942   path in such environmental variables or they would be ignored.
2944 Packaging:
2946 * RPM spec file:
2948   + Automatically detect the python version.
2950   + Rename "php4" references to "php".
2952   + Automatically detect the PHP extension directory.
2954   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
2956   + Add support for "--without php" and --without tcl8" options to rpmbuild.
2958 Portability:
2960 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
2961   10.3.  This is required to link the bindings, and it doesn't seem to be
2962   possible to link them on 10.1 or 10.2 anyway.
2964 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
2965   to be explicitly specified and libtool correctly handles platforms where it
2966   would have been implicitly linked with anyway.
2968 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
2970 * configure: Add missing ";;" on the last alternative in some case statements.
2972 * Only pass -no-undefined on platforms where it is required in order to link a
2973   shared library at all (it causes problems on Mac OS X in some cases).
2975 CSharp:
2977 * This release includes a lot of improvements for the C# bindings.  They're
2978   now pretty much on a par with the other language bindings.
2980 * Added documentation and examples.
2982 * Method and function names are now renamed to match C# conventions
2983   (e.g. from get_description() to GetDescription()).  This is obviously an
2984   incompatible change, but the C# bindings haven't been suitable for real world
2985   use prior to this release.
2987 * Optional parameters are now wrapped so no longer need be specified
2988   explicitly.
2990 * Overload ++ and -- for iterators.
2992 * Overload == and != for iterators.  Now comparisons with the end iterator
2993   work as expected, and SmokeTest passes.
2995 * SmokeTest now reports exceptions verbosely.
2997 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
2998   similarly for other database factory functions.
3000 * Heed compatibility warnings from mcs and use different forms for
3001   command-line switches to the C# compiler (presumably for compatibility with
3002   Microsoft's compiler, though the warnings don't actually say that
3003   explicitly).
3005 Guile:
3007 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
3008   zero-byte safe.  The guile bindings are still a long way from actually
3009   working though.
3011 Java:
3013 * Wrap optional second parameter (query length) to Enquire::set_query().
3015 * configure now probes for the Java path separator, which we then use to
3016   separate entries in the java -classpath command line option so we can
3017   build on platforms where it isn't ":".
3019 * SmokeTest.java: Expand to test more features.
3021 * java/README:
3023   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
3025   + Add note about how wrapped methods are named.
3027 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
3028   validity check.
3030 * Query.java: Comment out unused code.
3032 * Fixed memory leak in Query-from-array-of-strings constructor.
3034 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
3035   Xapian::Error subclasses can tell you their typename directly (using
3036   get_type()).
3038 PHP:
3040 * Some problems with overloaded methods in PHP have been fixed by a major
3041   overhaul of SWIG's PHP support.  So we no longer rename such methods
3042   for PHP.  This is an incompatible change, but it's easy to update your
3043   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
3045 * Previously the documentation and simpleindex.php suggested that you
3046   should call delete_CLASS().  This was incorrect and resulted in a
3047   double-free() in some cases, so we've fixed the documentation and
3048   examples and eliminated the delete_CLASS() wrappers.  This is another
3049   incompatible change, but again easy to update for.
3051 * We now support PHP5 as well as PHP4, so the configure test now looks
3052   for either and all references to "PHP4" or "php4" have been adjusted.
3054 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
3055   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
3056   warning and making the method return "Null".  This isn't ideal, but it's
3057   the best we can easily do without proper exceptions.
3059 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
3060   empty php.ini in srcdir (which we were failing to distribute anyway), use
3061   "$(PHP) -n" which tells PHP not to use any php.ini file.
3063 * Update PHP documentation to include new features.
3065 * Redo Xapian section in phpinfo() to look more like most other modules.
3067 * You can now construct a Query object from an array of strings or Query
3068   objects (or even a mixture).
3070 * PHP examples now give a more useful error message if a database can't be
3071   opened.
3073 * smoketest.php: Expanded the tests performed, including feature tests for
3074   the new Query-from-list constuctor.
3076 * simplesearch.php: Use newly wrapped Query-from-list constructor.
3078 * Use std::string::data() instead of c_str() as it may be more efficient for
3079   some STL implementations.
3081 * Enquire::get_matching_terms() now generates the PHP list directly from the
3082   TermIterator rather than constructing a temporary C++ std::list, which is
3083   faster and requires less temporary memory.
3085 Python:
3087 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
3088   once again (it has been broken since 0.9.0).  Added a regression test to
3089   help keep this working.
3091 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
3092   instead of a list).  Also the sequence can contain xapian.Query objects or
3093   strings or a mixture.  Documented these enhancements.
3095 * smoketest.py: Expanded the tests performed.
3097 * Convert C++ strings to python ones in a zero-byte clean way.
3099 * Added more error checking of the results of calls into the python
3100   interpreter.
3102 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
3103   itself is compiled with this option to avoid problems and it appears we ought
3104   to use it too to avoid the risk of hitting the same problems, although I'm
3105   not aware of anyone actually encountering such problems).
3107 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
3108   avoid creating a broken xapian.pyc is the shared library can't be loaded for
3109   some reason.
3111 * Enquire::get_matching_terms() now generates the Python list directly from the
3112   TermIterator rather than constructing a temporary C++ std::list, which is
3113   faster and requires less temporary memory.
3115 Tcl:
3117 * Terms with a leading underscore now work (thanks to changes in SWIG).
3119 * Implement custom typemaps for Tcl, so that you can now construct a Query from
3120   a list of Query objects and/or strings, and Enquire::get_matching_terms is
3121   now wrapped.
3123 * simplesearch.tcl: Use the new Query from list constructor.
3125 * simplesearch.tcl: Fix to lowercase and stem query terms.
3127 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
3129 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
3131 Xapian-bindings 0.9.2 (2005-07-15):
3133 General:
3135 * Added wrappers for new optional flags argument to QueryParser::parse_query().
3137 CSharp:
3139 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
3140   another tool with the same name.
3142 Java:
3144 * Include SmokeTest.java in the distribution so "make check" works.
3146 * Added success report for Sun java 1.4.1_01a.
3148 Python:
3150 * When converting a python list to vector<string> we know the number of elements
3151   so reserve that number in the vector.
3153 Xapian-bindings 0.9.1 (2005-06-06):
3155 General:
3157 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
3159 Tcl:
3161 * Updated documentation to include information from Michael Schlenker about how
3162   to delete a database object such that the destructor gets called.
3164 Xapian-bindings 0.9.0 (2005-05-13):
3166 General:
3168 * Updated SWIG-based bindings to latest Xapian API
3170 * Improve support for building the bindings on MS Windows:
3172   + Provide stub versions of any backend functions which are disabled in the
3173     library we're wrapping to avoid a link failure on MS Windows (where the
3174     remote backend is automatically disabled).  These stubs just throw
3175     Xapian::FeatureUnavailableError.
3177   + Add -no-undefined to *_la_LDFLAGS.
3179   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
3180     appropriate.
3182   + For python, paths for finding headers and installing libraries are now
3183     handled so they work on MS Windows; an extra static library needs to be
3184     linked in too.
3186 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
3187   for disabled backends).
3189 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
3190   being useful functionality.
3192 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
3193   introduced in future get fixed.
3195 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
3196   have.
3198 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
3199   1.3.22 for as more recent versions don't work with methods with optional
3200   arguments - the arguments become non-optional!)
3202 Guile:
3204 * configure: Disable guile by default, as it needs more work.
3206 Java:
3208 * Updated to compile against 0.9.0 API.
3210 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
3212 * Wrap optional parameters to Query(term) constructor.
3214 PHP4:
3216 * For PHP4, rename default Database constructor to Database_empty
3217   instead of suppressing the much more useful Database(const string &path)
3218   constructor.
3220 * Use a blank config file when running PHP4 tests to avoid problems
3221   when the bindings are already installed as an extension which is
3222   loaded automatically in the default config.
3224 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
3225   it probably just means it's not in PATH.  We only need it for running tests,
3226   so substitute a trivial shell script which just exits with code 77 so PHP
3227   tests are skipped (previously we substituted "missing" which caused the tests
3228   to fail).
3230 Python:
3232 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
3233   and ValueIter.
3235 * configure: If python is found, also check that Python.h exists (it may not be
3236   if the python-dev package (or similar) isn't installed).
3238 Xapian-bindings 0.8.5.1 (2005-02-23):
3240 General:
3242 * configure: Run compiler feature tests using the C++ compiler, not the C
3243   compiler.
3245 * Allow bindings version to have an extra "patchlevel", yet still match with
3246   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
3248 Java:
3250 * Added a missing .java source file and removed several unused ones.
3252 * Fixed several glitches in the java bindings automake build system.
3254 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
3255   warnings in generated code (we were carefully passing "-Wunused"
3256   which is the opposite of what is needed!)
3258 * Fixed a couple of warnings from GCJ.
3260 * Wrapped a few missing methods added since Eric created the bindings.  There
3261   are still some missing methods - there's now a (probably incomplete) list in
3262   java/README.
3264 * Added various useful bits of information to java/README.
3266 * Tweaked SimpleSearch.java to be more like the C++ version.
3268 PHP4:
3270 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
3271   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
3272   a more recent version.
3274 * configure: Check for "php" as a program name as well as "php4", and
3275   fall-back to missing so the error message from "make check" is better.
3277 Xapian-bindings 0.8.5 (2004-12-23):
3279 General:
3281 * INSTALL: Added non-generic installation instructions.
3283 Python:
3285 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
3286   the same directory as xapian.py, but Makefile.am was looking in current
3287   directory when installing it.  Additionally, VPATH builds were broken.
3288   These problems were introduced by changes in 0.8.4.
3290 Xapian-bindings 0.8.4 (2004-12-08):
3292 General:
3294 * README: Now clearly says which languages we currently support, which people
3295   are working on, etc.
3297 * Instead of requiring the user to have a really recent SWIG installed, ship
3298   the files SWIG generates.  Disable all the SWIG rules unless configure is run
3299   with --enable-maintainer-mode to make sure they aren't triggered accidentally
3300   (e.g. by make with dodgy VPATH).
3302 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
3303   needed if you just want to install the bindings).
3305 * Wrap the new Database and WritableDatabase constructors which replace
3306   Auto::open().
3308 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
3309   (for example, simpleexpand.py needs it).
3311 * In the Query constructor which takes a vector of terms, only call set_window
3312   if window is non-zero.  Otherwise things go wrong if we're passed an empty
3313   vector.
3315 * Second argument to Document::add_posting() isn't optional, but xapian.i
3316   indicated that it was.
3318 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
3319   Deriving your own weight class in the scripting language isn't currently
3320   supported.
3322 * xapian.i: %name is deprecated, so use %rename instead.  This also works
3323   around a bug in SWIG 1.3.23.
3325 * configure: Removed pointless probe for a C compiler - everything we compile
3326   is C++.
3328 * configure: Reinstated the check that the bindings version matches the version
3329   of the xapian library.  It was added in 0.8.2, but accidentally removed in
3330   0.8.3.
3332 * Use newly added option `xapian-config --swigflags` which (a) avoids always
3333   passing -I/usr/include which could cause problems if we're using a Xapian
3334   install not in /usr and there's another one in /usr and (b) avoids problems
3335   if `xapian-config --cxxflags` contains flags other than -I<something>.
3337 CSharp:
3339 * Richard Boulton has put together bindings for C#.  These build successfully
3340   with the Mono tools, but the smoketest currently fails.  Unclear if the
3341   problem is the bindings or the smoketest code.
3343 Guile:
3345 * The guile bindings now build successfully, so we've enabled the guile
3346   detection machinery in configure.  They're untested though (we don't
3347   know guile!) so success or failure reports are encouraged!
3349 PHP4:
3351 * Mention the example scripts near the start of the documentation, not right at
3352   the end.
3354 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3355   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3356   mention!
3358 Python:
3360 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
3361   work in Python.
3363 * Changed examples to use the newly wrapped Query from list of terms ctor.
3365 * Mention the example scripts near the start of the documentation, not right at
3366   the end.
3368 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
3369   SWIG.
3371 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3372   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3373   mention!
3375 * Mention simpleexpand example in documentation.
3377 * Examples now report messages for Xapian exceptions.
3379 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
3381 * Make the example MatchDecider exclude documents matching a value, rather than
3382   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
3383   don't want examples to mislead like that.
3385 * python/docs/bindings.html: Note that you can construct a query
3386   from a list of terms, even if you can't from a list of queries.
3387   Add HTML links to the examples.
3389 * simpleindex.py: Trim spaces from the start as well as from the end of each
3390   line.  Simplify the loop slightly.
3392 Tcl:
3394 * Wrap in a tcl8 namespace "Xapian".
3396 * Added a smoketest.
3398 * Translated simpleindex and simplesearch into Tcl.
3400 * Set the Tcl package version.
3402 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
3404 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
3406 * Added documentation for tcl8 bindings.
3408 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
3409   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
3410   version (was 8.0).
3412 * configure.ac: Noted that the bindings can easily be compiled for use with
3413   Tcl 8.0, in case anybody needs that for some reason.
3415 * Don't wrap the factory functions which return a quartz WritableDatabase as
3416   the destructor never gets called so changes aren't flushed and the lock file
3417   isn't removed.
3419 Xapian-bindings 0.8.3 (2004-09-20):
3421 General:
3423 * Fixed mismatching versions of libtool used to produce configure and
3424   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
3425   names.
3427 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
3428   PHP4, and Tcl bindings.
3430 Java:
3432 * Pass -classpath to javac to fix build problems.
3434 * Make sure errors subdirectory is built before we try to build the jar file.
3436 * Fixed "make install" to not give libtool error.
3438 PHP4:
3440 * Include PHP4 documentation and exmples in the tarball.
3442 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
3443   change from 0.8.2 - it turns out we only need to pass these flags if we use
3444   swig's -noruntime option (which we don't do).
3446 Python:
3448 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
3449   faster Python wrapper code.
3451 Tcl:
3453 * Don't install xapian.la.
3455 * Improved configure check for tcl.h to work with Fedora Core 2.
3457 Xapian-bindings 0.8.2 (2004-09-13):
3459 General:
3461 * Added wrappers for recently added methods: ESet::back() and
3462   Database::get_lastdocid(), and wrap the new optional third parameter
3463   to Enquire::set_sorting().
3465 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
3467 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
3469 * Wrap Quartz, InMemory, and Remote database factory functions as
3470   quartz_open(), inmemory_open(), and remote_open().
3472 * Added missing wrappers for static Stem::get_available_languages() and
3473   Stem::get_description().
3475 * Wrap renamed method Query::empty() (was Query::is_empty()).
3477 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
3478   as an alias for now).
3480 * Require autoconf 2.59 and automake 1.8.5.
3482 * configure: Added check that the bindings version matches the version of
3483   the xapian library.
3485 * configure: Check if we're using GCC and only pass GCC specific warning
3486   control options if we are.
3488 * configure: When running with GCC, also pass -Wno-uninitialized so the
3489   SWIG glue builds without warnings.
3491 * README: Updated list of languages which SWIG supports.
3493 PHP4:
3495 * Document that the 2 argument form of Xapian::Auto::open() for opening a
3496   writable database is wrapped as open_writable() (bug #32).
3498 * Include Xapian version in output from phpinfo().
3500 * Build the SWIG glue library like we build the others rather than using
3501   SWIG's -phpfull option.  This avoids problems with newer automake versions
3502   and means we can build against an uninstalled xapian library.
3504 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
3505   Fixed documentation of how Xapian::Query::OP_* are wrapped.
3507 * Use special SWIG PHP ldflags when linking the PHP glue library.
3509 * simplesearch.py now works with multi-term queries.
3511 * Added documentation on how to install the PHP4 bindings.
3513 * Added a simple testcase to at least ensure the PHP4 bindings can be
3514   initialised and some simple operations work.
3516 Python:
3518 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
3520 * Don't install _xapian.la and _xapian.a.
3522 * Byte compile xapian.py to xapian.pyc and install it.
3524 * Suppress SWIG warning about MatchDecider::operator() director discarding
3525   const.
3527 * "make clean" no longer leaves "xapian_wrap.h" behind.
3529 * Added a simple testcase to at least ensure the python bindings can be
3530   initialised and some simple operations work.
3532 Tcl8:
3534 * configure: Disable building tcl8 bindings if the headers are missing
3535   (probably because the tcl8.X-dev package isn't installed).
3537 Xapian-bindings 0.8.1 (2004-06-30):
3539 General:
3541 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
3543 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
3544   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
3545   doesn't emit -I/usr/include in this situation (because it causes problems
3546   with some GCC versions).
3548 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
3549   not just a subset.
3551 Java:
3553 * Removed wrappers for unused error classes which have been pruned from C++.
3555 * Make finalize() methods of Database and WritableDatabase public so they can
3556   be called from by the user.
3558 * Document Document.add_term_nopos() as deprecated.
3560 PHP4:
3562 * Make sure that PHP bindings build a module which exports get_module() so PHP
3563   is able to load it.
3565 * Configure now checks that phpize can actually be run, rather than just that
3566   it's executable (test -x isn't portable anyhow).
3568 * Added basic documentation and examples to PHP4 bindings.
3570 * Rename overloaded methods and constructors.
3572 * Add simple access to the prefixes map in QueryParser.
3574 * Correct simpleindex ports to never generate empty termnames.
3576 Python:
3578 * configure: Use $PYTHON instead of python when running python to determine
3579   library and include paths and version number.
3581 * Actually ship python examples and documentation.
3583 Xapian-bindings 0.8.0 (2004-04-20):
3585 * README: Started collecting information on supporting Xapian from even
3586   more languages.
3588 * Added configure tests to enable bindings only where the necessary tools
3589   are installed and have a supported version.  ./configure --without-LANGUAGE
3590   allows particular languages to be forcibly disabled.
3592 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
3594 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
3596 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
3597   have been well tested, but integration with the xapian-bindings configure
3598   system hasn't been tested at all - please alert us to any problems.
3600 * Xapian can now be used from TCL.
3602 * Python: MSet now provides a Python iterator.
3604 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
3606 * Python: enable directors for MatchDecider, to allow subclassing in Python.
3608 * Python: Added basic documentation, and some examples.