-
-
Notifications
You must be signed in to change notification settings - Fork 426
Expand file tree
/
Copy pathXcodeInspector.swift
More file actions
488 lines (430 loc) · 18.7 KB
/
XcodeInspector.swift
File metadata and controls
488 lines (430 loc) · 18.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
import AppKit
import AsyncAlgorithms
import AXExtension
import Combine
import Foundation
import Logger
import Perception
import Preferences
import SuggestionBasic
import SwiftNavigation
import Toast
public extension Notification.Name {
static let accessibilityAPIMalfunctioning = Notification
.Name("XcodeInspector.accessibilityAPIMalfunctioning")
static let activeApplicationDidChange = Notification
.Name("XcodeInspector.activeApplicationDidChange")
static let previousActiveApplicationDidChange = Notification
.Name("XcodeInspector.previousActiveApplicationDidChange")
static let activeXcodeDidChange = Notification
.Name("XcodeInspector.activeXcodeDidChange")
static let latestActiveXcodeDidChange = Notification
.Name("XcodeInspector.latestActiveXcodeDidChange")
static let xcodesDidChange = Notification.Name("XcodeInspector.xcodesDidChange")
static let activeProjectRootURLDidChange = Notification
.Name("XcodeInspector.activeProjectRootURLDidChange")
static let activeDocumentURLDidChange = Notification
.Name("XcodeInspector.activeDocumentURLDidChange")
static let activeWorkspaceURLDidChange = Notification
.Name("XcodeInspector.activeWorkspaceURLDidChange")
static let focusedWindowDidChange = Notification
.Name("XcodeInspector.focusedWindowDidChange")
static let focusedEditorDidChange = Notification
.Name("XcodeInspector.focusedEditorDidChange")
static let focusedElementDidChange = Notification
.Name("XcodeInspector.focusedElementDidChange")
static let completionPanelDidChange = Notification
.Name("XcodeInspector.completionPanelDidChange")
static let xcodeWorkspacesDidChange = Notification
.Name("XcodeInspector.xcodeWorkspacesDidChange")
}
@globalActor
public enum XcodeInspectorActor: GlobalActor {
public actor Actor {}
public static let shared = Actor()
}
@XcodeInspectorActor
@Perceptible
public final class XcodeInspector: Sendable {
public final class PerceptionObserver: Sendable {
public struct Cancellable {
let token: ObserveToken
public func cancel() {
token.cancel()
}
}
final class Object: NSObject, Sendable {}
let object = Object()
@MainActor
@discardableResult public func observe(
_ block: @Sendable @escaping @MainActor () -> Void
) -> Cancellable {
let token = object.observe { block() }
return Cancellable(token: token)
}
}
public nonisolated static func createObserver() -> PerceptionObserver {
PerceptionObserver()
}
public nonisolated static let shared = XcodeInspector()
private var toast: ToastController { ToastControllerDependencyKey.liveValue }
@PerceptionIgnored private var activeXcodeObservations = Set<Task<Void, Error>>()
@PerceptionIgnored private var appChangeObservations = Set<Task<Void, Never>>()
@MainActor
public fileprivate(set) var activeApplication: AppInstanceInspector? {
didSet {
NotificationCenter.default.post(name: .activeApplicationDidChange, object: nil)
}
}
@MainActor
public fileprivate(set) var previousActiveApplication: AppInstanceInspector? {
didSet {
NotificationCenter.default.post(name: .previousActiveApplicationDidChange, object: nil)
}
}
@MainActor
public fileprivate(set) var activeXcode: XcodeAppInstanceInspector? {
didSet {
NotificationCenter.default.post(name: .activeXcodeDidChange, object: nil)
NotificationCenter.default.post(name: .focusedWindowDidChange, object: nil)
NotificationCenter.default.post(name: .activeDocumentURLDidChange, object: self)
NotificationCenter.default.post(name: .activeWorkspaceURLDidChange, object: self)
NotificationCenter.default.post(name: .activeProjectRootURLDidChange, object: self)
NotificationCenter.default.post(name: .completionPanelDidChange, object: self)
NotificationCenter.default.post(name: .xcodeWorkspacesDidChange, object: self)
}
}
@MainActor
public fileprivate(set) var latestActiveXcode: XcodeAppInstanceInspector? {
didSet {
_nonIsolatedLatestActiveXcode = latestActiveXcode
NotificationCenter.default.post(name: .latestActiveXcodeDidChange, object: nil)
}
}
@MainActor
public fileprivate(set) var xcodes: [XcodeAppInstanceInspector] = [] {
didSet {
NotificationCenter.default.post(name: .xcodesDidChange, object: nil)
}
}
@MainActor
public var activeProjectRootURL: URL? {
(activeXcode ?? latestActiveXcode)?.projectRootURL
}
@MainActor
public var activeDocumentURL: URL? {
(activeXcode ?? latestActiveXcode)?.documentURL
}
@MainActor
public var activeWorkspaceURL: URL? {
(activeXcode ?? latestActiveXcode)?.workspaceURL
}
@MainActor
public var focusedWindow: XcodeWindowInspector? {
(activeXcode ?? latestActiveXcode)?.focusedWindow
}
@MainActor
public var completionPanel: AXUIElement? {
(activeXcode ?? latestActiveXcode)?.completionPanel
}
@MainActor
public fileprivate(set) var focusedEditor: SourceEditor? {
didSet {
NotificationCenter.default.post(name: .focusedEditorDidChange, object: nil)
}
}
@MainActor
public fileprivate(set) var latestFocusedEditor: SourceEditor?
@MainActor
public fileprivate(set) var focusedElement: AXUIElement? {
didSet {
NotificationCenter.default.post(name: .focusedElementDidChange, object: nil)
}
}
/// Get the content of the source editor.
///
/// - note: This method is expensive. It needs to convert index based ranges to line based
/// ranges.
public func getFocusedEditorContent() async -> EditorInformation? {
guard let documentURL = realtimeActiveDocumentURL,
let workspaceURL = realtimeActiveWorkspaceURL,
let projectURL = realtimeActiveProjectURL
else { return nil }
let editorContent = await latestFocusedEditor?.getContent()
let language = languageIdentifierFromFileURL(documentURL)
let relativePath = documentURL.path.replacingOccurrences(of: projectURL.path, with: "")
if let editorContent, let range = editorContent.selections.first {
let (selectedContent, selectedLines) = EditorInformation.code(
in: editorContent.lines,
inside: range
)
return .init(
editorContent: editorContent,
selectedContent: selectedContent,
selectedLines: selectedLines,
documentURL: documentURL,
workspaceURL: workspaceURL,
projectRootURL: projectURL,
relativePath: relativePath,
language: language
)
}
return .init(
editorContent: editorContent,
selectedContent: "",
selectedLines: [],
documentURL: documentURL,
workspaceURL: workspaceURL,
projectRootURL: projectURL,
relativePath: relativePath,
language: language
)
}
@PerceptionIgnored
private nonisolated(unsafe) var _nonIsolatedLatestActiveXcode: XcodeAppInstanceInspector?
public nonisolated var realtimeActiveDocumentURL: URL? {
_nonIsolatedLatestActiveXcode?.realtimeDocumentURL
}
public nonisolated var realtimeActiveWorkspaceURL: URL? {
_nonIsolatedLatestActiveXcode?.realtimeWorkspaceURL
}
public nonisolated var realtimeActiveProjectURL: URL? {
_nonIsolatedLatestActiveXcode?.realtimeProjectURL
}
nonisolated init() {
AXUIElement.setGlobalMessagingTimeout(3)
Task { await restart() }
}
public func restart(cleanUp: Bool = false) async {
if cleanUp {
activeXcodeObservations.forEach { $0.cancel() }
activeXcodeObservations.removeAll()
await MainActor.run {
self.activeXcode = nil
latestActiveXcode = nil
activeApplication = nil
focusedEditor = nil
latestFocusedEditor = nil
focusedElement = nil
}
}
let runningApplications = NSWorkspace.shared.runningApplications
await MainActor.run {
xcodes = runningApplications
.filter { $0.isXcode }
.map(XcodeAppInstanceInspector.init(runningApplication:))
let activeXcode = xcodes.first(where: \.isActive)
latestActiveXcode = activeXcode ?? xcodes.first
activeApplication = activeXcode ?? runningApplications
.first(where: \.isActive)
.map(AppInstanceInspector.init(runningApplication:))
self.activeXcode = activeXcode
}
appChangeObservations.forEach { $0.cancel() }
appChangeObservations.removeAll()
let appChangeTask = Task(priority: .utility) { [weak self] in
guard let self else { return }
if let activeXcode = await self.activeXcode {
await setActiveXcode(activeXcode)
}
await withThrowingTaskGroup(of: Void.self) { [weak self] group in
group.addTask { [weak self] in // Did activate app
let sequence = NSWorkspace.shared.notificationCenter
.notifications(named: NSWorkspace.didActivateApplicationNotification)
for await notification in sequence {
try Task.checkCancellation()
guard let self else { return }
guard let app = notification
.userInfo?[NSWorkspace.applicationUserInfoKey] as? NSRunningApplication
else { continue }
if app.isXcode {
if let existed = await self.xcodes.first(where: {
$0.processIdentifier == app.processIdentifier && !$0.isTerminated
}) {
Task {
await self.setActiveXcode(existed)
}
} else {
let new = XcodeAppInstanceInspector(runningApplication: app)
Task { @MainActor in
self.xcodes.append(new)
await self.setActiveXcode(new)
}
}
} else {
let appInspector = AppInstanceInspector(runningApplication: app)
Task { @MainActor in
self.previousActiveApplication = self.activeApplication
self.activeApplication = appInspector
}
}
}
}
group.addTask { [weak self] in // Did terminate app
let sequence = NSWorkspace.shared.notificationCenter
.notifications(named: NSWorkspace.didTerminateApplicationNotification)
for await notification in sequence {
try Task.checkCancellation()
guard let self else { return }
guard let app = notification
.userInfo?[NSWorkspace.applicationUserInfoKey] as? NSRunningApplication
else { continue }
if app.isXcode {
let processIdentifier = app.processIdentifier
Task { @MainActor in
self.xcodes.removeAll {
$0.processIdentifier == processIdentifier || $0.isTerminated
}
if self.latestActiveXcode?.runningApplication
.processIdentifier == processIdentifier
{
self.latestActiveXcode = nil
}
if let activeXcode = self.xcodes.first(where: \.isActive) {
await self.setActiveXcode(activeXcode)
}
}
}
}
}
if UserDefaults.shared
.value(for: \.restartXcodeInspectorIfAccessibilityAPIIsMalfunctioning)
{
group.addTask { [weak self] in
while true {
guard let self else { return }
if UserDefaults.shared.value(
for: \.restartXcodeInspectorIfAccessibilityAPIIsMalfunctioningNoTimer
) {
return
}
try await Task.sleep(nanoseconds: 10_000_000_000)
Task {
await self.checkForAccessibilityMalfunction("Timer")
}
}
}
}
group.addTask { [weak self] in // malfunctioning
let sequence = NotificationCenter.default
.notifications(named: .accessibilityAPIMalfunctioning)
for await notification in sequence {
try Task.checkCancellation()
guard let self else { return }
await self
.recoverFromAccessibilityMalfunctioning(notification.object as? String)
}
}
}
}
appChangeObservations.insert(appChangeTask)
}
public func reactivateObservationsToXcode() async {
if let activeXcode = await activeXcode {
await setActiveXcode(activeXcode)
activeXcode.observeAXNotifications()
}
}
private func setActiveXcode(_ xcode: XcodeAppInstanceInspector) async {
await MainActor.run {
previousActiveApplication = activeApplication
activeApplication = xcode
}
xcode.refresh()
for task in activeXcodeObservations { task.cancel() }
activeXcodeObservations.removeAll()
await MainActor.run {
activeXcode = xcode
latestActiveXcode = xcode
}
let setFocusedElement = { [weak self] in
guard let self else { return }
await MainActor.run {
self.focusedElement = xcode.appElement.focusedElement
if let editorElement = self.focusedElement, editorElement.isSourceEditor {
self.focusedEditor = .init(
runningApplication: xcode.runningApplication,
element: editorElement
)
self.latestFocusedEditor = self.focusedEditor
} else if let element = self.focusedElement,
let editorElement = element.firstParent(where: \.isSourceEditor)
{
self.focusedEditor = .init(
runningApplication: xcode.runningApplication,
element: editorElement
)
self.latestFocusedEditor = self.focusedEditor
} else {
self.focusedEditor = nil
}
}
}
await setFocusedElement()
let focusedElementChanged = Task {
for await notification in await xcode.axNotifications.notifications() {
if notification.kind == .focusedUIElementChanged {
try Task.checkCancellation()
await setFocusedElement()
}
}
}
activeXcodeObservations.insert(focusedElementChanged)
if UserDefaults.shared
.value(for: \.restartXcodeInspectorIfAccessibilityAPIIsMalfunctioning)
{
let malfunctionCheck = Task { [weak self] in
if #available(macOS 13.0, *) {
let notifications = await xcode.axNotifications.notifications().filter {
$0.kind == .uiElementDestroyed
}.debounce(for: .milliseconds(1000))
for await _ in notifications {
guard let self else { return }
try Task.checkCancellation()
await self.checkForAccessibilityMalfunction("Element Destroyed")
}
}
}
activeXcodeObservations.insert(malfunctionCheck)
await checkForAccessibilityMalfunction("Reactivate Xcode")
}
}
private var lastRecoveryFromAccessibilityMalfunctioningTimeStamp = Date()
private func checkForAccessibilityMalfunction(_ source: String) async {
guard Date().timeIntervalSince(lastRecoveryFromAccessibilityMalfunctioningTimeStamp) > 5
else { return }
if let editor = await focusedEditor, !editor.element.isSourceEditor {
NotificationCenter.default.post(
name: .accessibilityAPIMalfunctioning,
object: "Source Editor Element Corrupted: \(source)"
)
} else if let element = await activeXcode?.appElement.focusedElement {
let focusedElement = await focusedElement
if element.description != focusedElement?.description ||
element.role != focusedElement?.role
{
NotificationCenter.default.post(
name: .accessibilityAPIMalfunctioning,
object: "Element Inconsistency: \(source)"
)
}
}
}
private func recoverFromAccessibilityMalfunctioning(_ source: String?) async {
let message = """
Accessibility API malfunction detected: \
\(source ?? "").
Resetting active Xcode.
"""
if UserDefaults.shared.value(for: \.toastForTheReasonWhyXcodeInspectorNeedsToBeRestarted) {
toast.toast(content: message, type: .warning)
} else {
Logger.service.info(message)
}
if let activeXcode = await activeXcode {
lastRecoveryFromAccessibilityMalfunctioningTimeStamp = Date()
await setActiveXcode(activeXcode)
activeXcode.observeAXNotifications()
}
}
}