Add listener on foreground window change/resize

Author: huntfx

mousetracks2/components/tracking.py

@@ -23,7 +23,7 @@
 from ..utils.monitor import MonitorData
 from ..utils.input import get_cursor_pos
 from ..utils.interface import Interfaces
-from ..utils.system import MonitorEventListener, ControllerEventListener, hide_child_process
+from ..utils.system import MonitorEventListener, ControllerEventListener, ForegroundAppListener, hide_child_process
 
 
 if XInput is None:
@@ -136,6 +136,9 @@ def __post_init__(self) -> None:
         self._controller_listener = ControllerEventListener()
         self._controller_listener.start()
 
+        self._application_listener = ForegroundAppListener()
+        self._application_listener.start()
+
     def _receive_data(self) -> None:
         for message in self.receive_data():
             match message:
@@ -198,6 +201,12 @@ def _receive_data(self) -> None:
                     print(f'[Tracking] Disabled check for running applications: {message.disable}')
                     self.update_apps = not message.disable
 
+                    if message.disable:
+                        self._application_listener.stop()
+                    else:
+                        self._application_listener = ForegroundAppListener()
+                        self._application_listener.start()
+
                 case ipc.DebugDisableMonitorCheck():
                     print(f'[Tracking] Disabled check for monitor changes: {message.disable}')
                     self.update_monitors = not message.disable
@@ -412,7 +421,7 @@ def run(self) -> None:
             self.send_data(ipc.Tick(tick, int(time.time())))
 
             # Check for loaded applications
-            if self.update_apps and tick and not tick % int(UPDATES_PER_SECOND * GlobalConfig.application_check_frequency):
+            if self.update_apps and self._application_listener.triggered:
                 self.send_data(ipc.RequestRunningAppCheck())
 
             # Update monitor data

mousetracks2/config.py

@@ -26,7 +26,6 @@ class GlobalConfig:
         save_frequency: How often to autosave.
         max_loaded_profiles: Maximum amount of loaded profiles.
             This will only affect profiles without unsaved changes.
-        application_check_frequency: How often to check the current focused application.
         component_check_frequency: How often to check all components are running.
             This is used once per message received.
         shutdown_timeout: How long to wait before shutting down automatically.
@@ -45,7 +44,6 @@ class GlobalConfig:
     inactivity_time: float = 300.0
     save_frequency: float = 600.0
     max_loaded_profiles: int = 8
-    application_check_frequency: float = 1.0
     component_check_frequency: float = 1.0
     shutdown_timeout: float = 15.0
     export_notification_timeout: float = 7.0

mousetracks2/utils/system/__init__.py

@@ -18,7 +18,6 @@
         from .windows import get_autostart, set_autostart, remove_autostart
         from .windows import is_elevated, relaunch_as_elevated
         from .windows import Window
-        from .windows import MonitorEventListener, ControllerEventListener
         from .base import hide_child_process
         from .windows import prepare_application_icon
         from .windows import update_installer_version_number

mousetracks2/utils/system/base.py

@@ -98,7 +98,7 @@ class EventListener(threading.Thread):
     """
 
     def __init__(self) -> None:
-        super().__init__(name='EventListener', daemon=True)
+        super().__init__(name=type(self).__name__, daemon=True)
         self._queue = queue.Queue()  # type: queue.Queue[None]
         self._running = True
 
@@ -135,6 +135,10 @@ class ControllerEventListener(EventListener):
     """Listen for controller change events."""
 
 
+class ForegroundAppListener(EventListener):
+    """Listen for application change events."""
+
+
 def hide_child_process() -> None:
     """This is here to allow macOS to hide the child processes."""
 

mousetracks2/utils/system/windows.py

@@ -51,16 +51,28 @@
 
 DBT_DEVNODES_CHANGED = 0x0007
 
+EVENT_SYSTEM_FOREGROUND = 0x0003
+
+EVENT_OBJECT_LOCATIONCHANGE = 0x800B
+
+WINEVENT_OUTOFCONTEXT = 0x0000
+
+OBJID_WINDOW = 0x00000000
+
 BOOL = ctypes.wintypes.BOOL
 
 DWORD = ctypes.wintypes.DWORD
 
+LONG = ctypes.wintypes.LONG
+
 HDC = ctypes.wintypes.HDC
 
 HMONITOR = ctypes.wintypes.HMONITOR
 
 HWND = ctypes.wintypes.HWND
 
+HANDLE = ctypes.wintypes.HANDLE
+
 UINT = ctypes.wintypes.UINT
 
 LPARAM = ctypes.wintypes.LPARAM
@@ -83,11 +95,13 @@
 
 WNDPROCTYPE = ctypes.WINFUNCTYPE(LRESULT, HWND, UINT, WPARAM, LPARAM)
 
+WINEVENTPROC = ctypes.WINFUNCTYPE(None, HANDLE, DWORD, HWND, LONG, LONG, DWORD, DWORD)
+
 HCURSOR = ctypes.wintypes.HANDLE
 
-HICON = ctypes.wintypes.HANDLE
+HICON = ctypes.wintypes.HICON
 
-HBRUSH = ctypes.wintypes.HANDLE
+HBRUSH = ctypes.wintypes.HBRUSH
 
 DPI_AWARENESS_CONTEXT_UNAWARE = ctypes.wintypes.HANDLE(-1)
 DPI_AWARENESS_CONTEXT_SYSTEM_AWARE = ctypes.wintypes.HANDLE(-2)
@@ -134,12 +148,7 @@
 user32.EnumDisplayMonitors.restype = BOOL
 
 user32.DefWindowProcW.restype = LRESULT
-user32.DefWindowProcW.argtypes = [
-    HWND,
-    UINT,
-    WPARAM,
-    LPARAM,
-]
+user32.DefWindowProcW.argtypes = [HWND, UINT, WPARAM, LPARAM]
 
 user32.SetThreadDpiAwarenessContext.argtypes = [ctypes.wintypes.HANDLE]
 user32.SetThreadDpiAwarenessContext.restype = ctypes.wintypes.HANDLE
@@ -456,29 +465,29 @@ def size(self) -> tuple[int, int]:
         return self._pid.size
 
 
-class EventListener(base.EventListener):
-    """Base Windows event listener.
+class _WindowMessageListener(base.EventListener):
+    """Listen for Windows messages.
 
-    Override the `check` method to implement this.
+    Override the `check` method to implement triggers.
     """
 
     def __init__(self) -> None:
         super().__init__()
-        self._hwnd = None  # type: int | None
+        self._hwnd: int | None = None
 
     def check(self, hwnd: int, msg: int, wparam: int, lparam: int) -> bool:
         """Determine if a specific event has been fired."""
         return False
 
+    def _win_proc(self, hwnd: int, msg: int, wparam: int, lparam: int) -> int:
+        if self.check(hwnd, msg, wparam, lparam):
+            self.trigger()
+        return user32.DefWindowProcW(hwnd, msg, wparam, lparam)
+
     def run(self) -> None:
         """Create and start the message listener."""
-        def wndproc(hwnd: int, msg: int, wparam: int, lparam: int) -> int:
-            if self.check(hwnd, msg, wparam, lparam):
-                self.trigger()
-            return user32.DefWindowProcW(hwnd, msg, wparam, lparam)
-
         hinst = kernel32.GetModuleHandleW(None)
-        wndproc_c = WNDPROCTYPE(wndproc)
+        wndproc_c = WNDPROCTYPE(self._win_proc)
 
         class_name = type(self).__name__
         wc = WNDCLASS()
@@ -510,20 +519,93 @@ def stop(self) -> None:
             user32.PostMessageW(self._hwnd, WM_QUIT, 0, 0)
 
 
-class MonitorEventListener(EventListener):
+class _WinEventHookListener(base.EventListener):
+    """Listen for Windows event hooks.
+
+    Override the `check` method to implement triggers.
+    """
+
+    EVENTS: tuple[int, ...] = ()
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._hooks: list[int] = []
+
+    def check(self, hWinEventHook: int, event: int, hwnd: int, idObject: int,
+              idChild: int, dwEventThread: int, dwmsEventTime: int) -> bool:
+        """Determine if a specific event has been fired."""
+        return False
+
+    def _win_event_callback(self, hWinEventHook: int, event: int, hwnd: int, idObject: int,
+                            idChild: int, dwEventThread: int, dwmsEventTime: int) -> None:
+        if self.check(hWinEventHook, event, hwnd, idObject,
+                      idChild, dwEventThread, dwmsEventTime):
+            self.trigger()
+
+    def run(self) -> None:
+        hook_proc = WINEVENTPROC(self._win_event_callback)
+
+        for event_id in self.EVENTS:
+            hook = user32.SetWinEventHook(
+                event_id, event_id,
+                None, hook_proc, 0, 0, WINEVENT_OUTOFCONTEXT
+            )
+            if not hook:
+                raise ctypes.WinError(ctypes.get_last_error())
+            self._hooks.append(hook)
+
+        self.trigger()
+
+        msg = MSG()
+        while user32.GetMessageW(ctypes.byref(msg), None, 0, 0):
+            user32.TranslateMessage(ctypes.byref(msg))
+            user32.DispatchMessageW(ctypes.byref(msg))
+
+    def stop(self) -> None:
+        """Stops the message loop and cleans up the thread."""
+        for hook in self._hooks:
+            user32.UnhookWinEvent(hook)
+        self._hooks.clear()
+        user32.PostThreadMessageW(kernel32.GetCurrentThreadId(), WM_QUIT, 0, 0)
+
+
+class MonitorEventListener(_WindowMessageListener):
     """Listen for monitor change events."""
 
     def check(self, hwnd: int, msg: int, wparam: int, lparam: int) -> bool:
         return msg == WM_DISPLAYCHANGE
 
 
-class ControllerEventListener(EventListener):
+class ControllerEventListener(_WindowMessageListener):
     """Listen for controller change events."""
 
     def check(self, hwnd: int, msg: int, wparam: int, lparam: int) -> bool:
         return msg == WM_DEVICECHANGE and wparam == DBT_DEVNODES_CHANGED
 
 
+class ForegroundAppListener(_WinEventHookListener):
+    """Listen for when the foreground window changes.
+    This can happen if the user changes, moves or resizes an app.
+    """
+
+    EVENTS = (
+        EVENT_SYSTEM_FOREGROUND,
+        EVENT_OBJECT_LOCATIONCHANGE,
+    )
+
+    def __init__(self) -> None:
+        self._is_moving = False
+        super().__init__()
+
+    def check(self, hWinEventHook: int, event: int, hwnd: int, idObject: int,
+              idChild: int, dwEventThread: int, dwmsEventTime: int) -> bool:
+        if not hwnd or event not in self.EVENTS:
+            return False
+        if event == EVENT_OBJECT_LOCATIONCHANGE:
+            return idObject == OBJID_WINDOW
+        return True
+
+
 def prepare_application_icon(icon_path: Path | str) -> None:
     """Register app so that setting an icon is possible."""
     ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(PACKAGE_IDENTIFIER)