(svn r24337) -Feature: Allow filtering for multiple words (separated by whitespace resp. quoted) in the sign list, content- and NewGRF-guis.
parent
db709aff32
commit
03046f614f
@ -0,0 +1,120 @@
|
||||
/* $Id$ */
|
||||
|
||||
/*
|
||||
* This file is part of OpenTTD.
|
||||
* OpenTTD 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, version 2.
|
||||
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/** @file stringfilter.cpp Searching and filtering using a stringterm. */
|
||||
|
||||
#include "stdafx.h"
|
||||
#include "string_func.h"
|
||||
#include "stringfilter_type.h"
|
||||
|
||||
static const WChar STATE_WHITESPACE = ' ';
|
||||
static const WChar STATE_WORD = 'w';
|
||||
static const WChar STATE_QUOTE1 = '\'';
|
||||
static const WChar STATE_QUOTE2 = '"';
|
||||
|
||||
/**
|
||||
* Set the term to filter on.
|
||||
* @param str Filter term
|
||||
*/
|
||||
void StringFilter::SetFilterTerm(const char *str)
|
||||
{
|
||||
this->word_index.Reset();
|
||||
this->word_matches = 0;
|
||||
free(this->filter_buffer);
|
||||
|
||||
assert(str != NULL);
|
||||
|
||||
char *dest = (char *)malloc(strlen(str) + 1);
|
||||
this->filter_buffer = dest;
|
||||
|
||||
WChar state = STATE_WHITESPACE;
|
||||
const char *pos = str;
|
||||
WordState *word = NULL;
|
||||
size_t len;
|
||||
for (;; pos += len) {
|
||||
WChar c;
|
||||
len = Utf8Decode(&c, pos);
|
||||
|
||||
if (c == 0 || (state == STATE_WORD && IsWhitespace(c))) {
|
||||
/* Finish word */
|
||||
if (word != NULL) {
|
||||
*(dest++) = '\0';
|
||||
word = NULL;
|
||||
}
|
||||
state = STATE_WHITESPACE;
|
||||
if (c != 0) continue; else break;
|
||||
}
|
||||
|
||||
if (state == STATE_WHITESPACE) {
|
||||
/* Skip whitespace */
|
||||
if (IsWhitespace(c)) continue;
|
||||
state = STATE_WORD;
|
||||
}
|
||||
|
||||
if (c == STATE_QUOTE1 || c == STATE_QUOTE2) {
|
||||
if (state == c) {
|
||||
/* Stop quoting */
|
||||
state = STATE_WORD;
|
||||
continue;
|
||||
} else if (state == STATE_WORD) {
|
||||
/* Start quoting */
|
||||
state = c;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
/* Add to word */
|
||||
if (word == NULL) {
|
||||
word = this->word_index.Append();
|
||||
word->start = dest;
|
||||
word->match = false;
|
||||
}
|
||||
|
||||
memcpy(dest, pos, len);
|
||||
dest += len;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Reset the matching state to process a new item.
|
||||
*/
|
||||
void StringFilter::ResetState()
|
||||
{
|
||||
this->word_matches = 0;
|
||||
const WordState *end = this->word_index.End();
|
||||
for (WordState *it = this->word_index.Begin(); it != end; ++it) {
|
||||
it->match = false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Pass another text line from the current item to the filter.
|
||||
*
|
||||
* You can call this multiple times for a single item, if the filter shall apply to multiple things.
|
||||
* Before processing the next item you have to call ResetState().
|
||||
*
|
||||
* @param str Another line from the item.
|
||||
*/
|
||||
void StringFilter::AddLine(const char *str)
|
||||
{
|
||||
if (str == NULL) return;
|
||||
|
||||
bool match_case = this->case_sensitive != NULL && *this->case_sensitive;
|
||||
const WordState *end = this->word_index.End();
|
||||
for (WordState *it = this->word_index.Begin(); it != end; ++it) {
|
||||
if (!it->match) {
|
||||
if ((match_case ? strstr(str, it->start) : strcasestr(str, it->start)) != NULL) {
|
||||
it->match = true;
|
||||
this->word_matches++;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -0,0 +1,72 @@
|
||||
/* $Id$ */
|
||||
|
||||
/*
|
||||
* This file is part of OpenTTD.
|
||||
* OpenTTD 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, version 2.
|
||||
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/** @file stringfilter_type.h Searching and filtering using a stringterm. */
|
||||
|
||||
#ifndef STRINGFILTER_TYPE_H
|
||||
#define STRINGFILTER_TYPE_H
|
||||
|
||||
#include "core/smallvec_type.hpp"
|
||||
|
||||
/**
|
||||
* String filter and state.
|
||||
*
|
||||
* The filter takes a stringterm and parses it into words separated by whitespace.
|
||||
* The whitespace-separation can be avoided by quoting words in the searchterm using " or '.
|
||||
* The quotation characters can be nested or concatenated in a unix-shell style.
|
||||
*
|
||||
* When filtering an item, all words are checked for matches, and the filter matches if every word
|
||||
* matched. So, effectively this is a AND search for all entered words.
|
||||
*
|
||||
* Once the filter is set up using SetFilterTerm, multiple items can be filtered consecutively.
|
||||
* 1. For every item first call ResetState() which resets the matching-state.
|
||||
* 2. Pass all lines of the item via AddLine() to the filter.
|
||||
* 3. Check the matching-result for the item via GetState().
|
||||
*/
|
||||
struct StringFilter {
|
||||
private:
|
||||
/** State of a single filter word */
|
||||
struct WordState {
|
||||
const char *start; ///< Word to filter for.
|
||||
bool match; ///< Already matched?
|
||||
};
|
||||
|
||||
const char *filter_buffer; ///< Parsed filter string. Words separated by 0.
|
||||
SmallVector<WordState, 4> word_index; ///< Word index and filter state.
|
||||
uint word_matches; ///< Summary of filter state: Number of words matched.
|
||||
|
||||
const bool *case_sensitive; ///< Match case-sensitively (usually a static variable).
|
||||
|
||||
public:
|
||||
/**
|
||||
* Constructor for filter.
|
||||
* @param case_sensitive Pointer to a (usually static) variable controlling the case-sensitivity. NULL means always case-insensitive.
|
||||
*/
|
||||
StringFilter(const bool *case_sensitive = NULL) : filter_buffer(NULL), word_matches(0), case_sensitive(case_sensitive) {}
|
||||
~StringFilter() { free(this->filter_buffer); }
|
||||
|
||||
void SetFilterTerm(const char *str);
|
||||
|
||||
/**
|
||||
* Check whether any filter words were entered.
|
||||
* @return true if no words were entered.
|
||||
*/
|
||||
bool IsEmpty() const { return this->word_index.Length() == 0; }
|
||||
|
||||
void ResetState();
|
||||
void AddLine(const char *str);
|
||||
|
||||
/**
|
||||
* Get the matching state of the current item.
|
||||
* @return true if matched.
|
||||
*/
|
||||
bool GetState() const { return this->word_matches == this->word_index.Length(); }
|
||||
};
|
||||
|
||||
#endif /* STRINGFILTER_TYPE_H */
|
Loading…
Reference in New Issue