Ticket #206: serialise_query_and_document.patch

include/xapian/query.h

@@ -238 +238 @@
          */
         bool empty() const;
 
+        /** Serialise query into a string.
+         *
+         *  The query representation may change between xapian releases:
+         *  even between minor versions.  The serialisation should not be used
+         *  for persistence - it is intended for allowing documents to be
+         *  passed between clients and servers which are running the same
+         *  version of xapian.
+         */
+        std::string serialise() const;
+
+        /** Unserialise a query from a string produced by serialise().
+         */
+        static Query unserialise(const std::string &s);
+
         /// Return a string describing this object.
         std::string get_description() const;
 

include/xapian/document.h

@@ -194 +194 @@
          */
         docid get_docid() const;
 
+        /** Serialise document into a string.
+         *
+         *  The document representation may change between xapian releases:
+         *  even between minor versions.  The serialisation should not be used
+         *  for persistence - it is intended for allowing documents to be
+         *  passed between clients and servers which are running the same
+         *  version of xapian.
+         */
+        std::string serialise() const;
+
+        /** Unserialise a document from a string produced by serialise().
+         */
+        static Document unserialise(const std::string &s);
+
         /// Return a string describing this object.
         std::string get_description() const;
 };

api/omdocument.cc

@@ -27 +27 @@
 #include "document.h"
 #include "documentvaluelist.h"
 #include "maptermlist.h"
+#include "serialise.h"
 #include "utils.h"
 
 #include <xapian/error.h>
@@ -199 +200 @@
     RETURN(internal->get_docid());
 }
 
+std::string
+Document::serialise() const
+{
+    DEBUGAPICALL(std::string, "Document::serialise", "");
+    return serialise_document(*this);
 }
 
+Document
+Document::unserialise(const std::string &s)
+{
+    DEBUGAPICALL_STATIC(Document, "Document::unserialise", s);
+    return unserialise_document(s);
+}
+
+}
+
 /////////////////////////////////////////////////////////////////////////////
 
 void

api/omquery.cc

@@ -194 +194 @@
 }
 
 std::string
+Query::serialise() const
+{
+    DEBUGAPICALL(std::string, "Xapian::Query::serialise", "");
+    if (!internal.get()) return "";
+    return internal->serialise();
+}
+
+Query
+Query::unserialise(const std::string &s)
+{
+    DEBUGAPICALL_STATIC(Xapian::Query, "Xapian::Query::unserialise", s);
+    Query result;
+    if (!s.empty()) {
+        result.internal = Xapian::Query::Internal::unserialise(s);
+    }
+    RETURN(result);
+}
+
+std::string
 Query::get_description() const
 {
     std::string res("Xapian::Query(");