Fix that searching for tabs in Xcode cause Xcode to have performance issue

Author: intitni

Tool/Sources/AXExtension/AXUIElement.swift

@@ -21,7 +21,7 @@ public extension AXUIElement {
     var value: String {
         (try? copyValue(key: kAXValueAttribute)) ?? ""
     }
-    
+
     var intValue: Int? {
         (try? copyValue(key: kAXValueAttribute))
     }
@@ -134,7 +134,7 @@ public extension AXUIElement {
     var isFullScreen: Bool {
         (try? copyValue(key: "AXFullScreen")) ?? false
     }
-    
+
     var isFrontmost: Bool {
         (try? copyValue(key: kAXFrontmostAttribute)) ?? false
     }
@@ -191,6 +191,16 @@ public extension AXUIElement {
         return nil
     }
 
+    /// Get children that match the requirement
+    ///
+    /// - important: If the element has a lot of descendant nodes, it will heavily affect the
+    /// **performance of Xcode**. Please make use ``AXUIElement\traverse(_:)`` instead.
+    @available(
+        *,
+        deprecated,
+        renamed: "traverse(_:)",
+        message: "Please make use ``AXUIElement\traverse(_:)`` instead."
+    )
     func children(where match: (AXUIElement) -> Bool) -> [AXUIElement] {
         var all = [AXUIElement]()
         for child in children {
@@ -233,6 +243,52 @@ public extension AXUIElement {
     }
 }
 
+public extension AXUIElement {
+    enum SearchNextStep {
+        case skipDescendants
+        case skipSiblings
+        case skipDescendantsAndSiblings
+        case continueSearching
+        case stopSearching
+    }
+
+    /// Traversing the element tree.
+    ///
+    /// - important: Traversing the element tree is resource consuming and will affect the
+    /// **performance of Xcode**. Please make sure to skip as much as possible.
+    ///
+    /// - todo: Make it not recursive.
+    func traverse(_ handle: (_ element: AXUIElement, _ level: Int) -> SearchNextStep) {
+        func _traverse(
+            element: AXUIElement,
+            level: Int,
+            handle: (AXUIElement, Int) -> SearchNextStep
+        ) -> SearchNextStep {
+            let nextStep = handle(element, level)
+            switch nextStep {
+            case .stopSearching: return .stopSearching
+            case .skipDescendants: return .continueSearching
+            case .skipDescendantsAndSiblings: return .skipSiblings
+            case .continueSearching, .skipSiblings:
+                for child in element.children {
+                    switch _traverse(element: child, level: level + 1, handle: handle) {
+                    case .skipSiblings, .skipDescendantsAndSiblings:
+                        break
+                    case .stopSearching:
+                        return .stopSearching
+                    case .continueSearching, .skipDescendants:
+                        continue
+                    }
+                }
+
+                return nextStep
+            }
+        }
+
+        _ = _traverse(element: self, level: 0, handle: handle)
+    }
+}
+
 // MARK: - Helper
 
 public extension AXUIElement {

Tool/Sources/XcodeInspector/Apps/XcodeAppInstanceInspector.swift

@@ -353,16 +353,21 @@ extension XcodeAppInstanceInspector {
 
         for window in windows {
             let workspaceIdentifier = workspaceIdentifier(window)
+            var traverseCount = 0
 
             let tabs = {
                 guard let editArea = window.firstChild(where: { $0.description == "editor area" })
                 else { return Set<String>() }
                 var allTabs = Set<String>()
-                let tabBars = editArea.children { $0.description == "tab bar" }
+                let tabBars = editArea.tabBars
                 for tabBar in tabBars {
-                    let tabs = tabBar.children { $0.roleDescription == "tab" }
-                    for tab in tabs {
-                        allTabs.insert(tab.title)
+                    tabBar.traverse { element, _ in
+                        traverseCount += 1
+                        if element.roleDescription == "tab" {
+                            allTabs.insert(element.title)
+                            return .skipDescendants
+                        }
+                        return .continueSearching
                     }
                 }
                 return allTabs
@@ -416,3 +421,54 @@ private func isCompletionPanel(_ element: AXUIElement) -> Bool {
     return matchXcode16CompletionPanel
 }
 
+public extension AXUIElement {
+    var tabBars: [AXUIElement] {
+        // Searching by traversing with AXUIElement is (Xcode) resource consuming, we should skip
+        // as much as possible!
+        
+        guard let editArea: AXUIElement = {
+            if description == "editor area" { return self }
+            return firstChild(where: { $0.description == "editor area" })
+        }() else { return [] }
+        
+        var tabBars = [AXUIElement]()
+        editArea.traverse { element, _ in
+            let description = element.description
+            if description == "Tab Bar" {
+                element.traverse { element, _ in
+                    if element.description == "tab bar" {
+                        tabBars.append(element)
+                        return .stopSearching
+                    }
+                    return .continueSearching
+                }
+
+                return .skipDescendantsAndSiblings
+            }
+            
+            if element.identifier == "editor context" {
+                return .skipDescendantsAndSiblings
+            }
+
+            if element.isSourceEditor {
+                return .skipDescendantsAndSiblings
+            }
+
+            if description == "Code Coverage Ribbon" {
+                return .skipDescendants
+            }
+
+            if description == "Debug Area" {
+                return .skipDescendants
+            }
+            
+            if description == "debug bar" {
+                return .skipDescendants
+            }
+
+            return .continueSearching
+        }
+
+        return tabBars
+    }
+}