Try avoid moving windows when removing/adding monitors (#824)

When Windows removes/adds monitors, it will helpfully move windows to/from monitors. However, Whim is a window manager and we'd like to control this behavior.

To work around Windows' helpfulness, the `WindowManager` and `ButlerEventHandlers` ignore all Windows events for tracked windows. This has the downside of potentially missing a window closing, but I've judged that it's more important to keep windows in the correct workspaces.

Other changes include:

- Removing an ineffectual lock
- Updating some calls to obsolete methods
- Another attempt at avoiding `AccessViolationException` in the `Bar`

docs/docs/getting-started/comparison.md

@@ -48,7 +48,7 @@ Whim is the only window manager which is capable of both dynamic and manual mana
 
 [Repository](https://github.com/fuhsjr00/bug.n) | [Documentation](https://github.com/fuhsjr00/bug.n/wiki)
 
-bug.n is an interesting idea, especiallly for users who already use AutoHotKey. Unfortunately, bug.n is no longer actively developed or maintained.
+bug.n is an interesting idea, especially for users who already use AutoHotKey. Unfortunately, bug.n is no longer actively developed or maintained.
 
 ## FancyWM
 

docs/docs/getting-started/troubleshooting.md

@@ -15,3 +15,11 @@ Examples of troublesome windows include Firefox and JetBrains Gateway.
 Windows can launch windows in different locations. Additionally, interacting with some untracked windows like the Windows Taskbar can break focus tracking in Whim.
 
 To counteract this, the <xref:Whim.IRouterManager> has a <xref:Whim.IRouterManager.RouterOptions> property which can configure how new windows are routed - see the <xref:Whim.RouterOptions> enum.
+
+## Adding/removing monitors
+
+When adding and removing monitors, Windows will very helpfully move windows between monitors. However, this conflicts with Whim. To work around Windows' helpfulness, Whim (in the `WindowManager` and `ButlerEventHandlers` will) ignore [`WinEvents`](../architecture/events.md) for 3 seconds for tracked windows. After the 3 seconds have elapsed, Whim will layout all the active workspaces.
+
+## Window overflows given area
+
+Whim will request windows to have a specific size, but some windows (like Spotify) enforce a minimum size and will ignore Whim's instructions. Whim does not account for this. As a result, these stubborn windows will overflow the expected area. This will also result in the [focus indicator](../plugins/focus-indicator.md) highlighting the expected area, not the window's actual area.

src/Whim.Bar.Tests/BarPluginTests.cs

@@ -1,3 +1,4 @@
+using Microsoft.UI.Dispatching;
 using NSubstitute;
 using Whim.TestUtils;
 using Xunit;
@@ -12,6 +13,7 @@ public void MonitorManager_MonitorsChanged_RemovedMonitors(IContext context, IMo
 		// Given
 		BarConfig barConfig = new(new List<BarComponent>(), new List<BarComponent>(), new List<BarComponent>());
 		BarPlugin barPlugin = new(context, barConfig);
+		NativeManagerUtils.SetupTryEnqueue(context);
 
 		// When MonitorManager_MonitorsChanged is called with a removed monitor which is not in the map
 		barPlugin.PreInitialize();
@@ -26,5 +28,6 @@ public void MonitorManager_MonitorsChanged_RemovedMonitors(IContext context, IMo
 
 		// Then an exception is not thrown.
 		barPlugin.Dispose();
+		context.NativeManager.Received(1).TryEnqueue(Arg.Any<DispatcherQueueHandler>());
 	}
 }

src/Whim.Bar/BarPlugin.cs

@@ -56,14 +56,7 @@ private void MonitorManager_MonitorsChanged(object? sender, MonitorsChangedEvent
 		foreach (IMonitor monitor in e.RemovedMonitors)
 		{
 			_monitorBarMap.TryGetValue(monitor, out BarWindow? value);
-			try
-			{
-				value?.Close();
-			}
-			catch (AccessViolationException ex)
-			{
-				Logger.Error($"Failed to close bar window for monitor {monitor} due to {ex}");
-			}
+			_context.NativeManager.TryEnqueue(() => value?.Close());
 			_monitorBarMap.Remove(monitor);
 		}
 

src/Whim.TestUtils/NativeManagerUtils.cs

@@ -0,0 +1,17 @@
+using Microsoft.UI.Dispatching;
+using NSubstitute;
+
+namespace Whim.TestUtils;
+
+public static class NativeManagerUtils
+{
+	public static void SetupTryEnqueue(IContext ctx)
+	{
+		ctx.NativeManager.When(cnm => cnm.TryEnqueue(Arg.Any<DispatcherQueueHandler>()))
+			.Do(callInfo =>
+			{
+				DispatcherQueueHandler handler = callInfo.ArgAt<DispatcherQueueHandler>(0);
+				handler.Invoke();
+			});
+	}
+}