Visual Studio Facade is now distributed using Dependency Injection

Author: loop8ack

src/ExtensionManager.UI/Attached/VSTheme.cs

@@ -1,11 +1,14 @@
+using System.Threading;
 using System.Windows;
 
-using ExtensionManager.VisualStudio;
+using ExtensionManager.VisualStudio.Themes;
 
 namespace ExtensionManager.UI.Attached;
 
 internal static class VSTheme
 {
+    private static IVSThemes? _themes;
+
     public static readonly DependencyProperty UseProperty;
 
     static VSTheme()
@@ -20,19 +23,22 @@ static VSTheme()
             });
     }
 
+    public static void Initialize(IVSThemes themes)
+        => Interlocked.Exchange(ref _themes, themes);
+
     public static void SetUse(UIElement element, bool value) => element.SetValue(UseProperty, value);
     public static bool GetUse(UIElement element) => (bool)element.GetValue(UseProperty);
 
     private static void OnUsePropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
     {
-        if (!VSFacade.IsInitialized)
+        if (_themes is not { } themes)
             return;
 
         if (d is not UIElement element)
             return;
         if (e.NewValue is not bool value)
             return;
 
-        VSFacade.Themes.Use(element, value);
+        themes.Use(element, value);
     }
 }

src/ExtensionManager.UI/DialogService.cs

@@ -10,6 +10,7 @@
 using ExtensionManager.UI.Worker;
 using ExtensionManager.VisualStudio;
 using ExtensionManager.VisualStudio.Extensions;
+using ExtensionManager.VisualStudio.Threads;
 
 using Microsoft.Win32;
 
@@ -19,15 +20,22 @@ namespace ExtensionManager.UI;
 
 internal sealed class DialogService : IDialogService
 {
+    private readonly IVSThreads _threads;
+
+    public DialogService(IVSThreads threads)
+    {
+        _threads = threads;
+    }
+
     public Task<string?> ShowSaveVsextFileDialogAsync() => ShowVsextFileDialogAsync<SaveFileDialog>();
     public Task<string?> ShowOpenVsextFileDialogAsync() => ShowVsextFileDialogAsync<OpenFileDialog>();
     private Task<string?> ShowVsextFileDialogAsync<TFileDialog>()
         where TFileDialog : FileDialog, new()
     {
-        if (VSFacade.Threads.CheckUIThreadAccess())
+        if (_threads.CheckUIThreadAccess())
             return Task.FromResult(OnUIThread());
 
-        return VSFacade.Threads.RunOnUIThreadAsync(OnUIThread);
+        return _threads.RunOnUIThreadAsync(OnUIThread);
 
         static string? OnUIThread()
         {
@@ -79,14 +87,14 @@ private async Task ShowInstallForSolutionDialogAsync(IInstallWorker worker, IMan
 
     private Task ShowInstallExportDialogAsync(object viewModel)
     {
-        if (VSFacade.Threads.CheckUIThreadAccess())
+        if (_threads.CheckUIThreadAccess())
         {
             OnUIThread(viewModel);
 
             return Task.CompletedTask;
         }
 
-        return VSFacade.Threads.RunOnUIThreadAsync(() => OnUIThread(viewModel));
+        return _threads.RunOnUIThreadAsync(() => OnUIThread(viewModel));
 
         static void OnUIThread(object viewModel)
         {

src/ExtensionManager.VisualStudio.Abstractions/ExtensionManager.VisualStudio.Abstractions.csproj

@@ -14,7 +14,6 @@
     <Compile Remove="IVisualStudioUIThread.cs" />
     <Compile Remove="IVisualStudioViewColors.cs" />
     <Compile Remove="IVisualStudioViewResourceKeys.cs" />
-    <Compile Remove="ServiceCollectionExtensions.cs" />
   </ItemGroup>
 
   <ItemGroup>

src/ExtensionManager.VisualStudio.Abstractions/IVSFacade.cs

@@ -0,0 +1,36 @@
+using ExtensionManager.VisualStudio.Documents;
+using ExtensionManager.VisualStudio.Extensions;
+using ExtensionManager.VisualStudio.MessageBox;
+using ExtensionManager.VisualStudio.Solution;
+using ExtensionManager.VisualStudio.StatusBar;
+using ExtensionManager.VisualStudio.Themes;
+using ExtensionManager.VisualStudio.Threads;
+
+namespace ExtensionManager.VisualStudio;
+
+/// <summary>
+/// This class is an abstraction around the Visual Studio API and should have the same look and feel as the Community.VisualStudio.Toolkit.VS class.
+/// </summary>
+public interface IVSFacade
+{
+    /// <summary>Contains methods for WPF to deal with Visual Studio Themes.</summary>
+    IVSThemes Themes { get; }
+
+    /// <summary> Contains methods for dealing with threads. </summary>
+    IVSThreads Threads { get; }
+
+    /// <summary> A collection of services related to solutions. </summary>
+    IVSSolutions Solutions { get; }
+
+    /// <summary> An API wrapper that makes it easy to work with the status bar. </summary>
+    IVSStatusBar StatusBar { get; }
+
+    /// <summary> Contains helper methods for dealing with documents. </summary>
+    IVSDocuments Documents { get; }
+
+    /// <summary> Shows message boxes. </summary>
+    IVSMessageBox MessageBox { get; }
+
+    /// <summary> Contains methods for dealing with Visual Studio Extensions. </summary>
+    IVSExtensions Extensions { get; }
+}

src/ExtensionManager.VisualStudio.Abstractions/IVSServiceFactory.cs

@@ -0,0 +1,20 @@
+using ExtensionManager.VisualStudio.Documents;
+using ExtensionManager.VisualStudio.Extensions;
+using ExtensionManager.VisualStudio.MessageBox;
+using ExtensionManager.VisualStudio.Solution;
+using ExtensionManager.VisualStudio.StatusBar;
+using ExtensionManager.VisualStudio.Themes;
+using ExtensionManager.VisualStudio.Threads;
+
+namespace ExtensionManager.VisualStudio;
+
+public interface IVSServiceFactory
+{
+    IVSThemes CreateThemes();
+    IVSThreads CreateThreads();
+    IVSSolutions CreateSolutions();
+    IVSStatusBar CreateStatusBar();
+    IVSDocuments CreateDocuments();
+    IVSMessageBox CreateMessageBox();
+    IVSExtensions CreateExtensions();
+}

src/ExtensionManager.VisualStudio.Abstractions/ServiceCollectionExtensions.cs

@@ -0,0 +1,21 @@
+using Microsoft.Extensions.DependencyInjection;
+
+namespace ExtensionManager.VisualStudio;
+
+public static class ServiceCollectionExtensions
+{
+    public static IServiceCollection ConfigureVSFacade(this IServiceCollection services, IVSServiceFactory serviceFactory)
+    {
+        services.AddSingleton<IVSFacade>(new VSFacade(serviceFactory));
+
+        services.AddTransient(s => s.GetRequiredService<IVSFacade>().Themes);
+        services.AddTransient(s => s.GetRequiredService<IVSFacade>().Threads);
+        services.AddTransient(s => s.GetRequiredService<IVSFacade>().Solutions);
+        services.AddTransient(s => s.GetRequiredService<IVSFacade>().StatusBar);
+        services.AddTransient(s => s.GetRequiredService<IVSFacade>().Documents);
+        services.AddTransient(s => s.GetRequiredService<IVSFacade>().MessageBox);
+        services.AddTransient(s => s.GetRequiredService<IVSFacade>().Extensions);
+
+        return services;
+    }
+}

src/ExtensionManager.VisualStudio.Abstractions/VSFacade.cs

@@ -1,6 +1,3 @@
-using System;
-using System.Threading;
-
 using ExtensionManager.VisualStudio.Documents;
 using ExtensionManager.VisualStudio.Extensions;
 using ExtensionManager.VisualStudio.MessageBox;
@@ -14,64 +11,40 @@ namespace ExtensionManager.VisualStudio;
 /// <summary>
 /// This class is an abstraction around the Visual Studio API and should have the same look and feel as the Community.VisualStudio.Toolkit.VS class.
 /// </summary>
-public abstract class VSFacade
+public sealed class VSFacade : IVSFacade
 {
-    private static VSFacade? _instance;
-    private static IVSThemes? _themes;
-    private static IVSThreads? _threads;
-    private static IVSSolutions? _solutions;
-    private static IVSStatusBar? _statusBar;
-    private static IVSDocuments? _documents;
-    private static IVSMessageBox? _messageBox;
-    private static IVSExtensions? _extensions;
-
-    /// <summary>
-    /// Indicates whether this <see cref="VSFacade"/> is initialised or not. <br/>
-    /// This should always be <see langword="true"/> at runtime and <see langword="false"/> at design time.
-    /// </summary>
-    public static bool IsInitialized => _instance is not null;
+    private readonly IVSServiceFactory _factory;
+    private IVSThemes? _themes;
+    private IVSThreads? _threads;
+    private IVSSolutions? _solutions;
+    private IVSStatusBar? _statusBar;
+    private IVSDocuments? _documents;
+    private IVSMessageBox? _messageBox;
+    private IVSExtensions? _extensions;
 
     /// <summary>Contains methods for WPF to deal with Visual Studio Themes.</summary>
-    public static IVSThemes Themes => _themes ??= Instance.CreateThemes();
+    public IVSThemes Themes => _themes ??= _factory.CreateThemes();
 
     /// <summary> Contains methods for dealing with threads. </summary>
-    public static IVSThreads Threads => _threads ??= Instance.CreateThreads();
+    public IVSThreads Threads => _threads ??= _factory.CreateThreads();
 
     /// <summary> A collection of services related to solutions. </summary>
-    public static IVSSolutions Solutions => _solutions ??= Instance.CreateSolutions();
+    public IVSSolutions Solutions => _solutions ??= _factory.CreateSolutions();
 
     /// <summary> An API wrapper that makes it easy to work with the status bar. </summary>
-    public static IVSStatusBar StatusBar => _statusBar ??= Instance.CreateStatusBar();
+    public IVSStatusBar StatusBar => _statusBar ??= _factory.CreateStatusBar();
 
     /// <summary> Contains helper methods for dealing with documents. </summary>
-    public static IVSDocuments Documents => _documents ??= Instance.CreateDocuments();
+    public IVSDocuments Documents => _documents ??= _factory.CreateDocuments();
 
     /// <summary> Shows message boxes. </summary>
-    public static IVSMessageBox MessageBox => _messageBox ??= Instance.CreateMessageBox();
+    public IVSMessageBox MessageBox => _messageBox ??= _factory.CreateMessageBox();
 
     /// <summary> Contains methods for dealing with Visual Studio Extensions. </summary>
-    public static IVSExtensions Extensions => _extensions ??= Instance.CreateExtensions();
-
-    private static VSFacade Instance
-    {
-        get => _instance ?? throw new InvalidOperationException("VS facade was not already initialized");
-    }
+    public IVSExtensions Extensions => _extensions ??= _factory.CreateExtensions();
 
-    protected static void Initialize(VSFacade instance)
+    public VSFacade(IVSServiceFactory factory)
     {
-        var oldInstance = Interlocked.CompareExchange(ref _instance, instance, null);
-
-        if (oldInstance is not null)
-            throw new InvalidOperationException("VS facade was already initialized");
+        _factory = factory;
     }
-
-    protected VSFacade() { }
-
-    protected abstract IVSThemes CreateThemes();
-    protected abstract IVSThreads CreateThreads();
-    protected abstract IVSSolutions CreateSolutions();
-    protected abstract IVSStatusBar CreateStatusBar();
-    protected abstract IVSDocuments CreateDocuments();
-    protected abstract IVSMessageBox CreateMessageBox();
-    protected abstract IVSExtensions CreateExtensions();
 }

src/ExtensionManager.VisualStudio.Shared/ExtensionManager.VisualStudio.Shared.projitems

@@ -19,6 +19,6 @@
     <Compile Include="$(MSBuildThisFileDirectory)StatusBar\VSStatusBar.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Themes\VSThemes.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)Threads\VSThreads.cs" />
-    <Compile Include="$(MSBuildThisFileDirectory)VSFacadeImplementation.cs" />
+    <Compile Include="$(MSBuildThisFileDirectory)VSServiceFactory.cs" />
   </ItemGroup>
 </Project>

src/ExtensionManager.VisualStudio.Shared/VSFacadeImplementation.cs

@@ -0,0 +1,28 @@
+using ExtensionManager.VisualStudio.Documents;
+using ExtensionManager.VisualStudio.Extensions;
+using ExtensionManager.VisualStudio.MessageBox;
+using ExtensionManager.VisualStudio.Solution;
+using ExtensionManager.VisualStudio.StatusBar;
+using ExtensionManager.VisualStudio.Themes;
+using ExtensionManager.VisualStudio.Threads;
+
+#if V15
+namespace ExtensionManager.VisualStudio.V15;
+#elif V16
+namespace ExtensionManager.VisualStudio.V16;
+#elif V17_5
+namespace ExtensionManager.VisualStudio.V17_5;
+#elif V17_7
+namespace ExtensionManager.VisualStudio.V17_7;
+#endif
+
+public sealed class VSServiceFactory : IVSServiceFactory
+{
+    public IVSThemes CreateThemes() => new VSThemes();
+    public IVSThreads CreateThreads() => new VSThreads();
+    public IVSSolutions CreateSolutions() => new VSSolutions();
+    public IVSStatusBar CreateStatusBar() => new VSStatusBar();
+    public IVSDocuments CreateDocuments() => new VSDocuments();
+    public IVSMessageBox CreateMessageBox() => new VSMessageBox();
+    public IVSExtensions CreateExtensions() => new VSExtensions();
+}