Ticket #565: patch-Search-Xapian-1.2.6.0-select-backend.diff

Xapian/WritableDatabase.pm

@@ -29 +29 @@
   my $class = shift;
   my $database;
   my $invalid_args;
-  if( scalar(@_) == 1 ) {
+  if( @_ == 1 ) {
     my $arg = shift;
     my $arg_class = ref( $arg );
     if( $arg_class eq $class ) {
@@ -37 +37 @@
     } else {
       $invalid_args = 1;
     }
-  } elsif( scalar(@_) == 2 ) {
+  } elsif( @_ >= 2 ) {
     $database = new1( @_ );
-  } elsif( scalar(@_) == 0 ) {
+  } elsif( !@_ ) {
     $database = new3();
   } else {
     $invalid_args = 1;
   }
   if( $invalid_args ) {
-    Carp::carp( "USAGE: $class->new(\$file, DB_OPTS), $class->new(\$database), $class->new()" );
+    Carp::carp( "USAGE: $class->new(\$file, DB_OPTS[, BACKEND]), $class->new(\$database), $class->new()" );
     exit;
   }
   bless $database, $class;
@@ -69 +69 @@
 
 =over 4
 
-=item new <database> or new <path> <mode>
+=item new <database> or new <path> <mode> [backend] [block size]
 
-Class constructor. Takes either a database object, or a path and one
-of DB_OPEN, DB_CREATE, DB_CREATE_OR_OPEN or DB_CREATE_OR_OVERWRITE.
-These are exported by L<Search::Xapian> with the 'db' option.
+Class constructor. Takes either a database object, or a path to database directory,
+mode, which is one of DB_OPEN, DB_CREATE, DB_CREATE_OR_OPEN or DB_CREATE_OR_OVERWRITE,
+exported by L<Search::Xapian> with the ':db' option, backend selector,
+which is one of BACKEND_FLINT, BACKEND_CHERT (default) and BACKEND_BRASS,
+exported by L<Search::Xapian> with the ':backend' option, and block size
+(default 8192).
 
 =item clone
 

Xapian.pm

@@ -91 +91 @@
                                  STEM_NONE
                                  STEM_SOME
                                  STEM_ALL
-                                 ) ]
+                                 ) ],
+                    'backend' => [ qw(
+                                 BACKEND_FLINT
+                                 BACKEND_CHERT
+                                 BACKEND_BRASS
+                                 ) ],
                    );
 $EXPORT_TAGS{standard} = [ @{ $EXPORT_TAGS{'ops'} },
                            @{ $EXPORT_TAGS{'db'} },
                            @{ $EXPORT_TAGS{'qpflags'} },
                            @{ $EXPORT_TAGS{'qpstem'} } ];
-$EXPORT_TAGS{all} = [ @{ $EXPORT_TAGS{'standard'} }, @{ $EXPORT_TAGS{'enq_order'} } ];
+$EXPORT_TAGS{all} = [ @{ $EXPORT_TAGS{'standard'} },
+                           @{ $EXPORT_TAGS{'backend'} },
+                           @{ $EXPORT_TAGS{'enq_order'} } ];
 
 
 # Names which can be exported.
@@ -205 +212 @@
 
 =back
 
+=head1 :backend
+
+=item BACKEND_FLINT
+
+Tells L<Search::Xapian::WritableDatabase>'s constructor to use
+Flint backend for newly created databases. Flint is the "old stable"
+backend in Xapian 1.2.x. Use Chert instead.
+
+=item BACKEND_CHERT
+
+Tells L<Search::Xapian::WritableDatabase>'s constructor to use
+Chert backend for newly created databases. Chert is considered stable
+in Xapian 1.2.x and is the default.
+
+=item BACKEND_BRASS
+
+Tells L<Search::Xapian::WritableDatabase>'s constructor to use
+Brass backend for newly created databases. Brass is the development
+backend and will be considered stable in 1.4.0.
+
 =head1 :ops
 
 =over 4

Xapian.xs

@@ -22 +22 @@
 using namespace std;
 using namespace Xapian;
 
+#define XAPIAN_BACKEND_FLINT 1
+#define XAPIAN_BACKEND_CHERT 2
+#define XAPIAN_BACKEND_BRASS 3
+
 extern void handle_exception(void);
 
 /* PerlStopper class
@@ -245 +249 @@
         ENUM_CONST(FLAG_AUTO_MULTIWORD_SYNONYMS, QueryParser::FLAG_AUTO_SYNONYMS);
         ENUM_CONST(FLAG_DEFAULT, QueryParser::FLAG_DEFAULT);
 
+        ENUM_CONST(BACKEND_FLINT, XAPIAN_BACKEND_FLINT);
+        ENUM_CONST(BACKEND_CHERT, XAPIAN_BACKEND_CHERT);
+        ENUM_CONST(BACKEND_BRASS, XAPIAN_BACKEND_BRASS);
+
         ENUM_CONST(STEM_NONE, QueryParser::STEM_NONE);
         ENUM_CONST(STEM_SOME, QueryParser::STEM_SOME);
         ENUM_CONST(STEM_ALL, QueryParser::STEM_ALL);

XS/WritableDatabase.xs

@@ -3 +3 @@
 PROTOTYPES: ENABLE
 
 WritableDatabase *
-new1(file, opts)
+new1(file, opts, backend = XAPIAN_BACKEND_CHERT, blocksize = 8192)
     string      file
     int         opts
+    int         backend
+    int         blocksize
     CODE:
         try {
-            RETVAL = new WritableDatabase(file, opts);
+            switch (backend) {
+            case XAPIAN_BACKEND_FLINT:
+                RETVAL = new WritableDatabase(Xapian::Flint::open(file, opts, blocksize));
+                break;
+            case XAPIAN_BACKEND_BRASS:
+                RETVAL = new WritableDatabase(Xapian::Brass::open(file, opts, blocksize));
+                break;
+            case XAPIAN_BACKEND_CHERT:
+            default:
+                RETVAL = new WritableDatabase(Xapian::Chert::open(file, opts, blocksize));
+            }
         } catch (...) {
             handle_exception();
         }