Merge pull request #314 from jamesc-skyward/Debugger

Added IsDebuggingAsync() and GetDebugModeAsync() methods

Author: madskristensen

src/toolkit/Community.VisualStudio.Toolkit.Shared/Debugger/Debugger.cs

@@ -0,0 +1,53 @@
+using System;
+using System.Threading.Tasks;
+using Microsoft.VisualStudio.Shell;
+using Microsoft.VisualStudio.Shell.Interop;
+
+namespace Community.VisualStudio.Toolkit
+{
+    /// <summary>
+    /// Handles debugging.
+    /// </summary>
+    public class Debugger
+    {
+        /// <summary>
+        /// The mode of the debugger.
+        /// </summary>
+        public enum DebugMode
+        {
+            /// <summary>The debugger is not attached.</summary>
+            NotDebugging,
+            /// <summary>The debugger is stopped at a breakpoint.</summary>
+            AtBreakpoint,
+            /// <summary>The debugger is attached and running.</summary>
+            Running
+        }
+
+        /// <summary>
+        /// Checks if the debugger is attached.
+        /// </summary>
+        public async Task<bool> IsDebuggingAsync()
+        {
+            DebugMode debugMode = await GetDebugModeAsync();
+            return debugMode != DebugMode.NotDebugging;
+        }
+
+        /// <summary>
+        /// Returns the current mode for the debugger.
+        /// </summary>
+        public async Task<DebugMode> GetDebugModeAsync()
+        {
+            await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
+
+            DBGMODE dbgMode = VsShellUtilities.GetDebugMode(ServiceProvider.GlobalProvider) & ~DBGMODE.DBGMODE_EncMask;
+
+            return dbgMode switch
+            {
+                DBGMODE.DBGMODE_Design => DebugMode.NotDebugging,
+                DBGMODE.DBGMODE_Break => DebugMode.AtBreakpoint,
+                DBGMODE.DBGMODE_Run => DebugMode.Running,
+                _ => throw new InvalidOperationException($"Unexpected {nameof(DebugMode)}")
+            };
+        }
+    }
+}

src/toolkit/Community.VisualStudio.Toolkit.Shared/VS.cs

@@ -21,6 +21,10 @@ public static class VS
         /// <summary>A collection of services related to the command system.</summary>
         public static Commands Commands => _commands ??= new();
 
+        private static Debugger? _debugger;
+        /// <summary>A collection of services related to the debugger.</summary>
+        public static Debugger Debugger => _debugger ??= new();
+
         private static Documents? _documents;
         /// <summary>Contains helper methods for dealing with documents.</summary>
         public static Documents Documents => _documents ??= new();

src/toolkit/Community.VisualStudio.Toolkit.Shared/VSSDK.Helpers.Shared.projitems

@@ -9,6 +9,7 @@
     <Import_RootNamespace>Community.VisualStudio.Toolkit.Shared</Import_RootNamespace>
   </PropertyGroup>
   <ItemGroup>
+    <Compile Include="$(MSBuildThisFileDirectory)Debugger\Debugger.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)\Attributes\ProvideBraceCompletionAttribute.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)\Attributes\ProvideFileIconAttribute.cs" />
     <Compile Include="$(MSBuildThisFileDirectory)\Attributes\ProvideGalleryFeedAttribute.cs" />