Printing for handles, descriptors and address methods for props

Author: ktoso

Package.swift

@@ -122,7 +122,8 @@ let package = Package(
   dependencies: [
     .package(url: "https://github.com/swiftlang/swift-syntax.git", branch: "main"),
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
-    .package(url: "https://github.com/apple/swift-system", from: "1.0.0"),
+    .package(url: "https://github.com/apple/swift-system", from: "1.0.0"), // TODO: remove, we should not need 'nm' or process callouts
+    .package(url: "https://github.com/apple/swift-collections.git", .upToNextMinor(from: "1.1.0")),
   ],
   targets: [
     .macro(
@@ -282,6 +283,7 @@ let package = Package(
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
+        .product(name: "Collections", package: "swift-collections"),
         "_Subprocess",
         "JavaTypes",
       ],

Sources/JExtractSwift/ImportedDecls+Printing.swift

@@ -0,0 +1,65 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+import JavaTypes
+import SwiftSyntax
+import OrderedCollections
+
+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 {
+      """
+      * {@snippet lang=swift :
+      * \(syntax)
+      * }
+      """
+    } else {
+      nil
+    }
+  }
+}
+
+extension VariableAccessorKind {
+  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"
+    }
+  }
+}

Sources/JExtractSwift/ImportedDecls.swift

@@ -15,6 +15,7 @@
 import Foundation
 import JavaTypes
 import SwiftSyntax
+import OrderedCollections
 
 /// Any imported (Swift) declaration
 protocol ImportedDecl {
@@ -232,13 +233,6 @@ public struct ImportedFunc: ImportedDecl, CustomStringConvertible {
 public enum VariableAccessorKind {
   case get
   case set
-
-  public var renderDescFieldName: String {
-    switch self {
-    case .get: "DESC_GET"
-    case .set: "DESC_SET"
-    }
-  }
 }
 
 public struct ImportedVariable: ImportedDecl, CustomStringConvertible {
@@ -257,7 +251,7 @@ public struct ImportedVariable: ImportedDecl, CustomStringConvertible {
   /// Usually this will be all the accessors the variable declares,
   /// however if the getter is async or throwing we may not be able to import it
   /// (yet), and therefore would skip it from the supported set.
-  public var supportedAccessorKinds: Set<VariableAccessorKind> = [.get, .set]
+  public var supportedAccessorKinds: OrderedSet<VariableAccessorKind> = [.get, .set]
 
   /// This is the base identifier for the function, e.g., "init" for an
   /// initializer or "f" for "f(a:b:)".

Sources/JExtractSwift/Swift2JavaTranslator+Printing.swift

@@ -465,54 +465,108 @@ extension Swift2JavaTranslator {
       printMethodDowncallHandleForAddrDesc(&printer)
     }
 
+    printFunctionDescriptorMethod(&printer, decl: decl)
+    printFunctionMethodHandleMethod(&printer, decl: decl)
+    printFunctionAddressMethod(&printer, decl: decl)
+
+    // Render the basic "make the downcall" function
+    if decl.hasParent {
+      printFuncDowncallMethod(&printer, decl: decl, selfVariant: .memorySegment)
+      printFuncDowncallMethod(&printer, decl: decl, selfVariant: .wrapper)
+    } else {
+      printFuncDowncallMethod(&printer, decl: decl, selfVariant: nil)
+    }
+  }
+
+  private func printFunctionAddressMethod(_ printer: inout CodePrinter,
+                                          decl: ImportedFunc,
+                                          accessorKind: VariableAccessorKind? = nil) {
+
+    let addrName = accessorKind?.renderAddrFieldName ?? "ADDR"
+    let methodNameSegment = accessorKind?.renderMethodNameSegment ?? ""
+    let snippet = decl.renderCommentSnippet ?? "* "
+
     printer.print(
       """
       /**
-       * Function descriptor for:
-       * {@snippet lang=swift :
-       * \(/*TODO: make a printSnippet func*/decl.syntax ?? "")
-       * }
+       * Address for:
+       \(snippet)
        */
-      public static FunctionDescriptor \(decl.baseIdentifier)$descriptor() {
-          return \(decl.baseIdentifier).DESC;
+      public static MemorySegment \(decl.baseIdentifier)\(methodNameSegment)$address() {
+          return \(decl.baseIdentifier).\(addrName);
       }
       """
     )
+  }
+
+  private func printFunctionMethodHandleMethod(_ printer: inout CodePrinter,
+                                               decl: ImportedFunc,
+                                               accessorKind: VariableAccessorKind? = nil) {
+    let handleName = accessorKind?.renderHandleFieldName ?? "HANDLE"
+    let methodNameSegment = accessorKind?.renderMethodNameSegment ?? ""
+    let snippet = decl.renderCommentSnippet ?? "* "
 
     printer.print(
       """
       /**
        * Downcall method handle for:
-       * {@snippet lang=swift :
-       * \(/*TODO: make a printSnippet func*/decl.syntax ?? "")
-       * }
+       \(snippet)
        */
-      public static MethodHandle \(decl.baseIdentifier)$handle() {
-          return \(decl.baseIdentifier).HANDLE;
+      public static MethodHandle \(decl.baseIdentifier)\(methodNameSegment)$handle() {
+          return \(decl.baseIdentifier).\(handleName);
       }
       """
     )
+  }
+
+  private func printFunctionDescriptorMethod(_ printer: inout CodePrinter,
+                                             decl: ImportedFunc,
+                                             accessorKind: VariableAccessorKind? = nil) {
+    let descName = accessorKind?.renderDescFieldName ?? "DESC"
+    let methodNameSegment = accessorKind?.renderMethodNameSegment ?? ""
+    let snippet = decl.renderCommentSnippet ?? "* "
 
     printer.print(
       """
       /**
-       * Address for:
-       * {@snippet lang=swift :
-       * \(/*TODO: make a printSnippet func*/decl.syntax ?? "")
-       * }
+       * Function descriptor for:
+       \(snippet)
        */
-      public static MemorySegment \(decl.baseIdentifier)$address() {
-          return \(decl.baseIdentifier).ADDR;
+      public static FunctionDescriptor \(decl.baseIdentifier)\(methodNameSegment)$descriptor() {
+          return \(decl.baseIdentifier).\(descName);
       }
       """
     )
+  }
+
+  public func printVariableDowncallMethods(_ printer: inout CodePrinter, _ decl: ImportedVariable) {
+    printer.printSeparator(decl.identifier)
+
+    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)
+      }
+    }
+
+    for accessorKind in decl.supportedAccessorKinds {
+      guard let accessor = decl.accessorFunc(kind: accessorKind) else {
+        log.warning("Skip print for \(accessorKind) of \(decl.identifier)!")
+        continue
+      }
+      printFunctionDescriptorMethod(&printer, decl: accessor, accessorKind: accessorKind)
+      printFunctionMethodHandleMethod(&printer, decl: accessor, accessorKind: accessorKind)
+      printFunctionAddressMethod(&printer, decl: accessor, accessorKind: accessorKind)
+    }
 
     // Render the basic "make the downcall" function
     if decl.hasParent {
-      printFuncDowncallMethod(&printer, decl: decl, selfVariant: .memorySegment)
-      printFuncDowncallMethod(&printer, decl: decl, selfVariant: .wrapper)
+//      printFuncDowncallMethod(&printer, decl: decl, selfVariant: .memorySegment)
+//      printFuncDowncallMethod(&printer, decl: decl, selfVariant: .wrapper)
     } else {
-      printFuncDowncallMethod(&printer, decl: decl, selfVariant: nil)
+//      printFuncDowncallMethod(&printer, decl: decl, selfVariant: nil)
     }
   }
 

Tests/JExtractSwiftTests/Asserts/TextAssertions.swift

@@ -17,6 +17,7 @@ import Testing
 import struct Foundation.CharacterSet
 
 func assertOutput(
+  dump: Bool = false,
   _ got: String,
   expected: String,
   fileID: String = #fileID,
@@ -38,7 +39,7 @@ func assertOutput(
 
     let ge = g.trimmingCharacters(in: CharacterSet.whitespacesAndNewlines)
     let ee = e.trimmingCharacters(in: CharacterSet.whitespacesAndNewlines)
-    if ge != ee {
+    if ge.commonPrefix(with: ee) != ee {
       //      print("")
       //      print("[\(file):\(line)] " + "Difference found on line: \(no + 1)!".red)
       //      print("Expected @ \(file):\(Int(line) + no + 3 /*formatting*/ + 1):")
@@ -55,15 +56,19 @@ func assertOutput(
 
   }
 
-  if diffLineNumbers.count > 0 {
+  let hasDiff = diffLineNumbers.count > 0
+  if hasDiff || dump{
     print("")
-    print("error: Number of not matching lines: \(diffLineNumbers.count)!".red)
+    if hasDiff {
+      print("error: Number of not matching lines: \(diffLineNumbers.count)!".red)
 
-    print("==== ---------------------------------------------------------------")
-    print("Expected output:")
-    for (n, e) in expectedLines.enumerated() {
-      print("\(e)".yellow(if: diffLineNumbers.contains(n)))
+      print("==== ---------------------------------------------------------------")
+      print("Expected output:")
+      for (n, e) in expectedLines.enumerated() {
+        print("\(e)".yellow(if: diffLineNumbers.contains(n)))
+      }
     }
+
     print("==== ---------------------------------------------------------------")
     print("Got output:")
     for (n, g) in gotLines.enumerated() {

Tests/JExtractSwiftTests/FunctionDescriptorImportTests.swift

@@ -184,7 +184,7 @@ extension FunctionDescriptorTests {
           }
         }.first
     guard let varDecl else {
-      fatalError("Cannot find descriptor of: \(methodIdentifier)") as! ImportedVariable
+      fatalError("Cannot find descriptor of: \(methodIdentifier)")
     }
 
     let getOutput = CodePrinter.toString { printer in