Failed attempt to fix window tracking on macOS

Author: Exidex

Cargo.lock

@@ -87,7 +87,7 @@ objc2-foundation = { version = "0.3.1", features = [
     "NSGeometry",
     "NSEnumerator",
 ] }
-objc2-core-graphics = { version = "0.3.1", features = ["CGWindow"] }
+core-graphics = "0.25.0"
 accessibility = "0.2.0"
 accessibility-sys = "0.2.0"
 core-foundation = "0.10.1"

Cargo.toml

@@ -39,7 +39,7 @@ smithay-client-toolkit.workspace = true
 objc2.workspace = true
 objc2-app-kit.workspace = true
 objc2-foundation.workspace = true
-objc2-core-graphics.workspace = true
+core-graphics.workspace = true
 accessibility.workspace = true
 accessibility-sys.workspace = true
 core-foundation.workspace = true

rust/client/Cargo.toml

@@ -1307,6 +1307,7 @@ fn update(state: &mut AppModel, message: AppMsg) -> Task<AppMsg> {
             }
         }
         AppMsg::WindowTrackingMacosFocusWindow { window_uuid } => {
+            #[cfg(target_os = "macos")]
             state.macos_window_tracker.focus_window(window_uuid);
             Task::none()
         }

rust/client/src/ui/mod.rs

@@ -151,6 +151,8 @@ impl ApplicationNotificationDelegate {
             return Err(anyhow::anyhow!("No window with uuid: {}", window_uuid));
         };
 
+        println!("Focusing window: {}, {:?}, {}", window_uuid, window, pid);
+
         make_key_window(*pid, window).context("Failed to make window key")?;
 
         // some apps seem to also require additional raise action

rust/client/src/ui/window_tracking/macos/apps.rs

@@ -11,7 +11,6 @@ use core_foundation::boolean::CFBoolean;
 use core_foundation::dictionary::CFDictionary;
 use core_foundation::string::CFString;
 
-// see https://github.com/jkelleyrtp/kauresel/tree/master for a massive collection of related links
 
 pub fn request_macos_accessibility_permissions() -> bool {
     let options = CFDictionary::from_CFType_pairs(&[(
@@ -22,8 +21,47 @@ pub fn request_macos_accessibility_permissions() -> bool {
     unsafe { AXIsProcessTrustedWithOptions(options.as_concrete_TypeRef()) }
 }
 
+// todo
+//  on each ax notification + non-ax destroy event
+//  get app pid using AXUIElementGetPid
+//  run bruteforce search (+ regular) for axuielement using _AXUIElementCreateWithRemoteToken
+//  from each found window axuielement
+//    filter based on window role/subrole
+//    get window using _AXUIElementGetWindow
+//    get title
+//  to focus use window id and private api
+
+
+// do not support hidden windows
+// do not support multiple "desktop" spaces unless they are all visible
+// what about multiple fullscreen windows of the same app?
+// what about tabs in visible apps in non-visible spaces?
+// i.e., only non-hidden windows in visible spaces and maybe(?) fullscreen apps
+// support minimized windows but only on visible spaces
+
+// support fullscreen applications?
+// support tabs on the visible windows in visible spaces only
+
+// I think ignoring existence of spaces is fine???
+
+// is the private function for focusing a window needed?
+
 // todo support for windows on separate spaces
+// todo multiple desktop spaces ("Desktop" vs. "Desktop 1" and "Desktop 2")
 // todo sometimes the window state seems to be lost, clearing the list of windows
 // todo when starting the gauntlet, tabbed windows only show single one
 // todo implement this https://github.com/glide-wm/glide/issues/10
 // todo how to handle system apps and settings wrt window tracking?
+// todo add all github issue links and appreciations to the commit message
+//   https://github.com/Hammerspoon/hammerspoon/issues/370#issuecomment-545545468
+//   https://github.com/lwouis/alt-tab-macos/issues/1540#issuecomment-1138579049
+//   https://github.com/lwouis/alt-tab-macos/issues/3589#issuecomment-2422002210
+//   https://github.com/lwouis/alt-tab-macos/issues/258#issuecomment-624753940
+//   https://github.com/jkelleyrtp/kauresel/tree/master
+//   https://github.com/koekeishiya/yabai/issues/68
+//   https://github.com/koekeishiya/yabai/commit/6f9006dd957100ec13096d187a8865e85a164a9b#r148091577
+//   https://github.com/koekeishiya/yabai/issues/68
+//   https://github.com/koekeishiya/yabai/issues/199#issuecomment-519152388
+//   https://github.com/lwouis/alt-tab-macos/issues/1324#issuecomment-2631035482
+
+

rust/client/src/ui/window_tracking/macos/mod.rs

@@ -1,19 +1,26 @@
 use accessibility::AXUIElement;
+use accessibility::AXUIElementAttributes;
 use accessibility_sys::AXError;
 use accessibility_sys::AXObserverGetTypeID;
 use accessibility_sys::AXObserverRef;
 use accessibility_sys::AXUIElementRef;
 use accessibility_sys::kAXErrorSuccess;
+use accessibility_sys::kAXWindowRole;
 use accessibility_sys::pid_t;
 use anyhow::Context;
 use anyhow::anyhow;
+use core_foundation::base::CFIndexConvertible;
 use core_foundation::base::OSStatus;
 use core_foundation::base::TCFType;
+use core_foundation::data::CFData;
+use core_foundation::data::CFDataCreate;
+use core_foundation::data::CFDataRef;
 use core_foundation::declare_TCFType;
 use core_foundation::impl_CFTypeDescription;
 use core_foundation::impl_TCFType;
-use objc2_core_graphics::CGError;
-use objc2_core_graphics::CGWindowID;
+use core_graphics::base::kCGErrorSuccess;
+use core_graphics::display::CGError;
+use core_graphics::window::CGWindowID;
 
 declare_TCFType!(AXObserver, AXObserverRef);
 impl_TCFType!(AXObserver, AXObserverRef, AXObserverGetTypeID);
@@ -25,6 +32,13 @@ unsafe extern "C" {
     fn GetProcessForPID(pid: pid_t, psn: *mut ProcessSerialNumber) -> OSStatus;
 }
 
+#[link(name = "SkyLight", kind = "framework")] // PrivateFrameworks included in build.rs
+unsafe extern "C" {
+    fn _SLPSSetFrontProcessWithOptions(psn: *const ProcessSerialNumber, wid: CGWindowID, mode: u32) -> CGError;
+    fn SLPSPostEventRecordTo(psn: *const ProcessSerialNumber, bytes: *const u8) -> CGError;
+    pub fn _AXUIElementCreateWithRemoteToken(data: CFDataRef) -> AXUIElementRef;
+}
+
 #[repr(C)]
 #[derive(Default)]
 struct ProcessSerialNumber {
@@ -47,11 +61,9 @@ pub fn make_key_window(pid: pid_t, window: &AXUIElement) -> anyhow::Result<()> {
     // See https://github.com/Hammerspoon/hammerspoon/issues/370#issuecomment-545545468.
     // god bless all the wizards in that thread that worked on it, thank you
 
-    let mut window_id = 0;
-    let res = unsafe { _AXUIElementGetWindow(window.as_concrete_TypeRef(), &mut window_id) };
-    if res != kAXErrorSuccess {
-        return Err(accessibility::Error::Ax(res)).context(format!("Failed to get window id for element {:?}", window));
-    }
+    let window_id = ax_window_id(window)?;
+
+    println!("window id: {}", window_id);
 
     #[allow(non_upper_case_globals)]
     const kCPSUserGenerated: u32 = 0x200;
@@ -69,7 +81,7 @@ pub fn make_key_window(pid: pid_t, window: &AXUIElement) -> anyhow::Result<()> {
     let psn = ProcessSerialNumber::for_pid(pid)?;
 
     let check = |err| {
-        if err == CGError::Success {
+        if err == kCGErrorSuccess {
             Ok(())
         } else {
             Err(anyhow::anyhow!("Cursed api failed: {:?}", err))
@@ -83,8 +95,46 @@ pub fn make_key_window(pid: pid_t, window: &AXUIElement) -> anyhow::Result<()> {
     Ok(())
 }
 
-#[link(name = "SkyLight", kind = "framework")] // PrivateFrameworks included in build.rs
-unsafe extern "C" {
-    fn _SLPSSetFrontProcessWithOptions(psn: *const ProcessSerialNumber, wid: u32, mode: u32) -> CGError;
-    fn SLPSPostEventRecordTo(psn: *const ProcessSerialNumber, bytes: *const u8) -> CGError;
+pub fn bruteforce_windows_for_app(app_pid: pid_t) -> Vec<AXUIElement> {
+    unsafe {
+        let mut result = vec![];
+        let mut data = [0; 0x14];
+
+        let app_pid = u32::to_ne_bytes(app_pid as u32);
+        data[0..0x4].copy_from_slice(&app_pid);
+
+        let magic = u32::to_ne_bytes(0x636f636f);
+        data[0x8..0xC].copy_from_slice(&magic);
+
+        for element_id in 0..0x7fffu64 {
+            let mut data = data.clone();
+
+            let element_id = element_id.to_ne_bytes();
+            data[0xC..0x14].copy_from_slice(&element_id);
+
+            let data_ref = CFDataCreate(std::ptr::null(), data.as_ptr(), data.len().to_CFIndex());
+            let data_ref = CFData::wrap_under_create_rule(data_ref);
+            let data_ref = data_ref.as_concrete_TypeRef();
+
+            let window = AXUIElement::wrap_under_create_rule(_AXUIElementCreateWithRemoteToken(data_ref));
+
+            let role = window.role().ok().map(|role| role.to_string());
+            if role.as_deref() != Some(kAXWindowRole) {
+                continue;
+            }
+
+            result.push(window);
+        }
+
+        result
+    }
+}
+
+pub fn ax_window_id(window: &AXUIElement) -> anyhow::Result<CGWindowID> {
+    let mut window_id = 0;
+    let res = unsafe { _AXUIElementGetWindow(window.as_concrete_TypeRef(), &mut window_id) };
+    if res != kAXErrorSuccess {
+        return Err(accessibility::Error::Ax(res)).context(format!("Failed to get window id for element {:?}", window));
+    }
+    Ok(window_id)
 }