Merge pull request #3 from MrJarnould/fix/dock-orientation

Fix/dock orientation

Author: mshamrai

macapptree/dock_utils.py

@@ -1,15 +1,44 @@
 import os
+import subprocess
 import time
+
 import AppKit
 import Quartz
-import ApplicationServices
 
 import macapptree.apps as apps
-from macapptree.uielement import UIElement
 from macapptree.extractor import extract_window
-from macapptree.window_tools import store_screen_scaling_factor, segment_window_components
 from macapptree.screenshot_app_window import capture_full_screen
-from macapptree.window_tools import propagate_screen_rect
+from macapptree.uielement import UIElement
+from macapptree.window_tools import (
+    propagate_screen_rect,
+    segment_window_components,
+    store_screen_scaling_factor,
+)
+
+
+def get_dock_orientation() -> str:
+    try:
+        result = subprocess.run(
+            ['defaults', 'read', 'com.apple.dock', 'orientation'],
+            capture_output=True, text=True
+        )
+        val = result.stdout.strip()
+        if val in ["left", "bottom", "right"]:
+            return val
+    except Exception:
+        pass
+    return "bottom"
+
+def get_dock_autohide() -> bool:
+    try:
+        result = subprocess.run(
+            ['defaults', 'read', 'com.apple.dock', 'autohide'],
+            capture_output=True, text=True
+        )
+        return result.stdout.strip() == "1"
+    except Exception:
+        pass
+    return True  # Default to True to be safe (reveal if unsure)
 
 DOCK_THICKNESS_PT = 96 
 
@@ -30,74 +59,97 @@ def _propagate_screen_rect_local(ui_element, screen_rect_tl):
         _propagate_screen_rect_local(child, screen_rect_tl)
 
 # if the dock is set to autohide, we can move the mouse to reveal it temporarily
-def _reveal_dock_temporarily(orientation: str = "bottom", dwell: float = 0.8):
+# if the dock is set to autohide, we can move the mouse to reveal it temporarily
+def _move_mouse_revealing_dock(orientation: str = "bottom", dwell: float = 0.8):
     try:
+        # Save current mouse position
+        loc = Quartz.CGEventGetLocation(Quartz.CGEventCreate(None))
+        current_x, current_y = loc.x, loc.y
+
         screen = AppKit.NSScreen.mainScreen().frame()
         sw, sh = int(screen.size.width), int(screen.size.height)
 
         if orientation.lower() == "left":
-            x, y = 2, sh // 2
+            x, y = 0, sh // 2
         elif orientation.lower() == "right":
-            x, y = sw - 2, sh // 2
+            x, y = sw - 1, sh // 2
         else:
             # bottom
-            x, y = sw // 2, sh - 2
+            x, y = sw // 2, sh - 1
 
         evt = Quartz.CGEventCreateMouseEvent(None, Quartz.kCGEventMouseMoved, (x, y), Quartz.kCGMouseButtonLeft)
         Quartz.CGEventPost(Quartz.kCGHIDEventTap, evt)
         time.sleep(dwell)
+        
+        return (current_x, current_y)
+    except Exception:
+        return None
+
+def _restore_mouse_position(pos):
+    if not pos:
+        return
+    try:
+        current_x, current_y = pos
+        # Restore mouse position
+        restore_evt = Quartz.CGEventCreateMouseEvent(None, Quartz.kCGEventMouseMoved, (current_x, current_y), Quartz.kCGMouseButtonLeft)
+        Quartz.CGEventPost(Quartz.kCGHIDEventTap, restore_evt)
     except Exception:
         pass
 
 class DockCapture:
-    def __init__(self, orientation: str = "bottom", reveal: bool = True, dwell: float = 0.8):
-        self.orientation = orientation
-        self.reveal = reveal
+    def __init__(self, orientation: str = None, reveal: bool = None, dwell: float = 0.8):
+        self.orientation = orientation or get_dock_orientation()
+        self.reveal = reveal if reveal is not None else get_dock_autohide()
         self.dwell = dwell
 
     def capture(self, max_depth=None, output_screenshot_dir=None):
         store_screen_scaling_factor()
 
+        original_mouse_pos = None
         if self.reveal:
-            _reveal_dock_temporarily(self.orientation, dwell=self.dwell)
-
-        dock_ax = apps.dock_ax_application()
-
-        x_tl, y_tl, w, h = _dock_tl_rect_fixed(self.orientation)
-
-        dock_root = UIElement(
-            dock_ax,
-            offset_x=x_tl,
-            offset_y=y_tl,
-            max_depth=max_depth,
-            parents_visible_bbox=[0, 0, w, h],
-        )
-        dock_root.app_name = "Dock"
-        dock_root.window_screen_rect = [x_tl, y_tl, x_tl + w, y_tl + h]
-
-        extract_window(
-            dock_root, "com.apple.dock", None,
-            perform_hit_test=False, print_nodes=False, max_depth=max_depth
-        )
-        propagate_screen_rect(dock_root, dock_root.window_screen_rect)
-
-        screenshot_info = None
-        if output_screenshot_dir:
-            os.makedirs(output_screenshot_dir, exist_ok=True)
-
-            full_path = os.path.join(output_screenshot_dir, "dock_full.png")
-            capture_full_screen(full_path)
-
-            crop_path = full_path.replace(".png", "_cropped.png")
-            from macapptree.screenshot_app_window import crop_screenshot
-            _ = crop_screenshot(full_path, (x_tl, y_tl, w, h), crop_path)
-
-            segmented_path = segment_window_components(dock_root, crop_path) or crop_path
-            screenshot_info = {
-                "app": "com.apple.dock",
-                "window_name": "Dock",
-                "cropped_screenshot_path": crop_path,
-                "segmented_screenshot_path": segmented_path,
-            }
-
-        return dock_root, screenshot_info
+            original_mouse_pos = _move_mouse_revealing_dock(self.orientation, dwell=self.dwell)
+
+        try:
+            dock_ax = apps.dock_ax_application()
+
+            x_tl, y_tl, w, h = _dock_tl_rect_fixed(self.orientation)
+
+            dock_root = UIElement(
+                dock_ax,
+                offset_x=x_tl,
+                offset_y=y_tl,
+                max_depth=max_depth,
+                parents_visible_bbox=[0, 0, w, h],
+            )
+            dock_root.app_name = "Dock"
+            dock_root.window_screen_rect = [x_tl, y_tl, x_tl + w, y_tl + h]
+
+            extract_window(
+                dock_root, "com.apple.dock", None,
+                perform_hit_test=False, print_nodes=False, max_depth=max_depth
+            )
+            propagate_screen_rect(dock_root, dock_root.window_screen_rect)
+
+            screenshot_info = None
+            if output_screenshot_dir:
+                os.makedirs(output_screenshot_dir, exist_ok=True)
+
+                full_path = os.path.join(output_screenshot_dir, "dock_full.png")
+                capture_full_screen(full_path)
+
+                crop_path = full_path.replace(".png", "_cropped.png")
+                from macapptree.screenshot_app_window import crop_screenshot
+                _ = crop_screenshot(full_path, (x_tl, y_tl, w, h), crop_path)
+
+                segmented_path = segment_window_components(dock_root, crop_path) or crop_path
+                screenshot_info = {
+                    "app": "com.apple.dock",
+                    "window_name": "Dock",
+                    "cropped_screenshot_path": crop_path,
+                    "segmented_screenshot_path": segmented_path,
+                }
+
+            return dock_root, screenshot_info
+        finally:
+            if original_mouse_pos:
+                _restore_mouse_position(original_mouse_pos)

macapptree/main.py

@@ -1,24 +1,33 @@
-import AppKit
-import ApplicationServices
 import argparse
 import json
 import os
 import time
-from PIL import ImageGrab, Image, ImageDraw, ImageFont
 
-from macapptree.apps import get_visible_windows_for_bundles
+import AppKit
+import ApplicationServices
+from PIL import Image, ImageDraw, ImageFont
+
 import macapptree.apps as apps
-from macapptree.window_tools import store_screen_scaling_factor, segment_window_components
-from macapptree.uielement import UIElement, element_attribute, element_value
+from macapptree.dock_utils import DockCapture
 from macapptree.extractor import extract_window
-from macapptree.screenshot_app_window import screenshot_window_to_file, capture_full_screen, rect_subtract
-from macapptree.uielement import _flatten_ui_elements
-from macapptree.window_tools import propagate_screen_rect, _iou, _build_global_visible_index
-
 from macapptree.menu_bar_utils import MenuBarCapture
-from macapptree.dock_utils import DockCapture
-
-
+from macapptree.screenshot_app_window import (
+    capture_full_screen,
+    screenshot_window_to_file,
+)
+from macapptree.uielement import (
+    UIElement,
+    _flatten_ui_elements,
+    element_attribute,
+    element_value,
+)
+from macapptree.window_tools import (
+    _build_global_visible_index,
+    _iou,
+    propagate_screen_rect,
+    segment_window_components,
+    store_screen_scaling_factor,
+)
 
 
 def get_window_rect(window):
@@ -226,7 +235,7 @@ def main(app_bundles, output_accessibility_file, output_screenshot_dir, max_dept
 
     if include_dock:
         print("Processing Dock…")
-        dock = DockCapture(orientation="bottom", reveal=True, dwell=0.8)
+        dock = DockCapture(dwell=0.8)
 
         dock_root, dock_shots = dock.capture(max_depth, output_screenshot_dir)
         if dock_root:

macapptree/scale_utils.py

@@ -0,0 +1,32 @@
+"""
+Utility functions for image scaling calculations.
+
+This module is intentionally dependency-free (no imports from window_tools
+or screenshot_app_window) to avoid circular import issues.
+"""
+import AppKit
+
+
+def get_image_scale_factor(image_width_px: int, target_width_points: float, eps: float = 0.1) -> float:
+    """
+    Detects if an image is 1x or 2x (Retina) by comparing its pixel width
+    to the target object's logical point width.
+
+    Args:
+        image_width_px: The width of the image in pixels.
+        target_width_points: The expected width of the target in logical points.
+        eps: Tolerance for ratio comparison (default 0.1).
+
+    Returns:
+        The detected scale factor (1.0 or 2.0), or the system's
+        backingScaleFactor as a fallback.
+    """
+    if target_width_points > 0:
+        ratio = image_width_px / target_width_points
+        if abs(ratio - 1.0) < eps:
+            return 1.0
+        elif abs(ratio - 2.0) < eps:
+            return 2.0
+
+    # Fallback to system scale factor if target dimensions are invalid
+    return AppKit.NSScreen.mainScreen().backingScaleFactor()