1 Xapian-bindings 1.2.22 (2015-12-29):
5 * Stop maintaining ChangeLog files. They make merging patches harder, and stop
6 'git cherry-pick' from working as it should. The git repo history should be
7 sufficient for complying with GPLv2 2(a).
11 * Stop wrapping internal methods of Xapian::Weight.
13 * Return Error::get_description() rather than get_type + ": " + get_msg(). In
14 many cases this is the same, but if context or errno are available,
15 get_description() includes them.
17 * Catch and report std::exception rather than handling it as an unknown error
18 (so in particular std::bad_alloc will now be reported more helpfully).
22 * Fix configure test for whether $MONO can run CSharp programs - previously it
23 would always fail, which would mean that the CSharp tests would only be run
24 on systems where CSharp programs can be run directly.
28 * Send stderr from lua version check to config.log instead of letting it appear
33 * Fix memory leak and crash when using PHP subclasses of Xapian functors.
35 * Subclasses of XapianMatchSpy and XapianPostingSource with implicit
36 constructors now work.
40 * Add new testcase to catch any internal functions, methods, constants, etc
41 which have accidentally been wrapped.
43 Xapian-bindings 1.2.21 (2015-05-20):
47 * README: Remove note about the Lua bindings being experimental - it's not
48 really been true for some time now.
52 * Wrap missing constants OP_SYNONYM and STEM_ALL_Z.
54 * Add workaround for Perl defining a seed() macro which breaks compilation with
55 GCC in C++11 mode (due to <algorithm> now pulling in random number generation
56 classes with a method called seed).
58 * Update list of unwrapped things in POD documentation.
60 * Perl tests are ordering-dependent, so use .NOTPARALLEL to avoid problems
61 during parallel builds.
63 * Add test coverage for Enquire::set_collapse_key() with 1 and 2 parameters.
65 * Add test that we can create all the stemmers returned by
66 Stem::get_available_languages().
68 * t/symbol-test.t: If the symboltest module build fails, skip the test - it's
69 likely due to external reasons, like incompatible compiler flags being taken
70 from Perl's Config module, due to Perl having been built with a different
73 * Use croak_sv() or ERRSV if defined.
77 * README: Remove note about the subclassing bug with PHP 5.4 and later - that
82 * README: Add note that 1.3.2 has Python 3 support, and that this will be in
87 * smoketest.rb: Fix "warning: assigned but unused variable - mset".
89 * Ship generate-rdoc-stubs in the tarball. Reported by Matthias Klose in
90 https://bugs.debian.org/782270
92 Xapian-bindings 1.2.20 (2015-03-04):
96 * configure: Avoid using \? in sed command in Lua detection - it isn't
97 supported by all sed implementations.
101 * configure: Rework LUA_SO checks to be clearer and to properly handle LUA_SO
102 being specified without a leading '.'.
104 * configure: Add an example of specifying LUA_SO to --help output.
108 * Remove text about subclassing bug with PHP 5.4 and later - that was fixed in
111 * In current PHP releases, dl() is disabled in most SAPIs, and even where
112 available it will now only look in the configured extension directory. The
113 upshot is that there no longer seems to be a sane way to install the PHP
114 bindings without being root, so update the documentation to reflect this.
115 Fixes #661, reported by Felix Ostmann.
117 Xapian-bindings 1.2.19 (2014-10-21):
121 * Fix up SWIG generated C++ wrapper code so that subclassing of wrapped classes
122 in PHP works with PHP 5.4 and later. (Fixes #652, reported by Sebastian
125 * Fix XapianQueryParser::set_stopper() and XapianTermGenerator::set_stopper()
126 which were getting incorrectly wrapped such that they didn't actually do
127 anything. Fixes #659, reported by jmienert. This bug was introduced by the
128 reference tracking fix in 1.2.14.
132 * README: Note that Ruby 2.1 works too.
134 Xapian-bindings 1.2.18 (2014-06-22):
138 * README: Add links to Erlang and Node.js bindings.
142 * lua/smoketest.lua: Change expect() parameter order to the more natural (got,
143 expected), which most of the calls already used, and fix up the few calls
144 which passed (expected, got).
148 * php/smoketest.php: Add missing "exit(1);" after reporting failure of check
149 that MatchDecider returns an MSet with the expected docid in. Luckily this
150 wasn't masking a test failure.
154 * python/pythontest.py: There's no longer a need to use chert_open() explicitly
155 - chert is the default backend now, and both chert and brass support the
156 required functionality for the tests which do this, so this just needlessly
157 causes the tests to fail if chert is disabled in xapian-core.
159 * configure: If the Python version is too new or too old, only report it once
164 * configure: Fix Ruby bindings to build on Windows (and other platforms where
165 allow_undefined_flag=unsupported. (fixes#634, reported by Alexis Denis)
167 Xapian-bindings 1.2.17 (2014-01-29):
171 * Improve workaround which allows building against an uninstalled xapian-core
172 on OS X - this should now work with any uninstalled xapian-core (not only in
173 a tree with the same layout as an SVN or git checkout) and it also won't try
174 to build against "../xapian-core/.libs" just because it happens to exist.
175 (Backported from 1.3.1; fixes #322)
179 * configure: Some distros now point /usr/bin/python at Python 3, so the check
180 for a Python 2 interpreter now checks for 'python2' first, and checks that
181 the version of found interpreter is 2.x.
185 * Tweak configure to work with Ruby 2.0.
189 * Link against -ltclstubX.Y for Tcl 8.5 and later (reported by Sergei Golovan
190 in http://bugs.debian.org/724830).
192 * Use a better check for TCL_INC for Tcl 8.5 and later.
194 Xapian-bindings 1.2.16 (2013-12-04):
198 * README: Note that the SWIG Perl bindings should replace the XS ones in 1.4.x.
202 * Compress source tarballs with xz instead of gzip.
204 * configure: Handle git snapshot naming.
208 * configure: Update list of platforms where we tell libtool not to link in
209 deplibs to match the list used for xapian-core.
213 * Pass 0 instead of NULL for non-pointer parameter to av_fetch (spotted due to
216 * symboltest.t: Pass $CPPFLAGS and $CXXFLAGS from the environment through to
217 the sub-build, fixing failure when built with CPPFLAGS=-D_GLIBCXX_DEBUG.
221 * smoketest.php: If running under PHP >= 5.4, skip the tests we know will fail
222 with a message explaining this.
226 * Provide bindings version in xapian.__version__ as per PEP 396. (see #346)
228 * python/docs/examples/simpleexpand.py: Use Pythonic iteration over the ESet.
230 * pythontest.py: Fix testcase checking we get an exception from using
231 non-random-access iterators after then have advanced - previously these
232 didn't actually test as fully as intended.
236 * Omit internal classes and methods from the rdocs.
238 Xapian-bindings 1.2.15 (2013-04-16):
242 * Fix configure --enable-quiet option to actually work for the bindings.
246 * Fix doc typo: "as as" -> "as a"
250 * Fix deprecation warning in configure from Ruby 1.9.3.
252 Xapian-bindings 1.2.14 (2013-03-14):
256 * Fix typo in doccomment.
260 * Keep references to the PHP wrapper object when an object is set on another
265 * Allow TCL_INC to be passed to configure. (fixes #612)
267 Xapian-bindings 1.2.13 (2012-11-09):
271 * configure: Overhaul checks for C# tools to use modern names in preference.
275 * Fix examples to use str(query) to get the query description. (Fixes #600)
277 * Document that get_description() is mapped to str(), and end() to _end().
279 * Fix functor wrappers which return strings to be zero-byte clean.
283 * Forward port tests of StringValueRangeProcessor with a prefix or suffix from
284 1.2's XS Search::Xapian. (ticket#607)
286 * Update testsuite not to use UNIVERSAL::isa() as a function, since doing so
291 * Document that subclassing Xapian classes in PHP currently doesn't work with
294 Xapian-bindings 1.2.12 (2012-06-27):
296 No changes since 1.2.11 except to bump the version - this release was made to
297 fix an incorrect library version information update in xapian-core 1.2.11.
299 Xapian-bindings 1.2.11 (2012-06-26):
303 * Ship the scripts which generate the except.i files for Lua, Perl and Python.
307 * In generated C++ code, pass 0 instead of NULL for non-pointer parameter to
308 av_fetch() (spotted due to GCC 4.7 warning).
312 * Fix "make check" to work for PHP when building from a release tarball with
315 * Work around "undefined symbol: zend_error_noreturn" error.
317 Xapian-bindings 1.2.10 (2012-05-09):
321 * Use -keyfile and -keycontainer options to the C# compiler, because it warns
322 us to do this instead of setting them in AssemblyInfo.cs.
324 * Use diff's -c option when comparing the files SWIG generated against those we
325 were expecting to get as the output should be easier to understand.
327 * Sort both the lists of expected and of found SWIG-generated sources with
328 Perl, to avoid problems with locale-specific sort orders.
332 * Remove now superfluous old check that SWIG generated at least the sources we
333 want - we now check it generated *exactly* the sources we want.
335 * Use diff's -c option when comparing the files SWIG generated against those we
336 were expecting to get as the output should be easier to understand.
338 * Sort both the lists of expected and of found SWIG-generated sources with
339 Perl, to avoid problems with locale-specific sort orders.
343 * Now works with Lua 5.2.
345 * "require 'xapian'" now returns the module table. (ticket #593)
347 * lua/smoketest.lua: Improve reporting of test failures.
351 * Avoid importing isa from UNIVERSAL to fix Perl 5.12 deprecation warning.
353 * Remove #! lines with -W to fix "Name "Test::More::TODO" used only once:
354 possible typo at /usr/share/perl/5.14/Exporter/Heavy.pm line 190." warnings.
358 * python/docs/examples/simpleexpand.py: Update to not use deprecated MSet
359 iteration features which have been removed on trunk. This also fixes a
360 segfault if there are no matches and no documents are explicitly marked as
363 * python/testsuite2.py: Explicitly suggest "make check VERBOSE=1" as a simple
364 way to rerun tests with verbose output.
368 * configure: Make sure the ruby subdirectory exists before trying to create
369 ruby/rubyio.h, so this works in a VPATH build from a clean tree.
371 Xapian-bindings 1.2.9 (2012-03-08):
375 * configure: Fix test for jni.h to try looking for jni.h relative to the real
376 location of javac, which should work for more JDKs.
380 * Handle an exception from C++ by raising a xapian.Error object as an error in
383 * Rename get_description() methods to __tostring(), so that you can use write
384 tostring(obj) in Lua.
386 * configure: Honour LUA_LIB if already set. Fixes #581.
388 * configure: Improve probing for LUA_LIB, and also probe for LUA_SO so we
389 support platforms where the compiled Lua module isn't called .so.
393 * Add tests of Document::get_docid().
397 * Add a test that Query constructor taking OP_NEAR with a window size works.
401 * python/testsuite2.py: Don't run off the traceback looking for a test function
402 if the exception wasn't from a test function.
404 Xapian-bindings 1.2.8 (2011-12-13):
408 * Wrap user-subclassable functor objects by allowing the user to pass a
409 Lua function where the functor object would be passed in the C++ API.
413 * Fix "PHP Notice: Undefined variable: r in xapian.php". (Fixes bug#576)
415 * The PHP bindings will now work again with a version of PHP built with ZTS
416 enabled (which is the default on Microsoft Windows). This was broken by
417 the changes to support subclassing in PHP in the version of SWIG used since
422 * Add a module docstring. (Fixes bug #573)
424 * The python testsuite now checks for object leaks during each testcase.
426 * In test_matchingterms_iter, run the code we're testing for leaks twice, and
427 only check for leaks the second time to avoid falsely reporting a leak when
428 some cached value gets initialised under Python 2.5.
432 * Wrap optional prefix parameter to Database::allterms.
434 Xapian-bindings 1.2.7 (2011-08-10):
438 * INSTALL: Pull in a few updates from the latest version of the automake
439 document which this file was originally based on. Add in the missing
440 copyright and licensing information.
442 * INSTALL: Add --with-lua to list of options.
444 * INSTALL,README: It's no longer noteworthy that Mac OS X 10.1 and 10.2 aren't
445 supported as Apple ditched them long ago, so drop this as a "Known Issue" in
446 INSTALL and instead just say "Mac OS X >= 10.3" in the discussion of
447 supported platforms in the README.
449 * HACKING: Update and start section on deprecation warnings for the bindings.
453 * Add missing wrappers for Database::has_positions() and
454 TermIterator::positionlist_count(), and correct the return type of
455 Database::get_doclength() from double to Xapian::termcount.
459 * README: Note a recent version of Mono which we've tested the C# bindings
462 * Check that exactly the sources we expect are generated, and add some sources
463 which were missing from the list.
465 * Fix "make uninstall" so the compiled C++ module (typically _XapianSharp.so)
468 * Fix iterator ++ and -- so that the reference to the object isn't released
469 prematurely, which was causing an occasional crash if the garbage collection
470 happened at just the wrong moment,
472 * Add test coverage for QueryParser.ParseQuery() with flags argument.
474 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
478 * SmokeTest.java: Fix == comparisons with strings to use equals().
480 * Add test that string passing is zero byte safe.
482 * Fix MyExpandDecider.accept() to really check the passed parameter.
486 * Put the SWIG-generated Java bindings in package org.xapian.
488 * Wrap Query::MatchAll and Query::MatchNothing. (ticket#158)
490 * SmokeTest.java: Fix == comparisons with literal strings to use equals()
492 * Add test that string passing is zero byte safe.
494 * Fix MyExpandDecider.accept() to really check the passed parameter.
496 * Fix the compile JNI code to have a .jnilib extension on Mac OS X.
498 * Create an HTML documentation page based on java/README.
500 * Copy java examples from the hand-coded JNI ones.
502 * docs/examples/SimpleIndex.java: Update to use commit() rather than flush().
504 * Check that exactly the sources we expect are generated, and add some sources
505 which were missing from the list.
509 * Merge latest Lua changes from Xiaona Han.
511 * lua/smoketest.lua: Add simple test for Database::positionlist_begin().
513 * simpleexpand.lua: Don't try to add anything to the RSet if there are no
518 * Sync updates to examples from XS Search::Xapian:
520 + Require Perl >= 5.6 so we can "use warnings;".
522 + Loop over file using while() (which reads a line per iteration) not
523 foreach() (which reads the whole file up front).
525 * Wrap MatchAll and MatchNothing for Perl (as Search::Xapian::Query::MatchAll
526 and Search::Xapian::Query::MatchNothing). (ticket#158)
528 * perl/t/termgenerator.t: Test TermIterator::index_text() with two arguments.
530 * perl/Makefile.am: Fix "make check".
532 * perl/t/symbol-test.t: Fix to work when built against an installed
533 xapian-core. (ticket#558)
537 * php/smoketest.php: Install an error handler so the test fails if there are
538 any errors, warnings, notices, etc.
540 * Change PHP examples and test program to use 'include "xapian.php"' like user
541 code should (rather than 'include "php5/xapian.php"' as they did previously).
543 * Wrap MatchAll and MatchNothing for PHP as XapianQuery::MatchAll() and
544 XapianQuery::MatchNothing(). (ticket#158)
548 * Wrap MatchAll and MatchNothing for Ruby. (ticket#158)
550 Xapian-bindings 1.2.6 (2011-06-12):
554 * SWIG-based bindings are now generated with a newer version of SWIG
559 * On Mac OS X 10.5 or later, and 10.4 on x86, build Java JNI library with a
560 .jnilib extension as we do for older versions.
564 * Upgrading to newer SWIG fixes issues with strings with newer C# versions.
568 * Fix memory leaks when functions taking string parameters throw exceptions.
570 * Previously a hash table was used to map Java objects to C++ ones, but we
571 now just cast the address of the C++ object to a jlong (which is 64 bits
572 so will hold a pointer on current platforms). This is more efficient and
573 avoids the need for thread locks around accesses to the hash table.
575 * Remove explicit checks for NULL around calls to delete.
577 * Mark makefiles which build Java code as .NOTPARALLEL to avoid race conditions
578 during parallel builds.
582 * Add support for Lua, which is being developed by Xiaona Han during GSoC this
583 year. The current support should be regarded as experimental - it passes
584 its automated tests, but the details of the Lua API are likely to evolve as
585 the project progresses.
589 * README: say that Perl bindings probably need Perl 5.8 or later.
593 * Directors now work for PHP (ticket#488). New simplematchdecider.php example.
597 * python/pythontest2.py: With Python 2.7, gc.collect() doesn't always collect
598 all the garbage, so repeat until no further objects are freed.
599 (http://bugs.debian.org/625679 and https://bugs.gentoo.org/349484).
603 * ruby/smoketest.rb: Older Ruby 1.8.x doesn't have Dir.mktmpdir() - just skip
604 the compaction tests for these versions.
606 Xapian-bindings 1.2.5 (2011-04-04):
610 * README: Update info on SWIG-based Perl bindings.
612 * INSTALL: Copy new Multi-Arch section from xapian-core/INSTALL. Replace VPATH
613 section with better equivalent from xapian-core/INSTALL.
617 * Wrap ESet::get_eset() with min_wt parameter (new in C++ API in 1.2.5).
619 * configure: If xapian-core is a different release series, promote the
620 mismatched versions warning to an error.
624 * Mac OS X: Don't override MACOSX_DEPLOYMENT_TARGET on 10.5 and later, or
625 10.4 on x86, as the default if unset on these versions is the current OS
626 version. (ticket#541)
628 * python/pythontest2.py: In test_compactor(), close any open databases before
629 removing the directory as you can't delete an open database on Microsoft
630 Windows. (ticket#526)
634 * Don't pass extra flags to Microsoft's gacutil. (ticket#516)
636 * Clarify the licence is GPL "version 2 or later" in the meta information
637 we put in the module.
641 * Remove old and broken Enquire.get_matching_terms() method. We deprecated
642 Enquire.get_matching_terms() in 1.0.x, and removed it in 1.1.0, but
643 accidentally left an older version of get_matching_terms() exposed.
645 * Remove broken implementation of MSet.__contains__. This appears never to
646 have worked, and to have been broken for at least the past 3.5 years without
647 anyone mentioning it, and is probably of little use anyway, so no need to
650 * python/docs/index.html: Document that MSet.items and ESet.items are
651 deprecated, and what to use instead. Note that MSET_DOCUMENT never worked on
652 the tuple returned by MSet.items. (ticket#531)
654 * Add test coverage for mset.items.
658 * Add test coverage for Xapian::Compactor.
660 * Handle an empty response to $RUBY --version specially. This gives a less
661 opaque error in cases where the user specified RUBY but the value given
662 wasn't an executable file.
664 Xapian-bindings 1.2.4 (2010-12-19):
668 * Wrap the new Xapian::Compactor class. The resolve_duplicate_metadata()
669 virtual method is wrapped for subclassing for Python and Ruby currently.
671 * Eliminate separate Makefile.am in the docs subdirectory of each language
672 subdirectory and just inline any rules into the main sub-Makefile.am, which
673 allows more of the build to run in parallel.
675 * Don't ship some files which are generated at build time.
677 * configure: Need python in maintainer mode to run doxy2swig.py.
681 * RPM: Package the Perl bindings.
683 * RPM: Don't package _XapianSharp.la.
687 * For Mac OS X builds, set DYLD_LIBRARY_PATH to allow tests to find an
688 uninstalled Xapian library. See ticket #322.
690 * configure: Fix typo in code to set PYTHON_LIBS under cygwin. (ticket#509)
694 * Don't install _XapianSharp.la.
698 * Merge SWIG-based Perl bindings originally developed by Kosei Moriyama during
699 GSoC 2009. These are close to being a compatible replacement for the
700 hand-coded XS bindings in Search::Xapian but also offer a more complete
701 wrapping of the C++ API. We're planning to replace the XS bindings with the
702 SWIG ones for easier maintenance. We encourage you to try them and let us
703 know how you get on - particularly if you find cases where code which works
704 with the XS bindings doesn't work with the SWIG ones.
708 * Document that iterators shouldn't be dereferenced or advanced when at their
709 end points (ticket#520).
713 * Fix memory leaks in typemaps which return Python lists.
715 * MatchSpy can now be subclassed in Python. Remote use isn't currently
718 * configure: Use sys.version_info tuple, rather than string splicing which
719 assumes the Python "major.minor" is 3 characters (which would fail if Python
720 2.10 were ever released, for example).
722 Xapian-bindings 1.2.3 (2010-08-24):
726 * xapian-bindings.spec: Don't run autoreconf - it's no longer required.
728 Xapian-bindings 1.2.2 (2010-06-27):
730 * No user-visible change except for bumping the version to indicate
731 compatibility with Xapian-core 1.2.2.
733 Xapian-bindings 1.2.1 (2010-06-22):
735 This release includes all changes from 1.0.21 which are relevant.
739 * Wrap Xapian::StemImplementation. Currently this has only been tested for
744 * Remove non-functional disabled guile bindings left over from Open Muscat
745 days - if someone wanted to add guile bindings, it would be easier to start
750 * Update list of generated java sources in the SWIG-based Java bindings.
754 * zend_throw_exception() returns, so return control to PHP directly after
755 calling it to avoid needless extra work and possible issues.
759 * Fix "from xapian import *". (ticket#477)
761 * Fix testcase weight_normalise - a change in xapian-core means that
762 get_max_possible() can now return zero for a non-existent term, so don't
763 blindly calculate the reciprocal of it.
765 * python/replicationtest2.py: Extend to check that changesets get applied
768 * python/smoketest2.py: Check len(mset) works (improving test coverage of
769 Python-specific wrapping).
771 Xapian-bindings 1.2.0 (2010-04-28):
773 This release includes all changes from 1.0.20 which are relevant.
777 * configure: Tell libtool not to link in deplibs on platforms where we know
780 * configure: On Linux, extract the library search path from ldconfig which
781 gives us the default entries reliably.
783 Xapian-bindings 1.1.5 (2010-04-15):
785 This release includes all changes from 1.0.19 which are relevant.
789 * tcl8/docs/index.html: Document WritableDatabase::close() as a way to
790 sidestep the whole destructor issue. (ticket#62)
792 Xapian-bindings 1.1.4 (2010-02-15):
794 This release includes all changes from 1.0.18 which are relevant.
798 * Update for the new Brass backend and other C++ API changes.
800 * Wrap Database::get_doclength_lower_bound(),
801 Database::get_doclength_upper_bound(), Database::get_wdf_upper_bound(),
802 Database::valuestream_begin() and Database::valuestream_end() for all
803 languages. (ticket#431)
805 * Wrap ValueIterator::skip_to() and ValueIterator::check() for all languages.
809 * Wrap valuestreams as Database.valuestream(), returning a ValueStreamIter
810 object which dereferences to a ValueStreamItem object,
812 * Fix Enquire.clear_matchspies() wrapper which crashed in 1.1.3.
816 * Add safe wrapper for the valuestream iterator.
818 Xapian-bindings 1.1.3 (2009-11-18):
820 This release includes all changes from 1.0.15-1.0.17 which are relevant.
824 * configure: Default to looking for xapian-config-1.1 unless XAPIAN_CONFIG is
827 * Wrap the new MatchSpy class, and associated features.
829 * Don't wrap PostingSource::serialise(), Weight::serialise() and
830 Weight::unserialise() as they aren't useful from the bindings.
832 * Update for the Sorter to KeyMaker changes.
836 * Fix PHP bindings to build when PHP has been compiled in multithreaded mode,
837 as it standardly is on Microsoft Windows. Fixes #411.
839 * Merged the PHP "smoketest" back together now we don't need to support
844 * Fix a memory leak on error (in theory - we've not got a way to generate this
845 error, so haven't been able to reproduce the leak or test the fix).
847 Xapian-bindings 1.1.2 (2009-07-23):
849 This release includes all changes from 1.0.14 which are relevant to trunk.
853 * Several changes towards fully supporting Python 3, but more work is required.
856 Xapian-bindings 1.1.1 (2009-06-09):
858 This release includes all changes from 1.0.13 which are relevant to trunk.
862 * Wrap the recently added extra parameter to Enquire::set_collapse_key().
866 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
867 C# yet, and to use Query("") and Query() instead.
869 * configure: If we don't find a C# compiler, don't test an empty command name
870 further which saves a fork and avoids an odd looking message.
874 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
875 PHP yet, and to use Query("") and Query() instead.
879 * Wrap Query::MatchAll and Query::MatchNothing for Python and document how they
880 are wrapped (ticket#158).
882 * python/smoketest2.py,python/smoketest3.py: Update tests with FLAG_PARTIAL to
883 expect SYNONYM in generated query.
887 * Document that Query::MatchAll and Query::MatchNothing aren't wrapped for
888 Ruby yet, and to use Query("") and Query() instead.
892 * Wrap Query::MatchAll and Query::MatchNothing for Tcl and document how they
893 are wrapped (ticket#158).
895 Xapian-bindings 1.1.0 (2009-04-22):
899 * INSTALL: Python 2.6 and later look in ~/.local for Python modules so update
900 the instructions to suggest users use this standard location for installing
905 * All deprecated features slated for removal in 1.1.0 have been removed.
907 * All new C++ API features have been wrapped. Also, since we now supply some
908 standard MatchDecider subclasses, we now wrap Enquire::get_mset() so that
909 these can be passed in even for languages for which SWIG doesn't support
914 * xapian-bindings.spec: Updated to reflect the new Python packaging.
918 * configure: Use XAPIAN_CXXFLAGS for test compiles since it may include options
919 to put the compiler into ISO C++ mode).
923 * PHP4 support has been removed, since PHP4 is no longer supported upstream
928 * Python 2.3 or later is now required. 2.2 is essentially unsupported
931 * The import method used has been changed (by using a newer SWIG version)
932 and no longer gives a warning with Python 2.6.
934 * Initial support for Python 3.0 has been added. This currently doesn't
935 work correctly and should be treated as experimental. (ticket#346)
937 * The newer SWIG version handles exceptions in director methods correctly
938 so we no longer need our workaround for ticket #289.
940 * Database::metadata_keys_begin() and Database::metadata_keys_end() are
941 wrapped for Python as Database.metadata_keys().
943 * The Python bindings are now installed as a python package, with the
944 files in a xapian subdirectory, hiding the internal _xapian module
947 * Python now flags deprecation warnings for the single argument form and old
948 parameter name (ascending) in set_sort_by_key(), set_sort_by_value() and
951 Xapian-bindings 1.0.23 (2011-01-14):
955 * configure: Fix typo in code to set PYTHON_LIBS under cygwin. (ticket#509)
959 * Document that iterators shouldn't be dereferenced or advanced when at their
960 end points (ticket#520).
964 * Fix memory leaks in typemaps which return Python lists.
966 Xapian-bindings 1.0.22 (2010-10-03):
970 * RPM: Don't package _XapianSharp.la.
974 * Don't install _XapianSharp.la.
978 * configure: Use sys.version_info tuple, rather than string splicing which
979 assumes the Python "major.minor" is 3 characters (which would fail if Python
980 2.10 were ever released, for example).
982 * Add test_xapian_star.py to distribution - fixes failure of "test_import_star"
983 testcase in pythontest.py.
985 Xapian-bindings 1.0.21 (2010-06-18):
989 * xapian.BAD_VALUENO is now wrapped as a constant rather than variable which
990 can't be written to. (ticket#297)
992 * Fix cleaning of test directories to use "rm -rf" rather than "rm -f".
994 * Add test to check that "from xapian import *" works.
996 Xapian-bindings 1.0.20 (2010-04-27):
1000 * Set PYTHONDONTWRITEBYTECODE=1 in the environment to prevent Python from
1001 generating .pyc files in srcdir for Python >= 2.6, and use a Bourne shell
1002 trap to delete them after running tests for older versions of Python.
1007 * configure: Fix typo so path to ruby is reported if Ruby < 1.8 is found.
1009 Xapian-bindings 1.0.19 (2010-04-15):
1013 * tcl8/docs/index.html: Improve wording in a few places.
1015 Xapian-bindings 1.0.18 (2010-02-14):
1019 * Wrap new C++ API method Document::add_boolean_term().
1023 * Generate entries in the Ruby rdocs for all classes which aren't documented
1024 because of Ruby-specific methods. Fixes ticket#417.
1026 * Avoid absolute paths in the generated rdocs.
1028 Xapian-bindings 1.0.17 (2009-11-18):
1032 * Improve RPM package summaries - the files are needed to *use* scripts as well
1033 as to develop them. Use "Tcl" instead of "TCL" as the former is more
1038 * python/Makefile.am: Restore the "./" path to the sourced file
1039 libtoolconfig.tmp as ksh requires it.
1043 * Fix memory leak when passing a MatchDecider to Enquire::get_mset().
1045 Xapian-bindings 1.0.16 (2009-09-10):
1049 * Improved docstrings for QueryParser::set_default_op() and
1050 QueryParser::get_default_op() (automatically generated from changes in
1053 Xapian-bindings 1.0.15 (2009-08-26):
1057 * Don't break long words when wrapping text in the generated API documentation
1058 comments as this was causing identifiers to be broken in two.
1060 Xapian-bindings 1.0.14 (2009-07-21):
1064 * configure: If $CSC is empty, don't try to run it. This was a cosmetic bug
1065 and the only side-effect was an odd looking message.
1069 * Rename methods at build-time using SWIG rather than a run-time in Python, as
1070 the latter approach adds a small time overhead when the module is being
1075 * Fix to accept an integer value > MAXINT for a double parameter.
1077 Xapian-bindings 1.0.13 (2009-05-23):
1081 * xapian-bindings.spec: Update C# packaging for rename of XapianSharp.so to
1082 _XapianSharp.so in 1.0.11.
1084 * xapian-bindings.spec: Update Tcl8 packaging for where we now install the
1085 bindings since 1.0.6.
1089 * Backport fix from SWIG SVN for misuse of formatted error function in
1090 SWIG-generated code.
1094 * Change the SWIG-generated wrapper code so it doesn't attempt to acquire
1095 Python's Global Interpreter Lock (GIL) in situations where we know that it
1096 will already be locked. This avoids some dead-locks with mod_python (due to
1097 mod_python bugs which are apparently unlikely to ever be fixed), and results
1098 in smaller wrappers which run a little faster (in tests with Xapian on x86-64
1099 Ubuntu 9.04, the stripped wrapper library was 11% smaller and ran 2.7%
1100 faster). (ticket#185)
1102 * README,python/docs/index.html: Update documentation of the above mod_python
1103 issue and also document the related mod_wsgi issue. The status is now that
1104 everything seems to work if you stick to the main interpreter (ticket#364).
1106 * Backport fix from SWIG SVN for misuse of formatted error function in
1107 SWIG-generated code.
1109 * python/docs/examples/simplematchdecider.py: Read "avoid_value" from the
1110 second parameter, not the third.
1112 * python/docs/examples/simplematchdecider.py,
1113 python/docs/examples/simplesearch.py: Make use of str.join() for simpler,
1118 * README: Note that the testsuite fails due to a bug in the test/unit module in
1119 Ruby 1.9.0, but applications using the bindings should work, and that the
1120 testsuite works with Ruby 1.9.1. Drop all mention of Ruby 1.6.x as that
1121 appears to be completely dead both upstream and in the wild.
1123 Xapian-bindings 1.0.12 (2009-04-19):
1127 * INSTALL: Add a note about being able to pass variables to configure to pick
1128 which of several parallel installations of a language to build for.
1132 * python/pythontest.py: Round the weights returned for the OP_SCALE_WEIGHT
1133 test to avoid failing due to rounding differences.
1135 * python/testsuite.py: Remove bare except: handlers from testsuite, so Ctrl-C
1136 stop the whole testsuite, not just the currently running testcase.
1138 Xapian-bindings 1.0.11 (2009-03-15):
1142 * README: Note that 1.0.x doesn't (and isn't currently planned to) support
1143 Python 3, and possible current issues with Ruby 1.9.
1147 * Merge fixes from Cygwin Ports, so bindings should build out of the box on
1152 * python/docs/examples/: Use str(obj) rather than obj.get_description() (the
1153 latter is deprecated, and support was removed in 1.0.0).
1155 * Add support for using the new name ("reverse") for the second argument of
1156 set_sort_by_key() and set_sort_by_value() and friends as a named parameter.
1157 The old name ("ascending") is still supported, but will be deprecated in
1160 * Keep Python references to Sorter, Stopper, and ValueRangeProcessor objects
1161 which get set on other objects to avoid segmentation faults if they go out
1162 of scope before the object they are set on does. (ticket#341)
1166 * Fixes for Ruby 1.9 compatibility (ticket#323). The test harness currently
1167 fails so "make check" doesn't pass, but code using the bindings should work.
1169 Xapian-bindings 1.0.10 (2008-12-23):
1173 * Need to clean testsuite.pyc from srcdir since that's where it gets generated
1174 as things stand (upstream fix for Debian bug 506090).
1176 Xapian-bindings 1.0.9 (2008-10-31):
1180 * configure: Add support for "--enable-quiet" like xapian-core and omega have.
1182 * Wrap new Database::metadata_keys_begin() and Database::metadata_keys_end()
1185 Xapian-bindings 1.0.8 (2008-09-04):
1189 * configure: Report bug report URL in --help output.
1193 * Fix mangling of exceptions thrown from Python subclasses of Xapian classes.
1196 * Fix memory leaks in the xapian.Query constructor. (bug#294)
1198 Xapian-bindings 1.0.7 (2008-07-14):
1202 * Document how all the database factory functions and library version functions
1203 are wrapped for all languages.
1207 * Fix to build against a xapian-core which has quartz and/or flint disabled.
1209 * The "program" version of Remote::open() has been wrapped for some time, so
1210 update the documentation which said it wasn't.
1214 * xapian-bindings.spec: Remove "www." from xapian.org and oligarchy.co.uk URLs.
1218 * For Java, Python, and Ruby, use the libtool -shrext option to specify a
1219 different module extension rather than our own ugly bodge.
1223 * Make passing string from Java to C++ zero-byte safe. It doesn't appear to be
1224 simple to make C++ to Java work though.
1228 * Add test that OP_VALUE_GE works for PHP.
1232 * Several corrections to the Python documentation.
1234 * configure: Fix problem with building under mingw.
1238 * Include simplematchdecider.rb example.
1240 * smoketest.rb: Test the version reporting functions.
1244 * Include simpleexpand.tcl example.
1246 * Fix where the Tcl module gets installed.
1248 * README: Note that Tcl 8.3 and earlier are no longer supported by upstream.
1250 Xapian-bindings 1.0.6 (2008-03-17):
1254 * Wrap OP_VALUE_GE and OP_VALUE_LE and the new Query constructor which they are
1257 * configure: Correct the required SWIG version given in an error message.
1261 * php/smoketest.php: Add note that this script should be run using 'make check'
1262 in the build tree (rather than trying to copy it to a webserver as someone
1265 * php/smoketest.php: Fix to work under PHP4.
1269 * The Python module now always has the extension which Python expects, which
1270 fixes a failure on Mac OS X.
1274 * Automatically install/uninstall the Ruby rdoc-generated documentation along
1275 with the ruby bindings.
1279 * configure: Sort out the default value of TCL_LIB, which could end up being
1280 under /usr/share in xapian-bindings 1.0.4 and 1.0.5.
1282 Xapian-bindings 1.0.5 (2007-12-21):
1286 * Wrap Xapian::Sorter and subclasses.
1288 * Wrap Enquire::set_sort_by_key(), Enquire::set_sort_by_key_then_relevance(),
1289 and Enquire::set_sort_by_relevance_then_key().
1291 * Factor out the code to protect multitarget rules against parallel make, and
1292 fix it to handle the source being changed while the rule is executing, and to
1293 correctly return an error code if we fail while trying to recover from the
1294 removal of a target of a multi-target rule.
1296 * configure: Improve the clarity of the error given when none of the tools
1297 needed for any supported language are found.
1299 * configure: SWIG 1.3.32 has now been released, so require at least this
1300 released version for maintainer builds.
1304 * Add explicit '#include <cstring>' to fix build with the latest snapshots of
1307 * configure: Log the output of trying to compile conftest.java in config.log;
1308 if the test fails, report whether the failure was compiling or running the
1311 * Check for directory existence rather than calling mkdir unconditionally as
1312 despite the "(ignored)", the error message seems to confuse some people.
1316 * Add feature test for XapianMultiValueSorter.
1318 * php/smoketest5.php: Fix use of Database_get_document to new style OO
1319 interface. Fix the error reported when the PHP5 exception test fails.
1321 * php/smoketest.php: Add feature test to confirm that optional arguments to
1322 XapianQuery's "term" constructor are wrapped.
1326 * Don't drop the GIL when calling Xapian.MSet.items and Xapian.ESet.items -
1327 these properties build a python list, so dropping the GIL isn't safe and
1328 may cause undefined behaviour in multithreaded environments.
1330 * configure: Update error message to reflect requirement for at least python
1333 * configure: Change "print foo" to "print(foo)" in python version checks, for
1334 compatibility with python 3.0.
1338 * The Ruby bindings now work on Mac OS X (the Ruby module's extension was
1339 previously incorrect).
1341 * Run "rdoc" to generate HTML for the Ruby-specific API documentation which
1342 ruby/docs/index.html previously had a dead link to.
1346 * configure: Overhaul code to find tcl.h since the old version no longer worked
1347 with Debian unstable.
1349 * tcl8/docs/index.html: Update documentation to cover flint and mention that
1350 quartz is now deprecated.
1352 * Remove code to handle `const char *' exceptions - as of 1.0.0 the QueryParser
1353 throws QueryParserError instead.
1355 Xapian-bindings 1.0.4 (2007-10-30):
1359 * Wrap new OP_SCALE_WEIGHT query operator, and corresponding Query constructor.
1360 Add feature tests for all languages.
1362 * The "bindings.html" file documenting each of the bindings has been renamed to
1367 * Fix the PHP Makefile.am to work with autoconf < 2.60 to fix RPM builds for
1372 * Fix warnings when compiling with GCC 4.2.
1376 * Update to newer SWIG SVN snapshot to fix memory leaks in wrapped constructors
1377 and methods/functions which return a wrapped class.
1379 * For PHP4, wrap Xapian::sortable_serialise() as xapian_sortable_serialise()
1380 and Xapian::sortable_unserialise() as xapian_sortable_unserialise().
1382 * Document how non-class functions are wrapped.
1384 * Fix wrapping of NumberValueRangeProcessor for PHP4.
1386 * smoketest.php: Split the regression test for bug#193 into separate
1387 versions for PHP4 and PHP5 as the previous version only worked for PHP5.
1391 * python/docs/index.html: Promote the Pythonic iterators, and deprecate the
1392 non-pythonic iterators. Make it clearer that the "sequence API" is
1395 * Add test of a custom ValueRangeProcessor (ie, one written in python).
1397 * Update the examples to use the new-style attributes to access MSet item
1398 values rather than the old-style MSET_* constants.
1400 * Document MSET_DOCUMENT.
1404 * smoketest.rb: Rename test of metadata access methods which had been named the
1405 same as the matchdecider test due to a copy-and-paste error.
1407 Xapian-bindings 1.0.3 (2007-09-28):
1411 * Wrap new methods Database::get_metadata() and
1412 WritableDatabase::set_metadata().
1414 * "make uninstall" now removes the loadable module we install for each of
1417 * "make distcheck" now works.
1419 * Distribution tarballs are now in the POSIX "ustar" format since it saves
1420 about 40KB and we need to use it for xapian-core anyway.
1424 * RPMs: Package xapian.php.
1428 * Remove wrapper for ValueRangeProcessor::operator(), since it can't be
1429 usefully used currently.
1433 * Remove wrappers for the Muscat36 backend, which has now been dropped from the
1436 * "make clean" now removes the class files generated for inner classes.
1440 * Add feature test for DateValueRangeProcessor when used with QueryParser.
1442 * ValueRangeProcessor::apply() can now be called from PHP (bug#193). This
1443 isn't actually very useful, since you can't subclass it in PHP currently.
1445 * Fixed wrapping of Enquire::set_cutoff() - previously this would only work
1446 if the third parameter was specified and a floating point number (e.g. 0.0).
1448 * php/docs/bindings.html: Fix errors in example code.
1452 * ValueRangeProcessor::operator() is now wrapped as a __call__ method in
1453 Python which takes two strings and returns a 3-tuple (value_number,
1454 modified_begin, modified_end). Previously this always failed with a
1455 type error, so this doesn't break existing code.
1457 * python/pythontest.py: Interpret any commandline arguments as a list of
1458 tests to be run (the default is to run all tests).
1460 * README,python/docs/bindings.html: Add a note about the problems with
1461 mod-python (as described in bug #185).
1463 * python/pythontest.py: Delete the database handles before deleting a database
1464 to fix problems running the Python tests on MS Windows (bug#179).
1466 * "make clean" now removes testsuite.pyc.
1470 * Check for RUBY_INC, RUBY_LIB, and RUBY_LIB_ARCH in the environment or on
1471 the configure command-line. The defaults for RUBY_LIB and RUBY_LIB_ARCH are
1472 now the site-specific directories, which is more correct when building
1473 from source. Debian packages, etc can override this by setting RUBY_LIB and
1478 * Check for TCL_LIB in the environment or on the configure command-line to
1479 allow installing without root access more cleanly.
1481 Xapian-bindings 1.0.2 (2007-07-05):
1485 * Document use of PYTHON_LIB and PHP_EXTENSION_DIR instead of pylibdir and
1488 * Remove documentation of removed "--with-swig" configure option.
1492 * Add methods of NumberValueRangeProcessor for serialising and
1493 unserialising doubles.
1495 * Add methods and constants supporting spelling correction and synonyms.
1497 * Value of XAPIAN_CONFIG supplied to configure is now passed to distcheck,
1498 to ensure that it works with uninstalled copies of Xapian.
1500 * Value of PYTHON_LIB supplied to configure is now respected - previously
1501 it was documented, but ignored.
1503 * Add support for supplying PHP_EXTENSION_DIR to configure.
1505 * Change to using "%include", rather than reproducing contents of header
1506 files, for "queryparser.h", "document.h" and "postingiterator.h".
1508 * Add new form of get_mset() which allows a matchspy matchdecider to be
1511 * RPMs: Don't mention %makeinstall in a .spec file comment as that makes RPM
1512 explode. Add in a missing "mv" in the command for installing tcl8
1517 * Fix rule handling parallel make to include xapian_wrap.h
1521 * Install xapian.php as <PREFIX>/share/php<PHPMAJOR>/xapian.php. There
1522 doesn't seem to be a standard location, but this works for Debian at
1523 least, and it seems better to at least try to install it.
1525 * Rename ValueRangeProcessor and subclasses and TermGenerator to have a Xapian
1530 * Fix a threading problem: the GIL was not being acquired in the exception
1531 handling code before setting the Python exception state, leading to
1532 various memory corruption symptoms in threaded programs.
1534 * Add special iterators to Database for synonyms, synonym_keys and
1537 * Add test cases for OP_VALUE_RANGE queries, getting spelling corrections,
1538 synonym iterators and spelling iterators.
1540 * In the test suite, expect_query() now adds "Xapian::Query(" and ")" around
1541 the expected description to make the tests more readable.
1543 Xapian-bindings 1.0.1 (2007-06-11):
1547 * NEWS: Fix the recent headings which said "Xapian-core" to say
1552 * Wrap Xapian::Query constructor for creating ValueRange queries.
1554 * Wrap new forms of Xapian::Database::allterms_begin() and allterms_end()
1555 which take a prefix.
1559 * RPMs: Use "make install" instead of %makeinstall to avoid doubled
1560 %{buildroot} prefix on most files which we then have to work around.
1564 * SimpleIndex now uses Xapian.TermGenerator.
1566 * SimpleSearch now uses Xapian.QueryParser.
1568 * New SimpleExpand example.
1570 * Document explicitly how STEM_SOME constants are currently wrapped.
1572 * Update GetTermName() reference in documentation to GetTerm().
1574 * SmokeTest.cs: Update comment about Portable.NET bug - the bug is fixed in
1575 their CVS repo, and the fix should be in their 0.8.2 release.
1579 * `configure --help' documented that environmental variable JNI_INCLUDE_DIR was
1580 looked at, but in fact its value was read but ignored. We now use it as the
1581 first place to look for jni.h.
1583 * configure will now automatically add an extra "-I" for the
1584 linux/solaris/win32 subdirectory which Sun's JDK requires.
1586 * Document JAVA_HOME and JDK_HOME in ./configure --help and mark them as
1587 "precious" so their values are preserved for when configure is automatically
1592 * Enquire::get_mset(first, maxitems, omrset) now works for PHP5.
1594 * The PHP examples have been rewritten to be clearer and to make use of the
1595 new XapianTermGenerator class.
1599 * Python examples now use xapian.QueryParser and xapian.TermGenerator.
1601 * Add support for prefix-restricted pythonic allterms iterators.
1603 * Update documentation in a couple of places to refer to updated replacements
1606 * Change testsuite output to be more vim-friendly (vim should be able to jump
1607 to the right lines now).
1609 * __str__ on Xapian::Error now includes extra information in some cases (the
1610 error_string and context, if they are set).
1612 * python/smoketest.py: Eliminate uses of the legacy sequence API.
1614 * python/pythontest.py: The legacy sequence API is only supported for Python
1615 2.3 and later, so don't run tests for it when running under Python 2.2.
1617 * We now generate and install xapian.pyo as well as xapian.pyc.
1621 * The Ruby examples now use the Xapian::QueryParser and Xapian::TermGenerator
1624 * Add missing rename for the C++ TermGenerator::set_document() method so it can
1625 be used as "tg.document = doc" in Ruby.
1627 * Fixed compilation on Mac OS X and warning from GCC on 32-bit Linux platforms.
1631 * tcl8/docs/examples/simpleexpand.tcl: New example to demonstrate relevance
1632 feedback, based on C++ simpleexpand.cc.
1634 * tcl8/docs/example/simpleindex.tcl: New simpler example making use of the
1635 TermGenerator class.
1637 * tcl8/docs/example/simplesearch.tcl: New simpler example making use of the
1640 * tcl8/docs/bindings.html: Document how constants are wrapped.
1642 * Update smoketest and examples to require version 1.0.0 - previously this
1643 required 0.9.6, which failed since TCL doesn't accept differing major
1646 * pkgIndex.tcl is now generated by configure.
1650 * The required automake version has been lowered to 1.8.3, so RPMs can now be
1651 built on RHEL 4 and SLES 9.
1653 Xapian-bindings 1.0.0 (2007-05-17):
1657 * Document Unicode support for each language.
1659 * Assorted minor improvements and typo fixes.
1663 * Add wrappers for ExpandDecider, and Enquire::get_eset() variants which use
1664 it, for languages where SWIG supports directors.
1666 * Wrap new features: TermGenerator, ValueRangeProcessor hierarchy, the
1667 OP_VALUE_RANGE query operator, the new overloaded form of parse_query, which
1668 allows the "default_prefix" argument to be supplied, QueryParser flags
1669 FLAG_PURE_NOT and FLAG_PARTIAL.
1671 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
1673 * Remove wrappers for deprecated features removed from the C++ API (see
1674 docs/deprecation.html in xapian-core for full details and upgrade
1677 * Deprecate ESetIterator::get_termname() in favour of ESetIterator::get_term().
1679 * QueryParserError is now a real error, so remove special handling for "const
1682 * Use a stamp file in "make" rules with multiple targets so that parallel
1685 * configure: Now quotes $PYTHON, etc so that you can specify a program with
1688 * configure: If the user specifies a program which doesn't exist (e.g.
1689 PYTHON=/opt/bin/ptyhon) don't autoprobe after failing to find it.
1691 * configure: Disable probes for f77, gcj, and rc completely by preventing
1692 the probe code from even appearing in configure - this reduces the size of
1693 configure by 28% and should speed it up significantly.
1695 * configure: If the version check against the xapian-core version detects a
1696 mismatch, we now issue a warning rather than a hard error since if you're
1697 careful this can work. The warning is issued late on in configure, so it's
1698 harder for the user to miss.
1700 * configure: The --with-swig option has been removed. It no longer has a
1701 purpose as we now ship the files which are generated by SWIG.
1705 * The PHP bindings can now be built with MSVC for Microsoft Windows.
1709 * When using Mono 1.2, we must build with gmcs (the C# 2.0 compiler) rather
1710 than mcs to avoid segmentation faults at runtime due to unimplemented
1711 features in mcs. Document this, and update configure to prefer gmcs.
1713 * The return type of MatchDecider::operator() is now `bool' rather than `int'
1714 (in line with the same change in the C++ API).
1716 * Xapian.Stem.StemWord() deprecated in favour of Xapian.Stem.Apply().
1720 * The Java bindings have been updated to use C++ replacements for deprecated
1721 methods, so they still build. The Java wrappers still provide the old
1722 deprecated names for now though. The longer term plan is to replace the
1723 hand-written JNI with SWIG generated wrappers (work has now begun on this)
1724 which is likely to require some API changes, and it seems more sensible to
1725 make any changes to align with C++ API changes at the same time.
1727 * Enquire.getQuery() is implemented entirely in Java, so strip out the unused
1728 MyQuery mechanism, and so fix a memory link which it caused (bug#105).
1732 * Fix undefined behaviour in get_matching_terms().
1734 * Document the (existing) renaming of methods which are PHP reserved words
1735 (empty() to is_empty() and clone() to clone_object()).
1737 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
1741 * The Python bindings now throw exceptions as classes with a hierarchy which
1742 mirrors that of the C++ Xapian::Error and its subclasses. The xapian.Error
1743 base class inherits from the standard Python Exception class.
1745 * All Python methods which accept strings can now be passed either a unicode
1746 object or a simple string. Strings are returned as simple strings: unicode
1747 input will be returned as utf-8 encoded output. The documentation now
1748 contains a "Unicode" section.
1750 * The Python bindings should now be usable more efficiently from threaded
1751 Python applications since we now use SWIG's -threads option when generating
1752 them, so that the GIL is released during long-running Xapian operations
1755 * Most classes, methods, functions, etc now have docstrings which are either
1756 automatically extracted from the C++ documentation comments, or overridden by
1757 more appropriate versions.
1759 * Most of the Pythonic iterators now return an object instead of a sequence,
1760 which means they now lazily fetch the information which previously had to be
1761 fetched to put it in the sequence. The old sequence API is supported for
1762 compatibility, but is scheduled for removal in Xapian 1.1.0.
1764 * Those Python iterators which have skip_to() methods now return the item
1765 skipped to, and next() will return the following item. Previously, they
1766 returned None, and next() returned the item skipped to. Several bugs in the
1767 skip_to() wrappers were fixed.
1769 * Because of the lazy access, some objects returned by iterators will raise
1770 an error if the lazy evaluation happens after the iterator has moved on
1771 (since the underlying Xapian API doesn't allow efficient access to the
1772 information in this situation). The exact semantics are defined in the
1773 docstrings for each iterator.
1775 * Those Pythonic iterators which return only a list of terms now return
1776 simple strings, instead of a sequence or an object containing the term. This
1777 is an incompatible change with earlier releases. The affected iterators are
1778 Enquire.matching_terms, Query.__iter__, QueryParser.stoplist and
1779 QueryParser.unstemlist.
1781 * The contents of an MSet can now be iterated in the standard Python way.
1782 The iteration will return MSetItem objects. The __contains__ and __getitem__
1783 methods are also implemented, allowing the "in" and [] operators to work.
1784 MSet.__getitem__ is a synonym for MSet.get_hit.
1786 * MSet.get_hit() now returns an MSetItem object instead of an MSetIterator,
1787 so that lazy access to its attributes is supported. MSetItem has some
1788 deprecated methods which mimic the MSetIterator interface to allow old code
1789 to work without modification until release 1.1.0.
1791 * MSetItem provides access to the collapse_key and collapse_count, which
1792 weren't accessible from the sequence returned by the iterators before this
1795 * Out-of-range access to MSets will now raise an IndexError - it used to
1796 cause undefined behaviour (usually a crash).
1798 * The Python testsuite is now much more extensive, and supports colour output
1799 and verbosity levels, much like the C++ testsuite. Tests of deprecated
1800 features are separated out, so that they can easily be removed when the
1801 features are removed. The Python tests currently focus mainly on Python
1802 specific iterators and related functionality - general Xapian behaviour is
1803 tested by the C++ testsuite.
1805 * The pure Python code in the bindings now uses new-style classes, since we
1806 have required Python >= 2.2 since Xapian release 0.9.9.
1808 * Enquire.get_matching_terms is now deprecated - use Enquire.matching_terms
1811 * The get_description() method which many classes support has been deprecated
1812 in favour of new more pythonic __str__ methods, so that the str() builtin can
1813 be used. get_description() is deprecated and scheduled for removal in 1.1.0.
1817 * We no longer regard the Ruby bindings as "beta quality", so remove the
1818 warning from their documentation.
1820 * Document that that C++ operator() becomes the method "call" in Ruby.
1822 * Don't read termfreq in safe wrapper for Document::termlist_begin(). Don't
1823 read wdf in safe wrapper for Database::allterms_begin() (bug#133).
1827 * Deprecated Xapian::Stem's stem_word() method in favour of apply().
1829 Xapian-bindings 0.9.10.1 (2007-04-04):
1833 * Fix PHP5 class wrapper generation in a few cases for overloaded methods with
1834 default parameters. The most notable case was a missing Query constructor
1835 which meant that QueryParser was unusable.
1837 * Fix compilation of the PHP4 bindings with ZTS-enabled versions of PHP
1838 (which mostly seems to mean the MS Windows version).
1840 * Fix PHP5 crash on exit with ZTS-enabled versions of PHP (which mostly
1841 seems to mean the MS Windows version).
1843 * Add note to the documentation that PHP examples are written for CLI version
1844 of PHP, but that the bindings work with any version.
1846 * Add check to all PHP examples that they are being run under a CLI version of
1851 * simpleexpand.py: Print each term's expand weight as a floating point value,
1856 * INSTALL: document how to install Xapian's Ruby bindings in your home
1859 Xapian-bindings 0.9.10 (2007-03-04):
1863 * Under Mac OS X, automatically look in the standard location for jni.h,
1864 and automatically rename the JNI library we build to ".jnilib", as is
1865 required by the OS X JVM.
1867 * java/README: Note success with Sun's JDK 1.5.0_06-b05, plus the requirement
1868 to add the linux header directory to the include path when using this JDK.
1870 * Add missing default constructor for RSet class - it's not much use without
1873 * Fix Enquire.getESet() to actually work.
1875 * Fix bug in ESetIterator.hasNext().
1877 * Fix MatchDecider and ExpandDecider so subclassing in Java actually works.
1879 * Fix memory leak with some JVMs in the "Query from array" constructor.
1881 * Fix memory leak in Enquire.setQuery().
1883 * SmokeTest.java: Add regression tests for RSet default constructor,
1884 Enquire.getESet(), ESetIterator.hasNext(), MatchDecider, ExpandDecider.
1885 Add feature tests for Enquire.getQuery(), and to make sure we get passed
1886 the right document in a java subclass of MatchDecider.
1888 * configure: Look for jni.h in $JAVA_HOME/include and $JDK_HOME/include if the
1889 respective variables are set.
1893 * Update the documentation to fix out-of-date information and document the
1894 differences between the PHP4 and PHP5 wrappers.
1896 * Update the examples to use the new Object Oriented API, and provide versions
1897 for both PHP4 and PHP5.
1899 * Add a "simpleexpand" example.
1901 * For PHP4, Xapian::DB_CREATE_OR_OPEN should be wrapped as
1902 Xapian_DB_CREATE_OR_OPEN not DB_CREATE_OR_OPEN, so wrap it with the
1903 new name, but keep the old name for now for backward compatibility.
1905 * configure: Try `$(PHP_CONFIG) --php-binary` when looking for a PHP
1906 interpreter - this works with PHP5.
1908 * configure: Remove the sanity check for PHP_EXTENSION_DIR added in Xapian
1909 0.9.8 - if Xapian is the first PHP extension to be installed, the extension
1910 directory may not exist and "make install" will create it.
1912 * configure: If zend.h isn't found and configure was run with "--with-php",
1913 exit with an error rather than automatically disabling PHP support.
1917 * Fix a problem which preventing building for Python 2.5 on 64 bit platforms.
1921 * RPMs: Add support for passing "--without python" to rpmbuild. Document the
1922 various "--without" options in a comment at the start of the .spec file.
1924 * RPMs: Remove "." from the end of the Summary.
1926 Xapian-bindings 0.9.9 (2006-11-09):
1930 * Ship our custom INSTALL file rather than the generic one from autoconf which
1931 we've accidentally been shipping instead since 0.9.5.
1935 * Wrap Flint::open() and Flint::open_writable().
1937 * configure: Require SWIG 1.3.30 (1.3.30 isn't out yet, but 1.3.30rc1 is
1942 * Generate the bindings using SWIG 1.3.30rc1 which fixes a build error on 64
1943 bit platforms with Python 2.5.
1947 * RPMs: Prevent binaries getting an rpath for /usr/lib64 on FC6.
1949 * RPMs: The Python bindings now require Python >= 2.2.
1953 * configure: Remove unnecessary backticks from tclsh version test.
1955 Xapian-bindings 0.9.8 (2006-11-02):
1959 * Wrap the "prog" form of Remote::open() (which is suitable for general purpose
1960 use as of 0.9.7) and the Remote::open_writable() methods (new in 0.9.7).
1962 * The C++ method QueryParser::parse_query() current throws "std:string"
1963 exceptions if there's a parse error. Previously the bindings didn't catch
1964 these. Now we catch them and handle them as if they were exceptions of
1965 type Xapian::QueryParserError (in anticipation of this changing in
1966 xapian-core). Added testcases for this for PHP, Python, and C#.
1968 * configure: Note that SWIG is only useful for Xapian developers in --help
1971 * configure: If we failed to find any languages to build for, give a more
1976 * SmokeTest.cs: Fix warning about unused variable in OP_ELITE_SET check.
1980 * configure: Fix check for jni.h in /usr/lib/jvm/java-gcj/include to actually
1981 work rather than using the cached failure of the first jni.h check.
1983 * SmokeTest.java: Fix check for value of Query.OP_ELITE_SET.
1985 * SmokeTest.java: Avoid gcj "set but not used" warning.
1989 * configure: Sanity check PHP_EXTENSION_DIR and PHP_INC.
1991 * smoketest4.php,smoketest5.php: Check the exception message given by the
1992 DocNotFoundError testcase.
1996 * Drop support for Python 2.1.
1998 Xapian-bindings 0.9.7 (2006-10-10):
2002 * NEWS: Fix the recent headings which said "Xapian-core" to say
2007 * Specify required automake version in the call to AM_INIT_AUTOMAKE in
2010 * If we're building with GCC 4.0 or higher, pass -fvisibility=hidden when
2011 compiling SWIG generated code which makes the compiled modules a few percent
2012 smaller and perhaps a little faster.
2014 * Wrap the newly implemented transaction API.
2016 * configure: Use "-fno-strict-aliasing" when compiling all the SWIG bindings
2017 (this option was supposed to be used to compile the Python bindings from
2018 0.9.3 onwards, but this wasn't actually working correctly).
2020 * Use CVS snapshot of SWIG to generate files (fixes bugs #83, #85).
2022 * In maintainer-mode, "make clean" now removes the SWIG generated files
2023 which would otherwise only be removed on "make maintainer-clean".
2027 * Xapian::MatchDecider can now be subclassed in C#.
2029 * The value of OP_ELITE_SET was wrong in C# which caused an error if you tried
2030 to use it. This has been fixed and a regression test added.
2032 * SmokeTest.cs: Added exception handling test.
2036 * Correct two misuses of delete to delete[]. Fixes bug#78.
2038 * configure: We need to look for jni.h in /usr/lib/jvm/java-gcj/include on some
2039 Debian and Ubuntu boxes at least.
2043 * We now generate class wrappers for PHP5.
2045 * We now generate proxy classes for PHP4, which is an incompatible change
2046 from previous versions of xapian-bindings. A perl script to upgrade
2047 your scripts is included.
2051 + Now that we're throwing PHP exceptions with PHP5 we need separate versions
2052 of the exception handling test for PHP4 and PHP5. Fixes bug#76.
2054 + Rely on xapian.php to load the extension module for us.
2056 + Fix error messages to show PHP code, not Python code.
2058 * When running smoketest.php, pass the "-q" option to php, which suppresses
2059 HTTP header output for PHP < 4.3 and is ignored for compatibility by more
2060 recent versions of PHP.
2062 * configure: Fix typo - PHP_tried should be PHP_found. This might have caused
2063 the PHP interpreter not to be found in some cases when it was actually
2064 available, but it's only used to run the smoketest not for building the
2069 * configure: Fixed check for PYTHON_PATHSEP to use $PYTHON rather than python,
2070 and also report the check and its result to the user.
2072 * python/Makefile.am: xapian.pyc can't be generated until _xapian.la has been
2073 built, so add an explicit dependency so that this works reliably in parallel
2074 builds. Fixes bug#77.
2076 * In examples and documentation, don't call the MatchDecider class/object
2077 "matcher", since we use the term "matcher" to mean something else in
2078 the library documentation.
2082 + Add test of exception handling.
2084 + Add test that MatchDecider can be subclassed successfully.
2086 * Wrap TermIterator::skip_to() so that it can be used from the TermIter
2087 pythonic iterator class.
2091 * Xapian::MatchDecider can now be subclassed in Ruby.
2093 * configure: Look for ruby interpreter as "ruby1.8" since it's called that
2094 (with no "ruby" alias) on Ubuntu dapper at least.
2096 * simplesearch.rb: Lowercase terms before stemming. "First ten" is inaccurate
2097 since we may have less than 10 matches, so say "1-<N>" instead.
2099 * simplematchdecider.rb: Implemented.
2103 * Implement saner exception handling for Tcl and document it.
2107 + Add check that xapian::Query_OP_ELITE_SET has the right value.
2109 + Rework how the smoketest gets run to eliminate special code for using
2110 uninstalled bindings from smoketest.tcl itself. This allows the smoketest
2111 to be run using installed bindings, and also makes it a better example
2114 + Add test for exception handling.
2116 + Send error messages to stderr.
2118 + Add comment about Tcl storing zero bytes as \xc0\x80.
2120 * simpleindex.tcl,simplesearch.tcl: Print $errorCode in the exception handler.
2122 * For SVN snapshots, remove any _svn6789 suffix from the Xapian version number
2123 used for the Tcl bindings.
2125 Xapian-bindings 0.9.6 (2006-05-15):
2129 * INSTALL: Add section describing how to install without root access.
2133 * Updated to reflect the renaming of Xapian::xapian_version_string and
2134 companions to Xapian::version_string.
2136 * Wrap optional length parameter to Enquire::set_query().
2138 * In PHP, Python, and Tcl bindings, rename get_document_id to get_docid for
2139 consistency. Keep get_document_id as an alias for now for backward
2142 * Fixed ESet::empty() to return bool instead of Xapian::termcount (this was
2143 probably a largely harmless error).
2145 * Stop SWIG from adding exception handling wrappers to the calls which return
2146 version strings, since they can't throw exceptions.
2148 * xapian.i: Removed superfluous "const" from return type "docid" which is just
2149 a typedef for an unsigned integer type.
2151 * configure: Add some missing "checking ..." messages so the user has more idea
2154 * Language specific util.i files can now define
2155 XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP and
2156 XAPIAN_MIXED_VECTOR_QUERY_INPUT_TYPEMAP to indicate which optional typemaps
2157 are provided for each language. This avoids needing to keep this
2158 information in two different places.
2160 * xapian.i: Uncomment commented-out parameter names and fix duplicate
2161 parameter names (for the benefit of bindings which use the parameter names,
2162 like the OO PHP5 patch for SWIG I'm working on...)
2166 * configure: Fix warning flags passed for Intel C++ compiler.
2170 * We now support building with Portable.NET.
2172 * Note that the passing of strings from C# into Xapian and back isn't currently
2173 zero byte safe. If you try to handle string containing zero bytes, you'll
2174 find they get truncated at the zero byte.
2176 * C# bindings now build and pass tests when srcdir != builddir.
2178 * In configure.ac, the "#" in "C#" seems to sometimes confuse autoconf so
2179 always say "CSharp" instead.
2181 * Not all machines are set up to run compiled C# programs when invoked
2182 directly, so get configure to check if we can, and otherwise see if using
2183 mono or ilrun works. If not, just skip the C# tests.
2185 * configure: If "mcs" isn't found, we now look for a CSharp compiler as "gmcs"
2186 (alternative name for "mcs"), "cscc" (Portable.NET), and then "csc"
2187 (Microsoft, but we check it isn't the unrelated Chicken csc program.)
2189 * Move the C# specific %rename list to csharp/util.i.
2191 * Store the strong name key in the key container so we reuse it for later
2194 * Wrap the version functions as more sensible names and document them (and
2195 continue to provide the older undocumented names for now just in case anyone
2198 * Set the version of XapianSharp.dll correctly when building a snapshot from
2199 SVN and set informational attributes (which e.g. MS Windows Explorer shows.)
2201 * SmokeTest.cs: Add test of version functions.
2205 * The Guile bindings don't work and aren't being actively worked on, so we're
2206 no longer including them in the distributed tarball to avoid disappointing
2207 users who notice a "guile" subdirectory. It also makes the download smaller.
2211 * Simplify (and improve portability of) run-java-test by using "libtool
2212 --mode=execute"'s -dlopen option.
2214 * Need to make sure "built" subdirectory exists or building from clean fails.
2216 * Fix "make check" to work when srcdir != builddir.
2220 * Using "php -c myphp.ini" still loads the system php.ini (at least for PHP
2221 4.3.10), so use "php -n" and then set the options we specifically want using
2224 * Fix the smoketest invocation to work better when srcdir != builddir.
2226 * Look for PHP interpreter first in prefix given by "php-config --prefix".
2228 * Fix SWIG_RuntimeError to be handled as an exception in PHP5.
2230 * simplesearch.php: MAX_PROB_TERM_LENGTH isn't used here so remove it.
2234 + Add test for version reporting functions
2236 + If a test fails, say which one to aid debugging.
2238 + Added simple test that zero-bytes are handled correctly when passing
2239 strings to and from Xapian.
2243 * README: Note that Python bindings have been built with MSVC.
2245 * Install xapian.py and xapian.pyc as _DATA not _SCRIPTS because we don't want
2246 to make them executable (they don't have a #! line).
2248 * simplematchdecider.py: Rename confusingly-named "mymatcher" to
2249 "mymatchdecider". Add description of what this example does.
2251 * simpleexpand.py: Don't define MAX_PROB_TERM_LENGTH as it isn't used.
2253 * smoketest.py: Added simple test that zero-bytes are handled when passing
2254 strings to and from Xapian.
2258 * Added new Ruby bindings from Paul Legato.
2264 + Add test for version reporting functions
2266 + If a test fails, say which one to aid debugging.
2268 + Added simple test that zero-bytes are handled correctly when passing
2269 strings to and from Xapian.
2271 Xapian-bindings 0.9.5 (2006-04-08):
2275 * HACKING,README: Split off HACKING to contain information which is only
2276 relevant to those wishing to modify the bindings.
2280 * SWIG-based bindings are now built with SWIG 1.3.29.
2282 * configure: Report which languages we're building bindings for just before
2285 * xapian.i: Make the stub definitions for disabled backends static.
2287 * configure: Don't quote $PHP in AC_PATH_PROGS to avoid "checking for ... no"
2290 * xapian.i: Wrap new method Enquire::set_sort_by_relevance_then_value().
2294 * RPMs: xapian-bindings.spec.in: Use "%{_libdir}" instead of "/usr/lib" for
2295 Python bindings to support 64 bit systems.
2297 * RPMs: Package the C# bindings.
2301 * java/run-java-test: Fix to work on platforms where LD_LIBRARY_PATH has a
2304 * configure: Detect Intel's C++ compiler and set suitable warning flags to
2305 avoid noise from compiling generated code.
2309 * Rename Database::GetDoccount() to Database::GetDocCount() for consistency.
2313 * configure: Disable --with-guile since Guile support doesn't currently work.
2317 * Override deprecation warnings for Xapian methods/functions/etc.
2319 * SmokeTest.java: Write a helpful diagnostic to stderr if a check fails so we
2320 have some idea what went wrong!
2322 * Rework how we include headers to get hash_map to avoid compiler warnings
2323 since it's usually not in the std namespace nowadays.
2325 * Previously the "all" target also ran the "install" target, but this has
2326 proved very problematic, so change "make check" to use the uninstalled JNI
2327 glue library, and update the instructions to say that "make install" is now
2330 * Use JAVA_PATHSEP when specifying the classpath for compiling .java files to
2333 * README: Note that some platforms need "-pthread" or similar flags.
2335 * Add a new Query constructor wrapper which take an OP_xxx and an array of
2338 * Compiling a .java file to a .class file now deletes the .jar file to ensure
2343 * php -n avoids reading any php.ini, but the compiled in default may be to
2344 enable the dubiously named "safe_mode" which prevents dl() being used so
2345 "make check" fails. So instead provide a very simple php.ini which turns off
2346 safe_mode and makes sure enable_dl is on.
2348 * Fix handling of bool parameters when resolving overloaded methods and/or
2349 default arguments. This fixes Enquire_sort_by_value() to work when the
2350 second argument is specified. Added regression test for this case.
2352 * simpleindex.php: Lowercase terms before stemming. Fixes bug#73.
2354 * Fix segmentation fault when PHP "Null" is passed where C++ wants an object
2355 passed by reference. Fixes bug#74.
2357 * simpleindex.php: Flushing after every call to WritableDatabase_add_document
2358 isn't required and will kill performance, so stop doing it. Fixes bug#75.
2362 * Use the fairly new "swig -O" option for the "modern" python bindings as
2363 it generates a smaller glue library and runs faster. Some of the features
2364 enabled also work on python 2.1, so enable these for the "olde" bindings.
2366 * configure: Catch the case where the user has python installed but not the
2367 module "distutils.sysconfig" and explain that they probably need to install a
2368 python-dev or python-devel package.
2370 * "make check" now works in VPATH builds.
2372 * smoketest.py: If a check fails, write a diagnostic message to stderr so we
2373 know which check it was!
2375 * smoketest.py: catch Exception objects and print them.
2377 * smoketest.py: Add feature tests for the various pythonic iterator
2380 * python/docs/bindings.html: Document the Pythonic iterators.
2382 * Fix TermIter not to try to read termfreqs or positions if they aren't
2383 meaningful for the current TermIter.
2385 Xapian-bindings 0.9.4 (2006-02-21):
2389 * COPYING: Updated FSF address.
2393 * Wrap Stopper::get_description().
2395 * Wrap xapian_version_string() and related functions.
2399 * If we're overriding MACOSX_DEPLOYMENT_TARGET then override it for commands
2400 run from "make" too.
2404 * Fix so that generated code compiles with ZTS-enabled PHP (which is the
2405 default on Windows).
2409 * smoketest.py: Test wrapping of xapian_version_string() and related functions.
2411 Xapian-bindings 0.9.3 (2006-02-16):
2415 * README: Updated and expanded (now covers supported platforms, and lists
2416 criteria which bindings for an additional language need to fulfil before
2417 we're likely to accept them).
2419 * INSTALL: Updated and improved.
2421 * TODO: Move C#-specific TODO to top level so we can track to-do items for
2426 * configure: Change how the user selects which bindings to build. If no
2427 --with* arguments are passed, then we default to building bindings we detect
2428 the required tools for (as before). But instead of requiring the user to
2429 deselect all bindings they don't actually want, we now let them select the
2430 bindings they do want. So "./configure --with-python" will only build the
2431 python bindings (and will fail if the required tools aren't installed).
2433 * Every wrapped method contains exception handling code. The bulk of this
2434 is now factored out into a single helper function, which cuts the compile
2435 time by around a factor of 3 and halves the size of the stripped library
2436 (figures are for Tcl on x86_64).
2438 * configure: Rework how XAPIAN_CXXFLAGS is passed through so that the user can
2439 override CXXFLAGS in the make invocation like so: make CXXFLAGS=-g
2441 * configure: Bump required SWIG version to 1.3.28 and drop the special
2442 requirement for 1.3.22 for PHP (hurrah!) Note that you don't need
2443 SWIG to install the bindings - SWIG is run by the Xapian developers
2444 so these updated requirements are only relevant if you want to modify
2447 * Eliminate separate Makefile in each examples subdirectory, which makes the
2448 build system simpler, smaller, and a little faster.
2450 * xapian.i: Include default constructors for all classes so that SWIG knows it
2451 doesn't have to use SwigValueWrapper for them, which makes the bindings code
2452 a bit smaller and faster. Also stop SWIG using SwigValueWrapper for
2455 * configure: Document special environmental variables which configure
2456 recognises. Enhance handling of environmental variables so you can
2457 e.g. './configure PYTHON=python23' (previously you had to give a full
2458 path in such environmental variables or they would be ignored.
2464 + Automatically detect the python version.
2466 + Rename "php4" references to "php".
2468 + Automatically detect the PHP extension directory.
2470 + Relax Tcl requirement to >= 8.1, since that's what we actually require.
2472 + Add support for "--without php" and --without tcl8" options to rpmbuild.
2476 * configure: On Mac OS X, ensure MACOSX_DEPLOYMENT_TARGET is set to at least
2477 10.3. This is required to link the bindings, and it doesn't seem to be
2478 possible to link them on 10.1 or 10.2 anyway.
2480 * configure: Add -lstdc++ to XAPIAN_LIBS if we're using GCC. OpenBSD needs it
2481 to be explicitly specified and libtool correctly handles platforms where it
2482 would have been implicitly linked with anyway.
2484 * Try to enable PHP bindings to build out of the box on cygwin (needs testing).
2486 * configure: Add missing ";;" on the last alternative in some case statements.
2488 * Only pass -no-undefined on platforms where it is required in order to link a
2489 shared library at all (it causes problems on Mac OS X in some cases).
2493 * This release includes a lot of improvements for the C# bindings. They're
2494 now pretty much on a par with the other language bindings.
2496 * Added documentation and examples.
2498 * Method and function names are now renamed to match C# conventions
2499 (e.g. from get_description() to GetDescription()). This is obviously an
2500 incompatible change, but the C# bindings haven't been suitable for real world
2501 use prior to this release.
2503 * Optional parameters are now wrapped so no longer need be specified
2506 * Overload ++ and -- for iterators.
2508 * Overload == and != for iterators. Now comparisons with the end iterator
2509 work as expected, and SmokeTest passes.
2511 * SmokeTest now reports exceptions verbosely.
2513 * Xapian::InMemory::open() is now wrapped as Xapian.InMemory.Open(), and
2514 similarly for other database factory functions.
2516 * Heed compatibility warnings from mcs and use different forms for
2517 command-line switches to the C# compiler (presumably for compatibility with
2518 Microsoft's compiler, though the warnings don't actually say that
2523 * Rewrote guile/util.i. The old version caused SWIG warnings and wasn't
2524 zero-byte safe. The guile bindings are still a long way from actually
2529 * Wrap optional second parameter (query length) to Enquire::set_query().
2531 * configure now probes for the Java path separator, which we then use to
2532 separate entries in the java -classpath command line option so we can
2533 build on platforms where it isn't ":".
2535 * SmokeTest.java: Expand to test more features.
2539 + Note that the bindings work with the Eclipse javac and GIJ 4.0.1.
2541 + Add note about how wrapped methods are named.
2543 * Query.java: OP_* code 9 no longer exists, so add it to those rejected by the
2546 * Query.java: Comment out unused code.
2548 * Fixed memory leak in Query-from-array-of-strings constructor.
2550 * Eliminate the "_errormap" hashmap - we don't need to use RTTI here, since
2551 Xapian::Error subclasses can tell you their typename directly (using
2556 * Some problems with overloaded methods in PHP have been fixed by a major
2557 overhaul of SWIG's PHP support. So we no longer rename such methods
2558 for PHP. This is an incompatible change, but it's easy to update your
2559 PHP scripts (just change new_Query_from_term_pair -> new_Query, etc).
2561 * Previously the documentation and simpleindex.php suggested that you
2562 should call delete_CLASS(). This was incorrect and resulted in a
2563 double-free() in some cases, so we've fixed the documentation and
2564 examples and eliminated the delete_CLASS() wrappers. This is another
2565 incompatible change, but again easy to update for.
2567 * We now support PHP5 as well as PHP4, so the configure test now looks
2568 for either and all references to "PHP4" or "php4" have been adjusted.
2570 * PHP5 supports exceptions, so throw exceptions under PHP5. For PHP4
2571 we now handle DocNotFoundError and FeatureUnavailableError by issuing a
2572 warning and making the method return "Null". This isn't ideal, but it's
2573 the best we can easily do without proper exceptions.
2575 * For the smoketest, instead of using "$(PHP) -c $(srcdir)" and having an
2576 empty php.ini in srcdir (which we were failing to distribute anyway), use
2577 "$(PHP) -n" which tells PHP not to use any php.ini file.
2579 * Update PHP documentation to include new features.
2581 * Redo Xapian section in phpinfo() to look more like most other modules.
2583 * You can now construct a Query object from an array of strings or Query
2584 objects (or even a mixture).
2586 * PHP examples now give a more useful error message if a database can't be
2589 * smoketest.php: Expanded the tests performed, including feature tests for
2590 the new Query-from-list constuctor.
2592 * simplesearch.php: Use newly wrapped Query-from-list constructor.
2594 * Use std::string::data() instead of c_str() as it may be more efficient for
2595 some STL implementations.
2597 * Enquire::get_matching_terms() now generates the PHP list directly from the
2598 TermIterator rather than constructing a temporary C++ std::list, which is
2599 faster and requires less temporary memory.
2603 * The Python constructor xapian.Query(OP, LIST_OF_STRINGS [, PARAM]) works
2604 once again (it has been broken since 0.9.0). Added a regression test to
2605 help keep this working.
2607 * Enhance the above constructor to accept any Python sequence (e.g. a tuple
2608 instead of a list). Also the sequence can contain xapian.Query objects or
2609 strings or a mixture. Documented these enhancements.
2611 * smoketest.py: Expanded the tests performed.
2613 * Convert C++ strings to python ones in a zero-byte clean way.
2615 * Added more error checking of the results of calls into the python
2618 * If using GCC, compile the python bindings with -fno-strict-aliasing (python
2619 itself is compiled with this option to avoid problems and it appears we ought
2620 to use it too to avoid the risk of hitting the same problems, although I'm
2621 not aware of anyone actually encountering such problems).
2623 * When making xapian.pyc, "import _xapian;" before we "import xapian;" to
2624 avoid creating a broken xapian.pyc is the shared library can't be loaded for
2627 * Enquire::get_matching_terms() now generates the Python list directly from the
2628 TermIterator rather than constructing a temporary C++ std::list, which is
2629 faster and requires less temporary memory.
2633 * Terms with a leading underscore now work (thanks to changes in SWIG).
2635 * Implement custom typemaps for Tcl, so that you can now construct a Query from
2636 a list of Query objects and/or strings, and Enquire::get_matching_terms is
2639 * simplesearch.tcl: Use the new Query from list constructor.
2641 * simplesearch.tcl: Fix to lowercase and stem query terms.
2643 * simpleindex.tcl: Tweak regex to not tokenise "foo--bar" as "foo-" and "bar".
2645 * simpleindex.tcl,simplesearch.tcl: Need explicit "xapian::" on constants.
2647 Xapian-bindings 0.9.2 (2005-07-15):
2651 * Added wrappers for new optional flags argument to QueryParser::parse_query().
2655 * Enhance configure to check that "mcs" is actually GNU Mono mcs and not
2656 another tool with the same name.
2660 * Include SmokeTest.java in the distribution so "make check" works.
2662 * Added success report for Sun java 1.4.1_01a.
2666 * When converting a python list to vector<string> we know the number of elements
2667 so reserve that number in the vector.
2669 Xapian-bindings 0.9.1 (2005-06-06):
2673 * Releases are now created using libtool 1.5.18 and automake 1.9.5.
2677 * Updated documentation to include information from Michael Schlenker about how
2678 to delete a database object such that the destructor gets called.
2680 Xapian-bindings 0.9.0 (2005-05-13):
2684 * Updated SWIG-based bindings to latest Xapian API
2686 * Improve support for building the bindings on MS Windows:
2688 + Provide stub versions of any backend functions which are disabled in the
2689 library we're wrapping to avoid a link failure on MS Windows (where the
2690 remote backend is automatically disabled). These stubs just throw
2691 Xapian::FeatureUnavailableError.
2693 + Add -no-undefined to *_la_LDFLAGS.
2695 + Use $(PATH_SEPARATOR) or Python's os.pathsep instead of ':' where
2698 + For python, paths for finding headers and installing libraries are now
2699 handled so they work on MS Windows; an extra static library needs to be
2702 * Wrap the Muscat36 Database factory functions (easy to do now we have stubs
2703 for disabled backends).
2705 * Don't wrap MSet::max_size() as it's there for STL compatibility rather than
2706 being useful functionality.
2708 * configure: Fix all SWIG warnings and pass -Werror to SWIG so any which get
2709 introduced in future get fixed.
2711 * configure: Fix version test to allow for _svn6789 suffix which SVN snapshots
2714 * Generate SWIG bindings with SWIG 1.3.24 (except for PHP which we still use
2715 1.3.22 for as more recent versions don't work with methods with optional
2716 arguments - the arguments become non-optional!)
2720 * configure: Disable guile by default, as it needs more work.
2724 * Updated to compile against 0.9.0 API.
2726 * Added missing make rule to build SmokeTestWrap.class to "make check" works.
2728 * Wrap optional parameters to Query(term) constructor.
2732 * For PHP4, rename default Database constructor to Database_empty
2733 instead of suppressing the much more useful Database(const string &path)
2736 * Use a blank config file when running PHP4 tests to avoid problems
2737 when the bindings are already installed as an extension which is
2738 loaded automatically in the default config.
2740 * configure.ac: If configure can't find the PHP interpreter (as php4 or php),
2741 it probably just means it's not in PATH. We only need it for running tests,
2742 so substitute a trivial shell script which just exits with code 77 so PHP
2743 tests are skipped (previously we substituted "missing" which caused the tests
2748 * Added Python-style iterators ESetIter, TermIter, PostingIter, PositionIter,
2751 * configure: If python is found, also check that Python.h exists (it may not be
2752 if the python-dev package (or similar) isn't installed).
2754 Xapian-bindings 0.8.5.1 (2005-02-23):
2758 * configure: Run compiler feature tests using the C++ compiler, not the C
2761 * Allow bindings version to have an extra "patchlevel", yet still match with
2762 corresponding xapian-core version (e.g. 0.8.5.1 and 0.8.5);
2766 * Added a missing .java source file and removed several unused ones.
2768 * Fixed several glitches in the java bindings automake build system.
2770 * Use "-Wno-unused" when compiling JNI C++ code to ignore harmless
2771 warnings in generated code (we were carefully passing "-Wunused"
2772 which is the opposite of what is needed!)
2774 * Fixed a couple of warnings from GCJ.
2776 * Wrapped a few missing methods added since Eric created the bindings. There
2777 are still some missing methods - there's now a (probably incomplete) list in
2780 * Added various useful bits of information to java/README.
2782 * Tweaked SimpleSearch.java to be more like the C++ version.
2786 * 0.8.5 was generated with SWIG 1.3.24, but PHP support is broken there so
2787 we now generate the PHP bindings with SWIG 1.3.22 and everything else with
2788 a more recent version.
2790 * configure: Check for "php" as a program name as well as "php4", and
2791 fall-back to missing so the error message from "make check" is better.
2793 Xapian-bindings 0.8.5 (2004-12-23):
2797 * INSTALL: Added non-generic installation instructions.
2801 * Fixed bytecode compilation of xapian.py. xapian.pyc was being generated in
2802 the same directory as xapian.py, but Makefile.am was looking in current
2803 directory when installing it. Additionally, VPATH builds were broken.
2804 These problems were introduced by changes in 0.8.4.
2806 Xapian-bindings 0.8.4 (2004-12-08):
2810 * README: Now clearly says which languages we currently support, which people
2811 are working on, etc.
2813 * Instead of requiring the user to have a really recent SWIG installed, ship
2814 the files SWIG generates. Disable all the SWIG rules unless configure is run
2815 with --enable-maintainer-mode to make sure they aren't triggered accidentally
2816 (e.g. by make with dodgy VPATH).
2818 * configure: Require SWIG 1.3.22 or higher (but note that SWIG is no longer
2819 needed if you just want to install the bindings).
2821 * Wrap the new Database and WritableDatabase constructors which replace
2824 * It turns out that we do need to wrap MSet::MSet() (wrapping removed in 0.8.2)
2825 (for example, simpleexpand.py needs it).
2827 * In the Query constructor which takes a vector of terms, only call set_window
2828 if window is non-zero. Otherwise things go wrong if we're passed an empty
2831 * Second argument to Document::add_posting() isn't optional, but xapian.i
2832 indicated that it was.
2834 * xapian.i: Added wrappers for Xapian::Weight and standard subclasses.
2835 Deriving your own weight class in the scripting language isn't currently
2838 * xapian.i: %name is deprecated, so use %rename instead. This also works
2839 around a bug in SWIG 1.3.23.
2841 * configure: Removed pointless probe for a C compiler - everything we compile
2844 * configure: Reinstated the check that the bindings version matches the version
2845 of the xapian library. It was added in 0.8.2, but accidentally removed in
2848 * Use newly added option `xapian-config --swigflags` which (a) avoids always
2849 passing -I/usr/include which could cause problems if we're using a Xapian
2850 install not in /usr and there's another one in /usr and (b) avoids problems
2851 if `xapian-config --cxxflags` contains flags other than -I<something>.
2855 * Richard Boulton has put together bindings for C#. These build successfully
2856 with the Mono tools, but the smoketest currently fails. Unclear if the
2857 problem is the bindings or the smoketest code.
2861 * The guile bindings now build successfully, so we've enabled the guile
2862 detection machinery in configure. They're untested though (we don't
2863 know guile!) so success or failure reports are encouraged!
2867 * Mention the example scripts near the start of the documentation, not right at
2870 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
2871 Xapian::Stem since we wrap them exactly as we wrap everything else we don't
2876 * Make overloaded Query(Query::op, vector<string>*, termpos) constructor
2879 * Changed examples to use the newly wrapped Query from list of terms ctor.
2881 * Mention the example scripts near the start of the documentation, not right at
2884 * python/Makefile.am: Added xapian_wrap.h as a target for the rule which runs
2887 * Remove documentation explicitly saying how we wrap Xapian::QueryParser and
2888 Xapian::Stem since we wrap them exactly as we wrap everything else we don't
2891 * Mention simpleexpand example in documentation.
2893 * Examples now report messages for Xapian exceptions.
2895 * Removed MAX_PROB_TERM_LENGTH from example scripts which don't use it.
2897 * Make the example MatchDecider exclude documents matching a value, rather than
2898 a term. The latter is a very inefficient way to do what AND_NOT does, and we
2899 don't want examples to mislead like that.
2901 * python/docs/bindings.html: Note that you can construct a query
2902 from a list of terms, even if you can't from a list of queries.
2903 Add HTML links to the examples.
2905 * simpleindex.py: Trim spaces from the start as well as from the end of each
2906 line. Simplify the loop slightly.
2910 * Wrap in a tcl8 namespace "Xapian".
2912 * Added a smoketest.
2914 * Translated simpleindex and simplesearch into Tcl.
2916 * Set the Tcl package version.
2918 * Create pkgIndex.tcl so the package can be loaded in the usual Tcl way.
2920 * Install in "xapian<VERSION>" directory in the conventional Tcl way.
2922 * Added documentation for tcl8 bindings.
2924 * Use the TCL_STUBS mechanism so that compiled extensions are portable between
2925 different versions of Tcl. This needs Tcl 8.1, so bump the required Tcl
2928 * configure.ac: Noted that the bindings can easily be compiled for use with
2929 Tcl 8.0, in case anybody needs that for some reason.
2931 * Don't wrap the factory functions which return a quartz WritableDatabase as
2932 the destructor never gets called so changes aren't flushed and the lock file
2935 Xapian-bindings 0.8.3 (2004-09-20):
2939 * Fixed mismatching versions of libtool used to produce configure and
2940 ltmain.sh. The obvious symptom was ".so" missing from the shared object
2943 * RPM spec file contributed by Fabrice Colin. Currently this packages Python,
2944 PHP4, and Tcl bindings.
2948 * Pass -classpath to javac to fix build problems.
2950 * Make sure errors subdirectory is built before we try to build the jar file.
2952 * Fixed "make install" to not give libtool error.
2956 * Include PHP4 documentation and exmples in the tarball.
2958 * Reverted "Use special SWIG PHP ldflags when linking the PHP glue library."
2959 change from 0.8.2 - it turns out we only need to pass these flags if we use
2960 swig's -noruntime option (which we don't do).
2964 * Use swig's -modern switch for Python 2.2 and up - it gives cleaner, leaner,
2965 faster Python wrapper code.
2969 * Don't install xapian.la.
2971 * Improved configure check for tcl.h to work with Fedora Core 2.
2973 Xapian-bindings 0.8.2 (2004-09-13):
2977 * Added wrappers for recently added methods: ESet::back() and
2978 Database::get_lastdocid(), and wrap the new optional third parameter
2979 to Enquire::set_sorting().
2981 * No longer wrap MSet::MSet() - it's not of use in scripting languages.
2983 * Wrap operator-- as prev() for MSetIterator and ESetIterator.
2985 * Wrap Quartz, InMemory, and Remote database factory functions as
2986 quartz_open(), inmemory_open(), and remote_open().
2988 * Added missing wrappers for static Stem::get_available_languages() and
2989 Stem::get_description().
2991 * Wrap renamed method Query::empty() (was Query::is_empty()).
2993 * Remove renaming of other empty() methods to is_empty() (but keep is_empty()
2994 as an alias for now).
2996 * Require autoconf 2.59 and automake 1.8.5.
2998 * configure: Added check that the bindings version matches the version of
3001 * configure: Check if we're using GCC and only pass GCC specific warning
3002 control options if we are.
3004 * configure: When running with GCC, also pass -Wno-uninitialized so the
3005 SWIG glue builds without warnings.
3007 * README: Updated list of languages which SWIG supports.
3011 * Document that the 2 argument form of Xapian::Auto::open() for opening a
3012 writable database is wrapped as open_writable() (bug #32).
3014 * Include Xapian version in output from phpinfo().
3016 * Build the SWIG glue library like we build the others rather than using
3017 SWIG's -phpfull option. This avoids problems with newer automake versions
3018 and means we can build against an uninstalled xapian library.
3020 * Corrected documentation to refer to Xapian::DB_* not Xapian::Auto::DB_*.
3021 Fixed documentation of how Xapian::Query::OP_* are wrapped.
3023 * Use special SWIG PHP ldflags when linking the PHP glue library.
3025 * simplesearch.py now works with multi-term queries.
3027 * Added documentation on how to install the PHP4 bindings.
3029 * Added a simple testcase to at least ensure the PHP4 bindings can be
3030 initialised and some simple operations work.
3034 * configure: Now checks for Python >= 2.1 which we need for __cmp__ and __eq__.
3036 * Don't install _xapian.la and _xapian.a.
3038 * Byte compile xapian.py to xapian.pyc and install it.
3040 * Suppress SWIG warning about MatchDecider::operator() director discarding
3043 * "make clean" no longer leaves "xapian_wrap.h" behind.
3045 * Added a simple testcase to at least ensure the python bindings can be
3046 initialised and some simple operations work.
3050 * configure: Disable building tcl8 bindings if the headers are missing
3051 (probably because the tcl8.X-dev package isn't installed).
3053 Xapian-bindings 0.8.1 (2004-06-30):
3057 * configure: Require SWIG 1.3.20 or higher (previously was 1.3.14).
3059 * Add "-I/usr/include" to the swig line. This is needed when xapian is
3060 installed with a prefix of /usr, since "xapian-config --cxxflags" carefully
3061 doesn't emit -I/usr/include in this situation (because it causes problems
3062 with some GCC versions).
3064 * Fixed the %exception handler to cover all the exceptions Xapian can throw,
3069 * Removed wrappers for unused error classes which have been pruned from C++.
3071 * Make finalize() methods of Database and WritableDatabase public so they can
3072 be called from by the user.
3074 * Document Document.add_term_nopos() as deprecated.
3078 * Make sure that PHP bindings build a module which exports get_module() so PHP
3081 * Configure now checks that phpize can actually be run, rather than just that
3082 it's executable (test -x isn't portable anyhow).
3084 * Added basic documentation and examples to PHP4 bindings.
3086 * Rename overloaded methods and constructors.
3088 * Add simple access to the prefixes map in QueryParser.
3090 * Correct simpleindex ports to never generate empty termnames.
3094 * configure: Use $PYTHON instead of python when running python to determine
3095 library and include paths and version number.
3097 * Actually ship python examples and documentation.
3099 Xapian-bindings 0.8.0 (2004-04-20):
3101 * README: Started collecting information on supporting Xapian from even
3104 * Added configure tests to enable bindings only where the necessary tools
3105 are installed and have a supported version. ./configure --without-LANGUAGE
3106 allows particular languages to be forcibly disabled.
3108 * Added Xapian::Document::add_term() - the new name for add_term_nopos().
3110 * A couple of Xapian::Query constructors weren't being wrapped - fixed.
3112 * Added Eric B. Ridge's JNI bindings for Java. The JNI bindings themselves
3113 have been well tested, but integration with the xapian-bindings configure
3114 system hasn't been tested at all - please alert us to any problems.
3116 * Xapian can now be used from TCL.
3118 * Python: MSet now provides a Python iterator.
3120 * Python: OMMSET_* and OMESET_* renamed to MSET_* and ESET_*.
3122 * Python: enable directors for MatchDecider, to allow subclassing in Python.
3124 * Python: Added basic documentation, and some examples.