添加"异步完成模式"选项，用于启用新的异步完成逻辑;

Author: stratosblue

README.md

@@ -1,9 +1,8 @@
-# ChinesePinyinIntelliSenseExtender
+# ChinesePinyinIntelliSenseExtender
 
-VisualStudio中文代码拼音补全拓展。
+VisualStudio表意文字补全拓展(汉语拼音、五笔等)。
 
-- 仅在 `C#` 和 `F#` 下进行了测试，理论上支持所有基于 `IAsyncCompletionSource` 的完成。
-- 支持自定义字符映射。
+- 支持自定义字符映射，可支持任意表意文字的表音补全。
 
 View at [VisualStudio Marketplace](https://marketplace.visualstudio.com/items?itemName=stratos.ChinesePinyinIntelliSenseExtender)
 

src/ChinesePinyinIntelliSenseExtender.csproj

@@ -70,6 +70,7 @@
     </Compile>
     <Compile Include="Options\Model\DictionaryManageOptions.cs" />
     <Compile Include="Options\Model\Options.cs" />
+    <Compile Include="Options\Model\AsyncCompletionMode.cs" />
     <Compile Include="Options\Model\StringPreCheckRule.cs" />
     <Compile Include="Options\Model\PreMatchType.cs" />
     <Compile Include="Options\DictionaryManagePage.cs">
@@ -114,6 +115,7 @@
     <Compile Include="Util\CompletionSetSelectBestMatchHelper.cs" />
     <Compile Include="Util\EnumerableExtend.cs" />
     <Compile Include="Util\InputTextMatchHelper.cs" />
+    <Compile Include="Internal\IPreCheckPredicate.cs" />
     <Compile Include="Util\StringPreMatchUtil.cs" />
     <Compile Include="Util\InputMethodDictionaryLoader.cs" />
     <Compile Include="Intellisense\AsyncCompletion\IdeographAsyncCompletionSource.cs" />

src/Intellisense/AsyncCompletion/IdeographAsyncCompletionItemManager.cs

@@ -12,44 +12,33 @@
 
 namespace ChinesePinyinIntelliSenseExtender.Intellisense.AsyncCompletion;
 
-internal class IdeographAsyncCompletionItemManager(IPatternMatcherFactory _patternMatcherFactory) : IAsyncCompletionItemManager
+internal class IdeographAsyncCompletionItemManager(GeneralOptions options, IPatternMatcherFactory patternMatcherFactory) : IAsyncCompletionItemManager
 {
-    //private void write(TimeSpan t, string msg = "", [CallerMemberName] string n = "")
-    //{
-    //    using var s = File.AppendText("D:\\time.txt");
-    //    s.WriteLine($"[{DateTime.Now.Ticks / TimeSpan.TicksPerMillisecond}] {n}: {t.TotalMilliseconds}ms ({msg})");
-    //}
+    #region Private 字段
 
-    private InputMethodDictionaryGroup? _inputMethodDictionaryGroup;
+    /// <summary>
+    /// 匹配缓存，当前没有移除？可能需要处理
+    /// </summary>
     private readonly ConcurrentDictionary<(PreMatchType, StringPreCheckRule, string), string> _filterTextCache = [];
-    private GeneralOptions? _options;
 
-    private async Task<InputMethodDictionaryGroup> GetInputMethodDictionaryGroupAsync()
-    {
-        if (_inputMethodDictionaryGroup is null
-            || _inputMethodDictionaryGroup.IsDisposed)
-        {
-            _inputMethodDictionaryGroup = await InputMethodDictionaryGroupProvider.GetAsync();
-        }
-        return _inputMethodDictionaryGroup;
-    }
+    private readonly GeneralOptions _options = options ?? throw new ArgumentNullException(nameof(options));
 
-    private static IReadOnlyList<CompletionItem> SortCompletionItem(IReadOnlyList<CompletionItem> items)
-    {
-        bool CheckShouldSort()
-        {
-            return !(Parallel.For(1, items.Count, (i, p) =>
-            {
-                if (items[i - 1].SortText.CompareTo(items[i].SortText) > 0) p.Stop();
-            }).IsCompleted);
-        }
+    private readonly IPatternMatcherFactory _patternMatcherFactory = patternMatcherFactory ?? throw new ArgumentNullException(nameof(patternMatcherFactory));
 
-        if (CheckShouldSort()) { return items.AsParallel().OrderBy(i => i.SortText).ToArray(); }
-        return items;
-    }
+    private InputMethodDictionaryGroup? _inputMethodDictionaryGroup;
+
+    #endregion Private 字段
+
+    #region Public 方法
 
     public Task<ImmutableArray<CompletionItem>> SortCompletionListAsync(IAsyncCompletionSession session, AsyncCompletionSessionInitialDataSnapshot data, CancellationToken token)
     {
+        if (!_options.Enable
+            || _options.AsyncCompletionMode != AsyncCompletionMode.Experimental)
+        {
+            return Task.FromResult<ImmutableArray<CompletionItem>>(default);
+        }
+
         //var st = ValueStopwatch.StartNew();
         var sortedItems = SortCompletionItem(data.InitialList).ToImmutableArray();
         //var t = st.Elapsed;
@@ -59,6 +48,12 @@ public Task<ImmutableArray<CompletionItem>> SortCompletionListAsync(IAsyncComple
 
     public async Task<FilteredCompletionModel> UpdateCompletionListAsync(IAsyncCompletionSession session, AsyncCompletionSessionDataSnapshot data, CancellationToken token)
     {
+        if (!_options.Enable
+            || _options.AsyncCompletionMode != AsyncCompletionMode.Experimental)
+        {
+            return default!;
+        }
+
         //var st = ValueStopwatch.StartNew();
         //TimeSpan t;
 
@@ -83,7 +78,6 @@ public async Task<FilteredCompletionModel> UpdateCompletionListAsync(IAsyncCompl
             return new FilteredCompletionModel(listHighlighted, 0, data.SelectedFilters);
         }
 
-        _options ??= await GeneralOptions.GetLiveInstanceAsync();
         var shouldProcessChecker = StringPreMatchUtil.GetPreCheckPredicate(_options.PreMatchType, _options.PreCheckRule);
         var inputMethodDictionaryGroup = await GetInputMethodDictionaryGroupAsync();
 
@@ -187,9 +181,17 @@ string AddToCacheAndReturn(string v)
         return new FilteredCompletionModel(listWithHighlights, selectedItemIndex, updatedFilters);
     }
 
-    private static bool ShouldBeInCompletionList(
-        CompletionItem item,
-        ImmutableArray<CompletionFilterWithState> filtersWithState)
+    #endregion Public 方法
+
+    #region Private 方法
+
+    //private void write(TimeSpan t, string msg = "", [CallerMemberName] string n = "")
+    //{
+    //    using var s = File.AppendText("D:\\time.txt");
+    //    s.WriteLine($"[{DateTime.Now.Ticks / TimeSpan.TicksPerMillisecond}] {n}: {t.TotalMilliseconds}ms ({msg})");
+    //}
+
+    private static bool ShouldBeInCompletionList(CompletionItem item, ImmutableArray<CompletionFilterWithState> filtersWithState)
     {
         foreach (var filterWithState in filtersWithState.Where(n => n.IsSelected))
         {
@@ -200,4 +202,30 @@ private static bool ShouldBeInCompletionList(
         }
         return false;
     }
+
+    private static IReadOnlyList<CompletionItem> SortCompletionItem(IReadOnlyList<CompletionItem> items)
+    {
+        bool CheckShouldSort()
+        {
+            return !(Parallel.For(1, items.Count, (i, p) =>
+            {
+                if (items[i - 1].SortText.CompareTo(items[i].SortText) > 0) p.Stop();
+            }).IsCompleted);
+        }
+
+        if (CheckShouldSort()) { return items.AsParallel().OrderBy(i => i.SortText).ToArray(); }
+        return items;
+    }
+
+    private async Task<InputMethodDictionaryGroup> GetInputMethodDictionaryGroupAsync()
+    {
+        if (_inputMethodDictionaryGroup is null
+            || _inputMethodDictionaryGroup.IsDisposed)
+        {
+            _inputMethodDictionaryGroup = await InputMethodDictionaryGroupProvider.GetAsync();
+        }
+        return _inputMethodDictionaryGroup;
+    }
+
+    #endregion Private 方法
 }

src/Intellisense/AsyncCompletion/IdeographAsyncCompletionItemManagerProvider.cs

@@ -1,6 +1,8 @@
 #nullable enable
 
 using System.ComponentModel.Composition;
+using System.Threading;
+using ChinesePinyinIntelliSenseExtender.Options;
 using Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion;
 using Microsoft.VisualStudio.Text.Editor;
 using Microsoft.VisualStudio.Text.PatternMatching;
@@ -17,10 +19,59 @@ namespace ChinesePinyinIntelliSenseExtender.Intellisense.AsyncCompletion;
 [method: ImportingConstructor]
 internal class IdeographAsyncCompletionItemManagerProvider(IPatternMatcherFactory patternMatcherFactory) : IAsyncCompletionItemManagerProvider
 {
+    #region Private 字段
+
+    /// <summary>
+    /// 递归标记
+    /// </summary>
+    private static readonly AsyncLocal<bool> s_completionItemManagerProviderRecursionTag = new();
+
     private static IdeographAsyncCompletionItemManager? s_instance;
 
+    [ImportMany]
+    private readonly Lazy<IAsyncCompletionItemManagerProvider>[] _lazyIAsyncCompletionItemManagerProviders = null!;
+
+    private readonly IPatternMatcherFactory _patternMatcherFactory = patternMatcherFactory ?? throw new ArgumentNullException(nameof(patternMatcherFactory));
+
+    #endregion Private 字段
+
+    #region Public 方法
+
     public IAsyncCompletionItemManager GetOrCreate(ITextView textView)
     {
-        return s_instance ??= new IdeographAsyncCompletionItemManager(patternMatcherFactory);
+        if (s_completionItemManagerProviderRecursionTag.Value)
+        {
+            return null!;
+        }
+
+        var options = GeneralOptions.Instance;
+
+        //非实验模式不使用 IdeographAsyncCompletionItemManager
+        if (!options.Enable
+            || options.AsyncCompletionMode != AsyncCompletionMode.Experimental)
+        {
+            try
+            {
+                s_completionItemManagerProviderRecursionTag.Value = true;
+
+                foreach (var provider in _lazyIAsyncCompletionItemManagerProviders)
+                {
+                    if (provider.Value.GetOrCreate(textView) is IAsyncCompletionItemManager asyncCompletionItemManager)
+                    {
+                        return asyncCompletionItemManager;
+                    }
+                }
+                //返回null应该是没问题的
+                return null!;
+            }
+            finally
+            {
+                s_completionItemManagerProviderRecursionTag.Value = false;
+            }
+        }
+
+        return s_instance ??= new IdeographAsyncCompletionItemManager(options, _patternMatcherFactory);
     }
+
+    #endregion Public 方法
 }

src/Intellisense/AsyncCompletion/IdeographAsyncCompletionSource.cs

@@ -4,7 +4,7 @@
 using System.Collections.Immutable;
 using System.Diagnostics;
 using System.Threading;
-
+using ChinesePinyinIntelliSenseExtender.Internal;
 using ChinesePinyinIntelliSenseExtender.Options;
 using ChinesePinyinIntelliSenseExtender.Util;
 
@@ -43,11 +43,12 @@ public IdeographAsyncCompletionSource(IEnumerable<IAsyncCompletionSource> otherA
     public async Task<CompletionContext?> GetCompletionContextAsync(IAsyncCompletionSession session, CompletionTrigger trigger, SnapshotPoint triggerLocation, SnapshotSpan applicableToSpan, CancellationToken token)
     {
         if (s_completionContextRecursionTag.Value
-            || !Options.Enable)
+            || !Options.Enable
+            || Options.AsyncCompletionMode != AsyncCompletionMode.Default)
         {
             return null;
         }
-        
+
         try
         {
             s_completionContextRecursionTag.Value = true;

src/Intellisense/AsyncCompletion/IdeographAsyncCompletionSourceProvider.cs

@@ -3,16 +3,18 @@
 using System.ComponentModel.Composition;
 using System.Diagnostics;
 using System.Threading;
+using ChinesePinyinIntelliSenseExtender.Options;
 using Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion;
 using Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data;
 using Microsoft.VisualStudio.Text;
 using Microsoft.VisualStudio.Text.Editor;
+using Microsoft.VisualStudio.Utilities;
 
 namespace ChinesePinyinIntelliSenseExtender.Intellisense.AsyncCompletion;
 
-//[Export(typeof(IAsyncCompletionSourceProvider))]
-//[Name("表意文字表音补全")]
-//[ContentType("text")]
+[Export(typeof(IAsyncCompletionSourceProvider))]
+[Name("表意文字表音补全")]
+[ContentType("text")]
 internal class IdeographAsyncCompletionSourceProvider : CompletionSourceProviderBase<ITextView, IAsyncCompletionSource>, IAsyncCompletionSourceProvider
 {
     #region Private 字段
@@ -35,6 +37,13 @@ public IAsyncCompletionSource GetOrCreate(ITextView textView)
 
     protected override IAsyncCompletionSource CreateCompletionSource(ITextView dependence)
     {
+        //实验模式时不使用 IdeographAsyncCompletionSource
+        if (!Options.Enable
+            || Options.AsyncCompletionMode == AsyncCompletionMode.Experimental)
+        {
+            return EmptyAsyncCompletionSource.Instance;
+        }
+
         var currentContentType = dependence.TextBuffer.ContentType;
 
         var otherAsyncCompletionSources = _lazyAsyncCompletionSourceProviders

src/Intellisense/CompletionSourceProviderBase.cs

@@ -5,7 +5,6 @@
 using System.Reflection;
 using System.Runtime.CompilerServices;
 using System.Threading;
-using ChinesePinyinIntelliSenseExtender.Intellisense.AsyncCompletion;
 using ChinesePinyinIntelliSenseExtender.Intellisense.SyncCompletion;
 using ChinesePinyinIntelliSenseExtender.Options;
 using Microsoft.VisualStudio.Utilities;

src/Intellisense/SyncCompletion/IdeographCompletionCommandHandler.cs

@@ -47,11 +47,9 @@ internal IdeographCompletionCommandHandler(IVsTextView textViewAdapter, ITextVie
     public int Exec(ref Guid pguidCmdGroup, uint nCmdID, uint nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut)
     {
         //see https://learn.microsoft.com/zh-cn/visualstudio/extensibility/walkthrough-displaying-statement-completion?view=vs-2022&tabs=csharp#tabpanel_19_csharp
-        
+
         if (VsShellUtilities.IsInAutomationFunction(_serviceProvider)
-            || !_options.EnableSyncCompletionSupport
-            // 跳过 C#/F#，防止输入卡顿
-            || _textView.TextBuffer.ContentType.BaseTypes.Any(i => i.TypeName == "Roslyn Languages"))
+            || !_options.EnableSyncCompletionSupport)
         {
             return _nextCommandHandler.Exec(ref pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut);
         }

src/Intellisense/SyncCompletion/IdeographCompletionHandlerProvider.cs

@@ -40,9 +40,17 @@ public void VsTextViewCreated(IVsTextView textViewAdapter)
 
         var options = GeneralOptions.Instance;
 
-        if (options.EnableSyncCompletionSupport)
+        if (options.Enable
+            && options.EnableSyncCompletionSupport)
         {
-            textView.Properties.GetOrCreateSingletonProperty(() => new IdeographCompletionCommandHandler(textViewAdapter, textView, CompletionBroker, ServiceProvider, options));
+            //RoslynLanguages 都为异步完成
+            //此处可以进一步缓存与完善异步完成的类型
+            //前置检查，理论上 ContentType 不会在编辑过程中改变？
+            var isRoslynLanguagesBase = textView.TextBuffer.ContentType.BaseTypes.Any(i => i.TypeName == "Roslyn Languages");
+            if (!isRoslynLanguagesBase) //异步完成不需要此逻辑，跳过 CommandHandler 处理
+            {
+                textView.Properties.GetOrCreateSingletonProperty(() => new IdeographCompletionCommandHandler(textViewAdapter, textView, CompletionBroker, ServiceProvider, options));
+            }
         }
     }
 

src/Internal/IPreCheckPredicate.cs

@@ -0,0 +1,10 @@
+namespace ChinesePinyinIntelliSenseExtender.Internal;
+
+internal interface IPreCheckPredicate
+{
+    #region Public 方法
+
+    bool Check(string value);
+
+    #endregion Public 方法
+}