linux JExtractPluginSampleApp worked

ktoso · ktoso · commit 5d7677e5cffc · 2024-11-14T22:27:18.000+09:00
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -32,11 +32,11 @@ jobs:
       - uses: actions/checkout@v4
       - name: Prepare CI Environment
         uses: ./.github/actions/prepare_env
-      - name: Gradle build
+      - name: Gradle :SwiftKit:build
         run: ./gradlew build -x test # just build
-      - name: Gradle check
-        run: ./gradlew check --info
-      - name: Gradle compile benchmarks
+      - name: Gradle :SwiftKit:check
+        run: ./gradlew :SwiftKit:check --info
+      - name: Gradle compile JMH benchmarks
         run: ./gradlew compileJmh --info
 
   test-swift:
diff --git a/.gitignore b/.gitignore
@@ -37,3 +37,4 @@ Package.resolved
 */**/*.d
 */**/*.o
 */**/*.swiftdeps
+*/**/*.swiftdeps~
diff --git a/BuildLogic/src/main/kotlin/build-logic.java-common-conventions.gradle.kts b/BuildLogic/src/main/kotlin/build-logic.java-common-conventions.gradle.kts
@@ -91,17 +91,3 @@ tasks.withType<Test> {
         this.showStandardStreams = true
     }
 }
-
-
-// TODO: This is a crude workaround, we'll remove 'make' soon and properly track build dependencies
-// val buildSwiftJExtract = tasks.register<Exec>("buildMake") {
-//    description = "Triggers 'make' build"
-//
-//    workingDir(rootDir)
-//    commandLine("make")
-// }
-//
-// tasks.build {
-//     dependsOn(buildSwiftJExtract)
-// }
-
diff --git a/Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift b/Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift
@@ -30,17 +30,14 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
   /// This helps verify that the generated output is correct, and won't miscompile on the next build.
   var buildOutputs: Bool = true
 
-  func createBuildCommands(context: PackagePlugin.PluginContext, target: any PackagePlugin.Target) async throws -> [PackagePlugin.Command] {
+  func createBuildCommands(context: PluginContext, target: any Target) async throws -> [Command] {
     // FIXME: This is not a build plugin but SwiftPM forces us to impleme the protocol anyway? rdar://139556637
     return []
   }
 
   func performCommand(context: PluginContext, arguments: [String]) throws {
     // Plugin can't have dependencies, so we have some naive argument parsing instead:
     self.verbose = arguments.contains("-v") || arguments.contains("--verbose")
-    if !self.verbose {
-        fatalError("Plugin should be verbose")
-    }
 
     let selectedTargets: [String] =
       if let last = arguments.lastIndex(where: { $0.starts(with: "-")}),
@@ -52,32 +49,23 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
 
     for target in context.package.targets {
       guard let configPath = getSwiftJavaConfig(target: target) else {
-        log("Skipping target '\(target.name), has no 'swift-java.config' file")
+        log("Skipping target '\(target.name)', has no 'swift-java.config' file")
         continue
       }
 
       do {
         print("[swift-java-command] Extracting Java wrappers from target: '\(target.name)'...")
-        try performCommand(context: context, target: target, arguments: arguments)
+        try performCommand(context: context, target: target, extraArguments: arguments)
       } catch {
         print("[swift-java-command] error: Failed to extract from target '\(target.name)': \(error)")
       }
 
-      print("[swift-java-command] Done.")
     }
+    print("[swift-java-command] Generating sources: " + "done".green + ".")
   }
 
-  /// Perform the command on a specific target.
-  func performCommand(context: PluginContext, target: Target, arguments: [String]) throws {
-    // Make sure the target can builds properly
-    try self.packageManager.build(.target(target.name), parameters: .init())
-
-    guard let sourceModule = target.sourceModule else { return }
-
-    if self.buildInputs {
-      log("Pre-building target '\(target.name)' before extracting sources...")
-      try self.packageManager.build(.target(target.name), parameters: .init())
-    }
+  func prepareJExtractArguments(context: PluginContext, target: Target) throws -> [String] {
+    guard let sourceModule = target.sourceModule else { return [] }
 
     // Note: Target doesn't have a directoryURL counterpart to directory,
     // so we cannot eliminate this deprecation warning.
@@ -106,6 +94,23 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
     ]
     arguments.append(sourceDir)
 
+    return arguments
+  }
+
+  /// Perform the command on a specific target.
+  func performCommand(context: PluginContext, target: Target, extraArguments _: [String]) throws {
+    // Make sure the target can builds properly
+    try self.packageManager.build(.target(target.name), parameters: .init())
+
+    guard let sourceModule = target.sourceModule else { return }
+
+    if self.buildInputs {
+      log("Pre-building target '\(target.name)' before extracting sources...")
+      try self.packageManager.build(.target(target.name), parameters: .init())
+    }
+
+    let arguments = try prepareJExtractArguments(context: context, target: target)
+
     try runExtract(context: context, target: target, arguments: arguments)
 
     if self.buildOutputs {
@@ -146,3 +151,10 @@ final class JExtractSwiftCommandPlugin: BuildToolPlugin, CommandPlugin {
     }
   }
 }
+
+// Mini coloring helper, since we cannot have dependencies we keep it minimal here
+extension String {
+  var green: String {
+    "\u{001B}[0;32m" + "\(self)" + "\u{001B}[0;0m"
+  }
+}
diff --git a/Samples/JExtractPluginSampleApp/Sources/JExtractPluginSampleLib/MyCoolSwiftClass.swift b/Samples/JExtractPluginSampleApp/Sources/JExtractPluginSampleLib/MyCoolSwiftClass.swift
@@ -24,3 +24,9 @@ public class MyCoolSwiftClass {
     print("[swift]   number = \(number)")
   }
 }
+
+@_silgen_name("_objc_autoreleaseReturnValue")
+public func _objc_autoreleaseReturnValue(a: Any) {}
+
+@_silgen_name("objc_autoreleaseReturnValue")
+public func objc_autoreleaseReturnValue(a: Any) {}
diff --git a/Samples/JExtractPluginSampleApp/build.gradle b/Samples/JExtractPluginSampleApp/build.gradle
@@ -48,6 +48,12 @@ def buildJExtractPlugin = tasks.register("swiftBuildJExtractPlugin", Exec) {
     args "build"
 }
 
+def swiftClean = tasks.register("swiftClean", Exec) {
+    workingDir = layout.projectDirectory
+    commandLine "swift"
+    args("package", "clean")
+}
+
 def jextract = tasks.register("jextract", Exec) {
     description = "Builds swift sources, including swift-java source generation"
     dependsOn buildJExtractPlugin
@@ -93,6 +99,10 @@ tasks.build {
     dependsOn("jextract")
 }
 
+tasks.clean {
+    dependsOn("swiftClean")
+}
+
 dependencies {
     implementation(project(':SwiftKit'))
 
diff --git a/Samples/JExtractPluginSampleApp/src/main/java/com/example/swift/JExtractPluginSampleMain.java b/Samples/JExtractPluginSampleApp/src/main/java/com/example/swift/JExtractPluginSampleMain.java
@@ -22,6 +22,7 @@ public static void main(String[] args) {
         System.out.println("java.library.path = " + SwiftKit.getJavaLibraryPath());
         System.out.println("jextract.trace.downcalls = " + SwiftKit.getJextractTraceDowncalls());
 
+        SwiftKit.loadLibraries(true);
         var o = new MyCoolSwiftClass(12);
         o.exposedToJava();
     }
diff --git a/Samples/SwiftKitSampleApp/build.gradle b/Samples/SwiftKitSampleApp/build.gradle
@@ -49,6 +49,12 @@ def buildJExtractPlugin = tasks.register("swiftBuildJExtractPlugin", Exec) {
     args "build"
 }
 
+def swiftClean = tasks.register("swiftClean", Exec) {
+    workingDir = layout.projectDirectory
+    commandLine "swift"
+    args("package", "clean")
+}
+
 def jextract = tasks.register("jextract", Exec) {
     description = "Builds swift sources, including swift-java source generation"
     dependsOn buildJExtractPlugin
@@ -104,6 +110,10 @@ tasks.build {
     dependsOn("jextract")
 }
 
+tasks.clean {
+    dependsOn("swiftClean")
+}
+
 dependencies {
     implementation(project(':SwiftKit'))
 
diff --git a/Sources/JExtractSwift/Swift2JavaTranslator+Printing.swift b/Sources/JExtractSwift/Swift2JavaTranslator+Printing.swift
@@ -446,9 +446,9 @@ extension Swift2JavaTranslator {
                   .map(Object::toString)
                   .collect(Collectors.joining(", "));
           System.out.printf("[java][%s:%d] Downcall: %s(%s)\\n",
-                  ex.getStackTrace()[1].getFileName(),
-                  ex.getStackTrace()[1].getLineNumber(),
-                  ex.getStackTrace()[1].getMethodName(),
+                  ex.getStackTrace()[2].getFileName(),
+                  ex.getStackTrace()[2].getLineNumber(),
+                  ex.getStackTrace()[2].getMethodName(),
                   traceArgs);
       }
 
@@ -459,9 +459,9 @@ extension Swift2JavaTranslator {
                   .map(Object::toString)
                   .collect(Collectors.joining(", "));
           System.out.printf("[java][%s:%d] %s: %s\\n",
-                  ex.getStackTrace()[1].getFileName(),
-                  ex.getStackTrace()[1].getLineNumber(),
-                  ex.getStackTrace()[1].getMethodName(),
+                  ex.getStackTrace()[2].getFileName(),
+                  ex.getStackTrace()[2].getLineNumber(),
+                  ex.getStackTrace()[2].getMethodName(),
                   traceArgs);
       }
       """
@@ -884,18 +884,26 @@ extension Swift2JavaTranslator {
       let firstName = p.firstName ?? "_"
       let secondName = p.secondName ?? p.firstName ?? nextUniqueParamName()
 
+      let paramTy: String =
+        if paramPassingStyle == .swiftThunkSelf {
+          "\(p.type.cCompatibleSwiftType)"
+        } else {
+          p.type.swiftTypeName.description
+        }
+
       let param =
         if firstName == secondName {
           // We have to do this to avoid a 'extraneous duplicate parameter name; 'number' already has an argument label' warning
-          "\(firstName): \(p.type.swiftTypeName.description)"
+          "\(firstName): \(paramTy)"
         } else {
-          "\(firstName) \(secondName): \(p.type.swiftTypeName.description)"
+          "\(firstName) \(secondName): \(paramTy)"
         }
       ps.append(param)
     }
 
     if paramPassingStyle == .swiftThunkSelf {
-      ps.append("_self: Any")
+      ps.append("_self: UnsafeMutableRawPointer")
+//      ps.append("_self: Any")
     }
 
     let res = ps.joined(separator: ", ")
diff --git a/Sources/JExtractSwift/Swift2JavaVisitor.swift b/Sources/JExtractSwift/Swift2JavaVisitor.swift
@@ -136,7 +136,7 @@ final class Swift2JavaVisitor: SyntaxVisitor {
 
     // TODO: filter out kinds of variables we cannot import
 
-    self.log.info("Import variable: \(node.kind) \(fullName)")
+    self.log.debug("Import variable: \(node.kind) \(fullName)")
 
     let returnTy: TypeSyntax
     if let typeAnnotation = binding.typeAnnotation {
@@ -167,7 +167,7 @@ final class Swift2JavaVisitor: SyntaxVisitor {
     }
 
     if let currentTypeName {
-      log.info("Record variable in \(currentTypeName)")
+      log.debug("Record variable in \(currentTypeName)")
       translator.importedTypes[currentTypeName]!.variables.append(varDecl)
     } else {
       fatalError("Global variables are not supported yet: \(node.debugDescription)")
diff --git a/Sources/JExtractSwift/SwiftThunkTranslator.swift b/Sources/JExtractSwift/SwiftThunkTranslator.swift
@@ -85,46 +85,48 @@ struct SwiftThunkTranslator {
     let thunkName = self.st.thunkNameRegistry.functionThunkName(
       module: st.swiftModuleName, decl: function)
 
-    // FIXME: handle in thunk: return types
-    // FIXME: handle in thunk: parameters
-    // FIXME: handle in thunk: errors
     return
       [
         """
         @_cdecl("\(raw: thunkName)")
         public func \(raw: thunkName)(\(raw: st.renderSwiftParamDecls(function, paramPassingStyle: nil))) -> Any /* \(raw: parent.swiftTypeName) */ {
-          \(raw: parent.swiftTypeName)(\(raw: st.renderForwardSwiftParams(function, paramPassingStyle: nil)))
+          print("[swift] init class \(raw: parent.swiftTypeName)")
+          return \(raw: parent.swiftTypeName)(\(raw: st.renderForwardSwiftParams(function, paramPassingStyle: nil)))
         }
         """
       ]
   }
 
-
   func render(forFunc decl: ImportedFunc) -> [DeclSyntax] {
     st.log.trace("Rendering thunks for: \(decl.baseIdentifier)")
-//    let funcName = SwiftKitPrinting.Names.functionThunk(
-//      thunkNameRegistry: &st.thunkNameRegistry,
-//      module: st.swiftModuleName,
-//      function: decl)
-    let funcName = st.thunkNameRegistry.functionThunkName(module: st.swiftModuleName, decl: decl)
+    let thunkName = st.thunkNameRegistry.functionThunkName(module: st.swiftModuleName, decl: decl)
 
     // Do we need to pass a self parameter?
     let paramPassingStyle: SelfParameterVariant?
     let callBaseDot: String
       if let parent = decl.parent {
         paramPassingStyle = .swiftThunkSelf
-        // TODO: unsafe bitcast
-        callBaseDot = "(_self as! \(parent.originalSwiftType))."
+        callBaseDot = "unsafeBitCast(_self, to: \(parent.originalSwiftType).self)."
+        // callBaseDot = "(_self as! \(parent.originalSwiftType))."
       } else {
         paramPassingStyle = nil
         callBaseDot = ""
       }
 
+    let returnArrowTy =
+      if decl.returnType.cCompatibleJavaMemoryLayout == .primitive(.void) {
+        "/* \(decl.returnType.swiftTypeName) */"
+      } else {
+        "-> \(decl.returnType.cCompatibleSwiftType) /* \(decl.returnType.swiftTypeName) */"
+      }
+
+    // FIXME: handle in thunk: errors
+
     return
       [
         """
-        @_cdecl("\(raw: funcName)")
-        public func \(raw: funcName)(\(raw: st.renderSwiftParamDecls(decl, paramPassingStyle: paramPassingStyle))) -> \(decl.returnType.cCompatibleSwiftType) /* \(raw: decl.returnType.swiftTypeName) */ {
+        @_cdecl("\(raw: thunkName)")
+        public func \(raw: thunkName)(\(raw: st.renderSwiftParamDecls(decl, paramPassingStyle: paramPassingStyle))) \(raw: returnArrowTy) {
           \(raw: callBaseDot)\(raw: decl.baseIdentifier)(\(raw: st.renderForwardSwiftParams(decl, paramPassingStyle: paramPassingStyle)))
         }
         """
diff --git a/Sources/JExtractSwift/ThunkNameRegistry.swift b/Sources/JExtractSwift/ThunkNameRegistry.swift
@@ -38,6 +38,8 @@ package struct ThunkNameRegistry {
         param.firstName ?? "_"
       }.joined(separator: "_")
     }
+      
+      
 
     let name =
       if let parent = decl.parent {
diff --git a/Sources/Java2SwiftLib/JavaClassTranslator.swift b/Sources/Java2SwiftLib/JavaClassTranslator.swift
@@ -518,7 +518,9 @@ extension JavaClassTranslator {
       preferValueTypes: true,
       outerOptional: .implicitlyUnwrappedOptional
     )
-    if resultType != "Void" {
+
+    // FIXME: cleanup the checking here
+    if resultType != "Void" && resultType != "Swift.Void" {
       resultTypeStr = " -> \(resultType)"
     } else {
       resultTypeStr = ""
diff --git a/SwiftKit/src/main/java/org/swift/swiftkit/SwiftKit.java b/SwiftKit/src/main/java/org/swift/swiftkit/SwiftKit.java
@@ -28,17 +28,20 @@
 public class SwiftKit {
 
     public static final String STDLIB_DYLIB_NAME = "swiftCore";
+    public static final String SWIFTKITSWIFT_DYLIB_NAME = "SwiftKitSwift";
     private static final String STDLIB_MACOS_DYLIB_PATH = "/usr/lib/swift/libswiftCore.dylib";
 
     private static final Arena LIBRARY_ARENA = Arena.ofAuto();
     static final boolean TRACE_DOWNCALLS = Boolean.getBoolean("jextract.trace.downcalls");
 
     @SuppressWarnings("unused")
-    private static final boolean INITIALIZED_LIBS = initializeLibs();
+    private static final boolean INITIALIZED_LIBS = loadLibraries(false);
 
-    static boolean initializeLibs() {
+    public static boolean loadLibraries(boolean loadSwiftKit) {
         System.loadLibrary(STDLIB_DYLIB_NAME);
-        System.loadLibrary("SwiftKitSwift");
+        if (loadSwiftKit) {
+            System.loadLibrary(SWIFTKITSWIFT_DYLIB_NAME);
+        }
         return true;
     }
 
diff --git a/SwiftKit/src/test/java/org/swift/swiftkit/SwiftRuntimeMetadataTest.java b/SwiftKit/src/test/java/org/swift/swiftkit/SwiftRuntimeMetadataTest.java
@@ -15,6 +15,7 @@
 package org.swift.swiftkit;
 
 import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 public class SwiftRuntimeMetadataTest {
diff --git a/Tests/JExtractSwiftTests/MethodThunkTests.swift b/Tests/JExtractSwiftTests/MethodThunkTests.swift
diff --git a/docker/Dockerfile b/docker/Dockerfile

Original file line number	Diff line number	Diff line change
`@@ -24,3 +24,9 @@ public class MyCoolSwiftClass {`
`24`	`24`	`print("[swift] number = \(number)")`
`25`	`25`	`}`
`26`	`26`	`}`
	`27`	`+`
	`28`	`+@_silgen_name("_objc_autoreleaseReturnValue")`
	`29`	`+public func _objc_autoreleaseReturnValue(a: Any) {}`
	`30`	`+`
	`31`	`+@_silgen_name("objc_autoreleaseReturnValue")`
	`32`	`+public func objc_autoreleaseReturnValue(a: Any) {}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ public static void main(String[] args) {`
`22`	`22`	`System.out.println("java.library.path = " + SwiftKit.getJavaLibraryPath());`
`23`	`23`	`System.out.println("jextract.trace.downcalls = " + SwiftKit.getJextractTraceDowncalls());`
`24`	`24`
	`25`	`+ SwiftKit.loadLibraries(true);`
`25`	`26`	`var o = new MyCoolSwiftClass(12);`
`26`	`27`	`o.exposedToJava();`
`27`	`28`	`}`