[bootstrap] Use SWIG 4.2.0
[xapian.git] / xapian-bindings / NEWS
blob2472217100dd351782dea351d014917e4a807e4e
1 Xapian-bindings 1.4.24 (2023-11-06):
3 Portability:
5 * swig-depcomp: Strip CR from generated files which fixes an issue in some
6   cases when building from git on Microsoft Windows.
8 Lua:
10 * Use pkg-config for Lua flags instead of some rather ad-hoc configure probes.
11   This improves portability to platforms which require linking to a Lua
12   library, or which install the Lua headers directly without a versioned
13   containing directory.
15 PHP8:
17 * Update configure probe PHP_LIBS on cygwin.  Based on patch found in cygwin
18   packaging, authored by Yaakov Selkowitz.
20 Tcl:
22 * Fix to handle the case of tcl_pkgPath not existing, which happens on
23   Microsoft Windows builds of Tcl.
25 * run-tcl-test: Fix not to hardcode smoketest.tcl and instead run the program
26   specified on the command line.
28 * Use TCL_SHLIB_EXT for the installed extension which is what Tcl expects.
29   Previously the installed Tcl extension used the filename extension that
30   libtool thinks is right for modules on the current platform.  We're not
31   currently aware of platform where these actually differ, so this may be just
32   a latent bug.
34 * Improve configure probe for stub library to work if the tclConfig.sh we find
35   forwards to a different script, as is the case with /usr/lib/tclConfig.sh on
36   current Debian.  On Debian at least our method for finding the tclConfig.sh
37   to use doesn't find such a forwarding script, but it seems better to be
38   robust to this.
40 * Eliminate special cygwin handling which is no longer needed.
42 Xapian-bindings 1.4.23 (2023-07-07):
44 Documentation:
46 * Where we document how to build the bindings, link to the download page so
47   the reader can easily find the source to download.  Reported by John G. Heim.
49 * Update lists of debian packages to install for bindings development to
50   show be for the latest stable release and the one before (bookworm and
51   bullseye).
53 * HACKING: Fix typos in deprecation warning section
55 * HACKING: Update link to Pike bindings
57 * HACKING: Document issues caused by macOS SIP.  Fixes #732.
59 General:
61 * Add `FLAG_NGRAMS` as a preferred new alias for `FLAG_CJK_NGRAM` and
62   `SNIPPET_NGRAMS` as a preferred new alias for `SNIPPET_CJK_NGRAM`.
63   In the next release series these features have been expanded to cover many
64   more languages so the "CJK" in the name has become inaccurate as it stands
65   for "Chinese, Japanese and Korean").
67 * Avoid running pwd in makefiles since the directories we need are available in
68   automake variables.
70 CSharp:
72 * SmokeTest.cs: Fix some incorrect messages if testcases fail.
74 * Smoketest.cs: Test stemmer description.
76 Lua:
78 * Update docs for supported Lua versions.
80 Perl:
82 * Generate HTML docs for each class.
84 * Document all QueryParser FLAG_* constants.
86 * Update one place which didn't correctly indicate the current status of the
87   Perl bindings.  Fixes #523.
89 Python:
91 * Fix bug in wrapper for xapian.Query when constructing OP_WILDCARD queries.
92   A workaround for this bug which works with existing releases is to pass
93   0 for the third and fourth optional parameters like so:
95   xapian.Query(xapian.Query.OP_WILDCARD, "xyz", 0, 0)
97 Python3:
99 * Fix bug in wrapper for xapian.Query when constructing OP_WILDCARD queries.
100   A workaround for this bug which works with existing releases is to pass
101   0 for the third and fourth optional parameters like so:
103   xapian.Query(xapian.Query.OP_WILDCARD, "xyz", 0, 0)
105 Ruby:
107 * Improve documentation about __call__ methods.
109 Xapian-bindings 1.4.22 (2023-02-02):
111 Lua:
113 * When passing a Lua function for a Xapian functor object, the wrapper
114   object was leaked in most cases (except for Xapian::StemImplementation).
116 Perl:
118 * Fix testsuite and docs for Perl 5.36.0 change.
120   Prior to Perl 5.36.0 retrieving the string value of an integer could set
121   the flag read by "SvPOK()", but that's no longer the case in Perl 5.36.0
122   and later.
124   We already document the need to explicitly stringify numeric values
125   passed where a string is needed, so just add the missing stringification
126   to the testcase and document that it's required in more places when using
127   Perl 5.36.0 and later.
129 PHP8:
131 * Add support for PHP8 (PHP 8.0, 8.1 and 8.2 should all work).
133   The PHP bindings are now implemented entirely in C++ code using PHP's
134   C extension API, and the `xapian.php` wrapper file no longer exists.
135   This change means smaller and faster bindings.  See the documentation for a
136   recommended way to write code which works with both PHP7 and PHP8 bindings.
138   To add PHP8 support we've had to drop support for PHP7.  PHP7.4 reached end
139   of life on 2022-11-28 so hopefully this isn't a problem for too many people,
140   but if you need support for PHP7 please use xapian-bindings <= 1.4.21.
142   Fixes #817, reported by Ryan Schmidt.
144 * We now set the version in the metadata of the PHP module to the
145   xapian-bindings version (previously it was unversioned).
147 Python:
149 * Drop support for Python 2.6.  We need to use SWIG 4.1.0 for PHP8 support, but
150   that no longer supports Python 2.6 so we have to raise the minimum Python 2
151   version to Python 2.7.
153   The last Python 2.6 release was in 2013 so hopefully this isn't a problem for
154   anyone, but if you still need to use Python 2.6 please use xapian-bindings <=
155   1.4.21.
157 Python3:
159 * Drop support for Python 3.2.  We need to use SWIG 4.1.0 for PHP8 support, but
160   that no longer supports Python 3.2 so we have to raise the minimum Python 3
161   version to Python 3.3.
163   The last Python 3.2 release was in 2014 so hopefully this isn't a problem for
164   anyone, but if you still need to use Python 3.2 please use xapian-bindings <=
165   1.4.21.
167 Ruby:
169 * Fix new Ruby 3.2 warning "undefining the allocator of T_DATA class
170   swig_runtime_data" (fixed by the change to using a newer SWIG version).
172 Xapian-bindings 1.4.21 (2022-09-22):
174 Documentation:
176 * Consistently say "macOS" not "Mac OS X", "OS X", etc.
178 General:
180 * Update to use AX_CXX_COMPILE_STDCXX which is a replacement for
181   AX_CXX_COMPILE_STDCXX_11 (which we were using) which also supports newer C++
182   standards versions which will be useful.  For C++11 the only difference seems
183   to be that the macro now checks for attribute support - we use C++11
184   attributes so that seems a good thing.
186 Portability:
188 * Drop special handling of MACOSX_DEPLOYMENT_TARGET.  This was only relevant
189   for macOS 10.3 and (for powerpc only) 10.4, and Apple dropped support for
190   10.4 in 2009.
192 Java:
194 * Document where to install .jar on macOS. Partly addresses #774, reported by
195   Ryan Schmidt.
197 Xapian-bindings 1.4.20 (2022-07-04):
199 General:
201 * Enable -fvisibility-inlines-hidden option if the compiler supports it.
203 PHP7:
205 * Add missing reference tracking. XapianEnquire now keeps a reference to the
206   current XapianSorter object (if any).  XapianQueryParser now keeps a
207   reference to any set XapianFieldProcessor objects.  Test coverage for keeping
208   references to set functor objects is now more comprehensive.
210 * smoketest.php: Remove bogus extra null parameters.  PHP ignores these extra
211   parameters, but it's more helpful to be testing valid usage.
213 Python3:
215 * The configure probes for Python3 no longer use the deprecated distutils and
216   imp modules (both of which are slated for removal in Python 3.12).  We now
217   use sysconfig to get the directory to install the xapian module to, which may
218   result in it being installed in a different place (it should still work, but
219   if you're packaging the bindings you may need to update the list of files to
220   include in the package).
222 Xapian-bindings 1.4.19 (2021-12-31):
224 Documentation:
226 * configure: Add missing AC_ARG_VAR for all programs so that they are
227   documented in --help output, and so that autoconf knows they are "precious"
228   and preserves them if configure is rerun even when they're specified via an
229   environment variable.
231 General:
233 * Replace uses of obsolete autoconf macros, fixing warnings if configure is
234   regenerated with a recent release of autoconf.
236 Perl:
238 * Add missing wrappers for some QueryParser FLAG_* constants.
240 * Fix incorrect formatting in the processed POD documentation due to missing
241   escaping of `>` in code snippets.
243 PHP:
245 * Make configure PHP5 version check more robust.  Previously it would have
246   incorrectly accepted any (future) PHP version >= 10.0.0.
248 PHP7:
250 * configure: We now reject PHP8 since it isn't currently supported
251   by a released version of SWIG.  SWIG 4.1.0 will supports PHP8.
253 * configure: Check for php-config7.4 as well as earlier 7.x versions
254   and php-config.
256 Python3:
258 * Fix deprecation warnings with Python >= 3.9.
260 * Remove more files/dirs on "make clean".  Reported by Gaurav Arora.
262 Ruby:
264 * Fix build with Ruby 3.0 and clang. Reported by Eduard Panov on macos, where
265   clang is the default compiler.
267 * Improve markup in Ruby bindings docs.
269 Xapian-bindings 1.4.18 (2021-01-14):
271 Portability:
273 * Support macOS 11.0 - AC_CANONICAL_HOST identifies this as darwin20, which
274   wasn't caught by our glob pattern.  Patch from FX Coudert in
275   https://github.com/xapian/xapian/pull/319
277 CSharp:
279 * Wrap const std::string* parameters to accept a string or null in C#.  See #204.
281 Java:
283 * Wrap const std::string* parameters to accept a String or null in Java.
285 Perl:
287 * Fix minor documentation typo.
289 Xapian-bindings 1.4.17 (2020-08-21):
291 * No user-visible change except for bumping the version to indicate
292   compatibility with Xapian-core 1.4.17.
294 Xapian-bindings 1.4.16 (2020-06-08):
296 General:
298 * Remove code to support SVN snapshots since we stopped using SVN more than 5
299   years ago.
301 * Ignore overloads for logical ops, *, /.  These were already ignored for
302   several languages, and aren't actually usefully wrapped for any of the other
303   languages.
305 CSharp:
307 * Work around mono terminfo parsing bug in more cases.  With this, "make",
308   "make check", "make install" and "make uninstall" all work on Ubuntu 18.10.
309   Patch from Dipanshu Garg, fixes https://github.com/xapian/xapian/pull/287 and
310   #801.
312 Lua:
314 * Allow passing a Lua function as a MatchSpy.  This was supposed to be
315   supported already, but the typemaps weren't set up.
317 * On platforms where sizeof(long) is 4, SWIG was wrapping Xapian::BAD_VALUENO
318   as a negative constant in Lua, which was then rejected by a check which
319   disallows passing negative values for unsigned C++ types.  We now direct SWIG
320   to handle Xapian::valueno as double (which is what numbers in Lua usually
321   actually are) which gives us an unsigned constant, and also eliminates the
322   negative value check.
324 * Correct documentation - get_description() is wrapped as tostring() in Lua,
325   not str() as we previously claimed.
327 * Add test coverage for passing Lua function for a Stopper.
329 Perl:
331 * Resolve the remaining issues and remove the "experimental" marker:
333   + Add search_xapian_compat() function which sets up aliases in the
334     Search::Xapian namespace to aid writing code which uses either
335     Search::Xapian or this module.
337   + Allow passing Perl sub for simpler Xapian functor classes.  This fills in a
338     missing feature compared to Search::Xapian.  See #523.
340   + Remove useless PerlStopper class which was an incomplete copy of the
341     apparently non-functional Search::Xapian::PerlStopper.  We now support
342     passing a Perl sub for a Stopper object.
344   + Adjust some method names to match Search::Xapian.  Iterators now support
345     inc() (and dec() where the C++ class supports operator--) like
346     Search::Xapian, rather than increment() and prev().  Reported by Eric Wong
347     in #523.
349   + Drop undocumented and unexpected extra equals() method.
351   + Provide compatibility with ENQ_ASCENDING, etc constants.  SWIG wraps these
352     as $Xapian::Enquire::ASCENDING, which better matches the C++ API, but
353     Search::Xapian wraps this as Search::Xapian::ENQ_ASCENDING, etc so provide
354     those too for compatibility.  Reported by Eric Wong in #523.
356   + Drop stringification and int conversion overloads.  These seem more
357     confusing than helpful, and overloading stringification works badly
358     with SWIG-generated bindings.
360   + Document remaining known differences from Search::Xapian.
362 * Update recently tested versions in README.
364 * Improve documentation.
366 * Fix t/02pod.t to look for files in right directory.
368 Ruby:
370 * Don't print iterator sizes to stdout.  This was some debugging accidentally
371   left in as part of a change in 1.4.12.  Patch from Dan Callaghan.
373 Xapian-bindings 1.4.15 (2020-02-24):
375 Perl:
377 * Improve comment about App::Prove.
379 Ruby:
381 * Support Ruby 2.7.
383 Xapian-bindings 1.4.14 (2019-11-23):
385 Python:
387 * Remove broken replicationtest.py.  It's never worked reliably, and because
388   of that was disabled shortly after being added over a decade ago.
389   Unsurprisingly it's bit-rotted at least a bit since.  Nobody seems interested
390   in fixing it, so it's time to just get rid of it.  Closes #320.
392 Python3:
394 * Remove broken replicationtest.py.  It's never worked reliably, and because
395   of that was disabled shortly after being added over a decade ago.
396   Unsurprisingly it's bit-rotted at least a bit since.  Nobody seems interested
397   in fixing it, so it's time to just get rid of it.  Closes #320.
399 Xapian-bindings 1.4.13 (2019-10-14):
401 General:
403 * Omit SWIG exception handling for destructors.  Since C++11, destructors can't
404   throw by default and we don't override that default, so there's no point
405   adding exception handling code for them.
407 * Ensure doccomments.i is distributed.  If you unpacked a distribution tarball,
408   configured it and then ran "make dist" python/doccomments.i and
409   python3/doccomments.i would be missing unless you configured the tree with
410   --enable-maintainer-mode.
412 PHP:
414 * Check for php-config5.6 and php-config5.5 in configure as these versioned
415   names are used in some packages (such as those from the ondrej/php PPA).
417 PHP7:
419 * Work around build failure on Illuminos.  Fixes
420   https://trac.xapian.org/ticket/793, reported by Amitai Schleier.
422 Ruby:
424 * smoketest.rb: Use #push not #append on Array to restore compatibility with
425   Ruby < 2.5 (broken by changes in 1.4.12).
427 * Expand tabs in Ruby code since using spaces for indentation seems to be
428   preferred Ruby style.
430 * Remove trailing `;` from Ruby code.
432 Xapian-bindings 1.4.12 (2019-07-23):
434 Documentation:
436 * Update bindings HACKING document.  Reported as out of date by Niwesh Gupta.
438 CSharp:
440 * Work around mono terminfo parsing bug - older cli-sn fails with e.g.
441   TERM=xterm-256color due to: https://github.com/mono/mono/issues/6752
442   Encountered on Kubuntu 18.10 and debugged by Tejasvi Tomar.  Seems to be
443   fixed in the mono version in Debian buster.
445 Perl:
447 * Suppress warnings from older Perl headers due to use of constructs which look
448   like C++11 user-defined literals.  They're fixed in newer versions so they're
449   just noise in our build.  We were working around these in the CI build, so
450   drop that workaround as we want to make the build warning-clean for users
451   too.  Reported by daniel93 on #xapian.
453 Python3:
455 * Fix build for changes in Sphinx 2.0 (which drops support for sphinx.main()).
456   Fixes #778, reported by karolyi.  Also reported by Gaurav Arora.
458 * We now throw UnicodeEncodeError for bad Unicode string input.  Previously
459   cases such as a lone surrogate would be handled by quietly skipping the bad
460   codepoints when converting to UTF-8 to pass to Xapian.
462 * We no longer use the deprecated old-style Py_UNICODE API, which currently
463   gives deprecation warnings and is slated to be removed in Python 4.0.
465 Ruby:
467 * Add support for block iteration.  All the iterator methods in the Ruby API
468   now accept an optional block.  If no block is given an array is returned so
469   existing code will still work.  Partly based on a patch in
470   https://github.com/xapian/xapian/pull/232 from Cong Ding.
472 * Add missing wrappers for all the C++ methods returning iterators which
473   weren't wrapped for Ruby.  Fixes #777, reported by do.
475 * Suppress warnings from Ruby 2.3 headers due to use of register and
476   constructs which look like C++11 user-defined literals.  They're fixed in
477   newer versions so they're just noise in our build.  We were working around
478   these in the CI build, so drop that workaround as we want to make the build
479   warning-clean for users too.  Reported by daniel93 on #xapian.
481 * smoketest.rb: Don't leave temporary databases behind in /tmp.
483 Xapian-bindings 1.4.11 (2019-03-02):
485 CSharp:
487 * Make MatchAll and MatchNothing readonly.
489 Java:
491 * Simplify load-time setup of Query.OP_OR, etc which are provided for
492   compatibility with the original hand-written JNI bindings.
494 PHP:
496 * We now load the module for "make check" using -d extension=xapian which
497   avoids needing to turn off safe_mode and turn on enable_dl, and matches how
498   the module is usually loaded in production use.
500 PHP7:
502 * Fix access to already released memory during PHP module shutdown, which often
503   didn't cause visible problems, but could result in segmentation faults, bus
504   errors, etc.
506 * Fix generated code to compile when using a ZTS-enabled build of PHP.
508 * We now load the module for "make check" using -d extension=xapian which
509   avoids needing to turn off safe_mode and turn on enable_dl, and matches how
510   the module is usually loaded in production use.
512 Xapian-bindings 1.4.10 (2019-02-12):
514 Documentation:
516 * Use https for URLs where supported.
518 General:
520 * Wrap new DatabaseClosedError and DatabaseNotFoundError exceptions.
521   See #772 and #773.  Patches from Vaibhav Kansagara.
523 * Update expected query descriptions in tests for the xapian-core
524   change to produce flatter Query trees.
526 * Workaround Perl 5.28 -i quirk when postprocessing SWIG-generated code.
527   The commands in question are only run when maintainer-mode is enabled.
529 CSharp:
531 * C++ constant Xapian::BAD_VALUENO is now wrapped without using a getter.
532   This shouldn't affect existing user code.
534 Java:
536 * C++ constant Xapian::BAD_VALUENO is now wrapped as Java constant
537   Xapian.BAD_VALUENO.  The previous Java wrapping as function
538   Xapian.getBAD_VALUENO() is still supported for compatibility with
539   existing code.
541 * Remove redundant std::string initialisation.
543 Lua:
545 * C++ constant Xapian::BAD_VALUENO is now wrapped as a constant rather than
546   an immutable attribute.  This shouldn't affect existing user code.
548 Perl:
550 * C++ constant Xapian::BAD_VALUENO is now wrapped as Perl constant
551   Xapian::BAD_VALUENO.  The previous Perl wrapping as variable
552   $Xapian::BAD_VALUENO is still supported for compatibility with existing
553   code.
555 * Note in the POD documentation that the Error base classes which are abstract
556   in C++ don't have a new method in Perl.
558 PHP:
560 * C++ constant Xapian::BAD_VALUENO is now wrapped as PHP constant
561   Xapian::BAD_VALUENO.  The previous PHP wrapping as function
562   Xapian::BAD_VALUENO_get() is still supported for compatibility with existing
563   code.
565 * Remove code to work around a SWIG bug which was fixed in 2006.
567 PHP7:
569 * C++ constant Xapian::BAD_VALUENO is now wrapped as PHP constant
570   Xapian::BAD_VALUENO.  The previous PHP wrapping as function
571   Xapian::BAD_VALUENO_get() is still supported for compatibility with existing
572   code.
574 * configure: Check for php-config7.3 and php-config7.2 as well as
575   php-config7.1, php-config7.0 and php-config.
577 * Correct references to PHP5 in PHP7 script comments.
579 * Remove some C code which is no longer needed with PHP7.
581 Ruby:
583 * C++ constant Xapian::BAD_VALUENO is now wrapped as Ruby constant
584   Xapian::BAD_VALUENO.  The previous Ruby wrapping as function
585   Xapian::BAD_VALUENO() is still supported for compatibility with existing
586   code.
588 * We now recommend using String#encode instead of the Iconv class, since the
589   latter is no longer included with Ruby.
591 Tcl:
593 * C++ constant Xapian::BAD_VALUENO is now wrapped as a constant rather than
594   variable which can't be written to.  This shouldn't affect existing user
595   code.
597 Xapian-bindings 1.4.9 (2018-11-02):
599 PHP7:
601 * Fix to build with upcoming PHP 7.3 release, which changes array_init()
602   to not return a value instead of always returning the constant SUCCESS.
603   We were checking this return value but no longer do.
605 Xapian-bindings 1.4.8 (2018-10-25):
607 Perl:
609 * Wrap new STEM_SOME_FULL_POS constant.
611 * Add STEM_ALL_Z to qpstem export tag and POD docs.
613 * Fix Perl bindings documentation typos.
615 Python:
617 * Fix RST formatting warning during build.
619 Python3:
621 * Fix RST formatting warning during build.
623 Xapian-bindings 1.4.7 (2018-07-19):
625 Ruby:
627 * Fix -Wconversion-null warnings with newer GCC.
629 Xapian-bindings 1.4.6 (2018-07-02):
631 Documentation:
633 * Stop using "probabilistic" to mean "weighted" - we've supported other
634   families of weighting schemes since 1.3.2.
636 Packaging:
638 * Use https for tarball URLs in .spec files.  This provides protection against
639   MITM attacks on people building packages using these spec files, and is also
640   slightly more efficient as the http: URLs redirect to the https: versions
641   anyway.
643 CSharp:
645 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
646   with older SWIG, but it does with current versions, and using it means that
647   we skip any return value translation logic when an exception has been thrown.
649 Java:
651 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
652   with older SWIG, but it does with current versions, and using it means that
653   we skip any return value translation logic when an exception has been thrown.
655 * Fix leaks in binary std::string typemaps.  These are used for document values
656   and serialised data.
658 * Improve VPATH build.  Previously we looked for class files and java sources
659   in srcdir first, then in builddir.  That's backwards from how autotools
660   VPATH builds search for targets and prerequisites so reverse this order to
661   make handling of Java files more consistent.
663 Perl:
665 * Invoke prove via the App::Prove module.  This avoids potentially using
666   prove from a different Perl installation to perl (previously the user
667   needed to manually specify the corresponding PROVE= if they specify PERL= to
668   configure).  In particular this is useful on macOS when using Perl from
669   homebrew.
671 * Improve Perl Enquire::set_docid_order documentation by syncing improvements
672   from the C++ API docs.
674 Python:
676 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
677   James Aylett.
679 * Suppress clang -Wdeprecated-register warnings about uses register in C code
680   in Python.h.  We can't do anything about these other than suppress them.
682 Python3:
684 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
685   James Aylett.
687 * Suppress clang -Wdeprecated-register warnings about uses register in C code
688   in Python.h.  We can't do anything about these other than suppress them
689   (and they appear to have been removed in Python 3.4 and later).
691 * Remove unused MSet::__cmp__ extend method.  This was used in Python 2, but
692   Python 3 does things differently.  There doesn't seem a good reason to
693   provide comparison operations for MSet objects, and we don't for other
694   classes, so let's just drop this feature - it seems nobody has noticed it has
695   gone.
697 * Simplify generated wrapper post-processing.
699 Xapian-bindings 1.4.5 (2017-10-16):
701 Documentation:
703 * HACKING: Add details of Debian PHP7 packages to install for development.
705 General:
707 * Use a pattern match to ignore methods meant for internal use only rather
708   than having to list them all - they're consistently named to end with an
709   underscore.
711 * Stop using deprecated Xapian::percent typedef in bindings-specific code.
712   Deprecation warnings are suppressed when building the bindings (because the
713   bindings usually still need to wrap deprecated C++ features) so this probably
714   has no user-visible consequences.
716 Java:
718 * Fix JNI code to be compatible with Java 6 and earlier, where the final
719   parameter of SetByteArrayRegion() was not const.  This also seems to affect
720   GCJ (though GCJ was removed in GCC 7).  The incompatibility was introduced in
721   1.4.4.
723 Lua:
725 * Support subclassing of RangeProcessor in Lua.
727 Perl:
729 * Add CLONE_SKIP to RangeProcessor and subclases to avoid double deletion
730   if the Perl threads module is in use.
732 * Keep references for set RangeProcessor objects, like how we do for
733   ValueRangeProcessor and various other functor objects.
735 * Use RangeProcessor instead of ValueRangeProcessor in perl examples, as
736   ValueRangeProcessor is now deprecated.
738 PHP:
740 * Keep references for set RangeProcessor objects, like how we do for
741   ValueRangeProcessor and various other functor objects.
743 * Add type hints to QueryParser::add_rangeprocessor().
745 PHP7:
747 * Keep references for set RangeProcessor objects, like how we do for
748   ValueRangeProcessor and various other functor objects.
750 * Add type hints to QueryParser::add_rangeprocessor().
752 * Fix PHP7 "make check" to use right path separator.  It was using the PHP5
753   one, which in general is going to be the same but we won't have probed for
754   that unless we're also building the PHP5 bindings, which means "make check"
755   failed for PHP7 unless you also had the PHP5 bindings enabled.
757 Python3:
759 * Fix "make check" under Python 3.2, which was broken in 1.4.4 because Python
760   3.2 doesn't support the u'foo' syntax.
762 * Copy over Python2 check which aims to catch any internal functions, methods,
763   constants, etc which have accidentally been wrapped.
765 Ruby:
767 * Fix dependency generation for Ruby SWIG command (only relevant at all if
768   you configure with --enable-maintainer-mode).
770 Xapian-bindings 1.4.4 (2017-04-19):
772 General:
774 * Update tests for xapian-core changes to avoid unnecessary "0 *" in query
775   descriptions in certain cases.
777 Packaging:
779 * Ship java.i in tarball.
781 Java:
783 * Handle object serialisations and document values as Java byte[].  These will
784   usually contain binary data, so Java String doesn't work well and byte[] is a
785   much better fit.
787 * Correct various errors in java examples and documentation on how to run them.
789 * Fix java examples not to abuse doc values as fields - use the document data
790   instead.
792 * "make clean" now removes additional class files.
794 PHP7:
796 * Update version of SWIG required to >= 3.0.12 so that the code generated
797   for PHP7 no longer results in a segmentation fault on module unload with
798   PHP 7.1.  Fixes #748, reported by Victor Sakovich.
800 Python:
802 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
803   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
804   https://bugs.debian.org/849722
806 * Fix configure --with-python to fail if sphinx isn't found.  Patch from
807   Patricio Paez.  Fixes #749.
809 Python3:
811 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
812   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
813   https://bugs.debian.org/849722
815 Xapian-bindings 1.4.3 (2017-01-25):
817 Python:
819 * Remove compatibility code for Python < 2.5 - 1.4.x requires Python >= 2.6.
821 * Avoid unnecessary pointer indirection in XapianSWIG_anystring() helper
822   function, which should be a little more efficient and makes the Python 2
823   code more closely match the Python 3 code.
825 Ruby:
827 * "make clean" should only remove docs/xapian.rb if configure option
828   --enable-documentation was used to enable all rules to rebuild documentation.
829   Reported by Samuel Williams on xapian-discuss.
831 * Fix make rule for running rdoc for the cases where srcdir != builddir.
833 * Use 'test a = b' rather than 'test a == b' - the former is portable, the
834   latter a bashism.  In many cases the autotools will set SHELL = /bin/bash in
835   the makefiles, but if it doesn't and /bin/sh isn't bash, then this will
836   cause "make install" and "make uninstall" to fail for the Ruby bindings.
838 Xapian-bindings 1.4.2 (2016-12-26):
840 General:
842 * configure: Fail with clear error with xapian-core < 1.4.0.
844 * Work around OS X "System Integrity Protection".  We can't address the problem
845   of being unable to run tests against an uninstalled tree when the interpreter
846   is in a system directory (you have to "make install" in xapian-core for that
847   case), but we can at least make this work for interpreters which aren't in
848   system directories.
850 Java:
852 * Disable parallel make for java subdirectory as it causes random build
853   failures.  Reported by Lucas Nussbaum in https://bugs.debian.org/848733
855 * Disable automatic use of -Xcheck:jni for now as it seems to report false
856   positives with OpenJDK 8 and 9.
858 PHP:
860 * Generates smaller PHP wrappers by only emitting each unique arginfo
861   combination once (~6% saving in stripped extension module size for
862   PHP7 on x86_64 Linux).
864 * Fix to work again with a version of PHP5 built with ZTS enabled (which is the
865   default on Microsoft Windows).
867 * Add support for PHP7.
869 * Drop workaround for PHP4 from test code.
871 Python:
873 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
874   from a command line Python code snippet.  Reported by Alex Dunn in
875   https://github.com/xapian/xapian/pull/126 and solved with help from James
876   Aylett.
878 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
879   need to keep such a reference (as we already do for ValueRangeProcessor and
880   several other classes).
882 Python3:
884 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
885   from a command line Python code snippet.  Reported by Alex Dunn in
886   https://github.com/xapian/xapian/pull/126 and solved with help from James
887   Aylett.
889 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
890   need to keep such a reference (as we already do for ValueRangeProcessor and
891   several other classes).
893 Ruby:
895 * Use more conventional Ruby variable names in the examples (Ruby convention
896   uses underscores not camelcase) and fix comma/space transposition in a couple
897   of places.
899 Xapian-bindings 1.4.1 (2016-10-21):
901 Documentation:
903 * Fix --disable-documentation - in maintainer-mode, we still tried to make
904   docs/index.html for most of the bindings, which failed because the rule to do
905   so was disabled.
907 General:
909 * Update for additions to C++ API.
911 * When a backend is disabled in the xapian-core we're building against, we
912   have a stub version of any factory functions so the bindings still have
913   something to wrap.  Update these for 1.4:
914   + Disable stub for InMemory::open() when
915     XAPIAN_BINDINGS_SKIP_DEPRECATED_DB_FACTORIES is defined (Perl, Python3).
916   + Add new optional flags parameter to both overloaded forms of
917     Remote::open_writable().
919 Portability:
921 * Drop compiler options that are no longer useful:
922   + -fshow-column is the default in all GCC versions we now support
923     (checked as GCC 4.6).
924   + -Wno-long-long is no longer necessary now that we require C++11 where
925     "long long" is a standard type.
927 Java:
929 * Use a cleaner technique to insert the Java code to load JNI library into the
930   generated wrapper - we now use "%pragma(java) jniclasscode" instead of using
931   Perl to post-process the generated wrapper.  Suggested by James Aylett.
933 * Run Java tests with -Xcheck:jni if supported, which should help catch any
934   any bugs in the JNI code.
936 * Fix configure to find jni_md.h under Cygwin.  There doesn't seem to be an way
937   to automatically determine the machine-dependent JNI include path, so add
938   another case to use "win32" on Cygwin.  Reported by John Bankert on
939   xapian-discuss.
941 * Add more special cases to find jni_md.h on Cygwin, OS X, *BSD, AIX.
942   There doesn't seem to be an explicit list of these directories anywhere, but
943   grepping the OpenJDK 8 source code finds additional values "darwin" and
944   "aix", *BSD seems to use "bsd", and Cygwin uses "win32" (reported by John
945   Bankert on xapian-discuss).
947 * Generate xapian.jar rather than xapian_jni.jar - the fact that JNI is
948   involved is really just an implementation detail.
950 * SmokeTest.java: Add simple test of subclassing FieldProcessor.
952 Perl:
954 * Merge Perl POD doc improvements from Search::Xapian.  The most notable
955   improvement is a number of methods previously lacking docs now have them.
957 * Fix typo in POD docs for Perl bindings ("outputing" -> "outputting").
958   Reported by knowledgejunkie in #730.
960 Python:
962 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
964 * Fix Python2 bindings to work out of the box.  SWIG changed the code it
965   generates for importing the compiled module in a recent version, and
966   the newer code no longer works with the wrapper renamed to
967   xapian/__init__.py.  There's currently no way to configure SWIG to produce
968   what we need so for now we run a "fixup" script over the generated wrapper
969   which replaces the complex import code with a single statement which does
970   what we want.  It also strips out various unneeded code, mostly to do with
971   handling Python 3.x (which we don't need since we have an entirely
972   separate set of bindings for that).  Reported by James Aylett in #731.
973   The way we were importing the bindings to generate the .pyc and .pyo
974   files was masking this problem, so rework that as suggested by James.
976 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
977   parallel builds (make -j) may attempt to schedule the sphinx doc build before
978   the relevant wrapper has been compiled and moved into position.  This won't
979   result in a build failure, but will silently omit API docs that sphinx
980   would otherwise include.  Patch from James Aylett.
982 * doxy2swig: Specify encoding when reading doxygen's XML output so UTF-8 in
983   doxygen comments is handled.  Patch from Vivek Pal.
985 * Specify Python2 wrapper encoding is UTF-8.  This is needed when we pick up
986   doxygen comments from the C++ API which contain UTF-8.  For Python3, the
987   default source encoding is UTF-8, so we don't need the equivalent change
988   there.
990 Python3:
992 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
994 * Fix Python3 bindings to work out of the box.  SWIG changed the code it
995   generates for importing the compiled module in a recent version, and
996   the newer code no longer works with the wrapper renamed to
997   xapian/__init__.py.  There's currently no way to configure SWIG to produce
998   what we need so for now we run a "fixup" script over the generated wrapper
999   which replaces the complex import code with a single statement which does
1000   what we want.  It also strips out various unneeded code, mostly to do with
1001   handling Python 2.x (which we don't need since we have an entirely
1002   separate set of bindings for that).  Reported by James Aylett in #731.
1003   The way we were importing the bindings to generate the .pyc and .pyo
1004   files was masking this problem, so rework that as suggested by James.
1006 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
1007   parallel builds (make -j) may attempt to schedule the sphinx doc build before
1008   the relevant wrapper has been compiled and moved into position.  This won't
1009   result in a build failure, but will silently omit API docs that sphinx
1010   would otherwise include.  Patch from James Aylett.
1012 * Fix memory leak converting string from Python to C++.
1013   XapianSWIG_anystring_as_ptr() was failing to flag the returned value as
1014   allocated, so it wasn't being deleted.  Reported by Sean Robinson in #729.
1016 Xapian-bindings 1.4.0 (2016-06-24):
1018 Documentation:
1020 * Mark SWIG-generated Java and Perl bindings as "experimental" until we've
1021   had a chance to sort out any remaining changes we want to make.
1023 Xapian-bindings 1.3.7 (2016-06-01):
1025 Documentation:
1027 * Remove long out-dated reference to tinderbox.
1029 General:
1031 * Use SWIG 3.0.9 to generate the bindings.  There's nothing very important to
1032   us in the changes since the git snapshot we were using - mostly this means
1033   we're using a released version, which seems preferable.
1035 Tcl:
1037 * Fix segfault in tcl bindings "make check".  The location of tclConfig.sh
1038   wasn't being found, so libtclstub wasn't being linked to, which is required
1039   with Tcl >= 8.6.
1041 Xapian-bindings 1.3.6 (2016-05-09):
1043 General:
1045 * Update for changes to the C++ API.
1047 * Use WritableDatabase::commit() instead of flush() in testcases, as the
1048   latter is now formally deprecated.
1050 Java:
1052 * Fix syntax error in SmokeTest.java, introduced by the DB_BACKEND_INMEMORY
1053   change.  Noted on #xapian-discuss by Aakash Muttineni.
1055 * Update Java TODO list.
1057 * SmokeTest.java: Port over version checks from SmokeTest.cs.
1059 * Update list of recently tested JDK versions.
1061 Lua:
1063 * Note Lua bindings work with Lua 5.3.
1065 Perl:
1067 * Explicitly specify POD docs encoding as utf8.  Fixes warning in generated
1068   HTML docs.
1070 * Convert POD to HTML when building from a source tarball - the conversion
1071   code comes as standard with Perl.  In 1.3.5 we were failing to ship the HTML
1072   output, as reported by Anthony Basile.
1074 * For extra robustness, convert POD to HTML using the bundled Pod::Html module
1075   from the Perl interpreter found by configure, rather than assuming pod2html
1076   is on PATH, and the right one (this matters more now that it's not just
1077   people building from git who build these docs).
1079 * Improve Perl bindings POD documentation.
1081 * Remove workaround for Perl macro vs C++11 header.  SWIG 3.0.6 and later adds
1082   a different workaround to the generated C++ wrapper file, and we require SWIG
1083   3.0.8 for a Python fix, so we no longer need our workaround.
1085 Python:
1087 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
1088   system, so I'm guessing this is now required due to a change in the code SWIG
1089   generates.
1091 Python3:
1093 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
1094   system, so I'm guessing this is now required due to a change in the code SWIG
1095   generates.
1097 * Fix install location for python3 docs.  They were being install to the same
1098   path as the python docs - now the path includes "python3" instead of
1099   "python".
1101 Ruby:
1103 * Increase minimum Ruby version to 2.1, as older versions are no longer
1104   supported by the Ruby developers.
1106 Xapian-bindings 1.3.5 (2016-04-01):
1108 This release includes all changes from 1.2.23 which are relevant.
1110 Documentation:
1112 * Fix to install docs when not in maintainer-mode.
1114 * Note open_stub() is deprecated (most of the bindings already noted this, but
1115   now ruby and tcl do too).
1117 General:
1119 * Update for changes to the C++ API.
1121 * PostingSource is now fully wrapped for the bindings.  Fixes #499, reported by
1122   Joost Cassee.
1124 * Ship swig-depcomp and doxy2swig scripts in the source tarball.
1126 * Add installcheck-local make targets for most languages - these run the
1127   testsuites using the installed bindings.
1129 CSharp:
1131 * configure: Stop checking for obsolete mono compiler names - gmcs, smcs and
1132   dmcs were all deprecated in Mono 2.11.
1134 * configure: Strip out handling of DotGNU - it's been inactive for years, and
1135   was officially "decommissioned" in December 2012.
1137 * README: Update list of mono versions recently tested with.
1139 Lua:
1141 * smoketest.lua: Fix to work with newer lua - coercing a number to a string
1142   now appends ".0" for whole numbers.
1144 Perl:
1146 * Run pod2html with explicit --podpath=. - recent versions of pod2html seem to
1147   need this to correctly handle references to other Xapian classes.  Reported
1148   on #xapian-discuss by HowManny and abhishek_rand0wn.
1150 Python:
1152 * Run sphinx at build time.  It's an extra tool for people building from source
1153   to have to install, but its output is rather large (this change reduces our
1154   tar.xz size by ~20%), and its output includes a source-less minified copy of
1155   jquery.
1157 Python3:
1159 * Run sphinx at build time.  It's an extra tool for people building from source
1160   to have to install, but its output is rather large (this change reduces our
1161   tar.xz size by ~20%), and its output includes a source-less minified copy of
1162   jquery.
1164 * Fix handling of integer values larger than a C int by bootstraping with a
1165   newer version of SWIG.  Fixes #703, reported by Barry Warsaw.
1167 * Remove xapian.inmemory_open() - we've deprecated the corresponding C++
1168   function, and the Python3 bindings haven't yet had a stable release.
1170 Ruby:
1172 * Run rdoc at build time - it is included as part of the Ruby core
1173   distribution, so we can assume it is available if ruby is, and avoid shipping
1174   its rather large generated output in our source tarball.
1176 Xapian-bindings 1.3.4 (2016-01-01):
1178 This release includes all changes from 1.2.22 which are relevant.
1180 General:
1182 * Wrap new and changed features in C++ API.
1184 * PostingSource set_maxweight() is now accessible to the bindings.  Fixes #498,
1185   reported by Richard Boulton.
1187 * configure script now defaults to looking for xapian-config-1.3.  This is now
1188   automatically done for development series (odd middle component of the
1189   version number), but not for stable series (even middle component).  Fixes
1190   #695, reported by Jorge C. Leitão
1192 PHP:
1194 * Make PHP 5.5 the minimum officially supported version, as 5.4 has now reached
1195   EOL.
1197 * In the examples, when iterating an MSet with foreach, don't throw the docid
1198   away as $dummy, put it in $docid and use it - the code looks cleaner, and
1199   this avoids an extra call to C++ to get the docid on each iteration.
1201 Python:
1203 * Drop support for Python 2.5.
1205 Python3:
1207 * Document installation of Python 3 bindings.  Fixes #694, reported by Jorge C.
1208   Leitão.
1210 * Fix testsuite for changes in Python 3.5.  Fixes #690, patch from UsusDei.
1212 * Handle renaming of .pyo to .opt-1.pyc files due to PEP-0488.  Fixes #689,
1213   patch from UsusDei.
1215 * Fix Python 3 version check to accept 3.10.
1217 Xapian-bindings 1.3.3 (2015-06-01):
1219 This release includes all changes from 1.2.20-1.2.21 which are relevant.
1221 Documentation:
1223 * INSTALL: IRIX is past EOL so drop information about IRIX make.
1225 General:
1227 * Add DB_RETRY_LOCK as a constant to wrap.
1229 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
1231 * Fix "make install" from a git tree configured with --disable-documentation.
1232   (Fixes #658, reported by Germán M. Bravo)
1234 * Fix "make install" when building from git with --disable-documentation.
1236 * Fix to handle a VPATH build from a tarball when the generated docs will be in
1237   $(srcdir).
1239 * Update testcases for lazy wildcard expansion change in xapian-core.
1241 * Update for addition of XAPIAN_NOEXCEPT.
1243 * Don't wrap internal methods of Xapian::Weight.
1245 Portability:
1247 * Require a compiler with good C++11 support, like xapian-core now does.
1249 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
1250   doxygen.
1252 * configure: Update check for -fvisibility to match xapian-core's.
1254 CSharp:
1256 * Fix configure test for whether $CLI can run CSharp programs - previously it
1257   would always fail, which would mean that the CSharp tests wouldn't be run on
1258   platforms where CSharp programs can't be run directly.
1260 Java:
1262 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
1264 Lua:
1266 * The Lua bindings are no longer considered to be "experimental" (in reality
1267   they haven't been for some time).
1269 Perl:
1271 * Add a "LICENSE" section to the main POD.
1273 * Add 'use strict' to all testcases, and add missing instances of 'my' that
1274   this change uncovered.
1276 * Wrap new WILDCARD_LIMIT_* constants as constants.
1278 Python:
1280 * Don't release the GIL when constructing a Query object from a sequence of
1281   Query objects and/or strings.
1283 * python/smoketest.py: Add new testcase to catch any internal functions,
1284   methods, constants, etc which have accidentally been wrapped.
1286 Python3:
1288 * The Python3 bindings are no longer considered to be "experimental".
1290 * Don't release the GIL when constructing a Query object from a sequence of
1291   Query objects and/or strings.  (fixes #346)
1293 * python3/pythontest.py: Expand comment about disabling test_import_star under
1294   threads.
1296 Tcl:
1298 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
1299   version added ::tcl::pkgconfig, which makes the configure tests simpler and
1300   more reliable.
1302 * Adjust precedence of the typecheck typemap for wrapping constructing a query
1303   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
1304   constructor correctly.
1306 Xapian-bindings 1.3.2 (2014-11-24):
1308 This release includes all changes from 1.2.16-1.2.19 which are relevant.
1310 Documentation:
1312 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
1314 * Update for deprecation of Xapian::Chert::open().
1316 * Update for renaming of "brass" backend to "glass".
1318 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
1319   updated" information isn't all that informative anyway - there can still be
1320   stale information even if the file was updated very recently.
1322 General:
1324 * Releases and snapshots are now bootstrapped using a more recent version of
1325   SWIG (a git snapshot from after the 3.0.3 release).
1327 * configure: Fix SWIG version check to accept 3.x, and update the minimum
1328   accepted version to be what we actually currently want.
1330 * Wrap new C++ API features, and in particular all the new weighting schemes,
1331   the changes to opening databases, and Xapian::Snipper.
1333 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
1334   argument which the C++ API takes.  If opts != 0, then output is sent to
1335   stdout, otherwise no output is produced.
1337 * Object descriptions are now always valid UTF-8. (see #620)
1339 * Provide a SimpleStopper constructor which provides the ability to initialise
1340   from a stopword list in a file.  Based on patch from Assem Chelli.
1342 CSharp:
1344 * README: Note that C# bindings now need .NET 2 or later (because that's what
1345   SWIG-generated code now requires).
1347 Java:
1349 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
1350   Anish Kanchan.  (see #616, reported by "Naveen")
1352 Lua:
1354 * Document that constants can now be accessed using CLASS.CONSTANT as well as
1355   CLASS_CONSTANT.
1357 Perl:
1359 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
1360   overlap with the hand-coded XS 'Search::Xapian' module.
1362 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1363   during parallel builds.
1365 * Use croak_sv() or ERRSV if defined.
1367 PHP:
1369 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
1370   reached EOL.
1372 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
1373   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
1374   `foreach ($it as $c)` works and allows iterating through the equivalent of
1375   C++ operator* on the iterator.  (fixes#652)
1377 * Fix handling of an exception thrown from a PHP implementation of
1378   FieldProcessor::apply().
1380 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
1381   weight threshold.
1383 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1384   available it will now only look in the configured extension directory.  The
1385   upshot is that there no longer seems to be a sane way to install the PHP
1386   bindings without being root.  Fixes #661, reported by Felix Ostmann.
1388 Python2:
1390 * The python testsuite already tested if any constants weren't marked with
1391   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
1392   clearly point to the actual problem.  Now we report the names of any
1393   such constants.
1395 * In the testsuite, use the xapian.WritableDatabase constructor rather than
1396   chert_open() - that code dates back to when chert was the only disk-based
1397   backend to support valuestreams, but flint was the default backend.
1399 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
1400   Germán M. Bravo in github PR59.
1402 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
1404 Python3:
1406 * Python 3 support has been split off into its own subdirectory, and should now
1407   be usable.  3.2 is the minimum supported version currently.  Existing code
1408   will need updating for Python 3, and the wrapped API is necessarily different
1409   in how Unicode is handled, so we've dropped deprecated features (such as
1410   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
1412 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
1413   Germán M. Bravo in github PR59.
1415 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
1417 Ruby:
1419 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
1420   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
1421   picking ruby 1.6.
1423 Xapian-bindings 1.3.1 (2013-05-03):
1425 This release includes all changes from 1.2.10-1.2.15 which are relevant.
1427 Documentation:
1429 * HACKING: Document Debian packages needed for each language.
1431 General:
1433 * Wrap new C++ API features.
1435 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
1436   unnecessary exception handling code where we call such functions and
1437   methods.
1439 * Tweak wrapping of Query from list constructor so the needed number of
1440   elements get preallocated.
1442 * Ignore Query(Query::Internal&) constructor, which is for internal use
1443   only.
1445 * For all languages except C# and Java, wrap the functions declared in
1446   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
1447   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
1448   languages.
1450 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
1451   dependencies, and adjusts the generated dependencies to work in our build
1452   system.
1454 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
1455   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
1456   V=1' and 'make V=0' which are broadly equivalent and more standard.
1458 * Fix the tests to work with the new automake parallel test driver.
1460 Portability:
1462 * Improve workaround which allows building against an uninstalled xapian-core
1463   on OS X - this should now work with any uninstalled xapian-core (not only in
1464   a tree with the same layout as an SVN or git checkout) and it also won't try
1465   to build against "../xapian-core/.libs" just because it happens to exist.
1466   (Fixes #322)
1468 CSharp:
1470 * configure: The variable to specify the interpreter is now CLI (was MONO, but
1471   didn't actually work properly).
1473 Java:
1475 * Document that we aim to support JDK 1.6 (Java 6) and later.
1477 * Avoid generating a temporary C++ vector of Query objects when constructing
1478   a Query from a Java array of Query objects or a Java array of strings.
1480 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
1481   ValueIterator, and TermIterator.
1483 * Add Enquire.getMatchingTerms().
1485 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
1486   building, e.g. "make JAVACFLAGS=-g".
1488 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
1489   with (the rather elderly) ECJ 3.3.1.
1491 Perl:
1493 * Fix PostingIterator wrapper to work.
1495 * Update list of unwrapped things in POD documentation.
1497 * Improve test coverage.
1499 * perl/t/10query.t: Adjust regexp which checks expected error message to work
1500   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
1502 * Probe for the test running tool 'prove' in configure.
1504 PHP:
1506 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
1507   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
1508   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
1509   compiled PHP module by 6%.
1511 * php/smoketest.php: Add more tests of geospatial API.
1513 Python:
1515 * Drop support for Python 2.4.
1517 * python/smoketest2.py: Add more testcases.
1519 * python/smoketest2.py: Improve reporting of test failures for certain
1520   testcases.
1522 * Update Python 3 tests from Python 2 versions using 2to3.
1524 Xapian-bindings 1.3.0 (2012-03-14):
1526 Documentation:
1528 * In maintainer builds, run doxygen to generate XML for the bindings in the
1529   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
1531 General:
1533 * Wrap new geospatial API.
1535 * Wrap new database checking API.
1537 * Deprecated features scheduled for removal in 1.3.0 have been removed.
1539 * Wrap ExpandDecider even if we don't have director support - there's a
1540   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
1541   needs some typemap work to actually get it usefully wrapped.
1543 * configure:
1545   + Add --disable-visibility option to match xapian-core.
1547   + Add -fshow-column for GCC.
1549   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
1550     variable, so that it's easy to override it if you're getting a new warning
1551     from SWIG but want to just ignore it for the time being.
1553 * Exception handling now uses Error::get_description() rather than get_type +
1554   ": " + get_msg().  In many cases this is the same, but if context or errno
1555   are available, get_description() includes them.  Catch and report
1556   std::exception rather than handling it as an unknown error (so in particular
1557   std::bad_alloc will now be reported more helpfully).
1559 CSharp:
1561 * Avoid generating unwanted wrapper sources
1562   SWIGTYPE_p_std__vectorT_std__string_t.cs and
1563   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
1565 Java:
1567 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
1568   bindings promoted in their place.  This means almost the entire C++ API is
1569   now wrapped for Java, but the downside is there are some changes required
1570   to existing code.  Overall we feel the short-term pain is worth the long
1571   term benefits of having Java bindings which stay up to date.
1573 * java/SmokeTest.java: Add test that string passing is zero byte safe.
1575 Lua:
1577 * Improve error messages.
1579 Perl:
1581 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
1582   Perl 5.14.
1584 * Fix Search::Xapian::Query->new() to work.
1586 * Enable warnings for all test cases and make them fatal.
1588 * Add "use Carp;" where we use functions from that module.
1590 * Improve POD docs for Document and TermGenerator methods - "weight" is
1591   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
1593 * The Query constructor which takes an array of subqueries is now wrapped more
1594   efficiently - previous a temporary C++ std::vector was built but now we avoid
1595   doing this.
1597 PHP:
1599 * PHP >= 5.3 is now required.
1601 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
1603 * The XapianQuery constructor which takes an array of subqueries is now
1604   wrapped more efficiently - previous a temporary C++ std::vector was built
1605   but now we avoid doing this.
1607 Python:
1609 * Python >= 2.4 is now required.
1611 * Remove deprecated Stem_get_available_languages().
1613 * Hide away the deprecated non-pythonic iterators - we still need them to
1614   implement the pythonic iterators, so we can't entirely remove them.
1616 * Replace SWIG's thread locking with code which does nothing unless threads
1617   are already initialised, to avoid the overhead of thread locking in the
1618   common case of single-threaded Python code.  This seems to be about 5-10%
1619   faster for pythontest2.py modified to repeat the tests 100 times.
1621 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
1622   #364.
1624 * The Query constructor which takes an array of subqueries is now wrapped more
1625   efficiently - previous a temporary C++ std::vector was built but now we avoid
1626   doing this.
1628 Ruby:
1630 * The XapianQuery constructor which takes an array of subqueries is now
1631   wrapped more efficiently - previous a temporary C++ std::vector was built
1632   but now we avoid doing this.
1634 Tcl:
1636 * The XapianQuery constructor which takes an array of subqueries is now
1637   wrapped more efficiently - previous a temporary C++ std::vector was built
1638   but now we avoid doing this.
1640 Xapian-bindings 1.2.23 (2016-03-28):
1642 Documentation:
1644 * Update links to Xapian website and trac to use https, which is now supported,
1645   thanks to James Aylett.
1647 PHP:
1649 * Check that the PHP interpreter we find is actually PHP5, and if not look
1650   harder.  On current Debian unstable, php-config5 --php-binary reports
1651   /usr/bin/php which can be PHP7.
1653 * Document that PHP7 isn't currently supported, and explicitly check for and
1654   reject it in configure.
1656 Ruby:
1658 * configure: Stop preferring rdoc-1.8 to rdoc (this only happened in a
1659   fall-back case when rdoc wasn't found in the same directory as the ruby
1660   interpreter).
1662 Xapian-bindings 1.2.22 (2015-12-29):
1664 Documentation:
1666 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
1667   'git cherry-pick' from working as it should.  The git repo history should be
1668   sufficient for complying with GPLv2 2(a).
1670 General:
1672 * Stop wrapping internal methods of Xapian::Weight.
1674 * Return Error::get_description() rather than get_type + ": " + get_msg().  In
1675   many cases this is the same, but if context or errno are available,
1676   get_description() includes them.
1678 * Catch and report std::exception rather than handling it as an unknown error
1679   (so in particular std::bad_alloc will now be reported more helpfully).
1681 CSharp:
1683 * Fix configure test for whether $MONO can run CSharp programs - previously it
1684   would always fail, which would mean that the CSharp tests would only be run
1685   on systems where CSharp programs can be run directly.
1687 Lua:
1689 * Send stderr from lua version check to config.log instead of letting it appear
1690   on the terminal.
1692 PHP:
1694 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
1696 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
1697   constructors now work.
1699 Python:
1701 * Add new testcase to catch any internal functions, methods, constants, etc
1702   which have accidentally been wrapped.
1704 Xapian-bindings 1.2.21 (2015-05-20):
1706 Lua:
1708 * README: Remove note about the Lua bindings being experimental - it's not
1709   really been true for some time now.
1711 Perl:
1713 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
1715 * Add workaround for Perl defining a seed() macro which breaks compilation with
1716   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
1717   classes with a method called seed).
1719 * Update list of unwrapped things in POD documentation.
1721 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1722   during parallel builds.
1724 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
1726 * Add test that we can create all the stemmers returned by
1727   Stem::get_available_languages().
1729 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
1730   likely due to external reasons, like incompatible compiler flags being taken
1731   from Perl's Config module, due to Perl having been built with a different
1732   compiler to Xapian.
1734 * Use croak_sv() or ERRSV if defined.
1736 PHP:
1738 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
1739   was fixed in 1.2.19.
1741 Python:
1743 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
1744   stable release 1.4.0.
1746 Ruby:
1748 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
1750 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
1751   https://bugs.debian.org/782270
1753 Xapian-bindings 1.2.20 (2015-03-04):
1755 Portability:
1757 * configure: Avoid using \? in sed command in Lua detection - it isn't
1758   supported by all sed implementations.
1760 Lua:
1762 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
1763   being specified without a leading '.'.
1765 * configure: Add an example of specifying LUA_SO to --help output.
1767 PHP:
1769 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
1770   1.2.19.
1772 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1773   available it will now only look in the configured extension directory.  The
1774   upshot is that there no longer seems to be a sane way to install the PHP
1775   bindings without being root, so update the documentation to reflect this.
1776   Fixes #661, reported by Felix Ostmann.
1778 Xapian-bindings 1.2.19 (2014-10-21):
1780 PHP:
1782 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
1783   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
1784   Gottfried)
1786 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
1787   which were getting incorrectly wrapped such that they didn't actually do
1788   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
1789   reference tracking fix in 1.2.14.
1791 Ruby:
1793 * README: Note that Ruby 2.1 works too.
1795 Xapian-bindings 1.2.18 (2014-06-22):
1797 Documentation:
1799 * README: Add links to Erlang and Node.js bindings.
1801 Lua:
1803 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
1804   expected), which most of the calls already used, and fix up the few calls
1805   which passed (expected, got).
1807 PHP:
1809 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
1810   that MatchDecider returns an MSet with the expected docid in.  Luckily this
1811   wasn't masking a test failure.
1813 Python:
1815 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
1816   - chert is the default backend now, and both chert and brass support the
1817   required functionality for the tests which do this, so this just needlessly
1818   causes the tests to fail if chert is disabled in xapian-core.
1820 * configure: If the Python version is too new or too old, only report it once
1821   not twice.
1823 Ruby:
1825 * configure: Fix Ruby bindings to build on Windows (and other platforms where
1826   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
1828 Xapian-bindings 1.2.17 (2014-01-29):
1830 Portability:
1832 * Improve workaround which allows building against an uninstalled xapian-core
1833   on OS X - this should now work with any uninstalled xapian-core (not only in
1834   a tree with the same layout as an SVN or git checkout) and it also won't try
1835   to build against "../xapian-core/.libs" just because it happens to exist.
1836   (Backported from 1.3.1; fixes #322)
1838 Python:
1840 * configure: Some distros now point /usr/bin/python at Python 3, so the check
1841   for a Python 2 interpreter now checks for 'python2' first, and checks that
1842   the version of found interpreter is 2.x.
1844 Ruby:
1846 * Tweak configure to work with Ruby 2.0.
1848 Tcl:
1850 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
1851   in https://bugs.debian.org/724830).
1853 * Use a better check for TCL_INC for Tcl 8.5 and later.
1855 Xapian-bindings 1.2.16 (2013-12-04):
1857 Documentation:
1859 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
1861 General:
1863 * Compress source tarballs with xz instead of gzip.
1865 * configure: Handle git snapshot naming.
1867 Portability:
1869 * configure: Update list of platforms where we tell libtool not to link in
1870   deplibs to match the list used for xapian-core.
1872 Perl:
1874 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
1875   GCC 4.7 warning).
1877 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
1878   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
1880 PHP:
1882 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
1883   with a message explaining this.
1885 Python:
1887 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
1889 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
1891 * pythontest.py: Fix testcase checking we get an exception from using
1892   non-random-access iterators after then have advanced - previously these
1893   didn't actually test as fully as intended.
1895 Ruby:
1897 * Omit internal classes and methods from the rdocs.
1899 Xapian-bindings 1.2.15 (2013-04-16):
1901 General:
1903 * Fix configure --enable-quiet option to actually work for the bindings.
1905 Perl:
1907 * Fix doc typo: "as as" -> "as a"
1909 Ruby:
1911 * Fix deprecation warning in configure from Ruby 1.9.3.
1913 Xapian-bindings 1.2.14 (2013-03-14):
1915 Python:
1917 * Fix typo in doccomment.
1919 PHP:
1921 * Keep references to the PHP wrapper object when an object is set on another
1922   object.  (fixes #614)
1924 Tcl:
1926 * Allow TCL_INC to be passed to configure.  (fixes #612)
1928 Xapian-bindings 1.2.13 (2012-11-09):
1930 CSharp:
1932 * configure: Overhaul checks for C# tools to use modern names in preference.
1934 Lua:
1936 * Fix examples to use str(query) to get the query description.  (Fixes #600)
1938 * Document that get_description() is mapped to str(), and end() to _end().
1940 * Fix functor wrappers which return strings to be zero-byte clean.
1942 Perl:
1944 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
1945   1.2's XS Search::Xapian.  (ticket#607)
1947 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
1948   is deprecated.
1950 PHP:
1952 * Document that subclassing Xapian classes in PHP currently doesn't work with
1953   PHP 5.4.
1955 Xapian-bindings 1.2.12 (2012-06-27):
1957 No changes since 1.2.11 except to bump the version - this release was made to
1958 fix an incorrect library version information update in xapian-core 1.2.11.
1960 Xapian-bindings 1.2.11 (2012-06-26):
1962 General:
1964 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
1966 Perl:
1968 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
1969   av_fetch() (spotted due to GCC 4.7 warning).
1971 PHP:
1973 * Fix "make check" to work for PHP when building from a release tarball with
1974   srcdir != builddir.
1976 * Work around "undefined symbol: zend_error_noreturn" error.
1978 Xapian-bindings 1.2.10 (2012-05-09):
1980 CSharp:
1982 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
1983   us to do this instead of setting them in AssemblyInfo.cs.
1985 * Use diff's -c option when comparing the files SWIG generated against those we
1986   were expecting to get as the output should be easier to understand.
1988 * Sort both the lists of expected and of found SWIG-generated sources with
1989   Perl, to avoid problems with locale-specific sort orders.
1991 Java-SWIG:
1993 * Remove now superfluous old check that SWIG generated at least the sources we
1994   want - we now check it generated *exactly* the sources we want.
1996 * Use diff's -c option when comparing the files SWIG generated against those we
1997   were expecting to get as the output should be easier to understand.
1999 * Sort both the lists of expected and of found SWIG-generated sources with
2000   Perl, to avoid problems with locale-specific sort orders.
2002 Lua:
2004 * Now works with Lua 5.2.
2006 * "require 'xapian'" now returns the module table.  (ticket #593)
2008 * lua/smoketest.lua: Improve reporting of test failures.
2010 Perl:
2012 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
2014 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
2015   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
2017 Python:
2019 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
2020   iteration features which have been removed on trunk.  This also fixes a
2021   segfault if there are no matches and no documents are explicitly marked as
2022   relevant.
2024 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
2025   way to rerun tests with verbose output.
2027 Ruby:
2029 * configure: Make sure the ruby subdirectory exists before trying to create
2030   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
2032 Xapian-bindings 1.2.9 (2012-03-08):
2034 Java:
2036 * configure: Fix test for jni.h to try looking for jni.h relative to the real
2037   location of javac, which should work for more JDKs.
2039 Lua:
2041 * Handle an exception from C++ by raising a xapian.Error object as an error in
2042   Lua.
2044 * Rename get_description() methods to __tostring(), so that you can use write
2045   tostring(obj) in Lua.
2047 * configure: Honour LUA_LIB if already set.  Fixes #581.
2049 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
2050   support platforms where the compiled Lua module isn't called .so.
2052 Perl:
2054 * Add tests of Document::get_docid().
2056 PHP:
2058 * Add a test that Query constructor taking OP_NEAR with a window size works.
2060 Python:
2062 * python/testsuite2.py: Don't run off the traceback looking for a test function
2063   if the exception wasn't from a test function.
2065 Xapian-bindings 1.2.8 (2011-12-13):
2067 Lua:
2069 * Wrap user-subclassable functor objects by allowing the user to pass a
2070   Lua function where the functor object would be passed in the C++ API.
2072 PHP:
2074 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
2076 * The PHP bindings will now work again with a version of PHP built with ZTS
2077   enabled (which is the default on Microsoft Windows).  This was broken by
2078   the changes to support subclassing in PHP in the version of SWIG used since
2079   1.2.6.
2081 Python:
2083 * Add a module docstring.  (Fixes bug #573)
2085 * The python testsuite now checks for object leaks during each testcase.
2087 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
2088   only check for leaks the second time to avoid falsely reporting a leak when
2089   some cached value gets initialised under Python 2.5.
2091 Ruby:
2093 * Wrap optional prefix parameter to Database::allterms.
2095 Xapian-bindings 1.2.7 (2011-08-10):
2097 Documentation:
2099 * INSTALL: Pull in a few updates from the latest version of the automake
2100   document which this file was originally based on.  Add in the missing
2101   copyright and licensing information.
2103 * INSTALL: Add --with-lua to list of options.
2105 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
2106   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
2107   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
2108   supported platforms in the README.
2110 * HACKING: Update and start section on deprecation warnings for the bindings.
2112 General:
2114 * Add missing wrappers for Database::has_positions() and
2115   TermIterator::positionlist_count(), and correct the return type of
2116   Database::get_doclength() from double to Xapian::termcount.
2118 CSharp:
2120 * README: Note a recent version of Mono which we've tested the C# bindings
2121   with.
2123 * Check that exactly the sources we expect are generated, and add some sources
2124   which were missing from the list.
2126 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
2127   gets removed.
2129 * Fix iterator ++ and -- so that the reference to the object isn't released
2130   prematurely, which was causing an occasional crash if the garbage collection
2131   happened at just the wrong moment,
2133 * Add test coverage for QueryParser.ParseQuery() with flags argument.
2135 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
2137 Java:
2139 * SmokeTest.java: Fix == comparisons with strings to use equals().
2141 * Add test that string passing is zero byte safe.
2143 * Fix MyExpandDecider.accept() to really check the passed parameter.
2145 Java-SWIG:
2147 * Put the SWIG-generated Java bindings in package org.xapian.
2149 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
2151 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
2153 * Add test that string passing is zero byte safe.
2155 * Fix MyExpandDecider.accept() to really check the passed parameter.
2157 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
2159 * Create an HTML documentation page based on java/README.
2161 * Copy java examples from the hand-coded JNI ones.
2163 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
2165 * Check that exactly the sources we expect are generated, and add some sources
2166   which were missing from the list.
2168 Lua:
2170 * Merge latest Lua changes from Xiaona Han.
2172 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
2174 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
2175   matches.
2177 Perl:
2179 * Sync updates to examples from XS Search::Xapian:
2181   + Require Perl >= 5.6 so we can "use warnings;".
2183   + Loop over file using while() (which reads a line per iteration) not
2184     foreach() (which reads the whole file up front).
2186 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
2187   and Search::Xapian::Query::MatchNothing).  (ticket#158)
2189 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
2191 * perl/Makefile.am: Fix "make check".
2193 * perl/t/symbol-test.t: Fix to work when built against an installed
2194   xapian-core.  (ticket#558)
2196 PHP:
2198 * php/smoketest.php: Install an error handler so the test fails if there are
2199   any errors, warnings, notices, etc.
2201 * Change PHP examples and test program to use 'include "xapian.php"' like user
2202   code should (rather than 'include "php5/xapian.php"' as they did previously).
2204 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
2205   XapianQuery::MatchNothing(). (ticket#158)
2207 Ruby:
2209 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
2211 Xapian-bindings 1.2.6 (2011-06-12):
2213 General:
2215 * SWIG-based bindings are now generated with a newer version of SWIG
2216   (ticket#538).
2218 Portability:
2220 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
2221   .jnilib extension as we do for older versions.
2223 CSharp:
2225 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
2227 Java:
2229 * Fix memory leaks when functions taking string parameters throw exceptions.
2231 * Previously a hash table was used to map Java objects to C++ ones, but we
2232   now just cast the address of the C++ object to a jlong (which is 64 bits
2233   so will hold a pointer on current platforms).  This is more efficient and
2234   avoids the need for thread locks around accesses to the hash table.
2236 * Remove explicit checks for NULL around calls to delete.
2238 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
2239   during parallel builds.
2241 Lua:
2243 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
2244   year.  The current support should be regarded as experimental - it passes
2245   its automated tests, but the details of the Lua API are likely to evolve as
2246   the project progresses.
2248 Perl:
2250 * README: say that Perl bindings probably need Perl 5.8 or later.
2252 PHP:
2254 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
2256 Python:
2258 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
2259   all the garbage, so repeat until no further objects are freed.
2260   (https://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
2262 Ruby:
2264 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
2265   the compaction tests for these versions.
2267 Xapian-bindings 1.2.5 (2011-04-04):
2269 Documentation:
2271 * README: Update info on SWIG-based Perl bindings.
2273 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
2274   section with better equivalent from xapian-core/INSTALL.
2276 General:
2278 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
2280 * configure: If xapian-core is a different release series, promote the
2281   mismatched versions warning to an error.
2283 Portability:
2285 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
2286   10.4 on x86, as the default if unset on these versions is the current OS
2287   version.  (ticket#541)
2289 * python/pythontest2.py: In test_compactor(), close any open databases before
2290   removing the directory as you can't delete an open database on Microsoft
2291   Windows.  (ticket#526)
2293 CSharp:
2295 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
2297 * Clarify the licence is GPL "version 2 or later" in the meta information
2298   we put in the module.
2300 Python:
2302 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
2303   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
2304   accidentally left an older version of get_matching_terms() exposed.
2306 * Remove broken implementation of MSet.__contains__.  This appears never to
2307   have worked, and to have been broken for at least the past 3.5 years without
2308   anyone mentioning it, and is probably of little use anyway, so no need to
2309   deprecate.
2311 * python/docs/index.html: Document that MSet.items and ESet.items are
2312   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
2313   the tuple returned by MSet.items.  (ticket#531)
2315 * Add test coverage for mset.items.
2317 Ruby:
2319 * Add test coverage for Xapian::Compactor.
2321 * Handle an empty response to $RUBY --version specially.  This gives a less
2322   opaque error in cases where the user specified RUBY but the value given
2323   wasn't an executable file.
2325 Xapian-bindings 1.2.4 (2010-12-19):
2327 General:
2329 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
2330   virtual method is wrapped for subclassing for Python and Ruby currently.
2332 * Eliminate separate Makefile.am in the docs subdirectory of each language
2333   subdirectory and just inline any rules into the main sub-Makefile.am, which
2334   allows more of the build to run in parallel.
2336 * Don't ship some files which are generated at build time.
2338 * configure: Need python in maintainer mode to run doxy2swig.py.
2340 Packaging:
2342 * RPM: Package the Perl bindings.
2344 * RPM: Don't package _XapianSharp.la.
2346 Portability:
2348 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
2349   uninstalled Xapian library.  See ticket #322.
2351 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
2353 CSharp:
2355 * Don't install _XapianSharp.la.
2357 Perl:
2359 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
2360   GSoC 2009.  These are close to being a compatible replacement for the
2361   hand-coded XS bindings in Search::Xapian but also offer a more complete
2362   wrapping of the C++ API.  We're planning to replace the XS bindings with the
2363   SWIG ones for easier maintenance.  We encourage you to try them and let us
2364   know how you get on - particularly if you find cases where code which works
2365   with the XS bindings doesn't work with the SWIG ones.
2367 PHP:
2369 * Document that iterators shouldn't be dereferenced or advanced when at their
2370   end points (ticket#520).
2372 Python:
2374 * Fix memory leaks in typemaps which return Python lists.
2376 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
2377   supported.
2379 * configure: Use sys.version_info tuple, rather than string splicing which
2380   assumes the Python "major.minor" is 3 characters (which would fail if Python
2381   2.10 were ever released, for example).
2383 Xapian-bindings 1.2.3 (2010-08-24):
2385 Packaging:
2387 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
2389 Xapian-bindings 1.2.2 (2010-06-27):
2391 * No user-visible change except for bumping the version to indicate
2392   compatibility with Xapian-core 1.2.2.
2394 Xapian-bindings 1.2.1 (2010-06-22):
2396 This release includes all changes from 1.0.21 which are relevant.
2398 General:
2400 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
2401   Python.  (ticket#448)
2403 Guile:
2405 * Remove non-functional disabled guile bindings left over from Open Muscat
2406   days - if someone wanted to add guile bindings, it would be easier to start
2407   from scratch.
2409 Java-SWIG:
2411 * Update list of generated java sources in the SWIG-based Java bindings.
2413 PHP:
2415 * zend_throw_exception() returns, so return control to PHP directly after
2416   calling it to avoid needless extra work and possible issues.
2418 Python:
2420 * Fix "from xapian import *".  (ticket#477)
2422 * Fix testcase weight_normalise - a change in xapian-core means that
2423   get_max_possible() can now return zero for a non-existent term, so don't
2424   blindly calculate the reciprocal of it.
2426 * python/replicationtest2.py: Extend to check that changesets get applied
2427   correctly.
2429 * python/smoketest2.py: Check len(mset) works (improving test coverage of
2430   Python-specific wrapping).
2432 Xapian-bindings 1.2.0 (2010-04-28):
2434 This release includes all changes from 1.0.20 which are relevant.
2436 Portability:
2438 * configure: Tell libtool not to link in deplibs on platforms where we know
2439   they aren't needed.
2441 * configure: On Linux, extract the library search path from ldconfig which
2442   gives us the default entries reliably.
2444 Xapian-bindings 1.1.5 (2010-04-15):
2446 This release includes all changes from 1.0.19 which are relevant.
2448 Tcl:
2450 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
2451   sidestep the whole destructor issue.  (ticket#62)
2453 Xapian-bindings 1.1.4 (2010-02-15):
2455 This release includes all changes from 1.0.18 which are relevant.
2457 General:
2459 * Update for the new Brass backend and other C++ API changes.
2461 * Wrap Database::get_doclength_lower_bound(),
2462   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
2463   Database::valuestream_begin() and Database::valuestream_end() for all
2464   languages. (ticket#431)
2466 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
2468 Python:
2470 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
2471   object which dereferences to a ValueStreamItem object,
2473 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
2475 Ruby:
2477 * Add safe wrapper for the valuestream iterator.
2479 Xapian-bindings 1.1.3 (2009-11-18):
2481 This release includes all changes from 1.0.15-1.0.17 which are relevant.
2483 General:
2485 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
2486   specified.
2488 * Wrap the new MatchSpy class, and associated features.
2490 * Don't wrap PostingSource::serialise(), Weight::serialise() and
2491   Weight::unserialise() as they aren't useful from the bindings.
2493 * Update for the Sorter to KeyMaker changes.
2495 PHP:
2497 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
2498   as it standardly is on Microsoft Windows.  Fixes #411.
2500 * Merged the PHP "smoketest" back together now we don't need to support
2501   PHP4 now.
2503 Python:
2505 * Fix a memory leak on error (in theory - we've not got a way to generate this
2506   error, so haven't been able to reproduce the leak or test the fix).
2508 Xapian-bindings 1.1.2 (2009-07-23):
2510 This release includes all changes from 1.0.14 which are relevant to trunk.
2512 Python:
2514 * Several changes towards fully supporting Python 3, but more work is required.
2515   (ticket#246)
2517 Xapian-bindings 1.1.1 (2009-06-09):
2519 This release includes all changes from 1.0.13 which are relevant to trunk.
2521 General:
2523 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
2525 CSharp:
2527 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2528   C# yet, and to use Query("") and Query() instead.
2530 * configure: If we don't find a C# compiler, don't test an empty command name
2531   further which saves a fork and avoids an odd looking message.
2533 PHP:
2535 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2536   PHP yet, and to use Query("") and Query() instead.
2538 Python:
2540 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
2541   are wrapped (ticket#158).
2543 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
2544   expect SYNONYM in generated query.
2546 Ruby:
2548 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2549   Ruby yet, and to use Query("") and Query() instead.
2551 Tcl:
2553 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
2554   are wrapped (ticket#158).
2556 Xapian-bindings 1.1.0 (2009-04-22):
2558 Documentation:
2560 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
2561   the instructions to suggest users use this standard location for installing
2562   without root access.
2564 General:
2566 * All deprecated features slated for removal in 1.1.0 have been removed.
2568 * All new C++ API features have been wrapped.  Also, since we now supply some
2569   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
2570   these can be passed in even for languages for which SWIG doesn't support
2571   subclassing.
2573 Packaging:
2575 * xapian-bindings.spec: Updated to reflect the new Python packaging.
2577 Portability:
2579 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
2580   to put the compiler into ISO C++ mode).
2582 PHP:
2584 * PHP4 support has been removed, since PHP4 is no longer supported upstream
2585   as of 2008-08-08.
2587 Python:
2589 * Python 2.3 or later is now required.  2.2 is essentially unsupported
2590   upstream.
2592 * The import method used has been changed (by using a newer SWIG version)
2593   and no longer gives a warning with Python 2.6.
2595 * Initial support for Python 3.0 has been added.  This currently doesn't
2596   work correctly and should be treated as experimental. (ticket#346)
2598 * The newer SWIG version handles exceptions in director methods correctly
2599   so we no longer need our workaround for ticket #289.
2601 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
2602   wrapped for Python as Database.metadata_keys().
2604 * The Python bindings are now installed as a python package, with the
2605   files in a xapian subdirectory, hiding the internal _xapian module
2606   better.
2608 * Python now flags deprecation warnings for the single argument form and old
2609   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
2610   friends.
2612 Xapian-bindings 1.0.23 (2011-01-14):
2614 Portability:
2616 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
2618 PHP:
2620 * Document that iterators shouldn't be dereferenced or advanced when at their
2621   end points (ticket#520).
2623 Python:
2625 * Fix memory leaks in typemaps which return Python lists.
2627 Xapian-bindings 1.0.22 (2010-10-03):
2629 Packaging:
2631 * RPM: Don't package _XapianSharp.la.
2633 CSharp:
2635 * Don't install _XapianSharp.la.
2637 Python:
2639 * configure: Use sys.version_info tuple, rather than string splicing which
2640   assumes the Python "major.minor" is 3 characters (which would fail if Python
2641   2.10 were ever released, for example).
2643 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
2644   testcase in pythontest.py.
2646 Xapian-bindings 1.0.21 (2010-06-18):
2648 Python:
2650 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
2651   can't be written to. (ticket#297)
2653 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
2655 * Add test to check that "from xapian import *" works.
2657 Xapian-bindings 1.0.20 (2010-04-27):
2659 Python:
2661 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
2662   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
2663   trap to delete them after running tests for older versions of Python.
2664   (ticket#315)
2666 Ruby:
2668 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
2670 Xapian-bindings 1.0.19 (2010-04-15):
2672 Tcl:
2674 * tcl8/docs/index.html: Improve wording in a few places.
2676 Xapian-bindings 1.0.18 (2010-02-14):
2678 General:
2680 * Wrap new C++ API method Document::add_boolean_term().
2682 Ruby:
2684 * Generate entries in the Ruby rdocs for all classes which aren't documented
2685   because of Ruby-specific methods.  Fixes ticket#417.
2687 * Avoid absolute paths in the generated rdocs.
2689 Xapian-bindings 1.0.17 (2009-11-18):
2691 Packaging:
2693 * Improve RPM package summaries - the files are needed to *use* scripts as well
2694   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
2695   conventional.
2697 Portability:
2699 * python/Makefile.am: Restore the "./" path to the sourced file
2700   libtoolconfig.tmp as ksh requires it.
2702 Java:
2704 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
2706 Xapian-bindings 1.0.16 (2009-09-10):
2708 Python:
2710 * Improved docstrings for QueryParser::set_default_op() and
2711   QueryParser::get_default_op() (automatically generated from changes in
2712   xapian-core).
2714 Xapian-bindings 1.0.15 (2009-08-26):
2716 Python:
2718 * Don't break long words when wrapping text in the generated API documentation
2719   comments as this was causing identifiers to be broken in two.
2721 Xapian-bindings 1.0.14 (2009-07-21):
2723 General:
2725 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
2726   and the only side-effect was an odd looking message.
2728 Python:
2730 * Rename methods at build-time using SWIG rather than a run-time in Python, as
2731   the latter approach adds a small time overhead when the module is being
2732   loaded.
2734 Ruby:
2736 * Fix to accept an integer value > MAXINT for a double parameter.
2738 Xapian-bindings 1.0.13 (2009-05-23):
2740 Packaging:
2742 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
2743   _XapianSharp.so in 1.0.11.
2745 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
2746   bindings since 1.0.6.
2748 PHP:
2750 * Backport fix from SWIG SVN for misuse of formatted error function in
2751   SWIG-generated code.
2753 Python:
2755 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
2756   Python's Global Interpreter Lock (GIL) in situations where we know that it
2757   will already be locked.  This avoids some dead-locks with mod_python (due to
2758   mod_python bugs which are apparently unlikely to ever be fixed), and results
2759   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
2760   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
2761   faster). (ticket#185)
2763 * README,python/docs/index.html: Update documentation of the above mod_python
2764   issue and also document the related mod_wsgi issue.  The status is now that
2765   everything seems to work if you stick to the main interpreter (ticket#364).
2767 * Backport fix from SWIG SVN for misuse of formatted error function in
2768   SWIG-generated code.
2770 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
2771   second parameter, not the third.
2773 * python/docs/examples/simplematchdecider.py,
2774   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
2775   clearer code.
2777 Ruby:
2779 * README: Note that the testsuite fails due to a bug in the test/unit module in
2780   Ruby 1.9.0, but applications using the bindings should work, and that the
2781   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
2782   appears to be completely dead both upstream and in the wild.
2784 Xapian-bindings 1.0.12 (2009-04-19):
2786 Documentation:
2788 * INSTALL: Add a note about being able to pass variables to configure to pick
2789   which of several parallel installations of a language to build for.
2791 Python:
2793 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
2794   test to avoid failing due to rounding differences.
2796 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
2797   stop the whole testsuite, not just the currently running testcase.
2799 Xapian-bindings 1.0.11 (2009-03-15):
2801 Documentation:
2803 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
2804   Python 3, and possible current issues with Ruby 1.9.
2806 Portability:
2808 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
2809   Cygwin.
2811 Python:
2813 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
2814   latter is deprecated, and support was removed in 1.0.0).
2816 * Add support for using the new name ("reverse") for the second argument of
2817   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
2818   The old name ("ascending") is still supported, but will be deprecated in
2819   1.1.0.
2821 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
2822   which get set on other objects to avoid segmentation faults if they go out
2823   of scope before the object they are set on does.  (ticket#341)
2825 Ruby:
2827 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
2828   fails so "make check" doesn't pass, but code using the bindings should work.
2830 Xapian-bindings 1.0.10 (2008-12-23):
2832 Python:
2834 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
2835   as things stand (upstream fix for Debian bug 506090).
2837 Xapian-bindings 1.0.9 (2008-10-31):
2839 General:
2841 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
2843 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
2844   methods.
2846 Xapian-bindings 1.0.8 (2008-09-04):
2848 General:
2850 * configure: Report bug report URL in --help output.
2852 Python:
2854 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
2855   (bug#289)
2857 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
2859 Xapian-bindings 1.0.7 (2008-07-14):
2861 Documentation:
2863 * Document how all the database factory functions and library version functions
2864   are wrapped for all languages.
2866 General:
2868 * Fix to build against a xapian-core which has quartz and/or flint disabled.
2870 * The "program" version of Remote::open() has been wrapped for some time, so
2871   update the documentation which said it wasn't.
2873 Packaging:
2875 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
2877 Portability:
2879 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
2880   different module extension rather than our own ugly bodge.
2882 Java:
2884 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
2885   simple to make C++ to Java work though.
2887 PHP:
2889 * Add test that OP_VALUE_GE works for PHP.
2891 Python:
2893 * Several corrections to the Python documentation.
2895 * configure: Fix problem with building under mingw.
2897 Ruby:
2899 * Include simplematchdecider.rb example.
2901 * smoketest.rb: Test the version reporting functions.
2903 Tcl:
2905 * Include simpleexpand.tcl example.
2907 * Fix where the Tcl module gets installed.
2909 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
2911 Xapian-bindings 1.0.6 (2008-03-17):
2913 General:
2915 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
2916   used with.
2918 * configure: Correct the required SWIG version given in an error message.
2920 PHP:
2922 * php/smoketest.php: Add note that this script should be run using 'make check'
2923   in the build tree (rather than trying to copy it to a webserver as someone
2924   recently tried to).
2926 * php/smoketest.php: Fix to work under PHP4.
2928 Python:
2930 * The Python module now always has the extension which Python expects, which
2931   fixes a failure on Mac OS X.
2933 Ruby:
2935 * Automatically install/uninstall the Ruby rdoc-generated documentation along
2936   with the ruby bindings.
2938 Tcl:
2940 * configure: Sort out the default value of TCL_LIB, which could end up being
2941   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
2943 Xapian-bindings 1.0.5 (2007-12-21):
2945 General:
2947 * Wrap Xapian::Sorter and subclasses.
2949 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
2950   and Enquire::set_sort_by_relevance_then_key().
2952 * Factor out the code to protect multitarget rules against parallel make, and
2953   fix it to handle the source being changed while the rule is executing, and to
2954   correctly return an error code if we fail while trying to recover from the
2955   removal of a target of a multi-target rule.
2957 * configure: Improve the clarity of the error given when none of the tools
2958   needed for any supported language are found.
2960 * configure: SWIG 1.3.32 has now been released, so require at least this
2961   released version for maintainer builds.
2963 Java:
2965 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
2966   GCC 4.3.
2968 * configure: Log the output of trying to compile conftest.java in config.log;
2969   if the test fails, report whether the failure was compiling or running the
2970   test program.
2972 * Check for directory existence rather than calling mkdir unconditionally as
2973   despite the "(ignored)", the error message seems to confuse some people.
2975 PHP:
2977 * Add feature test for XapianMultiValueSorter.
2979 * php/smoketest5.php: Fix use of Database_get_document to new style OO
2980   interface.  Fix the error reported when the PHP5 exception test fails.
2982 * php/smoketest.php: Add feature test to confirm that optional arguments to
2983   XapianQuery's "term" constructor are wrapped.
2985 Python:
2987 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
2988   these properties build a python list, so dropping the GIL isn't safe and
2989   may cause undefined behaviour in multithreaded environments.
2991 * configure: Update error message to reflect requirement for at least python
2992   2.2.
2994 * configure: Change "print foo" to "print(foo)" in python version checks, for
2995   compatibility with python 3.0.
2997 Ruby:
2999 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
3000   previously incorrect).
3002 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
3003   ruby/docs/index.html previously had a dead link to.
3005 Tcl:
3007 * configure: Overhaul code to find tcl.h since the old version no longer worked
3008   with Debian unstable.
3010 * tcl8/docs/index.html: Update documentation to cover flint and mention that
3011   quartz is now deprecated.
3013 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
3014   throws QueryParserError instead.
3016 Xapian-bindings 1.0.4 (2007-10-30):
3018 General:
3020 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
3021   Add feature tests for all languages.
3023 * The "bindings.html" file documenting each of the bindings has been renamed to
3024   "index.html".
3026 Packaging:
3028 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
3029   older distros.
3031 Portability:
3033 * Fix warnings when compiling with GCC 4.2.
3035 PHP:
3037 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
3038   and methods/functions which return a wrapped class.
3040 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
3041   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
3043 * Document how non-class functions are wrapped.
3045 * Fix wrapping of NumberValueRangeProcessor for PHP4.
3047 * smoketest.php: Split the regression test for bug#193 into separate
3048   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
3050 Python:
3052 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
3053   non-pythonic iterators.  Make it clearer that the "sequence API" is
3054   deprecated.
3056 * Add test of a custom ValueRangeProcessor (ie, one written in python).
3058 * Update the examples to use the new-style attributes to access MSet item
3059   values rather than the old-style MSET_* constants.
3061 * Document MSET_DOCUMENT.
3063 Ruby:
3065 * smoketest.rb: Rename test of metadata access methods which had been named the
3066   same as the matchdecider test due to a copy-and-paste error.
3068 Xapian-bindings 1.0.3 (2007-09-28):
3070 General:
3072 * Wrap new methods Database::get_metadata() and
3073   WritableDatabase::set_metadata().
3075 * "make uninstall" now removes the loadable module we install for each of
3076   the bindings.
3078 * "make distcheck" now works.
3080 * Distribution tarballs are now in the POSIX "ustar" format since it saves
3081   about 40KB and we need to use it for xapian-core anyway.
3083 Packaging:
3085 * RPMs: Package xapian.php.
3087 CSharp:
3089 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
3090   usefully used currently.
3092 Java:
3094 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
3095   C++ library.
3097 * "make clean" now removes the class files generated for inner classes.
3099 PHP:
3101 * Add feature test for DateValueRangeProcessor when used with QueryParser.
3103 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
3104   isn't actually very useful, since you can't subclass it in PHP currently.
3106 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
3107   if the third parameter was specified and a floating point number (e.g. 0.0).
3109 * php/docs/bindings.html: Fix errors in example code.
3111 Python:
3113 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
3114   Python which takes two strings and returns a 3-tuple (value_number,
3115   modified_begin, modified_end).  Previously this always failed with a
3116   type error, so this doesn't break existing code.
3118 * python/pythontest.py: Interpret any commandline arguments as a list of
3119   tests to be run (the default is to run all tests).
3121 * README,python/docs/bindings.html: Add a note about the problems with
3122   mod-python (as described in bug #185).
3124 * python/pythontest.py: Delete the database handles before deleting a database
3125   to fix problems running the Python tests on MS Windows (bug#179).
3127 * "make clean" now removes testsuite.pyc.
3129 Ruby:
3131 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
3132   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
3133   now the site-specific directories, which is more correct when building
3134   from source.  Debian packages, etc can override this by setting RUBY_LIB and
3135   RUBY_LIB_ARCH.
3137 Tcl:
3139 * Check for TCL_LIB in the environment or on the configure command-line to
3140   allow installing without root access more cleanly.
3142 Xapian-bindings 1.0.2 (2007-07-05):
3144 Documentation:
3146 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
3147   phpextdir.
3149 * Remove documentation of removed "--with-swig" configure option.
3151 General:
3153 * Add methods of NumberValueRangeProcessor for serialising and
3154   unserialising doubles.
3156 * Add methods and constants supporting spelling correction and synonyms.
3158 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
3159   to ensure that it works with uninstalled copies of Xapian.
3161 * Value of PYTHON_LIB supplied to configure is now respected - previously
3162   it was documented, but ignored.
3164 * Add support for supplying PHP_EXTENSION_DIR to configure.
3166 * Change to using "%include", rather than reproducing contents of header
3167   files, for "queryparser.h", "document.h" and "postingiterator.h".
3169 * Add new form of get_mset() which allows a matchspy matchdecider to be
3170   set.
3172 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
3173   explode.  Add in a missing "mv" in the command for installing tcl8
3174   documentation.
3176 CSharp:
3178 * Fix rule handling parallel make to include xapian_wrap.h
3180 PHP:
3182 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
3183   doesn't seem to be a standard location, but this works for Debian at
3184   least, and it seems better to at least try to install it.
3186 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
3187   prefix for PHP4.
3189 Python:
3191 * Fix a threading problem: the GIL was not being acquired in the exception
3192   handling code before setting the Python exception state, leading to
3193   various memory corruption symptoms in threaded programs.
3195 * Add special iterators to Database for synonyms, synonym_keys and
3196   spellings.
3198 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
3199   synonym iterators and spelling iterators.
3201 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
3202   the expected description to make the tests more readable.
3204 Xapian-bindings 1.0.1 (2007-06-11):
3206 Documentation:
3208 * NEWS: Fix the recent headings which said "Xapian-core" to say
3209   "Xapian-bindings".
3211 General:
3213 * Wrap Xapian::Query constructor for creating ValueRange queries.
3215 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
3216   which take a prefix.
3218 Packaging:
3220 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
3221   %{buildroot} prefix on most files which we then have to work around.
3223 CSharp:
3225 * SimpleIndex now uses Xapian.TermGenerator.
3227 * SimpleSearch now uses Xapian.QueryParser.
3229 * New SimpleExpand example.
3231 * Document explicitly how STEM_SOME constants are currently wrapped.
3233 * Update GetTermName() reference in documentation to GetTerm().
3235 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
3236   their CVS repo, and the fix should be in their 0.8.2 release.
3238 Java:
3240 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
3241   looked at, but in fact its value was read but ignored.  We now use it as the
3242   first place to look for jni.h.
3244 * configure will now automatically add an extra "-I" for the
3245   linux/solaris/win32 subdirectory which Sun's JDK requires.
3247 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
3248   "precious" so their values are preserved for when configure is automatically
3249   rerun.
3251 PHP:
3253 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
3255 * The PHP examples have been rewritten to be clearer and to make use of the
3256   new XapianTermGenerator class.
3258 Python:
3260 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
3262 * Add support for prefix-restricted pythonic allterms iterators.
3264 * Update documentation in a couple of places to refer to updated replacements
3265   for MSetIterator.
3267 * Change testsuite output to be more vim-friendly (vim should be able to jump
3268   to the right lines now).
3270 * __str__ on Xapian::Error now includes extra information in some cases (the
3271   error_string and context, if they are set).
3273 * python/smoketest.py: Eliminate uses of the legacy sequence API.
3275 * python/pythontest.py: The legacy sequence API is only supported for Python
3276   2.3 and later, so don't run tests for it when running under Python 2.2.
3278 * We now generate and install xapian.pyo as well as xapian.pyc.
3280 Ruby:
3282 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
3283   classes.
3285 * Add missing rename for the C++ TermGenerator::set_document() method so it can
3286   be used as "tg.document = doc" in Ruby.
3288 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
3290 Tcl:
3292 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
3293   feedback, based on C++ simpleexpand.cc.
3295 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
3296   TermGenerator class.
3298 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
3299   QueryParser class.
3301 * tcl8/docs/bindings.html: Document how constants are wrapped.
3303 * Update smoketest and examples to require version 1.0.0 - previously this
3304   required 0.9.6, which failed since TCL doesn't accept differing major
3305   version numbers.
3307 * pkgIndex.tcl is now generated by configure.
3309 Packaging:
3311 * The required automake version has been lowered to 1.8.3, so RPMs can now be
3312   built on RHEL 4 and SLES 9.
3314 Xapian-bindings 1.0.0 (2007-05-17):
3316 Documentation:
3318 * Document Unicode support for each language.
3320 * Assorted minor improvements and typo fixes.
3322 General:
3324 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
3325   it, for languages where SWIG supports directors.
3327 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
3328   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
3329   allows the "default_prefix" argument to be supplied, QueryParser flags
3330   FLAG_PURE_NOT and FLAG_PARTIAL.
3332 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3334 * Remove wrappers for deprecated features removed from the C++ API (see
3335   docs/deprecation.html in xapian-core for full details and upgrade
3336   information).
3338 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
3340 * QueryParserError is now a real error, so remove special handling for "const
3341   char *" exceptions.
3343 * Use a stamp file in "make" rules with multiple targets so that parallel
3344   make works.
3346 * configure: Now quotes $PYTHON, etc so that you can specify a program with
3347   arguments.
3349 * configure: If the user specifies a program which doesn't exist (e.g.
3350   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
3352 * configure: Disable probes for f77, gcj, and rc completely by preventing
3353   the probe code from even appearing in configure - this reduces the size of
3354   configure by 28% and should speed it up significantly.
3356 * configure: If the version check against the xapian-core version detects a
3357   mismatch, we now issue a warning rather than a hard error since if you're
3358   careful this can work.  The warning is issued late on in configure, so it's
3359   harder for the user to miss.
3361 * configure: The --with-swig option has been removed.  It no longer has a
3362   purpose as we now ship the files which are generated by SWIG.
3364 Portability:
3366 * The PHP bindings can now be built with MSVC for Microsoft Windows.
3368 CSharp:
3370 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
3371   than mcs to avoid segmentation faults at runtime due to unimplemented
3372   features in mcs.  Document this, and update configure to prefer gmcs.
3374 * The return type of MatchDecider::operator() is now `bool' rather than `int'
3375   (in line with the same change in the C++ API).
3377 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
3379 Java:
3381 * The Java bindings have been updated to use C++ replacements for deprecated
3382   methods, so they still build.  The Java wrappers still provide the old
3383   deprecated names for now though.  The longer term plan is to replace the
3384   hand-written JNI with SWIG generated wrappers (work has now begun on this)
3385   which is likely to require some API changes, and it seems more sensible to
3386   make any changes to align with C++ API changes at the same time.
3388 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
3389   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
3391 PHP:
3393 * Fix undefined behaviour in get_matching_terms().
3395 * Document the (existing) renaming of methods which are PHP reserved words
3396   (empty() to is_empty() and clone() to clone_object()).
3398 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3400 Python:
3402 * The Python bindings now throw exceptions as classes with a hierarchy which
3403   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
3404   base class inherits from the standard Python Exception class.
3406 * All Python methods which accept strings can now be passed either a unicode
3407   object or a simple string.  Strings are returned as simple strings: unicode
3408   input will be returned as utf-8 encoded output.  The documentation now
3409   contains a "Unicode" section.
3411 * The Python bindings should now be usable more efficiently from threaded
3412   Python applications since we now use SWIG's -threads option when generating
3413   them, so that the GIL is released during long-running Xapian operations
3414   (bug#137).
3416 * Most classes, methods, functions, etc now have docstrings which are either
3417   automatically extracted from the C++ documentation comments, or overridden by
3418   more appropriate versions.
3420 * Most of the Pythonic iterators now return an object instead of a sequence,
3421   which means they now lazily fetch the information which previously had to be
3422   fetched to put it in the sequence.  The old sequence API is supported for
3423   compatibility, but is scheduled for removal in Xapian 1.1.0.
3425 * Those Python iterators which have skip_to() methods now return the item
3426   skipped to, and next() will return the following item.  Previously, they
3427   returned None, and next() returned the item skipped to.  Several bugs in the
3428   skip_to() wrappers were fixed.
3430 * Because of the lazy access, some objects returned by iterators will raise
3431   an error if the lazy evaluation happens after the iterator has moved on
3432   (since the underlying Xapian API doesn't allow efficient access to the
3433   information in this situation).  The exact semantics are defined in the
3434   docstrings for each iterator.
3436 * Those Pythonic iterators which return only a list of terms now return
3437   simple strings, instead of a sequence or an object containing the term.  This
3438   is an incompatible change with earlier releases.  The affected iterators are
3439   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
3440   QueryParser.unstemlist.
3442 * The contents of an MSet can now be iterated in the standard Python way.
3443   The iteration will return MSetItem objects.  The __contains__ and __getitem__
3444   methods are also implemented, allowing the "in" and [] operators to work.
3445   MSet.__getitem__ is a synonym for MSet.get_hit.
3447 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
3448   so that lazy access to its attributes is supported.  MSetItem has some
3449   deprecated methods which mimic the MSetIterator interface to allow old code
3450   to work without modification until release 1.1.0.
3452 * MSetItem provides access to the collapse_key and collapse_count, which
3453   weren't accessible from the sequence returned by the iterators before this
3454   release.
3456 * Out-of-range access to MSets will now raise an IndexError - it used to
3457   cause undefined behaviour (usually a crash).
3459 * The Python testsuite is now much more extensive, and supports colour output
3460   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
3461   features are separated out, so that they can easily be removed when the
3462   features are removed.  The Python tests currently focus mainly on Python
3463   specific iterators and related functionality - general Xapian behaviour is
3464   tested by the C++ testsuite.
3466 * The pure Python code in the bindings now uses new-style classes, since we
3467   have required Python >= 2.2 since Xapian release 0.9.9.
3469 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
3470   instead.
3472 * The get_description() method which many classes support has been deprecated
3473   in favour of new more pythonic __str__ methods, so that the str() builtin can
3474   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
3476 Ruby:
3478 * We no longer regard the Ruby bindings as "beta quality", so remove the
3479   warning from their documentation.
3481 * Document that that C++ operator() becomes the method "call" in Ruby.
3483 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
3484   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
3486 Tcl:
3488 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3490 Xapian-bindings 0.9.10.1 (2007-04-04):
3492 PHP:
3494 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
3495   default parameters.  The most notable case was a missing Query constructor
3496   which meant that QueryParser was unusable.
3498 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
3499   (which mostly seems to mean the MS Windows version).
3501 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
3502   seems to mean the MS Windows version).
3504 * Add note to the documentation that PHP examples are written for CLI version
3505   of PHP, but that the bindings work with any version.
3507 * Add check to all PHP examples that they are being run under a CLI version of
3508   PHP.
3510 Python:
3512 * simpleexpand.py: Print each term's expand weight as a floating point value,
3513   not an integer.
3515 Ruby:
3517 * INSTALL: document how to install Xapian's Ruby bindings in your home
3518   directory.
3520 Xapian-bindings 0.9.10 (2007-03-04):
3522 Java:
3524 * Under Mac OS X, automatically look in the standard location for jni.h,
3525   and automatically rename the JNI library we build to ".jnilib", as is
3526   required by the OS X JVM.
3528 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
3529   to add the linux header directory to the include path when using this JDK.
3531 * Add missing default constructor for RSet class - it's not much use without
3532   this!
3534 * Fix Enquire.getESet() to actually work.
3536 * Fix bug in ESetIterator.hasNext().
3538 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
3540 * Fix memory leak with some JVMs in the "Query from array" constructor.
3542 * Fix memory leak in Enquire.setQuery().
3544 * SmokeTest.java: Add regression tests for RSet default constructor,
3545   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
3546   Add feature tests for Enquire.getQuery(), and to make sure we get passed
3547   the right document in a java subclass of MatchDecider.
3549 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
3550   respective variables are set.
3552 PHP:
3554 * Update the documentation to fix out-of-date information and document the
3555   differences between the PHP4 and PHP5 wrappers.
3557 * Update the examples to use the new Object Oriented API, and provide versions
3558   for both PHP4 and PHP5.
3560 * Add a "simpleexpand" example.
3562 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
3563   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
3564   new name, but keep the old name for now for backward compatibility.
3566 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
3567   interpreter - this works with PHP5.
3569 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
3570   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
3571   directory may not exist and "make install" will create it.
3573 * configure: If zend.h isn't found and configure was run with "--with-php",
3574   exit with an error rather than automatically disabling PHP support.
3576 Python:
3578 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
3580 Packaging:
3582 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
3583   various "--without" options in a comment at the start of the .spec file.
3585 * RPMs: Remove "." from the end of the Summary.
3587 Xapian-bindings 0.9.9 (2006-11-09):
3589 Documentation:
3591 * Ship our custom INSTALL file rather than the generic one from autoconf which
3592   we've accidentally been shipping instead since 0.9.5.
3594 General:
3596 * Wrap Flint::open() and Flint::open_writable().
3598 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
3599   suitable).
3601 Python:
3603 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
3604   bit platforms with Python 2.5.
3606 Packaging:
3608 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
3610 * RPMs: The Python bindings now require Python >= 2.2.
3612 Portability:
3614 * configure: Remove unnecessary backticks from tclsh version test.
3616 Xapian-bindings 0.9.8 (2006-11-02):
3618 General:
3620 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
3621   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
3623 * The C++ method QueryParser::parse_query() current throws "std:string"
3624   exceptions if there's a parse error.  Previously the bindings didn't catch
3625   these.  Now we catch them and handle them as if they were exceptions of
3626   type Xapian::QueryParserError (in anticipation of this changing in
3627   xapian-core).  Added testcases for this for PHP, Python, and C#.
3629 * configure: Note that SWIG is only useful for Xapian developers in --help
3630   output.
3632 * configure: If we failed to find any languages to build for, give a more
3633   helpful message.
3635 CSharp:
3637 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
3639 Java:
3641 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
3642   work rather than using the cached failure of the first jni.h check.
3644 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
3646 * SmokeTest.java: Avoid gcj "set but not used" warning.
3648 PHP:
3650 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
3652 * smoketest4.php,smoketest5.php: Check the exception message given by the
3653   DocNotFoundError testcase.
3655 Python:
3657 * Drop support for Python 2.1.
3659 Xapian-bindings 0.9.7 (2006-10-10):
3661 Documentation:
3663 * NEWS: Fix the recent headings which said "Xapian-core" to say
3664   "Xapian-bindings".
3666 General:
3668 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
3669   configure.ac.
3671 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
3672   compiling SWIG generated code which makes the compiled modules a few percent
3673   smaller and perhaps a little faster.
3675 * Wrap the newly implemented transaction API.
3677 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
3678   (this option was supposed to be used to compile the Python bindings from
3679   0.9.3 onwards, but this wasn't actually working correctly).
3681 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
3683 * In maintainer-mode, "make clean" now removes the SWIG generated files
3684   which would otherwise only be removed on "make maintainer-clean".
3686 CSharp:
3688 * Xapian::MatchDecider can now be subclassed in C#.
3690 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
3691   to use it.  This has been fixed and a regression test added.
3693 * SmokeTest.cs: Added exception handling test.
3695 Java:
3697 * Correct two misuses of delete to delete[].  Fixes bug#78.
3699 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
3700   Debian and Ubuntu boxes at least.
3702 PHP:
3704 * We now generate class wrappers for PHP5.
3706 * We now generate proxy classes for PHP4, which is an incompatible change
3707   from previous versions of xapian-bindings.  A perl script to upgrade
3708   your scripts is included.
3710 * smoketest.php:
3712   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
3713     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
3715   + Rely on xapian.php to load the extension module for us.
3717   + Fix error messages to show PHP code, not Python code.
3719 * When running smoketest.php, pass the "-q" option to php, which suppresses
3720   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
3721   recent versions of PHP.
3723 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
3724   the PHP interpreter not to be found in some cases when it was actually
3725   available, but it's only used to run the smoketest not for building the
3726   bindings.
3728 Python:
3730 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
3731   and also report the check and its result to the user.
3733 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
3734   built, so add an explicit dependency so that this works reliably in parallel
3735   builds.  Fixes bug#77.
3737 * In examples and documentation, don't call the MatchDecider class/object
3738   "matcher", since we use the term "matcher" to mean something else in
3739   the library documentation.
3741 * smoketest.py:
3743   + Add test of exception handling.
3745   + Add test that MatchDecider can be subclassed successfully.
3747 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
3748   pythonic iterator class.
3750 Ruby:
3752 * Xapian::MatchDecider can now be subclassed in Ruby.
3754 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
3755   (with no "ruby" alias) on Ubuntu dapper at least.
3757 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
3758   since we may have less than 10 matches, so say "1-<N>" instead.
3760 * simplematchdecider.rb: Implemented.
3762 Tcl:
3764 * Implement saner exception handling for Tcl and document it.
3766 * smoketest.tcl:
3768   + Add check that xapian::Query_OP_ELITE_SET has the right value.
3770   + Rework how the smoketest gets run to eliminate special code for using
3771     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
3772     to be run using installed bindings, and also makes it a better example
3773     program.
3775   + Add test for exception handling.
3777   + Send error messages to stderr.
3779   + Add comment about Tcl storing zero bytes as \xc0\x80.
3781 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
3783 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
3784   used for the Tcl bindings.
3786 Xapian-bindings 0.9.6 (2006-05-15):
3788 Documentation:
3790 * INSTALL: Add section describing how to install without root access.
3792 General:
3794 * Updated to reflect the renaming of Xapian::xapian_version_string and
3795   companions to Xapian::version_string.
3797 * Wrap optional length parameter to Enquire::set_query().
3799 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
3800   consistency.  Keep get_document_id as an alias for now for backward
3801   compatibility.
3803 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
3804   probably a largely harmless error).
3806 * Stop SWIG from adding exception handling wrappers to the calls which return
3807   version strings, since they can't throw exceptions.
3809 * xapian.i: Removed superfluous "const" from return type "docid" which is just
3810   a typedef for an unsigned integer type.
3812 * configure: Add some missing "checking ..." messages so the user has more idea
3813   what is going on.
3815 * Language specific util.i files can now define
3816   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
3817   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
3818   are provided for each language.  This avoids needing to keep this
3819   information in two different places.
3821 * xapian.i: Uncomment commented-out parameter names and fix duplicate
3822   parameter names (for the benefit of bindings which use the parameter names,
3823   like the OO PHP5 patch for SWIG I'm working on...)
3825 Portability:
3827 * configure: Fix warning flags passed for Intel C++ compiler.
3829 CSharp:
3831 * We now support building with Portable.NET.
3833 * Note that the passing of strings from C# into Xapian and back isn't currently
3834   zero byte safe.  If you try to handle string containing zero bytes, you'll
3835   find they get truncated at the zero byte.
3837 * C# bindings now build and pass tests when srcdir != builddir.
3839 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
3840   always say "CSharp" instead.
3842 * Not all machines are set up to run compiled C# programs when invoked
3843   directly, so get configure to check if we can, and otherwise see if using
3844   mono or ilrun works.  If not, just skip the C# tests.
3846 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
3847   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
3848   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
3850 * Move the C# specific %rename list to csharp/util.i.
3852 * Store the strong name key in the key container so we reuse it for later
3853   builds.
3855 * Wrap the version functions as more sensible names and document them (and
3856   continue to provide the older undocumented names for now just in case anyone
3857   was using them.)
3859 * Set the version of XapianSharp.dll correctly when building a snapshot from
3860   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
3862 * SmokeTest.cs: Add test of version functions.
3864 Guile:
3866 * The Guile bindings don't work and aren't being actively worked on, so we're
3867   no longer including them in the distributed tarball to avoid disappointing
3868   users who notice a "guile" subdirectory.  It also makes the download smaller.
3870 Java:
3872 * Simplify (and improve portability of) run-java-test by using "libtool
3873   --mode=execute"'s -dlopen option.
3875 * Need to make sure "built" subdirectory exists or building from clean fails.
3877 * Fix "make check" to work when srcdir != builddir.
3879 PHP:
3881 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
3882   4.3.10), so use "php -n" and then set the options we specifically want using
3883   "-d".
3885 * Fix the smoketest invocation to work better when srcdir != builddir.
3887 * Look for PHP interpreter first in prefix given by "php-config --prefix".
3889 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
3891 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
3893 * smoketest.php:
3895   + Add test for version reporting functions
3897   + If a test fails, say which one to aid debugging.
3899   + Added simple test that zero-bytes are handled correctly when passing
3900     strings to and from Xapian.
3902 Python:
3904 * README: Note that Python bindings have been built with MSVC.
3906 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
3907   to make them executable (they don't have a #! line).
3909 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
3910   "mymatchdecider".  Add description of what this example does.
3912 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
3914 * smoketest.py: Added simple test that zero-bytes are handled when passing
3915   strings to and from Xapian.
3917 Ruby:
3919 * Added new Ruby bindings from Paul Legato.
3921 Tcl:
3923 * smoketest.tcl:
3925   + Add test for version reporting functions
3927   + If a test fails, say which one to aid debugging.
3929   + Added simple test that zero-bytes are handled correctly when passing
3930     strings to and from Xapian.
3932 Xapian-bindings 0.9.5 (2006-04-08):
3934 Documentation:
3936 * HACKING,README: Split off HACKING to contain information which is only
3937   relevant to those wishing to modify the bindings.
3939 General:
3941 * SWIG-based bindings are now built with SWIG 1.3.29.
3943 * configure: Report which languages we're building bindings for just before
3944   configure finishes.
3946 * xapian.i: Make the stub definitions for disabled backends static.
3948 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
3949   message.
3951 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
3953 Packaging:
3955 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
3956   Python bindings to support 64 bit systems.
3958 * RPMs: Package the C# bindings.
3960 Portability:
3962 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
3963   different name.
3965 * configure: Detect Intel's C++ compiler and set suitable warning flags to
3966   avoid noise from compiling generated code.
3968 CSharp:
3970 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
3972 Guile:
3974 * configure: Disable --with-guile since Guile support doesn't currently work.
3976 Java:
3978 * Override deprecation warnings for Xapian methods/functions/etc.
3980 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
3981   have some idea what went wrong!
3983 * Rework how we include headers to get hash_map to avoid compiler warnings
3984   since it's usually not in the std namespace nowadays.
3986 * Previously the "all" target also ran the "install" target, but this has
3987   proved very problematic, so change "make check" to use the uninstalled JNI
3988   glue library, and update the instructions to say that "make install" is now
3989   required.
3991 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
3992   .class files.
3994 * README: Note that some platforms need "-pthread" or similar flags.
3996 * Add a new Query constructor wrapper which take an OP_xxx and an array of
3997   Query objects.
3999 * Compiling a .java file to a .class file now deletes the .jar file to ensure
4000   it gets updated.
4002 PHP:
4004 * php -n avoids reading any php.ini, but the compiled in default may be to
4005   enable the dubiously named "safe_mode" which prevents dl() being used so
4006   "make check" fails.  So instead provide a very simple php.ini which turns off
4007   safe_mode and makes sure enable_dl is on.
4009 * Fix handling of bool parameters when resolving overloaded methods and/or
4010   default arguments.  This fixes Enquire_sort_by_value() to work when the
4011   second argument is specified.  Added regression test for this case.
4013 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
4015 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
4016   passed by reference.  Fixes bug#74.
4018 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
4019   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
4021 Python:
4023 * Use the fairly new "swig -O" option for the "modern" python bindings as
4024   it generates a smaller glue library and runs faster.  Some of the features
4025   enabled also work on python 2.1, so enable these for the "olde" bindings.
4027 * configure: Catch the case where the user has python installed but not the
4028   module "distutils.sysconfig" and explain that they probably need to install a
4029   python-dev or python-devel package.
4031 * "make check" now works in VPATH builds.
4033 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
4034   know which check it was!
4036 * smoketest.py: catch Exception objects and print them.
4038 * smoketest.py: Add feature tests for the various pythonic iterator
4039   wrappers
4041 * python/docs/bindings.html: Document the Pythonic iterators.
4043 * Fix TermIter not to try to read termfreqs or positions if they aren't
4044   meaningful for the current TermIter.
4046 Xapian-bindings 0.9.4 (2006-02-21):
4048 Documentation:
4050 * COPYING: Updated FSF address.
4052 General:
4054 * Wrap Stopper::get_description().
4056 * Wrap xapian_version_string() and related functions.
4058 Portability:
4060 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
4061   run from "make" too.
4063 PHP:
4065 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
4066   default on Windows).
4068 Python:
4070 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
4072 Xapian-bindings 0.9.3 (2006-02-16):
4074 Documentation:
4076 * README: Updated and expanded (now covers supported platforms, and lists
4077   criteria which bindings for an additional language need to fulfil before
4078   we're likely to accept them).
4080 * INSTALL: Updated and improved.
4082 * TODO: Move C#-specific TODO to top level so we can track to-do items for
4083   all languages.
4085 General:
4087 * configure: Change how the user selects which bindings to build.  If no
4088   --with* arguments are passed, then we default to building bindings we detect
4089   the required tools for (as before).  But instead of requiring the user to
4090   deselect all bindings they don't actually want, we now let them select the
4091   bindings they do want.  So "./configure --with-python" will only build the
4092   python bindings (and will fail if the required tools aren't installed).
4094 * Every wrapped method contains exception handling code.  The bulk of this
4095   is now factored out into a single helper function, which cuts the compile
4096   time by around a factor of 3 and halves the size of the stripped library
4097   (figures are for Tcl on x86_64).
4099 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
4100   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
4102 * configure: Bump required SWIG version to 1.3.28 and drop the special
4103   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
4104   SWIG to install the bindings - SWIG is run by the Xapian developers
4105   so these updated requirements are only relevant if you want to modify
4106   the bindings.
4108 * Eliminate separate Makefile in each examples subdirectory, which makes the
4109   build system simpler, smaller, and a little faster.
4111 * xapian.i: Include default constructors for all classes so that SWIG knows it
4112   doesn't have to use SwigValueWrapper for them, which makes the bindings code
4113   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
4114   std::pair<...>.
4116 * configure: Document special environmental variables which configure
4117   recognises.  Enhance handling of environmental variables so you can
4118   e.g. './configure PYTHON=python23' (previously you had to give a full
4119   path in such environmental variables or they would be ignored.
4121 Packaging:
4123 * RPM spec file:
4125   + Automatically detect the python version.
4127   + Rename "php4" references to "php".
4129   + Automatically detect the PHP extension directory.
4131   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
4133   + Add support for "--without php" and --without tcl8" options to rpmbuild.
4135 Portability:
4137 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
4138   10.3.  This is required to link the bindings, and it doesn't seem to be
4139   possible to link them on 10.1 or 10.2 anyway.
4141 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
4142   to be explicitly specified and libtool correctly handles platforms where it
4143   would have been implicitly linked with anyway.
4145 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
4147 * configure: Add missing ";;" on the last alternative in some case statements.
4149 * Only pass -no-undefined on platforms where it is required in order to link a
4150   shared library at all (it causes problems on Mac OS X in some cases).
4152 CSharp:
4154 * This release includes a lot of improvements for the C# bindings.  They're
4155   now pretty much on a par with the other language bindings.
4157 * Added documentation and examples.
4159 * Method and function names are now renamed to match C# conventions
4160   (e.g. from get_description() to GetDescription()).  This is obviously an
4161   incompatible change, but the C# bindings haven't been suitable for real world
4162   use prior to this release.
4164 * Optional parameters are now wrapped so no longer need be specified
4165   explicitly.
4167 * Overload ++ and -- for iterators.
4169 * Overload == and != for iterators.  Now comparisons with the end iterator
4170   work as expected, and SmokeTest passes.
4172 * SmokeTest now reports exceptions verbosely.
4174 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
4175   similarly for other database factory functions.
4177 * Heed compatibility warnings from mcs and use different forms for
4178   command-line switches to the C# compiler (presumably for compatibility with
4179   Microsoft's compiler, though the warnings don't actually say that
4180   explicitly).
4182 Guile:
4184 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
4185   zero-byte safe.  The guile bindings are still a long way from actually
4186   working though.
4188 Java:
4190 * Wrap optional second parameter (query length) to Enquire::set_query().
4192 * configure now probes for the Java path separator, which we then use to
4193   separate entries in the java -classpath command line option so we can
4194   build on platforms where it isn't ":".
4196 * SmokeTest.java: Expand to test more features.
4198 * java/README:
4200   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
4202   + Add note about how wrapped methods are named.
4204 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
4205   validity check.
4207 * Query.java: Comment out unused code.
4209 * Fixed memory leak in Query-from-array-of-strings constructor.
4211 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
4212   Xapian::Error subclasses can tell you their typename directly (using
4213   get_type()).
4215 PHP:
4217 * Some problems with overloaded methods in PHP have been fixed by a major
4218   overhaul of SWIG's PHP support.  So we no longer rename such methods
4219   for PHP.  This is an incompatible change, but it's easy to update your
4220   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
4222 * Previously the documentation and simpleindex.php suggested that you
4223   should call delete_CLASS().  This was incorrect and resulted in a
4224   double-free() in some cases, so we've fixed the documentation and
4225   examples and eliminated the delete_CLASS() wrappers.  This is another
4226   incompatible change, but again easy to update for.
4228 * We now support PHP5 as well as PHP4, so the configure test now looks
4229   for either and all references to "PHP4" or "php4" have been adjusted.
4231 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
4232   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
4233   warning and making the method return "Null".  This isn't ideal, but it's
4234   the best we can easily do without proper exceptions.
4236 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
4237   empty php.ini in srcdir (which we were failing to distribute anyway), use
4238   "$(PHP) -n" which tells PHP not to use any php.ini file.
4240 * Update PHP documentation to include new features.
4242 * Redo Xapian section in phpinfo() to look more like most other modules.
4244 * You can now construct a Query object from an array of strings or Query
4245   objects (or even a mixture).
4247 * PHP examples now give a more useful error message if a database can't be
4248   opened.
4250 * smoketest.php: Expanded the tests performed, including feature tests for
4251   the new Query-from-list constuctor.
4253 * simplesearch.php: Use newly wrapped Query-from-list constructor.
4255 * Use std::string::data() instead of c_str() as it may be more efficient for
4256   some STL implementations.
4258 * Enquire::get_matching_terms() now generates the PHP list directly from the
4259   TermIterator rather than constructing a temporary C++ std::list, which is
4260   faster and requires less temporary memory.
4262 Python:
4264 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
4265   once again (it has been broken since 0.9.0).  Added a regression test to
4266   help keep this working.
4268 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
4269   instead of a list).  Also the sequence can contain xapian.Query objects or
4270   strings or a mixture.  Documented these enhancements.
4272 * smoketest.py: Expanded the tests performed.
4274 * Convert C++ strings to python ones in a zero-byte clean way.
4276 * Added more error checking of the results of calls into the python
4277   interpreter.
4279 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
4280   itself is compiled with this option to avoid problems and it appears we ought
4281   to use it too to avoid the risk of hitting the same problems, although I'm
4282   not aware of anyone actually encountering such problems).
4284 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
4285   avoid creating a broken xapian.pyc is the shared library can't be loaded for
4286   some reason.
4288 * Enquire::get_matching_terms() now generates the Python list directly from the
4289   TermIterator rather than constructing a temporary C++ std::list, which is
4290   faster and requires less temporary memory.
4292 Tcl:
4294 * Terms with a leading underscore now work (thanks to changes in SWIG).
4296 * Implement custom typemaps for Tcl, so that you can now construct a Query from
4297   a list of Query objects and/or strings, and Enquire::get_matching_terms is
4298   now wrapped.
4300 * simplesearch.tcl: Use the new Query from list constructor.
4302 * simplesearch.tcl: Fix to lowercase and stem query terms.
4304 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
4306 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
4308 Xapian-bindings 0.9.2 (2005-07-15):
4310 General:
4312 * Added wrappers for new optional flags argument to QueryParser::parse_query().
4314 CSharp:
4316 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
4317   another tool with the same name.
4319 Java:
4321 * Include SmokeTest.java in the distribution so "make check" works.
4323 * Added success report for Sun java 1.4.1_01a.
4325 Python:
4327 * When converting a python list to vector<string> we know the number of elements
4328   so reserve that number in the vector.
4330 Xapian-bindings 0.9.1 (2005-06-06):
4332 General:
4334 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
4336 Tcl:
4338 * Updated documentation to include information from Michael Schlenker about how
4339   to delete a database object such that the destructor gets called.
4341 Xapian-bindings 0.9.0 (2005-05-13):
4343 General:
4345 * Updated SWIG-based bindings to latest Xapian API
4347 * Improve support for building the bindings on MS Windows:
4349   + Provide stub versions of any backend functions which are disabled in the
4350     library we're wrapping to avoid a link failure on MS Windows (where the
4351     remote backend is automatically disabled).  These stubs just throw
4352     Xapian::FeatureUnavailableError.
4354   + Add -no-undefined to *_la_LDFLAGS.
4356   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
4357     appropriate.
4359   + For python, paths for finding headers and installing libraries are now
4360     handled so they work on MS Windows; an extra static library needs to be
4361     linked in too.
4363 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
4364   for disabled backends).
4366 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
4367   being useful functionality.
4369 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
4370   introduced in future get fixed.
4372 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
4373   have.
4375 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
4376   1.3.22 for as more recent versions don't work with methods with optional
4377   arguments - the arguments become non-optional!)
4379 Guile:
4381 * configure: Disable guile by default, as it needs more work.
4383 Java:
4385 * Updated to compile against 0.9.0 API.
4387 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
4389 * Wrap optional parameters to Query(term) constructor.
4391 PHP4:
4393 * For PHP4, rename default Database constructor to Database_empty
4394   instead of suppressing the much more useful Database(const string &path)
4395   constructor.
4397 * Use a blank config file when running PHP4 tests to avoid problems
4398   when the bindings are already installed as an extension which is
4399   loaded automatically in the default config.
4401 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
4402   it probably just means it's not in PATH.  We only need it for running tests,
4403   so substitute a trivial shell script which just exits with code 77 so PHP
4404   tests are skipped (previously we substituted "missing" which caused the tests
4405   to fail).
4407 Python:
4409 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
4410   and ValueIter.
4412 * configure: If python is found, also check that Python.h exists (it may not be
4413   if the python-dev package (or similar) isn't installed).
4415 Xapian-bindings 0.8.5.1 (2005-02-23):
4417 General:
4419 * configure: Run compiler feature tests using the C++ compiler, not the C
4420   compiler.
4422 * Allow bindings version to have an extra "patchlevel", yet still match with
4423   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
4425 Java:
4427 * Added a missing .java source file and removed several unused ones.
4429 * Fixed several glitches in the java bindings automake build system.
4431 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
4432   warnings in generated code (we were carefully passing "-Wunused"
4433   which is the opposite of what is needed!)
4435 * Fixed a couple of warnings from GCJ.
4437 * Wrapped a few missing methods added since Eric created the bindings.  There
4438   are still some missing methods - there's now a (probably incomplete) list in
4439   java/README.
4441 * Added various useful bits of information to java/README.
4443 * Tweaked SimpleSearch.java to be more like the C++ version.
4445 PHP4:
4447 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
4448   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
4449   a more recent version.
4451 * configure: Check for "php" as a program name as well as "php4", and
4452   fall-back to missing so the error message from "make check" is better.
4454 Xapian-bindings 0.8.5 (2004-12-23):
4456 General:
4458 * INSTALL: Added non-generic installation instructions.
4460 Python:
4462 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
4463   the same directory as xapian.py, but Makefile.am was looking in current
4464   directory when installing it.  Additionally, VPATH builds were broken.
4465   These problems were introduced by changes in 0.8.4.
4467 Xapian-bindings 0.8.4 (2004-12-08):
4469 General:
4471 * README: Now clearly says which languages we currently support, which people
4472   are working on, etc.
4474 * Instead of requiring the user to have a really recent SWIG installed, ship
4475   the files SWIG generates.  Disable all the SWIG rules unless configure is run
4476   with --enable-maintainer-mode to make sure they aren't triggered accidentally
4477   (e.g. by make with dodgy VPATH).
4479 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
4480   needed if you just want to install the bindings).
4482 * Wrap the new Database and WritableDatabase constructors which replace
4483   Auto::open().
4485 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
4486   (for example, simpleexpand.py needs it).
4488 * In the Query constructor which takes a vector of terms, only call set_window
4489   if window is non-zero.  Otherwise things go wrong if we're passed an empty
4490   vector.
4492 * Second argument to Document::add_posting() isn't optional, but xapian.i
4493   indicated that it was.
4495 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
4496   Deriving your own weight class in the scripting language isn't currently
4497   supported.
4499 * xapian.i: %name is deprecated, so use %rename instead.  This also works
4500   around a bug in SWIG 1.3.23.
4502 * configure: Removed pointless probe for a C compiler - everything we compile
4503   is C++.
4505 * configure: Reinstated the check that the bindings version matches the version
4506   of the xapian library.  It was added in 0.8.2, but accidentally removed in
4507   0.8.3.
4509 * Use newly added option `xapian-config --swigflags` which (a) avoids always
4510   passing -I/usr/include which could cause problems if we're using a Xapian
4511   install not in /usr and there's another one in /usr and (b) avoids problems
4512   if `xapian-config --cxxflags` contains flags other than -I<something>.
4514 CSharp:
4516 * Richard Boulton has put together bindings for C#.  These build successfully
4517   with the Mono tools, but the smoketest currently fails.  Unclear if the
4518   problem is the bindings or the smoketest code.
4520 Guile:
4522 * The guile bindings now build successfully, so we've enabled the guile
4523   detection machinery in configure.  They're untested though (we don't
4524   know guile!) so success or failure reports are encouraged!
4526 PHP4:
4528 * Mention the example scripts near the start of the documentation, not right at
4529   the end.
4531 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
4532   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
4533   mention!
4535 Python:
4537 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
4538   work in Python.
4540 * Changed examples to use the newly wrapped Query from list of terms ctor.
4542 * Mention the example scripts near the start of the documentation, not right at
4543   the end.
4545 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
4546   SWIG.
4548 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
4549   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
4550   mention!
4552 * Mention simpleexpand example in documentation.
4554 * Examples now report messages for Xapian exceptions.
4556 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
4558 * Make the example MatchDecider exclude documents matching a value, rather than
4559   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
4560   don't want examples to mislead like that.
4562 * python/docs/bindings.html: Note that you can construct a query
4563   from a list of terms, even if you can't from a list of queries.
4564   Add HTML links to the examples.
4566 * simpleindex.py: Trim spaces from the start as well as from the end of each
4567   line.  Simplify the loop slightly.
4569 Tcl:
4571 * Wrap in a tcl8 namespace "Xapian".
4573 * Added a smoketest.
4575 * Translated simpleindex and simplesearch into Tcl.
4577 * Set the Tcl package version.
4579 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
4581 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
4583 * Added documentation for tcl8 bindings.
4585 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
4586   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
4587   version (was 8.0).
4589 * configure.ac: Noted that the bindings can easily be compiled for use with
4590   Tcl 8.0, in case anybody needs that for some reason.
4592 * Don't wrap the factory functions which return a quartz WritableDatabase as
4593   the destructor never gets called so changes aren't flushed and the lock file
4594   isn't removed.
4596 Xapian-bindings 0.8.3 (2004-09-20):
4598 General:
4600 * Fixed mismatching versions of libtool used to produce configure and
4601   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
4602   names.
4604 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
4605   PHP4, and Tcl bindings.
4607 Java:
4609 * Pass -classpath to javac to fix build problems.
4611 * Make sure errors subdirectory is built before we try to build the jar file.
4613 * Fixed "make install" to not give libtool error.
4615 PHP4:
4617 * Include PHP4 documentation and exmples in the tarball.
4619 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
4620   change from 0.8.2 - it turns out we only need to pass these flags if we use
4621   swig's -noruntime option (which we don't do).
4623 Python:
4625 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
4626   faster Python wrapper code.
4628 Tcl:
4630 * Don't install xapian.la.
4632 * Improved configure check for tcl.h to work with Fedora Core 2.
4634 Xapian-bindings 0.8.2 (2004-09-13):
4636 General:
4638 * Added wrappers for recently added methods: ESet::back() and
4639   Database::get_lastdocid(), and wrap the new optional third parameter
4640   to Enquire::set_sorting().
4642 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
4644 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
4646 * Wrap Quartz, InMemory, and Remote database factory functions as
4647   quartz_open(), inmemory_open(), and remote_open().
4649 * Added missing wrappers for static Stem::get_available_languages() and
4650   Stem::get_description().
4652 * Wrap renamed method Query::empty() (was Query::is_empty()).
4654 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
4655   as an alias for now).
4657 * Require autoconf 2.59 and automake 1.8.5.
4659 * configure: Added check that the bindings version matches the version of
4660   the xapian library.
4662 * configure: Check if we're using GCC and only pass GCC specific warning
4663   control options if we are.
4665 * configure: When running with GCC, also pass -Wno-uninitialized so the
4666   SWIG glue builds without warnings.
4668 * README: Updated list of languages which SWIG supports.
4670 PHP4:
4672 * Document that the 2 argument form of Xapian::Auto::open() for opening a
4673   writable database is wrapped as open_writable() (bug #32).
4675 * Include Xapian version in output from phpinfo().
4677 * Build the SWIG glue library like we build the others rather than using
4678   SWIG's -phpfull option.  This avoids problems with newer automake versions
4679   and means we can build against an uninstalled xapian library.
4681 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
4682   Fixed documentation of how Xapian::Query::OP_* are wrapped.
4684 * Use special SWIG PHP ldflags when linking the PHP glue library.
4686 * simplesearch.py now works with multi-term queries.
4688 * Added documentation on how to install the PHP4 bindings.
4690 * Added a simple testcase to at least ensure the PHP4 bindings can be
4691   initialised and some simple operations work.
4693 Python:
4695 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
4697 * Don't install _xapian.la and _xapian.a.
4699 * Byte compile xapian.py to xapian.pyc and install it.
4701 * Suppress SWIG warning about MatchDecider::operator() director discarding
4702   const.
4704 * "make clean" no longer leaves "xapian_wrap.h" behind.
4706 * Added a simple testcase to at least ensure the python bindings can be
4707   initialised and some simple operations work.
4709 Tcl8:
4711 * configure: Disable building tcl8 bindings if the headers are missing
4712   (probably because the tcl8.X-dev package isn't installed).
4714 Xapian-bindings 0.8.1 (2004-06-30):
4716 General:
4718 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
4720 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
4721   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
4722   doesn't emit -I/usr/include in this situation (because it causes problems
4723   with some GCC versions).
4725 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
4726   not just a subset.
4728 Java:
4730 * Removed wrappers for unused error classes which have been pruned from C++.
4732 * Make finalize() methods of Database and WritableDatabase public so they can
4733   be called from by the user.
4735 * Document Document.add_term_nopos() as deprecated.
4737 PHP4:
4739 * Make sure that PHP bindings build a module which exports get_module() so PHP
4740   is able to load it.
4742 * Configure now checks that phpize can actually be run, rather than just that
4743   it's executable (test -x isn't portable anyhow).
4745 * Added basic documentation and examples to PHP4 bindings.
4747 * Rename overloaded methods and constructors.
4749 * Add simple access to the prefixes map in QueryParser.
4751 * Correct simpleindex ports to never generate empty termnames.
4753 Python:
4755 * configure: Use $PYTHON instead of python when running python to determine
4756   library and include paths and version number.
4758 * Actually ship python examples and documentation.
4760 Xapian-bindings 0.8.0 (2004-04-20):
4762 * README: Started collecting information on supporting Xapian from even
4763   more languages.
4765 * Added configure tests to enable bindings only where the necessary tools
4766   are installed and have a supported version.  ./configure --without-LANGUAGE
4767   allows particular languages to be forcibly disabled.
4769 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
4771 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
4773 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
4774   have been well tested, but integration with the xapian-bindings configure
4775   system hasn't been tested at all - please alert us to any problems.
4777 * Xapian can now be used from TCL.
4779 * Python: MSet now provides a Python iterator.
4781 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
4783 * Python: enable directors for MatchDecider, to allow subclassing in Python.
4785 * Python: Added basic documentation, and some examples.