jextract: end to end run for a property import

Author: ktoso

Samples/SwiftKitSampleApp/build.gradle

@@ -95,7 +95,11 @@ application {
 task jextract(type: Exec) {
     description = "Extracts Java accessor sources using jextract"
     outputs.dir(layout.buildDirectory.dir("generated"))
-    inputs.dir("$rootDir/Sources/ExampleSwiftLibrary")
+    inputs.dir("$rootDir/Sources/ExampleSwiftLibrary") // monitored library
+
+    // any changes in the source generator sources also mean the resulting output might change
+    inputs.dir("$rootDir/Sources/JExtractSwift")
+    inputs.dir("$rootDir/Sources/JExtractSwiftTool")
 
     workingDir = rootDir
     commandLine "make"

Samples/SwiftKitSampleApp/src/test/java/com/example/swift/generated/MySwiftClassTest.java

@@ -15,6 +15,7 @@
 package com.example.swift.generated;
 
 import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -31,6 +32,24 @@ static void beforeAll() {
         System.setProperty("jextract.trace.downcalls", "true");
     }
 
-    // TODO: test member methods on MySwiftClass
+    @Test
+    void test_MySwiftClass_voidMethod() {
+        MySwiftClass o = new MySwiftClass(12, 42);
+        o.voidMethod();
+    }
+
+    @Test
+    void test_MySwiftClass_makeIntMethod() {
+        MySwiftClass o = new MySwiftClass(12, 42);
+        var got = o.makeIntMethod();
+        assertEquals(12, got);
+    }
+
+    @Test
+    void test_MySwiftClass_property_len() {
+        MySwiftClass o = new MySwiftClass(12, 42);
+        var got = o.makeIntMethod();
+        assertEquals(12, got);
+    }
 
 }

Sources/JExtractSwift/ImportedDecls+Printing.swift

@@ -34,6 +34,14 @@ extension ImportedFunc {
 }
 
 extension VariableAccessorKind {
+
+  public var fieldSuffix: String {
+    switch self {
+      case .get: "_GET"
+      case .set: "_SET"
+    }
+  }
+
   public var renderDescFieldName: String {
     switch self {
     case .get: "DESC_GET"

Sources/JExtractSwift/Swift2JavaTranslator+Printing.swift

@@ -129,7 +129,9 @@ extension Swift2JavaTranslator {
       }
 
       // Properties
-      // TODO: property accessors
+      for varDecl in decl.variables {
+        printVariableDowncallMethods(&printer, varDecl)
+      }
 
       // Methods
       for funcDecl in decl.methods {
@@ -482,8 +484,8 @@ extension Swift2JavaTranslator {
                                           decl: ImportedFunc,
                                           accessorKind: VariableAccessorKind? = nil) {
 
-    let addrName = accessorKind?.renderAddrFieldName ?? "ADDR"
-    let methodNameSegment = accessorKind?.renderMethodNameSegment ?? ""
+    let addrName = accessorKind.renderAddrFieldName
+    let methodNameSegment = accessorKind.renderMethodNameSegment
     let snippet = decl.renderCommentSnippet ?? "* "
 
     printer.print(
@@ -502,8 +504,8 @@ extension Swift2JavaTranslator {
   private func printFunctionMethodHandleMethod(_ printer: inout CodePrinter,
                                                decl: ImportedFunc,
                                                accessorKind: VariableAccessorKind? = nil) {
-    let handleName = accessorKind?.renderHandleFieldName ?? "HANDLE"
-    let methodNameSegment = accessorKind?.renderMethodNameSegment ?? ""
+    let handleName = accessorKind.renderHandleFieldName
+    let methodNameSegment = accessorKind.renderMethodNameSegment
     let snippet = decl.renderCommentSnippet ?? "* "
 
     printer.print(
@@ -522,8 +524,8 @@ extension Swift2JavaTranslator {
   private func printFunctionDescriptorMethod(_ printer: inout CodePrinter,
                                              decl: ImportedFunc,
                                              accessorKind: VariableAccessorKind? = nil) {
-    let descName = accessorKind?.renderDescFieldName ?? "DESC"
-    let methodNameSegment = accessorKind?.renderMethodNameSegment ?? ""
+    let descName = accessorKind.renderDescFieldName
+    let methodNameSegment = accessorKind.renderMethodNameSegment
     let snippet = decl.renderCommentSnippet ?? "* "
 
     printer.print(
@@ -544,10 +546,14 @@ extension Swift2JavaTranslator {
 
     printer.printTypeDecl("private static class \(decl.baseIdentifier)") { printer in
       for accessorKind in decl.supportedAccessorKinds {
-        printPropertyAccessorDescriptorValue(&printer, decl, accessorKind)
-//      printFunctionDescriptorValue(&printer, decl);
-//      printFindMemorySegmentAddrByMangledName(&printer, decl)
-//      printMethodDowncallHandleForAddrDesc(&printer)
+        guard let accessor = decl.accessorFunc(kind: accessorKind) else {
+          log.warning("Skip print for \(accessorKind) of \(decl.identifier)!")
+          continue
+        }
+
+        printFunctionDescriptorValue(&printer, accessor, accessorKind: accessorKind);
+        printFindMemorySegmentAddrByMangledName(&printer, accessor, accessorKind: accessorKind)
+        printMethodDowncallHandleForAddrDesc(&printer, accessorKind: accessorKind)
       }
     }
 
@@ -579,23 +585,24 @@ extension Swift2JavaTranslator {
     }
   }
 
-  func printFindMemorySegmentAddrByMangledName(_ printer: inout CodePrinter, _ decl: ImportedFunc) {
+  func printFindMemorySegmentAddrByMangledName(_ printer: inout CodePrinter, _ decl: ImportedFunc,
+                                               accessorKind: VariableAccessorKind? = nil) {
     printer.print(
       """
       /**
-       * {@snippet lang = Swift:
-       * \(decl.displayName)
-       * }
+       \(decl.renderCommentSnippet ?? "* ")
        */
-      public static final MemorySegment ADDR = \(swiftModuleName).findOrThrow("\(decl.swiftMangledName)");
+      public static final MemorySegment \(accessorKind.renderAddrFieldName) = 
+          \(swiftModuleName).findOrThrow("\(decl.swiftMangledName)");
       """
     );
   }
 
-  func printMethodDowncallHandleForAddrDesc(_ printer: inout CodePrinter) {
+  func printMethodDowncallHandleForAddrDesc(_ printer: inout CodePrinter, accessorKind: VariableAccessorKind? = nil) {
     printer.print(
       """
-      public static final MethodHandle HANDLE = Linker.nativeLinker().downcallHandle(ADDR, DESC);
+      public static final MethodHandle \(accessorKind.renderHandleFieldName) = 
+          Linker.nativeLinker().downcallHandle(\(accessorKind.renderAddrFieldName), \(accessorKind.renderDescFieldName));
       """
     )
   }
@@ -781,7 +788,8 @@ extension Swift2JavaTranslator {
   public func printFunctionDescriptorValue(
     _ printer: inout CodePrinter,
     _ decl: ImportedFunc,
-    fieldName: String = "DESC") {
+    accessorKind: VariableAccessorKind? = nil) {
+    let fieldName = accessorKind.renderDescFieldName
     printer.start("public static final FunctionDescriptor \(fieldName) = ")
 
     let parameterLayoutDescriptors = javaMemoryLayoutDescriptors(
@@ -818,14 +826,4 @@ extension Swift2JavaTranslator {
     printer.print(");");
   }
 
-  public func printPropertyAccessorDescriptorValue(
-    _ printer: inout CodePrinter,
-    _ decl: ImportedVariable,
-    _ kind: VariableAccessorKind) {
-    guard let funcDecl = decl.accessorFunc(kind: kind) else {
-      return
-    }
-
-    printFunctionDescriptorValue(&printer, funcDecl, fieldName: kind.renderDescFieldName)
-  }
 }

Tests/JExtractSwiftTests/FunctionDescriptorImportTests.swift

@@ -162,8 +162,8 @@ extension FunctionDescriptorTests {
   }
 
   func variableAccessorDescriptorTest(
-    _ methodIdentifier: String,
-    _ kind: VariableAccessorKind,
+    _ identifier: String,
+    _ accessorKind: VariableAccessorKind,
     javaPackage: String = "com.example.swift",
     swiftModuleName: String = "SwiftModule",
     logLevel: Logger.Level = .trace,
@@ -180,15 +180,15 @@ extension FunctionDescriptorTests {
     let varDecl: ImportedVariable? =
       st.importedTypes.values.compactMap {
           $0.variables.first {
-            $0.identifier == methodIdentifier
+            $0.identifier == identifier
           }
         }.first
     guard let varDecl else {
-      fatalError("Cannot find descriptor of: \(methodIdentifier)")
+      fatalError("Cannot find descriptor of: \(identifier)")
     }
 
     let getOutput = CodePrinter.toString { printer in
-      st.printPropertyAccessorDescriptorValue(&printer, varDecl, kind)
+      printFunctionDescriptorValue(&printer, funcDecl, accessorKind: accessorKind)
     }
 
     try await body(getOutput)