introduce swift-java jextract subcommand, completing our migration

ktoso · ktoso · commit cf8f4aec3e8c · 2025-06-19T18:58:36.000+09:00
diff --git a/Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift b/Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift
@@ -71,6 +71,7 @@ final class JExtractSwiftCommandPlugin: SwiftJavaPluginProtocol, BuildToolPlugin
     let configuration = try readConfiguration(sourceDir: "\(sourceDir)")
 
     var arguments: [String] = [
+      /*subcommand=*/"jextract",
       "--input-swift", sourceDir,
       "--swift-module", sourceModule.name,
       "--output-java", context.outputJavaDirectory.path(percentEncoded: false),
@@ -80,7 +81,6 @@ final class JExtractSwiftCommandPlugin: SwiftJavaPluginProtocol, BuildToolPlugin
       //       as it depends on the contents of the input files. Therefore we have to implement this as a prebuild plugin.
       //       We'll have to make up some caching inside the tool so we don't re-parse files which have not changed etc.
     ]
-    // arguments.append(sourceDir) // TODO: we could do this shape maybe? to have the dirs last?
     if let package = configuration?.javaPackage, !package.isEmpty {
       arguments += ["--java-package", package]
     }
diff --git a/Plugins/JExtractSwiftPlugin/JExtractSwiftPlugin.swift b/Plugins/JExtractSwiftPlugin/JExtractSwiftPlugin.swift
@@ -54,16 +54,16 @@ struct JExtractSwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
     let outputSwiftDirectory = context.outputSwiftDirectory
 
     var arguments: [String] = [
-      "--input-swift", sourceDir,
+      /*subcommand=*/"jextract",
       "--swift-module", sourceModule.name,
+      "--input-swift", sourceDir,
       "--output-java", outputJavaDirectory.path(percentEncoded: false),
       "--output-swift", outputSwiftDirectory.path(percentEncoded: false),
       // TODO: "--build-cache-directory", ...
       //       Since plugins cannot depend on libraries we cannot detect what the output files will be,
       //       as it depends on the contents of the input files. Therefore we have to implement this as a prebuild plugin.
       //       We'll have to make up some caching inside the tool so we don't re-parse files which have not changed etc.
     ]
-    // arguments.append(sourceDir)
     if !javaPackage.isEmpty {
       arguments.append(contentsOf: ["--java-package", javaPackage])
     }
diff --git a/Samples/SwiftAndJavaJarSampleLib/Package.swift b/Samples/SwiftAndJavaJarSampleLib/Package.swift
@@ -43,7 +43,7 @@ let javaIncludePath = "\(javaHome)/include"
 let package = Package(
   name: "SwiftAndJavaJarSampleLib",
   platforms: [
-    .macOS(.v10_15)
+    .macOS(.v15)
   ],
   products: [
     .library(
diff --git a/Samples/SwiftAndJavaJarSampleLib/build.gradle b/Samples/SwiftAndJavaJarSampleLib/build.gradle
@@ -51,8 +51,8 @@ dependencies {
 
 // This is for development, when we edit the Swift swift-java project, the outputs of the generated sources may change.
 // Thus, we also need to watch and re-build the top level project.
-def compileSwiftJExtractPlugin = tasks.register("compileSwiftJExtractPlugin", Exec) {
-    description = "Rebuild the swift-java root project"
+def compileSwiftJExtractPlugin = tasks.register("compileSwiftJava", Exec) {
+    description = "Rebuild the swift-java root project (" + swiftBuildConfiguration() + ")"
 
     inputs.file(new File(rootDir, "Package.swift"))
     inputs.dir(new File(rootDir, "Sources"))
@@ -62,9 +62,7 @@ def compileSwiftJExtractPlugin = tasks.register("compileSwiftJExtractPlugin", Ex
     commandLine "swift"
     args("build",
             "-c", swiftBuildConfiguration(),
-            "--product", "SwiftKitSwift",
-            "--product", "JExtractSwiftPlugin",
-            "--product", "JExtractSwiftCommandPlugin")
+            "--product", "swift-java")
 }
 
 def jextract = tasks.register("jextract", Exec) {
@@ -96,7 +94,7 @@ def jextract = tasks.register("jextract", Exec) {
 
     workingDir = layout.projectDirectory
     commandLine "swift"
-    args("package", "jextract", "-v", "--log-level", "info") // TODO: pass log level from Gradle build
+    args("run", "swift-java", "jextract", "-v", "--log-level", "info") // TODO: pass log level from Gradle build
 }
 
 
diff --git a/Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+SwiftThunkPrinting.swift b/Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+SwiftThunkPrinting.swift
@@ -34,7 +34,7 @@ extension FFMSwift2JavaGenerator {
         javaPackagePath: nil,
         filename: moduleFilename)
       {
-        print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile)")
+        print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile))")
       }
     } catch {
       log.warning("Failed to write to Swift thunks: \(moduleFilename)")
@@ -54,7 +54,7 @@ extension FFMSwift2JavaGenerator {
           javaPackagePath: nil,
           filename: filename)
         {
-          print("[swift-java] Generated: \(fileNameBase.bold).swift (at \(outputFile)")
+          print("[swift-java] Generated: \(fileNameBase.bold).swift (at \(outputFile))")
         }
       } catch {
         log.warning("Failed to write to Swift thunks: \(filename)")
diff --git a/Sources/JExtractSwiftLib/JNI/JNISwift2JavaGenerator.swift b/Sources/JExtractSwiftLib/JNI/JNISwift2JavaGenerator.swift
@@ -87,7 +87,7 @@ extension JNISwift2JavaGenerator {
         javaPackagePath: javaPackagePath,
         filename: moduleFilename
       ) {
-        print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile)")
+        print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile))")
       }
     } catch {
       logger.warning("Failed to write to Swift thunks: \(moduleFilename)")
diff --git a/Sources/JExtractSwiftLib/Swift2Java.swift b/Sources/JExtractSwiftLib/Swift2Java.swift
@@ -39,12 +39,11 @@ public struct SwiftToJava {
       translator.log.warning("Configured java package is '', consider specifying concrete package for generated sources.")
     }
 
-    print("===== CONFIG ==== \(config)")
-
     guard let inputSwift = config.inputSwiftDirectory else {
       fatalError("Missing '--swift-input' directory!")
     }
 
+    translator.log.info("Input swift = \(inputSwift)")
     let inputPaths = inputSwift.split(separator: ",").map { URL(string: String($0))! }
     translator.log.info("Input paths = \(inputPaths)")
 
diff --git a/Sources/JavaKitConfigurationShared/Configuration.swift b/Sources/JavaKitConfigurationShared/Configuration.swift
@@ -38,7 +38,7 @@ public struct Configuration: Codable {
 
   public var outputJavaDirectory: String?
 
-  public var mode: GenerationMode?
+  public var mode: JExtractGenerationMode?
 
   // ==== java 2 swift ---------------------------------------------------------
 
diff --git a/Sources/JavaKitConfigurationShared/GenerationMode.swift b/Sources/JavaKitConfigurationShared/GenerationMode.swift
@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-public enum GenerationMode: String, Codable {
+public enum JExtractGenerationMode: String, Codable {
   /// Foreign Value and Memory API
   case ffm
 
diff --git a/Sources/SwiftJavaTool/Commands/JExtractCommand.swift b/Sources/SwiftJavaTool/Commands/JExtractCommand.swift
@@ -0,0 +1,94 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift.org project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+import ArgumentParser
+import SwiftJavaLib
+import JavaKit
+import JavaKitJar
+import SwiftJavaLib
+import JExtractSwiftLib
+import JavaKitConfigurationShared
+
+/// Extract Java bindings from Swift sources or interface files.
+///
+/// Example usage:
+/// ```
+/// > swift-java jextract
+//      --input-swift Sources/SwiftyBusiness \
+///     --output-swift .build/.../outputs/SwiftyBusiness \
+///     --output-Java .build/.../outputs/Java
+/// ```
+extension SwiftJava {
+
+  struct JExtractCommand: SwiftJavaBaseAsyncParsableCommand, HasCommonOptions {
+    static let configuration = CommandConfiguration(
+      commandName: "jextract", // TODO: wrap-swift?
+      abstract: "Wrap Swift functions and types with Java bindings, making them available to be called from Java")
+
+    @OptionGroup var commonOptions: SwiftJava.CommonOptions
+
+    @Option(help: "The mode of generation to use for the output files. Used with jextract mode.")
+    var mode: JExtractGenerationMode = .ffm
+
+    @Option(help: "The name of the Swift module into which the resulting Swift types will be generated.")
+    var swiftModule: String
+
+    var effectiveSwiftModule: String {
+      swiftModule
+    }
+
+    @Option(help: "The Java package the generated Java code should be emitted into.")
+    var javaPackage: String? = nil
+
+    @Option(help: "The directory where generated Swift files should be written. Generally used with jextract mode.")
+    var outputSwift: String
+
+    @Option(help: "The directory where generated Java files should be written. Generally used with jextract mode.")
+    var outputJava: String
+  }
+}
+
+extension SwiftJava.JExtractCommand {
+  func runSwiftJavaCommand(config: inout Configuration) async throws {
+    if let javaPackage {
+      config.javaPackage = javaPackage
+    }
+    config.swiftModule = self.effectiveSwiftModule
+    config.outputJavaDirectory = outputJava
+    config.outputSwiftDirectory = outputSwift
+
+    if let inputSwift = commonOptions.inputSwift {
+      config.inputSwiftDirectory = inputSwift
+    } else if let swiftModule = config.swiftModule {
+      // This is a "good guess" technically a target can be somewhere else, but then you can use --input-swift
+      config.inputSwiftDirectory = "\(FileManager.default.currentDirectoryPath)/Sources/\(swiftModule)"
+    }
+
+    print("[debug][swift-java] Running swift-java in mode: " + "\(self.mode)".bold)
+
+    try jextractSwift(config: config)
+  }
+}
+
+extension SwiftJava.JExtractCommand {
+  func jextractSwift(
+    config: Configuration
+  ) throws {
+    try SwiftToJava(config: config).run()
+  }
+
+}
+
+extension JExtractGenerationMode: ExpressibleByArgument {}
diff --git a/Sources/SwiftJavaTool/Commands/SwiftJava+JExtract.swift b/Sources/SwiftJavaTool/Commands/SwiftJava+JExtract.swift
diff --git a/Sources/SwiftJavaTool/Commands/WrapJavaCommand.swift b/Sources/SwiftJavaTool/Commands/WrapJavaCommand.swift
@@ -46,9 +46,6 @@ extension SwiftJava {
     )
     var dependsOn: [String] = []
 
-    @Option(help: "The Java package the generated Java code should be emitted into.")
-    var javaPackage: String? = nil
-
     @Option(help: "The names of Java classes whose declared native methods will be implemented in Swift.")
     var swiftNativeImplementation: [String] = []
 
@@ -63,11 +60,6 @@ extension SwiftJava {
 extension SwiftJava.WrapJavaCommand {
 
   mutating func runSwiftJavaCommand(config: inout Configuration) async throws {
-    // Perform any config overrides by command options:
-    if let javaPackage {
-      config.javaPackage = javaPackage
-    }
-
     // Get base classpath configuration for this target and configuration
     var classpathSearchDirs = [self.effectiveSwiftModuleURL]
     if let cacheDir = self.cacheDirectory {
diff --git a/Sources/SwiftJavaTool/SwiftJava.swift b/Sources/SwiftJavaTool/SwiftJava.swift
@@ -27,7 +27,7 @@ import JavaKitShared
 
 /// Command-line utility to drive the export of Java classes into Swift types.
 @main
-struct SwiftJava: SwiftJavaBaseAsyncParsableCommand, HasCommonJVMOptions { // FIXME: this is just a normal async command, no parsing happening here
+struct SwiftJava: AsyncParsableCommand { // FIXME: this is just a normal async command, no parsing happening here
   static var _commandName: String { "swift-java" }
 
   static let configuration = CommandConfiguration(
@@ -40,57 +40,18 @@ struct SwiftJava: SwiftJavaBaseAsyncParsableCommand, HasCommonJVMOptions { // FI
     ])
 
   var effectiveSwiftModule: String {
-    if let module = self.outputSwift?.split(separator: "/").last {
-      String(module)
-    } else {
-      "UnknownSwiftModule"
-    }
+    fatalError("SHOULD NOT BE USED")
   }
 
-  @Option(help: "The directory where generated Swift files should be written. Generally used with jextract mode.")
-  var outputSwift: String? = nil
-
-  @Option(help: "The directory where generated Java files should be written. Generally used with jextract mode.")
-  var outputJava: String? = nil
-
-  @OptionGroup var commonOptions: SwiftJava.CommonOptions
-  @OptionGroup var commonJVMOptions: SwiftJava.CommonJVMOptions
-
-//  @Argument(
-//    help: "The input file, which is either a Java2Swift configuration file or (if '-jar' was specified) a Jar file."
-//  )
-  var input: String? // FIXME: top level command cannot have input argument like this
-
-  mutating func runSwiftJavaCommand(config: inout Configuration) async throws {
+  mutating func run() async throws {
     guard CommandLine.arguments.count >= 2 else {
       // there's no "default" command, print USAGE when no arguments/parameters are passed.
       print("error: Must specify mode subcommand (e.g. configure, resolve, jextract, ...).\n\n\(Self.helpMessage())")
       return
     }
 
-    // TODO: some options are exclusive to each other so we should detect that
-    if let inputSwift = commonOptions.inputSwift {
-      guard let inputSwift = commonOptions.inputSwift else {
-        print("[swift-java] --input-swift enabled 'jextract' mode, however no --output-swift directory was provided!\n\(Self.helpMessage())")
-        return
-      }
-      guard let outputSwift else {
-        print("[swift-java] --output-swift enabled 'jextract' mode, however no --output-swift directory was provided!\n\(Self.helpMessage())")
-        return
-      }
-      guard let outputJava else {
-        print("[swift-java] --output-java enabled 'jextract' mode, however no --output-java directory was provided!\n\(Self.helpMessage())")
-        return
-      }
-      config.swiftModule = self.effectiveSwiftModule
-      config.inputSwiftDirectory = inputSwift
-      config.outputSwiftDirectory = outputSwift
-      config.outputJavaDirectory = outputJava
-    }
-
-    print("[debug][swift-java] Running swift-java in mode: " + "jextract (legacy, to be moved into subcommand)")
-
-    try jextractSwift(config: config)
+    print("error: Must specify subcommand to execute.\n\n\(Self.helpMessage())")
+    return
   }
 
   private func names(from javaClassNameOpt: String) -> (javaClassName: String, swiftName: String) {
diff --git a/Tests/JExtractSwiftTests/Asserts/TextAssertions.swift b/Tests/JExtractSwiftTests/Asserts/TextAssertions.swift
@@ -25,7 +25,7 @@ enum RenderKind {
 func assertOutput(
   dump: Bool = false,
   input: String,
-  _ mode: GenerationMode,
+  _ mode: JExtractGenerationMode,
   _ renderKind: RenderKind,
   swiftModuleName: String = "SwiftModule",
   detectChunkByInitialLines: Int = 4,

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,7 @@ final class JExtractSwiftCommandPlugin: SwiftJavaPluginProtocol, BuildToolPlugin`
`71`	`71`	`let configuration = try readConfiguration(sourceDir: "\(sourceDir)")`
`72`	`72`
`73`	`73`	`var arguments: [String] = [`
	`74`	`+ /subcommand=/"jextract",`
`74`	`75`	`"--input-swift", sourceDir,`
`75`	`76`	`"--swift-module", sourceModule.name,`
`76`	`77`	`"--output-java", context.outputJavaDirectory.path(percentEncoded: false),`
`@@ -80,7 +81,6 @@ final class JExtractSwiftCommandPlugin: SwiftJavaPluginProtocol, BuildToolPlugin`
`80`	`81`	`// as it depends on the contents of the input files. Therefore we have to implement this as a prebuild plugin.`
`81`	`82`	`// We'll have to make up some caching inside the tool so we don't re-parse files which have not changed etc.`
`82`	`83`	`]`
`83`		`- // arguments.append(sourceDir) // TODO: we could do this shape maybe? to have the dirs last?`
`84`	`84`	`if let package = configuration?.javaPackage, !package.isEmpty {`
`85`	`85`	`arguments += ["--java-package", package]`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ extension FFMSwift2JavaGenerator {`
`34`	`34`	`javaPackagePath: nil,`
`35`	`35`	`filename: moduleFilename)`
`36`	`36`	`{`
`37`		`- print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile)")`
	`37`	`+ print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile))")`
`38`	`38`	`}`
`39`	`39`	`} catch {`
`40`	`40`	`log.warning("Failed to write to Swift thunks: \(moduleFilename)")`
`@@ -54,7 +54,7 @@ extension FFMSwift2JavaGenerator {`
`54`	`54`	`javaPackagePath: nil,`
`55`	`55`	`filename: filename)`
`56`	`56`	`{`
`57`		`- print("[swift-java] Generated: \(fileNameBase.bold).swift (at \(outputFile)")`
	`57`	`+ print("[swift-java] Generated: \(fileNameBase.bold).swift (at \(outputFile))")`
`58`	`58`	`}`
`59`	`59`	`} catch {`
`60`	`60`	`log.warning("Failed to write to Swift thunks: \(filename)")`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ extension JNISwift2JavaGenerator {`
`87`	`87`	`javaPackagePath: javaPackagePath,`
`88`	`88`	`filename: moduleFilename`
`89`	`89`	`) {`
`90`		`- print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile)")`
	`90`	`+ print("[swift-java] Generated: \(moduleFilenameBase.bold).swift (at \(outputFile))")`
`91`	`91`	`}`
`92`	`92`	`} catch {`
`93`	`93`	`logger.warning("Failed to write to Swift thunks: \(moduleFilename)")`
Original file line number	Diff line number	Diff line change
`@@ -39,12 +39,11 @@ public struct SwiftToJava {`
`39`	`39`	`translator.log.warning("Configured java package is '', consider specifying concrete package for generated sources.")`
`40`	`40`	`}`
`41`	`41`
`42`		`- print("===== CONFIG ==== \(config)")`
`43`		`-`
`44`	`42`	`guard let inputSwift = config.inputSwiftDirectory else {`
`45`	`43`	`fatalError("Missing '--swift-input' directory!")`
`46`	`44`	`}`
`47`	`45`
	`46`	`+ translator.log.info("Input swift = \(inputSwift)")`
`48`	`47`	`let inputPaths = inputSwift.split(separator: ",").map { URL(string: String($0))! }`
`49`	`48`	`translator.log.info("Input paths = \(inputPaths)")`
`50`	`49`