implement improved include/exclude filtering for wrap-java

ktoso · ktoso · commit 94c70c321fc7 · 2025-11-11T23:07:49.000+09:00
diff --git a/Package.swift b/Package.swift
@@ -14,6 +14,9 @@ func findJavaHome() -> String {
     print("JAVA_HOME = \(home)")
     return home
   }
+  if let opts = ProcessInfo.processInfo.environment["JAVA_OPTS"] {
+    print("JAVA_OPTS = \(opts)")
+  }
 
   // This is a workaround for envs (some IDEs) which have trouble with
   // picking up env variables during the build process
diff --git a/Samples/JavaDependencySampleApp/Sources/JavaCommonsCSV/swift-java.config b/Samples/JavaDependencySampleApp/Sources/JavaCommonsCSV/swift-java.config
@@ -1,14 +1,13 @@
 {
   "classes" : {
     "org.apache.commons.io.FilenameUtils" : "FilenameUtils",
-    "org.apache.commons.io.IOCase" : "IOCase",
     "org.apache.commons.csv.CSVFormat" : "CSVFormat",
     "org.apache.commons.csv.CSVParser" : "CSVParser",
     "org.apache.commons.csv.CSVRecord" : "CSVRecord"
   },
-  "classes-ignore" : {
-    "org.apache.commons.csv.CSVFormat$Predefined" : "",
-  },
+  "filterExclude" : [
+    "org.apache.commons.csv.CSVFormat$Predefined",
+  ],
   "dependencies" : [
     "org.apache.commons:commons-csv:1.12.0"
   ]
diff --git a/Sources/SwiftJava/JVM/JavaVirtualMachine.swift b/Sources/SwiftJava/JVM/JavaVirtualMachine.swift
@@ -94,6 +94,10 @@ public final class JavaVirtualMachine: @unchecked Sendable {
       allVMOptions.append("-Djava.class.path=\(pathSeparatedClassPath)")
     }
     allVMOptions.append(contentsOf: vmOptions)
+    
+    // Append VM options from Environment
+    allVMOptions.append(contentsOf: vmOptions)
+    allVMOptions.append(contentsOf: Self.getSwiftJavaJVMEnvOptions())
 
     // Convert the options
     let optionsBuffer = UnsafeMutableBufferPointer<JavaVMOption>.allocate(capacity: allVMOptions.count)
@@ -421,6 +425,24 @@ extension JavaVirtualMachine {
       sharedJVMPointer.classpath = []
     }
   }
+
+  /// Parse JVM options from the SWIFT_JAVA_JVM_OPTIONS environment variable.
+  /// 
+  /// For example, to enable verbose JNI logging you can do: 
+  /// ```
+  /// export JAVA_OPTS="-verbose:jni"
+  /// ```
+  public static func getSwiftJavaJVMEnvOptions() -> [String] {
+    guard let optionsString = ProcessInfo.processInfo.environment["JAVA_OPTS"],
+          !optionsString.isEmpty else {
+      return []
+    }
+    
+    return optionsString
+      .split(separator: ",")
+      .map { $0.trimmingCharacters(in: .whitespacesAndNewlines) }
+      .filter { !$0.isEmpty }
+  }
 }
 
 extension JavaVirtualMachine {
diff --git a/Sources/SwiftJava/JavaObjectHolder.swift b/Sources/SwiftJava/JavaObjectHolder.swift
@@ -17,8 +17,8 @@ import CSwiftJavaJNI
 /// Stores a reference to a Java object, managing it as a global reference so
 /// that the Java virtual machine will not move or deallocate the object
 /// while this instance is live.
-public class JavaObjectHolder {
-  public private(set) var object: jobject?
+public final class JavaObjectHolder {
+  public private(set) var object: jobject? // TODO: thread-safety
   public let environment: JNIEnvironment
 
   /// Take a reference to a Java object and promote it to a global reference
diff --git a/Sources/SwiftJava/generated/JavaCharacter.swift b/Sources/SwiftJava/generated/JavaCharacter.swift
diff --git a/Sources/SwiftJava/generated/JavaEnum.swift b/Sources/SwiftJava/generated/JavaEnum.swift
@@ -1,6 +1,11 @@
-// Auto-generated by Java-to-Swift wrapper generator.
-import CSwiftJavaJNI
+// // Auto-generated by Java-to-Swift wrapper generator.
+// import CSwiftJavaJNI
 
-@JavaClass("java.lang.Enum")
-open class JavaEnum<T: AnyJavaObject>: JavaObject {
-}
+// @JavaClass("java.lang.Enum")
+// open class JavaEnum<T: AnyJavaObject>: JavaObject {
+//   @JavaMethod
+//   public func name() -> String
+
+//   @JavaMethod
+//   public func ordinal() -> Int32
+// }
diff --git a/Sources/SwiftJava/swift-java.config b/Sources/SwiftJava/swift-java.config
@@ -16,7 +16,6 @@
     "java.lang.Long" : "JavaLong",
     "java.lang.Number" : "JavaNumber",
     "java.lang.Object" : "JavaObject",
-    "java.lang.Enum" : "JavaEnum",
     "java.lang.RuntimeException" : "RuntimeException",
     "java.lang.Short" : "JavaShort",
     "java.lang.String" : "JavaString",
diff --git a/Sources/SwiftJavaConfigurationShared/Configuration.swift b/Sources/SwiftJavaConfigurationShared/Configuration.swift
@@ -86,8 +86,10 @@ public struct Configuration: Codable {
   public var targetCompatibility: JavaVersion?
 
   /// Filter input Java types by their package prefix if set.
-  /// Can be overriden by `--filter-java-package`.
-  public var filterJavaPackage: String?
+  public var filterInclude: [String]?
+
+  /// Exclude input Java types by their package prefix or exact match.
+  public var filterExclude: [String]?
 
   // ==== dependencies ---------------------------------------------------------
 
diff --git a/Sources/SwiftJavaTool/Commands/ConfigureCommand.swift b/Sources/SwiftJavaTool/Commands/ConfigureCommand.swift
@@ -103,17 +103,16 @@ extension SwiftJava.ConfigureCommand {
     var log = Self.log
     log.logLevel = .init(rawValue: self.logLevel.rawValue)!
 
-
     log.info("Run: emit configuration...")
     var (amendExistingConfig, configuration) = try getBaseConfigurationForWrite()
 
-    if let filterJavaPackage = self.commonJVMOptions.filterJavaPackage {
-      log.debug("Generate Java->Swift type mappings. Active filter: \(filterJavaPackage)")
-    } else if let filterJavaPackage = configuration.filterJavaPackage { 
+    if !self.commonOptions.filterInclude.isEmpty {
+      log.debug("Generate Java->Swift type mappings. Active include filters: \(self.commonOptions.filterInclude)")
+    } else if let filters = configuration.filterInclude, !filters.isEmpty { 
       // take the package filter from the configuration file
-      self.commonJVMOptions.filterJavaPackage = filterJavaPackage
+      self.commonOptions.filterInclude = filters
     } else {
-      log.debug("Generate Java->Swift type mappings. No package filter applied.")
+      log.debug("Generate Java->Swift type mappings. No package include filter applied.")
     }
     log.debug("Classpath: \(classpathEntries)")
 
@@ -195,10 +194,8 @@ extension SwiftJava.ConfigureCommand {
       let javaCanonicalName = String(entry.getName().replacing("/", with: ".")
         .dropLast(".class".count))
 
-
-      if let filterJavaPackage = self.commonJVMOptions.filterJavaPackage,
-         !javaCanonicalName.hasPrefix(filterJavaPackage) {
-        // Skip classes which don't match our expected prefix
+      guard SwiftJava.shouldImport(javaCanonicalName: javaCanonicalName, commonOptions: self.commonOptions) else {
+        log.info("Skip importing class: \(javaCanonicalName) due to include/exclude filters")
         continue
       }
 
diff --git a/Sources/SwiftJavaTool/Commands/JExtractCommand.swift b/Sources/SwiftJavaTool/Commands/JExtractCommand.swift
@@ -86,9 +86,7 @@ extension SwiftJava {
 
 extension SwiftJava.JExtractCommand {
   func runSwiftJavaCommand(config: inout Configuration) async throws {
-    if let javaPackage {
-      config.javaPackage = javaPackage
-    }
+    configure(&config.javaPackage, overrideWith: self.javaPackage)
     configure(&config.mode, overrideWith: self.mode)
     config.swiftModule = self.effectiveSwiftModule
     config.outputJavaDirectory = outputJava
@@ -136,12 +134,6 @@ extension SwiftJava.JExtractCommand {
       }
     }
   }
-
-  func configure<T>(_ setting: inout T?, overrideWith value: T?) {
-    if let value {
-      setting = value
-    }
-  }
 }
 
 struct IncompatibleModeError: Error {
diff --git a/Sources/SwiftJavaTool/Commands/WrapJavaCommand.swift b/Sources/SwiftJavaTool/Commands/WrapJavaCommand.swift
@@ -66,6 +66,9 @@ extension SwiftJava {
 extension SwiftJava.WrapJavaCommand {
 
   mutating func runSwiftJavaCommand(config: inout Configuration) async throws {
+    configure(&config.filterInclude, append: self.commonOptions.filterInclude)
+    configure(&config.filterExclude, append: self.commonOptions.filterExclude)
+
     // Get base classpath configuration for this target and configuration
     var classpathSearchDirs = [self.effectiveSwiftModuleURL]
     if let cacheDir = self.cacheDirectory {
@@ -113,7 +116,6 @@ extension SwiftJava.WrapJavaCommand {
 extension SwiftJava.WrapJavaCommand {
   mutating func generateWrappers(
     config: Configuration,
-    // classpathEntries: [String],
     dependentConfigs: [(String, Configuration)],
     environment: JNIEnvironment
   ) throws {
@@ -124,6 +126,9 @@ extension SwiftJava.WrapJavaCommand {
       translateAsClass: true
     )
 
+    log.info("Active include filters: \(config.filterInclude ?? [])")
+    log.info("Active exclude filters: \(config.filterExclude ?? [])")
+
     // Keep track of all of the Java classes that will have
     // Swift-native implementations.
     translator.swiftNativeImplementations = Set(swiftNativeImplementation)
@@ -143,14 +148,23 @@ extension SwiftJava.WrapJavaCommand {
     let classLoader = try! JavaClass<ClassLoader>(environment: environment)
       .getSystemClassLoader()!
     var javaClasses: [JavaClass<JavaObject>] = []
-    for (javaClassName, _) in config.classes ?? [:] {
+    eachClass: for (javaClassName, _) in config.classes ?? [:] {
 
-      if let filterPackage = config.filterJavaPackage {
-        if javaClassName.starts(with: filterPackage) {
-          log.info("SKIP Wrapping java type: \(javaClassName)")
+      // If we have an inclusive filter, import only types from it
+      for include in config.filterInclude ?? [] {
+        guard javaClassName.starts(with: include) else {
+          log.info("Skip Java type: \(javaClassName) (does not match filter)")
           continue
         }
       }
+      // If we have an exclude filter, check for it as well
+      for exclude in config.filterExclude ?? [] { 
+        if javaClassName.starts(with: exclude) {
+          log.info("Skip Java type: \(javaClassName) (does match exclude filter: \(exclude))")
+          continue eachClass
+        }
+      }
+
       log.info("Wrapping java type: \(javaClassName)")
 
       guard let javaClass = try classLoader.loadClass(javaClassName) else {
@@ -188,6 +202,20 @@ extension SwiftJava.WrapJavaCommand {
           return nil
         }
 
+        // If we have an inclusive filter, import only types from it
+        for include in config.filterInclude ?? [] {
+          guard javaClassName.starts(with: include) else {
+            log.info("Skip Java type: \(javaClassName) (does not match filter)")
+            return nil
+          }
+        }
+        // If we have an exclude filter, check for it as well
+        for exclude in config.filterExclude ?? [] { 
+          if javaClassName.starts(with: exclude) {
+            log.info("Skip Java type: \(javaClassName) (does match exclude filter: \(exclude))")
+            return nil
+          }
+        }
 
         // If this class has been explicitly mentioned, we're done.
         guard translator.translatedClasses[javaClassName] == nil else {
diff --git a/Sources/SwiftJavaTool/CommonOptions.swift b/Sources/SwiftJavaTool/CommonOptions.swift
@@ -30,6 +30,18 @@ protocol HasCommonOptions {
   var commonOptions: SwiftJava.CommonOptions { get set }
 }
 extension HasCommonOptions {
+  func configure<T>(_ setting: inout T?, overrideWith value: T?) {
+    if let value {
+      setting = value
+    }
+  }
+  
+  func configure<T>(_ setting: inout [T]?, append value: [T]?) {
+    if let value {
+      setting?.append(contentsOf: value)
+    }
+  }
+
   var outputDirectory: String? {
     self.commonOptions.outputDirectory
   }
@@ -45,6 +57,12 @@ extension SwiftJava {
 
     @Option(name: .shortAndLong, help: "Configure the level of logs that should be printed")
     var logLevel: JExtractSwiftLib.Logger.Level = .info
+
+    @Option(name: .long, help: "While scanning a classpath, inspect ONLY types included in these packages")
+    var filterInclude: [String] = []
+
+    @Option(name: .long, help: "While scanning a classpath, skip types which match the filter prefix")
+    var filterExclude: [String] = []
   }
 
   struct CommonJVMOptions: ParsableArguments {
@@ -53,9 +71,6 @@ extension SwiftJava {
       help: "Class search path of directories and zip/jar files from which Java classes can be loaded."
     )
     var classpath: [String] = []
-
-    @Option(name: .shortAndLong, help: "While scanning a classpath, inspect only types included in this package")
-    var filterJavaPackage: String? = nil
   }
 }
 
diff --git a/Sources/SwiftJavaTool/ExcludedJDKTypes.swift b/Sources/SwiftJavaTool/ExcludedJDKTypes.swift
@@ -0,0 +1,42 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+extension SwiftJava {
+  /// Some types we cannot handle importing, so we hardcode skipping them.
+  public static let ExcludedJDKTypes: Set<String> = [
+    "java.lang.Enum",
+    "java.lang.Enum$EnumDesc",
+  ]
+
+  static func shouldImport(javaCanonicalName: String, commonOptions: SwiftJava.CommonOptions) -> Bool {
+    if SwiftJava.ExcludedJDKTypes.contains(javaCanonicalName) {
+      return false
+    }
+
+    for include in commonOptions.filterInclude {
+      guard javaCanonicalName.hasPrefix(include) else {
+        // Skip classes which don't match our expected prefix
+        return false
+      }
+    }
+
+    for exclude in commonOptions.filterExclude { 
+      if javaCanonicalName.hasPrefix(exclude) {
+        return false
+      }
+    }
+
+    return true
+  }
+}
diff --git a/Sources/SwiftJavaTool/SwiftJavaBaseAsyncParsableCommand.swift b/Sources/SwiftJavaTool/SwiftJavaBaseAsyncParsableCommand.swift
@@ -81,7 +81,7 @@ extension SwiftJavaBaseAsyncParsableCommand {
 
     // If we haven't tried to create the output directory yet, do so now before
     // we write any files to it.
-    // if !createdOutputDirectory { // FIXME: do we need this
+    // if !createdOutputDirectory {
     try FileManager.default.createDirectory(
       at: outputDir,
       withIntermediateDirectories: true
@@ -124,6 +124,8 @@ extension SwiftJavaBaseAsyncParsableCommand {
       if outputDirectory == "-" {
         return nil
       }
+//      print("[debug][swift-java] Module base directory based on outputDirectory!")
+//      return URL(fileURLWithPath: outputDirectory)
     }
 
     // Put the result into Sources/\(swiftModule).
diff --git a/Sources/SwiftJavaToolLib/JavaClassTranslator.swift b/Sources/SwiftJavaToolLib/JavaClassTranslator.swift
@@ -16,6 +16,7 @@ import SwiftJava
 import JavaLangReflect
 import SwiftSyntax
 import SwiftJavaConfigurationShared
+import Logging
 
 /// Utility type that translates a single Java class into its corresponding
 /// Swift type and any additional helper types or functions.
@@ -24,6 +25,10 @@ struct JavaClassTranslator {
   /// needed for translation.
   let translator: JavaTranslator
 
+  var log: Logger { 
+    translator.log
+  }
+
   /// The Java class (or interface) being translated.
   let javaClass: JavaClass<JavaObject>
 
@@ -785,7 +790,7 @@ extension JavaClassTranslator {
                   ? "self.init(javaHolder: \($0.getName()).javaHolder)"
                   : "self = \($0.getName())")
             } else {
-              fatalError("Enum value \($0.getName()) was unexpectedly nil, please re-run Java2Swift on the most updated Java class") 
+              fatalError("Enum value \($0.getName()) was unexpectedly nil, please re-run swift-java on the most updated Java class") 
             }
       """
     }.joined(separator: "\n"))
@@ -957,7 +962,11 @@ extension Type {
 
   /// Determine whether this type is equivalent to or a subtype of the other
   /// type.
-  func isEqualTo(_ other: Type) -> Bool {
+  func isEqualTo(_ other: Type, file: String = #file, line: Int = #line, function: String = #function) -> Bool {
+    if self.javaHolder.object == other.javaHolder.object {
+      return true
+    }
+
     // First, adjust types to their bounds, if we need to.
     var anyAdjusted: Bool = false
     let adjustedSelf = self.adjustToJavaBounds(adjusted: &anyAdjusted)
diff --git a/Sources/SwiftJavaToolLib/JavaTranslator.swift b/Sources/SwiftJavaToolLib/JavaTranslator.swift
diff --git a/Tests/JExtractSwiftTests/JNI/JNIUnsignedNumberTests.swift b/Tests/JExtractSwiftTests/JNI/JNIUnsignedNumberTests.swift
diff --git a/Tests/SwiftJavaTests/BasicRuntimeTests.swift b/Tests/SwiftJavaTests/BasicRuntimeTests.swift
diff --git a/Tests/SwiftJavaToolLibTests/Java2SwiftTests.swift b/Tests/SwiftJavaToolLibTests/Java2SwiftTests.swift

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@ func findJavaHome() -> String {`
`14`	`14`	`print("JAVA_HOME = \(home)")`
`15`	`15`	`return home`
`16`	`16`	`}`
	`17`	`+ if let opts = ProcessInfo.processInfo.environment["JAVA_OPTS"] {`
	`18`	`+ print("JAVA_OPTS = \(opts)")`
	`19`	`+ }`
`17`	`20`
`18`	`21`	`// This is a workaround for envs (some IDEs) which have trouble with`
`19`	`22`	`// picking up env variables during the build process`
Original file line number	Diff line number	Diff line change
`@@ -86,9 +86,7 @@ extension SwiftJava {`
`86`	`86`
`87`	`87`	`extension SwiftJava.JExtractCommand {`
`88`	`88`	`func runSwiftJavaCommand(config: inout Configuration) async throws {`
`89`		`- if let javaPackage {`
`90`		`- config.javaPackage = javaPackage`
`91`		`- }`
	`89`	`+ configure(&config.javaPackage, overrideWith: self.javaPackage)`
`92`	`90`	`configure(&config.mode, overrideWith: self.mode)`
`93`	`91`	`config.swiftModule = self.effectiveSwiftModule`
`94`	`92`	`config.outputJavaDirectory = outputJava`
`@@ -136,12 +134,6 @@ extension SwiftJava.JExtractCommand {`
`136`	`134`	`}`
`137`	`135`	`}`
`138`	`136`	`}`
`139`		`-`
`140`		`- func configure<T>(_ setting: inout T?, overrideWith value: T?) {`
`141`		`- if let value {`
`142`		`- setting = value`
`143`		`- }`
`144`		`- }`
`145`	`137`	`}`
`146`	`138`
`147`	`139`	`struct IncompatibleModeError: Error {`