keymaker.h

Go to the documentation of this file.

 
/* Copyright (C) 2007,2009,2011,2013,2014,2015,2016,2019,2024 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, see
 * <https://www.gnu.org/licenses/>.
 */
 
#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 <string_view>
#include <vector>
 
#include <xapian/intrusive_ptr.h>
#include <xapian/types.h>
#include <xapian/visibility.h>
 
namespace Xapian {
 
class Document;
class Registry;
 
class XAPIAN_VISIBILITY_DEFAULT KeyMaker
    : public Xapian::Internal::opt_intrusive_base {
    void operator=(const KeyMaker &) = delete;
 
    KeyMaker(const KeyMaker &) = delete;
 
  public:
    KeyMaker() { }
 
    virtual std::string operator()(const Xapian::Document & doc) const = 0;
 
    virtual ~KeyMaker();
 
    virtual std::string name() const;
 
    virtual std::string serialise() const;
 
    virtual KeyMaker* unserialise(const std::string& serialised,
                                  const Registry& context) const;
 
    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_,
                std::string_view 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,
                   std::string_view defvalue = {}) {
        slots.push_back(KeySpec(slot, reverse, defvalue));
    }
 
    std::string name() const;
 
    std::string serialise() const;
 
    KeyMaker* unserialise(const std::string& serialised,
                          const Registry& context) const;
};
 
}
 
#endif // XAPIAN_INCLUDED_KEYMAKER_H