termgenerator.h

Go to the documentation of this file.

/* Copyright (C) 2007,2009,2011,2012,2013,2014,2018,2023 Olly Betts
 *
 * 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_TERMGENERATOR_H
#define XAPIAN_INCLUDED_TERMGENERATOR_H

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

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

#include <string>

namespace Xapian {

class Document;
class Stem;
class Stopper;
class WritableDatabase;

class XAPIAN_VISIBILITY_DEFAULT TermGenerator {
  public:
    class Internal;
    Xapian::Internal::intrusive_ptr<Internal> internal;

    TermGenerator(const TermGenerator & o);

    TermGenerator & operator=(const TermGenerator & o);

#ifdef XAPIAN_MOVE_SEMANTICS
    TermGenerator(TermGenerator && o);

    TermGenerator & operator=(TermGenerator && o);
#endif

    TermGenerator();

    ~TermGenerator();

    void set_stemmer(const Xapian::Stem & stemmer);

    void set_stopper(const Xapian::Stopper *stop = NULL);

    void set_document(const Xapian::Document & doc);

    const Xapian::Document & get_document() const;

    void set_database(const Xapian::WritableDatabase &db);

    typedef int flags;

    enum {
        FLAG_SPELLING = 128, // Value matches QueryParser flag.

        FLAG_NGRAMS = 2048, // Value matches QueryParser flag.

        FLAG_CJK_NGRAM = FLAG_NGRAMS // Value matches QueryParser flag.
    };

    typedef enum {
        STEM_NONE, STEM_SOME, STEM_ALL, STEM_ALL_Z, STEM_SOME_FULL_POS
    } stem_strategy;

    typedef enum { STOP_NONE, STOP_ALL, STOP_STEMMED } stop_strategy;

    flags set_flags(flags toggle, flags mask = flags(0));

    void set_stemming_strategy(stem_strategy strategy);

    void set_stopper_strategy(stop_strategy strategy);

    void set_max_word_length(unsigned max_word_length);

    void index_text(const Xapian::Utf8Iterator & itor,
                    Xapian::termcount wdf_inc = 1,
                    const std::string & prefix = std::string());

    void index_text(const std::string & text,
                    Xapian::termcount wdf_inc = 1,
                    const std::string & prefix = std::string()) {
        index_text(Utf8Iterator(text), wdf_inc, prefix);
    }

    void index_text_without_positions(const Xapian::Utf8Iterator & itor,
                                      Xapian::termcount wdf_inc = 1,
                                      const std::string & prefix = std::string());

    void index_text_without_positions(const std::string & text,
                                      Xapian::termcount wdf_inc = 1,
                                      const std::string & prefix = std::string()) {
        index_text_without_positions(Utf8Iterator(text), wdf_inc, prefix);
    }

    void increase_termpos(Xapian::termpos delta = 100);

    Xapian::termpos get_termpos() const;

    void set_termpos(Xapian::termpos termpos);

    std::string get_description() const;
};

}

#endif // XAPIAN_INCLUDED_TERMGENERATOR_H