Merge remote-tracking branch 'remotes/community-origin/master'

Author: RobertvanderHulst

README.md

@@ -78,20 +78,22 @@ catch (Exception ex)
 }
 ```
 
+### Dependency Injection
+To incorporate a DI container into your extension, see the complimentary project: [
+Community.VisualStudio.Toolkit.DependencyInjection](https://github.com/VsixCommunity/Community.VisualStudio.Toolkit.DependencyInjection)
+
 ## Purpose
 This package attempts to solve multiple issues with the current extensibility model.
 
 ### Too much boilerplate is needed to do simple things
 Base classes, helper methods, and extension methods encapsulate the complexity so you don't have to. 
 
 ### It's difficult to find what services and components to use
-Now the most commmon services are all easy to get to from the main `VS` object.
-
+Now the most common services are all easy to get to from the main `VS` object.
 
 ### Best practices change with each version of VS. I can't keep up
 The underlying implementation of the project uses the best practices for each version of VS it supports. This ensures that your extension is much more likely to handle threading correctly, and avoid hangs and crashes.
 
-
 ### The API is dated and has lots of ugly COM legacy noise
 The most common APIs of the old complex COM nature are wrapped to expose a modern async API. This makes it much easier to code against the API and you can avoid the `EnvDTE` object for most scenarios.
 

src/toolkit/Community.VisualStudio.Toolkit.Shared/ExtensionMethods/IVsTextViewExtensions.cs

@@ -26,7 +26,7 @@ public static class IVsTextViewExtensions
         /// Converts an <see cref="IVsTextView"/> to a <see cref="DocumentView"/>.
         /// </summary>
         /// <returns><see langword="null"/> if the textView is null or the conversion failed.</returns>
-        internal static DocumentView ToDocumentView(this IVsTextView textView)
+        public static DocumentView ToDocumentView(this IVsTextView textView)
         {
             if (textView == null || textView is not IVsTextViewEx nativeView)
             {
@@ -62,7 +62,7 @@ internal static DocumentView ToDocumentView(this IVsTextView textView)
         /// Converts an <see cref="IWpfTextView"/> to a <see cref="DocumentView"/>.
         /// </summary>
         /// <returns><see langword="null"/> if the textView is null or the conversion failed.</returns>
-        internal static DocumentView ToDocumentView(this IWpfTextView textView)
+        public static DocumentView ToDocumentView(this IWpfTextView textView)
         {
             ThreadHelper.ThrowIfNotOnUIThread();
             IVsTextView? nativeView = textView.ToIVsTextView();
@@ -89,7 +89,7 @@ internal static DocumentView ToDocumentView(this IWpfTextView textView)
         /// Converts the <see cref="IVsTextView"/> to an <see cref="IWpfTextView"/>/
         /// </summary>
         /// <returns></returns>
-        internal static IWpfTextView? ToIWpfTextView(this IVsTextView nativeView)
+        public static IWpfTextView? ToIWpfTextView(this IVsTextView nativeView)
         {
             ThreadHelper.ThrowIfNotOnUIThread();
             IVsEditorAdaptersFactoryService? editorAdapter = VS.GetMefService<IVsEditorAdaptersFactoryService>();
@@ -110,7 +110,7 @@ internal static DocumentView ToDocumentView(this IWpfTextView textView)
         /// Converts the <see cref="IVsTextView"/> to an <see cref="IWpfTextView"/>/
         /// </summary>
         /// <returns></returns>
-        internal static IVsTextView? ToIVsTextView(this IWpfTextView view)
+        public static IVsTextView? ToIVsTextView(this IWpfTextView view)
         {
             ThreadHelper.ThrowIfNotOnUIThread();
             IVsEditorAdaptersFactoryService? editorAdapter = VS.GetMefService<IVsEditorAdaptersFactoryService>();

src/toolkit/Community.VisualStudio.Toolkit.Shared/ExtensionMethods/TaskExtensions.cs

@@ -41,5 +41,24 @@ public static void FireAndForget(this JoinableTask joinableTask, bool logOnFailu
         {
             FireAndForget(joinableTask.Task, logOnFailure);
         }
+
+        /// <summary>
+        /// Schedules a delegate for background execution on the UI thread without inheriting any claim to the UI thread from its caller.
+        /// </summary>
+        /// <remarks>
+        /// StartOnIdle is a included in later versions of the SDK, but this shim is to add support to VS 14+
+        /// </remarks>
+        public static JoinableTask StartOnIdleShim(this JoinableTaskFactory joinableTaskFactory, Action action, VsTaskRunContext priority = VsTaskRunContext.UIThreadBackgroundPriority)
+        {
+            using (joinableTaskFactory.Context.SuppressRelevance())
+            {
+                return joinableTaskFactory.RunAsync(priority, async delegate
+                {
+                    await System.Threading.Tasks.Task.Yield();
+                    await joinableTaskFactory.SwitchToMainThreadAsync();
+                    action();
+                });
+            }
+        }
     }
 }

src/toolkit/Community.VisualStudio.Toolkit.Shared/LanguageService/DefaultAuthoringScope.cs

@@ -53,6 +53,13 @@ public LanguageBase(object site)
             _languageServiceId = GetType().GUID;
         }
 
+        /// <inheritdoc/>
+        public override int GetLanguageName(out string name)
+        {
+            name = Name;
+            return VSConstants.S_OK;
+        }
+
         /// <inheritdoc/>
         public abstract override string Name { get; }
 
@@ -61,18 +68,6 @@ public LanguageBase(object site)
         /// </summary>
         public abstract string[] FileExtensions { get; }
 
-        /// <inheritdoc/>
-        public override Source CreateSource(IVsTextLines buffer)
-        {
-            return new DefaultSource(this, buffer, new DefaultColorizer(this, buffer, null));
-        }
-
-        /// <inheritdoc/>
-        public override TypeAndMemberDropdownBars CreateDropDownHelper(IVsTextView forView)
-        {
-            return base.CreateDropDownHelper(forView);
-        }
-
         /// <summary>
         /// Set the default preferences for this language.
         /// </summary>
@@ -92,21 +87,14 @@ public override LanguagePreferences GetLanguagePreferences()
         }
 
         /// <inheritdoc/>
-        public override IScanner GetScanner(IVsTextLines buffer)
-        {
-            return null!;
-        }
+        public override IScanner GetScanner(IVsTextLines buffer) => null!;
 
         /// <inheritdoc/>
-        public override AuthoringScope ParseSource(ParseRequest req)
-        {
-            return new DefaultAuthoringScope();
-        }
+        public override AuthoringScope ParseSource(ParseRequest req) => null!;
 
         /// <inheritdoc/>
         public override string GetFormatFilterList()
         {
-            // Constructs a string similar to: Foo File (*.foo, *.bar)|*.foo;*.bar";
             IEnumerable<string> normalized = FileExtensions.Select(f => $"*{f}");
             string first = string.Join(", ", normalized);
             string second = string.Join(";", normalized);

src/toolkit/Community.VisualStudio.Toolkit.Shared/LanguageService/DefaultColorizer.cs

@@ -7,7 +7,6 @@
 using Microsoft.VisualStudio.Text.Editor;
 using Microsoft.VisualStudio.Text.Operations;
 using Microsoft.VisualStudio.Text.Tagging;
-using Microsoft.VisualStudio.Threading;
 
 namespace Community.VisualStudio.Toolkit
 {
@@ -108,7 +107,7 @@ private void UpdateAtCaretPosition(CaretPosition caretPosition)
 
             if (word.HasValue && word.Value.IsSignificant && word.Value.Span.Length > 1)
             {
-                StartOnIdle(ThreadHelper.JoinableTaskFactory, () =>
+                ThreadHelper.JoinableTaskFactory.StartOnIdleShim(() =>
                 {
                     UpdateWordAdornments(word.Value);
                 }, VsTaskRunContext.UIThreadIdlePriority).FireAndForget();
@@ -201,20 +200,6 @@ public IEnumerable<ITagSpan<HighlightWordTag>> GetTags(NormalizedSnapshotSpanCol
             }
         }
 
-        //Schedules a delegate for background execution on the UI thread without inheriting any claim to the UI thread from its caller.
-        private static JoinableTask StartOnIdle(JoinableTaskFactory joinableTaskFactory, Action action, VsTaskRunContext priority = VsTaskRunContext.UIThreadBackgroundPriority)
-        {
-            using (joinableTaskFactory.Context.SuppressRelevance())
-            {
-                return joinableTaskFactory.RunAsync(priority, async delegate
-                {
-                    await System.Threading.Tasks.Task.Yield();
-                    await joinableTaskFactory.SwitchToMainThreadAsync();
-                    action();
-                });
-            }
-        }
-
         public void Dispose()
         {
             if (!_isDisposed)

src/toolkit/Community.VisualStudio.Toolkit.Shared/LanguageService/DefaultSource.cs

@@ -59,7 +59,7 @@ public override IEnumerable<ITagSpan<IErrorTag>> GetTags(NormalizedSnapshotSpanC
             }
         }
 
-        private static string GetErrorType(IList<ErrorListItem> errors)
+        private static string GetErrorType(IEnumerable<ErrorListItem> errors)
         {
             return errors.FirstOrDefault()?.ErrorCategory ?? PredefinedErrorTypeNames.SyntaxError;
         }

src/toolkit/Community.VisualStudio.Toolkit.Shared/LanguageService/LanguageBase.cs

@@ -32,7 +32,7 @@ public override IEnumerable<ITagSpan<IStructureTag>> GetTags(NormalizedSnapshotS
         {
             foreach (IMappingTagSpan<TokenTag> tag in Tags!.GetTags(spans))
             {
-                if (!tag.Tag.SupportOutlining || tag.Tag.GetOutliningText == null)
+                if (tag.Tag.GetOutliningText == null)
                 {
                     continue;
                 }