[JExtract] Import Data

Author: rintaro

Plugins/JExtractSwiftPlugin/JExtractSwiftPlugin.swift

@@ -100,6 +100,13 @@ struct JExtractSwiftBuildToolPlugin: SwiftJavaPluginProtocol, BuildToolPlugin {
       outputSwiftDirectory.appending(path: "\(sourceModule.name)Module+SwiftJava.swift")
     ]
 
+    // If the module uses 'Data' type, the thunk file is emitted as if 'Data' is declared
+    // in that module. Declare the thunk file as the output.
+    // FIXME: Make this conditional.
+    outputSwiftFiles += [
+      outputSwiftDirectory.appending(path: "Data+SwiftJava.swift")
+    ]
+
     return [
       .buildCommand(
         displayName: "Generate Java wrappers for Swift types",

Samples/SwiftKitSampleApp/Sources/MySwiftLibrary/MySwiftLibrary.swift

@@ -23,6 +23,8 @@ import Glibc
 import Darwin.C
 #endif
 
+import Foundation
+
 public func helloWorld() {
   p("\(#function)")
 }
@@ -53,6 +55,10 @@ public func globalReceiveRawBuffer(buf: UnsafeRawBufferPointer) -> Int {
 
 public var globalBuffer: UnsafeRawBufferPointer = UnsafeRawBufferPointer(UnsafeMutableRawBufferPointer.allocate(byteCount: 124, alignment: 1))
 
+public func globalReceiveReturnData(data: Data) -> Data {
+  return Data(data)
+}
+
 public func withBuffer(body: (UnsafeRawBufferPointer) -> Void) {
   body(globalBuffer)
 }

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

@@ -21,6 +21,10 @@
 import org.swift.swiftkit.SwiftArena;
 import org.swift.swiftkit.SwiftKit;
 
+import java.lang.foreign.MemoryLayout;
+import java.lang.foreign.MemorySegment;
+import java.lang.foreign.ValueLayout;
+
 public class HelloJava2Swift {
 
     public static void main(String[] args) {
@@ -77,6 +81,22 @@ static void examples() {
             });
         }
 
+        // Example of using 'Data'.
+        try (var arena = SwiftArena.ofConfined()) {
+            var origBytes = arena.allocateFrom("foobar");
+            var origDat = Data.init(origBytes, origBytes.byteSize(), arena);
+            
+            // var origBytes = arena.allocate(ValueLayout.JAVA_INT, arry.length);
+            // origBytes.copyFrom(MemorySegment.ofArray(arry));
+            // var dat = MySwiftLibrary.globalReceiveReturnData(origDat, arena);
+            // dat.withUnsafeBytes((retBytes) -> {
+            //    SwiftKit.trace("retBytes=" + retBytes.toArray(ValueLayout.JAVA_INT)[1]);
+            //    SwiftKit.trace("foobar");
+            // });
+            //SwiftKit.trace(origDat);
+        }
+
+
         System.out.println("DONE.");
     }
 

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

@@ -266,6 +266,9 @@ struct CdeclLowering {
             )
           }
 
+        case .data:
+          break
+
         default:
           // Unreachable? Should be handled by `CType(cdeclType:)` lowering above.
           throw LoweringError.unhandledType(type)
@@ -407,6 +410,9 @@ struct CdeclLowering {
             ])
           )
 
+        case .data:
+          break
+
         default:
           throw LoweringError.unhandledType(type)
         }
@@ -509,6 +515,9 @@ struct CdeclLowering {
           // Returning string is not supported at this point.
           throw LoweringError.unhandledType(type)
 
+        case .data:
+          break
+
         default:
           // Unreachable? Should be handled by `CType(cdeclType:)` lowering above.
           throw LoweringError.unhandledType(type)
@@ -764,7 +773,7 @@ extension LoweredFunctionSignature {
 }
 
 enum LoweringError: Error {
-  case inoutNotSupported(SwiftType)
-  case unhandledType(SwiftType)
-  case effectNotSupported(SwiftEffectSpecifier)
+  case inoutNotSupported(SwiftType, file: String = #file, line: Int = #line)
+  case unhandledType(SwiftType, file: String = #file, line: Int = #line)
+  case effectNotSupported(SwiftEffectSpecifier, file: String = #file, line: Int = #line)
 }

Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+JavaTranslation.swift

@@ -353,6 +353,9 @@ extension FFMSwift2JavaGenerator {
               conversion: .call(.placeholder, function: "SwiftKit.toCString", withArena: true)
             )
 
+          case .data:
+            break
+
           default:
             throw JavaTranslationError.unhandledType(swiftType)
           }
@@ -438,6 +441,9 @@ extension FFMSwift2JavaGenerator {
               )
             )
 
+          case .data:
+            break
+
           case .unsafePointer, .unsafeMutablePointer:
             // FIXME: Implement
             throw JavaTranslationError.unhandledType(swiftType)
@@ -629,6 +635,6 @@ extension CType {
 }
 
 enum JavaTranslationError: Error {
-  case inoutNotSupported(SwiftType)
+  case inoutNotSupported(SwiftType, file: String = #file, line: Int = #line)
   case unhandledType(SwiftType, file: String = #file, line: Int = #line)
 }

Sources/JExtractSwiftLib/FFM/FFMSwift2JavaGenerator+SwiftThunkPrinting.swift

@@ -87,6 +87,8 @@ extension FFMSwift2JavaGenerator {
 
       """)
 
+    printSwiftThunkImports(&printer)
+
     for thunk in stt.renderGlobalThunks() {
       printer.print(thunk)
       printer.println()
@@ -114,11 +116,22 @@ extension FFMSwift2JavaGenerator {
       """
     )
 
+    printSwiftThunkImports(&printer)
+
     for thunk in stt.renderThunks(forType: ty) {
       printer.print("\(thunk)")
       printer.print("")
     }
   }
+
+  func printSwiftThunkImports(_ printer: inout CodePrinter) {
+    for module in self.symbolTable.importedModules.keys.sorted() {
+      guard module != "Swift" else {
+        continue
+      }
+      printer.print("import \(module)")
+    }
+  }
 }
 
 struct SwiftThunkTranslator {

Sources/JExtractSwiftLib/Swift2JavaTranslator.swift

@@ -99,6 +99,14 @@ extension Swift2JavaTranslator {
       log.trace("Analyzing \(input.filePath)")
       visitor.visit(sourceFile: input.syntax)
     }
+
+    // If any API uses 'Foundation.Data', import 'Data' as if it's declared in
+    // this module.
+    if let dataDecl = self.symbolTable[.data] {
+      if self.isUsing(dataDecl) {
+        visitor.visit(nominalDecl: dataDecl.syntax!.asNominal!, in: nil)
+      }
+    }
   }
 
   package func prepareForTranslation() {
@@ -108,6 +116,53 @@ extension Swift2JavaTranslator {
       log: self.log
     )
   }
+
+  // Check if any of the imported decls uses the specified nominal declaration.
+  func isUsing(_ decl: SwiftNominalTypeDeclaration) -> Bool {
+    func check(_ type: SwiftType) -> Bool {
+      switch type {
+      case .nominal(let nominal):
+        return nominal.nominalTypeDecl == decl
+      case .optional(let ty):
+        return check(ty)
+      case .tuple(let tuple):
+        return tuple.contains(where: check)
+      case .function(let fn):
+        return check(fn.resultType) || fn.parameters.contains(where: { check($0.type) })
+      case .metatype(let ty):
+        return check(ty)
+      }
+    }
+
+    func check(_ fn: ImportedFunc) -> Bool {
+      if check(fn.functionSignature.result.type) {
+        return true
+      }
+      if fn.functionSignature.parameters.contains(where: { check($0.type) }) {
+        return true
+      }
+      return false
+    }
+
+    if self.importedGlobalFuncs.contains(where: check) {
+      return true
+    }
+    if self.importedGlobalVariables.contains(where: check) {
+      return true
+    }
+    for importedType in self.importedTypes.values {
+      if importedType.initializers.contains(where: check) {
+        return true
+      }
+      if importedType.methods.contains(where: check) {
+        return true
+      }
+      if importedGlobalVariables.contains(where: check) {
+        return true
+      }
+    }
+    return false
+  }
 }
 
 // ==== ----------------------------------------------------------------------------------------------------------------

Sources/JExtractSwiftLib/SwiftTypes/SwiftKnownModules.swift

@@ -76,17 +76,18 @@ private let swiftSourceFile: SourceFileSyntax = """
   public struct UnsafeBufferPointer<Element> {}
   public struct UnsafeMutableBufferPointer<Element> {}
   
-  public struct Void {} // FIXME: Support 'typealias Void = ()'
+  // FIXME: Support 'typealias Void = ()'
+  public struct Void {}
   
   public struct String {
     public init(cString: UnsafePointer<Int8>)
-    public func withCString(body: (UnsafePointer<Int8>) -> Void)
+    public func withCString(_ body: (UnsafePointer<Int8>) -> Void)
   }
   """
 
 private let foundationSourceFile: SourceFileSyntax = """
   public struct Data {
     public init(bytes: UnsafeRawPointer, count: Int)
-    public func withUnsafeBytes(body: (UnsafeRawBufferPointer) -> Void)
+    public func withUnsafeBytes(_ body: (UnsafeRawBufferPointer) -> Void)
   }
   """

Sources/JExtractSwiftLib/SwiftTypes/SwiftSymbolTable.swift

@@ -131,7 +131,7 @@ extension SwiftSymbolTable {
 
     let (module, name) = knownType.moduleAndName
     guard let moduleTable = importedModules[module] else {
-      fatalError("module \(module) is not known")
+      return nil
     }
 
     let found = moduleTable.lookupTopLevelNominalType(name)