Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 23, 2024
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
605e130
Make the "environment" parameter to @JavaMethod initializers optional…
TimWangING Oct 22, 2024
a8eb541
Adjust syntax of setting `_environment` to avoid force unwrapping bas…
TimWangING Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 13 additions & 29 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,6 @@ let package = Package(
targets: ["JavaKitReflection"]
),

.library(
name: "JavaKitVM",
targets: ["JavaKitVM"]
),

.library(
name: "JavaTypes",
targets: ["JavaTypes"]
Expand Down Expand Up @@ -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(
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -272,7 +258,6 @@ let package = Package(
"JavaKitJar",
"JavaKitReflection",
"JavaKitNetwork",
"JavaKitVM",
"JavaTypes",
],
swiftSettings: [
Expand All @@ -291,7 +276,6 @@ let package = Package(
"JavaKit",
"JavaKitJar",
"JavaKitNetwork",
"JavaKitVM",
"Java2SwiftLib",
],

Expand Down Expand Up @@ -328,7 +312,7 @@ let package = Package(

.testTarget(
name: "JavaKitTests",
dependencies: ["JavaKit", "JavaKitNetwork", "JavaKitVM"],
dependencies: ["JavaKit", "JavaKitNetwork"],
swiftSettings: [
.swiftLanguageMode(.v5)
]
Expand Down
1 change: 0 additions & 1 deletion Samples/JavaProbablyPrime/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
Expand Down
1 change: 0 additions & 1 deletion Samples/JavaProbablyPrime/Sources/JavaProbablyPrime/prime.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@

import ArgumentParser
import JavaKit
import JavaKitVM

@main
struct ProbablyPrime: ParsableCommand {
Expand Down
1 change: 0 additions & 1 deletion Samples/JavaSieve/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)"])
Expand Down
1 change: 0 additions & 1 deletion Sources/Java2Swift/JavaToSwift.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import JavaKit
import JavaKitJar
import JavaKitNetwork
import JavaKitReflection
import JavaKitVM
import SwiftSyntax
import SwiftSyntaxBuilder

Expand Down
7 changes: 4 additions & 3 deletions Sources/Java2SwiftLib/JavaTranslator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" : ""

Expand Down Expand Up @@ -483,8 +483,9 @@ 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 = environment == nil ? try! JavaVirtualMachine.shared().environment() : environment!
Copy link
Member

@DougGregor DougGregor Oct 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd rather do this without the force-unwraps, even if it's more verbose:

let _environment = if let environment {
  environment
} else {
  try! JavaVirtualMachine.shared().environment()
}

let classObj = try! JavaClass<Self>(in: _environment)
switch enumValue {
\(raw: enumFields.map {
return """
Expand Down
2 changes: 0 additions & 2 deletions Sources/JavaKitVM/JavaVirtualMachine.swift → ...avaKit/JavaKitVM/JavaVirtualMachine.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
//
//===----------------------------------------------------------------------===//

import JavaKit

typealias JavaVMPointer = UnsafeMutablePointer<JavaVM?>

public final class JavaVirtualMachine: @unchecked Sendable {
Expand Down
0 Sources/JavaKitVM/LockedState.swift → Sources/JavaKit/JavaKitVM/LockedState.swift
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions Sources/JavaKit/generated/Exception.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
8 changes: 4 additions & 4 deletions Sources/JavaKit/generated/JavaError.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion Sources/JavaKit/generated/JavaObject.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import JavaRuntime
@JavaClass("java.lang.Object")
public struct JavaObject {
@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func equals(_ arg0: JavaObject?) -> Bool
Expand Down
8 changes: 4 additions & 4 deletions Sources/JavaKit/generated/RuntimeException.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ import JavaRuntime
@JavaClass("java.lang.RuntimeException", extends: Exception.self)
public struct RuntimeException {
@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()
Expand Down
8 changes: 4 additions & 4 deletions Sources/JavaKit/generated/Throwable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@ import JavaRuntime
@JavaClass("java.lang.Throwable")
public struct Throwable {
@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()
Expand Down
6 changes: 3 additions & 3 deletions Sources/JavaKitCollection/generated/ArrayDeque.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import JavaRuntime
@JavaClass("java.util.ArrayDeque")
public struct ArrayDeque<E: AnyJavaObject> {
@JavaMethod
public init(_ arg0: Int32, environment: JNIEnvironment)
public init(_ arg0: Int32, environment: JNIEnvironment? = nil)

@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment)
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment? = nil)

@JavaMethod
public func remove() -> JavaObject?
Expand Down
6 changes: 3 additions & 3 deletions Sources/JavaKitCollection/generated/ArrayList.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import JavaRuntime
@JavaClass("java.util.ArrayList", implements: List<JavaObject>.self, RandomAccess.self)
public struct ArrayList<E: AnyJavaObject> {
@JavaMethod
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment)
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment? = nil)

@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: Int32, environment: JNIEnvironment)
public init(_ arg0: Int32, environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> Bool
Expand Down
4 changes: 2 additions & 2 deletions Sources/JavaKitCollection/generated/BitSet.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import JavaRuntime
@JavaClass("java.util.BitSet")
public struct BitSet {
@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: Int32, environment: JNIEnvironment)
public init(_ arg0: Int32, environment: JNIEnvironment? = nil)

@JavaMethod
public func cardinality() -> Int32
Expand Down
6 changes: 3 additions & 3 deletions Sources/JavaKitCollection/generated/HashMap.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import JavaRuntime
@JavaClass("java.util.HashMap")
public struct HashMap<K: AnyJavaObject, V: AnyJavaObject> {
@JavaMethod
public init(_ arg0: Int32, environment: JNIEnvironment)
public init(_ arg0: Int32, environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: Int32, _ arg1: Float, environment: JNIEnvironment)
public init(_ arg0: Int32, _ arg1: Float, environment: JNIEnvironment? = nil)

@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> JavaObject?
Expand Down
8 changes: 4 additions & 4 deletions Sources/JavaKitCollection/generated/HashSet.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ import JavaRuntime
@JavaClass("java.util.HashSet", implements: JavaSet<JavaObject>.self)
public struct HashSet<E: AnyJavaObject> {
@JavaMethod
public init(_ arg0: Int32, environment: JNIEnvironment)
public init(_ arg0: Int32, environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: Int32, _ arg1: Float, environment: JNIEnvironment)
public init(_ arg0: Int32, _ arg1: Float, environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment)
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment? = nil)

@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> Bool
Expand Down
2 changes: 1 addition & 1 deletion Sources/JavaKitCollection/generated/JavaDictionary.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import JavaRuntime
@JavaClass("java.util.Dictionary")
public struct JavaDictionary<K: AnyJavaObject, V: AnyJavaObject> {
@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> JavaObject?
Expand Down
4 changes: 2 additions & 2 deletions Sources/JavaKitCollection/generated/LinkedList.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import JavaRuntime
@JavaClass("java.util.LinkedList")
public struct LinkedList<E: AnyJavaObject> {
@JavaMethod
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment)
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment? = nil)

@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> Bool
Expand Down
8 changes: 4 additions & 4 deletions Sources/JavaKitCollection/generated/PriorityQueue.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ import JavaRuntime
@JavaClass("java.util.PriorityQueue")
public struct PriorityQueue<E: AnyJavaObject> {
@JavaMethod
public init(_ arg0: PriorityQueue<JavaObject>?, environment: JNIEnvironment)
public init(_ arg0: PriorityQueue<JavaObject>?, environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment)
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment? = nil)

@JavaMethod
public init(_ arg0: Int32, environment: JNIEnvironment)
public init(_ arg0: Int32, environment: JNIEnvironment? = nil)

@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> Bool
Expand Down
2 changes: 1 addition & 1 deletion Sources/JavaKitCollection/generated/Stack.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import JavaRuntime
@JavaClass("java.util.Stack")
public struct Stack<E: AnyJavaObject> {
@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func empty() -> Bool
Expand Down
2 changes: 1 addition & 1 deletion Sources/JavaKitCollection/generated/TreeMap.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import JavaRuntime
@JavaClass("java.util.TreeMap")
public struct TreeMap<K: AnyJavaObject, V: AnyJavaObject> {
@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> JavaObject?
Expand Down
4 changes: 2 additions & 2 deletions Sources/JavaKitCollection/generated/TreeSet.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import JavaRuntime
@JavaClass("java.util.TreeSet")
public struct TreeSet<E: AnyJavaObject> {
@JavaMethod
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment)
public init(_ arg0: JavaCollection<JavaObject>?, environment: JNIEnvironment? = nil)

@JavaMethod
public init(environment: JNIEnvironment)
public init(environment: JNIEnvironment? = nil)

@JavaMethod
public func remove(_ arg0: JavaObject?) -> Bool
Expand Down
Loading