[JExtract] Rework WIP

Author: rintaro

Samples/SwiftKitSampleApp/Sources/MySwiftLibrary/MySwiftClass.swift

@@ -34,6 +34,10 @@ public class MySwiftClass {
 
   public var counter: Int32 = 0
 
+  public static func factory(len: Int, cap: Int) -> MySwiftClass {
+    return MySwiftClass(len: len, cap: cap)
+  }
+
   public func voidMethod() {
     p("")
   }

Samples/SwiftKitSampleApp/build.gradle

@@ -81,7 +81,7 @@ def jextract = tasks.register("jextract", Exec) {
 
     workingDir = layout.projectDirectory
     commandLine "swift"
-    args("package", "jextract", "-v", "--log-level", "info") // TODO: pass log level from Gradle build
+    args("package", "jextract", "-v", "--log-level", "debug") // TODO: pass log level from Gradle build
 }
 
 // Add the java-swift generated Java sources

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

@@ -16,13 +16,16 @@
 
 // Import swift-extract generated sources
 
-import com.example.swift.MySwiftLibrary;
-import com.example.swift.MySwiftClass;
-
 // Import javakit/swiftkit support libraries
 import org.swift.swiftkit.SwiftArena;
 import org.swift.swiftkit.SwiftKit;
-import org.swift.swiftkit.SwiftValueWitnessTable;
+import org.swift.swiftkit.SwiftValueLayout;
+
+import java.lang.foreign.Arena;
+import java.lang.foreign.MemoryLayout;
+import java.lang.foreign.MemorySegment;
+import java.lang.foreign.ValueLayout;
+import java.util.concurrent.Callable;
 
 public class HelloJava2Swift {
 
@@ -40,18 +43,33 @@ static void examples() {
 
         MySwiftLibrary.globalTakeInt(1337);
 
+        long cnt =  MySwiftLibrary.globalWriteString("String from Java");
+
+        SwiftKit.trace("count = " + cnt);
+
+        MySwiftLibrary.globalCallMeRunnable(() -> {
+            SwiftKit.trace("running runnable");
+        });
+
         // Example of using an arena; MyClass.deinit is run at end of scope
         try (var arena = SwiftArena.ofConfined()) {
-             MySwiftClass obj = new MySwiftClass(arena, 2222, 7777);
+            MySwiftClass obj = new MySwiftClass(2222, 7777, arena);
+
+            // just checking retains/releases work
+            SwiftKit.trace("retainCount = " + SwiftKit.retainCount(obj));
+            SwiftKit.retain(obj);
+            SwiftKit.trace("retainCount = " + SwiftKit.retainCount(obj));
+            SwiftKit.release(obj);
+            SwiftKit.trace("retainCount = " + SwiftKit.retainCount(obj));
 
-             // just checking retains/releases work
-             SwiftKit.retain(obj.$memorySegment());
-             SwiftKit.release(obj.$memorySegment());
+            obj.setCounter(12);
+            SwiftKit.trace("obj.counter = " + obj.getCounter());
 
-             obj.voidMethod();
-             obj.takeIntMethod(42);
+            obj.voidMethod();
+            obj.takeIntMethod(42);
 
-            MySwiftStruct swiftValue = new MySwiftStruct(arena, 2222, 1111);
+            MySwiftStruct swiftValue = new MySwiftStruct(2222, 1111, arena);
+            SwiftKit.trace("swiftValue.capacity = " + swiftValue.getCapacity());
         }
 
         System.out.println("DONE.");

Samples/SwiftKitSampleApp/src/test/java/com/example/swift/MySwiftLibraryTest.java

@@ -35,15 +35,11 @@ public class MySwiftLibraryTest {
     @Test
     void call_helloWorld() {
         MySwiftLibrary.helloWorld();
-
-        assertNotNull(MySwiftLibrary.helloWorld$address());
     }
 
     @Test
     void call_globalTakeInt() {
         MySwiftLibrary.globalTakeInt(12);
-
-        assertNotNull(MySwiftLibrary.globalTakeInt$address());
     }
 
     @Test

Samples/SwiftKitSampleApp/src/test/java/org/swift/swiftkit/MySwiftClassTest.java

@@ -25,7 +25,7 @@ public class MySwiftClassTest {
     @Test
     void call_retain_retainCount_release() {
         var arena = SwiftArena.ofConfined();
-        var obj = new MySwiftClass(arena, 1, 2);
+        var obj = new MySwiftClass(1, 2, arena);
 
         assertEquals(1, SwiftKit.retainCount(obj.$memorySegment()));
         // TODO: test directly on SwiftHeapObject inheriting obj

Samples/SwiftKitSampleApp/src/test/java/org/swift/swiftkit/MySwiftStructTest.java

@@ -26,7 +26,7 @@ void create_struct() {
         try (var arena = SwiftArena.ofConfined()) {
             long cap = 12;
             long len = 34;
-            var struct = new MySwiftStruct(arena, cap, len);
+            var struct = new MySwiftStruct(cap, len, arena);
 
             assertEquals(cap, struct.getCapacity());
             assertEquals(len, struct.getLength());

Samples/SwiftKitSampleApp/src/test/java/org/swift/swiftkit/SwiftArenaTest.java

@@ -40,7 +40,7 @@ static boolean isAmd64() {
     @DisabledIf("isAmd64")
     public void arena_releaseClassOnClose_class_ok() {
         try (var arena = SwiftArena.ofConfined()) {
-            var obj = new MySwiftClass(arena,1, 2);
+            var obj = new MySwiftClass(1, 2, arena);
 
             retain(obj.$memorySegment());
             assertEquals(2, retainCount(obj.$memorySegment()));
@@ -57,7 +57,7 @@ public void arena_markAsDestroyed_preventUseAfterFree_class() {
         MySwiftClass unsafelyEscapedOutsideArenaScope = null;
 
         try (var arena = SwiftArena.ofConfined()) {
-            var obj = new MySwiftClass(arena,1, 2);
+            var obj = new MySwiftClass(1, 2, arena);
             unsafelyEscapedOutsideArenaScope = obj;
         }
 
@@ -76,7 +76,7 @@ public void arena_markAsDestroyed_preventUseAfterFree_struct() {
         MySwiftStruct unsafelyEscapedOutsideArenaScope = null;
 
         try (var arena = SwiftArena.ofConfined()) {
-            var s = new MySwiftStruct(arena,1, 2);
+            var s = new MySwiftStruct(1, 2, arena);
             unsafelyEscapedOutsideArenaScope = s;
         }
 
@@ -88,27 +88,6 @@ public void arena_markAsDestroyed_preventUseAfterFree_struct() {
         }
     }
 
-    @Test
-    public void arena_releaseClassOnClose_class_leaked() {
-        String memorySegmentDescription = "<none>";
-
-        try {
-            try (var arena = SwiftArena.ofConfined()) {
-                var obj = new MySwiftClass(arena,1, 2);
-                memorySegmentDescription = obj.$memorySegment().toString();
-
-                // Pretend that we "leaked" the class, something still holds a reference to it while we try to destroy it
-                retain(obj.$memorySegment());
-                assertEquals(2, retainCount(obj.$memorySegment()));
-            }
-
-            fail("Expected exception to be thrown while the arena is closed!");
-        } catch (Exception ex) {
-            // The message should point out which objects "leaked":
-            assertTrue(ex.getMessage().contains(memorySegmentDescription));
-        }
-    }
-
     @Test
     public void arena_initializeWithCopy_struct() {
 

Sources/JExtractSwift/CDeclLowering/CRepresentation.swift

@@ -21,7 +21,7 @@ extension CType {
   /// function, first go through Swift -> cdecl lowering. This function
   /// will throw an error if it encounters a type that is not expressible in
   /// C.
-  init(cdeclType: SwiftType) throws {
+init(cdeclType: SwiftType) throws {
     switch cdeclType {
     case .nominal(let nominalType):
       if let knownType = nominalType.nominalTypeDecl.knownStandardLibraryType {

Sources/JExtractSwift/CTypes/CType.swift

@@ -298,3 +298,12 @@ extension CType {
     }
   }
 }
+
+extension CType {
+  var isVoid: Bool {
+    return switch self {
+    case .void: true
+    default: false
+    }
+  }
+}

Sources/JExtractSwift/CodePrinter.swift

@@ -68,16 +68,16 @@ public struct CodePrinter {
     }
   }
 
-  public mutating func printTypeDecl(
-    _ text: Any,
+  public mutating func printBraceBlock(
+    _ header: Any,
     function: String = #function,
     file: String = #fileID,
     line: UInt = #line,
-    body: (inout CodePrinter) -> ()
-  ) {
-    print("\(text) {")
+    body: (inout CodePrinter) throws -> ()
+  ) rethrows {
+    print("\(header) {")
     indent()
-    body(&self)
+    try body(&self)
     outdent()
     print("}", .sloc, function: function, file: file, line: line)
   }
@@ -145,9 +145,10 @@ public struct CodePrinter {
 
   // TODO: remove this in real mode, this just helps visually while working on it
   public mutating func printSeparator(_ text: String) {
-    // TODO: actually use the indentationDepth
+    assert(!text.contains(where: \.isNewline))
     print(
       """
+
       // ==== --------------------------------------------------
       // \(text)
 

Sources/JExtractSwift/Convenience/SwiftSyntax+Extensions.swift

@@ -37,21 +37,6 @@ extension ImplicitlyUnwrappedOptionalTypeSyntax {
 }
 
 extension SyntaxProtocol {
-
-  var asNominalTypeKind: NominalTypeKind {
-    if isClass {
-      .class
-    } else if isActor {
-      .actor
-    } else if isStruct {
-      .struct
-    } else if isEnum {
-      .enum
-    } else {
-      fatalError("Unknown nominal kind: \(self)")
-    }
-  }
-
   var isClass: Bool {
     return self.is(ClassDeclSyntax.self)
   }

Sources/JExtractSwift/ImportedDecls+Printing.swift

@@ -20,82 +20,14 @@ extension ImportedFunc {
   /// Render a `@{@snippet ... }` comment section that can be put inside a JavaDoc comment
   /// when referring to the original declaration a printed method refers to.
   var renderCommentSnippet: String? {
-    if let syntax {
+    if let signatureString {
       """
        * {@snippet lang=swift :
-       * \(syntax)
+       * \(signatureString)
        * }
       """
     } else {
       nil
     }
   }
 }
-
-extension VariableAccessorKind {
-
-  public var fieldSuffix: String {
-    switch self {
-      case .get: "_GET"
-      case .set: "_SET"
-    }
-  }
-
-  public var renderDescFieldName: String {
-    switch self {
-    case .get: "DESC_GET"
-    case .set: "DESC_SET"
-    }
-  }
-
-  public var renderAddrFieldName: String {
-    switch self {
-    case .get: "ADDR_GET"
-    case .set: "ADDR_SET"
-    }
-  }
-
-  public var renderHandleFieldName: String {
-    switch self {
-    case .get: "HANDLE_GET"
-    case .set: "HANDLE_SET"
-    }
-  }
-
-  /// Renders a "$get" part that can be used in a method signature representing this accessor.
-  public var renderMethodNameSegment: String {
-    switch self {
-    case .get: "$get"
-    case .set: "$set"
-    }
-  }
-
-  func renderMethodName(_ decl: ImportedFunc) -> String? {
-    switch self {
-    case .get: "get\(decl.identifier.toCamelCase)"
-    case .set: "set\(decl.identifier.toCamelCase)"
-    }
-  }
-}
-
-extension Optional where Wrapped == VariableAccessorKind {
-  public var renderDescFieldName: String {
-    self?.renderDescFieldName ?? "DESC"
-  }
-
-  public var renderAddrFieldName: String {
-    self?.renderAddrFieldName ?? "ADDR"
-  }
-
-  public var renderHandleFieldName: String {
-    self?.renderHandleFieldName ?? "HANDLE"
-  }
-
-  public var renderMethodNameSegment: String {
-    self?.renderMethodNameSegment ?? ""
-  }
-
-  func renderMethodName(_ decl: ImportedFunc) -> String {
-    self?.renderMethodName(decl) ?? decl.baseIdentifier
-  }
-}