stem.h

Go to the documentation of this file.

/* Copyright (C) 2005,2007,2010,2011,2013,2014,2015,2018,2019 Olly Betts
 * Copyright (C) 2010 Evgeny Sizikov
 *
 * 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_STEM_H
#define XAPIAN_INCLUDED_STEM_H

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

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

#include <string>

namespace Xapian {

class XAPIAN_VISIBILITY_DEFAULT StemImplementation
    : public Xapian::Internal::intrusive_base
{
    void operator=(const StemImplementation &);

    StemImplementation(const StemImplementation &);

  public:
    StemImplementation() { }

    virtual ~StemImplementation();

    virtual std::string operator()(const std::string & word) = 0;

    virtual std::string get_description() const = 0;
};

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

    Stem(const Stem & o);

    Stem & operator=(const Stem & o);

#ifdef XAPIAN_MOVE_SEMANTICS
    Stem(Stem && o);

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

    Stem();

    explicit Stem(const std::string& language);
    Stem(const std::string& language, bool fallback);
    explicit Stem(StemImplementation * p);

    ~Stem();

    std::string operator()(const std::string &word) const;

    bool is_none() const { return !internal.get(); }

    std::string get_description() const;

    static std::string get_available_languages() {
        const struct Xapian::Internal::constinfo * info =
            Xapian::Internal::get_constinfo_();
        return std::string(info->stemmer_data, info->stemmer_name_len);
    }
};

}

#endif // XAPIAN_INCLUDED_STEM_H