Merge branch 'main' into wip-converge-cli

Author: ktoso

Makefile

@@ -29,7 +29,7 @@ extension Swift2JavaTranslator {
       enclosingType: try enclosingType.map { try SwiftType($0, symbolTable: symbolTable) },
       symbolTable: symbolTable
     )
-    return try CdeclLowering(swiftStdlibTypes: swiftStdlibTypes).lowerFunctionSignature(signature, apiKind: .function)
+    return try CdeclLowering(swiftStdlibTypes: swiftStdlibTypes).lowerFunctionSignature(signature)
   }
 
   /// Lower the given initializer to a C-compatible entrypoint,
@@ -46,7 +46,7 @@ extension Swift2JavaTranslator {
       symbolTable: symbolTable
     )
 
-    return try CdeclLowering(swiftStdlibTypes: swiftStdlibTypes).lowerFunctionSignature(signature, apiKind: .initializer)
+    return try CdeclLowering(swiftStdlibTypes: swiftStdlibTypes).lowerFunctionSignature(signature)
   }
 
   /// Lower the given variable decl to a C-compatible entrypoint,
@@ -69,7 +69,7 @@ extension Swift2JavaTranslator {
       enclosingType: try enclosingType.map { try SwiftType($0, symbolTable: symbolTable) },
       symbolTable: symbolTable
     )
-    return try CdeclLowering(swiftStdlibTypes: swiftStdlibTypes).lowerFunctionSignature(signature, apiKind: isSet ? .setter : .getter)
+    return try CdeclLowering(swiftStdlibTypes: swiftStdlibTypes).lowerFunctionSignature(signature)
   }
 }
 
@@ -82,8 +82,7 @@ struct CdeclLowering {
   ///
   /// Throws an error if this function cannot be lowered for any reason.
   func lowerFunctionSignature(
-    _ signature: SwiftFunctionSignature,
-    apiKind: SwiftAPIKind
+    _ signature: SwiftFunctionSignature
   ) throws -> LoweredFunctionSignature {
     // Lower the self parameter.
     let loweredSelf: LoweredParameter? = switch signature.selfParameter {
@@ -111,7 +110,6 @@ struct CdeclLowering {
 
     return LoweredFunctionSignature(
       original: signature,
-      apiKind: apiKind,
       selfParameter: loweredSelf,
       parameters: loweredParameters,
       result: loweredResult
@@ -436,13 +434,6 @@ struct CdeclLowering {
   }
 }
 
-package enum SwiftAPIKind {
-  case function
-  case initializer
-  case getter
-  case setter
-}
-
 /// Represent a Swift parameter in the cdecl thunk.
 struct LoweredParameter: Equatable {
   /// Lowered parameters in cdecl thunk.
@@ -487,8 +478,6 @@ extension LoweredResult {
 public struct LoweredFunctionSignature: Equatable {
   var original: SwiftFunctionSignature
 
-  var apiKind: SwiftAPIKind
-
   var selfParameter: LoweredParameter?
   var parameters: [LoweredParameter]
   var result: LoweredResult
@@ -520,9 +509,10 @@ public struct LoweredFunctionSignature: Equatable {
 extension LoweredFunctionSignature {
   /// Produce the `@_cdecl` thunk for this lowered function signature that will
   /// call into the original function.
-  public func cdeclThunk(
+  package func cdeclThunk(
     cName: String,
     swiftAPIName: String,
+    as apiKind: SwiftAPIKind,
     stdlibTypes: SwiftStandardLibraryTypes
   ) -> FunctionDeclSyntax {
 
@@ -563,7 +553,7 @@ extension LoweredFunctionSignature {
 
     // Build callee expression.
     let callee: ExprSyntax = if let selfExpr {
-      if case .initializer = self.apiKind {
+      if case .initializer = apiKind {
         // Don't bother to create explicit ${Self}.init expression.
         selfExpr
       } else {

Sources/JExtractSwiftLib/CDeclLowering/Swift2JavaTranslator+FunctionLowering.swift

@@ -177,17 +177,19 @@ extension DeclSyntaxProtocol {
   var signatureString: String {
     return switch DeclSyntax(self.detached).as(DeclSyntaxEnum.self) {
     case .functionDecl(let node):
-      node.with(\.body, nil).trimmedDescription
+      node.with(\.body, nil).triviaSanitizedDescription
     case .initializerDecl(let node):
-      node.with(\.body, nil).trimmedDescription
+      node.with(\.body, nil).triviaSanitizedDescription
     case .classDecl(let node):
-      node.with(\.memberBlock, "").trimmedDescription
+      node.with(\.memberBlock, "").triviaSanitizedDescription
     case .structDecl(let node):
-      node.with(\.memberBlock, "").trimmedDescription
+      node.with(\.memberBlock, "").triviaSanitizedDescription
     case .protocolDecl(let node):
-      node.with(\.memberBlock, "").trimmedDescription
+      node.with(\.memberBlock, "").triviaSanitizedDescription
     case .accessorDecl(let node):
-      node.with(\.body, nil).trimmedDescription
+      node.with(\.body, nil).triviaSanitizedDescription
+    case .subscriptDecl(let node):
+      node.with(\.accessorBlock, nil).triviaSanitizedDescription
     case .variableDecl(let node):
       node
         .with(\.bindings, PatternBindingListSyntax(
@@ -197,9 +199,47 @@ extension DeclSyntaxProtocol {
             .with(\.initializer, nil)
           }
         ))
-        .trimmedDescription
+        .triviaSanitizedDescription
     default:
       fatalError("unimplemented \(self.kind)")
     }
   }
+
+  /// Syntax text but without unnecessary trivia.
+  ///
+  /// Connective trivia are condensed into a single whitespace, but no space
+  /// after opening or before closing parentheses
+  var triviaSanitizedDescription: String {
+    let visitor = TriviaSanitizingDescriptionVisitor(viewMode: .sourceAccurate)
+    visitor.walk(self.trimmed)
+    return visitor.result
+  }
+}
+
+class TriviaSanitizingDescriptionVisitor: SyntaxVisitor {
+  var result: String = ""
+
+  var prevTokenKind: TokenKind = .endOfFile
+  var prevHadTrailingSpace: Bool = false
+
+  override func visit(_ node: TokenSyntax) -> SyntaxVisitorContinueKind {
+    let tokenKind = node.tokenKind
+    switch (prevTokenKind, tokenKind) {
+    case
+      // No whitespace after open parentheses.
+      (.leftAngle, _), (.leftParen, _), (.leftSquare, _), (.endOfFile, _),
+      // No whitespace before close parentheses.
+      (_, .rightAngle), (_, .rightParen), (_, .rightSquare):
+      break
+    default:
+      if prevHadTrailingSpace || !node.leadingTrivia.isEmpty {
+        result += " "
+      }
+    }
+    result += node.text
+    prevTokenKind = tokenKind
+    prevHadTrailingSpace = !node.trailingTrivia.isEmpty
+
+    return .skipChildren
+  }
 }

Sources/JExtractSwiftLib/Convenience/SwiftSyntax+Extensions.swift

@@ -17,7 +17,12 @@ import SwiftSyntax
 /// Any imported (Swift) declaration
 protocol ImportedDecl: AnyObject {}
 
-public typealias JavaPackage = String
+package enum SwiftAPIKind {
+  case function
+  case initializer
+  case getter
+  case setter
+}
 
 /// Describes a Swift nominal type (e.g., a class, struct, enum) that has been
 /// imported and is being translated into Java.
@@ -47,32 +52,17 @@ public final class ImportedFunc: ImportedDecl, CustomStringConvertible {
 
   public var swiftDecl: any DeclSyntaxProtocol
 
-  var translatedSignature: TranslatedFunctionSignature
+  package var apiKind: SwiftAPIKind
+
+  var functionSignature: SwiftFunctionSignature
 
   public var signatureString: String {
-    // FIXME: Remove comments and normalize trivia.
     self.swiftDecl.signatureString
   }
 
-  var loweredSignature: LoweredFunctionSignature {
-    translatedSignature.loweredSignature
-  }
-
-  var swiftSignature: SwiftFunctionSignature {
-    loweredSignature.original
-  }
-
-  package func cFunctionDecl(cName: String) -> CFunction {
-    // 'try!' because we know 'loweredSignature' can be described with C.
-    try! loweredSignature.cFunctionDecl(cName: cName)
-  }
-
-  package var kind: SwiftAPIKind {
-    loweredSignature.apiKind
-  }
 
   var parentType: SwiftType? {
-    guard let selfParameter = swiftSignature.selfParameter else {
+    guard let selfParameter = functionSignature.selfParameter else {
       return nil
     }
     switch selfParameter {
@@ -89,12 +79,12 @@ public final class ImportedFunc: ImportedDecl, CustomStringConvertible {
   /// this will contain that declaration's imported name.
   ///
   /// This is necessary when rendering accessor Java code we need the type that "self" is expecting to have.
-  public var hasParent: Bool { translatedSignature.selfParameter != nil }
+  public var hasParent: Bool { functionSignature.selfParameter != nil }
 
   /// A display name to use to refer to the Swift declaration with its
   /// enclosing type, if there is one.
   public var displayName: String {
-    let prefix = switch self.kind {
+    let prefix = switch self.apiKind {
     case .getter: "getter:"
     case .setter: "setter:"
     case .function, .initializer: ""
@@ -113,18 +103,20 @@ public final class ImportedFunc: ImportedDecl, CustomStringConvertible {
     module: String,
     swiftDecl: any DeclSyntaxProtocol,
     name: String,
-    translatedSignature: TranslatedFunctionSignature
+    apiKind: SwiftAPIKind,
+    functionSignature: SwiftFunctionSignature
   ) {
     self.module = module
     self.name = name
     self.swiftDecl = swiftDecl
-    self.translatedSignature = translatedSignature
+    self.apiKind = apiKind
+    self.functionSignature = functionSignature
   }
 
   public var description: String {
     """
     ImportedFunc {
-      kind: \(kind)
+      apiKind: \(apiKind)
       module: \(module)
       name: \(name)
       signature: \(self.swiftDecl.signatureString)