Ticket #473: querypostingsource.patch

xapian-core/include/xapian/querypostingsource.h

@@ +1 @@
+/** @file querypostingsource.h
+ *  @brief A posting source based on a query.
+ */
+/* Copyright (C) 2008 Lemur Consulting Ltd
+ *
+ * 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
+ */
+
+#ifndef XAPIAN_INCLUDED_QUERYPOSTINGSOURCE_H
+#define XAPIAN_INCLUDED_QUERYPOSTINGSOURCE_H
+
+#include <xapian/postingsource.h>
+
+#include <string>
+
+namespace Xapian {
+
+class Database;
+class Query;
+class RSet;
+class Weight;
+
+/// A posting source which returns all documents matching a query.
+class XAPIAN_VISIBILITY_DEFAULT QueryPostingSource : public PostingSource {
+  public:
+    // Declaration of Internal has to be public, so that the friend
+    // declaration in Query::Internal works.
+    class Internal;
+  private:
+
+    Internal * internal;
+  public:
+    /** Construct a QueryPostingSource from a given query.
+     *
+     *  @param q The query to construct the posting source from.
+     */
+    QueryPostingSource(Xapian::Database db,
+                       const Xapian::Query & q,
+                       const Xapian::RSet & rset,
+                       const Xapian::Weight * wt_factory);
+
+    ~QueryPostingSource();
+
+    Xapian::doccount get_termfreq_min() const;
+    Xapian::doccount get_termfreq_est() const;
+    Xapian::doccount get_termfreq_max() const;
+
+    Xapian::weight get_maxweight() const;
+    Xapian::weight get_weight() const;
+
+    void next(Xapian::weight min_wt);
+    void skip_to(Xapian::docid did, Xapian::weight min_wt);
+    bool check(Xapian::docid did, Xapian::weight min_wt);
+
+    bool at_end() const;
+
+    Xapian::docid get_docid() const;
+
+    void reset();
+
+    std::string get_description() const;
+};
+
+}
+
+#endif // XAPIAN_INCLUDED_QUERYPOSTINGSOURCE_H

xapian-core/include/xapian/query.h

@@ -29 +29 @@
 #include <vector>
 
 #include <xapian/base.h>
+#include <xapian/querypostingsource.h>
 #include <xapian/types.h>
 #include <xapian/termiterator.h>
 #include <xapian/visibility.h>
@@ -278 +279 @@
     friend class ::MultiMatch;
     friend class ::QueryOptimiser;
     friend struct ::SortPosName;
+    friend class Xapian::QueryPostingSource::Internal;
     friend class Query;
     public:
         static const int OP_LEAF = -1;

xapian-core/include/xapian/enquire.h

@@ -27 +27 @@
 #include <string>
 
 #include <xapian/base.h>
+#include <xapian/querypostingsource.h>
 #include <xapian/sorter.h>
 #include <xapian/types.h>
 #include <xapian/termiterator.h>
@@ -1016 +1017 @@
     friend class Enquire; // So Enquire can clone us
     friend class ::RemoteServer; // So RemoteServer can clone us - FIXME
     friend class ::ScaleWeight;
+    friend class QueryPostingSource::Internal;
     public:
         class Internal;
     protected:

xapian-core/include/Makefile.mk

@@ -25 +25 @@
         include/xapian/postingsource.h\
         include/xapian/query.h\
         include/xapian/queryparser.h\
+        include/xapian/querypostingsource.h\
         include/xapian/replication.h\
         include/xapian/sorter.h\
         include/xapian/stem.h\

xapian-core/include/xapian.h

@@ -48 +48 @@
 #include <xapian/postingsource.h>
 #include <xapian/query.h>
 #include <xapian/queryparser.h>
+#include <xapian/querypostingsource.h>
 #include <xapian/sorter.h>
 #include <xapian/valuesetmatchdecider.h>
 

xapian-core/api/Makefile.mk

@@ -24 +24 @@
         api/omtermlistiterator.cc\
         api/postingsource.cc\
         api/postlist.cc\
+        api/querypostingsource.cc\
         api/replication.cc\
         api/sortable-serialise.cc\
         api/sorter.cc\

xapian-core/api/querypostingsource.cc

@@ +1 @@
+/** @file querypostingsource.cc
+ *  @brief A posting source based on a query.
+ */
+/* Copyright (C) 2008 Lemur Consulting Ltd
+ *
+ * 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 <config.h>
+
+#include "xapian/database.h"
+#include "xapian/enquire.h"
+#include "xapian/error.h"
+#include "xapian/querypostingsource.h"
+
+#include "matcher/localmatch.h"
+
+namespace Xapian {
+
+class QueryPostingSource::Internal
+{
+    public:
+        Database db;
+        Query q;
+        RSet rset;
+        const Weight * wt_factory;
+
+        termcount qlen;
+
+        LocalSubMatch * matcher;
+
+        Internal(Database db_, const Query & q_, const RSet & rset_,
+                 const Weight * wt_factory_);
+        ~Internal();
+
+        void reset();
+        bool at_end() const;
+};
+
+QueryPostingSource::Internal::Internal(Database db_, const Query & q_,
+                                       const RSet & rset_,
+                                       const Weight * wt_factory_)
+        : db(db_),
+          q(q_),
+          rset(rset_),
+          wt_factory(NULL),
+          qlen(q_.get_length()),
+          matcher(NULL)
+{
+    if (wt_factory_ == NULL) {
+        wt_factory = new BM25Weight();
+    } else {
+        wt_factory = wt_factory_->clone();
+    }
+    if (db.internal.size() != 1) {
+        throw InvalidOperationError("QueryPostingSource needs to be passed a single database");
+    }
+    q.internal->validate_query();
+}
+
+QueryPostingSource::Internal::~Internal()
+{
+    delete matcher;
+    delete wt_factory;
+}
+
+void
+QueryPostingSource::Internal::reset()
+{
+    delete matcher;
+
+    if (q.internal.get() == 0) {
+        matcher = NULL;
+        return;
+    }
+
+    matcher = new LocalSubMatch(db.internal[0].get(),
+                                q.internal.get(),
+                                qlen, rset,
+                                wt_factory);
+}
+
+
+QueryPostingSource::QueryPostingSource(Database db,
+                                       const Query & q,
+                                       const RSet & rset,
+                                       const Weight * wt_factory)
+        : internal(new Internal(db, q, rset, wt_factory))
+{
+}
+
+QueryPostingSource::~QueryPostingSource()
+{
+    delete internal;
+}
+
+doccount
+QueryPostingSource::get_termfreq_min() const
+{
+}
+
+doccount
+QueryPostingSource::get_termfreq_est() const
+{
+}
+
+doccount
+QueryPostingSource::get_termfreq_max() const
+{
+}
+
+weight
+QueryPostingSource::get_maxweight() const
+{
+}
+
+weight
+QueryPostingSource::get_weight() const
+{
+}
+
+void
+QueryPostingSource::next(weight min_wt)
+{
+}
+
+void
+QueryPostingSource::skip_to(docid min_docid,
+                            weight min_wt)
+{
+}
+
+bool
+QueryPostingSource::check(docid min_docid,
+                          weight min_wt)
+{
+}
+
+bool
+QueryPostingSource::at_end() const
+{
+    return internal->at_end();
+}
+
+docid
+QueryPostingSource::get_docid() const
+{
+}
+
+void
+QueryPostingSource::reset()
+{
+    internal->reset();
+}
+
+std::string
+QueryPostingSource::get_description() const
+{
+    return "Xapian::QueryPostingSource(" +
+            internal->db.get_description() + ", " +
+            internal->q.get_description() + ")";
+}
+
+}