Cancel build facilities

* Cancel build before saving a project item. This fix trying to save a read only file being compiled.
* Added the possibility to double click the icon to cancel current background compilation.

Author: GuillaumeTz

BuildOnSave/BuildOnSave.cs

@@ -35,7 +35,8 @@ sealed class BuildOnSave
 		readonly DocumentEvents _documentEvents;
 		readonly BuildEvents _buildEvents;
 		readonly CommandEvents _buildSolutionEvent;
-
+		readonly CommandEvents _saveCommandEvent;
+		readonly CommandEvents _saveAsCommandEvent;
 
 		// state
 		SolutionOptions _solutionOptions;
@@ -49,7 +50,8 @@ public BuildOnSave(DTE dte, OleMenuCommandService commandService)
 			_buildEvents = _events.BuildEvents;
 			var guid = typeof(VSConstants.VSStd97CmdID).GUID.ToString("B");
 			_buildSolutionEvent = _dte.Events.CommandEvents[guid, (int)VSConstants.VSStd97CmdID.BuildSln];
-
+			_saveCommandEvent = _dte.Events.CommandEvents[guid, (int)VSConstants.VSStd97CmdID.SaveProjectItem];
+			_saveAsCommandEvent = _dte.Events.CommandEvents[guid, (int)VSConstants.VSStd97CmdID.SaveProjectItemAs];
 
 			_topMenu = new MenuCommand(delegate { }, 
 					new CommandID(CommandSet, TopMenuCommandId));
@@ -180,6 +182,10 @@ void connectDriver(SolutionOptions options)
 			_buildSolutionEvent.BeforeExecute += driver.onBeforeBuildSolutionCommand;
 			_buildSolutionEvent.AfterExecute += driver.onAfterBuildSolutionCommand;
 
+			// Cancel background build link to following commands
+			_saveCommandEvent.BeforeExecute += driver.onBeforeSaveCommand;
+			_saveAsCommandEvent.BeforeExecute += driver.onBeforeSaveAsCommand;
+
 			_driver_ = driver;
 
 			Log.D("driver connected");
@@ -199,6 +205,10 @@ void disconnectDriver()
 			_buildSolutionEvent.BeforeExecute -= driver.onBeforeBuildSolutionCommand;
 			_buildSolutionEvent.AfterExecute -= driver.onAfterBuildSolutionCommand;
 
+			// Cancel background build link to following commands
+			_saveCommandEvent.BeforeExecute -= driver.onBeforeSaveCommand;
+			_saveAsCommandEvent.BeforeExecute -= driver.onBeforeSaveAsCommand;
+
 			_driver_.Dispose();
 			_driver_ = null;
 

BuildOnSave/Driver.cs

@@ -35,6 +35,10 @@ public Driver(DTE dte, SolutionOptions options, BackgroundBuild2 backgroundBuild
 			_options = options;
 			_backgroundBuild = backgroundBuild;
 			_ui = ui;
+			_ui._onIconDoubleClick += () => {
+				cancelBackgroundBuild();
+			};
+
 			_context = SynchronizationContext.Current;
 		}
 
@@ -74,16 +78,26 @@ public void onBuildBegin(vsBuildScope scope, vsBuildAction action)
 			dumpState();
 			Log.D("VS build begin {scope}, {action}", scope, action);
 
-			prepareForVSBuild();
+			cancelBackgroundBuild();
 		}
 
-		void prepareForVSBuild()
+		public void onBeforeSaveCommand(string guid, int id, object customIn, object customOut, ref bool cancelDefault)
 		{
-			// immediately reflect in the UI that we are not wanted anymore!
-			_ui.setBuildStatus(BuildStatus.Indeterminate);
+			cancelBackgroundBuild();
+		}
 
+		public void onBeforeSaveAsCommand(string guid, int id, object customIn, object customOut, ref bool cancelDefault)
+		{
+			cancelBackgroundBuild();
+		}
+
+		void cancelBackgroundBuild()
+		{
 			_buildAgain = false;
 			_backgroundBuild.cancelAndWait();
+
+			// immediately reflect in the UI that we are not wanted anymore!
+			_ui.setBuildStatus(BuildStatus.Indeterminate);
 		}
 
 		public void onBuildDone(vsBuildScope scope, vsBuildAction action)

BuildOnSave/DriverUI.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Drawing;
 using System.Windows.Forms;
 using EnvDTE;
@@ -30,6 +30,10 @@ sealed class DriverUI : IDisposable
 		BuildStatus _status = BuildStatus.Indeterminate;
 		bool _processing;
 
+		DateTime _lastCLickTime;
+		public delegate void OnIconDoubleClick();
+		public OnIconDoubleClick _onIconDoubleClick;
+
 		const string BarButtonControlCaption = "BuildOnSave Status";
 
 		public DriverUI(DTE dte, Window outputWindow, OutputWindowPane pane)
@@ -52,8 +56,17 @@ public DriverUI(DTE dte, Window outputWindow, OutputWindowPane pane)
 				control.BeginGroup = true;
 				control.Click += (CommandBarButton ctrl, ref bool d) =>
 				{
+					TimeSpan ts = DateTime.Now - _lastCLickTime;
+					_lastCLickTime = DateTime.Now;
+
+					if (ts.TotalMilliseconds < 500)
+					{
+						//consider double click => cancel current build if any
+						_onIconDoubleClick();
+					}
+
 					_outputWindow.Visible = true;
-					pane.Activate();
+					_pane.Activate();
 				};
 			}
 			else

BuildOnSave/source.extension.vsixmanifest

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="BuildOnSave.Armin Sander.31ad4701-38ab-4dfa-9173-256d95ffed3d" Version="0.35.1" Language="en-US" Publisher="Armin Sander" />
+        <Identity Id="BuildOnSave.Armin Sander.31ad4701-38ab-4dfa-9173-256d95ffed3d" Version="0.35.2" Language="en-US" Publisher="Armin Sander" />
         <DisplayName>BuildOnSave</DisplayName>
         <Description xml:space="preserve">Builds your solution when a file is saved.</Description>
         <License>LICENSE.txt</License>

README.md

@@ -10,7 +10,7 @@ BuildOnSave is an extension for Visual Studio 2017 and 2019 that builds the curr
 
 - There is a menu named BuildOnSave in the Visual Studio menu bar with options to disable BuildOnSave and to specify what exactly should be built. Options are stored per solution.
 - A "BuildOnSave" pane is shown as soon a build starts. 
-- An icon is added to the Standard toolbar that shows the build status for background builds. **red** for build failed, **yellow** to show that the build is indeterminate, and **green** means the build succeeded. If the icon shows an outline instead of a filled circle, the build process is active. Clicking the icon opens the BuildOnSave pane.
+- An icon is added to the Standard toolbar that shows the build status for background builds. **red** for build failed, **yellow** to show that the build is indeterminate, and **green** means the build succeeded. If the icon shows an outline instead of a filled circle, the build process is active. Clicking the icon opens the BuildOnSave pane. Double clicking the icon cancel the current background build.
 
 ### Options