Ticket #588: ocaml.diff

xapian-bindings/configure.ac

@@ -239 +239 @@
   [],
   [with_perl=])
 
+AC_ARG_WITH(ocaml,
+  AS_HELP_STRING([--with-ocaml], [enable Ocaml bindings]),
+  [],
+  [with_ocaml=])
+
 AC_ARG_WITH(lua,
   AC_HELP_STRING([--with-lua], [enable Lua bindings]),
   [],
   [with_lua=])
 
-case $with_python$with_php$with_ruby$with_tcl$with_csharp$with_java$with_perl$with_lua in
+case $with_python$with_php$with_ruby$with_tcl$with_csharp$with_java$with_perl$with_ocaml$with_lua in
 *yes*)
   dnl Default unspecified values to no.
   test -z "$with_python" && with_python=no
@@ -254 +259 @@
   test -z "$with_java" && with_java=no
   test -z "$with_ruby" && with_ruby=no
   test -z "$with_perl" && with_perl=no
+  test -z "with_ocaml" && with_ocaml=no
   test -z "$with_lua" && with_lua=no
   ;;
 esac
@@ -940 +946 @@
   fi
 fi
 
+dnl -----------------------------------
+dnl INCLUDES and LIBS for OCAML
+
+if test no != "$with_ocaml"; then
+      AC_CHECK_PROG(OCAML,ocaml,ocaml)
+      if test -n "$OCAML"; then
+        with_ocaml="No (ocaml not available)"
+      else
+        AC_CHECK_PROG(OCAML_OPT,ocamlopt,ocamlopt)
+        OCAML_INCLUDES=-I/usr/lib$LIBPOSTFIX/ocaml
+        OCAML_LIBS=-L/usr/lib$LIBPOSTFIX/ocaml
+        save_CPPFLAGS=$CPPFLAGS
+        CPPFLAGS="$CPPFLAGS $OCAML_INCLUDES"
+        AC_CHECK_HEADER(caml/mlvalues.h,[
+          with_ocaml="Yes"
+          AC_SUBST(OCAML_INCLUDES)
+          AC_SUBST(OCAML_LIBS)
+        ],[
+          with_ocaml="No (missing header)"
+          AC_MSG_WARN([Unable to find header caml/mlvalues.h. The OCAML packages will not be built])
+        ])
+        CPPFLAGS=$save_CPPFLAGS
+         BINDINGS="$BINDINGS ocaml"
+      fi
+else
+  if test yes = "$with_ocaml" ; then
+    AC_MSG_ERROR([ocaml not found])
+  fi
+fi
+AM_CONDITIONAL(WITH_OCAML, [test yes = "$with_ocaml"])
+AM_CONDITIONAL(WITH_OCAMLOPT, [test "x$OCAML_OPT" != "x"])
+
 if test no != "$with_lua" ; then
   AC_PATH_PROGS(LUA, ["${LUA-lua}"], [])
   AC_ARG_VAR(LUA, [lua interpreter])

new file xapian-bindings/ocaml/Makefile

@@ +1 @@
+SWIG=../../swig/preinst-swig
+INCLUDE=-I. -I../generic -I../ $(shell xapian-config-1.3 --swigflags --cxxflags)
+LINK=$(shell xapian-config-1.3 --libs)
+
+all: static
+
+static: libs
+        ocamlc -pp "camlp4o ./swigp4.cmo" -c smoketest.ml       
+        ocamlfind ocamlc -g -ccopt -g -cclib                    \
+                -g -custom  -o smoketest                        \
+                -package unix  -linkpkg                         \
+                swig.cmo  xapian.cmo  smoketest.cmo             \
+                xapian_wrap.o                                   \
+                -cc 'g++ -Wno-write-strings $(INCLUDE) $(LINK)'
+
+
+swig:
+        $(SWIG) -ocaml -co swigp4.ml
+        $(SWIG) -ocaml -co swig.mli
+        $(SWIG) -ocaml -co swig.ml
+        ocamlfind ocamlc -package camlp4                        \
+                -pp "camlp4o pa_extend.cmo q_MLast.cmo"         \
+                -c swigp4.ml                                    
+        ocamlc -c swig.mli swig.ml
+
+
+libs: swig
+        $(SWIG) -Wall $(INCLUDE) -c++ -ocaml -v \
+                -outdir . -o xapian_wrap.c xapian-ocaml.i               
+        ocamlc -cc 'g++ -Wno-write-strings' -g -c -ccopt        \
+                -g -ccopt '-xc++' -ccopt '$(INCLUDE)'           \
+                xapian_wrap.c                                   
+        ocamlc -c xapian.mli xapian.ml
+
+
+toplevel: libs
+        ocamlfind ocamlmktop -custom swig.cmo                   \
+                -package dynlink -package camlp4                \
+                dynlink.cma camlp4o.cma swigp4.cmo              \
+                xapian_wrap.o xapian.cmo -o xapian_top          \
+                -cc 'g++ -Wno-write-strings $(INCLUDE) $(LINK)'
+
+
+clean:
+        rm -rf *.dSYM smoketest
+        rm -f swigp4.ml swig.mli swig.ml
+        rm -f *.cmo *.cmi
+        rm -f xapian_wrap.*
+        rm -f xapian.*
+        rm -f xapian_top

new file xapian-bindings/ocaml/smoketest.ml

@@ +1 @@
+open Swig
+open Xapian
+open Unix
+
+(* Quick test to ensure the module is loaded *)
+let () = 
+  assert (Xapian.module_name =  "xapian");
+  assert ((Xapian.version_string '() as string) = "1.3.0")
+;;
+
+(* Basis document test *)
+
+let () = 
+  let doc = new_Document '() in
+    ignore (add_terms doc ["hello"]);
+    assert ((doc -> termlist_count() as int) = 1);
+    ignore (doc -> set_data ("something"));
+    assert ((doc -> get_data() as string) = "something");
+    let tb = doc -> termlist_begin() in
+    let te = doc -> termlist_end() in
+      assert (tb -> equals(te) as bool == false);
+      assert ((tb -> get_term() as string) = "hello")
+;;
+
+(* simple database test *)
+let () = 
+  let db = writable_db "test.db" 1 in
+  let doc = new_Document '() in
+    ignore (add_terms doc ["hello"]);
+    ignore (doc -> set_data("goodbye"));
+    ignore (db -> add_document(doc));
+    ignore (db -> flush());
+    let enq = new_Enquire '(db) in
+    let qp = new_QueryParser '() in 
+      ignore (qp -> set_database(db));
+      let pq = build_parsed_query qp "hello" in
+        enq -> set_query(pq);
+        let matches = enq -> get_mset(0, 10) in
+          Printf.printf "Found %d\n" (matches -> size() as int);
+          assert ((matches -> size() as int) = 1);
+          let tb = pq -> get_terms_begin() in
+            assert (pq -> empty() as bool = false);
+            assert ((tb -> get_term() as string) = "hello")
+;;
+
+
+(* add a number of documents to a db then pull put one into an Rset and use
+get_eset *)
+
+let _ = 
+  ignore (
+    Array.map (fun el ->
+                 ignore (Sys.remove (Filename.concat "test.db" el)))
+      (Sys.readdir "test.db"));
+  Unix.rmdir "test.db"
+;;
+
+print_endline "All tests passed."

new file xapian-bindings/ocaml/util.i

@@ +1 @@
+%apply int { Xapian::doccount };
+%apply int { Xapian::termcount };
+
+%insert (mlitail) %{
+
+val version_string : c_obj -> c_obj
+val major_version : c_obj -> c_obj
+val minor_version : c_obj -> c_obj
+val revision : c_obj -> c_obj
+
+val closure_from_lst : c_obj -> c_obj
+val build_parsed_query : c_obj -> string -> c_obj
+val writable_db : string -> int -> c_obj
+val add_terms : c_obj -> string list -> c_obj list
+
+%}
+
+%insert (mltail) %{
+
+let version_string = _version_string
+let major_version = _major_version
+let minor_version = _minor_version
+let revision = _revision
+
+(* Helpers *)
+
+let closure_from_lst lst = 
+    match lst with
+        Swig.C_list [Swig.C_string a; Swig.C_obj f] -> Swig.C_obj f
+      | _ -> raise (Failure "ZOMG")
+
+
+let build_parsed_query qp query = 
+  let c_query = Swig.C_string query in
+    closure_from_lst ((invoke qp) "parse_query" (c_query))
+
+
+let writable_db path flags = 
+  let c_path = Swig.C_string path in 
+    let c_flags = Swig.C_int flags in
+    closure_from_lst (new_WritableDatabase (Swig.C_list[c_path; c_flags]))
+
+
+let add_terms doc terms =
+  List.map (fun el -> 
+              let c_el = Swig.C_string el in
+                (invoke doc) "add_term" (c_el)) terms
+
+%}

new file xapian-bindings/ocaml/xapian-ocaml.i

@@ +1 @@
+%module xapian
+%{
+/* ocaml.i: SWIG interface file for the Ocaml bindings
+ *
+ * Copyright (C) 2011 Olly Betts
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
+ * USA
+ */
+%}
+
+%include ../xapian-head.i
+
+%include util.i
+%include ../xapian.i

new file xapian-bindings/ocaml/xapianinit

@@ +1 @@
+open Swig
+open Xapian
+;;