Markup for Sendable

rustle · Nov 16, 2023 · 6546e4a · 6546e4a
1 parent 8385321
commit 6546e4a
Show file tree

Hide file tree

Showing 15 changed files with 47 additions and 124 deletions.
diff --git a/Package.swift b/Package.swift
@@ -21,7 +21,7 @@ let package = Package(
             from: "0.1.10"),
         .package(
             url: "https://github.com/rustle/TargetAction.git",
-            from: "0.1.0"),
+            from: "0.1.1"),
     ],
     targets: [
         .target(

diff --git a/Sources/ScreenReader/ArrayObserver.swift b/Sources/ScreenReader/ArrayObserver.swift
@@ -83,13 +83,15 @@ public enum ArrayChange<Element>: Equatable where Element: Equatable {
     }
 }
 
+extension ArrayChange: Sendable where Element: Sendable {}
+
 /// Repackage KVO updates to an observable array
 public final class ArrayObserver<Root, Element> where Root: NSObject, Element: Equatable {
     private let observer: NSKeyValueObservation
     init(
         root: Root,
         keypath: KeyPath<Root, [Element]>,
-        changeHandler: @escaping (ArrayChange<Element>) -> Void
+        changeHandler: @escaping @Sendable (ArrayChange<Element>) -> Void
     ) {
         observer = root.observe(
             keypath,

diff --git a/Sources/ScreenReader/Concurrency/AsyncSequence.swift b/Sources/ScreenReader/Concurrency/AsyncSequence.swift
diff --git a/Sources/ScreenReader/ControllerHierarchy.swift b/Sources/ScreenReader/ControllerHierarchy.swift
@@ -8,13 +8,13 @@ import AccessibilityElement
 import Foundation
 import os
 
-public typealias ControllerFactory<ObserverType: AccessibilityElement.Observer> = (
+public typealias ControllerFactory<ObserverType: AccessibilityElement.Observer> = @Sendable (
     ObserverType.ObserverElement,
     AsyncStream<Output.Job>.Continuation,
     ApplicationObserver<ObserverType>
 ) async throws -> Controller where ObserverType.ObserverElement: Hashable
 
-actor ControllerHierarchy<ObserverType: AccessibilityElement.Observer> where ObserverType.ObserverElement: Hashable {
+public actor ControllerHierarchy<ObserverType: AccessibilityElement.Observer> where ObserverType.ObserverElement: Hashable {
     typealias ElementType = ObserverType.ObserverElement
     private struct ControllerContext {
         let task: Task<Void, any Error>?
@@ -28,7 +28,7 @@ actor ControllerHierarchy<ObserverType: AccessibilityElement.Observer> where Obs
     private let controllerFactory: ControllerFactory<ObserverType>
     private let observer: ApplicationObserver<ObserverType>
     private var observerTasks: Set<Task<Void, any Error>> = .init()
-    init(
+    public init(
         application: Application<ObserverType>,
         observer: ApplicationObserver<ObserverType>,
         controllerFactory: @escaping ControllerFactory<ObserverType>
@@ -39,7 +39,7 @@ actor ControllerHierarchy<ObserverType: AccessibilityElement.Observer> where Obs
     }
     private func uiElementDestroyed(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(element)")
         guard let context = controllers.removeValue(forKey: element) else { return }
@@ -135,10 +135,10 @@ actor ControllerHierarchy<ObserverType: AccessibilityElement.Observer> where Obs
             element: element,
             notification: .uiElementDestroyed
         )
-        let action = target(action: ControllerHierarchy<ObserverType>.uiElementDestroyed)
+        let target = target(uncheckedAction: ControllerHierarchy<ObserverType>.uiElementDestroyed)
         let task: Task<Void, any Error> = Task(priority: .userInitiated) {
             for try await notification in stream {
-                await action(
+                await target(
                     notification.element,
                     notification.info
                 )

diff --git a/Sources/ScreenReader/Controllers/Application.swift b/Sources/ScreenReader/Controllers/Application.swift
@@ -72,7 +72,7 @@ public actor Application<ObserverType: Observer>: Controller where ObserverType.
                 observer: observer,
                 element: element,
                 notification: .windowCreated,
-                handler: target(action: Application.windowCreated)
+                handler: target(uncheckedAction: Application.windowCreated)
             ))
         } catch let error as ControllerObserverError {
             logger.debug("\(error.localizedDescription)")
@@ -84,7 +84,7 @@ public actor Application<ObserverType: Observer>: Controller where ObserverType.
                 observer: observer,
                 element: element,
                 notification: .focusedWindowChanged,
-                handler: target(action: Application.focusedWindowChanged)
+                handler: target(uncheckedAction: Application.focusedWindowChanged)
             ))
         } catch let error as ControllerObserverError {
             logger.debug("\(error.localizedDescription)")
@@ -130,7 +130,7 @@ public actor Application<ObserverType: Observer>: Controller where ObserverType.
     }
     private func windowCreated(
         window: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(window)")
         do {
@@ -141,7 +141,7 @@ public actor Application<ObserverType: Observer>: Controller where ObserverType.
     }
     private func focusedWindowChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(element)")
         do {
@@ -152,7 +152,7 @@ public actor Application<ObserverType: Observer>: Controller where ObserverType.
     }
     private func focusedUIElementChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(element.description)")
         do {
@@ -181,6 +181,7 @@ public actor Application<ObserverType: Observer>: Controller where ObserverType.
 }
 
 extension Application {
+    @Sendable
     fileprivate static func controller(
         element: ElementType,
         output: AsyncStream<Output.Job>.Continuation,

diff --git a/Sources/ScreenReader/Controllers/Button.swift b/Sources/ScreenReader/Controllers/Button.swift
@@ -39,7 +39,7 @@ public actor Button<ObserverType: Observer>: Controller where ObserverType.Obser
         do {
             observerTasks.append(try await add(
                 notification: .valueChanged,
-                handler: target(action: Button<ObserverType>.valueChanged)
+                handler: target(uncheckedAction: Button<ObserverType>.valueChanged)
             ))
         } catch let error as ControllerObserverError {
             logger.info("\(error.localizedDescription)")
@@ -59,7 +59,7 @@ public actor Button<ObserverType: Observer>: Controller where ObserverType.Obser
     }
     private func valueChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(element)")
     }

diff --git a/Sources/ScreenReader/Controllers/Controller.swift b/Sources/ScreenReader/Controllers/Controller.swift
@@ -49,11 +49,12 @@ enum RunState {
 }
 
 extension Controller {
+    @Sendable
     static func add<ObserverType: Observer>(
         observer: ApplicationObserver<ObserverType>,
         element: ObserverType.ObserverElement,
         notification: NSAccessibility.Notification,
-        handler: @escaping (ObserverType.ObserverElement, [String:Any]?) async -> Void
+        handler: @escaping @Sendable (ObserverType.ObserverElement, [String:Sendable]?) async -> Void
     ) async throws -> Task<Void, any Error> {
         do {
             let stream = try await observer.stream(

diff --git a/Sources/ScreenReader/Controllers/List.swift b/Sources/ScreenReader/Controllers/List.swift
@@ -39,7 +39,7 @@ public actor List<ObserverType: Observer>: Controller where ObserverType.Observe
         do {
             observerTasks.append(try await add(
                 notification: .selectedChildrenChanged,
-                handler: target(action: List<ObserverType>.selectedChildrenChanged)
+                handler: target(uncheckedAction: List<ObserverType>.selectedChildrenChanged)
             ))
         } catch let error as ControllerObserverError {
             logger.info("\(error.localizedDescription)")
@@ -88,7 +88,7 @@ public actor List<ObserverType: Observer>: Controller where ObserverType.Observe
     }
     private func selectedChildrenChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(self.element)")
         do {

diff --git a/Sources/ScreenReader/Controllers/ObserverHosting.swift b/Sources/ScreenReader/Controllers/ObserverHosting.swift
@@ -12,16 +12,18 @@ protocol ObserverHosting: Controller {
     typealias ElementType = ObserverType.ObserverElement
     var element: ElementType { get }
     var observer: ApplicationObserver<ObserverType> { get }
+    @Sendable
     func add(
         notification: NSAccessibility.Notification,
-        handler: @escaping (ElementType, [String:Any]?) async -> Void
+        handler: @escaping @Sendable (ElementType, [String:Sendable]?) async -> Void
     ) async throws -> Task<Void, any Error>
 }
 
 extension ObserverHosting {
+    @Sendable
     func add(
         notification: NSAccessibility.Notification,
-        handler: @escaping (ElementType, [String:Any]?) async -> Void
+        handler: @escaping @Sendable (ElementType, [String:Sendable]?) async -> Void
     ) async throws -> Task<Void, any Error> {
         try await Self.add(
             observer: observer,

diff --git a/Sources/ScreenReader/Controllers/Table.swift b/Sources/ScreenReader/Controllers/Table.swift
@@ -39,11 +39,11 @@ public actor Table<ObserverType: Observer>: Controller where ObserverType.Observ
         guard runState == .stopped else { return }
         try await _add(
             notification: .selectedRowsChanged,
-            handler: target(action: Table<ObserverType>.selectionChanged)
+            handler: target(uncheckedAction: Table<ObserverType>.selectionChanged)
         )
         try await _add(
             notification: .selectedColumnsChanged,
-            handler: target(action: Table<ObserverType>.selectionChanged)
+            handler: target(uncheckedAction: Table<ObserverType>.selectionChanged)
         )
         runState = .running
         await selectionChanged(
@@ -53,7 +53,7 @@ public actor Table<ObserverType: Observer>: Controller where ObserverType.Observ
     }
     private func _add(
         notification: NSAccessibility.Notification,
-        handler: @escaping (ObserverType.ObserverElement, [String : Any]?) async -> Void
+        handler: @escaping @Sendable (ObserverType.ObserverElement, [String:Sendable]?) async -> Void
     ) async throws {
         do {
             observerTasks.append(try await add(
@@ -77,7 +77,7 @@ public actor Table<ObserverType: Observer>: Controller where ObserverType.Observ
     }
     private func selectionChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(self.element)")
         do {

diff --git a/Sources/ScreenReader/Controllers/TextArea.swift b/Sources/ScreenReader/Controllers/TextArea.swift
@@ -40,7 +40,7 @@ public actor TextArea<ObserverType: Observer>: Controller where ObserverType.Obs
         do {
             observerTasks.append(try await add(
                 notification: .valueChanged,
-                handler: target(action: TextArea<ObserverType>.valueChanged)
+                handler: target(uncheckedAction: TextArea<ObserverType>.valueChanged)
             ))
         } catch let error as ControllerObserverError {
             logger.info("\(error.localizedDescription)")
@@ -50,7 +50,7 @@ public actor TextArea<ObserverType: Observer>: Controller where ObserverType.Obs
         do {
             observerTasks.append(try await add(
                 notification: .selectedTextChanged,
-                handler: target(action: TextArea<ObserverType>.selectedTextChanged)
+                handler: target(uncheckedAction: TextArea<ObserverType>.selectedTextChanged)
             ))
         } catch let error as ControllerObserverError {
             logger.info("\(error.localizedDescription)")
@@ -70,13 +70,13 @@ public actor TextArea<ObserverType: Observer>: Controller where ObserverType.Obs
     }
     private func valueChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         //logger.debug("\(self.element)")
     }
     private func selectedTextChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         //logger.debug("\(self.element)")
     }

diff --git a/Sources/ScreenReader/Controllers/TextField.swift b/Sources/ScreenReader/Controllers/TextField.swift
@@ -40,7 +40,7 @@ public actor TextField<ObserverType: Observer>: Controller where ObserverType.Ob
         do {
             observerTasks.append(try await add(
                 notification: .valueChanged,
-                handler: target(action: TextField<ObserverType>.valueChanged)
+                handler: target(uncheckedAction: TextField<ObserverType>.valueChanged)
             ))
         } catch let error as ControllerObserverError {
             logger.info("\(error.localizedDescription)")
@@ -50,7 +50,7 @@ public actor TextField<ObserverType: Observer>: Controller where ObserverType.Ob
         do {
             observerTasks.append(try await add(
                 notification: .selectedTextChanged,
-                handler: target(action: TextField<ObserverType>.selectedTextChanged)
+                handler: target(uncheckedAction: TextField<ObserverType>.selectedTextChanged)
             ))
         } catch let error as ControllerObserverError {
             logger.info("\(error.localizedDescription)")
@@ -96,13 +96,13 @@ public actor TextField<ObserverType: Observer>: Controller where ObserverType.Ob
     }
     private func valueChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(self.element)")
     }
     private func selectedTextChanged(
         element: ElementType,
-        userInfo: [String:Any]?
+        userInfo: [String:Sendable]?
     ) async {
         logger.debug("\(self.element)")
     }