Refactor to converge many command line tools into a single "swift-java"

And we'll do subcommands instead.

Author: ktoso

.gitignore

@@ -11,6 +11,8 @@ DerivedData/
 *.class
 bin/
 BuildLogic/out/
+**/.index-build/
+.build-vscode/
 
 # Ignore gradle build artifacts
 .gradle

Makefile

@@ -56,29 +56,29 @@ SAMPLES_DIR := "Samples"
 all:
 	@echo "Welcome to swift-java! There are several makefile targets to choose from:"
 	@echo "  javakit-run: Run the JavaKit example program that uses Java libraries from Swift."
-	@echo "  javakit-generate: Regenerate the Swift wrapper code for the various JavaKit libraries from Java. This only has to be done when changing the Java2Swift tool."
+	@echo "  javakit-generate: Regenerate the Swift wrapper code for the various JavaKit libraries from Java. This only has to be done when changing the SwiftJava tool."
 
-$(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/Java2Swift:
+$(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/SwiftJava:
 	swift build
 
 javakit-run:
 	cd Samples/JavaKitSampleApp && swift build && java -cp .build/plugins/outputs/javakitsampleapp/JavaKitExample/destination/JavaCompilerPlugin/Java -Djava.library.path=.build/debug com.example.swift.JavaKitSampleMain
 
-Java2Swift: $(BUILD_DIR)/debug/Java2Swift
+SwiftJava: $(BUILD_DIR)/debug/SwiftJava
 
-generate-JavaKit: Java2Swift
+generate-JavaKit: SwiftJava
 	mkdir -p Sources/JavaKit/generated
-	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKit -o Sources/JavaKit/generated Sources/JavaKit/swift-java.config
+	$(BUILD_DIR)/debug/SwiftJava --module-name JavaKit -o Sources/JavaKit/generated Sources/JavaKit/swift-java.config
 
-generate-JavaKitCollection: Java2Swift
+generate-JavaKitCollection: SwiftJava
 	mkdir -p Sources/JavaKitCollection/generated
-	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitCollection  --depends-on JavaKit=Sources/JavaKit/swift-java.config -o Sources/JavaKitCollection/generated Sources/JavaKitCollection/swift-java.config
+	$(BUILD_DIR)/debug/SwiftJava --module-name JavaKitCollection  --depends-on JavaKit=Sources/JavaKit/swift-java.config -o Sources/JavaKitCollection/generated Sources/JavaKitCollection/swift-java.config
 
-generate-JavaKitFunction: Java2Swift
+generate-JavaKitFunction: SwiftJava
 	mkdir -p Sources/JavaKitFunction/generated
-	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitFunction  --depends-on JavaKit=Sources/JavaKit/swift-java.config -o Sources/JavaKitFunction/generated Sources/JavaKitFunction/swift-java.config
+	$(BUILD_DIR)/debug/SwiftJava --module-name JavaKitFunction  --depends-on JavaKit=Sources/JavaKit/swift-java.config -o Sources/JavaKitFunction/generated Sources/JavaKitFunction/swift-java.config
 
-generate-JavaKitReflection: Java2Swift generate-JavaKit generate-JavaKitCollection
+generate-JavaKitReflection: SwiftJava generate-JavaKit generate-JavaKitCollection
 	mkdir -p Sources/JavaKitReflection/generated
 	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitReflection --depends-on JavaKit=Sources/JavaKit/swift-java.config --depends-on JavaKitCollection=Sources/JavaKitCollection/swift-java.config -o Sources/JavaKitReflection/generated Sources/JavaKitReflection/swift-java.config
 

Package.swift

@@ -87,8 +87,8 @@ let package = Package(
     ),
 
     .executable(
-      name: "Java2Swift",
-      targets: ["Java2Swift"]
+      name: "SwiftJavaTool",
+      targets: ["SwiftJavaTool"]
     ),
 
     // ==== Plugin for building Java code
@@ -101,17 +101,17 @@ let package = Package(
 
     // ==== Plugin for wrapping Java classes in Swift
     .plugin(
-      name: "Java2SwiftPlugin",
+      name: "SwiftJavaPlugin",
       targets: [
-        "Java2SwiftPlugin"
+        "SwiftJavaPlugin"
       ]
     ),
 
     // ==== jextract-swift (extract Java accessors from Swift interface files)
 
     .executable(
       name: "jextract-swift",
-      targets: ["JExtractSwiftTool"]
+      targets: ["SwiftJavaTool"]
     ),
 
     // Support library written in Swift for SwiftKit "Java"
@@ -257,10 +257,10 @@ let package = Package(
     ),
 
     .plugin(
-      name: "Java2SwiftPlugin",
+      name: "SwiftJavaPlugin",
       capability: .buildTool(),
       dependencies: [
-        "Java2Swift"
+        "SwiftJavaTool"
       ]
     ),
 
@@ -320,7 +320,7 @@ let package = Package(
     ),
 
     .executableTarget(
-      name: "Java2Swift",
+      name: "SwiftJavaTool",
       dependencies: [
         .product(name: "SwiftBasicFormat", package: "swift-syntax"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
@@ -330,6 +330,7 @@ let package = Package(
         "JavaKitJar",
         "JavaKitNetwork",
         "Java2SwiftLib",
+        "JExtractSwift", // TODO: Swift2JavaLib
         "JavaKitShared",
       ],
 
@@ -356,21 +357,11 @@ let package = Package(
       ]
     ),
 
-    .executableTarget(
-      name: "JExtractSwiftTool",
-      dependencies: [
-        "JExtractSwift",
-      ],
-      swiftSettings: [
-        .swiftLanguageMode(.v5)
-      ]
-    ),
-
     .plugin(
       name: "JExtractSwiftPlugin",
       capability: .buildTool(),
       dependencies: [
-        "JExtractSwiftTool"
+        "SwiftJavaTool"
       ]
     ),
     .plugin(
@@ -380,7 +371,7 @@ let package = Package(
         permissions: [
         ]),
       dependencies: [
-        "JExtractSwiftTool"
+        "SwiftJavaTool"
       ]
     ),
 
@@ -414,7 +405,9 @@ let package = Package(
 
     .testTarget(
       name: "Java2SwiftTests",
-      dependencies: ["Java2SwiftLib"],
+      dependencies: [
+        "Java2SwiftLib"
+      ],
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])

Plugins/JExtractSwiftCommandPlugin/JExtractSwiftCommandPlugin.swift

@@ -135,7 +135,7 @@ final class JExtractSwiftCommandPlugin: SwiftJavaPluginProtocol, BuildToolPlugin
 
   func runExtract(context: PluginContext, target: Target, arguments: [String]) throws {
     let process = Process()
-    process.executableURL = try context.tool(named: "JExtractSwiftTool").url
+    process.executableURL = try context.tool(named: "SwiftJavaTool").url
     process.arguments = arguments
 
     do {

Plugins/JExtractSwiftPlugin/JExtractSwiftPlugin.swift

@@ -22,7 +22,7 @@ struct JExtractSwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
   var verbose: Bool = getEnvironmentBool("SWIFT_JAVA_VERBOSE")
 
   func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {
-    let toolURL = try context.tool(named: "JExtractSwiftTool").url
+    let toolURL = try context.tool(named: "SwiftJavaTool").url
 
     guard let sourceModule = target.sourceModule else { return [] }
 

Plugins/JavaCompilerPlugin/JavaCompilerPlugin.swift

@@ -34,7 +34,7 @@ struct JavaCompilerBuildToolPlugin: BuildToolPlugin {
 
     // The name of the configuration file JavaKit.config from the target for
     // which we are generating Swift wrappers for Java classes.
-    let configFile = URL(filePath: sourceDir).appending(path: "Java2Swift.config")
+    let configFile = URL(filePath: sourceDir).appending(path: "swift-java.config")
     let config: Configuration?
 
     if let configData = try? Data(contentsOf: configFile) {

Plugins/Java2SwiftPlugin/Java2SwiftPlugin.swift renamed to Plugins/SwiftJavaPlugin/Java2SwiftPlugin.swift

@@ -18,7 +18,7 @@ import PackagePlugin
 fileprivate let SwiftJavaConfigFileName = "swift-java.config"
 
 @main
-struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
+struct SwiftJavaBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
 
   var pluginName: String = "swift-java"
   var verbose: Bool = getEnvironmentBool("SWIFT_JAVA_VERBOSE")
@@ -27,7 +27,7 @@ struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
     log("Create build commands for target '\(target.name)'")
     guard let sourceModule = target.sourceModule else { return [] }
 
-    let executable = try context.tool(named: "Java2Swift").url
+    let executable = try context.tool(named: "SwiftJavaTool").url
     var commands: [Command] = []
 
     // Note: Target doesn't have a directoryURL counterpart to directory,
@@ -44,7 +44,7 @@ struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
     log("Config was: \(config)")
     var javaDependencies = config.dependencies ?? []
 
-    /// Find the manifest files from other Java2Swift executions in any targets
+    /// Find the manifest files from other SwiftJava executions in any targets
     /// this target depends on.
     var dependentConfigFiles: [(String, URL)] = []
     func searchForConfigFiles(in target: any Target) {
@@ -107,7 +107,7 @@ struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
     let classes = config.classes ?? [:]
     print("Classes to wrap: \(classes.map(\.key))")
 
-    /// Determine the set of Swift files that will be emitted by the Java2Swift tool.
+    /// Determine the set of Swift files that will be emitted by the SwiftJava tool.
     // TODO: this is not precise and won't work with more advanced Java files, e.g. lambdas etc.
     let outputDirectoryGenerated = self.outputDirectory(context: context, generated: true)
     let outputSwiftFiles = classes.map { (javaClassName, swiftName) in
@@ -199,7 +199,7 @@ struct Java2SwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
   }
 }
 
-extension Java2SwiftBuildToolPlugin {
+extension SwiftJavaBuildToolPlugin {
   func argumentsModuleName(sourceModule: Target) -> [String] {
     return [
       "--module-name", sourceModule.name

Plugins/Java2SwiftPlugin/_PluginsShared renamed to Plugins/SwiftJavaPlugin/_PluginsShared

@@ -76,7 +76,7 @@ let package = Package(
         .swiftLanguageMode(.v5),
       ],
       plugins: [
-        .plugin(name: "Java2SwiftPlugin", package: "swift-java"),
+        .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
       ]
     ),
 
@@ -94,7 +94,7 @@ let package = Package(
       ],
       plugins: [
 //        .plugin(name: "SwiftJavaBootstrapJavaPlugin", package: "swift-java"),
-        .plugin(name: "Java2SwiftPlugin", package: "swift-java"),
+        .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
       ]
     ),
 

Samples/JavaDependencySampleApp/Package.swift

@@ -77,7 +77,7 @@ let package = Package(
       plugins: [
         .plugin(name: "JavaCompilerPlugin", package: "swift-java"),
         .plugin(name: "JExtractSwiftPlugin", package: "swift-java"),
-        .plugin(name: "Java2SwiftPlugin", package: "swift-java"),
+        .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
       ]
     ),
   ]

Samples/JavaKitSampleApp/Package.swift

@@ -34,7 +34,7 @@ let package = Package(
         .swiftLanguageMode(.v5)
       ],
       plugins: [
-        .plugin(name: "Java2SwiftPlugin", package: "swift-java"),
+        .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
       ]
     ),
   ]

Samples/JavaProbablyPrime/Package.swift

@@ -8,5 +8,5 @@ swift run JavaProbablyPrime <very big number>
 
 The package itself demonstrates how to:
 
-* Use the Java2Swift build tool plugin to wrap the `java.math.BigInteger` type in Swift.
+* Use the SwiftJava build tool plugin to wrap the `java.math.BigInteger` type in Swift.
 * Create an instance of `BigInteger` in Swift and use its `isProbablyPrime`.

Samples/JavaProbablyPrime/README.md

@@ -58,7 +58,7 @@ let package = Package(
               .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
             ],
             plugins: [
-              .plugin(name: "Java2SwiftPlugin", package: "swift-java"),
+              .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
             ]
         ),
 
@@ -75,7 +75,7 @@ let package = Package(
               .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
             ],
             plugins: [
-              .plugin(name: "Java2SwiftPlugin", package: "swift-java"),
+              .plugin(name: "SwiftJavaPlugin", package: "swift-java"),
             ]
         ),
     ]

Samples/JavaSieve/Package.swift

@@ -2,8 +2,8 @@
 
 This package contains an example program that demonstrates importing a Java library distributed as a Jar file into Swift and using some APIs from that library. It demonstrates how to:
 
-* Use the Java2Swift tool to discover the classes in a Jar file and make them available in Swift
-* Layer Swift wrappers for Java classes as separate Swift modules using Java2Swift
+* Use the SwiftJava tool to discover the classes in a Jar file and make them available in Swift
+* Layer Swift wrappers for Java classes as separate Swift modules using SwiftJava
 * Access static methods of Java classes from Swift
 
 This example wraps an [open-source Java library](https://github.com/gazman-sdk/quadratic-sieve-Java) implementing the [Sieve of Eratosthenes](https://en.wikipedia.org/wiki/Sieve_of_Eratosthenes) algorithm for finding prime numbers, among other algorithms. To get started, clone that repository and build a Jar file containing the library:

Samples/JavaSieve/README.md

@@ -29,7 +29,7 @@ public struct Configuration: Codable {
 
   // ==== java 2 swift ---------------------------------------------------------
 
-  /// The Java class path that should be passed along to the Java2Swift tool.
+  /// The Java class path that should be passed along to the SwiftJava tool.
   public var classpath: String? = nil
 
   public var classpathEntries: [String] {

Sources/JExtractSwiftTool/JExtractSwiftTool.swift

@@ -24,24 +24,23 @@ import SwiftSyntaxBuilder
 import JavaKitConfigurationShared
 import JavaKitShared
 
-/// Command-line utility to drive the export of Java classes into Swift types.
 @main
 struct JavaToSwift: AsyncParsableCommand {
-  static var _commandName: String { "Java2Swift" }
+  static var _commandName: String { "swift-java" }
 
   @Option(help: "The name of the Swift module into which the resulting Swift types will be generated.")
   var moduleName: String?
 
   @Option(
     help:
-      "A Java2Swift configuration file for a given Swift module name on which this module depends, e.g., JavaKitJar=Sources/JavaKitJar/Java2Swift.config. There should be one of these options for each Swift module that this module depends on (transitively) that contains wrapped Java sources."
+      "A swift-java configuration file for a given Swift module name on which this module depends, e.g., JavaKitJar=Sources/JavaKitJar/swift-java.config. There should be one of these options for each Swift module that this module depends on (transitively) that contains wrapped Java sources."
   )
   var dependsOn: [String] = []
 
   // TODO: This should be a "make wrappers" option that just detects when we give it a jar
   @Flag(
     help:
-      "Specifies that the input is a Jar file whose public classes will be loaded. The output of Java2Swift will be a configuration file (Java2Swift.config) that can be used as input to a subsequent Java2Swift invocation to generate wrappers for those public classes."
+      "Specifies that the input is a Jar file whose public classes will be loaded. The output of swift-java will be a configuration file (swift-java.config) that can be used as input to a subsequent swift-java invocation to generate wrappers for those public classes."
   )
   var jar: Bool = false
 
@@ -59,7 +58,7 @@ struct JavaToSwift: AsyncParsableCommand {
   )
   var swiftNativeImplementation: [String] = []
 
-  @Option(name: .shortAndLong, help: "The directory in which to output the generated Swift files or the Java2Swift configuration file.")
+  @Option(name: .shortAndLong, help: "The directory in which to output the generated Swift files or the swift-java configuration file.")
   var outputDirectory: String? = nil
 
 
@@ -88,7 +87,7 @@ struct JavaToSwift: AsyncParsableCommand {
 
   @Argument(
     help:
-      "The input file, which is either a Java2Swift configuration file or (if '-jar' was specified) a Jar file."
+      "The input file, which is either a swift-java configuration file or (if '-jar' was specified) a Jar file."
   )
   var input: String
 

Sources/JavaKitConfigurationShared/Configuration.swift

@@ -100,7 +100,7 @@ class Java2SwiftTests: XCTestCase {
                 if let APRIL = classObj.APRIL {
                   self = APRIL
                 } else {
-                  fatalError("Enum value APRIL was unexpectedly nil, please re-run Java2Swift on the most updated Java class")
+                  fatalError("Enum value APRIL was unexpectedly nil, please re-run SwiftJava on the most updated Java class")
                 }
         """,
         """
@@ -361,7 +361,7 @@ class Java2SwiftTests: XCTestCase {
                 if let APRIL = classObj.APRIL {
                   self.init(javaHolder: APRIL.javaHolder)
                 } else {
-                  fatalError("Enum value APRIL was unexpectedly nil, please re-run Java2Swift on the most updated Java class")
+                  fatalError("Enum value APRIL was unexpectedly nil, please re-run SwiftJava on the most updated Java class")
                 }
         """,
         """