Make the "environment" parameter to @JavaMethod initializers optional (#102)

Co-authored-by: Tim Wang <tim.wang@ing.com>

Author: ShenghaiWang

Package.swift

@@ -77,11 +77,6 @@ let package = Package(
       targets: ["JavaKitReflection"]
     ),
 
-    .library(
-      name: "JavaKitVM",
-      targets: ["JavaKitVM"]
-    ),
-
     .library(
       name: "JavaTypes",
       targets: ["JavaTypes"]
@@ -165,6 +160,18 @@ let package = Package(
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
+      ],
+      linkerSettings: [
+        .unsafeFlags(
+          [
+            "-L\(javaHome)/lib/server",
+            "-Xlinker",
+            "-rpath",
+            "-Xlinker",
+            "\(javaHome)/lib/server",
+          ]
+        ),
+        .linkedLibrary("jvm"),
       ]
     ),
     .target(
@@ -203,27 +210,6 @@ let package = Package(
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
       ]
     ),
-    .target(
-      name: "JavaKitVM",
-      dependencies: ["JavaKit"],
-      swiftSettings: [
-        .swiftLanguageMode(.v5),
-        .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
-      ],
-      linkerSettings: [
-        .unsafeFlags(
-          [
-            "-L\(javaHome)/lib/server",
-            "-Xlinker",
-            "-rpath",
-            "-Xlinker",
-            "\(javaHome)/lib/server",
-          ]
-        ),
-        .linkedLibrary("jvm"),
-      ]
-    ),
-
     .plugin(
         name: "JavaCompilerPlugin",
         capability: .buildTool()
@@ -272,7 +258,6 @@ let package = Package(
         "JavaKitJar",
         "JavaKitReflection",
         "JavaKitNetwork",
-        "JavaKitVM",
         "JavaTypes",
       ],
       swiftSettings: [
@@ -291,7 +276,6 @@ let package = Package(
         "JavaKit",
         "JavaKitJar",
         "JavaKitNetwork",
-        "JavaKitVM",
         "Java2SwiftLib",
       ],
 
@@ -328,7 +312,7 @@ let package = Package(
 
     .testTarget(
       name: "JavaKitTests",
-      dependencies: ["JavaKit", "JavaKitNetwork", "JavaKitVM"],
+      dependencies: ["JavaKit", "JavaKitNetwork"],
       swiftSettings: [
         .swiftLanguageMode(.v5)
       ]

Samples/JavaProbablyPrime/Package.swift

@@ -27,7 +27,6 @@ let package = Package(
       name: "JavaProbablyPrime",
       dependencies: [
         .product(name: "JavaKit", package: "swift-java"),
-        .product(name: "JavaKitVM", package: "swift-java"),
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
       ],
       swiftSettings: [

Samples/JavaProbablyPrime/Sources/JavaProbablyPrime/prime.swift

@@ -14,7 +14,6 @@
 
 import ArgumentParser
 import JavaKit
-import JavaKitVM
 
 @main
 struct ProbablyPrime: ParsableCommand {

Samples/JavaSieve/Package.swift

@@ -70,7 +70,6 @@ let package = Package(
                 "JavaMath",
                 .product(name: "JavaKit", package: "swift-java"),
                 .product(name: "JavaKitCollection", package: "swift-java"),
-                .product(name: "JavaKitVM", package: "swift-java"),
             ],
             swiftSettings: [
               .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])

Sources/Java2Swift/JavaToSwift.swift

@@ -19,7 +19,6 @@ import JavaKit
 import JavaKitJar
 import JavaKitNetwork
 import JavaKitReflection
-import JavaKitVM
 import SwiftSyntax
 import SwiftSyntaxBuilder
 

Sources/Java2SwiftLib/JavaTranslator.swift

@@ -410,7 +410,7 @@ extension JavaTranslator {
 extension JavaTranslator {
   /// Translates the given Java constructor into a Swift declaration.
   package func translateConstructor(_ javaConstructor: Constructor<some AnyJavaObject>) throws -> DeclSyntax {
-    let parameters = try translateParameters(javaConstructor.getParameters()) + ["environment: JNIEnvironment"]
+    let parameters = try translateParameters(javaConstructor.getParameters()) + ["environment: JNIEnvironment? = nil"]
     let parametersStr = parameters.map { $0.description }.joined(separator: ", ")
     let throwsStr = javaConstructor.throwsCheckedException ? "throws" : ""
 
@@ -483,8 +483,13 @@ extension JavaTranslator {
     """
 
     let initSyntax: DeclSyntax = """
-    public init(_ enumValue: \(raw: name), environment: JNIEnvironment) {
-      let classObj = try! JavaClass<Self>(in: environment)
+    public init(_ enumValue: \(raw: name), environment: JNIEnvironment? = nil) {
+      let _environment = if let environment {
+        environment
+      } else {
+        try! JavaVirtualMachine.shared().environment()
+      }
+      let classObj = try! JavaClass<Self>(in: _environment)
       switch enumValue {
     \(raw: enumFields.map {
       return """

Sources/JavaKitVM/JavaVirtualMachine.swift renamed to Sources/JavaKit/JavaKitVM/JavaVirtualMachine.swift

@@ -12,8 +12,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import JavaKit
-
 typealias JavaVMPointer = UnsafeMutablePointer<JavaVM?>
 
 public final class JavaVirtualMachine: @unchecked Sendable {

Sources/JavaKitVM/LockedState.swift renamed to Sources/JavaKit/JavaKitVM/LockedState.swift

@@ -4,16 +4,16 @@ import JavaRuntime
 @JavaClass("java.lang.Exception", extends: Throwable.self)
 public struct Exception {
   @JavaMethod
-  public init(_ arg0: Throwable?, environment: JNIEnvironment)
+  public init(_ arg0: Throwable?, environment: JNIEnvironment? = nil)
 
   @JavaMethod
-  public init(_ arg0: String, _ arg1: Throwable?, environment: JNIEnvironment)
+  public init(_ arg0: String, _ arg1: Throwable?, environment: JNIEnvironment? = nil)
 
   @JavaMethod
-  public init(_ arg0: String, environment: JNIEnvironment)
+  public init(_ arg0: String, environment: JNIEnvironment? = nil)
 
   @JavaMethod
-  public init(environment: JNIEnvironment)
+  public init(environment: JNIEnvironment? = nil)
 
   @JavaMethod
   public func printStackTrace()

Sources/JavaKit/generated/Exception.swift

@@ -4,16 +4,16 @@ import JavaRuntime
 @JavaClass("java.lang.Error", extends: Throwable.self)
 public struct JavaError {
   @JavaMethod
-  public init(_ arg0: Throwable?, environment: JNIEnvironment)
+  public init(_ arg0: Throwable?, environment: JNIEnvironment? = nil)
 
   @JavaMethod
-  public init(_ arg0: String, _ arg1: Throwable?, environment: JNIEnvironment)
+  public init(_ arg0: String, _ arg1: Throwable?, environment: JNIEnvironment? = nil)
 
   @JavaMethod
-  public init(_ arg0: String, environment: JNIEnvironment)
+  public init(_ arg0: String, environment: JNIEnvironment? = nil)
 
   @JavaMethod
-  public init(environment: JNIEnvironment)
+  public init(environment: JNIEnvironment? = nil)
 
   @JavaMethod
   public func printStackTrace()