[PT Run] WindowWalker: Refactor code, fix some bugs, hide UWP non-windows, prepare code for new features

.github/actions/spell-check/expect.txt

@@ -723,6 +723,7 @@ HOLDESC
 homepage
 homljgmgpmcbpjbnjpfijnhipfkiclkd
 HOOKPROC
+Hostbackdropbrush
 hostname
 hotkeycontrol
 hotkeys

doc/devdocs/modules/launcher/plugins/windowwalker.md

@@ -3,16 +3,19 @@ The window walker plugin matches the user entered query with the open windows on
 
 ![Image of Window Walker plugin](/doc/images/launcher/plugins/windowwalker.png)
 
-### [`OpenWindows.cs`](src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/OpenWindows.cs)
-- The window walker plugin uses the `EnumWindows` function to enumerate all the open windows in the [`OpenWindows.cs`](src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/OpenWindows.cs) class.
+### [`OpenWindows.cs`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/OpenWindows.cs)
+- The window walker plugin uses the `EnumWindows` function to enumerate all the open windows in the [`OpenWindows.cs`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/OpenWindows.cs) class.
 
+### [`SearchController.cs`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/SearchController.cs)
+- The [`SearchController`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/SearchController.cs) encapsulates the functions needed to search and find matches.
+- It is responsible for updating the search text and performing a fuzzy search on all the open windows.
 
-### [`SearchController.cs`](src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/SearchController.cs)
-- The [`SearchController`](src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/SearchController.cs) encapsulates the functions needed to search and find matches.
-- It is responsible for updating the search text and performing a fuzzy search on all the open windows in an asynchronous manner.
+### [`Window.cs`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/Window.cs)
+- The [`Window`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/Window.cs) class represents a specific window and has functions to get the name of the window, the state of the window (whether it is visible or not), and the `SwitchTowindow` function which switches the desktop focus to the selected window. This action is performed when the user clicks on a window walker plugin result.
+- The `Window` class holds a static cache with the process information of all windows we know so far and each window instance has a property which holds its process information (name, file, ...). The process data in the cache and the window property are of the type `WindowProcess`.
 
-### [`Window.cs`](src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/Window.cs)
-- The [`Window`](src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/Window.cs) class represents a specific window and has functions to get the name of the process, the state of the window (whether it is visible or not), and the `SwitchTowindow` function which switches the desktop focus to the selected window. This action is performed when the user clicks on a window walker plugin result.
+### [`WindowProcess.cs`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/WindowProcess.cs)
+- The [`WindowProcess`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/WindowProcess.cs) class represents a specific process for a window. It contains static methods to query process information from the system. And it contains instance methods and properties to hold/retrieve the process information we want to know about a window's process.
 
 ### Score
-The window walker plugin uses [`FuzzyMatching`](src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/FuzzyMatching.cs) to get the matching indices and calculates the score by creating a 2 dimensional array of the window and the query text.
+The window walker plugin uses [`FuzzyMatching`](/src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/FuzzyMatching.cs) to get the matching indices and calculates the score by creating a 2 dimensional array of the window and the query text.

src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/NativeMethods.cs

@@ -249,7 +249,7 @@ public enum DwmNCRenderingPolicy
         }
 
         /// <summary>
-        /// Window attribute
+        /// DWM window attribute (Windows 7 and earlier: The values between ExcludedFromPeek and Last aren't supported.)
         /// </summary>
         [Flags]
         public enum DwmWindowAttribute
@@ -266,9 +266,32 @@ public enum DwmWindowAttribute
             HasIconicBitmap,
             DisallowPeek,
             ExcludedFromPeek,
+            Cloak,
+            Cloaked,
+            FreezeRepresentation,
+            PassiveUpdateMode,
+            UseHostbackdropbrush,
+            UseImmersiveDarkMode,
+            WindowCornerPreference,
+            BorderColor,
+            CaptionColor,
+            TextColor,
+            VisibleFrameBorderThickness,
             Last,
         }
 
+        /// <summary>
+        /// Flags for describing the window cloak state (Windows 7 and earlier: This value is not supported.)
+        /// </summary>
+        [Flags]
+        public enum DwmWindowCloakState
+        {
+            None = 0,
+            CloakedApp = 1,
+            CloakedShell = 2,
+            CloakedInherited = 4,
+        }
+
         /// <summary>
         /// Flags for accessing the process in trying to get icon for the process
         /// </summary>
@@ -869,7 +892,7 @@ public enum ExtendedWindowStyles : uint
         [DllImport("user32.dll", SetLastError = true, BestFitMapping = false)]
         public static extern IntPtr GetProp(IntPtr hWnd, string lpString);
 
-        [DllImport("kernel32.dll")]
+        [DllImport("kernel32.dll", SetLastError = true)]
         public static extern IntPtr OpenProcess(ProcessAccessFlags dwDesiredAccess, [MarshalAs(UnmanagedType.Bool)] bool bInheritHandle, int dwProcessId);
 
         [DllImport("dwmapi.dll", EntryPoint = "#113", CallingConvention = CallingConvention.StdCall)]
@@ -890,5 +913,37 @@ public enum ExtendedWindowStyles : uint
 
         [DllImport("user32.dll")]
         public static extern int SendMessage(IntPtr hWnd, int msg, int wParam);
+
+        [DllImport("kernel32.dll")]
+        [return: MarshalAs(UnmanagedType.Bool)]
+        public static extern bool CloseHandle(IntPtr hObject);
+
+        [DllImport("user32.dll")]
+        public static extern IntPtr GetShellWindow();
+
+        /// <summary>
+        /// Returns the last Win32 Error code thrown by a native method if enabled for this method.
+        /// </summary>
+        /// <returns>The error code as int value.</returns>
+        public static int GetLastWin32Error()
+        {
+            return Marshal.GetLastWin32Error();
+        }
+
+        /// <summary>
+        /// Validate that the handle is not null and close it.
+        /// </summary>
+        /// <param name="handle">Handle to close.</param>
+        /// <returns>Zero if native method fails and nonzero if the native method succeeds.</returns>
+        public static bool CloseHandleIfNotNull(IntPtr handle)
+        {
+            if (handle == IntPtr.Zero)
+            {
+                // Return true if there is nothing to close.
+                return true;
+            }
+
+            return CloseHandle(handle);
+        }
     }
 }

src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/OpenWindows.cs

@@ -20,11 +20,6 @@ internal class OpenWindows
         /// </summary>
         private static readonly string _powerLauncherExe = Path.GetFileName(Process.GetCurrentProcess().MainModule.FileName);
 
-        /// <summary>
-        /// Delegate handler for open windows updates
-        /// </summary>
-        public delegate void OpenWindowsUpdateEventHandler(object sender, SearchController.SearchResultUpdateEventArgs e);
-
         /// <summary>
         /// List of all the open windows
         /// </summary>
@@ -93,9 +88,14 @@ public bool WindowEnumerationCallBack(IntPtr hwnd, IntPtr lParam)
 
             if (newWindow.IsWindow && newWindow.Visible && newWindow.IsOwner &&
                 (!newWindow.IsToolWindow || newWindow.IsAppWindow) && !newWindow.TaskListDeleted &&
-                newWindow.ClassName != "Windows.UI.Core.CoreWindow" && newWindow.ProcessName != _powerLauncherExe)
+                newWindow.ClassName != "Windows.UI.Core.CoreWindow" && newWindow.ProcessInfo.Name != _powerLauncherExe)
             {
-                windows.Add(newWindow);
+                // To hide (not add) preloaded uwp app windows that are invisible to the user we check the cloak state in DWM to be "none". (Issue #13637.)
+                // (If user asking to see these windows again we can add an optional plugin setting in the future.)
+                if (!newWindow.IsCloaked)
+                {
+                    windows.Add(newWindow);
+                }
             }
 
             return true;

src/modules/launcher/Plugins/Microsoft.Plugin.WindowWalker/Components/SearchController.cs

@@ -7,7 +7,6 @@
 using System.Collections.Generic;
 using System.Globalization;
 using System.Linq;
-using System.Threading.Tasks;
 
 namespace Microsoft.Plugin.WindowWalker.Components
 {
@@ -24,24 +23,14 @@ internal class SearchController
 
         /// <summary>
         /// Open window search results
-        /// </summary
+        /// </summary>
         private List<SearchResult> searchMatches;
 
         /// <summary>
         /// Singleton pattern
         /// </summary>
         private static SearchController instance;
 
-        /// <summary>
-        /// Delegate handler for open windows updates
-        /// </summary>
-        public delegate void SearchResultUpdateEventHandler(object sender, SearchResultUpdateEventArgs e);
-
-        /// <summary>
-        /// Event raised when there is an update to the list of open windows
-        /// </summary>
-        public event SearchResultUpdateEventHandler OnSearchResultUpdateEventHandler;
-
         /// <summary>
         /// Gets or sets the current search text
         /// </summary>
@@ -95,16 +84,16 @@ private SearchController()
         /// <summary>
         /// Event handler for when the search text has been updated
         /// </summary>
-        public async Task UpdateSearchText(string searchText)
+        public void UpdateSearchText(string searchText)
         {
             SearchText = searchText;
-            await SyncOpenWindowsWithModelAsync().ConfigureAwait(false);
+            SyncOpenWindowsWithModel();
         }
 
         /// <summary>
         /// Syncs the open windows with the OpenWindows Model
         /// </summary>
-        public async Task SyncOpenWindowsWithModelAsync()
+        public void SyncOpenWindowsWithModel()
         {
             System.Diagnostics.Debug.Print("Syncing WindowSearch result with OpenWindows Model");
 
@@ -116,22 +105,8 @@ public async Task SyncOpenWindowsWithModelAsync()
             }
             else
             {
-                searchMatches = await FuzzySearchOpenWindowsAsync(snapshotOfOpenWindows).ConfigureAwait(false);
+                searchMatches = FuzzySearchOpenWindows(snapshotOfOpenWindows);
             }
-
-            OnSearchResultUpdateEventHandler?.Invoke(this, new SearchResultUpdateEventArgs());
-        }
-
-        /// <summary>
-        /// Redirecting method for Fuzzy searching
-        /// </summary>
-        /// <param name="openWindows">what windows are open</param>
-        /// <returns>Returns search results</returns>
-        private Task<List<SearchResult>> FuzzySearchOpenWindowsAsync(List<Window> openWindows)
-        {
-            return Task.Run(
-                () =>
-                    FuzzySearchOpenWindows(openWindows));
         }
 
         /// <summary>
@@ -151,7 +126,7 @@ private List<SearchResult> FuzzySearchOpenWindows(List<Window> openWindows)
                 foreach (var window in openWindows)
                 {
                     var titleMatch = FuzzyMatching.FindBestFuzzyMatch(window.Title, searchString.SearchText);
-                    var processMatch = FuzzyMatching.FindBestFuzzyMatch(window.ProcessName, searchString.SearchText);
+                    var processMatch = FuzzyMatching.FindBestFuzzyMatch(window.ProcessInfo.Name, searchString.SearchText);
 
                     if ((titleMatch.Count != 0 || processMatch.Count != 0) &&
                                 window.Title.Length != 0)