queryparser_internal.h

Go to the documentation of this file.

 
/* Copyright (C) 2005-2025 Olly Betts
 * Copyright (C) 2010 Adam Sjøgren
 *
 * 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_QUERYPARSER_INTERNAL_H
#define XAPIAN_INCLUDED_QUERYPARSER_INTERNAL_H
 
#include "xapian/intrusive_ptr.h"
#include <xapian/database.h>
#include <xapian/query.h>
#include <xapian/queryparser.h>
#include <xapian/stem.h>
 
#include <list>
#include <map>
 
class State;
 
typedef enum { NON_BOOLEAN, BOOLEAN, BOOLEAN_EXCLUSIVE } filter_type;
 
struct FieldInfo {
    filter_type type;
 
    std::string grouping;
 
    std::vector<std::string> prefixes;
 
    Xapian::Internal::opt_intrusive_ptr<Xapian::FieldProcessor> proc;
 
    explicit
    FieldInfo(filter_type type_)
        : type(type_)
    {
    }
 
    FieldInfo(filter_type type_, std::string_view grouping_)
        : type(type_), grouping(grouping_)
    {
    }
 
    FieldInfo(filter_type type_, Xapian::FieldProcessor* proc_,
              std::string_view grouping_ = {})
        : type(type_), grouping(grouping_), proc(proc_)
    {
    }
 
    FieldInfo& append(std::string_view prefix)
    {
        prefixes.emplace_back(prefix);
        return *this;
    }
};
 
namespace Xapian {
 
class Utf8Iterator;
 
struct RangeProc {
    Xapian::Internal::opt_intrusive_ptr<RangeProcessor> proc;
    std::string grouping;
    bool default_grouping;
 
    RangeProc(RangeProcessor * range_proc, const std::string* grouping_)
        : proc(range_proc),
          grouping(grouping_ ? *grouping_ : std::string()),
          default_grouping(grouping_ == NULL) { }
};
 
class QueryParser::Internal : public Xapian::Internal::intrusive_base {
    friend class QueryParser;
    friend class ::State;
    Stem stemmer;
    stem_strategy stem_action = STEM_SOME;
    Xapian::Internal::opt_intrusive_ptr<const Stopper> stopper;
    stop_strategy stop_mode = STOP_STEMMED;
    Query::op default_op = Query::OP_OR;
    const char* errmsg = nullptr;
    Database db;
    std::list<std::string> stoplist;
    std::multimap<std::string, std::string, std::less<>> unstem;
 
    // Map "from" -> "A" ; "subject" -> "C" ; "newsgroups" -> "G" ;
    // "foobar" -> "XFOO". FIXME: it does more than this now!
    std::map<std::string, FieldInfo, std::less<>> field_map;
 
    std::list<RangeProc> rangeprocs;
 
    std::string corrected_query;
 
    Xapian::termcount max_wildcard_expansion = 0;
 
    Xapian::termcount max_partial_expansion = 100;
 
    Xapian::termcount max_fuzzy_expansion = 0;
 
    int max_wildcard_type = Xapian::Query::WILDCARD_LIMIT_ERROR;
 
    int max_partial_type = Xapian::Query::WILDCARD_LIMIT_MOST_FREQUENT;
 
    int max_fuzzy_type = Xapian::Query::WILDCARD_LIMIT_ERROR;
 
    unsigned min_wildcard_prefix_len = 0;
 
    unsigned min_partial_prefix_len = 2;
 
    void add_prefix(std::string_view field, std::string_view prefix);
 
    void add_prefix(std::string_view field, Xapian::FieldProcessor* proc);
 
    void add_boolean_prefix(std::string_view field,
                            std::string_view prefix,
                            const std::string* grouping);
 
    void add_boolean_prefix(std::string_view field,
                            Xapian::FieldProcessor* proc,
                            const std::string* grouping);
 
    std::string parse_term(Utf8Iterator& it, const Utf8Iterator& end,
                           bool try_word_break, unsigned flags,
                           bool& needs_word_break, bool& was_acronym,
                           size_t& first_wildcard,
                           size_t& char_count,
                           unsigned& edit_distance);
 
  public:
    Internal() { }
 
    Query parse_query(std::string_view query_string,
                      unsigned int flags,
                      std::string_view default_prefix);
};
 
}
 
#endif // XAPIAN_INCLUDED_QUERYPARSER_INTERNAL_H