Update with NEWS from 1.4.7
[xapian.git] / xapian-bindings / NEWS
blob2aac8161aaaaadfba69f082fa382ddf8ab249a68
1 Xapian-bindings 1.4.7 (2018-07-19):
3 Ruby:
5 * Fix -Wconversion-null warnings with newer GCC.
7 Xapian-bindings 1.4.6 (2018-07-02):
9 Documentation:
11 * Stop using "probabilistic" to mean "weighted" - we've supported other
12   families of weighting schemes since 1.3.2.
14 Packaging:
16 * Use https for tarball URLs in .spec files.  This provides protection against
17   MITM attacks on people building packages using these spec files, and is also
18   slightly more efficient as the http: URLs redirect to the https: versions
19   anyway.
21 CSharp:
23 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
24   with older SWIG, but it does with current versions, and using it means that
25   we skip any return value translation logic when an exception has been thrown.
27 Java:
29 * Use SWIG_exception() to handle exceptions.  It seems this didn't used to work
30   with older SWIG, but it does with current versions, and using it means that
31   we skip any return value translation logic when an exception has been thrown.
33 * Fix leaks in binary std::string typemaps.  These are used for document values
34   and serialised data.
36 * Improve VPATH build.  Previously we looked for class files and java sources
37   in srcdir first, then in builddir.  That's backwards from how autotools
38   VPATH builds search for targets and prerequisites so reverse this order to
39   make handling of Java files more consistent.
41 Perl:
43 * Invoke prove via the App::Prove module.  This avoids potentially using
44   prove from a different Perl installation to perl (previously the user
45   needed to manually specify the corresponding PROVE= if they specify PERL= to
46   configure).  In particular this is useful on macOS when using Perl from
47   homebrew.
49 * Improve Perl Enquire::set_docid_order documentation by syncing improvements
50   from the C++ API docs.
52 Python:
54 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
55   James Aylett.
57 * Suppress clang -Wdeprecated-register warnings about uses register in C code
58   in Python.h.  We can't do anything about these other than suppress them.
60 Python3:
62 * Support sphinx >= 1.7 while still working with < 1.7.  Patch from
63   James Aylett.
65 * Suppress clang -Wdeprecated-register warnings about uses register in C code
66   in Python.h.  We can't do anything about these other than suppress them
67   (and they appear to have been removed in Python 3.4 and later).
69 * Remove unused MSet::__cmp__ extend method.  This was used in Python 2, but
70   Python 3 does things differently.  There doesn't seem a good reason to
71   provide comparison operations for MSet objects, and we don't for other
72   classes, so let's just drop this feature - it seems nobody has noticed it has
73   gone.
75 * Simplify generated wrapper post-processing.
77 Xapian-bindings 1.4.5 (2017-10-16):
79 Documentation:
81 * HACKING: Add details of Debian PHP7 packages to install for development.
83 General:
85 * Use a pattern match to ignore methods meant for internal use only rather
86   than having to list them all - they're consistently named to end with an
87   underscore.
89 * Stop using deprecated Xapian::percent typedef in bindings-specific code.
90   Deprecation warnings are suppressed when building the bindings (because the
91   bindings usually still need to wrap deprecated C++ features) so this probably
92   has no user-visible consequences.
94 Java:
96 * Fix JNI code to be compatible with Java 6 and earlier, where the final
97   parameter of SetByteArrayRegion() was not const.  This also seems to affect
98   GCJ (though GCJ was removed in GCC 7).  The incompatibility was introduced in
99   1.4.4.
101 Lua:
103 * Support subclassing of RangeProcessor in Lua.
105 Perl:
107 * Add CLONE_SKIP to RangeProcessor and subclases to avoid double deletion
108   if the Perl threads module is in use.
110 * Keep references for set RangeProcessor objects, like how we do for
111   ValueRangeProcessor and various other functor objects.
113 * Use RangeProcessor instead of ValueRangeProcessor in perl examples, as
114   ValueRangeProcessor is now deprecated.
116 PHP:
118 * Keep references for set RangeProcessor objects, like how we do for
119   ValueRangeProcessor and various other functor objects.
121 * Add type hints to QueryParser::add_rangeprocessor().
123 PHP7:
125 * Keep references for set RangeProcessor objects, like how we do for
126   ValueRangeProcessor and various other functor objects.
128 * Add type hints to QueryParser::add_rangeprocessor().
130 * Fix PHP7 "make check" to use right path separator.  It was using the PHP5
131   one, which in general is going to be the same but we won't have probed for
132   that unless we're also building the PHP5 bindings, which means "make check"
133   failed for PHP7 unless you also had the PHP5 bindings enabled.
135 Python3:
137 * Fix "make check" under Python 3.2, which was broken in 1.4.4 because Python
138   3.2 doesn't support the u'foo' syntax.
140 * Copy over Python2 check which aims to catch any internal functions, methods,
141   constants, etc which have accidentally been wrapped.
143 Ruby:
145 * Fix dependency generation for Ruby SWIG command (only relevant at all if
146   you configure with --enable-maintainer-mode).
148 Xapian-bindings 1.4.4 (2017-04-19):
150 General:
152 * Update tests for xapian-core changes to avoid unnecessary "0 *" in query
153   descriptions in certain cases.
155 Packaging:
157 * Ship java.i in tarball.
159 Java:
161 * Handle object serialisations and document values as Java byte[].  These will
162   usually contain binary data, so Java String doesn't work well and byte[] is a
163   much better fit.
165 * Correct various errors in java examples and documentation on how to run them.
167 * Fix java examples not to abuse doc values as fields - use the document data
168   instead.
170 * "make clean" now removes additional class files.
172 PHP7:
174 * Update version of SWIG required to >= 3.0.12 so that the code generated
175   for PHP7 no longer results in a segmentation fault on module unload with
176   PHP 7.1.  Fixes #748, reported by Victor Sakovich.
178 Python:
180 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
181   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
182   https://bugs.debian.org/849722
184 * Fix configure --with-python to fail if sphinx isn't found.  Patch from
185   Patricio Paez.  Fixes #749.
187 Python3:
189 * Fix QueryParser methods add_boolean_prefix() and add_prefix() to accept a
190   string for the `grouping` parameter.  Reported by Jameson Graef Rollins in
191   https://bugs.debian.org/849722
193 Xapian-bindings 1.4.3 (2017-01-25):
195 Python:
197 * Remove compatibility code for Python < 2.5 - 1.4.x requires Python >= 2.6.
199 * Avoid unnecessary pointer indirection in XapianSWIG_anystring() helper
200   function, which should be a little more efficient and makes the Python 2
201   code more closely match the Python 3 code.
203 Ruby:
205 * "make clean" should only remove docs/xapian.rb if configure option
206   --enable-documentation was used to enable all rules to rebuild documentation.
207   Reported by Samuel Williams on xapian-discuss.
209 * Fix make rule for running rdoc for the cases where srcdir != builddir.
211 * Use 'test a = b' rather than 'test a == b' - the former is portable, the
212   latter a bashism.  In many cases the autotools will set SHELL = /bin/bash in
213   the makefiles, but if it doesn't and /bin/sh isn't bash, then this will
214   cause "make install" and "make uninstall" to fail for the Ruby bindings.
216 Xapian-bindings 1.4.2 (2016-12-26):
218 General:
220 * configure: Fail with clear error with xapian-core < 1.4.0.
222 * Work around OS X "System Integrity Protection".  We can't address the problem
223   of being unable to run tests against an uninstalled tree when the interpreter
224   is in a system directory (you have to "make install" in xapian-core for that
225   case), but we can at least make this work for interpreters which aren't in
226   system directories.
228 Java:
230 * Disable parallel make for java subdirectory as it causes random build
231   failures.  Reported by Lucas Nussbaum in https://bugs.debian.org/848733
233 * Disable automatic use of -Xcheck:jni for now as it seems to report false
234   positives with OpenJDK 8 and 9.
236 PHP:
238 * Generates smaller PHP wrappers by only emitting each unique arginfo
239   combination once (~6% saving in stripped extension module size for
240   PHP7 on x86_64 Linux).
242 * Fix to work again with a version of PHP5 built with ZTS enabled (which is the
243   default on Microsoft Windows).
245 * Add support for PHP7.
247 * Drop workaround for PHP4 from test code.
249 Python:
251 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
252   from a command line Python code snippet.  Reported by Alex Dunn in
253   https://github.com/xapian/xapian/pull/126 and solved with help from James
254   Aylett.
256 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
257   need to keep such a reference (as we already do for ValueRangeProcessor and
258   several other classes).
260 Python3:
262 * Handle sphinx-build being a shell script wrapper by invoking sphinx.main()
263   from a command line Python code snippet.  Reported by Alex Dunn in
264   https://github.com/xapian/xapian/pull/126 and solved with help from James
265   Aylett.
267 * Hold python reference to set RangeProcessor objects - until #714 is fixed we
268   need to keep such a reference (as we already do for ValueRangeProcessor and
269   several other classes).
271 Ruby:
273 * Use more conventional Ruby variable names in the examples (Ruby convention
274   uses underscores not camelcase) and fix comma/space transposition in a couple
275   of places.
277 Xapian-bindings 1.4.1 (2016-10-21):
279 Documentation:
281 * Fix --disable-documentation - in maintainer-mode, we still tried to make
282   docs/index.html for most of the bindings, which failed because the rule to do
283   so was disabled.
285 General:
287 * Update for additions to C++ API.
289 * When a backend is disabled in the xapian-core we're building against, we
290   have a stub version of any factory functions so the bindings still have
291   something to wrap.  Update these for 1.4:
292   + Disable stub for InMemory::open() when
293     XAPIAN_BINDINGS_SKIP_DEPRECATED_DB_FACTORIES is defined (Perl, Python3).
294   + Add new optional flags parameter to both overloaded forms of
295     Remote::open_writable().
297 Portability:
299 * Drop compiler options that are no longer useful:
300   + -fshow-column is the default in all GCC versions we now support
301     (checked as GCC 4.6).
302   + -Wno-long-long is no longer necessary now that we require C++11 where
303     "long long" is a standard type.
305 Java:
307 * Use a cleaner technique to insert the Java code to load JNI library into the
308   generated wrapper - we now use "%pragma(java) jniclasscode" instead of using
309   Perl to post-process the generated wrapper.  Suggested by James Aylett.
311 * Run Java tests with -Xcheck:jni if supported, which should help catch any
312   any bugs in the JNI code.
314 * Fix configure to find jni_md.h under Cygwin.  There doesn't seem to be an way
315   to automatically determine the machine-dependent JNI include path, so add
316   another case to use "win32" on Cygwin.  Reported by John Bankert on
317   xapian-discuss.
319 * Add more special cases to find jni_md.h on Cygwin, OS X, *BSD, AIX.
320   There doesn't seem to be an explicit list of these directories anywhere, but
321   grepping the OpenJDK 8 source code finds additional values "darwin" and
322   "aix", *BSD seems to use "bsd", and Cygwin uses "win32" (reported by John
323   Bankert on xapian-discuss).
325 * Generate xapian.jar rather than xapian_jni.jar - the fact that JNI is
326   involved is really just an implementation detail.
328 * SmokeTest.java: Add simple test of subclassing FieldProcessor.
330 Perl:
332 * Merge Perl POD doc improvements from Search::Xapian.  The most notable
333   improvement is a number of methods previously lacking docs now have them.
335 * Fix typo in POD docs for Perl bindings ("outputing" -> "outputting").
336   Reported by knowledgejunkie in #730.
338 Python:
340 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
342 * Fix Python2 bindings to work out of the box.  SWIG changed the code it
343   generates for importing the compiled module in a recent version, and
344   the newer code no longer works with the wrapper renamed to
345   xapian/__init__.py.  There's currently no way to configure SWIG to produce
346   what we need so for now we run a "fixup" script over the generated wrapper
347   which replaces the complex import code with a single statement which does
348   what we want.  It also strips out various unneeded code, mostly to do with
349   handling Python 3.x (which we don't need since we have an entirely
350   separate set of bindings for that).  Reported by James Aylett in #731.
351   The way we were importing the bindings to generate the .pyc and .pyo
352   files was masking this problem, so rework that as suggested by James.
354 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
355   parallel builds (make -j) may attempt to schedule the sphinx doc build before
356   the relevant wrapper has been compiled and moved into position.  This won't
357   result in a build failure, but will silently omit API docs that sphinx
358   would otherwise include.  Patch from James Aylett.
360 * doxy2swig: Specify encoding when reading doxygen's XML output so UTF-8 in
361   doxygen comments is handled.  Patch from Vivek Pal.
363 * Specify Python2 wrapper encoding is UTF-8.  This is needed when we pick up
364   doxygen comments from the C++ API which contain UTF-8.  For Python3, the
365   default source encoding is UTF-8, so we don't need the equivalent change
366   there.
368 Python3:
370 * Fix repr() to not return None.  Reported by Stuart Prescott on IRC.
372 * Fix Python3 bindings to work out of the box.  SWIG changed the code it
373   generates for importing the compiled module in a recent version, and
374   the newer code no longer works with the wrapper renamed to
375   xapian/__init__.py.  There's currently no way to configure SWIG to produce
376   what we need so for now we run a "fixup" script over the generated wrapper
377   which replaces the complex import code with a single statement which does
378   what we want.  It also strips out various unneeded code, mostly to do with
379   handling Python 2.x (which we don't need since we have an entirely
380   separate set of bindings for that).  Reported by James Aylett in #731.
381   The way we were importing the bindings to generate the .pyc and .pyo
382   files was masking this problem, so rework that as suggested by James.
384 * Make sphinx docs dependent on SWIG wrapper.  Without this dependency,
385   parallel builds (make -j) may attempt to schedule the sphinx doc build before
386   the relevant wrapper has been compiled and moved into position.  This won't
387   result in a build failure, but will silently omit API docs that sphinx
388   would otherwise include.  Patch from James Aylett.
390 * Fix memory leak converting string from Python to C++.
391   XapianSWIG_anystring_as_ptr() was failing to flag the returned value as
392   allocated, so it wasn't being deleted.  Reported by Sean Robinson in #729.
394 Xapian-bindings 1.4.0 (2016-06-24):
396 Documentation:
398 * Mark SWIG-generated Java and Perl bindings as "experimental" until we've
399   had a chance to sort out any remaining changes we want to make.
401 Xapian-bindings 1.3.7 (2016-06-01):
403 Documentation:
405 * Remove long out-dated reference to tinderbox.
407 General:
409 * Use SWIG 3.0.9 to generate the bindings.  There's nothing very important to
410   us in the changes since the git snapshot we were using - mostly this means
411   we're using a released version, which seems preferable.
413 Tcl:
415 * Fix segfault in tcl bindings "make check".  The location of tclConfig.sh
416   wasn't being found, so libtclstub wasn't being linked to, which is required
417   with Tcl >= 8.6.
419 Xapian-bindings 1.3.6 (2016-05-09):
421 General:
423 * Update for changes to the C++ API.
425 * Use WritableDatabase::commit() instead of flush() in testcases, as the
426   latter is now formally deprecated.
428 Java:
430 * Fix syntax error in SmokeTest.java, introduced by the DB_BACKEND_INMEMORY
431   change.  Noted on #xapian-discuss by Aakash Muttineni.
433 * Update Java TODO list.
435 * SmokeTest.java: Port over version checks from SmokeTest.cs.
437 * Update list of recently tested JDK versions.
439 Lua:
441 * Note Lua bindings work with Lua 5.3.
443 Perl:
445 * Explicitly specify POD docs encoding as utf8.  Fixes warning in generated
446   HTML docs.
448 * Convert POD to HTML when building from a source tarball - the conversion
449   code comes as standard with Perl.  In 1.3.5 we were failing to ship the HTML
450   output, as reported by Anthony Basile.
452 * For extra robustness, convert POD to HTML using the bundled Pod::Html module
453   from the Perl interpreter found by configure, rather than assuming pod2html
454   is on PATH, and the right one (this matters more now that it's not just
455   people building from git who build these docs).
457 * Improve Perl bindings POD documentation.
459 * Remove workaround for Perl macro vs C++11 header.  SWIG 3.0.6 and later adds
460   a different workaround to the generated C++ wrapper file, and we require SWIG
461   3.0.8 for a Python fix, so we no longer need our workaround.
463 Python:
465 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
466   system, so I'm guessing this is now required due to a change in the code SWIG
467   generates.
469 Python3:
471 * Fix "make check" in VPATH build.  Nothing seems to have changed in our build
472   system, so I'm guessing this is now required due to a change in the code SWIG
473   generates.
475 * Fix install location for python3 docs.  They were being install to the same
476   path as the python docs - now the path includes "python3" instead of
477   "python".
479 Ruby:
481 * Increase minimum Ruby version to 2.1, as older versions are no longer
482   supported by the Ruby developers.
484 Xapian-bindings 1.3.5 (2016-04-01):
486 This release includes all changes from 1.2.23 which are relevant.
488 Documentation:
490 * Fix to install docs when not in maintainer-mode.
492 * Note open_stub() is deprecated (most of the bindings already noted this, but
493   now ruby and tcl do too).
495 General:
497 * Update for changes to the C++ API.
499 * PostingSource is now fully wrapped for the bindings.  Fixes #499, reported by
500   Joost Cassee.
502 * Ship swig-depcomp and doxy2swig scripts in the source tarball.
504 * Add installcheck-local make targets for most languages - these run the
505   testsuites using the installed bindings.
507 CSharp:
509 * configure: Stop checking for obsolete mono compiler names - gmcs, smcs and
510   dmcs were all deprecated in Mono 2.11.
512 * configure: Strip out handling of DotGNU - it's been inactive for years, and
513   was officially "decommissioned" in December 2012.
515 * README: Update list of mono versions recently tested with.
517 Lua:
519 * smoketest.lua: Fix to work with newer lua - coercing a number to a string
520   now appends ".0" for whole numbers.
522 Perl:
524 * Run pod2html with explicit --podpath=. - recent versions of pod2html seem to
525   need this to correctly handle references to other Xapian classes.  Reported
526   on #xapian-discuss by HowManny and abhishek_rand0wn.
528 Python:
530 * Run sphinx at build time.  It's an extra tool for people building from source
531   to have to install, but its output is rather large (this change reduces our
532   tar.xz size by ~20%), and its output includes a source-less minified copy of
533   jquery.
535 Python3:
537 * Run sphinx at build time.  It's an extra tool for people building from source
538   to have to install, but its output is rather large (this change reduces our
539   tar.xz size by ~20%), and its output includes a source-less minified copy of
540   jquery.
542 * Fix handling of integer values larger than a C int by bootstraping with a
543   newer version of SWIG.  Fixes #703, reported by Barry Warsaw.
545 * Remove xapian.inmemory_open() - we've deprecated the corresponding C++
546   function, and the Python3 bindings haven't yet had a stable release.
548 Ruby:
550 * Run rdoc at build time - it is included as part of the Ruby core
551   distribution, so we can assume it is available if ruby is, and avoid shipping
552   its rather large generated output in our source tarball.
554 Xapian-bindings 1.3.4 (2016-01-01):
556 This release includes all changes from 1.2.22 which are relevant.
558 Documentation:
560 General:
562 * Wrap new and changed features in C++ API.
564 * PostingSource set_maxweight() is now accessible to the bindings.  Fixes #498,
565   reported by Richard Boulton.
567 * configure script now defaults to looking for xapian-config-1.3.  This is now
568   automatically done for development series (odd middle component of the
569   version number), but not for stable series (even middle component).  Fixes
570   #695, reported by Jorge C. Leitão
572 PHP:
574 * Make PHP 5.5 the minimum officially supported version, as 5.4 has now reached
575   EOL.
577 * In the examples, when iterating an MSet with foreach, don't throw the docid
578   away as $dummy, put it in $docid and use it - the code looks cleaner, and
579   this avoids an extra call to C++ to get the docid on each iteration.
581 Python:
583 * Drop support for Python 2.5.
585 Python3:
587 * Document installation of Python 3 bindings.  Fixes #694, reported by Jorge C.
588   Leitão.
590 * Fix testsuite for changes in Python 3.5.  Fixes #690, patch from UsusDei.
592 * Handle renaming of .pyo to .opt-1.pyc files due to PEP-0488.  Fixes #689,
593   patch from UsusDei.
595 * Fix Python 3 version check to accept 3.10.
597 Xapian-bindings 1.3.3 (2015-06-01):
599 This release includes all changes from 1.2.20-1.2.21 which are relevant.
601 Documentation:
603 * INSTALL: IRIX is past EOL so drop information about IRIX make.
605 General:
607 * Add DB_RETRY_LOCK as a constant to wrap.
609 * Don't wrap Query::LEAF_* - they're for internal use in xapian-core.
611 * Fix "make install" from a git tree configured with --disable-documentation.
612   (Fixes #658, reported by Germán M. Bravo)
614 * Fix "make install" when building from git with --disable-documentation.
616 * Fix to handle a VPATH build from a tarball when the generated docs will be in
617   $(srcdir).
619 * Update testcases for lazy wildcard expansion change in xapian-core.
621 * Update for addition of XAPIAN_NOEXCEPT.
623 * Don't wrap internal methods of Xapian::Weight.
625 Portability:
627 * Require a compiler with good C++11 support, like xapian-core now does.
629 * doxygen_xml.conf.in: Update to avoid warnings about obsolete tags from newer
630   doxygen.
632 * configure: Update check for -fvisibility to match xapian-core's.
634 CSharp:
636 * Fix configure test for whether $CLI can run CSharp programs - previously it
637   would always fail, which would mean that the CSharp tests wouldn't be run on
638   platforms where CSharp programs can't be run directly.
640 Java:
642 * java/docs/examples/SimpleSearch.java: Update to actually build and work.
644 Lua:
646 * The Lua bindings are no longer considered to be "experimental" (in reality
647   they haven't been for some time).
649 Perl:
651 * Add a "LICENSE" section to the main POD.
653 * Add 'use strict' to all testcases, and add missing instances of 'my' that
654   this change uncovered.
656 * Wrap new WILDCARD_LIMIT_* constants as constants.
658 Python:
660 * Don't release the GIL when constructing a Query object from a sequence of
661   Query objects and/or strings.
663 * python/smoketest.py: Add new testcase to catch any internal functions,
664   methods, constants, etc which have accidentally been wrapped.
666 Python3:
668 * The Python3 bindings are no longer considered to be "experimental".
670 * Don't release the GIL when constructing a Query object from a sequence of
671   Query objects and/or strings.  (fixes #346)
673 * python3/pythontest.py: Expand comment about disabling test_import_star under
674   threads.
676 Tcl:
678 * Require Tcl 8.5 as older versions are no longer supported upstream, and this
679   version added ::tcl::pkgconfig, which makes the configure tests simpler and
680   more reliable.
682 * Adjust precedence of the typecheck typemap for wrapping constructing a query
683   from a Tcl list so that we disambiguate this from the new OP_WILDCARD
684   constructor correctly.
686 Xapian-bindings 1.3.2 (2014-11-24):
688 This release includes all changes from 1.2.16-1.2.19 which are relevant.
690 Documentation:
692 * Convert HTML docs to reStructured text.  (Patch from Mayank Chaudhary)
694 * Update for deprecation of Xapian::Chert::open().
696 * Update for renaming of "brass" backend to "glass".
698 * Remove SVN "$Date" placeholders as they aren't expanded by git, and the "last
699   updated" information isn't all that informative anyway - there can still be
700   stale information even if the file was updated very recently.
702 General:
704 * Releases and snapshots are now bootstrapped using a more recent version of
705   SWIG (a git snapshot from after the 3.0.3 release).
707 * configure: Fix SWIG version check to accept 3.x, and update the minimum
708   accepted version to be what we actually currently want.
710 * Wrap new C++ API features, and in particular all the new weighting schemes,
711   the changes to opening databases, and Xapian::Snipper.
713 * Wrap Xapian::Database::check() for the bindings ignoring the std::ostream*
714   argument which the C++ API takes.  If opts != 0, then output is sent to
715   stdout, otherwise no output is produced.
717 * Object descriptions are now always valid UTF-8. (see #620)
719 * Provide a SimpleStopper constructor which provides the ability to initialise
720   from a stopword list in a file.  Based on patch from Assem Chelli.
722 CSharp:
724 * README: Note that C# bindings now need .NET 2 or later (because that's what
725   SWIG-generated code now requires).
727 Java:
729 * Add testcase that FLAG_SPELLING is now wrapped in a usable way.  Patch from
730   Anish Kanchan.  (see #616, reported by "Naveen")
732 Lua:
734 * Document that constants can now be accessed using CLASS.CONSTANT as well as
735   CLASS_CONSTANT.
737 Perl:
739 * Move the new SWIG-based Perl bindings into a 'Xapian' module, to smooth the
740   overlap with the hand-coded XS 'Search::Xapian' module.
742 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
743   during parallel builds.
745 * Use croak_sv() or ERRSV if defined.
747 PHP:
749 * Make PHP 5.4 the minimum version we officially support, as 5.3 has now
750   reached EOL.
752 * Wrap Xapian iterator classes as PHP iterators - requires PHP 5.5 for full
753   support, under PHP 5.4 you can't use `foreach ($it as $k => $c)`, but
754   `foreach ($it as $c)` works and allows iterating through the equivalent of
755   C++ operator* on the iterator.  (fixes#652)
757 * Fix handling of an exception thrown from a PHP implementation of
758   FieldProcessor::apply().
760 * smoketest.php: Add tests of get_eset() with an ExpandDecider and with a min
761   weight threshold.
763 * In current PHP releases, dl() is disabled in most SAPIs, and even where
764   available it will now only look in the configured extension directory.  The
765   upshot is that there no longer seems to be a sane way to install the PHP
766   bindings without being root.  Fixes #661, reported by Felix Ostmann.
768 Python2:
770 * The python testsuite already tested if any constants weren't marked with
771   the CONSTANT macro in xapian-headers.i, but the resulting error didn't
772   clearly point to the actual problem.  Now we report the names of any
773   such constants.
775 * In the testsuite, use the xapian.WritableDatabase constructor rather than
776   chert_open() - that code dates back to when chert was the only disk-based
777   backend to support valuestreams, but flint was the default backend.
779 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
780   Germán M. Bravo in github PR59.
782 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
784 Python3:
786 * Python 3 support has been split off into its own subdirectory, and should now
787   be usable.  3.2 is the minimum supported version currently.  Existing code
788   will need updating for Python 3, and the wrapped API is necessarily different
789   in how Unicode is handled, so we've dropped deprecated features (such as
790   'MSet.items' and 'ESet.items') from the Python 3 bindings.  (see #346)
792 * Fix typo in code to keep a reference to a FieldProcessor object, reported by
793   Germán M. Bravo in github PR59.
795 * Generate Python API docs with Sphinx.  (Fixes #138, patch from Assem Chelli)
797 Ruby:
799 * configure: Don't prefer ruby1.8 to ruby when looking for a ruby interpreter -
800   these days it's more likely to ignore ruby 1.9 or 2.0 rather than avoid
801   picking ruby 1.6.
803 Xapian-bindings 1.3.1 (2013-05-03):
805 This release includes all changes from 1.2.10-1.2.15 which are relevant.
807 Documentation:
809 * HACKING: Document Debian packages needed for each language.
811 General:
813 * Wrap new C++ API features.
815 * Use new XAPIAN_NOTHROW markers in C++ API headers to avoid generating
816   unnecessary exception handling code where we call such functions and
817   methods.
819 * Tweak wrapping of Query from list constructor so the needed number of
820   elements get preallocated.
822 * Ignore Query(Query::Internal&) constructor, which is for internal use
823   only.
825 * For all languages except C# and Java, wrap the functions declared in
826   xapian/dbfactory.h by getting SWIG to parse the header.  This means we now
827   wrap the WritableDatabase form of Xapian::Auto::open_stub() for these
828   languages.
830 * swig-depcomp: Script which wraps invoking SWIG, tells it to generate
831   dependencies, and adjusts the generated dependencies to work in our build
832   system.
834 * Remove support for 'configure --enable-quiet', 'make QUIET=' and 'make
835   QUIET=y' - automake now supports 'configure --enable-silent-rules', 'make
836   V=1' and 'make V=0' which are broadly equivalent and more standard.
838 * Fix the tests to work with the new automake parallel test driver.
840 Portability:
842 * Improve workaround which allows building against an uninstalled xapian-core
843   on OS X - this should now work with any uninstalled xapian-core (not only in
844   a tree with the same layout as an SVN or git checkout) and it also won't try
845   to build against "../xapian-core/.libs" just because it happens to exist.
846   (Fixes #322)
848 CSharp:
850 * configure: The variable to specify the interpreter is now CLI (was MONO, but
851   didn't actually work properly).
853 Java:
855 * Document that we aim to support JDK 1.6 (Java 6) and later.
857 * Avoid generating a temporary C++ vector of Query objects when constructing
858   a Query from a Java array of Query objects or a Java array of strings.
860 * Implement and test MSetIterator, ESetIterator.  Fix PostingIterator,
861   ValueIterator, and TermIterator.
863 * Add Enquire.getMatchingTerms().
865 * Use JAVACFLAGS when running JAVAC to allow extra flags to be specified when
866   building, e.g. "make JAVACFLAGS=-g".
868 * java/SmokeTest.java: Avoid using System.err.printf() which fails to compile
869   with (the rather elderly) ECJ 3.3.1.
871 Perl:
873 * Fix PostingIterator wrapper to work.
875 * Update list of unwrapped things in POD documentation.
877 * Improve test coverage.
879 * perl/t/10query.t: Adjust regexp which checks expected error message to work
880   with Perl 5.16, which adds a '.' after "at foo line 123".  (ticket#610)
882 * Probe for the test running tool 'prove' in configure.
884 PHP:
886 * Avoid using zend_error_noreturn() as it doesn't work with all builds of PHP.
887   Instead we now wrap it in a SWIG_FAIL() function which we annotate as
888   "noreturn" for GCC to avoids warnings.  This also reduces the size of the
889   compiled PHP module by 6%.
891 * php/smoketest.php: Add more tests of geospatial API.
893 Python:
895 * Drop support for Python 2.4.
897 * python/smoketest2.py: Add more testcases.
899 * python/smoketest2.py: Improve reporting of test failures for certain
900   testcases.
902 * Update Python 3 tests from Python 2 versions using 2to3.
904 Xapian-bindings 1.3.0 (2012-03-14):
906 Documentation:
908 * In maintainer builds, run doxygen to generate XML for the bindings in the
909   bindings build system, not as a side-effect in xapian-core's.  (ticket#262)
911 General:
913 * Wrap new geospatial API.
915 * Wrap new database checking API.
917 * Deprecated features scheduled for removal in 1.3.0 have been removed.
919 * Wrap ExpandDecider even if we don't have director support - there's a
920   ExpandDeciderFilterTerms subclass which is useful in itself, though it still
921   needs some typemap work to actually get it usefully wrapped.
923 * configure:
925   + Add --disable-visibility option to match xapian-core.
927   + Add -fshow-column for GCC.
929   + Don't put -Werror in SWIG_FLAGS - instead put it in a new SWIG_WERROR
930     variable, so that it's easy to override it if you're getting a new warning
931     from SWIG but want to just ignore it for the time being.
933 * Exception handling now uses Error::get_description() rather than get_type +
934   ": " + get_msg().  In many cases this is the same, but if context or errno
935   are available, get_description() includes them.  Catch and report
936   std::exception rather than handling it as an unknown error (so in particular
937   std::bad_alloc will now be reported more helpfully).
939 CSharp:
941 * Avoid generating unwanted wrapper sources
942   SWIGTYPE_p_std__vectorT_std__string_t.cs and
943   SWIGTYPE_p_std__vectorT_Xapian__Query_t.cs.
945 Java:
947 * The hand-coded JNI Java bindings have been removed and the SWIG-based Java
948   bindings promoted in their place.  This means almost the entire C++ API is
949   now wrapped for Java, but the downside is there are some changes required
950   to existing code.  Overall we feel the short-term pain is worth the long
951   term benefits of having Java bindings which stay up to date.
953 * java/SmokeTest.java: Add test that string passing is zero byte safe.
955 Lua:
957 * Improve error messages.
959 Perl:
961 * Fix "Use of qw(...) as parentheses is deprecated" warnings in test cases with
962   Perl 5.14.
964 * Fix Search::Xapian::Query->new() to work.
966 * Enable warnings for all test cases and make them fatal.
968 * Add "use Carp;" where we use functions from that module.
970 * Improve POD docs for Document and TermGenerator methods - "weight" is
971   misleading, so use "wdfinc" and "wdfdec" like the C++ API docs do.
973 * The Query constructor which takes an array of subqueries is now wrapped more
974   efficiently - previous a temporary C++ std::vector was built but now we avoid
975   doing this.
977 PHP:
979 * PHP >= 5.3 is now required.
981 * Add PHP type hints to the class wrappers.  Fixes ticket#577.
983 * The XapianQuery constructor which takes an array of subqueries is now
984   wrapped more efficiently - previous a temporary C++ std::vector was built
985   but now we avoid doing this.
987 Python:
989 * Python >= 2.4 is now required.
991 * Remove deprecated Stem_get_available_languages().
993 * Hide away the deprecated non-pythonic iterators - we still need them to
994   implement the pythonic iterators, so we can't entirely remove them.
996 * Replace SWIG's thread locking with code which does nothing unless threads
997   are already initialised, to avoid the overhead of thread locking in the
998   common case of single-threaded Python code.  This seems to be about 5-10%
999   faster for pythontest2.py modified to repeat the tests 100 times.
1001 * Handle the GIL in a way which also works in sub-interpreters.  Fixes ticket
1002   #364.
1004 * The Query constructor which takes an array of subqueries is now wrapped more
1005   efficiently - previous a temporary C++ std::vector was built but now we avoid
1006   doing this.
1008 Ruby:
1010 * The XapianQuery constructor which takes an array of subqueries is now
1011   wrapped more efficiently - previous a temporary C++ std::vector was built
1012   but now we avoid doing this.
1014 Tcl:
1016 * The XapianQuery constructor which takes an array of subqueries is now
1017   wrapped more efficiently - previous a temporary C++ std::vector was built
1018   but now we avoid doing this.
1020 Xapian-bindings 1.2.23 (2016-03-28):
1022 Documentation:
1024 * Update links to Xapian website and trac to use https, which is now supported,
1025   thanks to James Aylett.
1027 PHP:
1029 * Check that the PHP interpreter we find is actually PHP5, and if not look
1030   harder.  On current Debian unstable, php-config5 --php-binary reports
1031   /usr/bin/php which can be PHP7.
1033 * Document that PHP7 isn't currently supported, and explicitly check for and
1034   reject it in configure.
1036 Ruby:
1038 * configure: Stop preferring rdoc-1.8 to rdoc (this only happened in a
1039   fall-back case when rdoc wasn't found in the same directory as the ruby
1040   interpreter).
1042 Xapian-bindings 1.2.22 (2015-12-29):
1044 Documentation:
1046 * Stop maintaining ChangeLog files.  They make merging patches harder, and stop
1047   'git cherry-pick' from working as it should.  The git repo history should be
1048   sufficient for complying with GPLv2 2(a).
1050 General:
1052 * Stop wrapping internal methods of Xapian::Weight.
1054 * Return Error::get_description() rather than get_type + ": " + get_msg().  In
1055   many cases this is the same, but if context or errno are available,
1056   get_description() includes them.
1058 * Catch and report std::exception rather than handling it as an unknown error
1059   (so in particular std::bad_alloc will now be reported more helpfully).
1061 CSharp:
1063 * Fix configure test for whether $MONO can run CSharp programs - previously it
1064   would always fail, which would mean that the CSharp tests would only be run
1065   on systems where CSharp programs can be run directly.
1067 Lua:
1069 * Send stderr from lua version check to config.log instead of letting it appear
1070   on the terminal.
1072 PHP:
1074 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
1076 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
1077   constructors now work.
1079 Python:
1081 * Add new testcase to catch any internal functions, methods, constants, etc
1082   which have accidentally been wrapped.
1084 Xapian-bindings 1.2.21 (2015-05-20):
1086 Lua:
1088 * README: Remove note about the Lua bindings being experimental - it's not
1089   really been true for some time now.
1091 Perl:
1093 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
1095 * Add workaround for Perl defining a seed() macro which breaks compilation with
1096   GCC in C++11 mode (due to <algorithm> now pulling in random number generation
1097   classes with a method called seed).
1099 * Update list of unwrapped things in POD documentation.
1101 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
1102   during parallel builds.
1104 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
1106 * Add test that we can create all the stemmers returned by
1107   Stem::get_available_languages().
1109 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
1110   likely due to external reasons, like incompatible compiler flags being taken
1111   from Perl's Config module, due to Perl having been built with a different
1112   compiler to Xapian.
1114 * Use croak_sv() or ERRSV if defined.
1116 PHP:
1118 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
1119   was fixed in 1.2.19.
1121 Python:
1123 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
1124   stable release 1.4.0.
1126 Ruby:
1128 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
1130 * Ship generate-rdoc-stubs in the tarball.  Reported by Matthias Klose in
1131   https://bugs.debian.org/782270
1133 Xapian-bindings 1.2.20 (2015-03-04):
1135 Portability:
1137 * configure: Avoid using \? in sed command in Lua detection - it isn't
1138   supported by all sed implementations.
1140 Lua:
1142 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
1143   being specified without a leading '.'.
1145 * configure: Add an example of specifying LUA_SO to --help output.
1147 PHP:
1149 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
1150   1.2.19.
1152 * In current PHP releases, dl() is disabled in most SAPIs, and even where
1153   available it will now only look in the configured extension directory.  The
1154   upshot is that there no longer seems to be a sane way to install the PHP
1155   bindings without being root, so update the documentation to reflect this.
1156   Fixes #661, reported by Felix Ostmann.
1158 Xapian-bindings 1.2.19 (2014-10-21):
1160 PHP:
1162 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
1163   in PHP works with PHP 5.4 and later.  (Fixes #652, reported by Sebastian
1164   Gottfried)
1166 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
1167   which were getting incorrectly wrapped such that they didn't actually do
1168   anything.  Fixes #659, reported by jmienert.  This bug was introduced by the
1169   reference tracking fix in 1.2.14.
1171 Ruby:
1173 * README: Note that Ruby 2.1 works too.
1175 Xapian-bindings 1.2.18 (2014-06-22):
1177 Documentation:
1179 * README: Add links to Erlang and Node.js bindings.
1181 Lua:
1183 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
1184   expected), which most of the calls already used, and fix up the few calls
1185   which passed (expected, got).
1187 PHP:
1189 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
1190   that MatchDecider returns an MSet with the expected docid in.  Luckily this
1191   wasn't masking a test failure.
1193 Python:
1195 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
1196   - chert is the default backend now, and both chert and brass support the
1197   required functionality for the tests which do this, so this just needlessly
1198   causes the tests to fail if chert is disabled in xapian-core.
1200 * configure: If the Python version is too new or too old, only report it once
1201   not twice.
1203 Ruby:
1205 * configure: Fix Ruby bindings to build on Windows (and other platforms where
1206   allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
1208 Xapian-bindings 1.2.17 (2014-01-29):
1210 Portability:
1212 * Improve workaround which allows building against an uninstalled xapian-core
1213   on OS X - this should now work with any uninstalled xapian-core (not only in
1214   a tree with the same layout as an SVN or git checkout) and it also won't try
1215   to build against "../xapian-core/.libs" just because it happens to exist.
1216   (Backported from 1.3.1; fixes #322)
1218 Python:
1220 * configure: Some distros now point /usr/bin/python at Python 3, so the check
1221   for a Python 2 interpreter now checks for 'python2' first, and checks that
1222   the version of found interpreter is 2.x.
1224 Ruby:
1226 * Tweak configure to work with Ruby 2.0.
1228 Tcl:
1230 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
1231   in http://bugs.debian.org/724830).
1233 * Use a better check for TCL_INC for Tcl 8.5 and later.
1235 Xapian-bindings 1.2.16 (2013-12-04):
1237 Documentation:
1239 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
1241 General:
1243 * Compress source tarballs with xz instead of gzip.
1245 * configure: Handle git snapshot naming.
1247 Portability:
1249 * configure: Update list of platforms where we tell libtool not to link in
1250   deplibs to match the list used for xapian-core.
1252 Perl:
1254 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
1255   GCC 4.7 warning).
1257 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
1258   the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
1260 PHP:
1262 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
1263   with a message explaining this.
1265 Python:
1267 * Provide bindings version in xapian.__version__ as per PEP 396.  (see #346)
1269 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
1271 * pythontest.py: Fix testcase checking we get an exception from using
1272   non-random-access iterators after then have advanced - previously these
1273   didn't actually test as fully as intended.
1275 Ruby:
1277 * Omit internal classes and methods from the rdocs.
1279 Xapian-bindings 1.2.15 (2013-04-16):
1281 General:
1283 * Fix configure --enable-quiet option to actually work for the bindings.
1285 Perl:
1287 * Fix doc typo: "as as" -> "as a"
1289 Ruby:
1291 * Fix deprecation warning in configure from Ruby 1.9.3.
1293 Xapian-bindings 1.2.14 (2013-03-14):
1295 Python:
1297 * Fix typo in doccomment.
1299 PHP:
1301 * Keep references to the PHP wrapper object when an object is set on another
1302   object.  (fixes #614)
1304 Tcl:
1306 * Allow TCL_INC to be passed to configure.  (fixes #612)
1308 Xapian-bindings 1.2.13 (2012-11-09):
1310 CSharp:
1312 * configure: Overhaul checks for C# tools to use modern names in preference.
1314 Lua:
1316 * Fix examples to use str(query) to get the query description.  (Fixes #600)
1318 * Document that get_description() is mapped to str(), and end() to _end().
1320 * Fix functor wrappers which return strings to be zero-byte clean.
1322 Perl:
1324 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
1325   1.2's XS Search::Xapian.  (ticket#607)
1327 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
1328   is deprecated.
1330 PHP:
1332 * Document that subclassing Xapian classes in PHP currently doesn't work with
1333   PHP 5.4.
1335 Xapian-bindings 1.2.12 (2012-06-27):
1337 No changes since 1.2.11 except to bump the version - this release was made to
1338 fix an incorrect library version information update in xapian-core 1.2.11.
1340 Xapian-bindings 1.2.11 (2012-06-26):
1342 General:
1344 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
1346 Perl:
1348 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
1349   av_fetch() (spotted due to GCC 4.7 warning).
1351 PHP:
1353 * Fix "make check" to work for PHP when building from a release tarball with
1354   srcdir != builddir.
1356 * Work around "undefined symbol: zend_error_noreturn" error.
1358 Xapian-bindings 1.2.10 (2012-05-09):
1360 CSharp:
1362 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
1363   us to do this instead of setting them in AssemblyInfo.cs.
1365 * Use diff's -c option when comparing the files SWIG generated against those we
1366   were expecting to get as the output should be easier to understand.
1368 * Sort both the lists of expected and of found SWIG-generated sources with
1369   Perl, to avoid problems with locale-specific sort orders.
1371 Java-SWIG:
1373 * Remove now superfluous old check that SWIG generated at least the sources we
1374   want - we now check it generated *exactly* the sources we want.
1376 * Use diff's -c option when comparing the files SWIG generated against those we
1377   were expecting to get as the output should be easier to understand.
1379 * Sort both the lists of expected and of found SWIG-generated sources with
1380   Perl, to avoid problems with locale-specific sort orders.
1382 Lua:
1384 * Now works with Lua 5.2.
1386 * "require 'xapian'" now returns the module table.  (ticket #593)
1388 * lua/smoketest.lua: Improve reporting of test failures.
1390 Perl:
1392 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
1394 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
1395   possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
1397 Python:
1399 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
1400   iteration features which have been removed on trunk.  This also fixes a
1401   segfault if there are no matches and no documents are explicitly marked as
1402   relevant.
1404 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
1405   way to rerun tests with verbose output.
1407 Ruby:
1409 * configure: Make sure the ruby subdirectory exists before trying to create
1410   ruby/rubyio.h, so this works in a VPATH build from a clean tree.
1412 Xapian-bindings 1.2.9 (2012-03-08):
1414 Java:
1416 * configure: Fix test for jni.h to try looking for jni.h relative to the real
1417   location of javac, which should work for more JDKs.
1419 Lua:
1421 * Handle an exception from C++ by raising a xapian.Error object as an error in
1422   Lua.
1424 * Rename get_description() methods to __tostring(), so that you can use write
1425   tostring(obj) in Lua.
1427 * configure: Honour LUA_LIB if already set.  Fixes #581.
1429 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
1430   support platforms where the compiled Lua module isn't called .so.
1432 Perl:
1434 * Add tests of Document::get_docid().
1436 PHP:
1438 * Add a test that Query constructor taking OP_NEAR with a window size works.
1440 Python:
1442 * python/testsuite2.py: Don't run off the traceback looking for a test function
1443   if the exception wasn't from a test function.
1445 Xapian-bindings 1.2.8 (2011-12-13):
1447 Lua:
1449 * Wrap user-subclassable functor objects by allowing the user to pass a
1450   Lua function where the functor object would be passed in the C++ API.
1452 PHP:
1454 * Fix "PHP Notice:  Undefined variable: r in xapian.php".  (Fixes bug#576)
1456 * The PHP bindings will now work again with a version of PHP built with ZTS
1457   enabled (which is the default on Microsoft Windows).  This was broken by
1458   the changes to support subclassing in PHP in the version of SWIG used since
1459   1.2.6.
1461 Python:
1463 * Add a module docstring.  (Fixes bug #573)
1465 * The python testsuite now checks for object leaks during each testcase.
1467 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
1468   only check for leaks the second time to avoid falsely reporting a leak when
1469   some cached value gets initialised under Python 2.5.
1471 Ruby:
1473 * Wrap optional prefix parameter to Database::allterms.
1475 Xapian-bindings 1.2.7 (2011-08-10):
1477 Documentation:
1479 * INSTALL: Pull in a few updates from the latest version of the automake
1480   document which this file was originally based on.  Add in the missing
1481   copyright and licensing information.
1483 * INSTALL: Add --with-lua to list of options.
1485 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
1486   supported as Apple ditched them long ago, so drop this as a "Known Issue" in
1487   INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
1488   supported platforms in the README.
1490 * HACKING: Update and start section on deprecation warnings for the bindings.
1492 General:
1494 * Add missing wrappers for Database::has_positions() and
1495   TermIterator::positionlist_count(), and correct the return type of
1496   Database::get_doclength() from double to Xapian::termcount.
1498 CSharp:
1500 * README: Note a recent version of Mono which we've tested the C# bindings
1501   with.
1503 * Check that exactly the sources we expect are generated, and add some sources
1504   which were missing from the list.
1506 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
1507   gets removed.
1509 * Fix iterator ++ and -- so that the reference to the object isn't released
1510   prematurely, which was causing an occasional crash if the garbage collection
1511   happened at just the wrong moment,
1513 * Add test coverage for QueryParser.ParseQuery() with flags argument.
1515 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1517 Java:
1519 * SmokeTest.java: Fix == comparisons with strings to use equals().
1521 * Add test that string passing is zero byte safe.
1523 * Fix MyExpandDecider.accept() to really check the passed parameter.
1525 Java-SWIG:
1527 * Put the SWIG-generated Java bindings in package org.xapian.
1529 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
1531 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
1533 * Add test that string passing is zero byte safe.
1535 * Fix MyExpandDecider.accept() to really check the passed parameter.
1537 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
1539 * Create an HTML documentation page based on java/README.
1541 * Copy java examples from the hand-coded JNI ones.
1543 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
1545 * Check that exactly the sources we expect are generated, and add some sources
1546   which were missing from the list.
1548 Lua:
1550 * Merge latest Lua changes from Xiaona Han.
1552 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
1554 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
1555   matches.
1557 Perl:
1559 * Sync updates to examples from XS Search::Xapian:
1561   + Require Perl >= 5.6 so we can "use warnings;".
1563   + Loop over file using while() (which reads a line per iteration) not
1564     foreach() (which reads the whole file up front).
1566 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
1567   and Search::Xapian::Query::MatchNothing).  (ticket#158)
1569 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
1571 * perl/Makefile.am: Fix "make check".
1573 * perl/t/symbol-test.t: Fix to work when built against an installed
1574   xapian-core.  (ticket#558)
1576 PHP:
1578 * php/smoketest.php: Install an error handler so the test fails if there are
1579   any errors, warnings, notices, etc.
1581 * Change PHP examples and test program to use 'include "xapian.php"' like user
1582   code should (rather than 'include "php5/xapian.php"' as they did previously).
1584 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
1585   XapianQuery::MatchNothing(). (ticket#158)
1587 Ruby:
1589 * Wrap MatchAll and MatchNothing for Ruby.  (ticket#158)
1591 Xapian-bindings 1.2.6 (2011-06-12):
1593 General:
1595 * SWIG-based bindings are now generated with a newer version of SWIG
1596   (ticket#538).
1598 Portability:
1600 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
1601   .jnilib extension as we do for older versions.
1603 CSharp:
1605 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
1607 Java:
1609 * Fix memory leaks when functions taking string parameters throw exceptions.
1611 * Previously a hash table was used to map Java objects to C++ ones, but we
1612   now just cast the address of the C++ object to a jlong (which is 64 bits
1613   so will hold a pointer on current platforms).  This is more efficient and
1614   avoids the need for thread locks around accesses to the hash table.
1616 * Remove explicit checks for NULL around calls to delete.
1618 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
1619   during parallel builds.
1621 Lua:
1623 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
1624   year.  The current support should be regarded as experimental - it passes
1625   its automated tests, but the details of the Lua API are likely to evolve as
1626   the project progresses.
1628 Perl:
1630 * README: say that Perl bindings probably need Perl 5.8 or later.
1632 PHP:
1634 * Directors now work for PHP (ticket#488).  New simplematchdecider.php example.
1636 Python:
1638 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
1639   all the garbage, so repeat until no further objects are freed.
1640   (http://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
1642 Ruby:
1644 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
1645   the compaction tests for these versions.
1647 Xapian-bindings 1.2.5 (2011-04-04):
1649 Documentation:
1651 * README: Update info on SWIG-based Perl bindings.
1653 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL.  Replace VPATH
1654   section with better equivalent from xapian-core/INSTALL.
1656 General:
1658 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
1660 * configure: If xapian-core is a different release series, promote the
1661   mismatched versions warning to an error.
1663 Portability:
1665 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
1666   10.4 on x86, as the default if unset on these versions is the current OS
1667   version.  (ticket#541)
1669 * python/pythontest2.py: In test_compactor(), close any open databases before
1670   removing the directory as you can't delete an open database on Microsoft
1671   Windows.  (ticket#526)
1673 CSharp:
1675 * Don't pass extra flags to Microsoft's gacutil.  (ticket#516)
1677 * Clarify the licence is GPL "version 2 or later" in the meta information
1678   we put in the module.
1680 Python:
1682 * Remove old and broken Enquire.get_matching_terms() method.  We deprecated
1683   Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
1684   accidentally left an older version of get_matching_terms() exposed.
1686 * Remove broken implementation of MSet.__contains__.  This appears never to
1687   have worked, and to have been broken for at least the past 3.5 years without
1688   anyone mentioning it, and is probably of little use anyway, so no need to
1689   deprecate.
1691 * python/docs/index.html: Document that MSet.items and ESet.items are
1692   deprecated, and what to use instead.  Note that MSET_DOCUMENT never worked on
1693   the tuple returned by MSet.items.  (ticket#531)
1695 * Add test coverage for mset.items.
1697 Ruby:
1699 * Add test coverage for Xapian::Compactor.
1701 * Handle an empty response to $RUBY --version specially.  This gives a less
1702   opaque error in cases where the user specified RUBY but the value given
1703   wasn't an executable file.
1705 Xapian-bindings 1.2.4 (2010-12-19):
1707 General:
1709 * Wrap the new Xapian::Compactor class.  The resolve_duplicate_metadata()
1710   virtual method is wrapped for subclassing for Python and Ruby currently.
1712 * Eliminate separate Makefile.am in the docs subdirectory of each language
1713   subdirectory and just inline any rules into the main sub-Makefile.am, which
1714   allows more of the build to run in parallel.
1716 * Don't ship some files which are generated at build time.
1718 * configure: Need python in maintainer mode to run doxy2swig.py.
1720 Packaging:
1722 * RPM: Package the Perl bindings.
1724 * RPM: Don't package _XapianSharp.la.
1726 Portability:
1728 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
1729   uninstalled Xapian library.  See ticket #322.
1731 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1733 CSharp:
1735 * Don't install _XapianSharp.la.
1737 Perl:
1739 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
1740   GSoC 2009.  These are close to being a compatible replacement for the
1741   hand-coded XS bindings in Search::Xapian but also offer a more complete
1742   wrapping of the C++ API.  We're planning to replace the XS bindings with the
1743   SWIG ones for easier maintenance.  We encourage you to try them and let us
1744   know how you get on - particularly if you find cases where code which works
1745   with the XS bindings doesn't work with the SWIG ones.
1747 PHP:
1749 * Document that iterators shouldn't be dereferenced or advanced when at their
1750   end points (ticket#520).
1752 Python:
1754 * Fix memory leaks in typemaps which return Python lists.
1756 * MatchSpy can now be subclassed in Python.  Remote use isn't currently
1757   supported.
1759 * configure: Use sys.version_info tuple, rather than string splicing which
1760   assumes the Python "major.minor" is 3 characters (which would fail if Python
1761   2.10 were ever released, for example).
1763 Xapian-bindings 1.2.3 (2010-08-24):
1765 Packaging:
1767 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
1769 Xapian-bindings 1.2.2 (2010-06-27):
1771 * No user-visible change except for bumping the version to indicate
1772   compatibility with Xapian-core 1.2.2.
1774 Xapian-bindings 1.2.1 (2010-06-22):
1776 This release includes all changes from 1.0.21 which are relevant.
1778 General:
1780 * Wrap Xapian::StemImplementation.  Currently this has only been tested for
1781   Python.  (ticket#448)
1783 Guile:
1785 * Remove non-functional disabled guile bindings left over from Open Muscat
1786   days - if someone wanted to add guile bindings, it would be easier to start
1787   from scratch.
1789 Java-SWIG:
1791 * Update list of generated java sources in the SWIG-based Java bindings.
1793 PHP:
1795 * zend_throw_exception() returns, so return control to PHP directly after
1796   calling it to avoid needless extra work and possible issues.
1798 Python:
1800 * Fix "from xapian import *".  (ticket#477)
1802 * Fix testcase weight_normalise - a change in xapian-core means that
1803   get_max_possible() can now return zero for a non-existent term, so don't
1804   blindly calculate the reciprocal of it.
1806 * python/replicationtest2.py: Extend to check that changesets get applied
1807   correctly.
1809 * python/smoketest2.py: Check len(mset) works (improving test coverage of
1810   Python-specific wrapping).
1812 Xapian-bindings 1.2.0 (2010-04-28):
1814 This release includes all changes from 1.0.20 which are relevant.
1816 Portability:
1818 * configure: Tell libtool not to link in deplibs on platforms where we know
1819   they aren't needed.
1821 * configure: On Linux, extract the library search path from ldconfig which
1822   gives us the default entries reliably.
1824 Xapian-bindings 1.1.5 (2010-04-15):
1826 This release includes all changes from 1.0.19 which are relevant.
1828 Tcl:
1830 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
1831   sidestep the whole destructor issue.  (ticket#62)
1833 Xapian-bindings 1.1.4 (2010-02-15):
1835 This release includes all changes from 1.0.18 which are relevant.
1837 General:
1839 * Update for the new Brass backend and other C++ API changes.
1841 * Wrap Database::get_doclength_lower_bound(),
1842   Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
1843   Database::valuestream_begin() and Database::valuestream_end() for all
1844   languages. (ticket#431)
1846 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
1848 Python:
1850 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
1851   object which dereferences to a ValueStreamItem object,
1853 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
1855 Ruby:
1857 * Add safe wrapper for the valuestream iterator.
1859 Xapian-bindings 1.1.3 (2009-11-18):
1861 This release includes all changes from 1.0.15-1.0.17 which are relevant.
1863 General:
1865 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
1866   specified.
1868 * Wrap the new MatchSpy class, and associated features.
1870 * Don't wrap PostingSource::serialise(), Weight::serialise() and
1871   Weight::unserialise() as they aren't useful from the bindings.
1873 * Update for the Sorter to KeyMaker changes.
1875 PHP:
1877 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
1878   as it standardly is on Microsoft Windows.  Fixes #411.
1880 * Merged the PHP "smoketest" back together now we don't need to support
1881   PHP4 now.
1883 Python:
1885 * Fix a memory leak on error (in theory - we've not got a way to generate this
1886   error, so haven't been able to reproduce the leak or test the fix).
1888 Xapian-bindings 1.1.2 (2009-07-23):
1890 This release includes all changes from 1.0.14 which are relevant to trunk.
1892 Python:
1894 * Several changes towards fully supporting Python 3, but more work is required.
1895   (ticket#246)
1897 Xapian-bindings 1.1.1 (2009-06-09):
1899 This release includes all changes from 1.0.13 which are relevant to trunk.
1901 General:
1903 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
1905 CSharp:
1907 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1908   C# yet, and to use Query("") and Query() instead.
1910 * configure: If we don't find a C# compiler, don't test an empty command name
1911   further which saves a fork and avoids an odd looking message.
1913 PHP:
1915 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1916   PHP yet, and to use Query("") and Query() instead.
1918 Python:
1920 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
1921   are wrapped (ticket#158).
1923 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
1924   expect SYNONYM in generated query.
1926 Ruby:
1928 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
1929   Ruby yet, and to use Query("") and Query() instead.
1931 Tcl:
1933 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
1934   are wrapped (ticket#158).
1936 Xapian-bindings 1.1.0 (2009-04-22):
1938 Documentation:
1940 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
1941   the instructions to suggest users use this standard location for installing
1942   without root access.
1944 General:
1946 * All deprecated features slated for removal in 1.1.0 have been removed.
1948 * All new C++ API features have been wrapped.  Also, since we now supply some
1949   standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
1950   these can be passed in even for languages for which SWIG doesn't support
1951   subclassing.
1953 Packaging:
1955 * xapian-bindings.spec: Updated to reflect the new Python packaging.
1957 Portability:
1959 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
1960   to put the compiler into ISO C++ mode).
1962 PHP:
1964 * PHP4 support has been removed, since PHP4 is no longer supported upstream
1965   as of 2008-08-08.
1967 Python:
1969 * Python 2.3 or later is now required.  2.2 is essentially unsupported
1970   upstream.
1972 * The import method used has been changed (by using a newer SWIG version)
1973   and no longer gives a warning with Python 2.6.
1975 * Initial support for Python 3.0 has been added.  This currently doesn't
1976   work correctly and should be treated as experimental. (ticket#346)
1978 * The newer SWIG version handles exceptions in director methods correctly
1979   so we no longer need our workaround for ticket #289.
1981 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
1982   wrapped for Python as Database.metadata_keys().
1984 * The Python bindings are now installed as a python package, with the
1985   files in a xapian subdirectory, hiding the internal _xapian module
1986   better.
1988 * Python now flags deprecation warnings for the single argument form and old
1989   parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
1990   friends.
1992 Xapian-bindings 1.0.23 (2011-01-14):
1994 Portability:
1996 * configure: Fix typo in code to set PYTHON_LIBS under cygwin.  (ticket#509)
1998 PHP:
2000 * Document that iterators shouldn't be dereferenced or advanced when at their
2001   end points (ticket#520).
2003 Python:
2005 * Fix memory leaks in typemaps which return Python lists.
2007 Xapian-bindings 1.0.22 (2010-10-03):
2009 Packaging:
2011 * RPM: Don't package _XapianSharp.la.
2013 CSharp:
2015 * Don't install _XapianSharp.la.
2017 Python:
2019 * configure: Use sys.version_info tuple, rather than string splicing which
2020   assumes the Python "major.minor" is 3 characters (which would fail if Python
2021   2.10 were ever released, for example).
2023 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
2024   testcase in pythontest.py.
2026 Xapian-bindings 1.0.21 (2010-06-18):
2028 Python:
2030 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
2031   can't be written to. (ticket#297)
2033 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
2035 * Add test to check that "from xapian import *" works.
2037 Xapian-bindings 1.0.20 (2010-04-27):
2039 Python:
2041 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
2042   generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
2043   trap to delete them after running tests for older versions of Python.
2044   (ticket#315)
2046 Ruby:
2048 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
2050 Xapian-bindings 1.0.19 (2010-04-15):
2052 Tcl:
2054 * tcl8/docs/index.html: Improve wording in a few places.
2056 Xapian-bindings 1.0.18 (2010-02-14):
2058 General:
2060 * Wrap new C++ API method Document::add_boolean_term().
2062 Ruby:
2064 * Generate entries in the Ruby rdocs for all classes which aren't documented
2065   because of Ruby-specific methods.  Fixes ticket#417.
2067 * Avoid absolute paths in the generated rdocs.
2069 Xapian-bindings 1.0.17 (2009-11-18):
2071 Packaging:
2073 * Improve RPM package summaries - the files are needed to *use* scripts as well
2074   as to develop them.  Use "Tcl" instead of "TCL" as the former is more
2075   conventional.
2077 Portability:
2079 * python/Makefile.am: Restore the "./" path to the sourced file
2080   libtoolconfig.tmp as ksh requires it.
2082 Java:
2084 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
2086 Xapian-bindings 1.0.16 (2009-09-10):
2088 Python:
2090 * Improved docstrings for QueryParser::set_default_op() and
2091   QueryParser::get_default_op() (automatically generated from changes in
2092   xapian-core).
2094 Xapian-bindings 1.0.15 (2009-08-26):
2096 Python:
2098 * Don't break long words when wrapping text in the generated API documentation
2099   comments as this was causing identifiers to be broken in two.
2101 Xapian-bindings 1.0.14 (2009-07-21):
2103 General:
2105 * configure: If $CSC is empty, don't try to run it.  This was a cosmetic bug
2106   and the only side-effect was an odd looking message.
2108 Python:
2110 * Rename methods at build-time using SWIG rather than a run-time in Python, as
2111   the latter approach adds a small time overhead when the module is being
2112   loaded.
2114 Ruby:
2116 * Fix to accept an integer value > MAXINT for a double parameter.
2118 Xapian-bindings 1.0.13 (2009-05-23):
2120 Packaging:
2122 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
2123   _XapianSharp.so in 1.0.11.
2125 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
2126   bindings since 1.0.6.
2128 PHP:
2130 * Backport fix from SWIG SVN for misuse of formatted error function in
2131   SWIG-generated code.
2133 Python:
2135 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
2136   Python's Global Interpreter Lock (GIL) in situations where we know that it
2137   will already be locked.  This avoids some dead-locks with mod_python (due to
2138   mod_python bugs which are apparently unlikely to ever be fixed), and results
2139   in smaller wrappers which run a little faster (in tests with Xapian on x86-64
2140   Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
2141   faster). (ticket#185)
2143 * README,python/docs/index.html: Update documentation of the above mod_python
2144   issue and also document the related mod_wsgi issue.  The status is now that
2145   everything seems to work if you stick to the main interpreter (ticket#364).
2147 * Backport fix from SWIG SVN for misuse of formatted error function in
2148   SWIG-generated code.
2150 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
2151   second parameter, not the third.
2153 * python/docs/examples/simplematchdecider.py,
2154   python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
2155   clearer code.
2157 Ruby:
2159 * README: Note that the testsuite fails due to a bug in the test/unit module in
2160   Ruby 1.9.0, but applications using the bindings should work, and that the
2161   testsuite works with Ruby 1.9.1.  Drop all mention of Ruby 1.6.x as that
2162   appears to be completely dead both upstream and in the wild.
2164 Xapian-bindings 1.0.12 (2009-04-19):
2166 Documentation:
2168 * INSTALL: Add a note about being able to pass variables to configure to pick
2169   which of several parallel installations of a language to build for.
2171 Python:
2173 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
2174   test to avoid failing due to rounding differences.
2176 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
2177   stop the whole testsuite, not just the currently running testcase.
2179 Xapian-bindings 1.0.11 (2009-03-15):
2181 Documentation:
2183 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
2184   Python 3, and possible current issues with Ruby 1.9.
2186 Portability:
2188 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
2189   Cygwin.
2191 Python:
2193 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
2194   latter is deprecated, and support was removed in 1.0.0).
2196 * Add support for using the new name ("reverse") for the second argument of
2197   set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
2198   The old name ("ascending") is still supported, but will be deprecated in
2199   1.1.0.
2201 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
2202   which get set on other objects to avoid segmentation faults if they go out
2203   of scope before the object they are set on does.  (ticket#341)
2205 Ruby:
2207 * Fixes for Ruby 1.9 compatibility (ticket#323).  The test harness currently
2208   fails so "make check" doesn't pass, but code using the bindings should work.
2210 Xapian-bindings 1.0.10 (2008-12-23):
2212 Python:
2214 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
2215   as things stand (upstream fix for Debian bug 506090).
2217 Xapian-bindings 1.0.9 (2008-10-31):
2219 General:
2221 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
2223 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
2224   methods.
2226 Xapian-bindings 1.0.8 (2008-09-04):
2228 General:
2230 * configure: Report bug report URL in --help output.
2232 Python:
2234 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
2235   (bug#289)
2237 * Fix memory leaks in the xapian.Query constructor.  (bug#294)
2239 Xapian-bindings 1.0.7 (2008-07-14):
2241 Documentation:
2243 * Document how all the database factory functions and library version functions
2244   are wrapped for all languages.
2246 General:
2248 * Fix to build against a xapian-core which has quartz and/or flint disabled.
2250 * The "program" version of Remote::open() has been wrapped for some time, so
2251   update the documentation which said it wasn't.
2253 Packaging:
2255 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
2257 Portability:
2259 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
2260   different module extension rather than our own ugly bodge.
2262 Java:
2264 * Make passing string from Java to C++ zero-byte safe.  It doesn't appear to be
2265   simple to make C++ to Java work though.
2267 PHP:
2269 * Add test that OP_VALUE_GE works for PHP.
2271 Python:
2273 * Several corrections to the Python documentation.
2275 * configure: Fix problem with building under mingw.
2277 Ruby:
2279 * Include simplematchdecider.rb example.
2281 * smoketest.rb: Test the version reporting functions.
2283 Tcl:
2285 * Include simpleexpand.tcl example.
2287 * Fix where the Tcl module gets installed.
2289 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
2291 Xapian-bindings 1.0.6 (2008-03-17):
2293 General:
2295 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
2296   used with.
2298 * configure: Correct the required SWIG version given in an error message.
2300 PHP:
2302 * php/smoketest.php: Add note that this script should be run using 'make check'
2303   in the build tree (rather than trying to copy it to a webserver as someone
2304   recently tried to).
2306 * php/smoketest.php: Fix to work under PHP4.
2308 Python:
2310 * The Python module now always has the extension which Python expects, which
2311   fixes a failure on Mac OS X.
2313 Ruby:
2315 * Automatically install/uninstall the Ruby rdoc-generated documentation along
2316   with the ruby bindings.
2318 Tcl:
2320 * configure: Sort out the default value of TCL_LIB, which could end up being
2321   under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
2323 Xapian-bindings 1.0.5 (2007-12-21):
2325 General:
2327 * Wrap Xapian::Sorter and subclasses.
2329 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
2330   and Enquire::set_sort_by_relevance_then_key().
2332 * Factor out the code to protect multitarget rules against parallel make, and
2333   fix it to handle the source being changed while the rule is executing, and to
2334   correctly return an error code if we fail while trying to recover from the
2335   removal of a target of a multi-target rule.
2337 * configure: Improve the clarity of the error given when none of the tools
2338   needed for any supported language are found.
2340 * configure: SWIG 1.3.32 has now been released, so require at least this
2341   released version for maintainer builds.
2343 Java:
2345 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
2346   GCC 4.3.
2348 * configure: Log the output of trying to compile conftest.java in config.log;
2349   if the test fails, report whether the failure was compiling or running the
2350   test program.
2352 * Check for directory existence rather than calling mkdir unconditionally as
2353   despite the "(ignored)", the error message seems to confuse some people.
2355 PHP:
2357 * Add feature test for XapianMultiValueSorter.
2359 * php/smoketest5.php: Fix use of Database_get_document to new style OO
2360   interface.  Fix the error reported when the PHP5 exception test fails.
2362 * php/smoketest.php: Add feature test to confirm that optional arguments to
2363   XapianQuery's "term" constructor are wrapped.
2365 Python:
2367 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
2368   these properties build a python list, so dropping the GIL isn't safe and
2369   may cause undefined behaviour in multithreaded environments.
2371 * configure: Update error message to reflect requirement for at least python
2372   2.2.
2374 * configure: Change "print foo" to "print(foo)" in python version checks, for
2375   compatibility with python 3.0.
2377 Ruby:
2379 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
2380   previously incorrect).
2382 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
2383   ruby/docs/index.html previously had a dead link to.
2385 Tcl:
2387 * configure: Overhaul code to find tcl.h since the old version no longer worked
2388   with Debian unstable.
2390 * tcl8/docs/index.html: Update documentation to cover flint and mention that
2391   quartz is now deprecated.
2393 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
2394   throws QueryParserError instead.
2396 Xapian-bindings 1.0.4 (2007-10-30):
2398 General:
2400 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
2401   Add feature tests for all languages.
2403 * The "bindings.html" file documenting each of the bindings has been renamed to
2404   "index.html".
2406 Packaging:
2408 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
2409   older distros.
2411 Portability:
2413 * Fix warnings when compiling with GCC 4.2.
2415 PHP:
2417 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
2418   and methods/functions which return a wrapped class.
2420 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
2421   and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
2423 * Document how non-class functions are wrapped.
2425 * Fix wrapping of NumberValueRangeProcessor for PHP4.
2427 * smoketest.php: Split the regression test for bug#193 into separate
2428   versions for PHP4 and PHP5 as the previous version only worked for PHP5.
2430 Python:
2432 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
2433   non-pythonic iterators.  Make it clearer that the "sequence API" is
2434   deprecated.
2436 * Add test of a custom ValueRangeProcessor (ie, one written in python).
2438 * Update the examples to use the new-style attributes to access MSet item
2439   values rather than the old-style MSET_* constants.
2441 * Document MSET_DOCUMENT.
2443 Ruby:
2445 * smoketest.rb: Rename test of metadata access methods which had been named the
2446   same as the matchdecider test due to a copy-and-paste error.
2448 Xapian-bindings 1.0.3 (2007-09-28):
2450 General:
2452 * Wrap new methods Database::get_metadata() and
2453   WritableDatabase::set_metadata().
2455 * "make uninstall" now removes the loadable module we install for each of
2456   the bindings.
2458 * "make distcheck" now works.
2460 * Distribution tarballs are now in the POSIX "ustar" format since it saves
2461   about 40KB and we need to use it for xapian-core anyway.
2463 Packaging:
2465 * RPMs: Package xapian.php.
2467 CSharp:
2469 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
2470   usefully used currently.
2472 Java:
2474 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
2475   C++ library.
2477 * "make clean" now removes the class files generated for inner classes.
2479 PHP:
2481 * Add feature test for DateValueRangeProcessor when used with QueryParser.
2483 * ValueRangeProcessor::apply() can now be called from PHP (bug#193).  This
2484   isn't actually very useful, since you can't subclass it in PHP currently.
2486 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
2487   if the third parameter was specified and a floating point number (e.g. 0.0).
2489 * php/docs/bindings.html: Fix errors in example code.
2491 Python:
2493 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
2494   Python which takes two strings and returns a 3-tuple (value_number,
2495   modified_begin, modified_end).  Previously this always failed with a
2496   type error, so this doesn't break existing code.
2498 * python/pythontest.py: Interpret any commandline arguments as a list of
2499   tests to be run (the default is to run all tests).
2501 * README,python/docs/bindings.html: Add a note about the problems with
2502   mod-python (as described in bug #185).
2504 * python/pythontest.py: Delete the database handles before deleting a database
2505   to fix problems running the Python tests on MS Windows (bug#179).
2507 * "make clean" now removes testsuite.pyc.
2509 Ruby:
2511 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
2512   the configure command-line.  The defaults for RUBY_LIB and RUBY_LIB_ARCH are
2513   now the site-specific directories, which is more correct when building
2514   from source.  Debian packages, etc can override this by setting RUBY_LIB and
2515   RUBY_LIB_ARCH.
2517 Tcl:
2519 * Check for TCL_LIB in the environment or on the configure command-line to
2520   allow installing without root access more cleanly.
2522 Xapian-bindings 1.0.2 (2007-07-05):
2524 Documentation:
2526 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
2527   phpextdir.
2529 * Remove documentation of removed "--with-swig" configure option.
2531 General:
2533 * Add methods of NumberValueRangeProcessor for serialising and
2534   unserialising doubles.
2536 * Add methods and constants supporting spelling correction and synonyms.
2538 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
2539   to ensure that it works with uninstalled copies of Xapian.
2541 * Value of PYTHON_LIB supplied to configure is now respected - previously
2542   it was documented, but ignored.
2544 * Add support for supplying PHP_EXTENSION_DIR to configure.
2546 * Change to using "%include", rather than reproducing contents of header
2547   files, for "queryparser.h", "document.h" and "postingiterator.h".
2549 * Add new form of get_mset() which allows a matchspy matchdecider to be
2550   set.
2552 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
2553   explode.  Add in a missing "mv" in the command for installing tcl8
2554   documentation.
2556 CSharp:
2558 * Fix rule handling parallel make to include xapian_wrap.h
2560 PHP:
2562 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php.  There
2563   doesn't seem to be a standard location, but this works for Debian at
2564   least, and it seems better to at least try to install it.
2566 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
2567   prefix for PHP4.
2569 Python:
2571 * Fix a threading problem: the GIL was not being acquired in the exception
2572   handling code before setting the Python exception state, leading to
2573   various memory corruption symptoms in threaded programs.
2575 * Add special iterators to Database for synonyms, synonym_keys and
2576   spellings.
2578 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
2579   synonym iterators and spelling iterators.
2581 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
2582   the expected description to make the tests more readable.
2584 Xapian-bindings 1.0.1 (2007-06-11):
2586 Documentation:
2588 * NEWS: Fix the recent headings which said "Xapian-core" to say
2589   "Xapian-bindings".
2591 General:
2593 * Wrap Xapian::Query constructor for creating ValueRange queries.
2595 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
2596   which take a prefix.
2598 Packaging:
2600 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
2601   %{buildroot} prefix on most files which we then have to work around.
2603 CSharp:
2605 * SimpleIndex now uses Xapian.TermGenerator.
2607 * SimpleSearch now uses Xapian.QueryParser.
2609 * New SimpleExpand example.
2611 * Document explicitly how STEM_SOME constants are currently wrapped.
2613 * Update GetTermName() reference in documentation to GetTerm().
2615 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
2616   their CVS repo, and the fix should be in their 0.8.2 release.
2618 Java:
2620 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
2621   looked at, but in fact its value was read but ignored.  We now use it as the
2622   first place to look for jni.h.
2624 * configure will now automatically add an extra "-I" for the
2625   linux/solaris/win32 subdirectory which Sun's JDK requires.
2627 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
2628   "precious" so their values are preserved for when configure is automatically
2629   rerun.
2631 PHP:
2633 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
2635 * The PHP examples have been rewritten to be clearer and to make use of the
2636   new XapianTermGenerator class.
2638 Python:
2640 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
2642 * Add support for prefix-restricted pythonic allterms iterators.
2644 * Update documentation in a couple of places to refer to updated replacements
2645   for MSetIterator.
2647 * Change testsuite output to be more vim-friendly (vim should be able to jump
2648   to the right lines now).
2650 * __str__ on Xapian::Error now includes extra information in some cases (the
2651   error_string and context, if they are set).
2653 * python/smoketest.py: Eliminate uses of the legacy sequence API.
2655 * python/pythontest.py: The legacy sequence API is only supported for Python
2656   2.3 and later, so don't run tests for it when running under Python 2.2.
2658 * We now generate and install xapian.pyo as well as xapian.pyc.
2660 Ruby:
2662 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
2663   classes.
2665 * Add missing rename for the C++ TermGenerator::set_document() method so it can
2666   be used as "tg.document = doc" in Ruby.
2668 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
2670 Tcl:
2672 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
2673   feedback, based on C++ simpleexpand.cc.
2675 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
2676   TermGenerator class.
2678 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
2679   QueryParser class.
2681 * tcl8/docs/bindings.html: Document how constants are wrapped.
2683 * Update smoketest and examples to require version 1.0.0 - previously this
2684   required 0.9.6, which failed since TCL doesn't accept differing major
2685   version numbers.
2687 * pkgIndex.tcl is now generated by configure.
2689 Packaging:
2691 * The required automake version has been lowered to 1.8.3, so RPMs can now be
2692   built on RHEL 4 and SLES 9.
2694 Xapian-bindings 1.0.0 (2007-05-17):
2696 Documentation:
2698 * Document Unicode support for each language.
2700 * Assorted minor improvements and typo fixes.
2702 General:
2704 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
2705   it, for languages where SWIG supports directors.
2707 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
2708   OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
2709   allows the "default_prefix" argument to be supplied, QueryParser flags
2710   FLAG_PURE_NOT and FLAG_PARTIAL.
2712 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2714 * Remove wrappers for deprecated features removed from the C++ API (see
2715   docs/deprecation.html in xapian-core for full details and upgrade
2716   information).
2718 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
2720 * QueryParserError is now a real error, so remove special handling for "const
2721   char *" exceptions.
2723 * Use a stamp file in "make" rules with multiple targets so that parallel
2724   make works.
2726 * configure: Now quotes $PYTHON, etc so that you can specify a program with
2727   arguments.
2729 * configure: If the user specifies a program which doesn't exist (e.g.
2730   PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
2732 * configure: Disable probes for f77, gcj, and rc completely by preventing
2733   the probe code from even appearing in configure - this reduces the size of
2734   configure by 28% and should speed it up significantly.
2736 * configure: If the version check against the xapian-core version detects a
2737   mismatch, we now issue a warning rather than a hard error since if you're
2738   careful this can work.  The warning is issued late on in configure, so it's
2739   harder for the user to miss.
2741 * configure: The --with-swig option has been removed.  It no longer has a
2742   purpose as we now ship the files which are generated by SWIG.
2744 Portability:
2746 * The PHP bindings can now be built with MSVC for Microsoft Windows.
2748 CSharp:
2750 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
2751   than mcs to avoid segmentation faults at runtime due to unimplemented
2752   features in mcs.  Document this, and update configure to prefer gmcs.
2754 * The return type of MatchDecider::operator() is now `bool' rather than `int'
2755   (in line with the same change in the C++ API).
2757 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
2759 Java:
2761 * The Java bindings have been updated to use C++ replacements for deprecated
2762   methods, so they still build.  The Java wrappers still provide the old
2763   deprecated names for now though.  The longer term plan is to replace the
2764   hand-written JNI with SWIG generated wrappers (work has now begun on this)
2765   which is likely to require some API changes, and it seems more sensible to
2766   make any changes to align with C++ API changes at the same time.
2768 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
2769   MyQuery mechanism, and so fix a memory link which it caused (bug#105).
2771 PHP:
2773 * Fix undefined behaviour in get_matching_terms().
2775 * Document the (existing) renaming of methods which are PHP reserved words
2776   (empty() to is_empty() and clone() to clone_object()).
2778 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2780 Python:
2782 * The Python bindings now throw exceptions as classes with a hierarchy which
2783   mirrors that of the C++ Xapian::Error and its subclasses.  The xapian.Error
2784   base class inherits from the standard Python Exception class.
2786 * All Python methods which accept strings can now be passed either a unicode
2787   object or a simple string.  Strings are returned as simple strings: unicode
2788   input will be returned as utf-8 encoded output.  The documentation now
2789   contains a "Unicode" section.
2791 * The Python bindings should now be usable more efficiently from threaded
2792   Python applications since we now use SWIG's -threads option when generating
2793   them, so that the GIL is released during long-running Xapian operations
2794   (bug#137).
2796 * Most classes, methods, functions, etc now have docstrings which are either
2797   automatically extracted from the C++ documentation comments, or overridden by
2798   more appropriate versions.
2800 * Most of the Pythonic iterators now return an object instead of a sequence,
2801   which means they now lazily fetch the information which previously had to be
2802   fetched to put it in the sequence.  The old sequence API is supported for
2803   compatibility, but is scheduled for removal in Xapian 1.1.0.
2805 * Those Python iterators which have skip_to() methods now return the item
2806   skipped to, and next() will return the following item.  Previously, they
2807   returned None, and next() returned the item skipped to.  Several bugs in the
2808   skip_to() wrappers were fixed.
2810 * Because of the lazy access, some objects returned by iterators will raise
2811   an error if the lazy evaluation happens after the iterator has moved on
2812   (since the underlying Xapian API doesn't allow efficient access to the
2813   information in this situation).  The exact semantics are defined in the
2814   docstrings for each iterator.
2816 * Those Pythonic iterators which return only a list of terms now return
2817   simple strings, instead of a sequence or an object containing the term.  This
2818   is an incompatible change with earlier releases.  The affected iterators are
2819   Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
2820   QueryParser.unstemlist.
2822 * The contents of an MSet can now be iterated in the standard Python way.
2823   The iteration will return MSetItem objects.  The __contains__ and __getitem__
2824   methods are also implemented, allowing the "in" and [] operators to work.
2825   MSet.__getitem__ is a synonym for MSet.get_hit.
2827 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
2828   so that lazy access to its attributes is supported.  MSetItem has some
2829   deprecated methods which mimic the MSetIterator interface to allow old code
2830   to work without modification until release 1.1.0.
2832 * MSetItem provides access to the collapse_key and collapse_count, which
2833   weren't accessible from the sequence returned by the iterators before this
2834   release.
2836 * Out-of-range access to MSets will now raise an IndexError - it used to
2837   cause undefined behaviour (usually a crash).
2839 * The Python testsuite is now much more extensive, and supports colour output
2840   and verbosity levels, much like the C++ testsuite.  Tests of deprecated
2841   features are separated out, so that they can easily be removed when the
2842   features are removed.  The Python tests currently focus mainly on Python
2843   specific iterators and related functionality - general Xapian behaviour is
2844   tested by the C++ testsuite.
2846 * The pure Python code in the bindings now uses new-style classes, since we
2847   have required Python >= 2.2 since Xapian release 0.9.9.
2849 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
2850   instead.
2852 * The get_description() method which many classes support has been deprecated
2853   in favour of new more pythonic __str__ methods, so that the str() builtin can
2854   be used.  get_description() is deprecated and scheduled for removal in 1.1.0.
2856 Ruby:
2858 * We no longer regard the Ruby bindings as "beta quality", so remove the
2859   warning from their documentation.
2861 * Document that that C++ operator() becomes the method "call" in Ruby.
2863 * Don't read termfreq in safe wrapper for Document::termlist_begin().  Don't
2864   read wdf in safe wrapper for Database::allterms_begin() (bug#133).
2866 Tcl:
2868 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
2870 Xapian-bindings 0.9.10.1 (2007-04-04):
2872 PHP:
2874 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
2875   default parameters.  The most notable case was a missing Query constructor
2876   which meant that QueryParser was unusable.
2878 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
2879   (which mostly seems to mean the MS Windows version).
2881 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
2882   seems to mean the MS Windows version).
2884 * Add note to the documentation that PHP examples are written for CLI version
2885   of PHP, but that the bindings work with any version.
2887 * Add check to all PHP examples that they are being run under a CLI version of
2888   PHP.
2890 Python:
2892 * simpleexpand.py: Print each term's expand weight as a floating point value,
2893   not an integer.
2895 Ruby:
2897 * INSTALL: document how to install Xapian's Ruby bindings in your home
2898   directory.
2900 Xapian-bindings 0.9.10 (2007-03-04):
2902 Java:
2904 * Under Mac OS X, automatically look in the standard location for jni.h,
2905   and automatically rename the JNI library we build to ".jnilib", as is
2906   required by the OS X JVM.
2908 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
2909   to add the linux header directory to the include path when using this JDK.
2911 * Add missing default constructor for RSet class - it's not much use without
2912   this!
2914 * Fix Enquire.getESet() to actually work.
2916 * Fix bug in ESetIterator.hasNext().
2918 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
2920 * Fix memory leak with some JVMs in the "Query from array" constructor.
2922 * Fix memory leak in Enquire.setQuery().
2924 * SmokeTest.java: Add regression tests for RSet default constructor,
2925   Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
2926   Add feature tests for Enquire.getQuery(), and to make sure we get passed
2927   the right document in a java subclass of MatchDecider.
2929 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
2930   respective variables are set.
2932 PHP:
2934 * Update the documentation to fix out-of-date information and document the
2935   differences between the PHP4 and PHP5 wrappers.
2937 * Update the examples to use the new Object Oriented API, and provide versions
2938   for both PHP4 and PHP5.
2940 * Add a "simpleexpand" example.
2942 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
2943   Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
2944   new name, but keep the old name for now for backward compatibility.
2946 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
2947   interpreter - this works with PHP5.
2949 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
2950   0.9.8 - if Xapian is the first PHP extension to be installed, the extension
2951   directory may not exist and "make install" will create it.
2953 * configure: If zend.h isn't found and configure was run with "--with-php",
2954   exit with an error rather than automatically disabling PHP support.
2956 Python:
2958 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
2960 Packaging:
2962 * RPMs: Add support for passing "--without python" to rpmbuild.  Document the
2963   various "--without" options in a comment at the start of the .spec file.
2965 * RPMs: Remove "." from the end of the Summary.
2967 Xapian-bindings 0.9.9 (2006-11-09):
2969 Documentation:
2971 * Ship our custom INSTALL file rather than the generic one from autoconf which
2972   we've accidentally been shipping instead since 0.9.5.
2974 General:
2976 * Wrap Flint::open() and Flint::open_writable().
2978 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
2979   suitable).
2981 Python:
2983 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
2984   bit platforms with Python 2.5.
2986 Packaging:
2988 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
2990 * RPMs: The Python bindings now require Python >= 2.2.
2992 Portability:
2994 * configure: Remove unnecessary backticks from tclsh version test.
2996 Xapian-bindings 0.9.8 (2006-11-02):
2998 General:
3000 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
3001   use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
3003 * The C++ method QueryParser::parse_query() current throws "std:string"
3004   exceptions if there's a parse error.  Previously the bindings didn't catch
3005   these.  Now we catch them and handle them as if they were exceptions of
3006   type Xapian::QueryParserError (in anticipation of this changing in
3007   xapian-core).  Added testcases for this for PHP, Python, and C#.
3009 * configure: Note that SWIG is only useful for Xapian developers in --help
3010   output.
3012 * configure: If we failed to find any languages to build for, give a more
3013   helpful message.
3015 CSharp:
3017 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
3019 Java:
3021 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
3022   work rather than using the cached failure of the first jni.h check.
3024 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
3026 * SmokeTest.java: Avoid gcj "set but not used" warning.
3028 PHP:
3030 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
3032 * smoketest4.php,smoketest5.php: Check the exception message given by the
3033   DocNotFoundError testcase.
3035 Python:
3037 * Drop support for Python 2.1.
3039 Xapian-bindings 0.9.7 (2006-10-10):
3041 Documentation:
3043 * NEWS: Fix the recent headings which said "Xapian-core" to say
3044   "Xapian-bindings".
3046 General:
3048 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
3049   configure.ac.
3051 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
3052   compiling SWIG generated code which makes the compiled modules a few percent
3053   smaller and perhaps a little faster.
3055 * Wrap the newly implemented transaction API.
3057 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
3058   (this option was supposed to be used to compile the Python bindings from
3059   0.9.3 onwards, but this wasn't actually working correctly).
3061 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
3063 * In maintainer-mode, "make clean" now removes the SWIG generated files
3064   which would otherwise only be removed on "make maintainer-clean".
3066 CSharp:
3068 * Xapian::MatchDecider can now be subclassed in C#.
3070 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
3071   to use it.  This has been fixed and a regression test added.
3073 * SmokeTest.cs: Added exception handling test.
3075 Java:
3077 * Correct two misuses of delete to delete[].  Fixes bug#78.
3079 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
3080   Debian and Ubuntu boxes at least.
3082 PHP:
3084 * We now generate class wrappers for PHP5.
3086 * We now generate proxy classes for PHP4, which is an incompatible change
3087   from previous versions of xapian-bindings.  A perl script to upgrade
3088   your scripts is included.
3090 * smoketest.php:
3092   + Now that we're throwing PHP exceptions with PHP5 we need separate versions
3093     of the exception handling test for PHP4 and PHP5.  Fixes bug#76.
3095   + Rely on xapian.php to load the extension module for us.
3097   + Fix error messages to show PHP code, not Python code.
3099 * When running smoketest.php, pass the "-q" option to php, which suppresses
3100   HTTP header output for PHP < 4.3 and is ignored for compatibility by more
3101   recent versions of PHP.
3103 * configure: Fix typo - PHP_tried should be PHP_found.  This might have caused
3104   the PHP interpreter not to be found in some cases when it was actually
3105   available, but it's only used to run the smoketest not for building the
3106   bindings.
3108 Python:
3110 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
3111   and also report the check and its result to the user.
3113 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
3114   built, so add an explicit dependency so that this works reliably in parallel
3115   builds.  Fixes bug#77.
3117 * In examples and documentation, don't call the MatchDecider class/object
3118   "matcher", since we use the term "matcher" to mean something else in
3119   the library documentation.
3121 * smoketest.py:
3123   + Add test of exception handling.
3125   + Add test that MatchDecider can be subclassed successfully.
3127 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
3128   pythonic iterator class.
3130 Ruby:
3132 * Xapian::MatchDecider can now be subclassed in Ruby.
3134 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
3135   (with no "ruby" alias) on Ubuntu dapper at least.
3137 * simplesearch.rb: Lowercase terms before stemming.  "First ten" is inaccurate
3138   since we may have less than 10 matches, so say "1-<N>" instead.
3140 * simplematchdecider.rb: Implemented.
3142 Tcl:
3144 * Implement saner exception handling for Tcl and document it.
3146 * smoketest.tcl:
3148   + Add check that xapian::Query_OP_ELITE_SET has the right value.
3150   + Rework how the smoketest gets run to eliminate special code for using
3151     uninstalled bindings from smoketest.tcl itself.  This allows the smoketest
3152     to be run using installed bindings, and also makes it a better example
3153     program.
3155   + Add test for exception handling.
3157   + Send error messages to stderr.
3159   + Add comment about Tcl storing zero bytes as \xc0\x80.
3161 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
3163 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
3164   used for the Tcl bindings.
3166 Xapian-bindings 0.9.6 (2006-05-15):
3168 Documentation:
3170 * INSTALL: Add section describing how to install without root access.
3172 General:
3174 * Updated to reflect the renaming of Xapian::xapian_version_string and
3175   companions to Xapian::version_string.
3177 * Wrap optional length parameter to Enquire::set_query().
3179 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
3180   consistency.  Keep get_document_id as an alias for now for backward
3181   compatibility.
3183 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
3184   probably a largely harmless error).
3186 * Stop SWIG from adding exception handling wrappers to the calls which return
3187   version strings, since they can't throw exceptions.
3189 * xapian.i: Removed superfluous "const" from return type "docid" which is just
3190   a typedef for an unsigned integer type.
3192 * configure: Add some missing "checking ..." messages so the user has more idea
3193   what is going on.
3195 * Language specific util.i files can now define
3196   XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
3197   XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
3198   are provided for each language.  This avoids needing to keep this
3199   information in two different places.
3201 * xapian.i: Uncomment commented-out parameter names and fix duplicate
3202   parameter names (for the benefit of bindings which use the parameter names,
3203   like the OO PHP5 patch for SWIG I'm working on...)
3205 Portability:
3207 * configure: Fix warning flags passed for Intel C++ compiler.
3209 CSharp:
3211 * We now support building with Portable.NET.
3213 * Note that the passing of strings from C# into Xapian and back isn't currently
3214   zero byte safe.  If you try to handle string containing zero bytes, you'll
3215   find they get truncated at the zero byte.
3217 * C# bindings now build and pass tests when srcdir != builddir.
3219 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
3220   always say "CSharp" instead.
3222 * Not all machines are set up to run compiled C# programs when invoked
3223   directly, so get configure to check if we can, and otherwise see if using
3224   mono or ilrun works.  If not, just skip the C# tests.
3226 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
3227   (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
3228   (Microsoft, but we check it isn't the unrelated Chicken csc program.)
3230 * Move the C# specific %rename list to csharp/util.i.
3232 * Store the strong name key in the key container so we reuse it for later
3233   builds.
3235 * Wrap the version functions as more sensible names and document them (and
3236   continue to provide the older undocumented names for now just in case anyone
3237   was using them.)
3239 * Set the version of XapianSharp.dll correctly when building a snapshot from
3240   SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
3242 * SmokeTest.cs: Add test of version functions.
3244 Guile:
3246 * The Guile bindings don't work and aren't being actively worked on, so we're
3247   no longer including them in the distributed tarball to avoid disappointing
3248   users who notice a "guile" subdirectory.  It also makes the download smaller.
3250 Java:
3252 * Simplify (and improve portability of) run-java-test by using "libtool
3253   --mode=execute"'s -dlopen option.
3255 * Need to make sure "built" subdirectory exists or building from clean fails.
3257 * Fix "make check" to work when srcdir != builddir.
3259 PHP:
3261 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
3262   4.3.10), so use "php -n" and then set the options we specifically want using
3263   "-d".
3265 * Fix the smoketest invocation to work better when srcdir != builddir.
3267 * Look for PHP interpreter first in prefix given by "php-config --prefix".
3269 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
3271 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
3273 * smoketest.php:
3275   + Add test for version reporting functions
3277   + If a test fails, say which one to aid debugging.
3279   + Added simple test that zero-bytes are handled correctly when passing
3280     strings to and from Xapian.
3282 Python:
3284 * README: Note that Python bindings have been built with MSVC.
3286 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
3287   to make them executable (they don't have a #! line).
3289 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
3290   "mymatchdecider".  Add description of what this example does.
3292 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
3294 * smoketest.py: Added simple test that zero-bytes are handled when passing
3295   strings to and from Xapian.
3297 Ruby:
3299 * Added new Ruby bindings from Paul Legato.
3301 Tcl:
3303 * smoketest.tcl:
3305   + Add test for version reporting functions
3307   + If a test fails, say which one to aid debugging.
3309   + Added simple test that zero-bytes are handled correctly when passing
3310     strings to and from Xapian.
3312 Xapian-bindings 0.9.5 (2006-04-08):
3314 Documentation:
3316 * HACKING,README: Split off HACKING to contain information which is only
3317   relevant to those wishing to modify the bindings.
3319 General:
3321 * SWIG-based bindings are now built with SWIG 1.3.29.
3323 * configure: Report which languages we're building bindings for just before
3324   configure finishes.
3326 * xapian.i: Make the stub definitions for disabled backends static.
3328 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
3329   message.
3331 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
3333 Packaging:
3335 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
3336   Python bindings to support 64 bit systems.
3338 * RPMs: Package the C# bindings.
3340 Portability:
3342 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
3343   different name.
3345 * configure: Detect Intel's C++ compiler and set suitable warning flags to
3346   avoid noise from compiling generated code.
3348 CSharp:
3350 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
3352 Guile:
3354 * configure: Disable --with-guile since Guile support doesn't currently work.
3356 Java:
3358 * Override deprecation warnings for Xapian methods/functions/etc.
3360 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
3361   have some idea what went wrong!
3363 * Rework how we include headers to get hash_map to avoid compiler warnings
3364   since it's usually not in the std namespace nowadays.
3366 * Previously the "all" target also ran the "install" target, but this has
3367   proved very problematic, so change "make check" to use the uninstalled JNI
3368   glue library, and update the instructions to say that "make install" is now
3369   required.
3371 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
3372   .class files.
3374 * README: Note that some platforms need "-pthread" or similar flags.
3376 * Add a new Query constructor wrapper which take an OP_xxx and an array of
3377   Query objects.
3379 * Compiling a .java file to a .class file now deletes the .jar file to ensure
3380   it gets updated.
3382 PHP:
3384 * php -n avoids reading any php.ini, but the compiled in default may be to
3385   enable the dubiously named "safe_mode" which prevents dl() being used so
3386   "make check" fails.  So instead provide a very simple php.ini which turns off
3387   safe_mode and makes sure enable_dl is on.
3389 * Fix handling of bool parameters when resolving overloaded methods and/or
3390   default arguments.  This fixes Enquire_sort_by_value() to work when the
3391   second argument is specified.  Added regression test for this case.
3393 * simpleindex.php: Lowercase terms before stemming.  Fixes bug#73.
3395 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
3396   passed by reference.  Fixes bug#74.
3398 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
3399   isn't required and will kill performance, so stop doing it.  Fixes bug#75.
3401 Python:
3403 * Use the fairly new "swig -O" option for the "modern" python bindings as
3404   it generates a smaller glue library and runs faster.  Some of the features
3405   enabled also work on python 2.1, so enable these for the "olde" bindings.
3407 * configure: Catch the case where the user has python installed but not the
3408   module "distutils.sysconfig" and explain that they probably need to install a
3409   python-dev or python-devel package.
3411 * "make check" now works in VPATH builds.
3413 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
3414   know which check it was!
3416 * smoketest.py: catch Exception objects and print them.
3418 * smoketest.py: Add feature tests for the various pythonic iterator
3419   wrappers
3421 * python/docs/bindings.html: Document the Pythonic iterators.
3423 * Fix TermIter not to try to read termfreqs or positions if they aren't
3424   meaningful for the current TermIter.
3426 Xapian-bindings 0.9.4 (2006-02-21):
3428 Documentation:
3430 * COPYING: Updated FSF address.
3432 General:
3434 * Wrap Stopper::get_description().
3436 * Wrap xapian_version_string() and related functions.
3438 Portability:
3440 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
3441   run from "make" too.
3443 PHP:
3445 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
3446   default on Windows).
3448 Python:
3450 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
3452 Xapian-bindings 0.9.3 (2006-02-16):
3454 Documentation:
3456 * README: Updated and expanded (now covers supported platforms, and lists
3457   criteria which bindings for an additional language need to fulfil before
3458   we're likely to accept them).
3460 * INSTALL: Updated and improved.
3462 * TODO: Move C#-specific TODO to top level so we can track to-do items for
3463   all languages.
3465 General:
3467 * configure: Change how the user selects which bindings to build.  If no
3468   --with* arguments are passed, then we default to building bindings we detect
3469   the required tools for (as before).  But instead of requiring the user to
3470   deselect all bindings they don't actually want, we now let them select the
3471   bindings they do want.  So "./configure --with-python" will only build the
3472   python bindings (and will fail if the required tools aren't installed).
3474 * Every wrapped method contains exception handling code.  The bulk of this
3475   is now factored out into a single helper function, which cuts the compile
3476   time by around a factor of 3 and halves the size of the stripped library
3477   (figures are for Tcl on x86_64).
3479 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
3480   override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
3482 * configure: Bump required SWIG version to 1.3.28 and drop the special
3483   requirement for 1.3.22 for PHP (hurrah!)  Note that you don't need
3484   SWIG to install the bindings - SWIG is run by the Xapian developers
3485   so these updated requirements are only relevant if you want to modify
3486   the bindings.
3488 * Eliminate separate Makefile in each examples subdirectory, which makes the
3489   build system simpler, smaller, and a little faster.
3491 * xapian.i: Include default constructors for all classes so that SWIG knows it
3492   doesn't have to use SwigValueWrapper for them, which makes the bindings code
3493   a bit smaller and faster.  Also stop SWIG using SwigValueWrapper for
3494   std::pair<...>.
3496 * configure: Document special environmental variables which configure
3497   recognises.  Enhance handling of environmental variables so you can
3498   e.g. './configure PYTHON=python23' (previously you had to give a full
3499   path in such environmental variables or they would be ignored.
3501 Packaging:
3503 * RPM spec file:
3505   + Automatically detect the python version.
3507   + Rename "php4" references to "php".
3509   + Automatically detect the PHP extension directory.
3511   + Relax Tcl requirement to >= 8.1, since that's what we actually require.
3513   + Add support for "--without php" and --without tcl8" options to rpmbuild.
3515 Portability:
3517 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
3518   10.3.  This is required to link the bindings, and it doesn't seem to be
3519   possible to link them on 10.1 or 10.2 anyway.
3521 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC.  OpenBSD needs it
3522   to be explicitly specified and libtool correctly handles platforms where it
3523   would have been implicitly linked with anyway.
3525 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
3527 * configure: Add missing ";;" on the last alternative in some case statements.
3529 * Only pass -no-undefined on platforms where it is required in order to link a
3530   shared library at all (it causes problems on Mac OS X in some cases).
3532 CSharp:
3534 * This release includes a lot of improvements for the C# bindings.  They're
3535   now pretty much on a par with the other language bindings.
3537 * Added documentation and examples.
3539 * Method and function names are now renamed to match C# conventions
3540   (e.g. from get_description() to GetDescription()).  This is obviously an
3541   incompatible change, but the C# bindings haven't been suitable for real world
3542   use prior to this release.
3544 * Optional parameters are now wrapped so no longer need be specified
3545   explicitly.
3547 * Overload ++ and -- for iterators.
3549 * Overload == and != for iterators.  Now comparisons with the end iterator
3550   work as expected, and SmokeTest passes.
3552 * SmokeTest now reports exceptions verbosely.
3554 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
3555   similarly for other database factory functions.
3557 * Heed compatibility warnings from mcs and use different forms for
3558   command-line switches to the C# compiler (presumably for compatibility with
3559   Microsoft's compiler, though the warnings don't actually say that
3560   explicitly).
3562 Guile:
3564 * Rewrote guile/util.i.  The old version caused SWIG warnings and wasn't
3565   zero-byte safe.  The guile bindings are still a long way from actually
3566   working though.
3568 Java:
3570 * Wrap optional second parameter (query length) to Enquire::set_query().
3572 * configure now probes for the Java path separator, which we then use to
3573   separate entries in the java -classpath command line option so we can
3574   build on platforms where it isn't ":".
3576 * SmokeTest.java: Expand to test more features.
3578 * java/README:
3580   + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
3582   + Add note about how wrapped methods are named.
3584 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
3585   validity check.
3587 * Query.java: Comment out unused code.
3589 * Fixed memory leak in Query-from-array-of-strings constructor.
3591 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
3592   Xapian::Error subclasses can tell you their typename directly (using
3593   get_type()).
3595 PHP:
3597 * Some problems with overloaded methods in PHP have been fixed by a major
3598   overhaul of SWIG's PHP support.  So we no longer rename such methods
3599   for PHP.  This is an incompatible change, but it's easy to update your
3600   PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
3602 * Previously the documentation and simpleindex.php suggested that you
3603   should call delete_CLASS().  This was incorrect and resulted in a
3604   double-free() in some cases, so we've fixed the documentation and
3605   examples and eliminated the delete_CLASS() wrappers.  This is another
3606   incompatible change, but again easy to update for.
3608 * We now support PHP5 as well as PHP4, so the configure test now looks
3609   for either and all references to "PHP4" or "php4" have been adjusted.
3611 * PHP5 supports exceptions, so throw exceptions under PHP5.  For PHP4
3612   we now handle DocNotFoundError and FeatureUnavailableError by issuing a
3613   warning and making the method return "Null".  This isn't ideal, but it's
3614   the best we can easily do without proper exceptions.
3616 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
3617   empty php.ini in srcdir (which we were failing to distribute anyway), use
3618   "$(PHP) -n" which tells PHP not to use any php.ini file.
3620 * Update PHP documentation to include new features.
3622 * Redo Xapian section in phpinfo() to look more like most other modules.
3624 * You can now construct a Query object from an array of strings or Query
3625   objects (or even a mixture).
3627 * PHP examples now give a more useful error message if a database can't be
3628   opened.
3630 * smoketest.php: Expanded the tests performed, including feature tests for
3631   the new Query-from-list constuctor.
3633 * simplesearch.php: Use newly wrapped Query-from-list constructor.
3635 * Use std::string::data() instead of c_str() as it may be more efficient for
3636   some STL implementations.
3638 * Enquire::get_matching_terms() now generates the PHP list directly from the
3639   TermIterator rather than constructing a temporary C++ std::list, which is
3640   faster and requires less temporary memory.
3642 Python:
3644 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
3645   once again (it has been broken since 0.9.0).  Added a regression test to
3646   help keep this working.
3648 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
3649   instead of a list).  Also the sequence can contain xapian.Query objects or
3650   strings or a mixture.  Documented these enhancements.
3652 * smoketest.py: Expanded the tests performed.
3654 * Convert C++ strings to python ones in a zero-byte clean way.
3656 * Added more error checking of the results of calls into the python
3657   interpreter.
3659 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
3660   itself is compiled with this option to avoid problems and it appears we ought
3661   to use it too to avoid the risk of hitting the same problems, although I'm
3662   not aware of anyone actually encountering such problems).
3664 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
3665   avoid creating a broken xapian.pyc is the shared library can't be loaded for
3666   some reason.
3668 * Enquire::get_matching_terms() now generates the Python list directly from the
3669   TermIterator rather than constructing a temporary C++ std::list, which is
3670   faster and requires less temporary memory.
3672 Tcl:
3674 * Terms with a leading underscore now work (thanks to changes in SWIG).
3676 * Implement custom typemaps for Tcl, so that you can now construct a Query from
3677   a list of Query objects and/or strings, and Enquire::get_matching_terms is
3678   now wrapped.
3680 * simplesearch.tcl: Use the new Query from list constructor.
3682 * simplesearch.tcl: Fix to lowercase and stem query terms.
3684 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
3686 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
3688 Xapian-bindings 0.9.2 (2005-07-15):
3690 General:
3692 * Added wrappers for new optional flags argument to QueryParser::parse_query().
3694 CSharp:
3696 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
3697   another tool with the same name.
3699 Java:
3701 * Include SmokeTest.java in the distribution so "make check" works.
3703 * Added success report for Sun java 1.4.1_01a.
3705 Python:
3707 * When converting a python list to vector<string> we know the number of elements
3708   so reserve that number in the vector.
3710 Xapian-bindings 0.9.1 (2005-06-06):
3712 General:
3714 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
3716 Tcl:
3718 * Updated documentation to include information from Michael Schlenker about how
3719   to delete a database object such that the destructor gets called.
3721 Xapian-bindings 0.9.0 (2005-05-13):
3723 General:
3725 * Updated SWIG-based bindings to latest Xapian API
3727 * Improve support for building the bindings on MS Windows:
3729   + Provide stub versions of any backend functions which are disabled in the
3730     library we're wrapping to avoid a link failure on MS Windows (where the
3731     remote backend is automatically disabled).  These stubs just throw
3732     Xapian::FeatureUnavailableError.
3734   + Add -no-undefined to *_la_LDFLAGS.
3736   + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
3737     appropriate.
3739   + For python, paths for finding headers and installing libraries are now
3740     handled so they work on MS Windows; an extra static library needs to be
3741     linked in too.
3743 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
3744   for disabled backends).
3746 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
3747   being useful functionality.
3749 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
3750   introduced in future get fixed.
3752 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
3753   have.
3755 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
3756   1.3.22 for as more recent versions don't work with methods with optional
3757   arguments - the arguments become non-optional!)
3759 Guile:
3761 * configure: Disable guile by default, as it needs more work.
3763 Java:
3765 * Updated to compile against 0.9.0 API.
3767 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
3769 * Wrap optional parameters to Query(term) constructor.
3771 PHP4:
3773 * For PHP4, rename default Database constructor to Database_empty
3774   instead of suppressing the much more useful Database(const string &path)
3775   constructor.
3777 * Use a blank config file when running PHP4 tests to avoid problems
3778   when the bindings are already installed as an extension which is
3779   loaded automatically in the default config.
3781 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
3782   it probably just means it's not in PATH.  We only need it for running tests,
3783   so substitute a trivial shell script which just exits with code 77 so PHP
3784   tests are skipped (previously we substituted "missing" which caused the tests
3785   to fail).
3787 Python:
3789 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
3790   and ValueIter.
3792 * configure: If python is found, also check that Python.h exists (it may not be
3793   if the python-dev package (or similar) isn't installed).
3795 Xapian-bindings 0.8.5.1 (2005-02-23):
3797 General:
3799 * configure: Run compiler feature tests using the C++ compiler, not the C
3800   compiler.
3802 * Allow bindings version to have an extra "patchlevel", yet still match with
3803   corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
3805 Java:
3807 * Added a missing .java source file and removed several unused ones.
3809 * Fixed several glitches in the java bindings automake build system.
3811 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
3812   warnings in generated code (we were carefully passing "-Wunused"
3813   which is the opposite of what is needed!)
3815 * Fixed a couple of warnings from GCJ.
3817 * Wrapped a few missing methods added since Eric created the bindings.  There
3818   are still some missing methods - there's now a (probably incomplete) list in
3819   java/README.
3821 * Added various useful bits of information to java/README.
3823 * Tweaked SimpleSearch.java to be more like the C++ version.
3825 PHP4:
3827 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
3828   we now generate the PHP bindings with SWIG 1.3.22 and everything else with
3829   a more recent version.
3831 * configure: Check for "php" as a program name as well as "php4", and
3832   fall-back to missing so the error message from "make check" is better.
3834 Xapian-bindings 0.8.5 (2004-12-23):
3836 General:
3838 * INSTALL: Added non-generic installation instructions.
3840 Python:
3842 * Fixed bytecode compilation of xapian.py.  xapian.pyc was being generated in
3843   the same directory as xapian.py, but Makefile.am was looking in current
3844   directory when installing it.  Additionally, VPATH builds were broken.
3845   These problems were introduced by changes in 0.8.4.
3847 Xapian-bindings 0.8.4 (2004-12-08):
3849 General:
3851 * README: Now clearly says which languages we currently support, which people
3852   are working on, etc.
3854 * Instead of requiring the user to have a really recent SWIG installed, ship
3855   the files SWIG generates.  Disable all the SWIG rules unless configure is run
3856   with --enable-maintainer-mode to make sure they aren't triggered accidentally
3857   (e.g. by make with dodgy VPATH).
3859 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
3860   needed if you just want to install the bindings).
3862 * Wrap the new Database and WritableDatabase constructors which replace
3863   Auto::open().
3865 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
3866   (for example, simpleexpand.py needs it).
3868 * In the Query constructor which takes a vector of terms, only call set_window
3869   if window is non-zero.  Otherwise things go wrong if we're passed an empty
3870   vector.
3872 * Second argument to Document::add_posting() isn't optional, but xapian.i
3873   indicated that it was.
3875 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
3876   Deriving your own weight class in the scripting language isn't currently
3877   supported.
3879 * xapian.i: %name is deprecated, so use %rename instead.  This also works
3880   around a bug in SWIG 1.3.23.
3882 * configure: Removed pointless probe for a C compiler - everything we compile
3883   is C++.
3885 * configure: Reinstated the check that the bindings version matches the version
3886   of the xapian library.  It was added in 0.8.2, but accidentally removed in
3887   0.8.3.
3889 * Use newly added option `xapian-config --swigflags` which (a) avoids always
3890   passing -I/usr/include which could cause problems if we're using a Xapian
3891   install not in /usr and there's another one in /usr and (b) avoids problems
3892   if `xapian-config --cxxflags` contains flags other than -I<something>.
3894 CSharp:
3896 * Richard Boulton has put together bindings for C#.  These build successfully
3897   with the Mono tools, but the smoketest currently fails.  Unclear if the
3898   problem is the bindings or the smoketest code.
3900 Guile:
3902 * The guile bindings now build successfully, so we've enabled the guile
3903   detection machinery in configure.  They're untested though (we don't
3904   know guile!) so success or failure reports are encouraged!
3906 PHP4:
3908 * Mention the example scripts near the start of the documentation, not right at
3909   the end.
3911 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3912   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3913   mention!
3915 Python:
3917 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
3918   work in Python.
3920 * Changed examples to use the newly wrapped Query from list of terms ctor.
3922 * Mention the example scripts near the start of the documentation, not right at
3923   the end.
3925 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
3926   SWIG.
3928 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
3929   Xapian::Stem since we wrap them exactly as we wrap everything else we don't
3930   mention!
3932 * Mention simpleexpand example in documentation.
3934 * Examples now report messages for Xapian exceptions.
3936 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
3938 * Make the example MatchDecider exclude documents matching a value, rather than
3939   a term.  The latter is a very inefficient way to do what AND_NOT does, and we
3940   don't want examples to mislead like that.
3942 * python/docs/bindings.html: Note that you can construct a query
3943   from a list of terms, even if you can't from a list of queries.
3944   Add HTML links to the examples.
3946 * simpleindex.py: Trim spaces from the start as well as from the end of each
3947   line.  Simplify the loop slightly.
3949 Tcl:
3951 * Wrap in a tcl8 namespace "Xapian".
3953 * Added a smoketest.
3955 * Translated simpleindex and simplesearch into Tcl.
3957 * Set the Tcl package version.
3959 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
3961 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
3963 * Added documentation for tcl8 bindings.
3965 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
3966   different versions of Tcl.  This needs Tcl 8.1, so bump the required Tcl
3967   version (was 8.0).
3969 * configure.ac: Noted that the bindings can easily be compiled for use with
3970   Tcl 8.0, in case anybody needs that for some reason.
3972 * Don't wrap the factory functions which return a quartz WritableDatabase as
3973   the destructor never gets called so changes aren't flushed and the lock file
3974   isn't removed.
3976 Xapian-bindings 0.8.3 (2004-09-20):
3978 General:
3980 * Fixed mismatching versions of libtool used to produce configure and
3981   ltmain.sh.  The obvious symptom was ".so" missing from the shared object
3982   names.
3984 * RPM spec file contributed by Fabrice Colin.  Currently this packages Python,
3985   PHP4, and Tcl bindings.
3987 Java:
3989 * Pass -classpath to javac to fix build problems.
3991 * Make sure errors subdirectory is built before we try to build the jar file.
3993 * Fixed "make install" to not give libtool error.
3995 PHP4:
3997 * Include PHP4 documentation and exmples in the tarball.
3999 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
4000   change from 0.8.2 - it turns out we only need to pass these flags if we use
4001   swig's -noruntime option (which we don't do).
4003 Python:
4005 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
4006   faster Python wrapper code.
4008 Tcl:
4010 * Don't install xapian.la.
4012 * Improved configure check for tcl.h to work with Fedora Core 2.
4014 Xapian-bindings 0.8.2 (2004-09-13):
4016 General:
4018 * Added wrappers for recently added methods: ESet::back() and
4019   Database::get_lastdocid(), and wrap the new optional third parameter
4020   to Enquire::set_sorting().
4022 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
4024 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
4026 * Wrap Quartz, InMemory, and Remote database factory functions as
4027   quartz_open(), inmemory_open(), and remote_open().
4029 * Added missing wrappers for static Stem::get_available_languages() and
4030   Stem::get_description().
4032 * Wrap renamed method Query::empty() (was Query::is_empty()).
4034 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
4035   as an alias for now).
4037 * Require autoconf 2.59 and automake 1.8.5.
4039 * configure: Added check that the bindings version matches the version of
4040   the xapian library.
4042 * configure: Check if we're using GCC and only pass GCC specific warning
4043   control options if we are.
4045 * configure: When running with GCC, also pass -Wno-uninitialized so the
4046   SWIG glue builds without warnings.
4048 * README: Updated list of languages which SWIG supports.
4050 PHP4:
4052 * Document that the 2 argument form of Xapian::Auto::open() for opening a
4053   writable database is wrapped as open_writable() (bug #32).
4055 * Include Xapian version in output from phpinfo().
4057 * Build the SWIG glue library like we build the others rather than using
4058   SWIG's -phpfull option.  This avoids problems with newer automake versions
4059   and means we can build against an uninstalled xapian library.
4061 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
4062   Fixed documentation of how Xapian::Query::OP_* are wrapped.
4064 * Use special SWIG PHP ldflags when linking the PHP glue library.
4066 * simplesearch.py now works with multi-term queries.
4068 * Added documentation on how to install the PHP4 bindings.
4070 * Added a simple testcase to at least ensure the PHP4 bindings can be
4071   initialised and some simple operations work.
4073 Python:
4075 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
4077 * Don't install _xapian.la and _xapian.a.
4079 * Byte compile xapian.py to xapian.pyc and install it.
4081 * Suppress SWIG warning about MatchDecider::operator() director discarding
4082   const.
4084 * "make clean" no longer leaves "xapian_wrap.h" behind.
4086 * Added a simple testcase to at least ensure the python bindings can be
4087   initialised and some simple operations work.
4089 Tcl8:
4091 * configure: Disable building tcl8 bindings if the headers are missing
4092   (probably because the tcl8.X-dev package isn't installed).
4094 Xapian-bindings 0.8.1 (2004-06-30):
4096 General:
4098 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
4100 * Add "-I/usr/include" to the swig line.  This is needed when xapian is
4101   installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
4102   doesn't emit -I/usr/include in this situation (because it causes problems
4103   with some GCC versions).
4105 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
4106   not just a subset.
4108 Java:
4110 * Removed wrappers for unused error classes which have been pruned from C++.
4112 * Make finalize() methods of Database and WritableDatabase public so they can
4113   be called from by the user.
4115 * Document Document.add_term_nopos() as deprecated.
4117 PHP4:
4119 * Make sure that PHP bindings build a module which exports get_module() so PHP
4120   is able to load it.
4122 * Configure now checks that phpize can actually be run, rather than just that
4123   it's executable (test -x isn't portable anyhow).
4125 * Added basic documentation and examples to PHP4 bindings.
4127 * Rename overloaded methods and constructors.
4129 * Add simple access to the prefixes map in QueryParser.
4131 * Correct simpleindex ports to never generate empty termnames.
4133 Python:
4135 * configure: Use $PYTHON instead of python when running python to determine
4136   library and include paths and version number.
4138 * Actually ship python examples and documentation.
4140 Xapian-bindings 0.8.0 (2004-04-20):
4142 * README: Started collecting information on supporting Xapian from even
4143   more languages.
4145 * Added configure tests to enable bindings only where the necessary tools
4146   are installed and have a supported version.  ./configure --without-LANGUAGE
4147   allows particular languages to be forcibly disabled.
4149 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
4151 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
4153 * Added Eric B. Ridge's JNI bindings for Java.  The JNI bindings themselves
4154   have been well tested, but integration with the xapian-bindings configure
4155   system hasn't been tested at all - please alert us to any problems.
4157 * Xapian can now be used from TCL.
4159 * Python: MSet now provides a Python iterator.
4161 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
4163 * Python: enable directors for MatchDecider, to allow subclassing in Python.
4165 * Python: Added basic documentation, and some examples.