jextract/ffm: Support returning Strings, we copy and have to free it on

java side

Add runtime tests in ffm sample

jextract/ffm: Support returning Strings, we copy and have to free it on
java side

Author: ktoso

Package.swift

@@ -396,5 +396,15 @@ let package = Package(
         .swiftLanguageMode(.v5)
       ]
     ),
+
+    .testTarget(
+      name: "SwiftRuntimeFunctionsTests",
+      dependencies: [
+        "SwiftRuntimeFunctions",
+      ],
+      swiftSettings: [
+        .swiftLanguageMode(.v5)
+      ]
+    ),
   ]
 )

Samples/SwiftJavaExtractFFMSampleApp/Sources/MySwiftLibrary/MySwiftClass.swift

@@ -46,6 +46,10 @@ public class MySwiftClass {
     12
   }
 
+  public func describe() -> String {
+    "MySwiftClass(len: \(len), cap: \(cap))"
+  }
+
   public func makeRandomIntMethod() -> Int {
     Int.random(in: 1..<256)
   }

Samples/SwiftJavaExtractFFMSampleApp/Sources/MySwiftLibrary/MySwiftLibrary.swift

@@ -114,6 +114,17 @@ public func globalReceiveOptional(o1: Int?, o2: (some DataProtocol)?) -> Int {
   }
 }
 
+// ==== -----------------------------------------------------------------------
+// MARK: String returns
+
+public func globalMakeString() -> String {
+  "Hello from Swift!"
+}
+
+public func globalStringIdentity(string: String) -> String {
+  string
+}
+
 // ==== -----------------------------------------------------------------------
 // MARK: Overloaded functions
 

Samples/SwiftJavaExtractFFMSampleApp/src/test/java/com/example/swift/MySwiftClassTest.java

@@ -58,6 +58,15 @@ void test_MySwiftClass_makeIntMethod() {
         }
     }
 
+    @Test
+    void test_MySwiftClass_describe() {
+        try(var arena = AllocatingSwiftArena.ofConfined()) {
+            MySwiftClass o = MySwiftClass.init(12, 42, arena);
+            var got = o.describe();
+            assertEquals("MySwiftClass(len: 12, cap: 42)", got);
+        }
+    }
+
     @Test
     @Disabled // TODO: Need var mangled names in interfaces
     void test_MySwiftClass_property_len() {

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

@@ -53,6 +53,27 @@ void call_writeString_jni() {
         assertEquals(string.length(), reply);
     }
 
+    @Test
+    void call_globalMakeString() {
+        String result = MySwiftLibrary.globalMakeString();
+        assertEquals("Hello from Swift!", result);
+    }
+
+    @Test
+    void call_globalStringIdentity() {
+        String input = "round-trip test!";
+        String result = MySwiftLibrary.globalStringIdentity(input);
+        assertEquals(input, result);
+    }
+
+    @Test
+    void call_globalStringIdentity_empty() {
+        String result = MySwiftLibrary.globalStringIdentity("");
+        assertEquals("", result);
+    }
+
+
+
     @Test
     @Disabled("Upcalls not yet implemented in new scheme")
     @SuppressWarnings({"Convert2Lambda", "Convert2MethodRef"})

Sources/JExtractSwiftLib/FFM/CDeclLowering/FFMSwift2JavaGenerator+FunctionLowering.swift

@@ -736,7 +736,19 @@ struct CdeclLowering {
         case .foundationData, .essentialsData:
           break
 
-        case .string, .optional:
+        case .string:
+          // String returned as heap-allocated C string (caller frees).
+          return LoweredResult(
+            cdeclResultType: knownTypes.unsafeMutablePointer(knownTypes.int8),
+            cdeclOutParameters: [],
+            conversion: .method(
+              base: "_swiftjava_stringToCString",
+              methodName: nil,
+              arguments: [.init(label: nil, argument: .placeholder)]
+            )
+          )
+
+        case .optional:
           // Not supported at this point.
           throw LoweringError.unhandledType(type)
 

Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+JavaTranslation.swift

@@ -768,8 +768,12 @@ extension FFMSwift2JavaGenerator {
             // FIXME: Implement
             throw JavaTranslationError.unhandledType(swiftType)
           case .string:
-            // FIXME: Implement
-            throw JavaTranslationError.unhandledType(swiftType)
+            return TranslatedResult(
+              javaResultType: .javaLangString,
+              annotations: resultAnnotations,
+              outParameters: [],
+              conversion: .call(.placeholder, function: "SwiftRuntime.fromCString", withArena: false)
+            )
           default:
             throw JavaTranslationError.unhandledType(swiftType)
           }

Sources/SwiftRuntimeFunctions/SwiftRuntimeFunctions.swift

@@ -32,6 +32,18 @@ public func _swiftjava_swift_retainCount(object: UnsafeMutableRawPointer) -> Int
 @_silgen_name("swift_isUniquelyReferenced")
 public func _swiftjava_swift_isUniquelyReferenced(object: UnsafeMutableRawPointer) -> Bool
 
+/// Copies a Swift String to a heap-allocated NULL-terminated C string.
+/// The caller (Java FFM) must call free() on the returned pointer.
+public func _swiftjava_stringToCString(_ string: String) -> UnsafeMutablePointer<CChar> {
+  var string = string
+  return string.withUTF8 { utf8 in
+    let buffer = UnsafeMutablePointer<CChar>.allocate(capacity: utf8.count + 1)
+    UnsafeMutableRawPointer(buffer).copyMemory(from: utf8.baseAddress!, byteCount: utf8.count)
+    buffer[utf8.count] = 0
+    return buffer
+  }
+}
+
 @_alwaysEmitIntoClient @_transparent
 func _swiftjava_withHeapObject<R>(
   of object: AnyObject,

SwiftKitFFM/src/main/java/org/swift/swiftkit/ffm/SwiftRuntime.java

@@ -405,6 +405,16 @@ public static MemorySegment toCString(String str, Arena arena) {
         return arena.allocateFrom(str);
     }
 
+    /**
+     * Read a heap-allocated C string into a Java String, then free the native memory.
+     */
+    public static String fromCString(MemorySegment cStr) {
+        if (cStr.equals(MemorySegment.NULL)) return null;
+        String result = cStr.reinterpret(Long.MAX_VALUE).getString(0);
+        cFree(cStr);
+        return result;
+    }
+
     public static MemorySegment toOptionalSegmentInt(OptionalInt opt, Arena arena) {
         return opt.isPresent() ? arena.allocateFrom(ValueLayout.JAVA_INT, opt.getAsInt()) : MemorySegment.NULL;
     }

Tests/JExtractSwiftTests/FunctionLoweringTests.swift

@@ -535,4 +535,20 @@ final class FunctionLoweringTests {
       expectedCFunction: "void c_value(const void *newValue, const void *self)"
     )
   }
+
+  @Test("Lowering String return")
+  func lowerStringReturn() throws {
+    try assertLoweredFunction(
+      """
+      func bar() -> String { }
+      """,
+      expectedCDecl: """
+        @_cdecl("c_bar")
+        public func c_bar() -> UnsafeMutablePointer<Int8> {
+          return _swiftjava_stringToCString(bar())
+        }
+        """,
+      expectedCFunction: "int8_t *c_bar(void)"
+    )
+  }
 }