Use AsyncPackage instead of Package

awulkiew · awulkiew · commit e417ad0070c2 · 2023-06-30T01:08:28.000+02:00
diff --git a/solution/GraphicalDebugging/Debugger.cs b/solution/GraphicalDebugging/Debugger.cs
@@ -1,8 +1,5 @@
 ﻿using EnvDTE;
-using Microsoft.VisualStudio.Debugger.ComponentInterfaces;
-using System;
-using System.Windows.Forms;
-using static GraphicalDebugging.MemoryReader;
+using Microsoft.VisualStudio.Shell;
 
 namespace GraphicalDebugging
 {
diff --git a/solution/GraphicalDebugging/ExpressionLoader.cs b/solution/GraphicalDebugging/ExpressionLoader.cs
@@ -9,10 +9,8 @@
 using Microsoft.VisualStudio.Shell;
 
 using System;
-using System.Collections;
 using System.Collections.Generic;
-using System.Globalization;
-using System.Threading;
+using System.Threading.Tasks;
 
 namespace GraphicalDebugging
 {
@@ -57,11 +55,13 @@ public static bool IsBreakMode
         }
 
         private static ExpressionLoader Instance { get; set; }
-        
-        public static void Initialize(GraphicalDebuggingPackage package)
+
+        public static async Task InitializeAsync(GraphicalDebuggingPackage package)
         {
-            DTE2 dte = package.GetService(typeof(DTE)) as DTE2;
-            
+            DTE2 dte = await package.GetServiceAsync(typeof(DTE)) as DTE2;
+
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(package.DisposalToken);
+
             Instance = new ExpressionLoader(dte);
         }
 
diff --git a/solution/GraphicalDebugging/GeometryWatchCommand.cs b/solution/GraphicalDebugging/GeometryWatchCommand.cs
@@ -31,30 +31,23 @@ internal sealed class GeometryWatchCommand
         /// <summary>
         /// VS Package that provides this command, not null.
         /// </summary>
-        private readonly Package package;
+        private readonly AsyncPackage package;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="GeometryWatchCommand"/> class.
         /// Adds our command handlers for menu (commands must exist in the command table file)
         /// </summary>
         /// <param name="package">Owner package, not null.</param>
-        private GeometryWatchCommand(Package package, OleMenuCommandService commandService)
+        private GeometryWatchCommand(AsyncPackage package, OleMenuCommandService commandService)
         {
             ThreadHelper.ThrowIfNotOnUIThread();
 
-            if (package == null)
-            {
-                throw new ArgumentNullException("package");
-            }
+            this.package = package ?? throw new ArgumentNullException(nameof(package));
+            commandService = commandService ?? throw new ArgumentNullException(nameof(commandService));
 
-            this.package = package;
-            
-            if (commandService != null)
-            {
-                var menuCommandID = new CommandID(CommandSet, CommandId);
-                var menuItem = new MenuCommand(this.ShowToolWindow, menuCommandID);
-                commandService.AddCommand(menuItem);
-            }
+            var menuCommandID = new CommandID(CommandSet, CommandId);
+            var menuItem = new MenuCommand(this.ShowToolWindow, menuCommandID);
+            commandService.AddCommand(menuItem);
         }
 
         /// <summary>
@@ -69,7 +62,7 @@ public static GeometryWatchCommand Instance
         /// <summary>
         /// Gets the service provider from the owner package.
         /// </summary>
-        private IServiceProvider ServiceProvider
+        private IAsyncServiceProvider ServiceProvider
         {
             get
             {
@@ -81,10 +74,12 @@ private IServiceProvider ServiceProvider
         /// Initializes the singleton instance of the command.
         /// </summary>
         /// <param name="package">Owner package, not null.</param>
-        public static void Initialize(GraphicalDebuggingPackage package)
+        public static async Task InitializeAsync(GraphicalDebuggingPackage package)
         {
-            OleMenuCommandService commandService = package.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
-            
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(package.DisposalToken);
+
+            OleMenuCommandService commandService = await package.GetServiceAsync(typeof(IMenuCommandService)) as OleMenuCommandService;
+
             Instance = new GeometryWatchCommand(package, commandService);
         }
 
diff --git a/solution/GraphicalDebugging/GraphicalDebuggingPackage.cs b/solution/GraphicalDebugging/GraphicalDebuggingPackage.cs
@@ -30,7 +30,7 @@ namespace GraphicalDebugging
     /// To get loaded into VS, the package must be referred by &lt;Asset Type="Microsoft.VisualStudio.VsPackage" ...&gt; in .vsixmanifest file.
     /// </para>
     /// </remarks>
-    [PackageRegistration(UseManagedResourcesOnly = true)]
+    [PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]
     [InstalledProductRegistration("#110", "#112", "1.0", IconResourceID = 400)] // Info on this package for Help/About
     [ProvideMenuResource("Menus.ctmenu", 1)]
     [Guid(GraphicalDebuggingPackage.PackageGuidString)]
@@ -42,7 +42,7 @@ namespace GraphicalDebugging
     [ProvideOptionPage(typeof(GeometryWatchOptionPage), "Graphical Debugging", "Geometry Watch", 0, 0, true)]
     [ProvideOptionPage(typeof(GraphicalWatchOptionPage), "Graphical Debugging", "Graphical Watch", 0, 0, true)]
     [ProvideOptionPage(typeof(PlotWatchOptionPage), "Graphical Debugging", "Plot Watch", 0, 0, true)]
-    public sealed class GraphicalDebuggingPackage : Package
+    public sealed class GraphicalDebuggingPackage : AsyncPackage
     {
         /// <summary>
         /// GraphicalDebuggingPackage GUID string.
@@ -71,22 +71,19 @@ public GraphicalDebuggingPackage()
         /// Initialization of the package; this method is called right after the package is sited, so this is the place
         /// where you can put all the initialization code that rely on services provided by VisualStudio.
         /// </summary>
-        protected override void Initialize()
+        protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
         {
-            Instance = this;
+            // When initialized asynchronously, the current thread may be a background thread at this point.
+            // Do any initialization that requires the UI thread after switching to the UI thread.
+            await this.JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
 
-            base.Initialize();
+            Instance = this;
 
-            ExpressionLoader.Initialize(this);
+            await ExpressionLoader.InitializeAsync(this);
 
-            GeometryWatchCommand.Initialize(this);
-            GraphicalWatchCommand.Initialize(this);
-            PlotWatchCommand.Initialize(this);
-        }
-
-        public new object GetService(Type serviceType)
-        {
-            return base.GetService(serviceType);
+            await GeometryWatchCommand.InitializeAsync(this);
+            await GraphicalWatchCommand.InitializeAsync(this);
+            await PlotWatchCommand.InitializeAsync(this);
         }
 
         public new DialogPage GetDialogPage(Type dialogPageType)
diff --git a/solution/GraphicalDebugging/GraphicalWatchCommand.cs b/solution/GraphicalDebugging/GraphicalWatchCommand.cs
@@ -31,30 +31,23 @@ internal sealed class GraphicalWatchCommand
         /// <summary>
         /// VS Package that provides this command, not null.
         /// </summary>
-        private readonly Package package;
+        private readonly AsyncPackage package;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="GraphicalWatchCommand"/> class.
         /// Adds our command handlers for menu (commands must exist in the command table file)
         /// </summary>
         /// <param name="package">Owner package, not null.</param>
-        private GraphicalWatchCommand(Package package, OleMenuCommandService commandService)
+        private GraphicalWatchCommand(AsyncPackage package, OleMenuCommandService commandService)
         {
             ThreadHelper.ThrowIfNotOnUIThread();
 
-            if (package == null)
-            {
-                throw new ArgumentNullException("package");
-            }
-
-            this.package = package;
+            this.package = package ?? throw new ArgumentNullException(nameof(package));
+            commandService = commandService ?? throw new ArgumentNullException(nameof(commandService));
 
-            if (commandService != null)
-            {
-                var menuCommandID = new CommandID(CommandSet, CommandId);
-                var menuItem = new MenuCommand(this.ShowToolWindow, menuCommandID);
-                commandService.AddCommand(menuItem);
-            }
+            var menuCommandID = new CommandID(CommandSet, CommandId);
+            var menuItem = new MenuCommand(this.ShowToolWindow, menuCommandID);
+            commandService.AddCommand(menuItem);
         }
 
         /// <summary>
@@ -69,7 +62,7 @@ public static GraphicalWatchCommand Instance
         /// <summary>
         /// Gets the service provider from the owner package.
         /// </summary>
-        private IServiceProvider ServiceProvider
+        private IAsyncServiceProvider ServiceProvider
         {
             get
             {
@@ -81,9 +74,11 @@ private IServiceProvider ServiceProvider
         /// Initializes the singleton instance of the command.
         /// </summary>
         /// <param name="package">Owner package, not null.</param>
-        public static void Initialize(GraphicalDebuggingPackage package)
+        public static async Task InitializeAsync(GraphicalDebuggingPackage package)
         {
-            OleMenuCommandService commandService = package.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(package.DisposalToken);
+
+            OleMenuCommandService commandService = await package.GetServiceAsync(typeof(IMenuCommandService)) as OleMenuCommandService;
             
             Instance = new GraphicalWatchCommand(package, commandService);
         }
diff --git a/solution/GraphicalDebugging/PlotWatchCommand.cs b/solution/GraphicalDebugging/PlotWatchCommand.cs
@@ -31,30 +31,23 @@ internal sealed class PlotWatchCommand
         /// <summary>
         /// VS Package that provides this command, not null.
         /// </summary>
-        private readonly Package package;
+        private readonly AsyncPackage package;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="PlotWatchCommand"/> class.
         /// Adds our command handlers for menu (commands must exist in the command table file)
         /// </summary>
         /// <param name="package">Owner package, not null.</param>
-        private PlotWatchCommand(Package package, OleMenuCommandService commandService)
+        private PlotWatchCommand(AsyncPackage package, OleMenuCommandService commandService)
         {
             ThreadHelper.ThrowIfNotOnUIThread();
 
-            if (package == null)
-            {
-                throw new ArgumentNullException("package");
-            }
-
-            this.package = package;
+            this.package = package ?? throw new ArgumentNullException(nameof(package));
+            commandService = commandService ?? throw new ArgumentNullException(nameof(commandService));
 
-            if (commandService != null)
-            {
-                var menuCommandID = new CommandID(CommandSet, CommandId);
-                var menuItem = new MenuCommand(this.ShowToolWindow, menuCommandID);
-                commandService.AddCommand(menuItem);
-            }
+            var menuCommandID = new CommandID(CommandSet, CommandId);
+            var menuItem = new MenuCommand(this.ShowToolWindow, menuCommandID);
+            commandService.AddCommand(menuItem);
         }
 
         /// <summary>
@@ -69,7 +62,7 @@ public static PlotWatchCommand Instance
         /// <summary>
         /// Gets the service provider from the owner package.
         /// </summary>
-        private IServiceProvider ServiceProvider
+        private IAsyncServiceProvider ServiceProvider
         {
             get
             {
@@ -81,9 +74,11 @@ private IServiceProvider ServiceProvider
         /// Initializes the singleton instance of the command.
         /// </summary>
         /// <param name="package">Owner package, not null.</param>
-        public static void Initialize(GraphicalDebuggingPackage package)
+        public static async Task InitializeAsync(GraphicalDebuggingPackage package)
         {
-            OleMenuCommandService commandService = package.GetService(typeof(IMenuCommandService)) as OleMenuCommandService;
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(package.DisposalToken);
+
+            OleMenuCommandService commandService = await package.GetServiceAsync(typeof(IMenuCommandService)) as OleMenuCommandService;
             
             Instance = new PlotWatchCommand(package, commandService);
         }
diff --git a/solution/GraphicalDebugging/Util.cs b/solution/GraphicalDebugging/Util.cs
@@ -19,9 +19,7 @@
 using System.Windows.Interop;
 using System.Windows.Media;
 using System.Windows.Media.Imaging;
-using System.Threading;
-using Task = System.Threading.Tasks.Task;
-using Microsoft.VisualStudio.OLE.Interop;
+
 
 namespace GraphicalDebugging
 {
@@ -240,9 +238,11 @@ public static string Tparam(string type, int index)
                  : "";
         }
 
-        public static void ShowWindow<WatchWindow>(Package package, string name)
+        public static void ShowWindow<WatchWindow>(AsyncPackage package, string name)
             where WatchWindow : ToolWindowPane
         {
+            ThreadHelper.ThrowIfNotOnUIThread();
+
             for (int i = 0; i < 10; ++i)
             {
                 ToolWindowPane window = package.FindToolWindow(typeof(WatchWindow), i, false);

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,5 @@`
`1`	`1`	`using EnvDTE;`
`2`		`-using Microsoft.VisualStudio.Debugger.ComponentInterfaces;`
`3`		`-using System;`
`4`		`-using System.Windows.Forms;`
`5`		`-using static GraphicalDebugging.MemoryReader;`
	`2`	`+using Microsoft.VisualStudio.Shell;`
`6`	`3`
`7`	`4`	`namespace GraphicalDebugging`
`8`	`5`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,7 @@`
`19`	`19`	`using System.Windows.Interop;`
`20`	`20`	`using System.Windows.Media;`
`21`	`21`	`using System.Windows.Media.Imaging;`
`22`		`-using System.Threading;`
`23`		`-using Task = System.Threading.Tasks.Task;`
`24`		`-using Microsoft.VisualStudio.OLE.Interop;`
	`22`	`+`
`25`	`23`
`26`	`24`	`namespace GraphicalDebugging`
`27`	`25`	`{`
`@@ -240,9 +238,11 @@ public static string Tparam(string type, int index)`
`240`	`238`	`: "";`
`241`	`239`	`}`
`242`	`240`
`243`		`- public static void ShowWindow<WatchWindow>(Package package, string name)`
	`241`	`+ public static void ShowWindow<WatchWindow>(AsyncPackage package, string name)`
`244`	`242`	`where WatchWindow : ToolWindowPane`
`245`	`243`	`{`
	`244`	`+ ThreadHelper.ThrowIfNotOnUIThread();`
	`245`	`+`
`246`	`246`	`for (int i = 0; i < 10; ++i)`
`247`	`247`	`{`
`248`	`248`	`ToolWindowPane window = package.FindToolWindow(typeof(WatchWindow), i, false);`