PR feedback

Author: madsodgaard

BuildLogic/src/main/kotlin/build-logic.java-common-conventions.gradle.kts

@@ -31,21 +31,6 @@ repositories {
     mavenCentral()
 }
 
-testing {
-    suites {
-//        val test by getting(JvmTestSuite::class) {
-//            useJUnitJupiter("5.10.3")
-//        }
-    }
-}
-
-/// Enable access to preview APIs, e.g. java.lang.foreign.* (Panama)
-tasks.withType(JavaCompile::class).forEach {
-    it.options.compilerArgs.add("--enable-preview")
-    it.options.compilerArgs.add("-Xlint:preview")
-}
-
-
 fun getSwiftRuntimeLibraryPaths(): List<String> {
     val process = ProcessBuilder("swiftc", "-print-target-info")
         .redirectError(ProcessBuilder.Redirect.INHERIT)

Samples/JExtractJNISampleApp/src/main/java/com/example/swift/HelloJava2SwiftJNI.java

@@ -18,12 +18,12 @@
 
 // Import javakit/swiftkit support libraries
 
-import org.swift.swiftkitffm.SwiftKit;
+import org.swift.swiftkit.core.SwiftLibraries;
 
 public class HelloJava2SwiftJNI {
 
     public static void main(String[] args) {
-        System.out.print("Property: java.library.path = " + SwiftKit.getJavaLibraryPath());
+        System.out.print("Property: java.library.path = " + SwiftLibraries.getJavaLibraryPath());
 
         examples();
     }
@@ -35,10 +35,8 @@ static void examples() {
         MySwiftLibrary.globalTakeIntInt(1337, 42);
 
         long cnt = MySwiftLibrary.globalWriteString("String from Java");
-        SwiftKit.trace("count = " + cnt);
 
         long i = MySwiftLibrary.globalMakeInt();
-        SwiftKit.trace("globalMakeInt() = " + i);
 
         MySwiftClass.method();
 

Samples/SwiftAndJavaJarSampleLib/build.gradle

@@ -43,6 +43,7 @@ java {
 }
 
 dependencies {
+    implementation(project(':SwiftKitCore'))
     implementation(project(':SwiftKitFFM'))
 
     testImplementation(platform("org.junit:junit-bom:5.10.0"))

Samples/SwiftAndJavaJarSampleLib/src/main/java/com/example/swift/HelloJava2Swift.java

@@ -17,16 +17,17 @@
 // Import swift-extract generated sources
 
 // Import javakit/swiftkit support libraries
-import org.swift.swiftkitffm.SwiftArena;
-import org.swift.swiftkitffm.SwiftFFM;
+import org.swift.swiftkit.ffm.AllocatingSwiftArena;
+import org.swift.swiftkit.ffm.SwiftRuntime;
+import org.swift.swiftkit.core.SwiftLibraries;
 
 public class HelloJava2Swift {
 
     public static void main(String[] args) {
         boolean traceDowncalls = Boolean.getBoolean("jextract.trace.downcalls");
         System.out.println("Property: jextract.trace.downcalls = " + traceDowncalls);
 
-        System.out.print("Property: java.library.path = " + SwiftFFM.getJavaLibraryPath());
+        System.out.print("Property: java.library.path = " + SwiftLibraries.getJavaLibraryPath());
 
         examples();
     }
@@ -37,12 +38,12 @@ static void examples() {
         MySwiftLibrary.globalTakeInt(1337);
 
         // Example of using an arena; MyClass.deinit is run at end of scope
-        try (var arena = SwiftArena.ofConfined()) {
+        try (var arena = AllocatingSwiftArena.ofConfined()) {
             MySwiftClass obj = MySwiftClass.init(2222, 7777, arena);
 
             // just checking retains/releases work
-            SwiftFFM.retain(obj);
-            SwiftFFM.release(obj);
+            SwiftRuntime.retain(obj);
+            SwiftRuntime.release(obj);
 
             obj.voidMethod();
             obj.takeIntMethod(42);

Samples/SwiftAndJavaJarSampleLib/src/test/java/org/swift/swiftkitffm/SwiftArenaTest.java

@@ -19,7 +19,6 @@
 import org.junit.jupiter.api.condition.DisabledIf;
 import org.swift.swiftkitffm.util.PlatformUtils;
 
-import static org.junit.jupiter.api.Assertions.*;
 import static org.swift.swiftkitffm.SwiftFFM.retainCount;
 
 public class SwiftArenaTest {

SwiftKitCore/build.gradle

@@ -16,7 +16,7 @@ plugins {
     id("build-logic.java-application-conventions")
 }
 
-group = "org.swift.swiftkitcore"
+group = "org.swift.swiftkit"
 version = "1.0-SNAPSHOT"
 
 repositories {
@@ -25,15 +25,15 @@ repositories {
 
 java {
     toolchain {
-        languageVersion.set(JavaLanguageVersion.of(24))
+        // JDK 19 is the last JDK to support Java 7
+        languageVersion.set(JavaLanguageVersion.of(19))
     }
     // Support Android 6+ (Java 7)
     sourceCompatibility = JavaVersion.VERSION_1_7
 }
 
 dependencies {
-//    testImplementation(platform("org.junit:junit-bom:5.10.0"))
-//    testImplementation("org.junit.jupiter:junit-jupiter")
+    testImplementation 'junit:junit:4.13.2'
 }
 
 tasks.test {

SwiftKitCore/src/main/java/org/swift/swiftkitcore/ClosableSwiftArena.java renamed to SwiftKitCore/src/main/java/org/swift/swiftkit/core/ClosableSwiftArena.java

@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-package org.swift.swiftkitcore;
+package org.swift.swiftkit.core;
 
 /**
  * Auto-closable version of {@link SwiftArena}.

SwiftKitCore/src/main/java/org/swift/swiftkitcore/ConfinedSwiftMemorySession.java renamed to SwiftKitCore/src/main/java/org/swift/swiftkit/core/ConfinedSwiftMemorySession.java

@@ -12,10 +12,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-package org.swift.swiftkitcore;
+package org.swift.swiftkit.core;
 
-import java.lang.foreign.Arena;
-import java.lang.foreign.MemorySegment;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -58,7 +56,7 @@ public void close() {
     public void register(SwiftInstance instance) {
         checkValid();
 
-        SwiftInstanceCleanup cleanup = instance.makeCleanupAction();
+        SwiftInstanceCleanup cleanup = instance.createCleanupAction();
         this.resources.add(cleanup);
     }
 

SwiftKitCore/src/main/java/org/swift/swiftkit/core/JNISwiftInstance.java

@@ -0,0 +1,56 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+package org.swift.swiftkit.core;
+
+import java.util.concurrent.atomic.AtomicBoolean;
+
+public abstract class JNISwiftInstance extends SwiftInstance {
+    /**
+     * The designated constructor of any imported Swift types.
+     *
+     * @param pointer a pointer to the memory containing the value
+     * @param arena   the arena this object belongs to. When the arena goes out of scope, this value is destroyed.
+     */
+    protected JNISwiftInstance(long pointer, SwiftArena arena) {
+        super(pointer, arena);
+    }
+
+    /**
+     * Creates a function that will be called when the value should be destroyed.
+     * This will be code-generated to call a native method to do deinitialization and deallocation.
+     * <p>
+     * The reason for this "indirection" is that we cannot have static methods on abstract classes,
+     * and we can't define the destroy method as a member method, because we assume that the wrapper
+     * has been released, when we destroy.
+     * <p>
+     * <b>Warning:</b> The function must not capture {@code this}.
+     *
+     * @return a function that is called when the value should be destroyed.
+     */
+    abstract Runnable $createDestroyFunction();
+
+    @Override
+    public SwiftInstanceCleanup createCleanupAction() {
+        final AtomicBoolean statusDestroyedFlag = $statusDestroyedFlag();
+        Runnable markAsDestroyed = new Runnable() {
+            @Override
+            public void run() {
+                statusDestroyedFlag.set(true);
+            }
+        };
+
+        return new JNISwiftInstanceCleanup(this.$createDestroyFunction(), markAsDestroyed);
+    }
+}

SwiftKitCore/src/main/java/org/swift/swiftkit/core/JNISwiftInstanceCleanup.java

@@ -0,0 +1,31 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+package org.swift.swiftkit.core;
+
+class JNISwiftInstanceCleanup implements SwiftInstanceCleanup {
+    private final Runnable destroyFunction;
+    private final Runnable markAsDestroyed;
+
+    public JNISwiftInstanceCleanup(Runnable destroyFunction, Runnable markAsDestroyed) {
+        this.destroyFunction = destroyFunction;
+        this.markAsDestroyed = markAsDestroyed;
+    }
+
+    @Override
+    public void run() {
+        markAsDestroyed.run();
+        destroyFunction.run();
+    }
+}