Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vshawn/variablekeywordmatcher
VariableKeywordMatcher is library offering several string-keyword matchers, they allow you match keyword by Initials\Chinese PinYin\Japanese Romaji... You can get the keyword hit position that allow you to high light the matched words.
https://github.com/vshawn/variablekeywordmatcher
Last synced: about 5 hours ago
JSON representation
VariableKeywordMatcher is library offering several string-keyword matchers, they allow you match keyword by Initials\Chinese PinYin\Japanese Romaji... You can get the keyword hit position that allow you to high light the matched words.
- Host: GitHub
- URL: https://github.com/vshawn/variablekeywordmatcher
- Owner: VShawn
- License: mit
- Created: 2021-03-11T10:24:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-02T11:36:38.000Z (about 1 year ago)
- Last Synced: 2024-11-14T08:55:44.527Z (5 days ago)
- Language: C#
- Homepage:
- Size: 2.15 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# [Variable-Keyword-Matcher](https://github.com/VShawn/VariableKeywordMatcher)
VariableKeywordMatcher is a C# lib for:
- English initials matching
- English discrete matching
- Chinese PinYin matching
- Japanese Romajin matching
- highlight multiple keywords in search
- pluggable for more spell matching for future. (e.g. [Tongyong Pinyin](https://en.wikipedia.org/wiki/Tongyong_Pinyin), [Korean Hangul](https://en.wikipedia.org/wiki/Hangul) ... )
## Usage
### Install
Install from nuget:
[VariableKeywordMatcher](https://www.nuget.org/packages/VariableKeywordMatcher/)
[(optional)MatcherProvider: ChineseZhCnPinYin](https://www.nuget.org/packages/VariableKeywordMatcher.Provider.ChineseZhCnPinYin/)
[(optional)MatcherProvider: ChineseZhCnPinYinInitials](https://www.nuget.org/packages/VariableKeywordMatcher.Provider.ChineseZhCnPinYinInitials/)
[(optional)MatcherProvider: JapaneseRomaji](https://www.nuget.org/packages/VariableKeywordMatcher.Provider.JapaneseRomaji/)
### QuickStart
1. Get the names of available matchers
```C#
var availableProviderNames = VariableKeywordMatcher.Builder.GetAvailableProviderNames().ToList();
```
2. Make a list of which providers you want to use.
```C#
var enabledProviderNames = new ist();
enabledProviderNames.AddavailableProviderNames[0]);
enabledProviderNames.AddavailableProviderNames[1]);
```
3. Create the matcher(case sensitive = false)
```C#
var matcher = VariableKeywordMatcher.Builder.Build(enabledProviderNames);
```
4. Build cache for original strings
```C#
var matchCache = matcher.CreateStringCache("Hello World");
```
5. Match with the keywords
```C#
var result = matcher.Match(matchCache, new List() { "he", "wo" });
```
6. print result
```C#
if (result.IsMatchAllKeywords == true)
{
// print where should be high-light
for (int i = 0; i < result.HitFlags.Count; i++)
{
if (result.HitFlags[i] == true)
{
// highlight
Console.Write($"[{result.OriginalString[i]}]");
}
else
{
// normal
Console.Write($"{result.OriginalString[i]}");
}
Console.WriteLine();
}
}
else
{
Console.WriteLine("Not matched");
for (int i = 0; i < result.KeywordsMatchedFlags.Count; i++)
{
if (result.KeywordsMatchedFlags[i] == false)
{
Console.WriteLine($"{result.Keywords[i]} was not matched");
}
}
}
```
### Demo project [PRemoteM](https://github.com/VShawn/PRemoteM)
[](https://github.com/VShawn/PRemoteM)
## Included Components
- https://github.com/rvhuang/kmp-algorithm (MIT)
- https://github.com/toolgood/ToolGood.Words.Pinyin (MIT)
- https://github.com/Cutano/Kawazu (MIT)
- https://github.com/komutan/NMeCab (GPL 2.0 / LGPL 2.0)