matchspy.h

Go to the documentation of this file.

/* Copyright (C) 2007,2008,2009,2010,2011,2012,2013,2014,2015 Olly Betts
 * Copyright (C) 2007,2009 Lemur Consulting Ltd
 * Copyright (C) 2010 Richard Boulton
 *
 * 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_MATCHSPY_H
#define XAPIAN_INCLUDED_MATCHSPY_H

#if !defined XAPIAN_IN_XAPIAN_H && !defined XAPIAN_LIB_BUILD
# error Never use <xapian/matchspy.h> directly; include <xapian.h> instead.
#endif

#include <xapian/attributes.h>
#include <xapian/intrusive_ptr.h>
#include <xapian/termiterator.h>
#include <xapian/visibility.h>

#include <string>
#include <map>

namespace Xapian {

class Document;
class Registry;

class XAPIAN_VISIBILITY_DEFAULT MatchSpy
    : public Xapian::Internal::opt_intrusive_base {
  private:
    void operator=(const MatchSpy &);

    MatchSpy(const MatchSpy &);

  public:
    XAPIAN_NOTHROW(MatchSpy()) {}

    virtual ~MatchSpy();

    virtual void operator()(const Xapian::Document &doc,
                            double wt) = 0;

    virtual MatchSpy * clone() const;

    virtual std::string name() const;

    virtual std::string serialise() const;

    virtual MatchSpy * unserialise(const std::string & serialised,
                                   const Registry & context) const;

    virtual std::string serialise_results() const;

    virtual void merge_results(const std::string & serialised);

    virtual std::string get_description() const;

    MatchSpy * release() {
        opt_intrusive_base::release();
        return this;
    }

    const MatchSpy * release() const {
        opt_intrusive_base::release();
        return this;
    }
};


class XAPIAN_VISIBILITY_DEFAULT ValueCountMatchSpy : public MatchSpy {
  public:
    struct Internal;

#ifndef SWIG // SWIG doesn't need to know about the internal class
    struct XAPIAN_VISIBILITY_DEFAULT Internal
            : public Xapian::Internal::intrusive_base
    {
        Xapian::valueno slot;

        Xapian::doccount total;

        std::map<std::string, Xapian::doccount> values;

        Internal() : slot(Xapian::BAD_VALUENO), total(0) {}
        explicit Internal(Xapian::valueno slot_) : slot(slot_), total(0) {}
    };
#endif

  protected:
    Xapian::Internal::intrusive_ptr<Internal> internal;

  public:
    ValueCountMatchSpy() {}

    explicit ValueCountMatchSpy(Xapian::valueno slot_)
            : internal(new Internal(slot_)) {}

    size_t XAPIAN_NOTHROW(get_total() const) {
        return internal.get() ? internal->total : 0;
    }

    TermIterator values_begin() const;

    TermIterator XAPIAN_NOTHROW(values_end() const) {
        return TermIterator();
    }

    TermIterator top_values_begin(size_t maxvalues) const;

    TermIterator XAPIAN_NOTHROW(top_values_end(size_t) const) {
        return TermIterator();
    }

    void operator()(const Xapian::Document &doc, double wt);

    virtual MatchSpy * clone() const;
    virtual std::string name() const;
    virtual std::string serialise() const;
    virtual MatchSpy * unserialise(const std::string & serialised,
                                   const Registry & context) const;
    virtual std::string serialise_results() const;
    virtual void merge_results(const std::string & serialised);
    virtual std::string get_description() const;
};

}

#endif // XAPIAN_INCLUDED_MATCHSPY_H