Skip to content

Full async query model #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harrynull merged 2 commits into from
Feb 6, 2021
Merged

Full async query model #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f46105a
Full async query model
taooceros Feb 5, 2021
fedc738
fix an mismatched query
taooceros Feb 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Dictionary.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,12 @@
<Reference Include="System.Speech" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Flow.Launcher.Plugin" Version="1.2.0" />
<PackageReference Include="Flow.Launcher.Plugin" Version="1.4.0" />
<PackageReference Include="symspell" Version="6.7.0" />
<PackageReference Include="System.ComponentModel.Annotations" Version="4.7.0" />
<PackageReference Include="System.Data.SQLite" Version="1.0.106.0" />
<PackageReference Include="System.Data.SQLite.Core" Version="1.0.106.0" />
<PackageReference Include="System.Linq.Async" Version="5.0.0" />
</ItemGroup>
<ItemGroup>
<Compile Remove="src\Downloader.cs" />
Expand Down
126 changes: 78 additions & 48 deletions src/Dictionary.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
using Newtonsoft.Json;
using System;
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Runtime.InteropServices;
//using System.Speech.Synthesis;
using System.Text;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using Flow.Launcher.Plugin;

namespace Dictionary
{
public class Main : IPlugin, ISettingProvider, IResultUpdated
public class Main : IAsyncPlugin, ISettingProvider, IResultUpdated
{
private ECDict ecdict;
private WordCorrection wordCorrection;
private Synonyms synonyms;
private Iciba iciba;
private PluginInitContext context;
internal static PluginInitContext Context { get; private set; }
private Settings settings;
//private SpeechSynthesizer synth;

Expand All @@ -35,7 +37,7 @@ public Control CreateSettingPanel()
return new DictionarySettings(settings);
}

public void Init(PluginInitContext context)
public async Task InitAsync(PluginInitContext context)
{
string CurrentPath = context.CurrentPluginMetadata.PluginDirectory;

Expand All @@ -44,7 +46,7 @@ public void Init(PluginInitContext context)

string ConfigFile = CurrentPath + "/config/config.json";
if (File.Exists(ConfigFile))
settings = JsonConvert.DeserializeObject<Settings>(File.ReadAllText(ConfigFile));
settings = await JsonSerializer.DeserializeAsync<Settings>(File.OpenRead(ConfigFile)).ConfigureAwait(false);
else
settings = new Settings();
settings.ConfigFile = ConfigFile;
Expand All @@ -53,7 +55,7 @@ public void Init(PluginInitContext context)
wordCorrection = new WordCorrection(CurrentPath + "/dicts/frequency_dictionary_en_82_765.txt", settings.MaxEditDistance);
synonyms = new Synonyms(settings.BighugelabsToken);
iciba = new Iciba(settings.ICIBAToken);
this.context = context;
Context = context;
}

Result MakeResultItem(string title, string subtitle, string extraAction = null, string word = null)
Expand All @@ -69,7 +71,7 @@ bool CopyIfNeeded(ActionContext e)
}
catch (ExternalException ee)
{
context.API.ShowMsg("Copy failed, please try later", ee.Message);
Context.API.ShowMsg("Copy failed, please try later", ee.Message);
}
return true;
}
Expand All @@ -96,7 +98,7 @@ bool ReadWordIfNeeded(ActionContext e)
{
if (CopyIfNeeded(e)) return true;
//if (ReadWordIfNeeded(e)) return false;
context.API.ChangeQuery(ActionWord + " " + (word ?? QueryWord) + extraAction);
Context.API.ChangeQuery(ActionWord + " " + (word ?? QueryWord) + extraAction);
return false;
};
}
Expand Down Expand Up @@ -124,38 +126,70 @@ private Result MakeWordResult(Word word) =>
(settings.ShowEnglishDefinition ? word.definition.Replace("\n", "; ") : word.translation.Replace("\n", "; ")),
"!", word.word);

private class WordEqualityComparer : IEqualityComparer<Result>
{
public static WordEqualityComparer instance = new WordEqualityComparer();

public bool Equals([AllowNull] Result x, [AllowNull] Result y)
{
if (x.Equals(y))
return true;
else
return x.Title == y.Title;

}

public int GetHashCode([DisallowNull] Result obj)
{
return obj.Title.GetHashCode();
}
}

// First-level query.
// English -> Chinese, supports fuzzy search.
private List<Result> FirstLevelQuery(Query query)
private async Task<List<Result>> FirstLevelQueryAsync(Query query, CancellationToken token)
{
string queryWord = query.Search;
IEnumerable<Word> results = Enumerable.Empty<Word>();
HashSet<Result> results = new HashSet<Result>(WordEqualityComparer.instance);

// Pull fully match first.
Word fullMatch = ecdict.Query(query.Search);
Word fullMatch = await ecdict.QueryAsync(query.Search, token).ConfigureAwait(false);
if (fullMatch != null)
results = results.Append(fullMatch);
results.Add(MakeWordResult(fullMatch));

token.ThrowIfCancellationRequested();
ResultsUpdated?.Invoke(this, new ResultUpdatedEventArgs { Results = results.ToList(), Query = query });

// Then fuzzy search results. (since it's usually only a few)
List<SymSpell.SuggestItem> suggestions = wordCorrection.Correct(queryWord);
token.ThrowIfCancellationRequested();

return results.Concat(ecdict.QueryRange(suggestions))
.Concat(ecdict.QueryBeginningWith(queryWord))
.Distinct()
.Select(w => MakeWordResult(w))
.ToList();
await foreach (var word in ecdict.QueryRange(suggestions.Select(x => x.term), token).Select(w => MakeWordResult(w)).ConfigureAwait(false))
{
results.Add(word);
}

token.ThrowIfCancellationRequested();
ResultsUpdated?.Invoke(this, new ResultUpdatedEventArgs { Results = results.ToList(), Query = query });

await foreach (var word in ecdict.QueryBeginningWith(queryWord, token).Select(w => MakeWordResult(w)).ConfigureAwait(false))
{
results.Add(word);
}

return results.ToList();
}

// Detailed information of a word.
// English -> Phonetic, Translation, Definition, Exchanges, Synonym
// Fuzzy search disabled.
private List<Result> DetailedQuery(Query query)
private async Task<List<Result>> DetailedQueryAsync(Query query, CancellationToken token)
{
string queryWord = query.Search[0..^1]; // Remove the !

List<Result> results = new List<Result>();

var word = ecdict.Query(queryWord);
var word = await ecdict.QueryAsync(queryWord, token).ConfigureAwait(false);

if (word.phonetic != "")
results.Add(MakeResultItem(word.phonetic, "Phonetic"));
Expand All @@ -166,13 +200,14 @@ private List<Result> DetailedQuery(Query query)
if (word.exchange != "")
results.Add(MakeResultItem("Exchanges", word.exchange, "e"));

token.ThrowIfCancellationRequested();
ResultsUpdated?.Invoke(this, new ResultUpdatedEventArgs
{
Query = query,
Results = results
});

var synonymsResult = string.Join("; ", synonyms.Query(word.word));
var synonymsResult = string.Join("; ", await synonyms.QueryAsync(word.word, token).ConfigureAwait(false));
if (synonymsResult != "")
results.Add(MakeResultItem("Synonym", synonymsResult, "s"));

Expand All @@ -183,13 +218,13 @@ private List<Result> DetailedQuery(Query query)
// Translations of a word.
// English -> Translations
// Fuzzy search disabled.
private List<Result> TranslationQuery(Query query)
private async Task<List<Result>> TranslationQueryAsync(Query query, CancellationToken token)
{
string queryWord = query.Search[0..^2]; // Get the word

List<Result> results = new List<Result>();

var word = ecdict.Query(queryWord);
var word = await ecdict.QueryAsync(queryWord, token).ConfigureAwait(false);

foreach (var translation in word.translation.Split('\n'))
{
Expand All @@ -202,13 +237,13 @@ private List<Result> TranslationQuery(Query query)
// Definitions of a word.
// English -> Definitions
// Fuzzy search disabled.
private List<Result> DefinitionQuery(Query query)
private async Task<List<Result>> DefinitionQueryAsync(Query query, CancellationToken token)
{
string queryWord = query.Search[0..^2]; // Get the word

List<Result> results = new List<Result>();

var word = ecdict.Query(queryWord);
var word = await ecdict.QueryAsync(queryWord, token).ConfigureAwait(false);

foreach (var definition in word.definition.Split('\n'))
{
Expand All @@ -221,13 +256,13 @@ private List<Result> DefinitionQuery(Query query)
// Exchanges of a word.
// English -> Exchanges
// Fuzzy search disabled.
private List<Result> ExchangeQuery(Query query)
private async Task<List<Result>> ExchangeQueryAsync(Query query, CancellationToken token)
{
string queryWord = query.Search[0..^2]; // Get the word

List<Result> results = new List<Result>();

var word = ecdict.Query(queryWord);
var word = await ecdict.QueryAsync(queryWord, token);

foreach (var exchange in word.exchange.Split('/'))
{
Expand All @@ -241,33 +276,28 @@ private List<Result> ExchangeQuery(Query query)
// English -> Synonyms
// Fuzzy search disabled.
// Internet access needed.
private List<Result> SynonymQuery(Query query)
private async Task<List<Result>> SynonymQueryAsync(Query query, CancellationToken token)
{
string queryWord = query.Search[0..^2]; // Get the word

List<Result> results = new List<Result>();

var syns = synonyms.Query(queryWord);

foreach (var syn in syns)
{
results.Add(MakeWordResult(ecdict.Query(syn)));
}
var syns = await synonyms.QueryAsync(queryWord, token).ConfigureAwait(false);

return results;
return await ecdict.QueryRange(syns, token).Select(w => MakeWordResult(w)).ToListAsync(token);
}

// Chinese translation of a word.
// English -> Synonyms
// Fuzzy search disabled.
// Internet access needed.
private List<Result> ChineseQuery(Query query)
private async Task<List<Result>> ChineseQueryAsync(Query query, CancellationToken token)
{
string queryWord = query.Search; // Get the word

List<Result> results = new List<Result>();

var translations = iciba.Query(queryWord);
var translations = await iciba.QueryAsync(queryWord, token).ConfigureAwait(false);

if (translations.Count == 0)
{
Expand Down Expand Up @@ -295,26 +325,26 @@ private bool IsChinese(string cn)
return false;
}

public List<Result> Query(Query query)
public async Task<List<Result>> QueryAsync(Query query, CancellationToken token)
{
ActionWord = query.ActionKeyword;
string queryWord = query.Search;
if (queryWord == "") return new List<Result>();
QueryWord = queryWord;

if (queryWord.Length < 2)
return FirstLevelQuery(query);
return await FirstLevelQueryAsync(query, token).ConfigureAwait(false);

return queryWord[^2..] switch
return await (queryWord[^2..] switch
{
"!d" => DefinitionQuery(query),
"!t" => TranslationQuery(query),
"!e" => ExchangeQuery(query),
"!s" => SynonymQuery(query),
_ when queryWord[^1] == '!' => DetailedQuery(query),
_ when IsChinese(queryWord) => ChineseQuery(query),
_ => FirstLevelQuery(query)
};
"!d" => DefinitionQueryAsync(query, token),
"!t" => TranslationQueryAsync(query, token),
"!e" => ExchangeQueryAsync(query, token),
"!s" => SynonymQueryAsync(query, token),
_ when queryWord[^1] == '!' => DetailedQueryAsync(query, token),
_ when IsChinese(queryWord) => ChineseQueryAsync(query, token),
_ => FirstLevelQueryAsync(query, token)
}).ConfigureAwait(false);
}
}
}
Loading