xapian-quest.cc File Reference

Command line search tool using Xapian::QueryParser. More...

#include <config.h>
#include <xapian.h>
#include <cstdlib>
#include <cstring>
#include <algorithm>
#include <iostream>
#include "gnu_getopt.h"
#include "stringutils.h"

Include dependency graph for xapian-quest.cc:

Go to the source code of this file.

Classes
struct	tab_entry
	Common string to integer map entry for option decoding. More...

Macros
#define	PROG_NAME   "xapian-quest"
#define	PROG_DESC   "Xapian command line search tool"
#define	INDENT   " "
	The number of spaces to indent by in print_table. More...

Functions
template<typename T , std::size_t N>
static int	decode (const T(&table)[N], const char *s)
	Decode a string to an integer. More...
template<typename T >
static char	print_table (const T &table)
	Print strings from a string to integer mapping table. More...
static char	print_stemmers ()
	Print available stemmers, line wrapped. More...
template<typename T >
static void	list_table (const T &table)
	List strings from a string to integer mapping table, one per line. More...
static void	show_usage ()
int	main (int argc, char **argv)

Variables
static const char *const	sw []
static const tab_entry	flag_tab []
static const tab_entry	default_op_tab []
static const tab_entry	stem_strategy_tab []

Detailed Description

Command line search tool using Xapian::QueryParser.

Definition in file xapian-quest.cc.

Macro Definition Documentation

INDENT

#define INDENT   " "

The number of spaces to indent by in print_table.

This needs to match the indent in the help message in show_usage() below.

Definition at line 125 of file xapian-quest.cc.

PROG_DESC

#define PROG_DESC   "Xapian command line search tool"

Definition at line 37 of file xapian-quest.cc.

PROG_NAME

#define PROG_NAME   "xapian-quest"

Definition at line 36 of file xapian-quest.cc.

Function Documentation

decode()

template<typename T , std::size_t N>

static int decode ( const T(&)  table[N], const char *  s  )

static

Decode a string to an integer.

Parameters

table	Array of tab_entry in ascending string order.
s	The string to decode.

Definition at line 70 of file xapian-quest.cc.

References p.

Referenced by Xapian::BitReader::decode_interpolative_next(), and main().

list_table()

template<typename T >

static void list_table ( const T &  table )

static

List strings from a string to integer mapping table, one per line.

Parameters

table

Array of tab_entry in ascending string order.

Definition at line 183 of file xapian-quest.cc.

Referenced by main().

main()

int main	(	int	argc,
		char **	argv
	)

Definition at line 224 of file xapian-quest.cc.

References Xapian::QueryParser::add_boolean_prefix(), Xapian::Database::add_database(), Xapian::QueryParser::add_prefix(), Xapian::MSet::begin(), Xapian::Weight::create(), decode(), default_op_tab, Xapian::MSet::end(), option::flag, Xapian::QueryParser::FLAG_DEFAULT, flag_tab, Xapian::Stem::get_available_languages(), Xapian::QueryParser::get_corrected_query_string(), Xapian::Document::get_data(), Xapian::Query::get_description(), Xapian::MSet::get_matches_estimated(), Xapian::MSet::get_matches_lower_bound(), Xapian::MSet::get_matches_upper_bound(), Xapian::Enquire::get_mset(), Xapian::MSet::get_termfreq(), Xapian::Query::get_terms_begin(), Xapian::Query::get_terms_end(), gnu_getopt_long(), list_table(), long_opts, no_argument, optarg, optind, opts, p, PACKAGE_STRING, Xapian::QueryParser::parse_query(), PROG_DESC, PROG_NAME, query(), required_argument, Xapian::QueryParser::set_database(), Xapian::QueryParser::set_default_op(), Xapian::Enquire::set_query(), Xapian::QueryParser::set_stemmer(), Xapian::QueryParser::set_stemming_strategy(), Xapian::QueryParser::set_stopper(), Xapian::Enquire::set_weighting_scheme(), show_usage(), stem_strategy_tab, stemmer, sw, and term.

print_stemmers()

static char print_stemmers ( )

static

Print available stemmers, line wrapped.

Definition at line 154 of file xapian-quest.cc.

References Xapian::Stem::get_available_languages(), INDENT, p, and pos.

Referenced by show_usage().

print_table()

template<typename T >

static char print_table ( const T &  table )

static

Print strings from a string to integer mapping table.

Parameters

table

Array of tab_entry in ascending string order.

Definition at line 134 of file xapian-quest.cc.

References INDENT, and pos.

Referenced by show_usage().

show_usage()

static void show_usage ( )

static

Definition at line 190 of file xapian-quest.cc.

References default_op_tab, flag_tab, print_stemmers(), print_table(), PROG_NAME, and stem_strategy_tab.

Referenced by main().

Variable Documentation

default_op_tab

const tab_entry default_op_tab[]

static

Initial value:

= {
    { "and", Xapian::Query::OP_AND },
    { "elite_set", Xapian::Query::OP_ELITE_SET },
    { "max", Xapian::Query::OP_MAX },
    { "near", Xapian::Query::OP_NEAR },
    { "or", Xapian::Query::OP_OR },
    { "phrase", Xapian::Query::OP_PHRASE },
    { "synonym", Xapian::Query::OP_SYNONYM }
}

Definition at line 103 of file xapian-quest.cc.

Referenced by main(), and show_usage().

flag_tab

const tab_entry flag_tab[]

static

Initial value:

= {
    { "accumulate", Xapian::QueryParser::FLAG_ACCUMULATE },
    { "auto_multiword_synonyms", Xapian::QueryParser::FLAG_AUTO_MULTIWORD_SYNONYMS },
    { "auto_synonyms", Xapian::QueryParser::FLAG_AUTO_SYNONYMS },
    { "boolean", Xapian::QueryParser::FLAG_BOOLEAN },
    { "boolean_any_case", Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE },
    { "cjk_ngram", Xapian::QueryParser::FLAG_CJK_NGRAM },
    { "default", Xapian::QueryParser::FLAG_DEFAULT },
    { "fuzzy", Xapian::QueryParser::FLAG_FUZZY },
    { "lovehate", Xapian::QueryParser::FLAG_LOVEHATE },
    { "ngrams", Xapian::QueryParser::FLAG_NGRAMS },
    { "no_positions", Xapian::QueryParser::FLAG_NO_POSITIONS },
    { "no_proper_noun_heuristic", Xapian::QueryParser::FLAG_NO_PROPER_NOUN_HEURISTIC },
    { "partial", Xapian::QueryParser::FLAG_PARTIAL },
    { "phrase", Xapian::QueryParser::FLAG_PHRASE },
    { "pure_not", Xapian::QueryParser::FLAG_PURE_NOT },
    { "spelling_correction", Xapian::QueryParser::FLAG_SPELLING_CORRECTION },
    { "synonym", Xapian::QueryParser::FLAG_SYNONYM },
    { "wildcard", Xapian::QueryParser::FLAG_WILDCARD },
    { "wildcard_glob", Xapian::QueryParser::FLAG_WILDCARD_GLOB },
    { "wildcard_multi", Xapian::QueryParser::FLAG_WILDCARD_MULTI },
    { "wildcard_single", Xapian::QueryParser::FLAG_WILDCARD_SINGLE },
    { "word_breaks", Xapian::QueryParser::FLAG_WORD_BREAKS }
}

Definition at line 78 of file xapian-quest.cc.

Referenced by main(), and show_usage().

stem_strategy_tab

const tab_entry stem_strategy_tab[]

static

Initial value:

= {
    { "all", Xapian::QueryParser::STEM_ALL },
    { "all_z", Xapian::QueryParser::STEM_ALL_Z },
    { "none", Xapian::QueryParser::STEM_NONE },
    { "some", Xapian::QueryParser::STEM_SOME },
    { "some_full_pos", Xapian::QueryParser::STEM_SOME_FULL_POS }
}

Definition at line 113 of file xapian-quest.cc.

Referenced by main(), and show_usage().

sw

const char* const sw[]

static

Initial value:

= {
    "a", "about", "an", "and", "are", "as", "at",
    "be", "by",
    "en",
    "for", "from",
    "how",
    "i", "in", "is", "it",
    "of", "on", "or",
    "that", "the", "this", "to",
    "was", "what", "when", "where", "which", "who", "why", "will", "with"
}

Definition at line 40 of file xapian-quest.cc.

Referenced by main().