mirror of
https://github.com/microsoft/PowerToys.git
synced 2024-12-15 12:09:18 +08:00
324 lines
13 KiB
C#
324 lines
13 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using Wox.Infrastructure.Logger;
|
|
using Wox.Infrastructure.UserSettings;
|
|
using static Wox.Infrastructure.StringMatcher;
|
|
|
|
namespace Wox.Infrastructure
|
|
{
|
|
public static class StringMatcher
|
|
{
|
|
public static MatchOption DefaultMatchOption = new MatchOption();
|
|
|
|
public static SearchPrecisionScore UserSettingSearchPrecision { get; set; }
|
|
|
|
public static bool ShouldUsePinyin { get; set; }
|
|
|
|
[Obsolete("This method is obsolete and should not be used. Please use the static function StringMatcher.FuzzySearch")]
|
|
public static int Score(string source, string target)
|
|
{
|
|
if (!string.IsNullOrEmpty(source) && !string.IsNullOrEmpty(target))
|
|
{
|
|
return FuzzySearch(target, source, DefaultMatchOption).Score;
|
|
}
|
|
else
|
|
{
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
[Obsolete("This method is obsolete and should not be used. Please use the static function StringMatcher.FuzzySearch")]
|
|
public static bool IsMatch(string source, string target)
|
|
{
|
|
return FuzzySearch(target, source, DefaultMatchOption).Score > 0;
|
|
}
|
|
|
|
public static MatchResult FuzzySearch(string query, string stringToCompare)
|
|
{
|
|
return FuzzySearch(query, stringToCompare, DefaultMatchOption);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Current method:
|
|
/// Character matching + substring matching;
|
|
/// 1. Query search string is split into substrings, separator is whitespace.
|
|
/// 2. Check each query substring's characters against full compare string,
|
|
/// 3. if a character in the substring is matched, loop back to verify the previous character.
|
|
/// 4. If previous character also matches, and is the start of the substring, update list.
|
|
/// 5. Once the previous character is verified, move on to the next character in the query substring.
|
|
/// 6. Move onto the next substring's characters until all substrings are checked.
|
|
/// 7. Consider success and move onto scoring if every char or substring without whitespaces matched
|
|
/// </summary>
|
|
public static MatchResult FuzzySearch(string query, string stringToCompare, MatchOption opt)
|
|
{
|
|
if (string.IsNullOrEmpty(stringToCompare) || string.IsNullOrEmpty(query)) return new MatchResult { Success = false };
|
|
|
|
query = query.Trim();
|
|
|
|
var fullStringToCompareWithoutCase = opt.IgnoreCase ? stringToCompare.ToLower() : stringToCompare;
|
|
|
|
var queryWithoutCase = opt.IgnoreCase ? query.ToLower() : query;
|
|
|
|
var querySubstrings = queryWithoutCase.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);
|
|
int currentQuerySubstringIndex = 0;
|
|
var currentQuerySubstring = querySubstrings[currentQuerySubstringIndex];
|
|
var currentQuerySubstringCharacterIndex = 0;
|
|
|
|
var firstMatchIndex = -1;
|
|
var firstMatchIndexInWord = -1;
|
|
var lastMatchIndex = 0;
|
|
bool allQuerySubstringsMatched = false;
|
|
bool matchFoundInPreviousLoop = false;
|
|
bool allSubstringsContainedInCompareString = true;
|
|
|
|
var indexList = new List<int>();
|
|
|
|
for (var compareStringIndex = 0; compareStringIndex < fullStringToCompareWithoutCase.Length; compareStringIndex++)
|
|
{
|
|
if (fullStringToCompareWithoutCase[compareStringIndex] != currentQuerySubstring[currentQuerySubstringCharacterIndex])
|
|
{
|
|
matchFoundInPreviousLoop = false;
|
|
continue;
|
|
}
|
|
|
|
if (firstMatchIndex < 0)
|
|
{
|
|
// first matched char will become the start of the compared string
|
|
firstMatchIndex = compareStringIndex;
|
|
}
|
|
|
|
if (currentQuerySubstringCharacterIndex == 0)
|
|
{
|
|
// first letter of current word
|
|
matchFoundInPreviousLoop = true;
|
|
firstMatchIndexInWord = compareStringIndex;
|
|
}
|
|
else if (!matchFoundInPreviousLoop)
|
|
{
|
|
// we want to verify that there is not a better match if this is not a full word
|
|
// in order to do so we need to verify all previous chars are part of the pattern
|
|
var startIndexToVerify = compareStringIndex - currentQuerySubstringCharacterIndex;
|
|
|
|
if (AllPreviousCharsMatched(startIndexToVerify, currentQuerySubstringCharacterIndex, fullStringToCompareWithoutCase, currentQuerySubstring))
|
|
{
|
|
matchFoundInPreviousLoop = true;
|
|
|
|
// if it's the beginning character of the first query substring that is matched then we need to update start index
|
|
firstMatchIndex = currentQuerySubstringIndex == 0 ? startIndexToVerify : firstMatchIndex;
|
|
|
|
indexList = GetUpdatedIndexList(startIndexToVerify, currentQuerySubstringCharacterIndex, firstMatchIndexInWord, indexList);
|
|
}
|
|
}
|
|
|
|
lastMatchIndex = compareStringIndex + 1;
|
|
indexList.Add(compareStringIndex);
|
|
|
|
currentQuerySubstringCharacterIndex++;
|
|
|
|
// if finished looping through every character in the current substring
|
|
if (currentQuerySubstringCharacterIndex == currentQuerySubstring.Length)
|
|
{
|
|
// if any of the substrings was not matched then consider as all are not matched
|
|
allSubstringsContainedInCompareString = matchFoundInPreviousLoop && allSubstringsContainedInCompareString;
|
|
|
|
currentQuerySubstringIndex++;
|
|
|
|
allQuerySubstringsMatched = AllQuerySubstringsMatched(currentQuerySubstringIndex, querySubstrings.Length);
|
|
if (allQuerySubstringsMatched)
|
|
break;
|
|
|
|
// otherwise move to the next query substring
|
|
currentQuerySubstring = querySubstrings[currentQuerySubstringIndex];
|
|
currentQuerySubstringCharacterIndex = 0;
|
|
}
|
|
}
|
|
|
|
// proceed to calculate score if every char or substring without whitespaces matched
|
|
if (allQuerySubstringsMatched)
|
|
{
|
|
var score = CalculateSearchScore(query, stringToCompare, firstMatchIndex, lastMatchIndex - firstMatchIndex, allSubstringsContainedInCompareString);
|
|
var pinyinScore = ScoreForPinyin(stringToCompare, query);
|
|
|
|
var result = new MatchResult
|
|
{
|
|
Success = true,
|
|
MatchData = indexList,
|
|
RawScore = Math.Max(score, pinyinScore),
|
|
AllSubstringsContainedInCompareString = allSubstringsContainedInCompareString
|
|
};
|
|
|
|
return result;
|
|
}
|
|
|
|
return new MatchResult { Success = false };
|
|
}
|
|
|
|
private static bool AllPreviousCharsMatched(int startIndexToVerify, int currentQuerySubstringCharacterIndex,
|
|
string fullStringToCompareWithoutCase, string currentQuerySubstring)
|
|
{
|
|
var allMatch = true;
|
|
for (int indexToCheck = 0; indexToCheck < currentQuerySubstringCharacterIndex; indexToCheck++)
|
|
{
|
|
if (fullStringToCompareWithoutCase[startIndexToVerify + indexToCheck] !=
|
|
currentQuerySubstring[indexToCheck])
|
|
{
|
|
allMatch = false;
|
|
}
|
|
}
|
|
|
|
return allMatch;
|
|
}
|
|
|
|
private static List<int> GetUpdatedIndexList(int startIndexToVerify, int currentQuerySubstringCharacterIndex, int firstMatchIndexInWord, List<int> indexList)
|
|
{
|
|
var updatedList = new List<int>();
|
|
|
|
indexList.RemoveAll(x => x >= firstMatchIndexInWord);
|
|
|
|
updatedList.AddRange(indexList);
|
|
|
|
for (int indexToCheck = 0; indexToCheck < currentQuerySubstringCharacterIndex; indexToCheck++)
|
|
{
|
|
updatedList.Add(startIndexToVerify + indexToCheck);
|
|
}
|
|
|
|
return updatedList;
|
|
}
|
|
|
|
private static bool AllQuerySubstringsMatched(int currentQuerySubstringIndex, int querySubstringsLength)
|
|
{
|
|
return currentQuerySubstringIndex >= querySubstringsLength;
|
|
}
|
|
|
|
private static int CalculateSearchScore(string query, string stringToCompare, int firstIndex, int matchLen, bool allSubstringsContainedInCompareString)
|
|
{
|
|
// A match found near the beginning of a string is scored more than a match found near the end
|
|
// A match is scored more if the characters in the patterns are closer to each other,
|
|
// while the score is lower if they are more spread out
|
|
var score = 100 * (query.Length + 1) / ((1 + firstIndex) + (matchLen + 1));
|
|
|
|
// A match with less characters assigning more weights
|
|
if (stringToCompare.Length - query.Length < 5)
|
|
{
|
|
score += 20;
|
|
}
|
|
else if (stringToCompare.Length - query.Length < 10)
|
|
{
|
|
score += 10;
|
|
}
|
|
|
|
if (allSubstringsContainedInCompareString)
|
|
score += 10 * string.Concat(query.Where(c => !char.IsWhiteSpace(c))).Count();
|
|
|
|
return score;
|
|
}
|
|
|
|
public enum SearchPrecisionScore
|
|
{
|
|
Regular = 50,
|
|
Low = 20,
|
|
None = 0
|
|
}
|
|
|
|
public static int ScoreForPinyin(string source, string target)
|
|
{
|
|
if (!ShouldUsePinyin)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
if (!string.IsNullOrEmpty(source) && !string.IsNullOrEmpty(target))
|
|
{
|
|
if (Alphabet.ContainsChinese(source))
|
|
{
|
|
var combination = Alphabet.PinyinComination(source);
|
|
var pinyinScore = combination
|
|
.Select(pinyin => FuzzySearch(target, string.Join("", pinyin)).Score)
|
|
.Max();
|
|
var acronymScore = combination.Select(Alphabet.Acronym)
|
|
.Select(pinyin => FuzzySearch(target, pinyin).Score)
|
|
.Max();
|
|
var score = Math.Max(pinyinScore, acronymScore);
|
|
return score;
|
|
}
|
|
else
|
|
{
|
|
return 0;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
return 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
public class MatchResult
|
|
{
|
|
public bool Success { get; set; }
|
|
|
|
/// <summary>
|
|
/// The final score of the match result with all search precision filters applied.
|
|
/// </summary>
|
|
public int Score { get; private set; }
|
|
|
|
/// <summary>
|
|
/// The raw calculated search score without any search precision filtering applied.
|
|
/// </summary>
|
|
private int _rawScore;
|
|
|
|
public int RawScore
|
|
{
|
|
get { return _rawScore; }
|
|
set
|
|
{
|
|
_rawScore = value;
|
|
Score = ApplySearchPrecisionFilter(_rawScore);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indicates if all query's substrings are contained in the string to compare
|
|
/// </summary>
|
|
public bool AllSubstringsContainedInCompareString { get; set; }
|
|
|
|
/// <summary>
|
|
/// Matched data to highlight.
|
|
/// </summary>
|
|
public List<int> MatchData { get; set; }
|
|
|
|
public bool IsSearchPrecisionScoreMet()
|
|
{
|
|
return IsSearchPrecisionScoreMet(Score);
|
|
}
|
|
|
|
private bool IsSearchPrecisionScoreMet(int score)
|
|
{
|
|
return score >= (int)UserSettingSearchPrecision;
|
|
}
|
|
|
|
private int ApplySearchPrecisionFilter(int score)
|
|
{
|
|
return IsSearchPrecisionScoreMet(score) ? score : 0;
|
|
}
|
|
}
|
|
|
|
public class MatchOption
|
|
{
|
|
/// <summary>
|
|
/// prefix of match char, use for hightlight
|
|
/// </summary>
|
|
[Obsolete("this is never used")]
|
|
public string Prefix { get; set; } = "";
|
|
|
|
/// <summary>
|
|
/// suffix of match char, use for hightlight
|
|
/// </summary>
|
|
[Obsolete("this is never used")]
|
|
public string Suffix { get; set; } = "";
|
|
|
|
public bool IgnoreCase { get; set; } = true;
|
|
}
|
|
} |