Add XCUIAutomation and XCTest

Fixes #737.

Author: madsmtm

.github/workflows/ci.yml

@@ -277,6 +277,8 @@ objc2-vision = { path = "framework-crates/objc2-vision", version = "0.3.1", defa
 objc2-watch-connectivity = { path = "framework-crates/objc2-watch-connectivity", version = "0.3.1", default-features = false }
 objc2-watch-kit = { path = "framework-crates/objc2-watch-kit", version = "0.3.1", default-features = false }
 objc2-web-kit = { path = "framework-crates/objc2-web-kit", version = "0.3.1", default-features = false }
+objc2-xc-test = { path = "framework-crates/objc2-xc-test", version = "0.3.1", default-features = false }
+objc2-xc-ui-automation = { path = "framework-crates/objc2-xc-ui-automation", version = "0.3.1", default-features = false }
 objc2-itunes-library = { path = "framework-crates/objc2-itunes-library", version = "0.3.1", default-features = false }
 
 # These are useful for examples, since it allows them to be self-contained.
@@ -467,4 +469,6 @@ objc2-vision = { path = "framework-crates/objc2-vision" }
 objc2-watch-connectivity = { path = "framework-crates/objc2-watch-connectivity" }
 objc2-watch-kit = { path = "framework-crates/objc2-watch-kit" }
 objc2-web-kit = { path = "framework-crates/objc2-web-kit" }
+objc2-xc-test = { path = "framework-crates/objc2-xc-test" }
+objc2-xc-ui-automation = { path = "framework-crates/objc2-xc-ui-automation" }
 objc2-itunes-library = { path = "framework-crates/objc2-itunes-library" }

Cargo.lock

@@ -8,6 +8,7 @@ Kerberos = "Too low-level"
 Kernel = "Too low-level"
 PCSC = "Too low-level, consider crates like `pcsc` instead"
 Matter = "Mostly available [here](https://github.com/project-chip/connectedhomeip)"
+Python3 = "Better served by dedicated crates like `pyo3-ffi`"
 
 ForceFeedback = "Very C-centric and old"
 GSS = "Very C-centric and old"
@@ -73,13 +74,14 @@ SwiftUI = "Swift-only"
 SwiftUICore = "Swift-only"
 TabletopKit = "Swift-only"
 TabularData = "Swift-only"
+Testing = "Swift-only"
 TipKit = "Swift-only"
 Translation = "Swift-only"
 TranslationUIProvider = "Swift-only"
 VisionKit = "Swift-only"
 WeatherKit = "Swift-only"
-WorkoutKit = "Swift-only"
 WidgetKit = "Mostly Swift-only"
+WorkoutKit = "Swift-only"
 
 AppleScriptKit = "Basically empty nowadays" # requires !swift
 AppleScriptObjC = "Basically empty nowadays"
@@ -120,6 +122,11 @@ JavaRuntimeSupport = "Probably not really interesting."
 CalendarStore = "Very deprecated" # requires !swift
 CoreMIDIServer = "Very deprecated"
 
+InterfaceBuilderKit = "TODO. Developer-only"
+XcodeKit = "TODO. Developer-only"
+StoreKitTest = "TODO. Developer-only"
+LiveExecutionResultsLogger = "Removed in Xcode 26"
+
 Network = "TODO, see [#646](https://github.com/madsmtm/objc2/issues/646)"
 DeviceDiscoveryUI = "Needs Network first"
 

Cargo.toml

@@ -7,11 +7,25 @@
 //! ```
 use std::fs;
 use std::os::unix::ffi::OsStrExt;
+use std::path::Path;
 use std::{collections::BTreeSet, process::ExitCode};
 
 use apple_sdk::{AppleSdk, DeveloperDirectory, Platform, SimpleSdk};
 use header_translator::{load_config, load_skipped};
 
+fn parse_framework_from_path(path: &Path) -> Option<String> {
+    if path.file_name().unwrap().as_bytes().starts_with(b"_") {
+        // Ignore private/underscored frameworks
+        return None;
+    }
+
+    if path.extension().unwrap() != "framework" {
+        return None;
+    }
+
+    Some(path.file_stem().unwrap().to_string_lossy().into_owned())
+}
+
 fn all_frameworks() -> BTreeSet<String> {
     let developer_dir = DeveloperDirectory::from_env()
         .unwrap()
@@ -28,18 +42,28 @@ fn all_frameworks() -> BTreeSet<String> {
         }
 
         for dir in fs::read_dir(sdk.path().join("System/Library/Frameworks")).unwrap() {
-            let path = dir.unwrap().path();
-
-            if path.file_name().unwrap().as_bytes().starts_with(b"_") {
-                // Ignore private/underscored frameworks
-                continue;
+            if let Some(framework) = parse_framework_from_path(&dir.unwrap().path()) {
+                res.insert(framework);
             }
+        }
+    }
 
-            if path.extension().unwrap() != "framework" {
-                continue;
+    for platform in developer_dir.platforms().unwrap() {
+        if *(platform.as_ref() as &Platform) == Platform::DriverKit {
+            // Ignore DriverKit for now
+            continue;
+        }
+
+        for dir in fs::read_dir(platform.path().join("Developer/Library/Frameworks")).unwrap() {
+            if let Some(framework) = parse_framework_from_path(&dir.unwrap().path()) {
+                res.insert(framework);
             }
+        }
+    }
 
-            res.insert(path.file_stem().unwrap().to_string_lossy().into_owned());
+    for dir in fs::read_dir(developer_dir.path().join("Library/Frameworks")).unwrap() {
+        if let Some(framework) = parse_framework_from_path(&dir.unwrap().path()) {
+            res.insert(framework);
         }
     }
 

crates/header-translator/configs/skipped.toml

@@ -253,6 +253,9 @@ pub struct LibraryConfig {
     #[serde(rename = "is-library")]
     #[serde(default)]
     pub is_library: bool,
+    #[serde(rename = "located-outside-sdk")]
+    #[serde(default)]
+    pub located_outside_sdk: bool,
 
     #[serde(default = "link_default")]
     pub link: bool,
@@ -656,7 +659,10 @@ impl LibraryConfig {
             config.krate.replace("objc2-", "").replace('-', ""),
             "crate name had an unexpected format",
         );
-        if matches!(&*config.krate, "objc2-tv-ml-kit" | "objc2-tv-ui-kit") {
+        if matches!(
+            &*config.krate,
+            "objc2-tv-ml-kit" | "objc2-tv-ui-kit" | "objc2-xc-ui-automation"
+        ) {
             // Named this way for better consistency with other tv-specific crates.
             return Ok(config);
         }

crates/header-translator/src/bin/check_all_frameworks_known.rs

@@ -484,6 +484,24 @@ fn get_translation_unit<'i: 'c, 'c>(
         }
     }
 
+    // Certain developer frameworks like XCTest are found in the platform
+    // path instead of the SDK path.
+    let platform_framework_path = sdk
+        .path
+        .parent()
+        .unwrap()
+        .parent()
+        .unwrap()
+        .join("Library/Frameworks");
+
+    let platform_path = platform_framework_path.join(format!(
+        "{}.framework/Modules/module.modulemap",
+        data.framework
+    ));
+    if data.located_outside_sdk {
+        path = platform_path;
+    }
+
     // Find the framework module name
     let module = if data.modulemap.is_none() {
         let re = regex::Regex::new(r"(?m)^framework +module +(\w*)").unwrap();
@@ -575,6 +593,13 @@ fn get_translation_unit<'i: 'c, 'c>(
         ]);
     }
 
+    if data.located_outside_sdk {
+        arguments.extend(&[
+            "-iframework",
+            platform_framework_path.as_os_str().to_str().unwrap(),
+        ]);
+    }
+
     arguments.extend(data.flags.iter().map(|flag| &**flag));
 
     let tu = index

crates/header-translator/src/config.rs

@@ -102,24 +102,31 @@ impl UnexposedAttr {
             // `nullability` is already exposed, so we won't bother with that.
             // `sendability` is most for backwards-compatibility with older
             // versions of system headers that didn't assign sendability.
-            "NS_HEADER_AUDIT_BEGIN" | "WK_HEADER_AUDIT_BEGIN" => None,
+            "NS_HEADER_AUDIT_BEGIN" | "WK_HEADER_AUDIT_BEGIN" | "XCT_HEADER_AUDIT_BEGIN" => None,
             // Nullability attributes
             s if s.starts_with("DISPATCH_NONNULL") => None,
             s if s.starts_with("XPC_NONNULL") => None,
             "NS_SWIFT_SENDABLE" | "AS_SWIFT_SENDABLE" | "CM_SWIFT_SENDABLE"
-            | "CT_SWIFT_SENDABLE" | "CV_SWIFT_SENDABLE" => Some(Self::Sendable),
+            | "CT_SWIFT_SENDABLE" | "CV_SWIFT_SENDABLE" | "XCT_SWIFT_SENDABLE" => {
+                Some(Self::Sendable)
+            }
             "NS_SWIFT_NONSENDABLE" | "CM_SWIFT_NONSENDABLE" | "CV_SWIFT_NONSENDABLE" => {
                 Some(Self::NonSendable)
             }
-            "NS_SWIFT_UI_ACTOR" | "WK_SWIFT_UI_ACTOR" => Some(Self::UIActor),
+            // The main and UI actor is effectively the same on Apple platforms.
+            "NS_SWIFT_UI_ACTOR"
+            | "WK_SWIFT_UI_ACTOR"
+            | "XCT_SWIFT_MAIN_ACTOR"
+            | "XCUI_SWIFT_MAIN_ACTOR" => Some(Self::UIActor),
             "NS_SWIFT_NONISOLATED" | "UIKIT_SWIFT_ACTOR_INDEPENDENT" => Some(Self::NonIsolated),
             // TODO
             "CF_FORMAT_ARGUMENT" | "CF_FORMAT_FUNCTION" | "NS_FORMAT_FUNCTION"
             | "NS_FORMAT_ARGUMENT" => {
                 let _ = get_arguments();
                 None
             }
-            "CF_NOESCAPE" | "DISPATCH_NOESCAPE" | "NS_NOESCAPE" => Some(Self::NoEscape),
+            "CF_NOESCAPE" | "DISPATCH_NOESCAPE" | "NS_NOESCAPE" | "XCT_NOESCAPE"
+            | "XCUI_NOESCAPE" => Some(Self::NoEscape),
             "DISPATCH_NOTHROW" | "NS_SWIFT_NOTHROW" => Some(Self::NoThrow),
             // TODO: We could potentially automatically elide this argument
             // from the method call, though it's rare enough that it's
@@ -282,7 +289,12 @@ impl UnexposedAttr {
             | "WEBKIT_ENUM_DEPRECATED_MAC"
             | "WK_AVAILABLE_WATCHOS_ONLY"
             | "WK_DEPRECATED_WATCHOS"
-            | "WK_DEPRECATED_WITH_REPLACEMENT" => {
+            | "WK_DEPRECATED_WITH_REPLACEMENT"
+            | "XCT_UNAVAILABLE"
+            | "XCT_DEPRECATED_WITH_REPLACEMENT"
+            | "XCUI_UNAVAILABLE"
+            | "XCUI_DEPRECATED_WITH_REPLACEMENT"
+            | "XCUI_DEPRECATED_WITH_DIRECT_REPLACEMENT" => {
                 let _ = get_arguments();
                 None
             }
@@ -354,7 +366,9 @@ impl UnexposedAttr {
             | "MP_DEPRECATED_BEGIN"
             | "SEC_ASN1_API_DEPRECATED"
             | "SECUREDOWNLOAD_API_DEPRECATED"
-            | "VS_INIT_UNAVAILABLE" => None,
+            | "VS_INIT_UNAVAILABLE"
+            | "XCT_METRIC_API_AVAILABLE"
+            | "XCUI_PROTECTED_RESOURCES_RESET_API_AVAILABLE" => None,
             s if s.starts_with("AVAILABLE_MAC_OS_X_VERSION_") => None,
             s if s.starts_with("DEPRECATED_IN_MAC_OS_X_VERSION_") => None,
             s if s.starts_with("FILEPROVIDER_API_AVAILABILITY_") => None,
@@ -364,6 +378,7 @@ impl UnexposedAttr {
             "swift_name"
             | "CF_SWIFT_NAME"
             | "CF_SWIFT_UNAVAILABLE_FROM_ASYNC"
+            | "XCT_SWIFT_UNAVAILABLE_FROM_ASYNC"
             | "DISPATCH_SWIFT_NAME"
             | "IOSFC_SWIFT_NAME"
             | "MPS_SWIFT_NAME"
@@ -402,6 +417,8 @@ impl UnexposedAttr {
                 let _ = get_arguments();
                 None
             }
+            // Weak imports are still unsupported by Rust.
+            "XCT_WEAK_EXPORT" => None,
             // Irrelevant, we don't emit dispatch_object_t anyhow.
             "DISPATCH_TRANSPARENT_UNION" => None,
             _ => return Err(()),

crates/header-translator/src/main.rs

@@ -179,4 +179,6 @@
 | `WatchConnectivity` | [`objc2-watch-connectivity`](https://crates.io/crates/objc2-watch-connectivity) | [![docs.rs](https://docs.rs/objc2-watch-connectivity/badge.svg)](https://docs.rs/objc2-watch-connectivity/) |
 | `WatchKit` | [`objc2-watch-kit`](https://crates.io/crates/objc2-watch-kit) | [![docs.rs](https://docs.rs/objc2-watch-kit/badge.svg)](https://docs.rs/objc2-watch-kit/) |
 | `WebKit` | [`objc2-web-kit`](https://crates.io/crates/objc2-web-kit) | [![docs.rs](https://docs.rs/objc2-web-kit/badge.svg)](https://docs.rs/objc2-web-kit/) |
+| `XCTest` | [`objc2-xc-test`](https://crates.io/crates/objc2-xc-test) | [![docs.rs](https://docs.rs/objc2-xc-test/badge.svg)](https://docs.rs/objc2-xc-test/) |
+| `XCUIAutomation` | [`objc2-xc-ui-automation`](https://crates.io/crates/objc2-xc-ui-automation) | [![docs.rs](https://docs.rs/objc2-xc-ui-automation/badge.svg)](https://docs.rs/objc2-xc-ui-automation/) |
 | `iTunesLibrary` | [`objc2-itunes-library`](https://crates.io/crates/objc2-itunes-library) | [![docs.rs](https://docs.rs/objc2-itunes-library/badge.svg)](https://docs.rs/objc2-itunes-library/) |