xapian-bindings/xapian-headers.i

   1 %{
   2 /* xapian-headers.i: Getting SWIG to parse Xapian's C++ headers.
   3  *
   4  * Copyright 2004,2006,2011,2012,2013,2014,2015,2016 Olly Betts
   5  * Copyright 2014 Assem Chelli
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  20  * USA
  21  */
  22 %}
  23
  24 /* Ignore these functions: */
  25 %ignore Xapian::iterator_rewind;
  26 %ignore Xapian::iterator_valid;
  27
  28 /* Ignore anything ending in an underscore, which is for internal use only: */
  29 %rename("$ignore", regexmatch$name="_$") "";
  30
  31 /* A class which can usefully be subclassed in the target language. */
  32 %define SUBCLASSABLE(NS, CLASS)
  33     %ignore NS::CLASS::clone;
  34     %ignore NS::CLASS::serialise;
  35     %ignore NS::CLASS::unserialise;
  36     %#ifdef XAPIAN_SWIG_DIRECTORS
  37     %feature(director) NS::CLASS;
  38     %#endif
  39 %enddef
  40
  41 /* A class which is only useful to wrap if the target language allows
  42  * subclassing of wrapped classes (what SWIG calls "director support").
  43  */
  44 #ifdef XAPIAN_SWIG_DIRECTORS
  45 #define SUBCLASSABLE_ONLY(NS, CLASS) SUBCLASSABLE(NS, CLASS)
  46 #else
  47 #define SUBCLASSABLE_ONLY(NS, CLASS) %ignore NS::CLASS;
  48 #endif
  49
  50 #ifdef SWIGTCL
  51 /* Tcl needs copy constructors it seems. */
  52 %define STANDARD_IGNORES(NS, CLASS)
  53     %ignore NS::CLASS::internal;
  54     %ignore NS::CLASS::CLASS(Internal*);
  55     %ignore NS::CLASS::CLASS(Internal&);
  56     %ignore NS::CLASS::operator=;
  57 %enddef
  58 #else
  59 %define STANDARD_IGNORES(NS, CLASS)
  60     %ignore NS::CLASS::internal;
  61     %ignore NS::CLASS::CLASS(Internal*);
  62     %ignore NS::CLASS::CLASS(Internal&);
  63     %ignore NS::CLASS::operator=;
  64     %ignore NS::CLASS::CLASS(const CLASS &);
  65 %enddef
  66 #endif
  67
  68 #ifdef SWIGCSHARP
  69 /* In C#, next and prev return the iterator object. */
  70 #define INC_OR_DEC(METHOD, OP, NS, CLASS, RET_TYPE) NS::CLASS METHOD() { return OP(*self); }
  71 #elif defined SWIGJAVA
  72 /* In Java, next and prev return the result of dereferencing the iterator. */
  73 #define INC_OR_DEC(METHOD, OP, NS, CLASS, RET_TYPE) RET_TYPE METHOD() { return *(OP(*self)); }
  74 #else
  75 /* Otherwise, next and prev return void. */
  76 #define INC_OR_DEC(METHOD, OP, NS, CLASS, RET_TYPE) void METHOD() { OP(*self); }
  77 #endif
  78
  79 /* For other languages, SWIG already renames operator() suitably. */
  80 #if defined SWIGJAVA || defined SWIGPHP || defined SWIGTCL
  81 %rename(apply) *::operator();
  82 #elif defined SWIGCSHARP
  83 %rename(Apply) *::operator();
  84 #endif
  85
  86 /* We use %ignore and %extend rather than %rename on operator* so that any
  87  * pattern rename used to match local naming conventions applies to
  88  * DEREF_METHOD.
  89  */
  90 %define INPUT_ITERATOR_METHODS(NS, CLASS, RET_TYPE, DEREF_METHOD)
  91     STANDARD_IGNORES(NS, CLASS)
  92     %ignore NS::CLASS::operator++;
  93     %ignore NS::CLASS::operator*;
  94     %extend NS::CLASS {
  95         bool equals(const NS::CLASS & o) const { return *self == o; }
  96         RET_TYPE DEREF_METHOD() const { return **self; }
  97         INC_OR_DEC(next, ++, NS, CLASS, RET_TYPE)
  98     }
  99 %enddef
 100
 101 %define RANDOM_ACCESS_ITERATOR_METHODS(NS, CLASS, RET_TYPE, DEREF_METHOD)
 102     INPUT_ITERATOR_METHODS(NS, CLASS, RET_TYPE, DEREF_METHOD)
 103     %ignore NS::CLASS::operator--;
 104     %ignore NS::CLASS::operator+=;
 105     %ignore NS::CLASS::operator-=;
 106     %ignore NS::CLASS::operator+;
 107     %ignore NS::CLASS::operator-;
 108     %extend NS::CLASS {
 109         INC_OR_DEC(prev, --, NS, CLASS, RET_TYPE)
 110     }
 111 %enddef
 112
 113 %define CONSTANT(TYPE, NS, NAME)
 114     %ignore NS::NAME;
 115     %constant TYPE NAME = NS::NAME;
 116 %enddef
 117
 118 /* Ignore these for all classes: */
 119 %ignore operator==;
 120 %ignore operator!=;
 121 %ignore operator<;
 122 %ignore operator>;
 123 %ignore operator<=;
 124 %ignore operator>=;
 125 %ignore operator+;
 126 %ignore difference_type;
 127 %ignore iterator_category;
 128 %ignore value_type;
 129 %ignore max_size;
 130 %ignore swap;
 131 %ignore iterator;
 132 %ignore const_iterator;
 133 %ignore size_type;
 134 %ignore unserialise(const char **, const char *);
 135 %ignore release();
 136
 137 /* These methods won't throw exceptions. */
 138 %exception Xapian::major_version "$action"
 139 %exception Xapian::minor_version "$action"
 140 %exception Xapian::revision "$action"
 141 %exception Xapian::version_string "$action"
 142 // For XAPIAN_DOCID_BASE_TYPE and XAPIAN_TERMCOUNT_BASE_TYPE:
 143 %import <xapian/version.h>
 144 %include <xapian.h>
 145
 146 // Disable errors about not including headers individually.
 147 #define XAPIAN_IN_XAPIAN_H
 148
 149 /* We don't wrap the version macros - they're useful for compile time checks
 150  * in C++ code, but for a scripting language, the version functions tell us
 151  * the version of Xapian we're actually using, which is more interesting than
 152  * the one the bindings were built against.
 153  */
 154 /* %include <xapian/version.h> */
 155
 156 /* Types are needed by most of the other headers. */
 157 %include <xapian/types.h>
 158
 159 CONSTANT(int, Xapian, DB_CREATE);
 160 CONSTANT(int, Xapian, DB_CREATE_OR_OPEN);
 161 CONSTANT(int, Xapian, DB_CREATE_OR_OVERWRITE);
 162 CONSTANT(int, Xapian, DB_OPEN);
 163 CONSTANT(int, Xapian, DB_NO_SYNC);
 164 CONSTANT(int, Xapian, DB_FULL_SYNC);
 165 CONSTANT(int, Xapian, DB_DANGEROUS);
 166 CONSTANT(int, Xapian, DB_NO_TERMLIST);
 167 CONSTANT(int, Xapian, DB_BACKEND_CHERT);
 168 CONSTANT(int, Xapian, DB_BACKEND_GLASS);
 169 CONSTANT(int, Xapian, DB_BACKEND_INMEMORY);
 170 CONSTANT(int, Xapian, DB_BACKEND_STUB);
 171 CONSTANT(int, Xapian, DB_RETRY_LOCK);
 172 CONSTANT(int, Xapian, DBCHECK_SHORT_TREE);
 173 CONSTANT(int, Xapian, DBCHECK_FULL_TREE);
 174 CONSTANT(int, Xapian, DBCHECK_SHOW_FREELIST);
 175 CONSTANT(int, Xapian, DBCHECK_SHOW_STATS);
 176 CONSTANT(int, Xapian, DBCHECK_FIX);
 177 CONSTANT(int, Xapian, DBCOMPACT_MULTIPASS);
 178 CONSTANT(int, Xapian, DBCOMPACT_NO_RENUMBER);
 179 CONSTANT(int, Xapian, DBCOMPACT_SINGLE_FILE);
 180 CONSTANT(int, Xapian, DOC_ASSUME_VALID);
 181 %include <xapian/constants.h>
 182
 183 /* The Error subclasses are handled separately for languages where we wrap
 184  * them. */
 185 /* %include <xapian/error.h> */
 186
 187 /* ErrorHandler isn't currently wrapped. */
 188 /* %include <xapian/errorhandler.h> */
 189
 190 INPUT_ITERATOR_METHODS(Xapian, PositionIterator, Xapian::termpos, get_termpos)
 191 %include <xapian/positioniterator.h>
 192
 193 %ignore Xapian::DocIDWrapper;
 194 INPUT_ITERATOR_METHODS(Xapian, PostingIterator, Xapian::docid, get_docid)
 195 %include <xapian/postingiterator.h>
 196
 197 INPUT_ITERATOR_METHODS(Xapian, TermIterator, std::string, get_term)
 198 %include <xapian/termiterator.h>
 199
 200 INPUT_ITERATOR_METHODS(Xapian, ValueIterator, std::string, get_value)
 201 %include <xapian/valueiterator.h>
 202
 203 STANDARD_IGNORES(Xapian, Document)
 204 %include <xapian/document.h>
 205
 206 STANDARD_IGNORES(Xapian, Registry)
 207 %include <xapian/registry.h>
 208
 209 STANDARD_IGNORES(Xapian, Query)
 210 %ignore Xapian::Query::Internal;
 211 %ignore operator Query;
 212 %ignore *::operator&(const Xapian::Query &, const Xapian::InvertedQuery_ &);
 213 %ignore *::operator~;
 214 %ignore *::operator&=;
 215 %ignore *::operator|=;
 216 %ignore *::operator^=;
 217 %ignore *::operator*=;
 218 %ignore *::operator/=;
 219 #if defined SWIGCSHARP || defined SWIGJAVA || defined SWIGLUA || defined SWIGPHP
 220 %ignore *::operator&;
 221 %ignore *::operator|;
 222 %ignore *::operator^;
 223 %ignore *::operator*;
 224 %ignore *::operator/;
 225 #endif
 226 %ignore Xapian::Query::LEAF_TERM;
 227 %ignore Xapian::Query::LEAF_POSTING_SOURCE;
 228 %ignore Xapian::Query::LEAF_MATCH_ALL;
 229 %ignore Xapian::Query::LEAF_MATCH_NOTHING;
 230
 231 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::Query::Internal;
 232 #if defined SWIGCSHARP || defined SWIGJAVA || defined SWIGPERL || \
 233     defined SWIGPYTHON || defined SWIGRUBY
 234 // C#, Java, Perl, Python and Ruby wrap these "by hand" to give a nicer API
 235 // than SWIG gives by default.
 236 %ignore Xapian::Query::MatchAll;
 237 %ignore Xapian::Query::MatchNothing;
 238 #endif
 239 #ifndef XAPIAN_MIXED_SUBQUERIES_BY_ITERATOR_TYPEMAP
 240 %ignore Query(op op_, XapianSWIGQueryItor qbegin, XapianSWIGQueryItor qend,
 241               Xapian::termcount parameter = 0);
 242 #endif
 243 %include <xapian/query.h>
 244
 245 // Suppress warning that Xapian::Internal::intrusive_base is unknown.
 246 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::StemImplementation;
 247 SUBCLASSABLE_ONLY(Xapian, StemImplementation)
 248 #ifndef XAPIAN_SWIG_DIRECTORS
 249 %ignore Xapian::Stem::Stem(Xapian::StemImplementation *);
 250 #endif
 251 STANDARD_IGNORES(Xapian, Stem)
 252 %ignore Xapian::Stem::Stem();
 253 %include <xapian/stem.h>
 254
 255 STANDARD_IGNORES(Xapian, TermGenerator)
 256 %ignore Xapian::TermGenerator::operator=;
 257 /* Ignore forms which use Utf8Iterator, as we don't wrap that class. */
 258 %ignore Xapian::TermGenerator::index_text(const Xapian::Utf8Iterator &);
 259 %ignore Xapian::TermGenerator::index_text(const Xapian::Utf8Iterator &, Xapian::termcount);
 260 %ignore Xapian::TermGenerator::index_text(const Xapian::Utf8Iterator &, Xapian::termcount, const std::string &);
 261 %ignore Xapian::TermGenerator::index_text_without_positions(const Xapian::Utf8Iterator &);
 262 %ignore Xapian::TermGenerator::index_text_without_positions(const Xapian::Utf8Iterator &, Xapian::termcount);
 263 %ignore Xapian::TermGenerator::index_text_without_positions(const Xapian::Utf8Iterator &, Xapian::termcount, const std::string &);
 264 %ignore Xapian::TermGenerator::TermGenerator(const TermGenerator &);
 265 %include <xapian/termgenerator.h>
 266
 267 STANDARD_IGNORES(Xapian, MSet)
 268 #ifdef SWIGJAVA
 269 // For compatibility with the original JNI wrappers.
 270 %rename("getElement") Xapian::MSet::operator[];
 271 #else
 272 %ignore Xapian::MSet::operator[];
 273 #endif
 274 %extend Xapian::MSet {
 275     Xapian::docid get_docid(Xapian::doccount i) const {
 276         return *(*self)[i];
 277     }
 278
 279     Xapian::Document get_document(Xapian::doccount i) const {
 280         return (*self)[i].get_document();
 281     }
 282
 283     Xapian::MSetIterator get_hit(Xapian::doccount i) const {
 284         return (*self)[i];
 285     }
 286
 287     int get_document_percentage(Xapian::doccount i) const {
 288         return self->convert_to_percent((*self)[i]);
 289     }
 290 }
 291
 292 RANDOM_ACCESS_ITERATOR_METHODS(Xapian, MSetIterator, Xapian::docid, get_docid)
 293
 294 %include <xapian/mset.h>
 295
 296 STANDARD_IGNORES(Xapian, ESet)
 297 %ignore Xapian::ESet::operator[];
 298
 299 RANDOM_ACCESS_ITERATOR_METHODS(Xapian, ESetIterator, std::string, get_term)
 300
 301 %include <xapian/eset.h>
 302
 303 STANDARD_IGNORES(Xapian, RSet)
 304
 305 STANDARD_IGNORES(Xapian, Enquire)
 306
 307 SUBCLASSABLE(Xapian, MatchDecider)
 308
 309 #ifdef XAPIAN_TERMITERATOR_PAIR_OUTPUT_TYPEMAP
 310 /* Instantiating the template we're going to use avoids SWIG wrapping uses
 311  * of it in SwigValueWrapper.
 312  */
 313 %template() std::pair<Xapian::TermIterator, Xapian::TermIterator>;
 314
 315 %extend Xapian::Enquire {
 316     /* This returns start and end iterators, then a typemap iterates between
 317      * those and returns an array of strings in the target language.
 318      */
 319     std::pair<Xapian::TermIterator, Xapian::TermIterator>
 320     get_matching_terms(const Xapian::MSetIterator & item) const {
 321         return std::make_pair($self->get_matching_terms_begin(item),
 322                               $self->get_matching_terms_end(item));
 323     }
 324 }
 325 #endif
 326
 327 /* We don't wrap ErrorHandler, so ignore the optional ErrorHandler parameter.
 328  */
 329 %ignore Enquire(const Database &, ErrorHandler *);
 330
 331 %include <xapian/enquire.h>
 332
 333 SUBCLASSABLE(Xapian, ExpandDecider)
 334 // Suppress warning that Xapian::Internal::opt_intrusive_base is unknown.
 335 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::ExpandDecider;
 336 %ignore Xapian::ExpandDeciderAnd::ExpandDeciderAnd(const ExpandDecider *, const ExpandDecider *);
 337 /* FIXME: %extend ExpandDeciderFilterTerms so it can be constructed from an
 338  * array of strings (or whatever the equivalent is in the target language).
 339  */
 340 %ignore Xapian::ExpandDeciderFilterTerms;
 341 %include <xapian/expanddecider.h>
 342
 343 SUBCLASSABLE(Xapian, KeyMaker)
 344 // Suppress warning that Xapian::Internal::opt_intrusive_base is unknown.
 345 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::KeyMaker;
 346 %include <xapian/keymaker.h>
 347
 348 %extend Xapian::SimpleStopper {
 349     /** Load stop words from a text file (one word per line). */
 350     SimpleStopper(const std::string &file) {
 351         ifstream in_file(file.c_str());
 352         if (!in_file.is_open())
 353             throw Xapian::InvalidArgumentError("Stopword file not found: " + file);
 354         istream_iterator<std::string> in_iter(in_file);
 355         istream_iterator<std::string> eof;
 356         return new Xapian::SimpleStopper(in_iter, eof);
 357     }
 358 }
 359
 360 SUBCLASSABLE(Xapian, FieldProcessor)
 361 // Suppress warning that Xapian::Internal::opt_intrusive_base is unknown.
 362 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::Stopper;
 363 SUBCLASSABLE(Xapian, RangeProcessor)
 364 SUBCLASSABLE(Xapian, Stopper)
 365 SUBCLASSABLE(Xapian, ValueRangeProcessor)
 366 // Suppress warning that Xapian::Internal::opt_intrusive_base is unknown.
 367 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::RangeProcessor;
 368 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::ValueRangeProcessor;
 369 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::FieldProcessor;
 370 STANDARD_IGNORES(Xapian, QueryParser)
 371 %ignore Xapian::QueryParser::QueryParser(const QueryParser &);
 372 CONSTANT(int, Xapian, RP_SUFFIX);
 373 CONSTANT(int, Xapian, RP_REPEATED);
 374 CONSTANT(int, Xapian, RP_DATE_PREFER_MDY);
 375 %include <xapian/queryparser.h>
 376
 377 %include <xapian/valuesetmatchdecider.h>
 378
 379 /* Xapian::Weight isn't usefully subclassable via the bindings, as clone()
 380  * needs to be implemented for it to be usable for weighting a search.  But
 381  * there are several supplied weighting schemes implemented in C++ which can
 382  * usefully be used via the bindings so we wrap those.
 383  */
 384 STANDARD_IGNORES(Xapian, Weight)
 385 /* The copy constructor isn't implemented, but is protected rather than
 386  * private to work around a compiler bug, so we ignore it explicitly.
 387  */
 388 %ignore Xapian::Weight::Weight(const Weight &);
 389 %ignore Xapian::Weight::clone;
 390 %ignore Xapian::Weight::serialise;
 391 %ignore Xapian::Weight::unserialise;
 392 %include <xapian/weight.h>
 393
 394 /* We don't wrap Xapian's Unicode support as other languages usually already
 395  * have their own Unicode support. */
 396 /* %include <xapian/unicode.h> */
 397
 398 SUBCLASSABLE(Xapian, Compactor)
 399 %include <xapian/compactor.h>
 400
 401 SUBCLASSABLE(Xapian, PostingSource)
 402 // Suppress warning that Xapian::Internal::opt_intrusive_base is unknown.
 403 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::PostingSource;
 404 SUBCLASSABLE(Xapian, ValuePostingSource)
 405 SUBCLASSABLE(Xapian, ValueWeightPostingSource)
 406 %ignore Xapian::PostingSource::unserialise_with_registry;
 407 %include <xapian/postingsource.h>
 408
 409 // Suppress warning that Xapian::Internal::intrusive_base is unknown.
 410 %warnfilter(SWIGWARN_TYPE_UNDEFINED_CLASS) Xapian::MatchSpy;
 411 SUBCLASSABLE(Xapian, MatchSpy)
 412 %ignore Xapian::MatchSpy::serialise_results;
 413 %include <xapian/matchspy.h>
 414
 415 SUBCLASSABLE(Xapian, LatLongMetric)
 416 INPUT_ITERATOR_METHODS(Xapian, LatLongCoordsIterator, LatLongCoord, get_coord)
 417 %ignore Xapian::LatLongCoord::operator<;
 418 %include <xapian/geospatial.h>
 419
 420 STANDARD_IGNORES(Xapian, Database)
 421 STANDARD_IGNORES(Xapian, WritableDatabase)
 422 %ignore Xapian::WritableDatabase::WritableDatabase(Database::Internal *);
 423 %ignore Xapian::Database::check(const std::string &, int, std::ostream *);
 424 %ignore Xapian::Database::check(int fd, int, std::ostream *);
 425 %include <xapian/database.h>
 426 %extend Xapian::Database {
 427     static size_t check(const std::string &path, int opts = 0) {
 428         return Xapian::Database::check(path, opts, opts ? &std::cout : NULL);
 429     }
 430 }
 431
 432 #if defined SWIGCSHARP || defined SWIGJAVA
 433
 434 /* xapian/dbfactory.h is currently wrapped via fake class declarations in
 435  * fake_dbfactory.i for C# and Java. */
 436
 437 #else
 438
 439 #ifdef XAPIAN_BINDINGS_SKIP_DEPRECATED_DB_FACTORIES
 440 %ignore Xapian::InMemory::open;
 441 %ignore Xapian::Chert::open;
 442 %ignore Xapian::Auto::open_stub;
 443 #else
 444
 445 %rename("inmemory_open") Xapian::InMemory::open;
 446
 447 /* SWIG Tcl wrappers don't call destructors for classes returned by factory
 448  * functions, so we don't wrap them so users are forced to use the
 449  * WritableDatabase ctor instead. */
 450 #ifdef SWIGTCL
 451 %ignore Xapian::Chert::open(const std::string &dir, int action, int block_size = 8192);
 452 #endif
 453
 454 %rename("chert_open") Xapian::Chert::open;
 455
 456 #ifndef SWIGPHP
 457 /* PHP renames this to auto_open_stub() in php/php.i. */
 458 %rename("open_stub") Xapian::Auto::open_stub;
 459 #endif
 460
 461 #endif
 462
 463 %rename("remote_open") Xapian::Remote::open;
 464 %rename("remote_open_writable") Xapian::Remote::open_writable;
 465
 466 %include <xapian/dbfactory.h>
 467
 468 #endif