Merge pull request #2427 from Flow-Launcher/double-pin

Double pinyin query

Author: jjw24

Flow.Launcher.Infrastructure/IAlphabet.cs

@@ -0,0 +1,22 @@
+namespace Flow.Launcher.Infrastructure
+{
+    /// <summary>
+    /// Translate a language to English letters using a given rule.
+    /// </summary>
+    public interface IAlphabet
+    {
+        /// <summary>
+        /// Translate a string to English letters, using a given rule.
+        /// </summary>
+        /// <param name="stringToTranslate">String to translate.</param>
+        /// <returns></returns>
+        public (string translation, TranslationMapping map) Translate(string stringToTranslate);
+
+        /// <summary>
+        /// Determine if a string should be translated to English letter with this Alphabet.
+        /// </summary>
+        /// <param name="stringToTranslate">String to translate.</param>
+        /// <returns></returns>
+        public bool ShouldTranslate(string stringToTranslate);
+    }
+}

Flow.Launcher.Infrastructure/PinyinAlphabet.cs

@@ -1,209 +1,148 @@
 using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
-using System.Linq;
+using System.Collections.ObjectModel;
+using System.IO;
 using System.Text;
-using JetBrains.Annotations;
+using System.Text.Json;
+using CommunityToolkit.Mvvm.DependencyInjection;
 using Flow.Launcher.Infrastructure.UserSettings;
 using ToolGood.Words.Pinyin;
-using CommunityToolkit.Mvvm.DependencyInjection;
+using Flow.Launcher.Infrastructure.Logger;
 
 namespace Flow.Launcher.Infrastructure
 {
-    public class TranslationMapping
+    public class PinyinAlphabet : IAlphabet
     {
-        private bool constructed;
+        private ConcurrentDictionary<string, (string translation, TranslationMapping map)> _pinyinCache =
+            new();
 
-        private List<int> originalIndexs = new List<int>();
-        private List<int> translatedIndexs = new List<int>();
-        private int translatedLength = 0;
+        private readonly Settings _settings;
 
-        public string key { get; private set; }
+        private ReadOnlyDictionary<string, string> currentDoublePinyinTable;
 
-        public void setKey(string key)
+        public PinyinAlphabet()
         {
-            this.key = key;
+            _settings = Ioc.Default.GetRequiredService<Settings>();
+            LoadDoublePinyinTable();
+
+            _settings.PropertyChanged += (sender, e) =>
+            {
+                if (e.PropertyName == nameof(Settings.UseDoublePinyin) ||
+                    e.PropertyName == nameof(Settings.DoublePinyinSchema))
+                {
+                    Reload();
+                }
+            };
         }
 
-        public void AddNewIndex(int originalIndex, int translatedIndex, int length)
+        public void Reload()
         {
-            if (constructed)
-                throw new InvalidOperationException("Mapping shouldn't be changed after constructed");
-
-            originalIndexs.Add(originalIndex);
-            translatedIndexs.Add(translatedIndex);
-            translatedIndexs.Add(translatedIndex + length);
-            translatedLength += length - 1;
+            LoadDoublePinyinTable();
+            _pinyinCache.Clear();
         }
 
-        public int MapToOriginalIndex(int translatedIndex)
+        private void CreateDoublePinyinTableFromStream(Stream jsonStream)
         {
-            if (translatedIndex > translatedIndexs.Last())
-                return translatedIndex - translatedLength - 1;
-
-            int lowerBound = 0;
-            int upperBound = originalIndexs.Count - 1;
-
-            int count = 0;
-
-            // Corner case handle
-            if (translatedIndex < translatedIndexs[0])
-                return translatedIndex;
-            if (translatedIndex > translatedIndexs.Last())
+            Dictionary<string, Dictionary<string, string>> table = JsonSerializer.Deserialize<Dictionary<string, Dictionary<string, string>>>(jsonStream);
+            string schemaKey = _settings.DoublePinyinSchema.ToString(); // Convert enum to string  
+            if (!table.TryGetValue(schemaKey, out var value))
             {
-                int indexDef = 0;
-                for (int k = 0; k < originalIndexs.Count; k++)
-                {
-                    indexDef += translatedIndexs[k * 2 + 1] - translatedIndexs[k * 2];
-                }
-
-                return translatedIndex - indexDef - 1;
+                throw new ArgumentException("DoublePinyinSchema is invalid or double pinyin table is broken.");
             }
+            currentDoublePinyinTable = new ReadOnlyDictionary<string, string>(value);
+        }
 
-            // Binary Search with Range
-            for (int i = originalIndexs.Count / 2;; count++)
+        private void LoadDoublePinyinTable()
+        {
+            if (_settings.UseDoublePinyin)
             {
-                if (translatedIndex < translatedIndexs[i * 2])
+                var tablePath = Path.Join(AppContext.BaseDirectory, "Resources", "double_pinyin.json");
+                try
                 {
-                    // move to lower middle
-                    upperBound = i;
-                    i = (i + lowerBound) / 2;
+                    using var fs = File.OpenRead(tablePath);
+                    CreateDoublePinyinTableFromStream(fs);
                 }
-                else if (translatedIndex > translatedIndexs[i * 2 + 1] - 1)
+                catch (System.Exception e)
                 {
-                    lowerBound = i;
-                    // move to upper middle
-                    // due to floor of integer division, move one up on corner case
-                    i = (i + upperBound + 1) / 2;
-                }
-                else
-                    return originalIndexs[i];
-
-                if (upperBound - lowerBound <= 1 &&
-                    translatedIndex > translatedIndexs[lowerBound * 2 + 1] &&
-                    translatedIndex < translatedIndexs[upperBound * 2])
-                {
-                    int indexDef = 0;
-
-                    for (int j = 0; j < upperBound; j++)
-                    {
-                        indexDef += translatedIndexs[j * 2 + 1] - translatedIndexs[j * 2];
-                    }
-
-                    return translatedIndex - indexDef - 1;
+                    Log.Exception(nameof(PinyinAlphabet), "Failed to load double pinyin table from file: " + tablePath, e);
+                    currentDoublePinyinTable = new ReadOnlyDictionary<string, string>(new Dictionary<string, string>());
                 }
             }
+            else
+            {
+                currentDoublePinyinTable = new ReadOnlyDictionary<string, string>(new Dictionary<string, string>());
+            }
         }
 
-        public void endConstruct()
-        {
-            if (constructed)
-                throw new InvalidOperationException("Mapping has already been constructed");
-            constructed = true;
-        }
-    }
-
-    /// <summary>
-    /// Translate a language to English letters using a given rule.
-    /// </summary>
-    public interface IAlphabet
-    {
-        /// <summary>
-        /// Translate a string to English letters, using a given rule.
-        /// </summary>
-        /// <param name="stringToTranslate">String to translate.</param>
-        /// <returns></returns>
-        public (string translation, TranslationMapping map) Translate(string stringToTranslate);
-
-        /// <summary>
-        /// Determine if a string can be translated to English letter with this Alphabet.
-        /// </summary>
-        /// <param name="stringToTranslate">String to translate.</param>
-        /// <returns></returns>
-        public bool CanBeTranslated(string stringToTranslate);
-    }
-
-    public class PinyinAlphabet : IAlphabet
-    {
-        private ConcurrentDictionary<string, (string translation, TranslationMapping map)> _pinyinCache =
-            new ConcurrentDictionary<string, (string translation, TranslationMapping map)>();
-
-        private Settings _settings;
-
-        public PinyinAlphabet()
-        {
-            Initialize(Ioc.Default.GetRequiredService<Settings>());
-        }
-
-        private void Initialize([NotNull] Settings settings)
-        {
-            _settings = settings ?? throw new ArgumentNullException(nameof(settings));
-        }
-
-        public bool CanBeTranslated(string stringToTranslate)
+        public bool ShouldTranslate(string stringToTranslate)
         {
-            return WordsHelper.HasChinese(stringToTranslate);
+            // If a string has Chinese characters, we don't need to translate it to pinyin.
+            return _settings.ShouldUsePinyin && !WordsHelper.HasChinese(stringToTranslate);
         }
 
         public (string translation, TranslationMapping map) Translate(string content)
         {
-            if (_settings.ShouldUsePinyin)
-            {
-                if (!_pinyinCache.ContainsKey(content))
-                {
-                    return BuildCacheFromContent(content);
-                }
-                else
-                {
-                    return _pinyinCache[content];
-                }
-            }
-            return (content, null);
+            if (!_settings.ShouldUsePinyin || !WordsHelper.HasChinese(content))
+                return (content, null);
+
+            return _pinyinCache.TryGetValue(content, out var value)
+                ? value
+                : BuildCacheFromContent(content);
         }
 
         private (string translation, TranslationMapping map) BuildCacheFromContent(string content)
         {
-            if (WordsHelper.HasChinese(content))
-            {
-                var resultList = WordsHelper.GetPinyinList(content);
+            var resultList = WordsHelper.GetPinyinList(content);
 
-                StringBuilder resultBuilder = new StringBuilder();
-                TranslationMapping map = new TranslationMapping();
+            var resultBuilder = new StringBuilder();
+            var map = new TranslationMapping();
 
-                bool pre = false;
+            var previousIsChinese = false;
 
-                for (int i = 0; i < resultList.Length; i++)
+            for (var i = 0; i < resultList.Length; i++)
+            {
+                if (content[i] >= 0x3400 && content[i] <= 0x9FD5)
                 {
-                    if (content[i] >= 0x3400 && content[i] <= 0x9FD5)
+                    string translated = _settings.UseDoublePinyin ? ToDoublePin(resultList[i]) : resultList[i];
+                    if (i > 0)
                     {
-                        map.AddNewIndex(i, resultBuilder.Length, resultList[i].Length + 1);
                         resultBuilder.Append(' ');
-                        resultBuilder.Append(resultList[i]);
-                        pre = true;
                     }
-                    else
+                    map.AddNewIndex(resultBuilder.Length, translated.Length);
+                    resultBuilder.Append(translated);
+                    previousIsChinese = true;
+                }
+                else
+                {
+                    if (previousIsChinese)
                     {
-                        if (pre)
-                        {
-                            pre = false;
-                            resultBuilder.Append(' ');
-                        }
-
-                        resultBuilder.Append(resultList[i]);
+                        previousIsChinese = false;
+                        resultBuilder.Append(' ');
                     }
+                    map.AddNewIndex(resultBuilder.Length, resultList[i].Length);
+                    resultBuilder.Append(resultList[i]);
                 }
+            }
 
-                map.endConstruct();
+            map.endConstruct();
 
-                var key = resultBuilder.ToString();
-                map.setKey(key);
+            var key = resultBuilder.ToString();
 
-                return _pinyinCache[content] = (key, map);
-            }
-            else
+            return _pinyinCache[content] = (key, map);
+        }
+
+        #region Double Pinyin
+
+        private string ToDoublePin(string fullPinyin)
+        {
+            if (currentDoublePinyinTable.TryGetValue(fullPinyin, out var doublePinyinValue))
             {
-                return (content, null);
+                return doublePinyinValue;
             }
+            return fullPinyin;
         }
+
+        #endregion
     }
 }

Flow.Launcher.Infrastructure/StringMatcher.cs

@@ -68,7 +68,7 @@ public MatchResult FuzzyMatch(string query, string stringToCompare, MatchOption
 
             query = query.Trim();
             TranslationMapping translationMapping = null;
-            if (_alphabet is not null && !_alphabet.CanBeTranslated(query))
+            if (_alphabet is not null && _alphabet.ShouldTranslate(query))
             {
                 // We assume that if a query can be translated (containing characters of a language, like Chinese)
                 // it actually means user doesn't want it to be translated to English letters.
@@ -228,7 +228,7 @@ public MatchResult FuzzyMatch(string query, string stringToCompare, MatchOption
             return new MatchResult(false, UserSettingSearchPrecision);
         }
 
-        private bool IsAcronym(string stringToCompare, int compareStringIndex)
+        private static bool IsAcronym(string stringToCompare, int compareStringIndex)
         {
             if (IsAcronymChar(stringToCompare, compareStringIndex) || IsAcronymNumber(stringToCompare, compareStringIndex))
                 return true;
@@ -237,7 +237,7 @@ private bool IsAcronym(string stringToCompare, int compareStringIndex)
         }
 
         // When counting acronyms, treat a set of numbers as one acronym ie. Visual 2019 as 2 acronyms instead of 5
-        private bool IsAcronymCount(string stringToCompare, int compareStringIndex)
+        private static bool IsAcronymCount(string stringToCompare, int compareStringIndex)
         {
             if (IsAcronymChar(stringToCompare, compareStringIndex))
                 return true;

Flow.Launcher.Infrastructure/TranslationMapping.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+
+namespace Flow.Launcher.Infrastructure
+{
+    public class TranslationMapping
+    {
+        private bool constructed;
+
+        // Assuming one original item maps to multi translated items  
+        // list[i] is the last translated index + 1 of original index i  
+        private readonly List<int> originalToTranslated = new();
+
+        public void AddNewIndex(int translatedIndex, int length)
+        {
+            if (constructed)
+                throw new InvalidOperationException("Mapping shouldn't be changed after constructed");
+
+            originalToTranslated.Add(translatedIndex + length);
+        }
+
+        public int MapToOriginalIndex(int translatedIndex)
+        {
+            int loc = originalToTranslated.BinarySearch(translatedIndex);
+            return loc >= 0 ? loc : ~loc;
+        }
+
+        public void endConstruct()
+        {
+            if (constructed)
+                throw new InvalidOperationException("Mapping has already been constructed");
+            constructed = true;
+        }
+    }
+}