keymaker.h

Go to the documentation of this file.

/* Copyright (C) 2007,2009,2011,2013,2014,2015,2016 Olly Betts
 * 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_KEYMAKER_H
#define XAPIAN_INCLUDED_KEYMAKER_H

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

#include <string>
#include <vector>

#include <xapian/intrusive_ptr.h>
#include <xapian/types.h>
#include <xapian/visibility.h>

namespace Xapian {

class Document;

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

    KeyMaker(const KeyMaker &);

  public:
    KeyMaker() { }

    virtual std::string operator()(const Xapian::Document & doc) const = 0;

    virtual ~KeyMaker();

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

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

class XAPIAN_VISIBILITY_DEFAULT MultiValueKeyMaker : public KeyMaker {
    struct KeySpec {
        Xapian::valueno slot;
        bool reverse;
        std::string defvalue;
        KeySpec(Xapian::valueno slot_, bool reverse_,
                const std::string & defvalue_)
                : slot(slot_), reverse(reverse_), defvalue(defvalue_)
        {}
    };
    std::vector<KeySpec> slots;

  public:
    MultiValueKeyMaker() { }

    template<class Iterator>
    MultiValueKeyMaker(Iterator begin, Iterator end) {
        while (begin != end) add_value(*begin++);
    }

    virtual std::string operator()(const Xapian::Document & doc) const;

    void add_value(Xapian::valueno slot, bool reverse = false,
                   const std::string & defvalue = std::string()) {
        slots.push_back(KeySpec(slot, reverse, defvalue));
    }
};

}

#endif // XAPIAN_INCLUDED_KEYMAKER_H