Update for 1.4.20
[xapian.git] / xapian-bindings / NEWS
blob33ec1be0ea0bba733db7ec6f9e6ada48059cf3b6
1 Xapian-bindings 1.4.20 (2022-07-04):
3 General:
5 * Enable -fvisibility-inlines-hidden option if the compiler supports it.
7 PHP7:
9 * Add missing reference tracking. XapianEnquire now keeps a reference to the
10   current XapianSorter object (if any).  XapianQueryParser now keeps a
11   reference to any set XapianFieldProcessor objects.  Test coverage for keeping
12   references to set functor objects is now more comprehensive.
14 * smoketest.php: Remove bogus extra null parameters.  PHP ignores these extra
15   parameters, but it's more helpful to be testing valid usage.
17 Python3:
19 * The configure probes for Python3 no longer use the deprecated distutils and
20   imp modules (both of which are slated for removal in Python 3.12).  We now
21   use sysconfig to get the directory to install the xapian module to, which may
22   result in it being installed in a different place (it should still work, but
23   if you're packaging the bindings you may need to update the list of files to
24   include in the package).
26 Xapian-bindings 1.4.19 (2021-12-31):
28 Documentation:
30 * configure: Add missing AC_ARG_VAR for all programs so that they are
31   documented in --help output, and so that autoconf knows they are "precious"
32   and preserves them if configure is rerun even when they're specified via an
33   environment variable.
35 General:
37 * Replace uses of obsolete autoconf macros, fixing warnings if configure is
38   regenerated with a recent release of autoconf.
40 Perl:
42 * Add missing wrappers for some QueryParser FLAG_* constants.
44 * Fix incorrect formatting in the processed POD documentation due to missing
45   escaping of `>` in code snippets.
47 PHP:
49 * Make configure PHP5 version check more robust.  Previously it would have
50   incorrectly accepted any (future) PHP version >= 10.0.0.
52 PHP7:
54 * configure: We now reject PHP8 since it isn't currently supported
55   by a released version of SWIG.  SWIG 4.1.0 will supports PHP8.
57 * configure: Check for php-config7.4 as well as earlier 7.x versions
58   and php-config.
60 Python3:
62 * Fix deprecation warnings with Python >= 3.9.
64 * Remove more files/dirs on "make clean".  Reported by Gaurav Arora.
66 Ruby:
68 * Fix build with Ruby 3.0 and clang. Reported by Eduard Panov on macos, where
69   clang is the default compiler.
71 * Improve markup in Ruby bindings docs.
73 Xapian-bindings 1.4.18 (2021-01-14):
75 Portability:
77 * Support macOS 11.0 - AC_CANONICAL_HOST identifies this as darwin20, which
78   wasn't caught by our glob pattern.  Patch from FX Coudert in
79   https://github.com/xapian/xapian/pull/319
81 CSharp:
83 * Wrap const std::string* parameters to accept a string or null in C#.  See #204.
85 Java:
87 * Wrap const std::string* parameters to accept a String or null in Java.
89 Perl:
91 * Fix minor documentation typo.
93 Xapian-bindings 1.4.17 (2020-08-21):
95 * No user-visible change except for bumping the version to indicate
96   compatibility with Xapian-core 1.4.17.
98 Xapian-bindings 1.4.16 (2020-06-08):
100 General:
102 * Remove code to support SVN snapshots since we stopped using SVN more than 5
103   years ago.
105 * Ignore overloads for logical ops, *, /.  These were already ignored for
106   several languages, and aren't actually usefully wrapped for any of the other
107   languages.
109 CSharp:
111 * Work around mono terminfo parsing bug in more cases.  With this, "make",
112   "make check", "make install" and "make uninstall" all work on Ubuntu 18.10.
113   Patch from Dipanshu Garg, fixes https://github.com/xapian/xapian/pull/287 and
114   #801.
116 Lua:
118 * Allow passing a Lua function as a MatchSpy.  This was supposed to be
119   supported already, but the typemaps weren't set up.
121 * On platforms where sizeof(long) is 4, SWIG was wrapping Xapian::BAD_VALUENO
122   as a negative constant in Lua, which was then rejected by a check which
123   disallows passing negative values for unsigned C++ types.  We now direct SWIG
124   to handle Xapian::valueno as double (which is what numbers in Lua usually
125   actually are) which gives us an unsigned constant, and also eliminates the
126   negative value check.
128 * Correct documentation - get_description() is wrapped as tostring() in Lua,
129   not str() as we previously claimed.
131 * Add test coverage for passing Lua function for a Stopper.
133 Perl:
135 * Resolve the remaining issues and remove the "experimental" marker:
137   + Add search_xapian_compat() function which sets up aliases in the
138     Search::Xapian namespace to aid writing code which uses either
139     Search::Xapian or this module.
141   + Allow passing Perl sub for simpler Xapian functor classes.  This fills in a
142     missing feature compared to Search::Xapian.  See #523.
144   + Remove useless PerlStopper class which was an incomplete copy of the
145     apparently non-functional Search::Xapian::PerlStopper.  We now support
146     passing a Perl sub for a Stopper object.
148   + Adjust some method names to match Search::Xapian.  Iterators now support
149     inc() (and dec() where the C++ class supports operator--) like
150     Search::Xapian, rather than increment() and prev().  Reported by Eric Wong
151     in #523.
153   + Drop undocumented and unexpected extra equals() method.
155   + Provide compatibility with ENQ_ASCENDING, etc constants.  SWIG wraps these
156     as $Xapian::Enquire::ASCENDING, which better matches the C++ API, but
157     Search::Xapian wraps this as Search::Xapian::ENQ_ASCENDING, etc so provide
158     those too for compatibility.  Reported by Eric Wong in #523.
160   + Drop stringification and int conversion overloads.  These seem more
161     confusing than helpful, and overloading stringification works badly
162     with SWIG-generated bindings.
164   + Document remaining known differences from Search::Xapian.
166 * Update recently tested versions in README.
168 * Improve documentation.
170 * Fix t/02pod.t to look for files in right directory.
172 Ruby:
174 * Don't print iterator sizes to stdout.  This was some debugging accidentally
175   left in as part of a change in 1.4.12.  Patch from Dan Callaghan.
177 Xapian-bindings 1.4.15 (2020-02-24):
179 Perl:
181 * Improve comment about App::Prove.
183 Ruby:
185 * Support Ruby 2.7.
187 Xapian-bindings 1.4.14 (2019-11-23):
189 Python:
191 * Remove broken replicationtest.py.  It's never worked reliably, and because
192   of that was disabled shortly after being added over a decade ago.
193   Unsurprisingly it's bit-rotted at least a bit since.  Nobody seems interested
194   in fixing it, so it's time to just get rid of it.  Closes #320.
196 Python3:
198 * Remove broken replicationtest.py.  It's never worked reliably, and because
199   of that was disabled shortly after being added over a decade ago.
200   Unsurprisingly it's bit-rotted at least a bit since.  Nobody seems interested
201   in fixing it, so it's time to just get rid of it.  Closes #320.
203 Xapian-bindings 1.4.13 (2019-10-14):
205 General:
207 * Omit SWIG exception handling for destructors.  Since C++11, destructors can't
208   throw by default and we don't override that default, so there's no point
209   adding exception handling code for them.
211 * Ensure doccomments.i is distributed.  If you unpacked a distribution tarball,
212   configured it and then ran "make dist" python/doccomments.i and
213   python3/doccomments.i would be missing unless you configured the tree with
214   --enable-maintainer-mode.
216 PHP:
218 * Check for php-config5.6 and php-config5.5 in configure as these versioned
219   names are used in some packages (such as those from the ondrej/php PPA).
221 PHP7:
223 * Work around build failure on Illuminos.  Fixes
224   https://trac.xapian.org/ticket/793, reported by Amitai Schleier.
226 Ruby:
228 * smoketest.rb: Use #push not #append on Array to restore compatibility with
229   Ruby < 2.5 (broken by changes in 1.4.12).
231 * Expand tabs in Ruby code since using spaces for indentation seems to be
232   preferred Ruby style.
234 * Remove trailing `;` from Ruby code.
236 Xapian-bindings 1.4.12 (2019-07-23):
238 Documentation:
240 * Update bindings HACKING document.  Reported as out of date by Niwesh Gupta.
242 CSharp:
244 * Work around mono terminfo parsing bug - older cli-sn fails with e.g.
245   TERM=xterm-256color due to: https://github.com/mono/mono/issues/6752
246   Encountered on Kubuntu 18.10 and debugged by Tejasvi Tomar.  Seems to be
247   fixed in the mono version in Debian buster.
249 Perl:
251 * Suppress warnings from older Perl headers due to use of constructs which look
252   like C++11 user-defined literals.  They're fixed in newer versions so they're
253   just noise in our build.  We were working around these in the CI build, so
254   drop that workaround as we want to make the build warning-clean for users
255   too.  Reported by daniel93 on #xapian.
257 Python3:
259 * Fix build for changes in Sphinx 2.0 (which drops support for sphinx.main()).
260   Fixes #778, reported by karolyi.  Also reported by Gaurav Arora.
262 * We now throw UnicodeEncodeError for bad Unicode string input.  Previously
263   cases such as a lone surrogate would be handled by quietly skipping the bad
264   codepoints when converting to UTF-8 to pass to Xapian.
266 * We no longer use the deprecated old-style Py_UNICODE API, which currently
267   gives deprecation warnings and is slated to be removed in Python 4.0.
269 Ruby:
271 * Add support for block iteration.  All the iterator methods in the Ruby API
272   now accept an optional block.  If no block is given an array is returned so
273   existing code will still work.  Partly based on a patch in
274   https://github.com/xapian/xapian/pull/232 from Cong Ding.
276 * Add missing wrappers for all the C++ methods returning iterators which
277   weren't wrapped for Ruby.  Fixes #777, reported by do.
279 * Suppress warnings from Ruby 2.3 headers due to use of register and
280   constructs which look like C++11 user-defined literals.  They're fixed in
281   newer versions so they're just noise in our build.  We were working around
282   these in the CI build, so drop that workaround as we want to make the build
283   warning-clean for users too.  Reported by daniel93 on #xapian.
285 * smoketest.rb: Don't leave temporary databases behind in /tmp.
287 Xapian-bindings 1.4.11 (2019-03-02):
289 CSharp:
291 * Make MatchAll and MatchNothing readonly.
293 Java:
295 * Simplify load-time setup of Query.OP_OR, etc which are provided for
296   compatibility with the original hand-written JNI bindings.
298 PHP:
300 * We now load the module for "make check" using -d extension=xapian which
301   avoids needing to turn off safe_mode and turn on enable_dl, and matches how
302   the module is usually loaded in production use.
304 PHP7:
306 * Fix access to already released memory during PHP module shutdown, which often
307   didn't cause visible problems, but could result in segmentation faults, bus
308   errors, etc.
310 * Fix generated code to compile when using a ZTS-enabled build of PHP.
312 * We now load the module for "make check" using -d extension=xapian which
313   avoids needing to turn off safe_mode and turn on enable_dl, and matches how
314   the module is usually loaded in production use.
316 Xapian-bindings 1.4.10 (2019-02-12):
318 Documentation:
320 * Use https for URLs where supported.
322 General:
324 * Wrap new DatabaseClosedError and DatabaseNotFoundError exceptions.
325   See #772 and #773.  Patches from Vaibhav Kansagara.
327 * Update expected query descriptions in tests for the xapian-core
328   change to produce flatter Query trees.
330 * Workaround Perl 5.28 -i quirk when postprocessing SWIG-generated code.
331   The commands in question are only run when maintainer-mode is enabled.
333 CSharp:
335 * C++ constant Xapian::BAD_VALUENO is now wrapped without using a getter.
336   This shouldn't affect existing user code.
338 Java:
340 * C++ constant Xapian::BAD_VALUENO is now wrapped as Java constant
341   Xapian.BAD_VALUENO.  The previous Java wrapping as function
342   Xapian.getBAD_VALUENO() is still supported for compatibility with
343   existing code.
345 * Remove redundant std::string initialisation.
347 Lua:
349 * C++ constant Xapian::BAD_VALUENO is now wrapped as a constant rather than
350   an immutable attribute.  This shouldn't affect existing user code.
352 Perl:
354 * C++ constant Xapian::BAD_VALUENO is now wrapped as Perl constant
355   Xapian::BAD_VALUENO.  The previous Perl wrapping as variable
356   $Xapian::BAD_VALUENO is still supported for compatibility with existing
357   code.
359 * Note in the POD documentation that the Error base classes which are abstract
360   in C++ don't have a new method in Perl.
362 PHP:
364 * C++ constant Xapian::BAD_VALUENO is now wrapped as PHP constant
365   Xapian::BAD_VALUENO.  The previous PHP wrapping as function
366   Xapian::BAD_VALUENO_get() is still supported for compatibility with existing
367   code.
369 * Remove code to work around a SWIG bug which was fixed in 2006.
371 PHP7:
373 * C++ constant Xapian::BAD_VALUENO is now wrapped as PHP constant
374   Xapian::BAD_VALUENO.  The previous PHP wrapping as function
375   Xapian::BAD_VALUENO_get() is still supported for compatibility with existing
376   code.
378 * configure: Check for php-config7.3 and php-config7.2 as well as
379   php-config7.1, php-config7.0 and php-config.
381 * Correct references to PHP5 in PHP7 script comments.
383 * Remove some C code which is no longer needed with PHP7.
385 Ruby:
387 * C++ constant Xapian::BAD_VALUENO is now wrapped as Ruby constant
388   Xapian::BAD_VALUENO.  The previous Ruby wrapping as function
389   Xapian::BAD_VALUENO() is still supported for compatibility with existing
390   code.
392 * We now recommend using String#encode instead of the Iconv class, since the
393   latter is no longer included with Ruby.
395 Tcl:
397 * C++ constant Xapian::BAD_VALUENO is now wrapped as a constant rather than
398   variable which can't be written to.  This shouldn't affect existing user
399   code.
401 Xapian-bindings 1.4.9 (2018-11-02):
403 PHP7:
405 * Fix to build with upcoming PHP 7.3 release, which changes array_init()
406   to not return a value instead of always returning the constant SUCCESS.
407   We were checking this return value but no longer do.
409 Xapian-bindings 1.4.8 (2018-10-25):
411 Perl:
413 * Wrap new STEM_SOME_FULL_POS constant.
415 * Add STEM_ALL_Z to qpstem export tag and POD docs.
417 * Fix Perl bindings documentation typos.
419 Python:
421 * Fix RST formatting warning during build.
423 Python3:
425 * Fix RST formatting warning during build.
427 Xapian-bindings 1.4.7 (2018-07-19):
429 Ruby:
431 * Fix -Wconversion-null warnings with newer GCC.
433 Xapian-bindings 1.4.6 (2018-07-02):
435 Documentation:
437 * Stop using "probabilistic" to mean "weighted" - we've supported other
438   families of weighting schemes since 1.3.2.
440 Packaging:
442 * Use https for tarball URLs in .spec files.  This provides protection against
443   MITM attacks on people building packages using these spec files, and is also
444   slightly more efficient as the http: URLs redirect to the https: versions
445   anyway.
447 CSharp:
449 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
450   with older SWIG, but it does with current versions, and using it means that
451   we skip any return value translation logic when an exception has been thrown.
453 Java:
455 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
456   with older SWIG, but it does with current versions, and using it means that
457   we skip any return value translation logic when an exception has been thrown.
459 * Fix leaks in binary std::string typemaps.  These are used for document values
460   and serialised data.
462 * Improve VPATH build.  Previously we looked for class files and java sources
463   in srcdir first, then in builddir.  That's backwards from how autotools
464   VPATH builds search for targets and prerequisites so reverse this order to
465   make handling of Java files more consistent.
467 Perl:
469 * Invoke prove via the App::Prove module.  This avoids potentially using
470   prove from a different Perl installation to perl (previously the user
471   needed to manually specify the corresponding PROVE= if they specify PERL= to
472   configure).  In particular this is useful on macOS when using Perl from
473   homebrew.
475 * Improve Perl Enquire::set_docid_order documentation by syncing improvements
476   from the C++ API docs.
478 Python:
480 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
481   James Aylett.
483 * Suppress clang -Wdeprecated-register warnings about uses register in C code
484   in Python.h.  We can't do anything about these other than suppress them.
486 Python3:
488 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
489   James Aylett.
491 * Suppress clang -Wdeprecated-register warnings about uses register in C code
492   in Python.h.  We can't do anything about these other than suppress them
493   (and they appear to have been removed in Python 3.4 and later).
495 * Remove unused MSet::__cmp__ extend method.  This was used in Python 2, but
496   Python 3 does things differently.  There doesn't seem a good reason to
497   provide comparison operations for MSet objects, and we don't for other
498   classes, so let's just drop this feature - it seems nobody has noticed it has
499   gone.
501 * Simplify generated wrapper post-processing.
503 Xapian-bindings 1.4.5 (2017-10-16):
505 Documentation:
507 * HACKING: Add details of Debian PHP7 packages to install for development.
509 General:
511 * Use a pattern match to ignore methods meant for internal use only rather
512   than having to list them all - they're consistently named to end with an
513   underscore.
515 * Stop using deprecated Xapian::percent typedef in bindings-specific code.
516   Deprecation warnings are suppressed when building the bindings (because the
517   bindings usually still need to wrap deprecated C++ features) so this probably
518   has no user-visible consequences.
520 Java:
522 * Fix JNI code to be compatible with Java 6 and earlier, where the final
523   parameter of SetByteArrayRegion() was not const.  This also seems to affect
524   GCJ (though GCJ was removed in GCC 7).  The incompatibility was introduced in
525   1.4.4.
527 Lua:
529 * Support subclassing of RangeProcessor in Lua.
531 Perl:
533 * Add CLONE_SKIP to RangeProcessor and subclases to avoid double deletion
534   if the Perl threads module is in use.
536 * Keep references for set RangeProcessor objects, like how we do for
537   ValueRangeProcessor and various other functor objects.
539 * Use RangeProcessor instead of ValueRangeProcessor in perl examples, as
540   ValueRangeProcessor is now deprecated.
542 PHP:
544 * Keep references for set RangeProcessor objects, like how we do for
545   ValueRangeProcessor and various other functor objects.
547 * Add type hints to QueryParser::add_rangeprocessor().
549 PHP7:
551 * Keep references for set RangeProcessor objects, like how we do for
552   ValueRangeProcessor and various other functor objects.
554 * Add type hints to QueryParser::add_rangeprocessor().
556 * Fix PHP7 "make check" to use right path separator.  It was using the PHP5
557   one, which in general is going to be the same but we won't have probed for
558   that unless we're also building the PHP5 bindings, which means "make check"
559   failed for PHP7 unless you also had the PHP5 bindings enabled.
561 Python3:
563 * Fix "make check" under Python 3.2, which was broken in 1.4.4 because Python
564   3.2 doesn't support the u'foo' syntax.
566 * Copy over Python2 check which aims to catch any internal functions, methods,
567   constants, etc which have accidentally been wrapped.
569 Ruby:
571 * Fix dependency generation for Ruby SWIG command (only relevant at all if
572   you configure with --enable-maintainer-mode).
574 Xapian-bindings 1.4.4 (2017-04-19):
576 General:
578 * Update tests for xapian-core changes to avoid unnecessary "0 *" in query
579   descriptions in certain cases.
581 Packaging:
583 * Ship java.i in tarball.
585 Java:
587 * Handle object serialisations and document values as Java byte[].  These will
588   usually contain binary data, so Java String doesn't work well and byte[] is a
589   much better fit.
591 * Correct various errors in java examples and documentation on how to run them.
593 * Fix java examples not to abuse doc values as fields - use the document data
594   instead.
596 * "make clean" now removes additional class files.
598 PHP7:
600 * Update version of SWIG required to >= 3.0.12 so that the code generated
601   for PHP7 no longer results in a segmentation fault on module unload with
602   PHP 7.1.  Fixes #748, reported by Victor Sakovich.
604 Python:
606 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
607   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
608   https://bugs.debian.org/849722
610 * Fix configure --with-python to fail if sphinx isn't found.  Patch from
611   Patricio Paez.  Fixes #749.
613 Python3:
615 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
616   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
617   https://bugs.debian.org/849722
619 Xapian-bindings 1.4.3 (2017-01-25):
621 Python:
623 * Remove compatibility code for Python < 2.5 - 1.4.x requires Python >= 2.6.
625 * Avoid unnecessary pointer indirection in XapianSWIG_anystring() helper
626   function, which should be a little more efficient and makes the Python 2
627   code more closely match the Python 3 code.
629 Ruby:
631 * "make clean" should only remove docs/xapian.rb if configure option
632   --enable-documentation was used to enable all rules to rebuild documentation.
633   Reported by Samuel Williams on xapian-discuss.
635 * Fix make rule for running rdoc for the cases where srcdir != builddir.
637 * Use 'test a = b' rather than 'test a == b' - the former is portable, the
638   latter a bashism.  In many cases the autotools will set SHELL = /bin/bash in
639   the makefiles, but if it doesn't and /bin/sh isn't bash, then this will
640   cause "make install" and "make uninstall" to fail for the Ruby bindings.
642 Xapian-bindings 1.4.2 (2016-12-26):
644 General:
646 * configure: Fail with clear error with xapian-core < 1.4.0.
648 * Work around OS X "System Integrity Protection".  We can't address the problem
649   of being unable to run tests against an uninstalled tree when the interpreter
650   is in a system directory (you have to "make install" in xapian-core for that
651   case), but we can at least make this work for interpreters which aren't in
652   system directories.
654 Java:
656 * Disable parallel make for java subdirectory as it causes random build
657   failures.  Reported by Lucas Nussbaum in https://bugs.debian.org/848733
659 * Disable automatic use of -Xcheck:jni for now as it seems to report false
660   positives with OpenJDK 8 and 9.
662 PHP:
664 * Generates smaller PHP wrappers by only emitting each unique arginfo
665   combination once (~6% saving in stripped extension module size for
666   PHP7 on x86_64 Linux).
668 * Fix to work again with a version of PHP5 built with ZTS enabled (which is the
669   default on Microsoft Windows).
671 * Add support for PHP7.
673 * Drop workaround for PHP4 from test code.
675 Python:
677 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
678   from a command line Python code snippet.  Reported by Alex Dunn in
679   https://github.com/xapian/xapian/pull/126 and solved with help from James
680   Aylett.
682 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
683   need to keep such a reference (as we already do for ValueRangeProcessor and
684   several other classes).
686 Python3:
688 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
689   from a command line Python code snippet.  Reported by Alex Dunn in
690   https://github.com/xapian/xapian/pull/126 and solved with help from James
691   Aylett.
693 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
694   need to keep such a reference (as we already do for ValueRangeProcessor and
695   several other classes).
697 Ruby:
699 * Use more conventional Ruby variable names in the examples (Ruby convention
700   uses underscores not camelcase) and fix comma/space transposition in a couple
701   of places.
703 Xapian-bindings 1.4.1 (2016-10-21):
705 Documentation:
707 * Fix --disable-documentation - in maintainer-mode, we still tried to make
708   docs/index.html for most of the bindings, which failed because the rule to do
709   so was disabled.
711 General:
713 * Update for additions to C++ API.
715 * When a backend is disabled in the xapian-core we're building against, we
716   have a stub version of any factory functions so the bindings still have
717   something to wrap.  Update these for 1.4:
718   + Disable stub for InMemory::open() when
719     XAPIAN_BINDINGS_SKIP_DEPRECATED_DB_FACTORIES is defined (Perl, Python3).
720   + Add new optional flags parameter to both overloaded forms of
721     Remote::open_writable().
723 Portability:
725 * Drop compiler options that are no longer useful:
726   + -fshow-column is the default in all GCC versions we now support
727     (checked as GCC 4.6).
728   + -Wno-long-long is no longer necessary now that we require C++11 where
729     "long long" is a standard type.
731 Java:
733 * Use a cleaner technique to insert the Java code to load JNI library into the
734   generated wrapper - we now use "%pragma(java) jniclasscode" instead of using
735   Perl to post-process the generated wrapper.  Suggested by James Aylett.
737 * Run Java tests with -Xcheck:jni if supported, which should help catch any
738   any bugs in the JNI code.
740 * Fix configure to find jni_md.h under Cygwin.  There doesn't seem to be an way
741   to automatically determine the machine-dependent JNI include path, so add
742   another case to use "win32" on Cygwin.  Reported by John Bankert on
743   xapian-discuss.
745 * Add more special cases to find jni_md.h on Cygwin, OS X, *BSD, AIX.
746   There doesn't seem to be an explicit list of these directories anywhere, but
747   grepping the OpenJDK 8 source code finds additional values "darwin" and
748   "aix", *BSD seems to use "bsd", and Cygwin uses "win32" (reported by John
749   Bankert on xapian-discuss).
751 * Generate xapian.jar rather than xapian_jni.jar - the fact that JNI is
752   involved is really just an implementation detail.
754 * SmokeTest.java: Add simple test of subclassing FieldProcessor.
756 Perl:
758 * Merge Perl POD doc improvements from Search::Xapian.  The most notable
759   improvement is a number of methods previously lacking docs now have them.
761 * Fix typo in POD docs for Perl bindings ("outputing" -> "outputting").
762   Reported by knowledgejunkie in #730.
764 Python:
766 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
768 * Fix Python2 bindings to work out of the box.  SWIG changed the code it
769   generates for importing the compiled module in a recent version, and
770   the newer code no longer works with the wrapper renamed to
771   xapian/__init__.py.  There's currently no way to configure SWIG to produce
772   what we need so for now we run a "fixup" script over the generated wrapper
773   which replaces the complex import code with a single statement which does
774   what we want.  It also strips out various unneeded code, mostly to do with
775   handling Python 3.x (which we don't need since we have an entirely
776   separate set of bindings for that).  Reported by James Aylett in #731.
777   The way we were importing the bindings to generate the .pyc and .pyo
778   files was masking this problem, so rework that as suggested by James.
780 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
781   parallel builds (make -j) may attempt to schedule the sphinx doc build before
782   the relevant wrapper has been compiled and moved into position.  This won't
783   result in a build failure, but will silently omit API docs that sphinx
784   would otherwise include.  Patch from James Aylett.
786 * doxy2swig: Specify encoding when reading doxygen's XML output so UTF-8 in
787   doxygen comments is handled.  Patch from Vivek Pal.
789 * Specify Python2 wrapper encoding is UTF-8.  This is needed when we pick up
790   doxygen comments from the C++ API which contain UTF-8.  For Python3, the
791   default source encoding is UTF-8, so we don't need the equivalent change
792   there.
794 Python3:
796 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
798 * Fix Python3 bindings to work out of the box.  SWIG changed the code it
799   generates for importing the compiled module in a recent version, and
800   the newer code no longer works with the wrapper renamed to
801   xapian/__init__.py.  There's currently no way to configure SWIG to produce
802   what we need so for now we run a "fixup" script over the generated wrapper
803   which replaces the complex import code with a single statement which does
804   what we want.  It also strips out various unneeded code, mostly to do with
805   handling Python 2.x (which we don't need since we have an entirely
806   separate set of bindings for that).  Reported by James Aylett in #731.
807   The way we were importing the bindings to generate the .pyc and .pyo
808   files was masking this problem, so rework that as suggested by James.
810 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
811   parallel builds (make -j) may attempt to schedule the sphinx doc build before
812   the relevant wrapper has been compiled and moved into position.  This won't
813   result in a build failure, but will silently omit API docs that sphinx
814   would otherwise include.  Patch from James Aylett.
816 * Fix memory leak converting string from Python to C++.
817   XapianSWIG_anystring_as_ptr() was failing to flag the returned value as
818   allocated, so it wasn't being deleted.  Reported by Sean Robinson in #729.
820 Xapian-bindings 1.4.0 (2016-06-24):
822 Documentation:
824 * Mark SWIG-generated Java and Perl bindings as "experimental" until we've
825   had a chance to sort out any remaining changes we want to make.
827 Xapian-bindings 1.3.7 (2016-06-01):
829 Documentation:
831 * Remove long out-dated reference to tinderbox.
833 General:
835 * Use SWIG 3.0.9 to generate the bindings.  There's nothing very important to
836   us in the changes since the git snapshot we were using - mostly this means
837   we're using a released version, which seems preferable.
839 Tcl:
841 * Fix segfault in tcl bindings "make check".  The location of tclConfig.sh
842   wasn't being found, so libtclstub wasn't being linked to, which is required
843   with Tcl >= 8.6.
845 Xapian-bindings 1.3.6 (2016-05-09):
847 General:
849 * Update for changes to the C++ API.
851 * Use WritableDatabase::commit() instead of flush() in testcases, as the
852   latter is now formally deprecated.
854 Java:
856 * Fix syntax error in SmokeTest.java, introduced by the DB_BACKEND_INMEMORY
857   change.  Noted on #xapian-discuss by Aakash Muttineni.
859 * Update Java TODO list.
861 * SmokeTest.java: Port over version checks from SmokeTest.cs.
863 * Update list of recently tested JDK versions.
865 Lua:
867 * Note Lua bindings work with Lua 5.3.
869 Perl:
871 * Explicitly specify POD docs encoding as utf8.  Fixes warning in generated
872   HTML docs.
874 * Convert POD to HTML when building from a source tarball - the conversion
875   code comes as standard with Perl.  In 1.3.5 we were failing to ship the HTML
876   output, as reported by Anthony Basile.
878 * For extra robustness, convert POD to HTML using the bundled Pod::Html module
879   from the Perl interpreter found by configure, rather than assuming pod2html
880   is on PATH, and the right one (this matters more now that it's not just
881   people building from git who build these docs).
883 * Improve Perl bindings POD documentation.
885 * Remove workaround for Perl macro vs C++11 header.  SWIG 3.0.6 and later adds
886   a different workaround to the generated C++ wrapper file, and we require SWIG
887   3.0.8 for a Python fix, so we no longer need our workaround.
889 Python:
891 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
892   system, so I'm guessing this is now required due to a change in the code SWIG
893   generates.
895 Python3:
897 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
898   system, so I'm guessing this is now required due to a change in the code SWIG
899   generates.
901 * Fix install location for python3 docs.  They were being install to the same
902   path as the python docs - now the path includes "python3" instead of
903   "python".
905 Ruby:
907 * Increase minimum Ruby version to 2.1, as older versions are no longer
908   supported by the Ruby developers.
910 Xapian-bindings 1.3.5 (2016-04-01):
912 This release includes all changes from 1.2.23 which are relevant.
914 Documentation:
916 * Fix to install docs when not in maintainer-mode.
918 * Note open_stub() is deprecated (most of the bindings already noted this, but
919   now ruby and tcl do too).
921 General:
923 * Update for changes to the C++ API.
925 * PostingSource is now fully wrapped for the bindings.  Fixes #499, reported by
926   Joost Cassee.
928 * Ship swig-depcomp and doxy2swig scripts in the source tarball.
930 * Add installcheck-local make targets for most languages - these run the
931   testsuites using the installed bindings.
933 CSharp:
935 * configure: Stop checking for obsolete mono compiler names - gmcs, smcs and
936   dmcs were all deprecated in Mono 2.11.
938 * configure: Strip out handling of DotGNU - it's been inactive for years, and
939   was officially "decommissioned" in December 2012.
941 * README: Update list of mono versions recently tested with.
943 Lua:
945 * smoketest.lua: Fix to work with newer lua - coercing a number to a string
946   now appends ".0" for whole numbers.
948 Perl:
950 * Run pod2html with explicit --podpath=. - recent versions of pod2html seem to
951   need this to correctly handle references to other Xapian classes.  Reported
952   on #xapian-discuss by HowManny and abhishek_rand0wn.
954 Python:
956 * Run sphinx at build time.  It's an extra tool for people building from source
957   to have to install, but its output is rather large (this change reduces our
958   tar.xz size by ~20%), and its output includes a source-less minified copy of
959   jquery.
961 Python3:
963 * Run sphinx at build time.  It's an extra tool for people building from source
964   to have to install, but its output is rather large (this change reduces our
965   tar.xz size by ~20%), and its output includes a source-less minified copy of
966   jquery.
968 * Fix handling of integer values larger than a C int by bootstraping with a
969   newer version of SWIG.  Fixes #703, reported by Barry Warsaw.
971 * Remove xapian.inmemory_open() - we've deprecated the corresponding C++
972   function, and the Python3 bindings haven't yet had a stable release.
974 Ruby:
976 * Run rdoc at build time - it is included as part of the Ruby core
977   distribution, so we can assume it is available if ruby is, and avoid shipping
978   its rather large generated output in our source tarball.
980 Xapian-bindings 1.3.4 (2016-01-01):
982 This release includes all changes from 1.2.22 which are relevant.
984 General:
986 * Wrap new and changed features in C++ API.
988 * PostingSource set_maxweight() is now accessible to the bindings.  Fixes #498,
989   reported by Richard Boulton.
991 * configure script now defaults to looking for xapian-config-1.3.  This is now
992   automatically done for development series (odd middle component of the
993   version number), but not for stable series (even middle component).  Fixes
994   #695, reported by Jorge C. Leitão
996 PHP:
998 * Make PHP 5.5 the minimum officially supported version, as 5.4 has now reached
999   EOL.
1001 * In the examples, when iterating an MSet with foreach, don't throw the docid
1002   away as $dummy, put it in $docid and use it - the code looks cleaner, and
1003   this avoids an extra call to C++ to get the docid on each iteration.
1005 Python:
1007 * Drop support for Python 2.5.
1009 Python3:
1011 * Document installation of Python 3 bindings.  Fixes #694, reported by Jorge C.
1012   Leitão.
1014 * Fix testsuite for changes in Python 3.5.  Fixes #690, patch from UsusDei.
1016 * Handle renaming of .pyo to .opt-1.pyc files due to PEP-0488.  Fixes #689,
1017   patch from UsusDei.
1019 * Fix Python 3 version check to accept 3.10.
1021 Xapian-bindings 1.3.3 (2015-06-01):
1023 This release includes all changes from 1.2.20-1.2.21 which are relevant.
1025 Documentation:
1027 * INSTALL: IRIX is past EOL so drop information about IRIX make.
1029 General:
1031 * Add DB_RETRY_LOCK as a constant to wrap.
1033 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
1035 * Fix "make install" from a git tree configured with --disable-documentation.
1036   (Fixes #658, reported by Germán M. Bravo)
1038 * Fix "make install" when building from git with --disable-documentation.
1040 * Fix to handle a VPATH build from a tarball when the generated docs will be in
1041   $(srcdir).
1043 * Update testcases for lazy wildcard expansion change in xapian-core.
1045 * Update for addition of XAPIAN_NOEXCEPT.
1047 * Don't wrap internal methods of Xapian::Weight.
1049 Portability:
1051 * Require a compiler with good C++11 support, like xapian-core now does.
1053 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
1054   doxygen.
1056 * configure: Update check for -fvisibility to match xapian-core's.
1058 CSharp:
1060 * Fix configure test for whether $CLI can run CSharp programs - previously it
1061   would always fail, which would mean that the CSharp tests wouldn't be run on
1062   platforms where CSharp programs can't be run directly.
1064 Java:
1066 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
1068 Lua:
1070 * The Lua bindings are no longer considered to be "experimental" (in reality
1071   they haven't been for some time).
1073 Perl:
1075 * Add a "LICENSE" section to the main POD.
1077 * Add 'use strict' to all testcases, and add missing instances of 'my' that
1078   this change uncovered.
1080 * Wrap new WILDCARD_LIMIT_* constants as constants.
1082 Python:
1084 * Don't release the GIL when constructing a Query object from a sequence of
1085   Query objects and/or strings.
1087 * python/smoketest.py: Add new testcase to catch any internal functions,
1088   methods, constants, etc which have accidentally been wrapped.
1090 Python3:
1092 * The Python3 bindings are no longer considered to be "experimental".
1094 * Don't release the GIL when constructing a Query object from a sequence of
1095   Query objects and/or strings.  (fixes #346)
1097 * python3/pythontest.py: Expand comment about disabling test_import_star under
1098   threads.
1100 Tcl:
1102 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
1103   version added ::tcl::pkgconfig, which makes the configure tests simpler and
1104   more reliable.
1106 * Adjust precedence of the typecheck typemap for wrapping constructing a query
1107   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
1108   constructor correctly.
1110 Xapian-bindings 1.3.2 (2014-11-24):
1112 This release includes all changes from 1.2.16-1.2.19 which are relevant.
1114 Documentation:
1116 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
1118 * Update for deprecation of Xapian::Chert::open().
1120 * Update for renaming of "brass" backend to "glass".
1122 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
1123   updated" information isn't all that informative anyway - there can still be
1124   stale information even if the file was updated very recently.
1126 General:
1128 * Releases and snapshots are now bootstrapped using a more recent version of
1129   SWIG (a git snapshot from after the 3.0.3 release).
1131 * configure: Fix SWIG version check to accept 3.x, and update the minimum
1132   accepted version to be what we actually currently want.
1134 * Wrap new C++ API features, and in particular all the new weighting schemes,
1135   the changes to opening databases, and Xapian::Snipper.
1137 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
1138   argument which the C++ API takes.  If opts != 0, then output is sent to
1139   stdout, otherwise no output is produced.
1141 * Object descriptions are now always valid UTF-8. (see #620)
1143 * Provide a SimpleStopper constructor which provides the ability to initialise
1144   from a stopword list in a file.  Based on patch from Assem Chelli.
1146 CSharp:
1148 * README: Note that C# bindings now need .NET 2 or later (because that's what
1149   SWIG-generated code now requires).
1151 Java:
1153 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
1154   Anish Kanchan.  (see #616, reported by "Naveen")
1156 Lua:
1158 * Document that constants can now be accessed using CLASS.CONSTANT as well as
1159   CLASS_CONSTANT.
1161 Perl:
1163 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
1164   overlap with the hand-coded XS 'Search::Xapian' module.
1166 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1167   during parallel builds.
1169 * Use croak_sv() or ERRSV if defined.
1171 PHP:
1173 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
1174   reached EOL.
1176 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
1177   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
1178   `foreach ($it as $c)` works and allows iterating through the equivalent of
1179   C++ operator* on the iterator.  (fixes#652)
1181 * Fix handling of an exception thrown from a PHP implementation of
1182   FieldProcessor::apply().
1184 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
1185   weight threshold.
1187 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1188   available it will now only look in the configured extension directory.  The
1189   upshot is that there no longer seems to be a sane way to install the PHP
1190   bindings without being root.  Fixes #661, reported by Felix Ostmann.
1192 Python2:
1194 * The python testsuite already tested if any constants weren't marked with
1195   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
1196   clearly point to the actual problem.  Now we report the names of any
1197   such constants.
1199 * In the testsuite, use the xapian.WritableDatabase constructor rather than
1200   chert_open() - that code dates back to when chert was the only disk-based
1201   backend to support valuestreams, but flint was the default backend.
1203 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
1204   Germán M. Bravo in github PR59.
1206 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
1208 Python3:
1210 * Python 3 support has been split off into its own subdirectory, and should now
1211   be usable.  3.2 is the minimum supported version currently.  Existing code
1212   will need updating for Python 3, and the wrapped API is necessarily different
1213   in how Unicode is handled, so we've dropped deprecated features (such as
1214   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
1216 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
1217   Germán M. Bravo in github PR59.
1219 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
1221 Ruby:
1223 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
1224   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
1225   picking ruby 1.6.
1227 Xapian-bindings 1.3.1 (2013-05-03):
1229 This release includes all changes from 1.2.10-1.2.15 which are relevant.
1231 Documentation:
1233 * HACKING: Document Debian packages needed for each language.
1235 General:
1237 * Wrap new C++ API features.
1239 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
1240   unnecessary exception handling code where we call such functions and
1241   methods.
1243 * Tweak wrapping of Query from list constructor so the needed number of
1244   elements get preallocated.
1246 * Ignore Query(Query::Internal&) constructor, which is for internal use
1247   only.
1249 * For all languages except C# and Java, wrap the functions declared in
1250   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
1251   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
1252   languages.
1254 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
1255   dependencies, and adjusts the generated dependencies to work in our build
1256   system.
1258 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
1259   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
1260   V=1' and 'make V=0' which are broadly equivalent and more standard.
1262 * Fix the tests to work with the new automake parallel test driver.
1264 Portability:
1266 * Improve workaround which allows building against an uninstalled xapian-core
1267   on OS X - this should now work with any uninstalled xapian-core (not only in
1268   a tree with the same layout as an SVN or git checkout) and it also won't try
1269   to build against "../xapian-core/.libs" just because it happens to exist.
1270   (Fixes #322)
1272 CSharp:
1274 * configure: The variable to specify the interpreter is now CLI (was MONO, but
1275   didn't actually work properly).
1277 Java:
1279 * Document that we aim to support JDK 1.6 (Java 6) and later.
1281 * Avoid generating a temporary C++ vector of Query objects when constructing
1282   a Query from a Java array of Query objects or a Java array of strings.
1284 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
1285   ValueIterator, and TermIterator.
1287 * Add Enquire.getMatchingTerms().
1289 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
1290   building, e.g. "make JAVACFLAGS=-g".
1292 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
1293   with (the rather elderly) ECJ 3.3.1.
1295 Perl:
1297 * Fix PostingIterator wrapper to work.
1299 * Update list of unwrapped things in POD documentation.
1301 * Improve test coverage.
1303 * perl/t/10query.t: Adjust regexp which checks expected error message to work
1304   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
1306 * Probe for the test running tool 'prove' in configure.
1308 PHP:
1310 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
1311   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
1312   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
1313   compiled PHP module by 6%.
1315 * php/smoketest.php: Add more tests of geospatial API.
1317 Python:
1319 * Drop support for Python 2.4.
1321 * python/smoketest2.py: Add more testcases.
1323 * python/smoketest2.py: Improve reporting of test failures for certain
1324   testcases.
1326 * Update Python 3 tests from Python 2 versions using 2to3.
1328 Xapian-bindings 1.3.0 (2012-03-14):
1330 Documentation:
1332 * In maintainer builds, run doxygen to generate XML for the bindings in the
1333   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
1335 General:
1337 * Wrap new geospatial API.
1339 * Wrap new database checking API.
1341 * Deprecated features scheduled for removal in 1.3.0 have been removed.
1343 * Wrap ExpandDecider even if we don't have director support - there's a
1344   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
1345   needs some typemap work to actually get it usefully wrapped.
1347 * configure:
1349   + Add --disable-visibility option to match xapian-core.
1351   + Add -fshow-column for GCC.
1353   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
1354     variable, so that it's easy to override it if you're getting a new warning
1355     from SWIG but want to just ignore it for the time being.
1357 * Exception handling now uses Error::get_description() rather than get_type +
1358   ": " + get_msg().  In many cases this is the same, but if context or errno
1359   are available, get_description() includes them.  Catch and report
1360   std::exception rather than handling it as an unknown error (so in particular
1361   std::bad_alloc will now be reported more helpfully).
1363 CSharp:
1365 * Avoid generating unwanted wrapper sources
1366   SWIGTYPE_p_std__vectorT_std__string_t.cs and
1367   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
1369 Java:
1371 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
1372   bindings promoted in their place.  This means almost the entire C++ API is
1373   now wrapped for Java, but the downside is there are some changes required
1374   to existing code.  Overall we feel the short-term pain is worth the long
1375   term benefits of having Java bindings which stay up to date.
1377 * java/SmokeTest.java: Add test that string passing is zero byte safe.
1379 Lua:
1381 * Improve error messages.
1383 Perl:
1385 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
1386   Perl 5.14.
1388 * Fix Search::Xapian::Query->new() to work.
1390 * Enable warnings for all test cases and make them fatal.
1392 * Add "use Carp;" where we use functions from that module.
1394 * Improve POD docs for Document and TermGenerator methods - "weight" is
1395   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
1397 * The Query constructor which takes an array of subqueries is now wrapped more
1398   efficiently - previous a temporary C++ std::vector was built but now we avoid
1399   doing this.
1401 PHP:
1403 * PHP >= 5.3 is now required.
1405 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
1407 * The XapianQuery constructor which takes an array of subqueries is now
1408   wrapped more efficiently - previous a temporary C++ std::vector was built
1409   but now we avoid doing this.
1411 Python:
1413 * Python >= 2.4 is now required.
1415 * Remove deprecated Stem_get_available_languages().
1417 * Hide away the deprecated non-pythonic iterators - we still need them to
1418   implement the pythonic iterators, so we can't entirely remove them.
1420 * Replace SWIG's thread locking with code which does nothing unless threads
1421   are already initialised, to avoid the overhead of thread locking in the
1422   common case of single-threaded Python code.  This seems to be about 5-10%
1423   faster for pythontest2.py modified to repeat the tests 100 times.
1425 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
1426   #364.
1428 * The Query constructor which takes an array of subqueries is now wrapped more
1429   efficiently - previous a temporary C++ std::vector was built but now we avoid
1430   doing this.
1432 Ruby:
1434 * The XapianQuery constructor which takes an array of subqueries is now
1435   wrapped more efficiently - previous a temporary C++ std::vector was built
1436   but now we avoid doing this.
1438 Tcl:
1440 * The XapianQuery constructor which takes an array of subqueries is now
1441   wrapped more efficiently - previous a temporary C++ std::vector was built
1442   but now we avoid doing this.
1444 Xapian-bindings 1.2.23 (2016-03-28):
1446 Documentation:
1448 * Update links to Xapian website and trac to use https, which is now supported,
1449   thanks to James Aylett.
1451 PHP:
1453 * Check that the PHP interpreter we find is actually PHP5, and if not look
1454   harder.  On current Debian unstable, php-config5 --php-binary reports
1455   /usr/bin/php which can be PHP7.
1457 * Document that PHP7 isn't currently supported, and explicitly check for and
1458   reject it in configure.
1460 Ruby:
1462 * configure: Stop preferring rdoc-1.8 to rdoc (this only happened in a
1463   fall-back case when rdoc wasn't found in the same directory as the ruby
1464   interpreter).
1466 Xapian-bindings 1.2.22 (2015-12-29):
1468 Documentation:
1470 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
1471   'git cherry-pick' from working as it should.  The git repo history should be
1472   sufficient for complying with GPLv2 2(a).
1474 General:
1476 * Stop wrapping internal methods of Xapian::Weight.
1478 * Return Error::get_description() rather than get_type + ": " + get_msg().  In
1479   many cases this is the same, but if context or errno are available,
1480   get_description() includes them.
1482 * Catch and report std::exception rather than handling it as an unknown error
1483   (so in particular std::bad_alloc will now be reported more helpfully).
1485 CSharp:
1487 * Fix configure test for whether $MONO can run CSharp programs - previously it
1488   would always fail, which would mean that the CSharp tests would only be run
1489   on systems where CSharp programs can be run directly.
1491 Lua:
1493 * Send stderr from lua version check to config.log instead of letting it appear
1494   on the terminal.
1496 PHP:
1498 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
1500 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
1501   constructors now work.
1503 Python:
1505 * Add new testcase to catch any internal functions, methods, constants, etc
1506   which have accidentally been wrapped.
1508 Xapian-bindings 1.2.21 (2015-05-20):
1510 Lua:
1512 * README: Remove note about the Lua bindings being experimental - it's not
1513   really been true for some time now.
1515 Perl:
1517 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
1519 * Add workaround for Perl defining a seed() macro which breaks compilation with
1520   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
1521   classes with a method called seed).
1523 * Update list of unwrapped things in POD documentation.
1525 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1526   during parallel builds.
1528 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
1530 * Add test that we can create all the stemmers returned by
1531   Stem::get_available_languages().
1533 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
1534   likely due to external reasons, like incompatible compiler flags being taken
1535   from Perl's Config module, due to Perl having been built with a different
1536   compiler to Xapian.
1538 * Use croak_sv() or ERRSV if defined.
1540 PHP:
1542 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
1543   was fixed in 1.2.19.
1545 Python:
1547 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
1548   stable release 1.4.0.
1550 Ruby:
1552 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
1554 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
1555   https://bugs.debian.org/782270
1557 Xapian-bindings 1.2.20 (2015-03-04):
1559 Portability:
1561 * configure: Avoid using \? in sed command in Lua detection - it isn't
1562   supported by all sed implementations.
1564 Lua:
1566 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
1567   being specified without a leading '.'.
1569 * configure: Add an example of specifying LUA_SO to --help output.
1571 PHP:
1573 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
1574   1.2.19.
1576 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1577   available it will now only look in the configured extension directory.  The
1578   upshot is that there no longer seems to be a sane way to install the PHP
1579   bindings without being root, so update the documentation to reflect this.
1580   Fixes #661, reported by Felix Ostmann.
1582 Xapian-bindings 1.2.19 (2014-10-21):
1584 PHP:
1586 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
1587   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
1588   Gottfried)
1590 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
1591   which were getting incorrectly wrapped such that they didn't actually do
1592   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
1593   reference tracking fix in 1.2.14.
1595 Ruby:
1597 * README: Note that Ruby 2.1 works too.
1599 Xapian-bindings 1.2.18 (2014-06-22):
1601 Documentation:
1603 * README: Add links to Erlang and Node.js bindings.
1605 Lua:
1607 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
1608   expected), which most of the calls already used, and fix up the few calls
1609   which passed (expected, got).
1611 PHP:
1613 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
1614   that MatchDecider returns an MSet with the expected docid in.  Luckily this
1615   wasn't masking a test failure.
1617 Python:
1619 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
1620   - chert is the default backend now, and both chert and brass support the
1621   required functionality for the tests which do this, so this just needlessly
1622   causes the tests to fail if chert is disabled in xapian-core.
1624 * configure: If the Python version is too new or too old, only report it once
1625   not twice.
1627 Ruby:
1629 * configure: Fix Ruby bindings to build on Windows (and other platforms where
1630   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
1632 Xapian-bindings 1.2.17 (2014-01-29):
1634 Portability:
1636 * Improve workaround which allows building against an uninstalled xapian-core
1637   on OS X - this should now work with any uninstalled xapian-core (not only in
1638   a tree with the same layout as an SVN or git checkout) and it also won't try
1639   to build against "../xapian-core/.libs" just because it happens to exist.
1640   (Backported from 1.3.1; fixes #322)
1642 Python:
1644 * configure: Some distros now point /usr/bin/python at Python 3, so the check
1645   for a Python 2 interpreter now checks for 'python2' first, and checks that
1646   the version of found interpreter is 2.x.
1648 Ruby:
1650 * Tweak configure to work with Ruby 2.0.
1652 Tcl:
1654 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
1655   in https://bugs.debian.org/724830).
1657 * Use a better check for TCL_INC for Tcl 8.5 and later.
1659 Xapian-bindings 1.2.16 (2013-12-04):
1661 Documentation:
1663 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
1665 General:
1667 * Compress source tarballs with xz instead of gzip.
1669 * configure: Handle git snapshot naming.
1671 Portability:
1673 * configure: Update list of platforms where we tell libtool not to link in
1674   deplibs to match the list used for xapian-core.
1676 Perl:
1678 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
1679   GCC 4.7 warning).
1681 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
1682   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
1684 PHP:
1686 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
1687   with a message explaining this.
1689 Python:
1691 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
1693 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
1695 * pythontest.py: Fix testcase checking we get an exception from using
1696   non-random-access iterators after then have advanced - previously these
1697   didn't actually test as fully as intended.
1699 Ruby:
1701 * Omit internal classes and methods from the rdocs.
1703 Xapian-bindings 1.2.15 (2013-04-16):
1705 General:
1707 * Fix configure --enable-quiet option to actually work for the bindings.
1709 Perl:
1711 * Fix doc typo: "as as" -> "as a"
1713 Ruby:
1715 * Fix deprecation warning in configure from Ruby 1.9.3.
1717 Xapian-bindings 1.2.14 (2013-03-14):
1719 Python:
1721 * Fix typo in doccomment.
1723 PHP:
1725 * Keep references to the PHP wrapper object when an object is set on another
1726   object.  (fixes #614)
1728 Tcl:
1730 * Allow TCL_INC to be passed to configure.  (fixes #612)
1732 Xapian-bindings 1.2.13 (2012-11-09):
1734 CSharp:
1736 * configure: Overhaul checks for C# tools to use modern names in preference.
1738 Lua:
1740 * Fix examples to use str(query) to get the query description.  (Fixes #600)
1742 * Document that get_description() is mapped to str(), and end() to _end().
1744 * Fix functor wrappers which return strings to be zero-byte clean.
1746 Perl:
1748 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
1749   1.2's XS Search::Xapian.  (ticket#607)
1751 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
1752   is deprecated.
1754 PHP:
1756 * Document that subclassing Xapian classes in PHP currently doesn't work with
1757   PHP 5.4.
1759 Xapian-bindings 1.2.12 (2012-06-27):
1761 No changes since 1.2.11 except to bump the version - this release was made to
1762 fix an incorrect library version information update in xapian-core 1.2.11.
1764 Xapian-bindings 1.2.11 (2012-06-26):
1766 General:
1768 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
1770 Perl:
1772 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
1773   av_fetch() (spotted due to GCC 4.7 warning).
1775 PHP:
1777 * Fix "make check" to work for PHP when building from a release tarball with
1778   srcdir != builddir.
1780 * Work around "undefined symbol: zend_error_noreturn" error.
1782 Xapian-bindings 1.2.10 (2012-05-09):
1784 CSharp:
1786 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
1787   us to do this instead of setting them in AssemblyInfo.cs.
1789 * Use diff's -c option when comparing the files SWIG generated against those we
1790   were expecting to get as the output should be easier to understand.
1792 * Sort both the lists of expected and of found SWIG-generated sources with
1793   Perl, to avoid problems with locale-specific sort orders.
1795 Java-SWIG:
1797 * Remove now superfluous old check that SWIG generated at least the sources we
1798   want - we now check it generated *exactly* the sources we want.
1800 * Use diff's -c option when comparing the files SWIG generated against those we
1801   were expecting to get as the output should be easier to understand.
1803 * Sort both the lists of expected and of found SWIG-generated sources with
1804   Perl, to avoid problems with locale-specific sort orders.
1806 Lua:
1808 * Now works with Lua 5.2.
1810 * "require 'xapian'" now returns the module table.  (ticket #593)
1812 * lua/smoketest.lua: Improve reporting of test failures.
1814 Perl:
1816 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
1818 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
1819   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
1821 Python:
1823 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
1824   iteration features which have been removed on trunk.  This also fixes a
1825   segfault if there are no matches and no documents are explicitly marked as
1826   relevant.
1828 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
1829   way to rerun tests with verbose output.
1831 Ruby:
1833 * configure: Make sure the ruby subdirectory exists before trying to create
1834   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
1836 Xapian-bindings 1.2.9 (2012-03-08):
1838 Java:
1840 * configure: Fix test for jni.h to try looking for jni.h relative to the real
1841   location of javac, which should work for more JDKs.
1843 Lua:
1845 * Handle an exception from C++ by raising a xapian.Error object as an error in
1846   Lua.
1848 * Rename get_description() methods to __tostring(), so that you can use write
1849   tostring(obj) in Lua.
1851 * configure: Honour LUA_LIB if already set.  Fixes #581.
1853 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
1854   support platforms where the compiled Lua module isn't called .so.
1856 Perl:
1858 * Add tests of Document::get_docid().
1860 PHP:
1862 * Add a test that Query constructor taking OP_NEAR with a window size works.
1864 Python:
1866 * python/testsuite2.py: Don't run off the traceback looking for a test function
1867   if the exception wasn't from a test function.
1869 Xapian-bindings 1.2.8 (2011-12-13):
1871 Lua:
1873 * Wrap user-subclassable functor objects by allowing the user to pass a
1874   Lua function where the functor object would be passed in the C++ API.
1876 PHP:
1878 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
1880 * The PHP bindings will now work again with a version of PHP built with ZTS
1881   enabled (which is the default on Microsoft Windows).  This was broken by
1882   the changes to support subclassing in PHP in the version of SWIG used since
1883   1.2.6.
1885 Python:
1887 * Add a module docstring.  (Fixes bug #573)
1889 * The python testsuite now checks for object leaks during each testcase.
1891 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
1892   only check for leaks the second time to avoid falsely reporting a leak when
1893   some cached value gets initialised under Python 2.5.
1895 Ruby:
1897 * Wrap optional prefix parameter to Database::allterms.
1899 Xapian-bindings 1.2.7 (2011-08-10):
1901 Documentation:
1903 * INSTALL: Pull in a few updates from the latest version of the automake
1904   document which this file was originally based on.  Add in the missing
1905   copyright and licensing information.
1907 * INSTALL: Add --with-lua to list of options.
1909 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
1910   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
1911   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
1912   supported platforms in the README.
1914 * HACKING: Update and start section on deprecation warnings for the bindings.
1916 General:
1918 * Add missing wrappers for Database::has_positions() and
1919   TermIterator::positionlist_count(), and correct the return type of
1920   Database::get_doclength() from double to Xapian::termcount.
1922 CSharp:
1924 * README: Note a recent version of Mono which we've tested the C# bindings
1925   with.
1927 * Check that exactly the sources we expect are generated, and add some sources
1928   which were missing from the list.
1930 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
1931   gets removed.
1933 * Fix iterator ++ and -- so that the reference to the object isn't released
1934   prematurely, which was causing an occasional crash if the garbage collection
1935   happened at just the wrong moment,
1937 * Add test coverage for QueryParser.ParseQuery() with flags argument.
1939 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1941 Java:
1943 * SmokeTest.java: Fix == comparisons with strings to use equals().
1945 * Add test that string passing is zero byte safe.
1947 * Fix MyExpandDecider.accept() to really check the passed parameter.
1949 Java-SWIG:
1951 * Put the SWIG-generated Java bindings in package org.xapian.
1953 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1955 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
1957 * Add test that string passing is zero byte safe.
1959 * Fix MyExpandDecider.accept() to really check the passed parameter.
1961 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
1963 * Create an HTML documentation page based on java/README.
1965 * Copy java examples from the hand-coded JNI ones.
1967 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
1969 * Check that exactly the sources we expect are generated, and add some sources
1970   which were missing from the list.
1972 Lua:
1974 * Merge latest Lua changes from Xiaona Han.
1976 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
1978 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
1979   matches.
1981 Perl:
1983 * Sync updates to examples from XS Search::Xapian:
1985   + Require Perl >= 5.6 so we can "use warnings;".
1987   + Loop over file using while() (which reads a line per iteration) not
1988     foreach() (which reads the whole file up front).
1990 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
1991   and Search::Xapian::Query::MatchNothing).  (ticket#158)
1993 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
1995 * perl/Makefile.am: Fix "make check".
1997 * perl/t/symbol-test.t: Fix to work when built against an installed
1998   xapian-core.  (ticket#558)
2000 PHP:
2002 * php/smoketest.php: Install an error handler so the test fails if there are
2003   any errors, warnings, notices, etc.
2005 * Change PHP examples and test program to use 'include "xapian.php"' like user
2006   code should (rather than 'include "php5/xapian.php"' as they did previously).
2008 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
2009   XapianQuery::MatchNothing(). (ticket#158)
2011 Ruby:
2013 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
2015 Xapian-bindings 1.2.6 (2011-06-12):
2017 General:
2019 * SWIG-based bindings are now generated with a newer version of SWIG
2020   (ticket#538).
2022 Portability:
2024 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
2025   .jnilib extension as we do for older versions.
2027 CSharp:
2029 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
2031 Java:
2033 * Fix memory leaks when functions taking string parameters throw exceptions.
2035 * Previously a hash table was used to map Java objects to C++ ones, but we
2036   now just cast the address of the C++ object to a jlong (which is 64 bits
2037   so will hold a pointer on current platforms).  This is more efficient and
2038   avoids the need for thread locks around accesses to the hash table.
2040 * Remove explicit checks for NULL around calls to delete.
2042 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
2043   during parallel builds.
2045 Lua:
2047 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
2048   year.  The current support should be regarded as experimental - it passes
2049   its automated tests, but the details of the Lua API are likely to evolve as
2050   the project progresses.
2052 Perl:
2054 * README: say that Perl bindings probably need Perl 5.8 or later.
2056 PHP:
2058 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
2060 Python:
2062 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
2063   all the garbage, so repeat until no further objects are freed.
2064   (https://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
2066 Ruby:
2068 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
2069   the compaction tests for these versions.
2071 Xapian-bindings 1.2.5 (2011-04-04):
2073 Documentation:
2075 * README: Update info on SWIG-based Perl bindings.
2077 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
2078   section with better equivalent from xapian-core/INSTALL.
2080 General:
2082 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
2084 * configure: If xapian-core is a different release series, promote the
2085   mismatched versions warning to an error.
2087 Portability:
2089 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
2090   10.4 on x86, as the default if unset on these versions is the current OS
2091   version.  (ticket#541)
2093 * python/pythontest2.py: In test_compactor(), close any open databases before
2094   removing the directory as you can't delete an open database on Microsoft
2095   Windows.  (ticket#526)
2097 CSharp:
2099 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
2101 * Clarify the licence is GPL "version 2 or later" in the meta information
2102   we put in the module.
2104 Python:
2106 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
2107   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
2108   accidentally left an older version of get_matching_terms() exposed.
2110 * Remove broken implementation of MSet.__contains__.  This appears never to
2111   have worked, and to have been broken for at least the past 3.5 years without
2112   anyone mentioning it, and is probably of little use anyway, so no need to
2113   deprecate.
2115 * python/docs/index.html: Document that MSet.items and ESet.items are
2116   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
2117   the tuple returned by MSet.items.  (ticket#531)
2119 * Add test coverage for mset.items.
2121 Ruby:
2123 * Add test coverage for Xapian::Compactor.
2125 * Handle an empty response to $RUBY --version specially.  This gives a less
2126   opaque error in cases where the user specified RUBY but the value given
2127   wasn't an executable file.
2129 Xapian-bindings 1.2.4 (2010-12-19):
2131 General:
2133 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
2134   virtual method is wrapped for subclassing for Python and Ruby currently.
2136 * Eliminate separate Makefile.am in the docs subdirectory of each language
2137   subdirectory and just inline any rules into the main sub-Makefile.am, which
2138   allows more of the build to run in parallel.
2140 * Don't ship some files which are generated at build time.
2142 * configure: Need python in maintainer mode to run doxy2swig.py.
2144 Packaging:
2146 * RPM: Package the Perl bindings.
2148 * RPM: Don't package _XapianSharp.la.
2150 Portability:
2152 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
2153   uninstalled Xapian library.  See ticket #322.
2155 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
2157 CSharp:
2159 * Don't install _XapianSharp.la.
2161 Perl:
2163 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
2164   GSoC 2009.  These are close to being a compatible replacement for the
2165   hand-coded XS bindings in Search::Xapian but also offer a more complete
2166   wrapping of the C++ API.  We're planning to replace the XS bindings with the
2167   SWIG ones for easier maintenance.  We encourage you to try them and let us
2168   know how you get on - particularly if you find cases where code which works
2169   with the XS bindings doesn't work with the SWIG ones.
2171 PHP:
2173 * Document that iterators shouldn't be dereferenced or advanced when at their
2174   end points (ticket#520).
2176 Python:
2178 * Fix memory leaks in typemaps which return Python lists.
2180 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
2181   supported.
2183 * configure: Use sys.version_info tuple, rather than string splicing which
2184   assumes the Python "major.minor" is 3 characters (which would fail if Python
2185   2.10 were ever released, for example).
2187 Xapian-bindings 1.2.3 (2010-08-24):
2189 Packaging:
2191 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
2193 Xapian-bindings 1.2.2 (2010-06-27):
2195 * No user-visible change except for bumping the version to indicate
2196   compatibility with Xapian-core 1.2.2.
2198 Xapian-bindings 1.2.1 (2010-06-22):
2200 This release includes all changes from 1.0.21 which are relevant.
2202 General:
2204 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
2205   Python.  (ticket#448)
2207 Guile:
2209 * Remove non-functional disabled guile bindings left over from Open Muscat
2210   days - if someone wanted to add guile bindings, it would be easier to start
2211   from scratch.
2213 Java-SWIG:
2215 * Update list of generated java sources in the SWIG-based Java bindings.
2217 PHP:
2219 * zend_throw_exception() returns, so return control to PHP directly after
2220   calling it to avoid needless extra work and possible issues.
2222 Python:
2224 * Fix "from xapian import *".  (ticket#477)
2226 * Fix testcase weight_normalise - a change in xapian-core means that
2227   get_max_possible() can now return zero for a non-existent term, so don't
2228   blindly calculate the reciprocal of it.
2230 * python/replicationtest2.py: Extend to check that changesets get applied
2231   correctly.
2233 * python/smoketest2.py: Check len(mset) works (improving test coverage of
2234   Python-specific wrapping).
2236 Xapian-bindings 1.2.0 (2010-04-28):
2238 This release includes all changes from 1.0.20 which are relevant.
2240 Portability:
2242 * configure: Tell libtool not to link in deplibs on platforms where we know
2243   they aren't needed.
2245 * configure: On Linux, extract the library search path from ldconfig which
2246   gives us the default entries reliably.
2248 Xapian-bindings 1.1.5 (2010-04-15):
2250 This release includes all changes from 1.0.19 which are relevant.
2252 Tcl:
2254 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
2255   sidestep the whole destructor issue.  (ticket#62)
2257 Xapian-bindings 1.1.4 (2010-02-15):
2259 This release includes all changes from 1.0.18 which are relevant.
2261 General:
2263 * Update for the new Brass backend and other C++ API changes.
2265 * Wrap Database::get_doclength_lower_bound(),
2266   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
2267   Database::valuestream_begin() and Database::valuestream_end() for all
2268   languages. (ticket#431)
2270 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
2272 Python:
2274 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
2275   object which dereferences to a ValueStreamItem object,
2277 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
2279 Ruby:
2281 * Add safe wrapper for the valuestream iterator.
2283 Xapian-bindings 1.1.3 (2009-11-18):
2285 This release includes all changes from 1.0.15-1.0.17 which are relevant.
2287 General:
2289 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
2290   specified.
2292 * Wrap the new MatchSpy class, and associated features.
2294 * Don't wrap PostingSource::serialise(), Weight::serialise() and
2295   Weight::unserialise() as they aren't useful from the bindings.
2297 * Update for the Sorter to KeyMaker changes.
2299 PHP:
2301 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
2302   as it standardly is on Microsoft Windows.  Fixes #411.
2304 * Merged the PHP "smoketest" back together now we don't need to support
2305   PHP4 now.
2307 Python:
2309 * Fix a memory leak on error (in theory - we've not got a way to generate this
2310   error, so haven't been able to reproduce the leak or test the fix).
2312 Xapian-bindings 1.1.2 (2009-07-23):
2314 This release includes all changes from 1.0.14 which are relevant to trunk.
2316 Python:
2318 * Several changes towards fully supporting Python 3, but more work is required.
2319   (ticket#246)
2321 Xapian-bindings 1.1.1 (2009-06-09):
2323 This release includes all changes from 1.0.13 which are relevant to trunk.
2325 General:
2327 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
2329 CSharp:
2331 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2332   C# yet, and to use Query("") and Query() instead.
2334 * configure: If we don't find a C# compiler, don't test an empty command name
2335   further which saves a fork and avoids an odd looking message.
2337 PHP:
2339 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2340   PHP yet, and to use Query("") and Query() instead.
2342 Python:
2344 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
2345   are wrapped (ticket#158).
2347 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
2348   expect SYNONYM in generated query.
2350 Ruby:
2352 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
2353   Ruby yet, and to use Query("") and Query() instead.
2355 Tcl:
2357 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
2358   are wrapped (ticket#158).
2360 Xapian-bindings 1.1.0 (2009-04-22):
2362 Documentation:
2364 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
2365   the instructions to suggest users use this standard location for installing
2366   without root access.
2368 General:
2370 * All deprecated features slated for removal in 1.1.0 have been removed.
2372 * All new C++ API features have been wrapped.  Also, since we now supply some
2373   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
2374   these can be passed in even for languages for which SWIG doesn't support
2375   subclassing.
2377 Packaging:
2379 * xapian-bindings.spec: Updated to reflect the new Python packaging.
2381 Portability:
2383 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
2384   to put the compiler into ISO C++ mode).
2386 PHP:
2388 * PHP4 support has been removed, since PHP4 is no longer supported upstream
2389   as of 2008-08-08.
2391 Python:
2393 * Python 2.3 or later is now required.  2.2 is essentially unsupported
2394   upstream.
2396 * The import method used has been changed (by using a newer SWIG version)
2397   and no longer gives a warning with Python 2.6.
2399 * Initial support for Python 3.0 has been added.  This currently doesn't
2400   work correctly and should be treated as experimental. (ticket#346)
2402 * The newer SWIG version handles exceptions in director methods correctly
2403   so we no longer need our workaround for ticket #289.
2405 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
2406   wrapped for Python as Database.metadata_keys().
2408 * The Python bindings are now installed as a python package, with the
2409   files in a xapian subdirectory, hiding the internal _xapian module
2410   better.
2412 * Python now flags deprecation warnings for the single argument form and old
2413   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
2414   friends.
2416 Xapian-bindings 1.0.23 (2011-01-14):
2418 Portability:
2420 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
2422 PHP:
2424 * Document that iterators shouldn't be dereferenced or advanced when at their
2425   end points (ticket#520).
2427 Python:
2429 * Fix memory leaks in typemaps which return Python lists.
2431 Xapian-bindings 1.0.22 (2010-10-03):
2433 Packaging:
2435 * RPM: Don't package _XapianSharp.la.
2437 CSharp:
2439 * Don't install _XapianSharp.la.
2441 Python:
2443 * configure: Use sys.version_info tuple, rather than string splicing which
2444   assumes the Python "major.minor" is 3 characters (which would fail if Python
2445   2.10 were ever released, for example).
2447 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
2448   testcase in pythontest.py.
2450 Xapian-bindings 1.0.21 (2010-06-18):
2452 Python:
2454 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
2455   can't be written to. (ticket#297)
2457 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
2459 * Add test to check that "from xapian import *" works.
2461 Xapian-bindings 1.0.20 (2010-04-27):
2463 Python:
2465 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
2466   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
2467   trap to delete them after running tests for older versions of Python.
2468   (ticket#315)
2470 Ruby:
2472 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
2474 Xapian-bindings 1.0.19 (2010-04-15):
2476 Tcl:
2478 * tcl8/docs/index.html: Improve wording in a few places.
2480 Xapian-bindings 1.0.18 (2010-02-14):
2482 General:
2484 * Wrap new C++ API method Document::add_boolean_term().
2486 Ruby:
2488 * Generate entries in the Ruby rdocs for all classes which aren't documented
2489   because of Ruby-specific methods.  Fixes ticket#417.
2491 * Avoid absolute paths in the generated rdocs.
2493 Xapian-bindings 1.0.17 (2009-11-18):
2495 Packaging:
2497 * Improve RPM package summaries - the files are needed to *use* scripts as well
2498   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
2499   conventional.
2501 Portability:
2503 * python/Makefile.am: Restore the "./" path to the sourced file
2504   libtoolconfig.tmp as ksh requires it.
2506 Java:
2508 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
2510 Xapian-bindings 1.0.16 (2009-09-10):
2512 Python:
2514 * Improved docstrings for QueryParser::set_default_op() and
2515   QueryParser::get_default_op() (automatically generated from changes in
2516   xapian-core).
2518 Xapian-bindings 1.0.15 (2009-08-26):
2520 Python:
2522 * Don't break long words when wrapping text in the generated API documentation
2523   comments as this was causing identifiers to be broken in two.
2525 Xapian-bindings 1.0.14 (2009-07-21):
2527 General:
2529 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
2530   and the only side-effect was an odd looking message.
2532 Python:
2534 * Rename methods at build-time using SWIG rather than a run-time in Python, as
2535   the latter approach adds a small time overhead when the module is being
2536   loaded.
2538 Ruby:
2540 * Fix to accept an integer value > MAXINT for a double parameter.
2542 Xapian-bindings 1.0.13 (2009-05-23):
2544 Packaging:
2546 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
2547   _XapianSharp.so in 1.0.11.
2549 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
2550   bindings since 1.0.6.
2552 PHP:
2554 * Backport fix from SWIG SVN for misuse of formatted error function in
2555   SWIG-generated code.
2557 Python:
2559 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
2560   Python's Global Interpreter Lock (GIL) in situations where we know that it
2561   will already be locked.  This avoids some dead-locks with mod_python (due to
2562   mod_python bugs which are apparently unlikely to ever be fixed), and results
2563   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
2564   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
2565   faster). (ticket#185)
2567 * README,python/docs/index.html: Update documentation of the above mod_python
2568   issue and also document the related mod_wsgi issue.  The status is now that
2569   everything seems to work if you stick to the main interpreter (ticket#364).
2571 * Backport fix from SWIG SVN for misuse of formatted error function in
2572   SWIG-generated code.
2574 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
2575   second parameter, not the third.
2577 * python/docs/examples/simplematchdecider.py,
2578   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
2579   clearer code.
2581 Ruby:
2583 * README: Note that the testsuite fails due to a bug in the test/unit module in
2584   Ruby 1.9.0, but applications using the bindings should work, and that the
2585   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
2586   appears to be completely dead both upstream and in the wild.
2588 Xapian-bindings 1.0.12 (2009-04-19):
2590 Documentation:
2592 * INSTALL: Add a note about being able to pass variables to configure to pick
2593   which of several parallel installations of a language to build for.
2595 Python:
2597 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
2598   test to avoid failing due to rounding differences.
2600 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
2601   stop the whole testsuite, not just the currently running testcase.
2603 Xapian-bindings 1.0.11 (2009-03-15):
2605 Documentation:
2607 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
2608   Python 3, and possible current issues with Ruby 1.9.
2610 Portability:
2612 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
2613   Cygwin.
2615 Python:
2617 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
2618   latter is deprecated, and support was removed in 1.0.0).
2620 * Add support for using the new name ("reverse") for the second argument of
2621   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
2622   The old name ("ascending") is still supported, but will be deprecated in
2623   1.1.0.
2625 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
2626   which get set on other objects to avoid segmentation faults if they go out
2627   of scope before the object they are set on does.  (ticket#341)
2629 Ruby:
2631 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
2632   fails so "make check" doesn't pass, but code using the bindings should work.
2634 Xapian-bindings 1.0.10 (2008-12-23):
2636 Python:
2638 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
2639   as things stand (upstream fix for Debian bug 506090).
2641 Xapian-bindings 1.0.9 (2008-10-31):
2643 General:
2645 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
2647 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
2648   methods.
2650 Xapian-bindings 1.0.8 (2008-09-04):
2652 General:
2654 * configure: Report bug report URL in --help output.
2656 Python:
2658 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
2659   (bug#289)
2661 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
2663 Xapian-bindings 1.0.7 (2008-07-14):
2665 Documentation:
2667 * Document how all the database factory functions and library version functions
2668   are wrapped for all languages.
2670 General:
2672 * Fix to build against a xapian-core which has quartz and/or flint disabled.
2674 * The "program" version of Remote::open() has been wrapped for some time, so
2675   update the documentation which said it wasn't.
2677 Packaging:
2679 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
2681 Portability:
2683 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
2684   different module extension rather than our own ugly bodge.
2686 Java:
2688 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
2689   simple to make C++ to Java work though.
2691 PHP:
2693 * Add test that OP_VALUE_GE works for PHP.
2695 Python:
2697 * Several corrections to the Python documentation.
2699 * configure: Fix problem with building under mingw.
2701 Ruby:
2703 * Include simplematchdecider.rb example.
2705 * smoketest.rb: Test the version reporting functions.
2707 Tcl:
2709 * Include simpleexpand.tcl example.
2711 * Fix where the Tcl module gets installed.
2713 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
2715 Xapian-bindings 1.0.6 (2008-03-17):
2717 General:
2719 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
2720   used with.
2722 * configure: Correct the required SWIG version given in an error message.
2724 PHP:
2726 * php/smoketest.php: Add note that this script should be run using 'make check'
2727   in the build tree (rather than trying to copy it to a webserver as someone
2728   recently tried to).
2730 * php/smoketest.php: Fix to work under PHP4.
2732 Python:
2734 * The Python module now always has the extension which Python expects, which
2735   fixes a failure on Mac OS X.
2737 Ruby:
2739 * Automatically install/uninstall the Ruby rdoc-generated documentation along
2740   with the ruby bindings.
2742 Tcl:
2744 * configure: Sort out the default value of TCL_LIB, which could end up being
2745   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
2747 Xapian-bindings 1.0.5 (2007-12-21):
2749 General:
2751 * Wrap Xapian::Sorter and subclasses.
2753 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
2754   and Enquire::set_sort_by_relevance_then_key().
2756 * Factor out the code to protect multitarget rules against parallel make, and
2757   fix it to handle the source being changed while the rule is executing, and to
2758   correctly return an error code if we fail while trying to recover from the
2759   removal of a target of a multi-target rule.
2761 * configure: Improve the clarity of the error given when none of the tools
2762   needed for any supported language are found.
2764 * configure: SWIG 1.3.32 has now been released, so require at least this
2765   released version for maintainer builds.
2767 Java:
2769 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
2770   GCC 4.3.
2772 * configure: Log the output of trying to compile conftest.java in config.log;
2773   if the test fails, report whether the failure was compiling or running the
2774   test program.
2776 * Check for directory existence rather than calling mkdir unconditionally as
2777   despite the "(ignored)", the error message seems to confuse some people.
2779 PHP:
2781 * Add feature test for XapianMultiValueSorter.
2783 * php/smoketest5.php: Fix use of Database_get_document to new style OO
2784   interface.  Fix the error reported when the PHP5 exception test fails.
2786 * php/smoketest.php: Add feature test to confirm that optional arguments to
2787   XapianQuery's "term" constructor are wrapped.
2789 Python:
2791 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
2792   these properties build a python list, so dropping the GIL isn't safe and
2793   may cause undefined behaviour in multithreaded environments.
2795 * configure: Update error message to reflect requirement for at least python
2796   2.2.
2798 * configure: Change "print foo" to "print(foo)" in python version checks, for
2799   compatibility with python 3.0.
2801 Ruby:
2803 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
2804   previously incorrect).
2806 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
2807   ruby/docs/index.html previously had a dead link to.
2809 Tcl:
2811 * configure: Overhaul code to find tcl.h since the old version no longer worked
2812   with Debian unstable.
2814 * tcl8/docs/index.html: Update documentation to cover flint and mention that
2815   quartz is now deprecated.
2817 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
2818   throws QueryParserError instead.
2820 Xapian-bindings 1.0.4 (2007-10-30):
2822 General:
2824 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
2825   Add feature tests for all languages.
2827 * The "bindings.html" file documenting each of the bindings has been renamed to
2828   "index.html".
2830 Packaging:
2832 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
2833   older distros.
2835 Portability:
2837 * Fix warnings when compiling with GCC 4.2.
2839 PHP:
2841 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
2842   and methods/functions which return a wrapped class.
2844 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
2845   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
2847 * Document how non-class functions are wrapped.
2849 * Fix wrapping of NumberValueRangeProcessor for PHP4.
2851 * smoketest.php: Split the regression test for bug#193 into separate
2852   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
2854 Python:
2856 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
2857   non-pythonic iterators.  Make it clearer that the "sequence API" is
2858   deprecated.
2860 * Add test of a custom ValueRangeProcessor (ie, one written in python).
2862 * Update the examples to use the new-style attributes to access MSet item
2863   values rather than the old-style MSET_* constants.
2865 * Document MSET_DOCUMENT.
2867 Ruby:
2869 * smoketest.rb: Rename test of metadata access methods which had been named the
2870   same as the matchdecider test due to a copy-and-paste error.
2872 Xapian-bindings 1.0.3 (2007-09-28):
2874 General:
2876 * Wrap new methods Database::get_metadata() and
2877   WritableDatabase::set_metadata().
2879 * "make uninstall" now removes the loadable module we install for each of
2880   the bindings.
2882 * "make distcheck" now works.
2884 * Distribution tarballs are now in the POSIX "ustar" format since it saves
2885   about 40KB and we need to use it for xapian-core anyway.
2887 Packaging:
2889 * RPMs: Package xapian.php.
2891 CSharp:
2893 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
2894   usefully used currently.
2896 Java:
2898 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
2899   C++ library.
2901 * "make clean" now removes the class files generated for inner classes.
2903 PHP:
2905 * Add feature test for DateValueRangeProcessor when used with QueryParser.
2907 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
2908   isn't actually very useful, since you can't subclass it in PHP currently.
2910 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
2911   if the third parameter was specified and a floating point number (e.g. 0.0).
2913 * php/docs/bindings.html: Fix errors in example code.
2915 Python:
2917 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
2918   Python which takes two strings and returns a 3-tuple (value_number,
2919   modified_begin, modified_end).  Previously this always failed with a
2920   type error, so this doesn't break existing code.
2922 * python/pythontest.py: Interpret any commandline arguments as a list of
2923   tests to be run (the default is to run all tests).
2925 * README,python/docs/bindings.html: Add a note about the problems with
2926   mod-python (as described in bug #185).
2928 * python/pythontest.py: Delete the database handles before deleting a database
2929   to fix problems running the Python tests on MS Windows (bug#179).
2931 * "make clean" now removes testsuite.pyc.
2933 Ruby:
2935 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
2936   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
2937   now the site-specific directories, which is more correct when building
2938   from source.  Debian packages, etc can override this by setting RUBY_LIB and
2939   RUBY_LIB_ARCH.
2941 Tcl:
2943 * Check for TCL_LIB in the environment or on the configure command-line to
2944   allow installing without root access more cleanly.
2946 Xapian-bindings 1.0.2 (2007-07-05):
2948 Documentation:
2950 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
2951   phpextdir.
2953 * Remove documentation of removed "--with-swig" configure option.
2955 General:
2957 * Add methods of NumberValueRangeProcessor for serialising and
2958   unserialising doubles.
2960 * Add methods and constants supporting spelling correction and synonyms.
2962 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
2963   to ensure that it works with uninstalled copies of Xapian.
2965 * Value of PYTHON_LIB supplied to configure is now respected - previously
2966   it was documented, but ignored.
2968 * Add support for supplying PHP_EXTENSION_DIR to configure.
2970 * Change to using "%include", rather than reproducing contents of header
2971   files, for "queryparser.h", "document.h" and "postingiterator.h".
2973 * Add new form of get_mset() which allows a matchspy matchdecider to be
2974   set.
2976 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
2977   explode.  Add in a missing "mv" in the command for installing tcl8
2978   documentation.
2980 CSharp:
2982 * Fix rule handling parallel make to include xapian_wrap.h
2984 PHP:
2986 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
2987   doesn't seem to be a standard location, but this works for Debian at
2988   least, and it seems better to at least try to install it.
2990 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
2991   prefix for PHP4.
2993 Python:
2995 * Fix a threading problem: the GIL was not being acquired in the exception
2996   handling code before setting the Python exception state, leading to
2997   various memory corruption symptoms in threaded programs.
2999 * Add special iterators to Database for synonyms, synonym_keys and
3000   spellings.
3002 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
3003   synonym iterators and spelling iterators.
3005 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
3006   the expected description to make the tests more readable.
3008 Xapian-bindings 1.0.1 (2007-06-11):
3010 Documentation:
3012 * NEWS: Fix the recent headings which said "Xapian-core" to say
3013   "Xapian-bindings".
3015 General:
3017 * Wrap Xapian::Query constructor for creating ValueRange queries.
3019 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
3020   which take a prefix.
3022 Packaging:
3024 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
3025   %{buildroot} prefix on most files which we then have to work around.
3027 CSharp:
3029 * SimpleIndex now uses Xapian.TermGenerator.
3031 * SimpleSearch now uses Xapian.QueryParser.
3033 * New SimpleExpand example.
3035 * Document explicitly how STEM_SOME constants are currently wrapped.
3037 * Update GetTermName() reference in documentation to GetTerm().
3039 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
3040   their CVS repo, and the fix should be in their 0.8.2 release.
3042 Java:
3044 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
3045   looked at, but in fact its value was read but ignored.  We now use it as the
3046   first place to look for jni.h.
3048 * configure will now automatically add an extra "-I" for the
3049   linux/solaris/win32 subdirectory which Sun's JDK requires.
3051 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
3052   "precious" so their values are preserved for when configure is automatically
3053   rerun.
3055 PHP:
3057 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
3059 * The PHP examples have been rewritten to be clearer and to make use of the
3060   new XapianTermGenerator class.
3062 Python:
3064 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
3066 * Add support for prefix-restricted pythonic allterms iterators.
3068 * Update documentation in a couple of places to refer to updated replacements
3069   for MSetIterator.
3071 * Change testsuite output to be more vim-friendly (vim should be able to jump
3072   to the right lines now).
3074 * __str__ on Xapian::Error now includes extra information in some cases (the
3075   error_string and context, if they are set).
3077 * python/smoketest.py: Eliminate uses of the legacy sequence API.
3079 * python/pythontest.py: The legacy sequence API is only supported for Python
3080   2.3 and later, so don't run tests for it when running under Python 2.2.
3082 * We now generate and install xapian.pyo as well as xapian.pyc.
3084 Ruby:
3086 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
3087   classes.
3089 * Add missing rename for the C++ TermGenerator::set_document() method so it can
3090   be used as "tg.document = doc" in Ruby.
3092 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
3094 Tcl:
3096 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
3097   feedback, based on C++ simpleexpand.cc.
3099 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
3100   TermGenerator class.
3102 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
3103   QueryParser class.
3105 * tcl8/docs/bindings.html: Document how constants are wrapped.
3107 * Update smoketest and examples to require version 1.0.0 - previously this
3108   required 0.9.6, which failed since TCL doesn't accept differing major
3109   version numbers.
3111 * pkgIndex.tcl is now generated by configure.
3113 Packaging:
3115 * The required automake version has been lowered to 1.8.3, so RPMs can now be
3116   built on RHEL 4 and SLES 9.
3118 Xapian-bindings 1.0.0 (2007-05-17):
3120 Documentation:
3122 * Document Unicode support for each language.
3124 * Assorted minor improvements and typo fixes.
3126 General:
3128 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
3129   it, for languages where SWIG supports directors.
3131 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
3132   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
3133   allows the "default_prefix" argument to be supplied, QueryParser flags
3134   FLAG_PURE_NOT and FLAG_PARTIAL.
3136 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3138 * Remove wrappers for deprecated features removed from the C++ API (see
3139   docs/deprecation.html in xapian-core for full details and upgrade
3140   information).
3142 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
3144 * QueryParserError is now a real error, so remove special handling for "const
3145   char *" exceptions.
3147 * Use a stamp file in "make" rules with multiple targets so that parallel
3148   make works.
3150 * configure: Now quotes $PYTHON, etc so that you can specify a program with
3151   arguments.
3153 * configure: If the user specifies a program which doesn't exist (e.g.
3154   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
3156 * configure: Disable probes for f77, gcj, and rc completely by preventing
3157   the probe code from even appearing in configure - this reduces the size of
3158   configure by 28% and should speed it up significantly.
3160 * configure: If the version check against the xapian-core version detects a
3161   mismatch, we now issue a warning rather than a hard error since if you're
3162   careful this can work.  The warning is issued late on in configure, so it's
3163   harder for the user to miss.
3165 * configure: The --with-swig option has been removed.  It no longer has a
3166   purpose as we now ship the files which are generated by SWIG.
3168 Portability:
3170 * The PHP bindings can now be built with MSVC for Microsoft Windows.
3172 CSharp:
3174 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
3175   than mcs to avoid segmentation faults at runtime due to unimplemented
3176   features in mcs.  Document this, and update configure to prefer gmcs.
3178 * The return type of MatchDecider::operator() is now `bool' rather than `int'
3179   (in line with the same change in the C++ API).
3181 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
3183 Java:
3185 * The Java bindings have been updated to use C++ replacements for deprecated
3186   methods, so they still build.  The Java wrappers still provide the old
3187   deprecated names for now though.  The longer term plan is to replace the
3188   hand-written JNI with SWIG generated wrappers (work has now begun on this)
3189   which is likely to require some API changes, and it seems more sensible to
3190   make any changes to align with C++ API changes at the same time.
3192 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
3193   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
3195 PHP:
3197 * Fix undefined behaviour in get_matching_terms().
3199 * Document the (existing) renaming of methods which are PHP reserved words
3200   (empty() to is_empty() and clone() to clone_object()).
3202 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3204 Python:
3206 * The Python bindings now throw exceptions as classes with a hierarchy which
3207   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
3208   base class inherits from the standard Python Exception class.
3210 * All Python methods which accept strings can now be passed either a unicode
3211   object or a simple string.  Strings are returned as simple strings: unicode
3212   input will be returned as utf-8 encoded output.  The documentation now
3213   contains a "Unicode" section.
3215 * The Python bindings should now be usable more efficiently from threaded
3216   Python applications since we now use SWIG's -threads option when generating
3217   them, so that the GIL is released during long-running Xapian operations
3218   (bug#137).
3220 * Most classes, methods, functions, etc now have docstrings which are either
3221   automatically extracted from the C++ documentation comments, or overridden by
3222   more appropriate versions.
3224 * Most of the Pythonic iterators now return an object instead of a sequence,
3225   which means they now lazily fetch the information which previously had to be
3226   fetched to put it in the sequence.  The old sequence API is supported for
3227   compatibility, but is scheduled for removal in Xapian 1.1.0.
3229 * Those Python iterators which have skip_to() methods now return the item
3230   skipped to, and next() will return the following item.  Previously, they
3231   returned None, and next() returned the item skipped to.  Several bugs in the
3232   skip_to() wrappers were fixed.
3234 * Because of the lazy access, some objects returned by iterators will raise
3235   an error if the lazy evaluation happens after the iterator has moved on
3236   (since the underlying Xapian API doesn't allow efficient access to the
3237   information in this situation).  The exact semantics are defined in the
3238   docstrings for each iterator.
3240 * Those Pythonic iterators which return only a list of terms now return
3241   simple strings, instead of a sequence or an object containing the term.  This
3242   is an incompatible change with earlier releases.  The affected iterators are
3243   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
3244   QueryParser.unstemlist.
3246 * The contents of an MSet can now be iterated in the standard Python way.
3247   The iteration will return MSetItem objects.  The __contains__ and __getitem__
3248   methods are also implemented, allowing the "in" and [] operators to work.
3249   MSet.__getitem__ is a synonym for MSet.get_hit.
3251 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
3252   so that lazy access to its attributes is supported.  MSetItem has some
3253   deprecated methods which mimic the MSetIterator interface to allow old code
3254   to work without modification until release 1.1.0.
3256 * MSetItem provides access to the collapse_key and collapse_count, which
3257   weren't accessible from the sequence returned by the iterators before this
3258   release.
3260 * Out-of-range access to MSets will now raise an IndexError - it used to
3261   cause undefined behaviour (usually a crash).
3263 * The Python testsuite is now much more extensive, and supports colour output
3264   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
3265   features are separated out, so that they can easily be removed when the
3266   features are removed.  The Python tests currently focus mainly on Python
3267   specific iterators and related functionality - general Xapian behaviour is
3268   tested by the C++ testsuite.
3270 * The pure Python code in the bindings now uses new-style classes, since we
3271   have required Python >= 2.2 since Xapian release 0.9.9.
3273 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
3274   instead.
3276 * The get_description() method which many classes support has been deprecated
3277   in favour of new more pythonic __str__ methods, so that the str() builtin can
3278   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
3280 Ruby:
3282 * We no longer regard the Ruby bindings as "beta quality", so remove the
3283   warning from their documentation.
3285 * Document that that C++ operator() becomes the method "call" in Ruby.
3287 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
3288   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
3290 Tcl:
3292 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
3294 Xapian-bindings 0.9.10.1 (2007-04-04):
3296 PHP:
3298 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
3299   default parameters.  The most notable case was a missing Query constructor
3300   which meant that QueryParser was unusable.
3302 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
3303   (which mostly seems to mean the MS Windows version).
3305 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
3306   seems to mean the MS Windows version).
3308 * Add note to the documentation that PHP examples are written for CLI version
3309   of PHP, but that the bindings work with any version.
3311 * Add check to all PHP examples that they are being run under a CLI version of
3312   PHP.
3314 Python:
3316 * simpleexpand.py: Print each term's expand weight as a floating point value,
3317   not an integer.
3319 Ruby:
3321 * INSTALL: document how to install Xapian's Ruby bindings in your home
3322   directory.
3324 Xapian-bindings 0.9.10 (2007-03-04):
3326 Java:
3328 * Under Mac OS X, automatically look in the standard location for jni.h,
3329   and automatically rename the JNI library we build to ".jnilib", as is
3330   required by the OS X JVM.
3332 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
3333   to add the linux header directory to the include path when using this JDK.
3335 * Add missing default constructor for RSet class - it's not much use without
3336   this!
3338 * Fix Enquire.getESet() to actually work.
3340 * Fix bug in ESetIterator.hasNext().
3342 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
3344 * Fix memory leak with some JVMs in the "Query from array" constructor.
3346 * Fix memory leak in Enquire.setQuery().
3348 * SmokeTest.java: Add regression tests for RSet default constructor,
3349   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
3350   Add feature tests for Enquire.getQuery(), and to make sure we get passed
3351   the right document in a java subclass of MatchDecider.
3353 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
3354   respective variables are set.
3356 PHP:
3358 * Update the documentation to fix out-of-date information and document the
3359   differences between the PHP4 and PHP5 wrappers.
3361 * Update the examples to use the new Object Oriented API, and provide versions
3362   for both PHP4 and PHP5.
3364 * Add a "simpleexpand" example.
3366 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
3367   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
3368   new name, but keep the old name for now for backward compatibility.
3370 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
3371   interpreter - this works with PHP5.
3373 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
3374   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
3375   directory may not exist and "make install" will create it.
3377 * configure: If zend.h isn't found and configure was run with "--with-php",
3378   exit with an error rather than automatically disabling PHP support.
3380 Python:
3382 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
3384 Packaging:
3386 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
3387   various "--without" options in a comment at the start of the .spec file.
3389 * RPMs: Remove "." from the end of the Summary.
3391 Xapian-bindings 0.9.9 (2006-11-09):
3393 Documentation:
3395 * Ship our custom INSTALL file rather than the generic one from autoconf which
3396   we've accidentally been shipping instead since 0.9.5.
3398 General:
3400 * Wrap Flint::open() and Flint::open_writable().
3402 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
3403   suitable).
3405 Python:
3407 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
3408   bit platforms with Python 2.5.
3410 Packaging:
3412 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
3414 * RPMs: The Python bindings now require Python >= 2.2.
3416 Portability:
3418 * configure: Remove unnecessary backticks from tclsh version test.
3420 Xapian-bindings 0.9.8 (2006-11-02):
3422 General:
3424 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
3425   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
3427 * The C++ method QueryParser::parse_query() current throws "std:string"
3428   exceptions if there's a parse error.  Previously the bindings didn't catch
3429   these.  Now we catch them and handle them as if they were exceptions of
3430   type Xapian::QueryParserError (in anticipation of this changing in
3431   xapian-core).  Added testcases for this for PHP, Python, and C#.
3433 * configure: Note that SWIG is only useful for Xapian developers in --help
3434   output.
3436 * configure: If we failed to find any languages to build for, give a more
3437   helpful message.
3439 CSharp:
3441 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
3443 Java:
3445 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
3446   work rather than using the cached failure of the first jni.h check.
3448 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
3450 * SmokeTest.java: Avoid gcj "set but not used" warning.
3452 PHP:
3454 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
3456 * smoketest4.php,smoketest5.php: Check the exception message given by the
3457   DocNotFoundError testcase.
3459 Python:
3461 * Drop support for Python 2.1.
3463 Xapian-bindings 0.9.7 (2006-10-10):
3465 Documentation:
3467 * NEWS: Fix the recent headings which said "Xapian-core" to say
3468   "Xapian-bindings".
3470 General:
3472 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
3473   configure.ac.
3475 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
3476   compiling SWIG generated code which makes the compiled modules a few percent
3477   smaller and perhaps a little faster.
3479 * Wrap the newly implemented transaction API.
3481 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
3482   (this option was supposed to be used to compile the Python bindings from
3483   0.9.3 onwards, but this wasn't actually working correctly).
3485 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
3487 * In maintainer-mode, "make clean" now removes the SWIG generated files
3488   which would otherwise only be removed on "make maintainer-clean".
3490 CSharp:
3492 * Xapian::MatchDecider can now be subclassed in C#.
3494 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
3495   to use it.  This has been fixed and a regression test added.
3497 * SmokeTest.cs: Added exception handling test.
3499 Java:
3501 * Correct two misuses of delete to delete[].  Fixes bug#78.
3503 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
3504   Debian and Ubuntu boxes at least.
3506 PHP:
3508 * We now generate class wrappers for PHP5.
3510 * We now generate proxy classes for PHP4, which is an incompatible change
3511   from previous versions of xapian-bindings.  A perl script to upgrade
3512   your scripts is included.
3514 * smoketest.php:
3516   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
3517     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
3519   + Rely on xapian.php to load the extension module for us.
3521   + Fix error messages to show PHP code, not Python code.
3523 * When running smoketest.php, pass the "-q" option to php, which suppresses
3524   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
3525   recent versions of PHP.
3527 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
3528   the PHP interpreter not to be found in some cases when it was actually
3529   available, but it's only used to run the smoketest not for building the
3530   bindings.
3532 Python:
3534 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
3535   and also report the check and its result to the user.
3537 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
3538   built, so add an explicit dependency so that this works reliably in parallel
3539   builds.  Fixes bug#77.
3541 * In examples and documentation, don't call the MatchDecider class/object
3542   "matcher", since we use the term "matcher" to mean something else in
3543   the library documentation.
3545 * smoketest.py:
3547   + Add test of exception handling.
3549   + Add test that MatchDecider can be subclassed successfully.
3551 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
3552   pythonic iterator class.
3554 Ruby:
3556 * Xapian::MatchDecider can now be subclassed in Ruby.
3558 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
3559   (with no "ruby" alias) on Ubuntu dapper at least.
3561 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
3562   since we may have less than 10 matches, so say "1-<N>" instead.
3564 * simplematchdecider.rb: Implemented.
3566 Tcl:
3568 * Implement saner exception handling for Tcl and document it.
3570 * smoketest.tcl:
3572   + Add check that xapian::Query_OP_ELITE_SET has the right value.
3574   + Rework how the smoketest gets run to eliminate special code for using
3575     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
3576     to be run using installed bindings, and also makes it a better example
3577     program.
3579   + Add test for exception handling.
3581   + Send error messages to stderr.
3583   + Add comment about Tcl storing zero bytes as \xc0\x80.
3585 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
3587 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
3588   used for the Tcl bindings.
3590 Xapian-bindings 0.9.6 (2006-05-15):
3592 Documentation:
3594 * INSTALL: Add section describing how to install without root access.
3596 General:
3598 * Updated to reflect the renaming of Xapian::xapian_version_string and
3599   companions to Xapian::version_string.
3601 * Wrap optional length parameter to Enquire::set_query().
3603 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
3604   consistency.  Keep get_document_id as an alias for now for backward
3605   compatibility.
3607 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
3608   probably a largely harmless error).
3610 * Stop SWIG from adding exception handling wrappers to the calls which return
3611   version strings, since they can't throw exceptions.
3613 * xapian.i: Removed superfluous "const" from return type "docid" which is just
3614   a typedef for an unsigned integer type.
3616 * configure: Add some missing "checking ..." messages so the user has more idea
3617   what is going on.
3619 * Language specific util.i files can now define
3620   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
3621   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
3622   are provided for each language.  This avoids needing to keep this
3623   information in two different places.
3625 * xapian.i: Uncomment commented-out parameter names and fix duplicate
3626   parameter names (for the benefit of bindings which use the parameter names,
3627   like the OO PHP5 patch for SWIG I'm working on...)
3629 Portability:
3631 * configure: Fix warning flags passed for Intel C++ compiler.
3633 CSharp:
3635 * We now support building with Portable.NET.
3637 * Note that the passing of strings from C# into Xapian and back isn't currently
3638   zero byte safe.  If you try to handle string containing zero bytes, you'll
3639   find they get truncated at the zero byte.
3641 * C# bindings now build and pass tests when srcdir != builddir.
3643 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
3644   always say "CSharp" instead.
3646 * Not all machines are set up to run compiled C# programs when invoked
3647   directly, so get configure to check if we can, and otherwise see if using
3648   mono or ilrun works.  If not, just skip the C# tests.
3650 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
3651   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
3652   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
3654 * Move the C# specific %rename list to csharp/util.i.
3656 * Store the strong name key in the key container so we reuse it for later
3657   builds.
3659 * Wrap the version functions as more sensible names and document them (and
3660   continue to provide the older undocumented names for now just in case anyone
3661   was using them.)
3663 * Set the version of XapianSharp.dll correctly when building a snapshot from
3664   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
3666 * SmokeTest.cs: Add test of version functions.
3668 Guile:
3670 * The Guile bindings don't work and aren't being actively worked on, so we're
3671   no longer including them in the distributed tarball to avoid disappointing
3672   users who notice a "guile" subdirectory.  It also makes the download smaller.
3674 Java:
3676 * Simplify (and improve portability of) run-java-test by using "libtool
3677   --mode=execute"'s -dlopen option.
3679 * Need to make sure "built" subdirectory exists or building from clean fails.
3681 * Fix "make check" to work when srcdir != builddir.
3683 PHP:
3685 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
3686   4.3.10), so use "php -n" and then set the options we specifically want using
3687   "-d".
3689 * Fix the smoketest invocation to work better when srcdir != builddir.
3691 * Look for PHP interpreter first in prefix given by "php-config --prefix".
3693 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
3695 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
3697 * smoketest.php:
3699   + Add test for version reporting functions
3701   + If a test fails, say which one to aid debugging.
3703   + Added simple test that zero-bytes are handled correctly when passing
3704     strings to and from Xapian.
3706 Python:
3708 * README: Note that Python bindings have been built with MSVC.
3710 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
3711   to make them executable (they don't have a #! line).
3713 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
3714   "mymatchdecider".  Add description of what this example does.
3716 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
3718 * smoketest.py: Added simple test that zero-bytes are handled when passing
3719   strings to and from Xapian.
3721 Ruby:
3723 * Added new Ruby bindings from Paul Legato.
3725 Tcl:
3727 * smoketest.tcl:
3729   + Add test for version reporting functions
3731   + If a test fails, say which one to aid debugging.
3733   + Added simple test that zero-bytes are handled correctly when passing
3734     strings to and from Xapian.
3736 Xapian-bindings 0.9.5 (2006-04-08):
3738 Documentation:
3740 * HACKING,README: Split off HACKING to contain information which is only
3741   relevant to those wishing to modify the bindings.
3743 General:
3745 * SWIG-based bindings are now built with SWIG 1.3.29.
3747 * configure: Report which languages we're building bindings for just before
3748   configure finishes.
3750 * xapian.i: Make the stub definitions for disabled backends static.
3752 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
3753   message.
3755 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
3757 Packaging:
3759 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
3760   Python bindings to support 64 bit systems.
3762 * RPMs: Package the C# bindings.
3764 Portability:
3766 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
3767   different name.
3769 * configure: Detect Intel's C++ compiler and set suitable warning flags to
3770   avoid noise from compiling generated code.
3772 CSharp:
3774 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
3776 Guile:
3778 * configure: Disable --with-guile since Guile support doesn't currently work.
3780 Java:
3782 * Override deprecation warnings for Xapian methods/functions/etc.
3784 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
3785   have some idea what went wrong!
3787 * Rework how we include headers to get hash_map to avoid compiler warnings
3788   since it's usually not in the std namespace nowadays.
3790 * Previously the "all" target also ran the "install" target, but this has
3791   proved very problematic, so change "make check" to use the uninstalled JNI
3792   glue library, and update the instructions to say that "make install" is now
3793   required.
3795 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
3796   .class files.
3798 * README: Note that some platforms need "-pthread" or similar flags.
3800 * Add a new Query constructor wrapper which take an OP_xxx and an array of
3801   Query objects.
3803 * Compiling a .java file to a .class file now deletes the .jar file to ensure
3804   it gets updated.
3806 PHP:
3808 * php -n avoids reading any php.ini, but the compiled in default may be to
3809   enable the dubiously named "safe_mode" which prevents dl() being used so
3810   "make check" fails.  So instead provide a very simple php.ini which turns off
3811   safe_mode and makes sure enable_dl is on.
3813 * Fix handling of bool parameters when resolving overloaded methods and/or
3814   default arguments.  This fixes Enquire_sort_by_value() to work when the
3815   second argument is specified.  Added regression test for this case.
3817 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
3819 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
3820   passed by reference.  Fixes bug#74.
3822 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
3823   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
3825 Python:
3827 * Use the fairly new "swig -O" option for the "modern" python bindings as
3828   it generates a smaller glue library and runs faster.  Some of the features
3829   enabled also work on python 2.1, so enable these for the "olde" bindings.
3831 * configure: Catch the case where the user has python installed but not the
3832   module "distutils.sysconfig" and explain that they probably need to install a
3833   python-dev or python-devel package.
3835 * "make check" now works in VPATH builds.
3837 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
3838   know which check it was!
3840 * smoketest.py: catch Exception objects and print them.
3842 * smoketest.py: Add feature tests for the various pythonic iterator
3843   wrappers
3845 * python/docs/bindings.html: Document the Pythonic iterators.
3847 * Fix TermIter not to try to read termfreqs or positions if they aren't
3848   meaningful for the current TermIter.
3850 Xapian-bindings 0.9.4 (2006-02-21):
3852 Documentation:
3854 * COPYING: Updated FSF address.
3856 General:
3858 * Wrap Stopper::get_description().
3860 * Wrap xapian_version_string() and related functions.
3862 Portability:
3864 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
3865   run from "make" too.
3867 PHP:
3869 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
3870   default on Windows).
3872 Python:
3874 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
3876 Xapian-bindings 0.9.3 (2006-02-16):
3878 Documentation:
3880 * README: Updated and expanded (now covers supported platforms, and lists
3881   criteria which bindings for an additional language need to fulfil before
3882   we're likely to accept them).
3884 * INSTALL: Updated and improved.
3886 * TODO: Move C#-specific TODO to top level so we can track to-do items for
3887   all languages.
3889 General:
3891 * configure: Change how the user selects which bindings to build.  If no
3892   --with* arguments are passed, then we default to building bindings we detect
3893   the required tools for (as before).  But instead of requiring the user to
3894   deselect all bindings they don't actually want, we now let them select the
3895   bindings they do want.  So "./configure --with-python" will only build the
3896   python bindings (and will fail if the required tools aren't installed).
3898 * Every wrapped method contains exception handling code.  The bulk of this
3899   is now factored out into a single helper function, which cuts the compile
3900   time by around a factor of 3 and halves the size of the stripped library
3901   (figures are for Tcl on x86_64).
3903 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
3904   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
3906 * configure: Bump required SWIG version to 1.3.28 and drop the special
3907   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
3908   SWIG to install the bindings - SWIG is run by the Xapian developers
3909   so these updated requirements are only relevant if you want to modify
3910   the bindings.
3912 * Eliminate separate Makefile in each examples subdirectory, which makes the
3913   build system simpler, smaller, and a little faster.
3915 * xapian.i: Include default constructors for all classes so that SWIG knows it
3916   doesn't have to use SwigValueWrapper for them, which makes the bindings code
3917   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
3918   std::pair<...>.
3920 * configure: Document special environmental variables which configure
3921   recognises.  Enhance handling of environmental variables so you can
3922   e.g. './configure PYTHON=python23' (previously you had to give a full
3923   path in such environmental variables or they would be ignored.
3925 Packaging:
3927 * RPM spec file:
3929   + Automatically detect the python version.
3931   + Rename "php4" references to "php".
3933   + Automatically detect the PHP extension directory.
3935   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
3937   + Add support for "--without php" and --without tcl8" options to rpmbuild.
3939 Portability:
3941 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
3942   10.3.  This is required to link the bindings, and it doesn't seem to be
3943   possible to link them on 10.1 or 10.2 anyway.
3945 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
3946   to be explicitly specified and libtool correctly handles platforms where it
3947   would have been implicitly linked with anyway.
3949 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
3951 * configure: Add missing ";;" on the last alternative in some case statements.
3953 * Only pass -no-undefined on platforms where it is required in order to link a
3954   shared library at all (it causes problems on Mac OS X in some cases).
3956 CSharp:
3958 * This release includes a lot of improvements for the C# bindings.  They're
3959   now pretty much on a par with the other language bindings.
3961 * Added documentation and examples.
3963 * Method and function names are now renamed to match C# conventions
3964   (e.g. from get_description() to GetDescription()).  This is obviously an
3965   incompatible change, but the C# bindings haven't been suitable for real world
3966   use prior to this release.
3968 * Optional parameters are now wrapped so no longer need be specified
3969   explicitly.
3971 * Overload ++ and -- for iterators.
3973 * Overload == and != for iterators.  Now comparisons with the end iterator
3974   work as expected, and SmokeTest passes.
3976 * SmokeTest now reports exceptions verbosely.
3978 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
3979   similarly for other database factory functions.
3981 * Heed compatibility warnings from mcs and use different forms for
3982   command-line switches to the C# compiler (presumably for compatibility with
3983   Microsoft's compiler, though the warnings don't actually say that
3984   explicitly).
3986 Guile:
3988 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
3989   zero-byte safe.  The guile bindings are still a long way from actually
3990   working though.
3992 Java:
3994 * Wrap optional second parameter (query length) to Enquire::set_query().
3996 * configure now probes for the Java path separator, which we then use to
3997   separate entries in the java -classpath command line option so we can
3998   build on platforms where it isn't ":".
4000 * SmokeTest.java: Expand to test more features.
4002 * java/README:
4004   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
4006   + Add note about how wrapped methods are named.
4008 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
4009   validity check.
4011 * Query.java: Comment out unused code.
4013 * Fixed memory leak in Query-from-array-of-strings constructor.
4015 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
4016   Xapian::Error subclasses can tell you their typename directly (using
4017   get_type()).
4019 PHP:
4021 * Some problems with overloaded methods in PHP have been fixed by a major
4022   overhaul of SWIG's PHP support.  So we no longer rename such methods
4023   for PHP.  This is an incompatible change, but it's easy to update your
4024   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
4026 * Previously the documentation and simpleindex.php suggested that you
4027   should call delete_CLASS().  This was incorrect and resulted in a
4028   double-free() in some cases, so we've fixed the documentation and
4029   examples and eliminated the delete_CLASS() wrappers.  This is another
4030   incompatible change, but again easy to update for.
4032 * We now support PHP5 as well as PHP4, so the configure test now looks
4033   for either and all references to "PHP4" or "php4" have been adjusted.
4035 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
4036   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
4037   warning and making the method return "Null".  This isn't ideal, but it's
4038   the best we can easily do without proper exceptions.
4040 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
4041   empty php.ini in srcdir (which we were failing to distribute anyway), use
4042   "$(PHP) -n" which tells PHP not to use any php.ini file.
4044 * Update PHP documentation to include new features.
4046 * Redo Xapian section in phpinfo() to look more like most other modules.
4048 * You can now construct a Query object from an array of strings or Query
4049   objects (or even a mixture).
4051 * PHP examples now give a more useful error message if a database can't be
4052   opened.
4054 * smoketest.php: Expanded the tests performed, including feature tests for
4055   the new Query-from-list constuctor.
4057 * simplesearch.php: Use newly wrapped Query-from-list constructor.
4059 * Use std::string::data() instead of c_str() as it may be more efficient for
4060   some STL implementations.
4062 * Enquire::get_matching_terms() now generates the PHP list directly from the
4063   TermIterator rather than constructing a temporary C++ std::list, which is
4064   faster and requires less temporary memory.
4066 Python:
4068 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
4069   once again (it has been broken since 0.9.0).  Added a regression test to
4070   help keep this working.
4072 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
4073   instead of a list).  Also the sequence can contain xapian.Query objects or
4074   strings or a mixture.  Documented these enhancements.
4076 * smoketest.py: Expanded the tests performed.
4078 * Convert C++ strings to python ones in a zero-byte clean way.
4080 * Added more error checking of the results of calls into the python
4081   interpreter.
4083 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
4084   itself is compiled with this option to avoid problems and it appears we ought
4085   to use it too to avoid the risk of hitting the same problems, although I'm
4086   not aware of anyone actually encountering such problems).
4088 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
4089   avoid creating a broken xapian.pyc is the shared library can't be loaded for
4090   some reason.
4092 * Enquire::get_matching_terms() now generates the Python list directly from the
4093   TermIterator rather than constructing a temporary C++ std::list, which is
4094   faster and requires less temporary memory.
4096 Tcl:
4098 * Terms with a leading underscore now work (thanks to changes in SWIG).
4100 * Implement custom typemaps for Tcl, so that you can now construct a Query from
4101   a list of Query objects and/or strings, and Enquire::get_matching_terms is
4102   now wrapped.
4104 * simplesearch.tcl: Use the new Query from list constructor.
4106 * simplesearch.tcl: Fix to lowercase and stem query terms.
4108 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
4110 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
4112 Xapian-bindings 0.9.2 (2005-07-15):
4114 General:
4116 * Added wrappers for new optional flags argument to QueryParser::parse_query().
4118 CSharp:
4120 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
4121   another tool with the same name.
4123 Java:
4125 * Include SmokeTest.java in the distribution so "make check" works.
4127 * Added success report for Sun java 1.4.1_01a.
4129 Python:
4131 * When converting a python list to vector<string> we know the number of elements
4132   so reserve that number in the vector.
4134 Xapian-bindings 0.9.1 (2005-06-06):
4136 General:
4138 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
4140 Tcl:
4142 * Updated documentation to include information from Michael Schlenker about how
4143   to delete a database object such that the destructor gets called.
4145 Xapian-bindings 0.9.0 (2005-05-13):
4147 General:
4149 * Updated SWIG-based bindings to latest Xapian API
4151 * Improve support for building the bindings on MS Windows:
4153   + Provide stub versions of any backend functions which are disabled in the
4154     library we're wrapping to avoid a link failure on MS Windows (where the
4155     remote backend is automatically disabled).  These stubs just throw
4156     Xapian::FeatureUnavailableError.
4158   + Add -no-undefined to *_la_LDFLAGS.
4160   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
4161     appropriate.
4163   + For python, paths for finding headers and installing libraries are now
4164     handled so they work on MS Windows; an extra static library needs to be
4165     linked in too.
4167 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
4168   for disabled backends).
4170 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
4171   being useful functionality.
4173 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
4174   introduced in future get fixed.
4176 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
4177   have.
4179 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
4180   1.3.22 for as more recent versions don't work with methods with optional
4181   arguments - the arguments become non-optional!)
4183 Guile:
4185 * configure: Disable guile by default, as it needs more work.
4187 Java:
4189 * Updated to compile against 0.9.0 API.
4191 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
4193 * Wrap optional parameters to Query(term) constructor.
4195 PHP4:
4197 * For PHP4, rename default Database constructor to Database_empty
4198   instead of suppressing the much more useful Database(const string &path)
4199   constructor.
4201 * Use a blank config file when running PHP4 tests to avoid problems
4202   when the bindings are already installed as an extension which is
4203   loaded automatically in the default config.
4205 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
4206   it probably just means it's not in PATH.  We only need it for running tests,
4207   so substitute a trivial shell script which just exits with code 77 so PHP
4208   tests are skipped (previously we substituted "missing" which caused the tests
4209   to fail).
4211 Python:
4213 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
4214   and ValueIter.
4216 * configure: If python is found, also check that Python.h exists (it may not be
4217   if the python-dev package (or similar) isn't installed).
4219 Xapian-bindings 0.8.5.1 (2005-02-23):
4221 General:
4223 * configure: Run compiler feature tests using the C++ compiler, not the C
4224   compiler.
4226 * Allow bindings version to have an extra "patchlevel", yet still match with
4227   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
4229 Java:
4231 * Added a missing .java source file and removed several unused ones.
4233 * Fixed several glitches in the java bindings automake build system.
4235 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
4236   warnings in generated code (we were carefully passing "-Wunused"
4237   which is the opposite of what is needed!)
4239 * Fixed a couple of warnings from GCJ.
4241 * Wrapped a few missing methods added since Eric created the bindings.  There
4242   are still some missing methods - there's now a (probably incomplete) list in
4243   java/README.
4245 * Added various useful bits of information to java/README.
4247 * Tweaked SimpleSearch.java to be more like the C++ version.
4249 PHP4:
4251 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
4252   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
4253   a more recent version.
4255 * configure: Check for "php" as a program name as well as "php4", and
4256   fall-back to missing so the error message from "make check" is better.
4258 Xapian-bindings 0.8.5 (2004-12-23):
4260 General:
4262 * INSTALL: Added non-generic installation instructions.
4264 Python:
4266 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
4267   the same directory as xapian.py, but Makefile.am was looking in current
4268   directory when installing it.  Additionally, VPATH builds were broken.
4269   These problems were introduced by changes in 0.8.4.
4271 Xapian-bindings 0.8.4 (2004-12-08):
4273 General:
4275 * README: Now clearly says which languages we currently support, which people
4276   are working on, etc.
4278 * Instead of requiring the user to have a really recent SWIG installed, ship
4279   the files SWIG generates.  Disable all the SWIG rules unless configure is run
4280   with --enable-maintainer-mode to make sure they aren't triggered accidentally
4281   (e.g. by make with dodgy VPATH).
4283 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
4284   needed if you just want to install the bindings).
4286 * Wrap the new Database and WritableDatabase constructors which replace
4287   Auto::open().
4289 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
4290   (for example, simpleexpand.py needs it).
4292 * In the Query constructor which takes a vector of terms, only call set_window
4293   if window is non-zero.  Otherwise things go wrong if we're passed an empty
4294   vector.
4296 * Second argument to Document::add_posting() isn't optional, but xapian.i
4297   indicated that it was.
4299 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
4300   Deriving your own weight class in the scripting language isn't currently
4301   supported.
4303 * xapian.i: %name is deprecated, so use %rename instead.  This also works
4304   around a bug in SWIG 1.3.23.
4306 * configure: Removed pointless probe for a C compiler - everything we compile
4307   is C++.
4309 * configure: Reinstated the check that the bindings version matches the version
4310   of the xapian library.  It was added in 0.8.2, but accidentally removed in
4311   0.8.3.
4313 * Use newly added option `xapian-config --swigflags` which (a) avoids always
4314   passing -I/usr/include which could cause problems if we're using a Xapian
4315   install not in /usr and there's another one in /usr and (b) avoids problems
4316   if `xapian-config --cxxflags` contains flags other than -I<something>.
4318 CSharp:
4320 * Richard Boulton has put together bindings for C#.  These build successfully
4321   with the Mono tools, but the smoketest currently fails.  Unclear if the
4322   problem is the bindings or the smoketest code.
4324 Guile:
4326 * The guile bindings now build successfully, so we've enabled the guile
4327   detection machinery in configure.  They're untested though (we don't
4328   know guile!) so success or failure reports are encouraged!
4330 PHP4:
4332 * Mention the example scripts near the start of the documentation, not right at
4333   the end.
4335 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
4336   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
4337   mention!
4339 Python:
4341 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
4342   work in Python.
4344 * Changed examples to use the newly wrapped Query from list of terms ctor.
4346 * Mention the example scripts near the start of the documentation, not right at
4347   the end.
4349 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
4350   SWIG.
4352 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
4353   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
4354   mention!
4356 * Mention simpleexpand example in documentation.
4358 * Examples now report messages for Xapian exceptions.
4360 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
4362 * Make the example MatchDecider exclude documents matching a value, rather than
4363   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
4364   don't want examples to mislead like that.
4366 * python/docs/bindings.html: Note that you can construct a query
4367   from a list of terms, even if you can't from a list of queries.
4368   Add HTML links to the examples.
4370 * simpleindex.py: Trim spaces from the start as well as from the end of each
4371   line.  Simplify the loop slightly.
4373 Tcl:
4375 * Wrap in a tcl8 namespace "Xapian".
4377 * Added a smoketest.
4379 * Translated simpleindex and simplesearch into Tcl.
4381 * Set the Tcl package version.
4383 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
4385 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
4387 * Added documentation for tcl8 bindings.
4389 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
4390   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
4391   version (was 8.0).
4393 * configure.ac: Noted that the bindings can easily be compiled for use with
4394   Tcl 8.0, in case anybody needs that for some reason.
4396 * Don't wrap the factory functions which return a quartz WritableDatabase as
4397   the destructor never gets called so changes aren't flushed and the lock file
4398   isn't removed.
4400 Xapian-bindings 0.8.3 (2004-09-20):
4402 General:
4404 * Fixed mismatching versions of libtool used to produce configure and
4405   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
4406   names.
4408 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
4409   PHP4, and Tcl bindings.
4411 Java:
4413 * Pass -classpath to javac to fix build problems.
4415 * Make sure errors subdirectory is built before we try to build the jar file.
4417 * Fixed "make install" to not give libtool error.
4419 PHP4:
4421 * Include PHP4 documentation and exmples in the tarball.
4423 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
4424   change from 0.8.2 - it turns out we only need to pass these flags if we use
4425   swig's -noruntime option (which we don't do).
4427 Python:
4429 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
4430   faster Python wrapper code.
4432 Tcl:
4434 * Don't install xapian.la.
4436 * Improved configure check for tcl.h to work with Fedora Core 2.
4438 Xapian-bindings 0.8.2 (2004-09-13):
4440 General:
4442 * Added wrappers for recently added methods: ESet::back() and
4443   Database::get_lastdocid(), and wrap the new optional third parameter
4444   to Enquire::set_sorting().
4446 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
4448 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
4450 * Wrap Quartz, InMemory, and Remote database factory functions as
4451   quartz_open(), inmemory_open(), and remote_open().
4453 * Added missing wrappers for static Stem::get_available_languages() and
4454   Stem::get_description().
4456 * Wrap renamed method Query::empty() (was Query::is_empty()).
4458 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
4459   as an alias for now).
4461 * Require autoconf 2.59 and automake 1.8.5.
4463 * configure: Added check that the bindings version matches the version of
4464   the xapian library.
4466 * configure: Check if we're using GCC and only pass GCC specific warning
4467   control options if we are.
4469 * configure: When running with GCC, also pass -Wno-uninitialized so the
4470   SWIG glue builds without warnings.
4472 * README: Updated list of languages which SWIG supports.
4474 PHP4:
4476 * Document that the 2 argument form of Xapian::Auto::open() for opening a
4477   writable database is wrapped as open_writable() (bug #32).
4479 * Include Xapian version in output from phpinfo().
4481 * Build the SWIG glue library like we build the others rather than using
4482   SWIG's -phpfull option.  This avoids problems with newer automake versions
4483   and means we can build against an uninstalled xapian library.
4485 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
4486   Fixed documentation of how Xapian::Query::OP_* are wrapped.
4488 * Use special SWIG PHP ldflags when linking the PHP glue library.
4490 * simplesearch.py now works with multi-term queries.
4492 * Added documentation on how to install the PHP4 bindings.
4494 * Added a simple testcase to at least ensure the PHP4 bindings can be
4495   initialised and some simple operations work.
4497 Python:
4499 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
4501 * Don't install _xapian.la and _xapian.a.
4503 * Byte compile xapian.py to xapian.pyc and install it.
4505 * Suppress SWIG warning about MatchDecider::operator() director discarding
4506   const.
4508 * "make clean" no longer leaves "xapian_wrap.h" behind.
4510 * Added a simple testcase to at least ensure the python bindings can be
4511   initialised and some simple operations work.
4513 Tcl8:
4515 * configure: Disable building tcl8 bindings if the headers are missing
4516   (probably because the tcl8.X-dev package isn't installed).
4518 Xapian-bindings 0.8.1 (2004-06-30):
4520 General:
4522 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
4524 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
4525   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
4526   doesn't emit -I/usr/include in this situation (because it causes problems
4527   with some GCC versions).
4529 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
4530   not just a subset.
4532 Java:
4534 * Removed wrappers for unused error classes which have been pruned from C++.
4536 * Make finalize() methods of Database and WritableDatabase public so they can
4537   be called from by the user.
4539 * Document Document.add_term_nopos() as deprecated.
4541 PHP4:
4543 * Make sure that PHP bindings build a module which exports get_module() so PHP
4544   is able to load it.
4546 * Configure now checks that phpize can actually be run, rather than just that
4547   it's executable (test -x isn't portable anyhow).
4549 * Added basic documentation and examples to PHP4 bindings.
4551 * Rename overloaded methods and constructors.
4553 * Add simple access to the prefixes map in QueryParser.
4555 * Correct simpleindex ports to never generate empty termnames.
4557 Python:
4559 * configure: Use $PYTHON instead of python when running python to determine
4560   library and include paths and version number.
4562 * Actually ship python examples and documentation.
4564 Xapian-bindings 0.8.0 (2004-04-20):
4566 * README: Started collecting information on supporting Xapian from even
4567   more languages.
4569 * Added configure tests to enable bindings only where the necessary tools
4570   are installed and have a supported version.  ./configure --without-LANGUAGE
4571   allows particular languages to be forcibly disabled.
4573 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
4575 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
4577 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
4578   have been well tested, but integration with the xapian-bindings configure
4579   system hasn't been tested at all - please alert us to any problems.
4581 * Xapian can now be used from TCL.
4583 * Python: MSet now provides a Python iterator.
4585 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
4587 * Python: enable directors for MatchDecider, to allow subclassing in Python.
4589 * Python: Added basic documentation, and some examples.