This builds off of rBf951aa063f7, adding a weight parameter which can be used to change the order of items when they have the same match score. In the future, if string searching gets a C++ API, we could use an optional parameter for the weight, since it is not used yet. This will be used for the node link drag search menu (D8286). Differential Revision: https://developer.blender.org/D13559
80 lines
2.6 KiB
C++
80 lines
2.6 KiB
C++
/*
|
|
* 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 Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef struct StringSearch StringSearch;
|
|
|
|
StringSearch *BLI_string_search_new(void);
|
|
/**
|
|
* Add a new possible result to the search.
|
|
* The caller keeps ownership of all parameters.
|
|
*
|
|
* \param weight: Can be used to customize the order when multiple items have the same match score.
|
|
*/
|
|
void BLI_string_search_add(StringSearch *search, const char *str, void *user_data, int weight);
|
|
|
|
/**
|
|
* Filter and sort all previously added search items.
|
|
* Returns an array containing the filtered user data.
|
|
* The caller has to free the returned array.
|
|
*/
|
|
int BLI_string_search_query(StringSearch *search, const char *query, void ***r_data);
|
|
void BLI_string_search_free(StringSearch *search);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
|
|
# include "BLI_linear_allocator.hh"
|
|
# include "BLI_span.hh"
|
|
# include "BLI_string_ref.hh"
|
|
# include "BLI_vector.hh"
|
|
|
|
namespace blender::string_search {
|
|
|
|
/**
|
|
* Computes the cost of transforming string a into b. The cost/distance is the minimal number of
|
|
* operations that need to be executed. Valid operations are deletion, insertion, substitution and
|
|
* transposition.
|
|
*
|
|
* This function is utf8 aware in the sense that it works at the level of individual code points
|
|
* (1-4 bytes long) instead of on individual bytes.
|
|
*/
|
|
int damerau_levenshtein_distance(StringRef a, StringRef b);
|
|
/**
|
|
* Returns -1 when this is no reasonably good match.
|
|
* Otherwise returns the number of errors in the match.
|
|
*/
|
|
int get_fuzzy_match_errors(StringRef query, StringRef full);
|
|
/**
|
|
* Splits a string into words and normalizes them (currently that just means converting to lower
|
|
* case). The returned strings are allocated in the given allocator.
|
|
*/
|
|
void extract_normalized_words(StringRef str,
|
|
LinearAllocator<> &allocator,
|
|
Vector<StringRef, 64> &r_words);
|
|
|
|
} // namespace blender::string_search
|
|
|
|
#endif
|