New commands: wrap-java and resolve work from swift-java CLI tool

Author: ktoso

Plugins/SwiftJavaPlugin/SwiftJavaPlugin.swift

@@ -87,13 +87,10 @@ struct SwiftJavaBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
       searchForConfigFiles(in: dependency)
     }
 
-    var arguments: [String] = [
-      "wrap-java"
-    ]
+    var arguments: [String] = []
     arguments += argumentsSwiftModule(sourceModule: sourceModule)
     arguments += argumentsOutputDirectory(context: context)
     arguments += argumentsDependedOnConfigs(dependentConfigFiles)
-    arguments.append(configFile.path(percentEncoded: false))
 
     let classes = config.classes ?? [:]
     print("[swift-java-plugin] Classes to wrap (\(classes.count)): \(classes.map(\.key))")
@@ -158,12 +155,7 @@ struct SwiftJavaBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
           executable: executable,
           arguments: ["resolve"]
             + argumentsOutputDirectory(context: context, generated: false)
-            + argumentsSwiftModule(sourceModule: sourceModule)
-            // + [
-            //  // explicitly provide config path
-            //   configFile.path(percentEncoded: false)
-            // ]
-            ,
+            + argumentsSwiftModule(sourceModule: sourceModule),
           environment: [:],
           inputFiles: [configFile],
           outputFiles: fetchDependenciesOutputFiles
@@ -174,13 +166,16 @@ struct SwiftJavaBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
     }
 
     if !outputSwiftFiles.isEmpty {
+      arguments += [ configFile.path(percentEncoded: false) ]
+
       let displayName = "Wrapping \(classes.count) Java classes in Swift target '\(sourceModule.name)'"
       log("Prepared: \(displayName)")
       commands += [
         .buildCommand(
           displayName: displayName,
           executable: executable,
-          arguments: arguments,
+          arguments: ["wrap-java"]
+            + arguments,
           inputFiles: compiledClassFiles + fetchDependenciesOutputFiles + [ configFile ],
           outputFiles: outputSwiftFiles
         )

Sources/JavaKitConfigurationShared/Configuration.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Copyright (c) 2024-2025 Apple Inc. and the Swift.org project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -156,15 +156,15 @@ public func findSwiftJavaClasspaths(in basePath: String = FileManager.default.cu
   let baseURL = URL(fileURLWithPath: basePath)
   var classpathEntries: [String] = []
 
-  print("[debug][swift-java] Searching for *.swift-java.classpath files in: \(baseURL)")
+  print("[debug][swift-java] Searching for *.swift-java.classpath files in: \(baseURL.absoluteString)")
   guard let enumerator = fileManager.enumerator(at: baseURL, includingPropertiesForKeys: []) else {
     print("[warning][swift-java] Failed to get enumerator for \(baseURL)")
     return []
   }
 
   for case let fileURL as URL in enumerator {
     if fileURL.lastPathComponent.hasSuffix(".swift-java.classpath") {
-      print("[debug][swift-java] Constructing classpath with entries from: \(fileURL.relativePath)")
+      print("[debug][swift-java] Constructing classpath with entries from: \(fileURL.path)")
       if let contents = try? String(contentsOf: fileURL) {
         let entries = contents.split(separator: ":").map(String.init)
         for entry in entries {

Sources/SwiftJavaTool/Commands/ConfigureCommand.swift

@@ -66,8 +66,8 @@ extension SwiftJava {
 
 extension SwiftJava.ConfigureCommand {
   mutating func runSwiftJavaCommand(config: inout Configuration) async throws {
-    let classpathEntries =
-      self.configureCommandJVMClasspath(effectiveSwiftModuleURL: self.effectiveSwiftModuleURL, config: config)
+    let classpathEntries = self.configureCommandJVMClasspath(
+        searchDirs: [self.effectiveSwiftModuleURL], config: config)
 
     let jvm =
       try self.makeJVM(classpathEntries: classpathEntries)

Sources/SwiftJavaTool/Commands/SwiftJava+JExtract.swift

@@ -31,6 +31,32 @@ import JavaKitConfigurationShared
 /// ```
 extension SwiftJava {
 
+  struct JExtractCommand: SwiftJavaBaseAsyncParsableCommand, HasCommonOptions {
+    static let configuration = CommandConfiguration(
+      commandName: "jextract", // TODO: wrap-swift?
+      abstract: "Resolve dependencies and write the resulting swift-java.classpath file")
+
+    @OptionGroup var commonOptions: SwiftJava.CommonOptions
+
+    @Option(help: "The mode of generation to use for the output files. Used with jextract mode.")
+    var mode: GenerationMode = .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
+    }
+  }
+}
+
+extension SwiftJava.JExtractCommand {
+  func runSwiftJavaCommand(config: inout Configuration) async throws {
+    fatalError("not implemented yet")
+  }
+}
+
+extension SwiftJava {
   mutating func jextractSwift(
     config: Configuration
   ) throws {

Sources/SwiftJavaTool/Commands/WrapJavaCommand.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the Swift.org open source project
 //
-// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Copyright (c) 2024-2025 Apple Inc. and the Swift.org project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -52,6 +52,9 @@ extension SwiftJava {
     @Option(help: "The names of Java classes whose declared native methods will be implemented in Swift.")
     var swiftNativeImplementation: [String] = []
 
+    @Option(help: "Cache directory for intermediate results and other outputs between runs")
+    var cacheDirectory: String?
+
     @Argument(help: "Path to .jar file whose Java classes should be wrapped using Swift bindings")
     var input: String
   }
@@ -60,34 +63,46 @@ 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
     }
 
-    // Load all of the dependent configurations and associate them with Swift
-    // modules.
-    let dependentConfigs = try loadDependentConfigs()
 
-    // Configure our own classpath based on config
-    var classpathEntries =
-      self.configureCommandJVMClasspath(effectiveSwiftModuleURL: self.effectiveSwiftModuleURL, config: config)
+
+    // Get base classpath configuration for this target and configuration
+    var classpathSearchDirs = [self.effectiveSwiftModuleURL]
+    if let cacheDir = self.cacheDirectory {
+      print("[trace][swift-java] Cache directory: \(cacheDir)")
+      classpathSearchDirs += [URL(fileURLWithPath: cacheDir)]
+    } else {
+      print("[trace][swift-java] Cache directory: none")
+    }
+    print("[trace][swift-java] INPUT: \(input)")
+
+    var classpathEntries = self.configureCommandJVMClasspath(
+        searchDirs: classpathSearchDirs, config: config)
+
+    // Load all of the dependent configurations and associate them with Swift modules.
+    let dependentConfigs = try self.loadDependentConfigs()
+    print("[debug][swift-java] Dependent configs: \(dependentConfigs.count)")
 
     // Include classpath entries which libs we depend on require...
     for (fromModule, config) in dependentConfigs {
+      print("[trace][swift-java] Add dependent config (\(fromModule)) classpath elements: \(config.classpathEntries.count)")
       // TODO: may need to resolve the dependent configs rather than just get their configs
       // TODO: We should cache the resolved classpaths as well so we don't do it many times
-      config.classpath.map { entry in
+      for entry in config.classpathEntries {
         print("[trace][swift-java] Add dependent config (\(fromModule)) classpath element: \(entry)")
         classpathEntries.append(entry)
       }
     }
 
-    let completeClasspath = classpathEntries.joined(separator: ":")
     let jvm = try self.makeJVM(classpathEntries: classpathEntries)
 
     try self.generateWrappers(
       config: config,
-      classpath: completeClasspath,
+      // classpathEntries: classpathEntries,
       dependentConfigs: dependentConfigs,
       environment: jvm.environment()
     )
@@ -118,7 +133,7 @@ extension SwiftJava.WrapJavaCommand {
 extension SwiftJava.WrapJavaCommand {
   mutating func generateWrappers(
     config: Configuration,
-    classpath: String,
+    // classpathEntries: [String],
     dependentConfigs: [(String, Configuration)],
     environment: JNIEnvironment
   ) throws {

Sources/SwiftJavaTool/CommonOptions.swift

@@ -73,22 +73,30 @@ extension HasCommonJVMOptions {
 }
 
 extension HasCommonJVMOptions {
-  func configureCommandJVMClasspath(effectiveSwiftModuleURL: Foundation.URL, config: Configuration) -> [String] {
+
+  /// Collect classpath information from various sources such as CLASSPATH, `-cp` option and
+  /// swift-java.classpath files as configured.
+  /// Parameters:
+  ///   - searchDirs: search directories where we can find swift.java.classpath files to include in the configuration
+  func configureCommandJVMClasspath(searchDirs: [Foundation.URL], config: Configuration) -> [String] {
     // Form a class path from all of our input sources:
     //   * Command-line option --classpath
     let classpathOptionEntries: [String] = self.classpathEntries
     let classpathFromEnv = ProcessInfo.processInfo.environment["CLASSPATH"]?.split(separator: ":").map(String.init) ?? []
+    print("[debug][swift-java] Base classpath from CLASSPATH environment: \(classpathFromEnv)")
     let classpathFromConfig: [String] = config.classpath?.split(separator: ":").map(String.init) ?? []
     print("[debug][swift-java] Base classpath from config: \(classpathFromConfig)")
 
     var classpathEntries: [String] = classpathFromConfig
 
-    let classPathFilesSearchDirectory = effectiveSwiftModuleURL.absoluteString
-    print("[debug][swift-java] Search *.swift-java.classpath in: \(classPathFilesSearchDirectory)")
-    let swiftJavaCachedModuleClasspath = findSwiftJavaClasspaths(in: classPathFilesSearchDirectory)
+    for searchDir in searchDirs {
+      let classPathFilesSearchDirectory = searchDir.path
+      print("[debug][swift-java] Search *.swift-java.classpath in: \(classPathFilesSearchDirectory)")
+      let foundSwiftJavaClasspath = findSwiftJavaClasspaths(in: classPathFilesSearchDirectory)
 
-    print("[debug][swift-java] Classpath from *.swift-java.classpath files: \(swiftJavaCachedModuleClasspath)")
-    classpathEntries += swiftJavaCachedModuleClasspath
+      print("[debug][swift-java] Classpath from *.swift-java.classpath files: \(foundSwiftJavaClasspath)")
+      classpathEntries += foundSwiftJavaClasspath
+    }
 
     if !classpathOptionEntries.isEmpty {
       print("[debug][swift-java] Classpath from options: \(classpathOptionEntries)")

Sources/SwiftJavaTool/SwiftJava.swift

@@ -77,19 +77,19 @@ struct SwiftJava: SwiftJavaBaseAsyncParsableCommand, HasCommonJVMOptions { // FI
   @Option(help: "The mode of generation to use for the output files. Used with jextract mode.")
   var mode: GenerationMode = .ffm
 
-  @Option(name: .shortAndLong, help: "Directory where to write cached values (e.g. swift-java.classpath files)")
-  var cacheDirectory: String? = nil
+//  @Option(name: .shortAndLong, help: "Directory where to write cached values (e.g. swift-java.classpath files)")
+//  var cacheDirectory: String? = nil
 
   @OptionGroup var commonOptions: SwiftJava.CommonOptions
   @OptionGroup var commonJVMOptions: SwiftJava.CommonJVMOptions
 
-  var effectiveCacheDirectory: String? {
-    if let cacheDirectory {
-      return cacheDirectory
-    } else {
-      return nil
-    }
-  }
+//  var effectiveCacheDirectory: String? {
+//    if let cacheDirectory {
+//      return cacheDirectory
+//    } else {
+//      return nil
+//    }
+//  }
 
 //  @Argument(
 //    help: "The input file, which is either a Java2Swift configuration file or (if '-jar' was specified) a Jar file."
@@ -193,10 +193,10 @@ struct SwiftJava: SwiftJavaBaseAsyncParsableCommand, HasCommonJVMOptions { // FI
 
     var classpathEntries: [String] = classpathFromConfig
 
-    let swiftJavaCachedModuleClasspath = findSwiftJavaClasspaths(
-      in: self.effectiveCacheDirectory ?? FileManager.default.currentDirectoryPath)
-    print("[debug][swift-java] Classpath from *.swift-java.classpath files: \(swiftJavaCachedModuleClasspath)")
-    classpathEntries += swiftJavaCachedModuleClasspath
+//    let swiftJavaCachedModuleClasspath = findSwiftJavaClasspaths(
+//      in: self.effectiveCacheDirectory ?? FileManager.default.currentDirectoryPath)
+//    print("[debug][swift-java] Classpath from *.swift-java.classpath files: \(swiftJavaCachedModuleClasspath)")
+//    classpathEntries += swiftJavaCachedModuleClasspath
 
     if !classpathOptionEntries.isEmpty {
       print("[debug][swift-java] Classpath from options: \(classpathOptionEntries)")

Sources/SwiftJavaTool/SwiftJavaBaseAsyncParsableCommand.swift

@@ -46,7 +46,7 @@ extension SwiftJavaBaseAsyncParsableCommand {
 extension SwiftJavaBaseAsyncParsableCommand {
   public mutating func run() async {
     print("[info][swift-java] Run \(Self.self): \(CommandLine.arguments.joined(separator: " "))")
-    print("[info][swift-java] Current work directory: \(URL(fileURLWithPath: "."))")
+    print("[info][swift-java] Current work directory: \(URL(fileURLWithPath: ".").path)")
 
     do {
       var config = try readInitialConfiguration(command: self)
@@ -64,16 +64,6 @@ extension SwiftJavaBaseAsyncParsableCommand {
 }
 
 extension SwiftJavaBaseAsyncParsableCommand {
-//  mutating func writeContents(
-//    _ contents: String,
-//    to filename: String, description: String) throws {
-//    try writeContents(
-//      contents,
-//      outputDirectoryOverride: self.actualOutputDirectory,
-//      to: filename,
-//      description: description)
-//  }
-
   mutating func writeContents(
     _ contents: String,
     outputDirectory: Foundation.URL?,