Split into multiple modules to accomodate single-mode bridging changes

Author: marcprux

Package.swift

@@ -7,21 +7,47 @@ let package = Package(
     platforms: [.iOS(.v16), .macOS(.v13), .tvOS(.v16), .watchOS(.v9), .macCatalyst(.v16)],
     products: [
         .library(name: "SkipAndroidBridge", type: .dynamic, targets: ["SkipAndroidBridge"]),
+        .library(name: "SkipAndroidBridgeKt", type: .dynamic, targets: ["SkipAndroidBridgeKt"]),
+        .library(name: "SkipAndroidSDKBridge", type: .dynamic, targets: ["SkipAndroidSDKBridge"]),
     ],
     dependencies: [
-        .package(url: "https://source.skip.tools/skip.git", from: "1.1.16"),
+        .package(url: "https://source.skip.tools/skip.git", branch: "main"),
         .package(url: "https://source.skip.tools/skip-foundation.git", from: "1.0.0"),
         .package(url: "https://source.skip.tools/skip-bridge.git", branch: "main"),
         .package(url: "https://source.skip.tools/swift-android-native.git", branch: "main")
     ],
     targets: [
+        // mode=kotlin
+        .target(name: "SkipAndroidSDKBridge",
+            dependencies: [
+                .product(name: "SkipBridgeKt", package: "skip-bridge"),
+                .product(name: "SkipFoundation", package: "skip-foundation"),
+            ],
+            plugins: [.plugin(name: "skipstone", package: "skip")]),
+        // mode=swift
         .target(name: "SkipAndroidBridge", dependencies: [
-            .product(name: "SkipBridge", package: "skip-bridge"),
-            .product(name: "SkipFoundation", package: "skip-foundation"),
-            .product(name: "AndroidNative", package: "swift-android-native"),
+            "SkipAndroidSDKBridge",
+            .product(name: "AndroidNative", package: "swift-android-native", condition: .when(platforms: [.android])),
+        ], plugins: [.plugin(name: "skipstone", package: "skip")]),
+        // mode=kotlin
+        .target(name: "SkipAndroidBridgeKt",
+            dependencies: [
+                "SkipAndroidBridge",
+            ],
+            plugins: [.plugin(name: "skipstone", package: "skip")]),
+
+        .testTarget(name: "SkipAndroidSDKBridgeTests", dependencies: [
+            "SkipAndroidSDKBridge",
+            .product(name: "SkipTest", package: "skip"),
         ], plugins: [.plugin(name: "skipstone", package: "skip")]),
         .testTarget(name: "SkipAndroidBridgeTests", dependencies: [
             "SkipAndroidBridge",
+            .product(name: "SkipBridgeKt", package: "skip-bridge"),
+            .product(name: "SkipTest", package: "skip"),
+        ], plugins: [.plugin(name: "skipstone", package: "skip")]),
+        .testTarget(name: "SkipAndroidBridgeKtTests", dependencies: [
+            "SkipAndroidBridgeKt",
+            .product(name: "SkipBridgeKt", package: "skip-bridge"),
             .product(name: "SkipTest", package: "skip"),
         ], plugins: [.plugin(name: "skipstone", package: "skip")]),
     ]

README.md

@@ -1,25 +1,19 @@
 # SkipAndroidBridge
 
-This is a free [Skip](https://skip.tools) Swift/Kotlin library project containing the following modules:
 
-SkipAndroidBridge
+```
+ls -la ~/Library/Developer/Xcode/DerivedData/*/SourcePackages/plugins/skipapp-appdroid.output/AppDroid/skipstone/AppDroidModel/src/main/swift/Packages
 
-## Building
+skip-android-bridge -> ~/Library/Developer/Xcode/DerivedData/Skip-Everything-aqywrhrzhkbvfseiqgxuufbdwdft/SourcePackages/plugins/skip-android-bridge.output/SkipAndroidBridge/skipstone/SkipAndroidBridge/src/main/swift
+skip-bridge -> /opt/src/github/skiptools/skip-bridge
+skip-foundation -> /opt/src/github/skiptools/skip-foundation
+skip-lib -> /opt/src/github/skiptools/skip-lib
+skip-model -> /opt/src/github/skiptools/skip-model
+skip-unit -> /opt/src/github/skiptools/skip-unit
+swift-algorithms -> ~/Library/Developer/Xcode/DerivedData/Skip-Everything-aqywrhrzhkbvfseiqgxuufbdwdft/SourcePackages/checkouts/swift-algorithms
+swift-android-native -> /opt/src/github/skiptools/swift-android-native
+swift-numerics -> ~/Library/Developer/Xcode/DerivedData/Skip-Everything-aqywrhrzhkbvfseiqgxuufbdwdft/SourcePackages/checkouts/swift-numerics
+```
 
-This project is a free Swift Package Manager module that uses the
-[Skip](https://skip.tools) plugin to transpile Swift into Kotlin.
 
-Building the module requires that Skip be installed using 
-[Homebrew](https://brew.sh) with `brew install skiptools/skip/skip`.
-This will also install the necessary build prerequisites:
-Kotlin, Gradle, and the Android build tools.
 
-## Testing
-
-The module can be tested using the standard `swift test` command
-or by running the test target for the macOS destination in Xcode,
-which will run the Swift tests as well as the transpiled
-Kotlin JUnit tests in the Robolectric Android simulation environment.
-
-Parity testing can be performed with `skip test`,
-which will output a table of the test results for both platforms.

Sources/SkipAndroidBridge/AndroidBridge.swift

@@ -4,7 +4,9 @@
 // under the terms of the GNU Lesser General Public License 3.0
 // as published by the Free Software Foundation https://fsf.org
 
+#if !SKIP
 import Foundation
+import SkipAndroidSDKBridge
 @_exported import SkipBridge
 #if canImport(FoundationNetworking)
 @_exported import FoundationNetworking
@@ -16,6 +18,7 @@ import Foundation
 #endif
 
 fileprivate let logger: Logger = Logger(subsystem: "SkipAndroidBridge", category: "AndroidBridgeToKotlin")
+#endif
 
 #if os(Android)
 public let isAndroid = true
@@ -26,64 +29,40 @@ public let isAndroid = false
 
 private var androidBridgeInit = false
 
-// SKIP @BridgeToKotlin
 public class AndroidBridgeKotlin {
-    public init() {
-    }
-
-}
-
-/// Perform all the setup that is needed to get `Foundation` idioms working with Android conventions.
-///
-/// This includes:
-/// - Using the Android certificate store for HTTPS validation
-/// - Using the AndroidContext files locations for `FileManager.url`
-// SKIP @BridgeToKotlin
-func initAndroidBridge() throws {
-    if androidBridgeInit == true { return }
-    defer { androidBridgeInit = true }
-
-    let start = Date.now
-    logger.log("initAndroidBridge started")
-    #if os(Android)
-    #if !SKIP
-    try setupFileManagerProperties(context: AndroidContext.shared)
-    try installSystemCertificates()
-    #endif
-    #endif
-    logger.log("initAndroidBridge done in \(Date.now.timeIntervalSince(start))")
-}
-
-
-// URL.applicationSupportDirectory exists in Darwin's Foundation but not in Android's Foundation
-#if os(Android)
-extension URL {
-    public static var applicationSupportDirectory: URL {
-        try! FileManager.default.url(for: .applicationSupportDirectory, in: .userDomainMask, appropriateFor: nil, create: false)
-    }
-    
-    public static var cachesDirectory: URL {
-        try! FileManager.default.url(for: .cachesDirectory, in: .userDomainMask, appropriateFor: nil, create: false)
+    /// Perform all the setup that is needed to get `Foundation` idioms working with Android conventions.
+    ///
+    /// This includes:
+    /// - Using the Android certificate store for HTTPS validation
+    /// - Using the AndroidContext files locations for `FileManager.url`
+    public static func initAndroidBridge() throws {
+        if androidBridgeInit == true { return }
+        defer { androidBridgeInit = true }
+
+        let start = Date.now
+        logger.log("initAndroidBridge started")
+        guard let context = AndroidContext.shared as AndroidContext? else {
+            fatalError("no AndroidContext.shared")
+        }
+        #if os(Android)
+        try setupFileManagerProperties(filesDir: context.filesDir, cacheDir: context.cacheDir)
+        try installSystemCertificates()
+        #endif
+        logger.log("initAndroidBridge done in \(Date.now.timeIntervalSince(start)) applicationSupportDirectory=\(URL.applicationSupportDirectory.path)")
     }
 }
-#endif
 
-#if !SKIP
-private func setupFileManagerProperties(context: AndroidContext?) throws {
-    guard let context else { return }
-    let filesDir = context.filesDir
-    let cacheDir = context.cacheDir
 
+private func setupFileManagerProperties(filesDir: String, cacheDir: String) throws {
     // https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FileManager/SearchPaths/FileManager%2BXDGSearchPaths.swift#L46
     setenv("XDG_CACHE_HOME", cacheDir, 1)
     // https://github.com/swiftlang/swift-foundation/blob/main/Sources/FoundationEssentials/FileManager/SearchPaths/FileManager%2BXDGSearchPaths.swift#L37
     setenv("XDG_DATA_HOME", filesDir, 1)
 
-    // ensure that we can get the `.applicationSupportDirectory`, which should use the `XDG_DATA_HOME` envrionment
+    // ensure that we can get the `.applicationSupportDirectory`, which should use the `XDG_DATA_HOME` environment
     //let applicationSupportDirectory = URL.applicationSupportDirectory // unavailable on Android
     let applicationSupportDirectory = try! FileManager.default.url(for: .applicationSupportDirectory, in: .userDomainMask, appropriateFor: nil, create: true)
     logger.debug("setupFileManagerProperties: applicationSupportDirectory=\(applicationSupportDirectory.path)")
-
 }
 
 /// Collects all the certificate files from the Android certificate store and writes them to a single `cacerts.pem` file that can be used by libcurl,
@@ -136,5 +115,16 @@ private func installSystemCertificates(fromCertficateFolders certsFolders: [Stri
     //setenv("URLSessionCertificateAuthorityInfoFile", "/system/etc/security/cacerts/", 1) // doesn't work for directories
     setenv("URLSessionCertificateAuthorityInfoFile", generatedCacertsURL.path, 1)
 }
-#endif
 
+// URL.applicationSupportDirectory exists in Darwin's Foundation but not in Android's Foundation
+#if os(Android)
+extension URL {
+    public static var applicationSupportDirectory: URL {
+        try! FileManager.default.url(for: .applicationSupportDirectory, in: .userDomainMask, appropriateFor: nil, create: false)
+    }
+
+    public static var cachesDirectory: URL {
+        try! FileManager.default.url(for: .cachesDirectory, in: .userDomainMask, appropriateFor: nil, create: false)
+    }
+}
+#endif

…Bridge/Swift/AndroidBridgeToKotlin.swift …ndroidBridge/AndroidBridgeToKotlin.swiftSources/SkipAndroidBridge/Swift/AndroidBridgeToKotlin.swift renamed to Sources/SkipAndroidBridge/AndroidBridgeToKotlin.swift Sources/SkipAndroidBridge/Swift/AndroidBridgeToKotlin.swift renamed to Sources/SkipAndroidBridge/AndroidBridgeToKotlin.swift

@@ -0,0 +1,22 @@
+// Copyright 2024 Skip
+//
+// This is free software: you can redistribute and/or modify it
+// under the terms of the GNU Lesser General Public License 3.0
+// as published by the Free Software Foundation https://fsf.org
+
+import SkipAndroidSDKBridge
+
+// Current limitations on Robolectric testing require us to go through a compiled wrapper in order to perform our
+// tests of bridging Kotlin to Swift.
+
+public func testSupport_appendStrings(_ a: String, _ b: String) -> String {
+    a + b
+}
+
+public func testSupport_getJavaSystemProperty(_ name: String) -> String? {
+    getJavaSystemProperty(name)
+}
+
+public func testSupport_getAndroidContext() -> AndroidContext {
+    AndroidContext.shared
+}

Sources/SkipAndroidBridge/AndroidBridgeToKotlinTestSupport.swift

@@ -1,3 +1,4 @@
 # Configuration file for https://skip.tools project
 skip:
-  mode: 'kotlin'
+  mode: 'swift'
+  bridging: true

Sources/SkipAndroidBridge/Skip/skip.yml

@@ -0,0 +1,31 @@
+// Copyright 2024 Skip
+//
+// This is free software: you can redistribute and/or modify it
+// under the terms of the GNU Lesser General Public License 3.0
+// as published by the Free Software Foundation https://fsf.org
+
+#if SKIP
+import Foundation
+import OSLog
+import SkipAndroidBridge
+
+fileprivate let logger: Logger = Logger(subsystem: "SkipAndroidBridge", category: "AndroidBridge")
+
+/// The entry point from a Kotlin Main.kt into the bridged `SkipAndroidBridge`.
+///
+/// This class handles the initial Kotlin-side setup of the Swift bridging, which currently
+/// just involves loading the specific library and calling the Swift `AndroidBridgeKotlin.initAndroidBridge()`,
+/// which will, in turn, perform all the Foundation-level setup.
+public class AndroidBridge {
+    /// This is called at app initialization time, typically from the `Main.kt`
+    ///
+    /// It will look like: `skip.android.bridge.kt.AndroidBridge.initBridge(this, "AppDroidModel")`
+    public static func initBridge(app: android.app.Application, _ libraryName: String) throws {
+        let context = app.applicationContext
+        ProcessInfo.launch(context)
+        logger.debug("loading library: \(libraryName)")
+        try System.loadLibrary(libraryName)
+        try AndroidBridgeKotlin.initAndroidBridge()
+    }
+}
+#endif

Sources/SkipAndroidBridge/Swift/AndroidBridgeToKotlinTestSupport.swift

@@ -0,0 +1,3 @@
+#skip:
+#  mode: 'kotlin'
+#  bridging: true