Improve method for spy window selection

benbuck · benbuck · commit fa7dd5641965 · 2025-03-21T23:55:44.000-07:00
diff --git a/README.md b/README.md
@@ -213,12 +213,13 @@ window will minimize the standard way instead of to the tray.
 ### Spy feature
 
 If you don't know the executable, class, or title of a window, or just would like help filling those values, you can use
-the Spy feature. To use it, first open the [Settings](#settings) window, then press the "Spy" button. This will close
-the Settings window, then show you a message explaining that Spy mode is active, and that you can click on any window to
-select it. Press the "OK" button of that message, and then click on the window you want to obtain the executable, class,
-and title of. Once you have done that, the Settings window should re-appear, and those values should be filled in. You
-can modify them if you like, or leave them alone, and then press the Add button to create a new Auto-tray item for that
-window.
+the Spy feature. To use it, first open the [Settings](#settings) window, find the crosshair icon next to the text that
+says "Spy (drag this):", and use your mouse to drag that icon onto the window that you want to obtain the executable,
+class, and title of. As you drag the crosshair around, the settings window should be updated with information about each
+window you move it over, and when you release the mouse button then the crosshair icon will return to its original
+position, and the values in the settings should stay filled in with whatever window you last dragged on top of. You can
+modify the values if you like, or leave them alone, and then press the Add button to create a new Auto-tray item for
+that window.
 
 If the Spy feature doesn't work for you, alternatively you can use another tool like
 [Window Spy](https://amourspirit.github.io/AutoHotkey-Snippit/WindowSpy.html) or
diff --git a/TODO.md b/TODO.md
@@ -2,7 +2,6 @@
 
 - Get windows error reporting (WER) working
 - Add tray icon promotion (avoid moving to notification area overflow menu)
-- Improve method for spy window selection
 - Investigate VirusTotal results for installer
 - Add auto-tray option: when created, when minimized, both
 - Add option to make tray icons persistent even when window is restored
diff --git a/src/Finestray.rc b/src/Finestray.rc
@@ -46,8 +46,6 @@ BEGIN
     IDS_COLUMN_EXECUTABLE           "Executable"
     IDS_COLUMN_WINDOW_CLASS         "Class"
     IDS_COLUMN_WINDOW_TITLE         "Title"
-    IDS_SPY_MODE_TITLE              "Spy Mode"
-    IDS_SPY_MODE_TEXT               "Spy mode activated, click on any window to retrieve its information."
     IDS_ERROR_INIT_COM              "Failed to initialize COM"
     IDS_ERROR_INIT_COMMON_CONTROLS  "Failed to initialize common controls"
     IDS_ERROR_REGISTER_WINDOW_CLASS "Error creating window class"
@@ -64,7 +62,7 @@ BEGIN
     IDS_ERROR_SAVE_SETTINGS         "Failed to save settings"
 END
 
-IDD_DIALOG_SETTINGS DIALOGEX 0, 0, 420, 315
+IDD_DIALOG_SETTINGS DIALOGEX 0, 0, 420, 317
 STYLE DS_SETFONT | DS_MODALFRAME | DS_FIXEDSYS | DS_CENTER | WS_POPUP | WS_CAPTION | WS_SYSMENU
 CAPTION "Finestray Settings"
 FONT 8, "MS Shell Dlg", 400, 0, 0x1
@@ -99,7 +97,7 @@ BEGIN
     LTEXT           "Poll Interval", IDC_STATIC, 10, 97, 67, 8, SS_RIGHT | WS_GROUP
     EDITTEXT        IDC_POLL_INTERVAL, 81, 95, 120, 14, ES_AUTOHSCROLL | ES_NUMBER | WS_TABSTOP
 
-    GROUPBOX        "Auto-tray windows", IDC_STATIC, 5, 114, 410, 176
+    GROUPBOX        "Auto-tray windows", IDC_STATIC, 5, 114, 410, 177
     CONTROL         "", IDC_AUTO_TRAY_LIST, WC_LISTVIEWA, LVS_NOSORTHEADER | LVS_REPORT | LVS_SINGLESEL | WS_TABSTOP, 9, 126, 400, 89
     LTEXT           "Executable", IDC_STATIC, 10, 221, 67, 8, SS_RIGHT | WS_GROUP
     EDITTEXT        IDC_AUTO_TRAY_EDIT_EXECUTABLE, 81, 219, 329, 14, ES_AUTOHSCROLL | WS_TABSTOP
@@ -110,14 +108,15 @@ BEGIN
     PUSHBUTTON      "Update", IDC_AUTO_TRAY_ITEM_UPDATE, 80, 272, 50, 12
     PUSHBUTTON      "Add", IDC_AUTO_TRAY_ITEM_ADD, 133, 272, 50, 12
     PUSHBUTTON      "Delete", IDC_AUTO_TRAY_ITEM_DELETE, 186, 272, 50, 12
-    PUSHBUTTON      "Spy", IDC_AUTO_TRAY_ITEM_SPY, 360, 272, 50, 12
-
-    PUSHBUTTON      "Help", IDC_HELP_PAGE, 10, 296, 50, 14
-    PUSHBUTTON      "About", IDC_ABOUT, 64, 296, 50, 14
-    PUSHBUTTON      "Reset", IDC_RESET, 118, 296, 50, 14
-    PUSHBUTTON      "Exit", IDC_EXIT, 172, 296, 50, 14
-    PUSHBUTTON      "Cancel", IDCANCEL, 305, 296, 50, 14
-    DEFPUSHBUTTON   "OK", IDOK, 359, 296, 50, 14
+    LTEXT           "Spy (drag this):", IDC_STATIC, 338, 274, 50, 12
+    ICON            "",IDC_AUTO_TRAY_ITEM_SPY, 390, 269, 20, 20, SS_NOTIFY
+
+    PUSHBUTTON      "Help", IDC_HELP_PAGE, 10, 298, 50, 14
+    PUSHBUTTON      "About", IDC_ABOUT, 64, 298, 50, 14
+    PUSHBUTTON      "Reset", IDC_RESET, 118, 298, 50, 14
+    PUSHBUTTON      "Exit", IDC_EXIT, 172, 298, 50, 14
+    PUSHBUTTON      "Cancel", IDCANCEL, 305, 298, 50, 14
+    DEFPUSHBUTTON   "OK", IDOK, 359, 298, 50, 14
 END
 
 VS_VERSION_INFO VERSIONINFO
diff --git a/src/Resource.h b/src/Resource.h
@@ -30,8 +30,6 @@
 #define IDS_COLUMN_EXECUTABLE                     222
 #define IDS_COLUMN_WINDOW_CLASS                   223
 #define IDS_COLUMN_WINDOW_TITLE                   224
-#define IDS_SPY_MODE_TITLE                        225
-#define IDS_SPY_MODE_TEXT                         226
 
 // error strings
 #define IDS_ERROR_INIT_COM                        301
diff --git a/src/SettingsDialog.cpp b/src/SettingsDialog.cpp
@@ -57,12 +57,14 @@ int autoTrayListViewCompare(LPARAM, LPARAM, LPARAM);
 void autoTrayListViewItemAdd(HWND dialogHwnd);
 void autoTrayListViewItemUpdate(HWND dialogHwnd, int item);
 void autoTrayListViewItemDelete(HWND dialogHwnd, int item);
-void autoTrayListViewItemSpy(HWND dialogHwnd);
 void autoTrayListViewItemEdit(HWND dialogHwnd, int item);
 void autoTrayListViewUpdateButtons(HWND dialogHwnd);
 void autoTrayListViewUpdateSelected(HWND dialogHwnd);
-void spySelectWindowAtPoint(const POINT & point);
-LRESULT CALLBACK MouseProc(int nCode, WPARAM wParam, LPARAM lParam);
+void spyBegin(HWND dialogHwnd);
+void spyEnd(HWND dialogHwnd);
+void spyEnableIcon(HWND dialogHwnd);
+void spyDisableIcon(HWND dialogHwnd);
+void spyUpdate(HWND dialogHwnd);
 std::string getDialogItemText(HWND dialogHwnd, int id);
 std::string getListViewItemText(HWND listViewHwnd, int item, int subItem);
 
@@ -75,8 +77,6 @@ bool autoTrayListViewSortAscending_;
 int autoTrayListViewSortColumn_;
 #endif
 bool spyMode_;
-HWND spyModeHwnd_;
-HHOOK mouseHhook_;
 
 } // anonymous namespace
 
@@ -110,12 +110,29 @@ INT_PTR settingsDialogFunc(HWND dialogHwnd, UINT message, WPARAM wParam, LPARAM
     // DEBUG_PRINTF("wnd %#x, message %#x, wparam %#x, lparam %#x\n", dialogHwnd, message, wParam, lParam);
 
     if (spyMode_) {
-        if (message == WM_LBUTTONDOWN) {
-            POINT point;
-            if (!GetCursorPos(&point)) {
-                WARNING_PRINTF("GetCursorPos failed: %s\n", StringUtility::lastErrorString().c_str());
-            } else {
-                spySelectWindowAtPoint(point);
+        switch (message) {
+            case WM_CAPTURECHANGED:
+            case WM_LBUTTONUP: {
+                spyUpdate(dialogHwnd);
+                spyEnd(dialogHwnd);
+                break;
+            }
+
+            case WM_MOUSEMOVE: {
+                spyUpdate(dialogHwnd);
+                break;
+            }
+
+            case WM_SETCURSOR: {
+                HCURSOR hCursor = LoadCursor(NULL, IDC_CROSS);
+                if (!hCursor) {
+                    WARNING_PRINTF("LoadCursor failed: %s\n", StringUtility::lastErrorString().c_str());
+                } else {
+                    if (!SetCursor(hCursor)) {
+                        WARNING_PRINTF("SetCursor failed: %s\n", StringUtility::lastErrorString().c_str());
+                    }
+                }
+                break;
             }
         }
 
@@ -193,6 +210,8 @@ INT_PTR settingsDialogFunc(HWND dialogHwnd, UINT message, WPARAM wParam, LPARAM
                 WARNING_PRINTF("SetDlgItemTextA failed: %s\n", StringUtility::lastErrorString().c_str());
             }
 
+            spyEnableIcon(dialogHwnd);
+
             autoTrayListViewInit(dialogHwnd);
 
             break;
@@ -258,7 +277,9 @@ INT_PTR settingsDialogFunc(HWND dialogHwnd, UINT message, WPARAM wParam, LPARAM
                         break;
                     }
                     case IDC_AUTO_TRAY_ITEM_SPY: {
-                        autoTrayListViewItemSpy(dialogHwnd);
+                        if (HIWORD(wParam) == STN_CLICKED) {
+                            spyBegin(dialogHwnd);
+                        }
                         break;
                     }
 
@@ -670,31 +691,6 @@ void autoTrayListViewItemDelete(HWND dialogHwnd, int item)
     autoTrayListViewUpdateSelected(dialogHwnd);
 }
 
-void autoTrayListViewItemSpy(HWND dialogHwnd)
-{
-    DEBUG_PRINTF("Spying auto tray\n");
-
-    if (!ShowWindow(dialogHwnd, SW_HIDE)) {
-        WARNING_PRINTF("ShowWindow failed: %s\n", StringUtility::lastErrorString().c_str());
-    }
-
-    MessageBoxA(
-        dialogHwnd,
-        getResourceString(IDS_SPY_MODE_TEXT).c_str(),
-        getResourceString(IDS_SPY_MODE_TITLE).c_str(),
-        MB_OK);
-
-    mouseHhook_ = SetWindowsHookEx(WH_MOUSE_LL, MouseProc, nullptr, 0);
-    if (!mouseHhook_) {
-        WARNING_PRINTF("Failed to install mouse hook!\n");
-    } else {
-        DEBUG_PRINTF("Mouse hook installed.\n");
-    }
-
-    spyModeHwnd_ = dialogHwnd;
-    spyMode_ = true;
-}
-
 void autoTrayListViewItemEdit(HWND dialogHwnd, int item)
 {
     DEBUG_PRINTF("Editing auto tray item %d\n", item);
@@ -822,76 +818,126 @@ void setListViewSortIcon(HWND listView, int col, int sortOrder)
 }
 #endif
 
-void spySelectWindowAtPoint(const POINT & point)
+void spyBegin(HWND dialogHwnd)
 {
-    DEBUG_PRINTF("Mouse clicked at: %d, %d\n", point.x, point.y);
+    DEBUG_PRINTF("Spy mode: beginning\n");
 
-    HWND hwnd = WindowFromPoint(point);
-    if (!hwnd) {
-        DEBUG_PRINTF("No window found\n");
-    } else {
-        DEBUG_PRINTF("Spy mode: hwnd %#x\n", hwnd);
+    spyMode_ = true;
+
+    spyDisableIcon(dialogHwnd);
+
+    SetCapture(dialogHwnd);
+}
+
+void spyEnd(HWND dialogHwnd)
+{
+    DEBUG_PRINTF("Spy mode: ended\n");
+    if (!ReleaseCapture()) {
+        WARNING_PRINTF("ReleaseCapture failed: %s\n", StringUtility::lastErrorString().c_str());
+    }
+
+    spyEnableIcon(dialogHwnd);
 
-        HWND rootHwnd = GetAncestor(hwnd, GA_ROOT);
-        if (!rootHwnd) {
-            WARNING_PRINTF("Failed to get root hwnd, falling back to original\n");
-            rootHwnd = hwnd;
+    spyMode_ = false;
+}
+
+void spyEnableIcon(HWND dialogHwnd)
+{
+    HCURSOR hCrossCursor = LoadCursor(NULL, IDC_CROSS);
+    if (!hCrossCursor) {
+        WARNING_PRINTF("LoadCursor failed: %s\n", StringUtility::lastErrorString().c_str());
+    } else {
+        if (!SendDlgItemMessage(dialogHwnd, IDC_AUTO_TRAY_ITEM_SPY, STM_SETICON, (WPARAM)hCrossCursor, 0)) {
+            WARNING_PRINTF("SendDlgItemMessage failed: %s\n", StringUtility::lastErrorString().c_str());
         }
+    }
+}
 
-        CHAR executableFullPath[MAX_PATH] = {};
-        DWORD processID;
-        if (!GetWindowThreadProcessId(rootHwnd, &processID)) {
-            WARNING_PRINTF("GetWindowThreadProcessId() failed: %s\n", StringUtility::lastErrorString().c_str());
-        } else {
-            HandleWrapper process(OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ, FALSE, processID));
-            if (!process) {
-                WARNING_PRINTF("OpenProcess() failed: %s\n", StringUtility::lastErrorString().c_str());
-            } else {
-                if (!GetModuleFileNameExA((HMODULE)(HANDLE)process, nullptr, executableFullPath, MAX_PATH)) {
-                    WARNING_PRINTF("GetModuleFileNameA() failed: %s\n", StringUtility::lastErrorString().c_str());
-                }
-            }
+void spyDisableIcon(HWND dialogHwnd)
+{
+    if (!SendDlgItemMessage(dialogHwnd, IDC_AUTO_TRAY_ITEM_SPY, STM_SETICON, 0, 0)) {
+        WARNING_PRINTF("SendDlgItemMessage failed: %s\n", StringUtility::lastErrorString().c_str());
+    }
+
+    HCURSOR hCursor = LoadCursor(NULL, IDC_CROSS);
+    if (!hCursor) {
+        WARNING_PRINTF("LoadCursor failed: %s\n", StringUtility::lastErrorString().c_str());
+    } else {
+        if (!SetCursor(hCursor)) {
+            WARNING_PRINTF("SetCursor failed: %s\n", StringUtility::lastErrorString().c_str());
         }
-        DEBUG_PRINTF("Executable full path: '%s'\n", executableFullPath);
+    }
+}
 
-        std::string className = getWindowClassName(rootHwnd);
-        DEBUG_PRINTF("Class name: '%s'\n", className.c_str());
+void spyUpdate(HWND dialogHwnd)
+{
+    POINT point;
+    if (!GetCursorPos(&point)) {
+        WARNING_PRINTF("GetCursorPos failed: %s\n", StringUtility::lastErrorString().c_str());
+        return;
+    }
+
+    DEBUG_PRINTF("Spy mode: selecting window at: %d, %d\n", point.x, point.y);
+
+    HWND hwnd = WindowFromPoint(point);
+    if (!hwnd) {
+        DEBUG_PRINTF("No window found\n");
+        return;
+    }
 
-        std::string title = getWindowText(rootHwnd);
-        DEBUG_PRINTF("Title: '%s'\n", title.c_str());
+    HWND rootHwnd = GetAncestor(hwnd, GA_ROOT);
+    if (!rootHwnd) {
+        WARNING_PRINTF("Failed to get root hwnd, falling back to original\n");
+        rootHwnd = hwnd;
+    }
 
-        if (!SetDlgItemTextA(spyModeHwnd_, IDC_AUTO_TRAY_EDIT_EXECUTABLE, executableFullPath)) {
+    if (rootHwnd == dialogHwnd) {
+        DEBUG_PRINTF("Spy mode: own window, clearing\n");
+        if (!SetDlgItemTextA(dialogHwnd, IDC_AUTO_TRAY_EDIT_EXECUTABLE, nullptr)) {
             WARNING_PRINTF("SetDlgItemTextA failed: %s\n", StringUtility::lastErrorString().c_str());
         }
-        if (!SetDlgItemTextA(spyModeHwnd_, IDC_AUTO_TRAY_EDIT_WINDOWCLASS, className.c_str())) {
+        if (!SetDlgItemTextA(dialogHwnd, IDC_AUTO_TRAY_EDIT_WINDOWCLASS, nullptr)) {
             WARNING_PRINTF("SetDlgItemTextA failed: %s\n", StringUtility::lastErrorString().c_str());
         }
-        if (!SetDlgItemTextA(spyModeHwnd_, IDC_AUTO_TRAY_EDIT_WINDOWTITLE, title.c_str())) {
+        if (!SetDlgItemTextA(dialogHwnd, IDC_AUTO_TRAY_EDIT_WINDOWTITLE, nullptr)) {
             WARNING_PRINTF("SetDlgItemTextA failed: %s\n", StringUtility::lastErrorString().c_str());
         }
+        return;
+    }
 
-        if (!ShowWindow(spyModeHwnd_, SW_SHOW)) {
-            WARNING_PRINTF("ShowWindow failed: %s\n", StringUtility::lastErrorString().c_str());
-        }
-        if (!SetForegroundWindow(spyModeHwnd_)) {
-            WARNING_PRINTF("SetForegroundWindow failed: %s\n", StringUtility::lastErrorString().c_str());
-        }
+    DEBUG_PRINTF("Spy mode: root hwnd %#x\n", rootHwnd);
 
-        spyModeHwnd_ = nullptr;
-        spyMode_ = false;
+    CHAR executableFullPath[MAX_PATH] = {};
+    DWORD processID;
+    if (!GetWindowThreadProcessId(rootHwnd, &processID)) {
+        WARNING_PRINTF("GetWindowThreadProcessId() failed: %s\n", StringUtility::lastErrorString().c_str());
+    } else {
+        HandleWrapper process(OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ, FALSE, processID));
+        if (!process) {
+            WARNING_PRINTF("OpenProcess() failed: %s\n", StringUtility::lastErrorString().c_str());
+        } else {
+            if (!GetModuleFileNameExA((HMODULE)(HANDLE)process, nullptr, executableFullPath, MAX_PATH)) {
+                WARNING_PRINTF("GetModuleFileNameA() failed: %s\n", StringUtility::lastErrorString().c_str());
+            }
+        }
     }
-}
+    DEBUG_PRINTF("Executable full path: '%s'\n", executableFullPath);
 
-LRESULT CALLBACK MouseProc(int nCode, WPARAM wParam, LPARAM lParam)
-{
-    if ((nCode == HC_ACTION) && (wParam == WM_LBUTTONDOWN)) {
-        UnhookWindowsHookEx(mouseHhook_);
+    std::string className = getWindowClassName(rootHwnd);
+    DEBUG_PRINTF("Class name: '%s'\n", className.c_str());
 
-        LPMSLLHOOKSTRUCT mouseInfo = (LPMSLLHOOKSTRUCT)lParam;
-        spySelectWindowAtPoint(mouseInfo->pt);
-    }
+    std::string title = getWindowText(rootHwnd);
+    DEBUG_PRINTF("Title: '%s'\n", title.c_str());
 
-    return CallNextHookEx(mouseHhook_, nCode, wParam, lParam);
+    if (!SetDlgItemTextA(dialogHwnd, IDC_AUTO_TRAY_EDIT_EXECUTABLE, executableFullPath)) {
+        WARNING_PRINTF("SetDlgItemTextA failed: %s\n", StringUtility::lastErrorString().c_str());
+    }
+    if (!SetDlgItemTextA(dialogHwnd, IDC_AUTO_TRAY_EDIT_WINDOWCLASS, className.c_str())) {
+        WARNING_PRINTF("SetDlgItemTextA failed: %s\n", StringUtility::lastErrorString().c_str());
+    }
+    if (!SetDlgItemTextA(dialogHwnd, IDC_AUTO_TRAY_EDIT_WINDOWTITLE, title.c_str())) {
+        WARNING_PRINTF("SetDlgItemTextA failed: %s\n", StringUtility::lastErrorString().c_str());
+    }
 }
 
 std::string getDialogItemText(HWND dialogHwnd, int id)
diff --git a/src/images/settings-window.png b/src/images/settings-window.png
