IRGen: Map bridged container types to their specific ObjC Clang types.

When used in @objc protocol requirements, properties, or blocks, frameworks like JSCore expect the extended type encodings to accurately reflect the class of the parameters and returns. Fixes rdar://problem/19519390.

Swift SVN r28582

Author: jckarter

lib/IRGen/GenClangType.cpp

@@ -224,6 +224,44 @@ clang::CanQualType GenClangType::visitBoundGenericClassType(
   return getClangIdType(getClangASTContext());
 }
 
+static clang::CanQualType
+getClangFoundationClassType(IRGenModule &IGM, StringRef name) {
+  auto &ctx = IGM.getClangASTContext();
+  // Fallback to returning the "id" type if the class type cannot be found.
+  auto id = [&]() -> clang::CanQualType {
+    return getClangIdType(ctx);
+  };
+
+  auto *Foundation = IGM.Context.getLoadedModule(IGM.Context.Id_Foundation);
+  if (!Foundation)
+    return id();
+  
+  auto identifier = IGM.Context.getIdentifier(name);
+  SmallVector<ValueDecl *, 1> results;
+  Foundation->lookupQualified(Foundation->getType(),
+                                              identifier,
+                                              NL_QualifiedDefault, nullptr,
+                                              results);
+  for (auto result : results) {
+    // If we found a type with a clang node, get its declared class type.
+    auto clangNode = result->getClangNode();
+    if (!clangNode)
+      continue;
+    
+    auto clangInterface = dyn_cast_or_null<clang::ObjCInterfaceDecl>
+      (clangNode.getAsDecl());
+
+    if (!clangInterface)
+      continue;
+    
+    auto type = ctx.getObjCInterfaceType(clangInterface);
+    type = ctx.getObjCObjectPointerType(type);
+    return ctx.getCanonicalType(type);
+  }
+  
+  return id();
+}
+
 clang::CanQualType
 GenClangType::visitBoundGenericType(CanBoundGenericType type) {
   // We only expect *Pointer<T>, ImplicitlyUnwrappedOptional<T>, and Optional<T>.
@@ -284,9 +322,11 @@ GenClangType::visitBoundGenericType(CanBoundGenericType type) {
   }
 
   case StructKind::Array:
+    return getClangFoundationClassType(IGM, "NSArray");
   case StructKind::Dictionary:
+    return getClangFoundationClassType(IGM, "NSDictionary");
   case StructKind::Set:
-    return getClangIdType(getClangASTContext());
+    return getClangFoundationClassType(IGM, "NSSet");
 
   case StructKind::CFunctionPointer: {
     auto &clangCtx = getClangASTContext();
@@ -593,8 +633,8 @@ void ClangTypeConverter::fillSpeciallyImportedTypeCache(IRGenModule &IGM) {
   //        probably be const char* for type encoding.
   CACHE_STDLIB_TYPE("CString", ctx.VoidPtrTy);
 
-  // We import NSString* (an Obj-C object pointer) as String.
-  CACHE_STDLIB_TYPE("String", getClangIdType(ctx));
+  // We import NSString* as String.
+  CACHE_STDLIB_TYPE("String", getClangFoundationClassType(IGM, "NSString"));
 
   CACHE_STDLIB_TYPE("CVaListPointer", getClangDecayedVaListType(ctx));
 

test/IRGen/Inputs/Foundation.swift

@@ -3,13 +3,30 @@
 
 @exported import ObjectiveC
 
+extension NSObject: Hashable {
+  public var hashValue: Int { return 0 }
+}
+public func ==(x: NSObject, y: NSObject) -> Bool { return x === y }
+
 // String/NSString bridging functions.
 @asmname("swift_StringToNSString") internal
 func _convertStringToNSString(string: String) -> NSString
 
 @asmname("swift_NSStringToString") internal
 func _convertNSStringToString(nsstring: NSString?) -> String
 
+@asmname("swift_ArrayToNSArray") internal
+func _convertArrayToNSArray<T>(array: Array<T>) -> NSArray
+
+@asmname("swift_NSArrayToArray") internal
+func _convertNSArrayToArray<T>(nsstring: NSArray?) -> Array<T>
+
+@asmname("swift_DictionaryToNSDictionary") internal
+func _convertDictionaryToNSDictionary<K: Hashable, V>(array: Dictionary<K, V>) -> NSDictionary
+
+@asmname("swift_NSDictionaryToDictionary") internal
+func _convertNSDictionaryToDictionary<K: Hashable, V>(nsstring: NSDictionary?) -> Dictionary<K, V>
+
 // NSSet bridging entry points
 func _convertSetToNSSet<T: Hashable>(s: Set<T>) -> NSSet {
   return NSSet()

test/IRGen/objc_bridge.swift

@@ -142,7 +142,7 @@ extension NSString {
   func nsstrArg(#s: NSString) { }
 }
 
-class Bas : NSObject, Hashable {
+class Bas : NSObject {
   // CHECK: define internal [[OPAQUE:.*]]* @_TToFC11objc_bridge3Basg11strRealPropSS([[OPAQUE:.*]]*, i8*) unnamed_addr {{.*}} {
   // CHECK: define internal void @_TToFC11objc_bridge3Bass11strRealPropSS([[OPAQUE:.*]]*, i8*, [[OPAQUE:.*]]*) unnamed_addr {{.*}} {
   var strRealProp : String
@@ -187,7 +187,7 @@ class Bas : NSObject, Hashable {
 
   deinit { var x = 10 }
 
-  var hashValue: Int { return 0 }
+  override var hashValue: Int { return 0 }
 
   func acceptSet(set: Set<Bas>) { }
 }

test/IRGen/objc_methods.swift

@@ -1,13 +1,22 @@
-// RUN: %target-swift-frontend %s -emit-ir -disable-objc-attr-requires-foundation-module | FileCheck %s
+// RUN: rm -rf %t && mkdir %t
+// RUN: %build-irgen-test-overlays
+// RUN: %target-swift-frontend(mock-sdk: -sdk %S/Inputs -I %t) -primary-file %s -emit-ir | FileCheck %s
 
 // REQUIRES: CPU=x86_64
 // REQUIRES: objc_interop
 
+import Foundation
+
 // Protocol methods require extended method type encodings to capture block
-// signatures.
+// signatures and parameter object types.
 @objc protocol Fooable {
   func block(_: Int -> Int)
   func block2(_: (Int,Int) -> Int)
+
+  func takesString(_: String) -> String
+  func takesArray(_: [AnyObject]) -> [AnyObject]
+  func takesDict(_: [NSObject: AnyObject]) -> [NSObject: AnyObject]
+  func takesSet(_: Set<NSObject>) -> Set<NSObject>
 }
 
 class Foo: Fooable {
@@ -16,23 +25,36 @@ class Foo: Fooable {
   @IBAction func garply(_: AnyObject?) {}
   @objc func block(_: Int -> Int) {}
   @objc func block2(_: (Int,Int) -> Int) {}
+
+  @objc func takesString(x: String) -> String { return x }
+  @objc func takesArray(x: [AnyObject]) -> [AnyObject] { return x }
+  @objc func takesDict(x: [NSObject: AnyObject]) -> [NSObject: AnyObject] { return x }
+  @objc func takesSet(x: Set<NSObject>) -> Set<NSObject> { return x }
 }
 
 // CHECK: [[BLOCK_SIGNATURE_TRAD:@.*]] = private unnamed_addr constant [12 x i8] c"v24@0:8@?16\00"
 // CHECK: [[BLOCK_SIGNATURE_EXT_1:@.*]] = private unnamed_addr constant [18 x i8] c"v24@0:8@?<q@?q>16\00"
 // CHECK: [[BLOCK_SIGNATURE_EXT_2:@.*]] = private unnamed_addr constant [19 x i8] c"v24@0:8@?<q@?qq>16\00"
-// CHECK: @_PROTOCOL_METHOD_TYPES__TtP12objc_methods7Fooable_ = private constant { [2 x i8*] } {
-// CHECK:   [2 x i8*] [
-// CHECK:     i8* getelementptr inbounds ([18 x i8], [18 x i8]* [[BLOCK_SIGNATURE_EXT_1]], i64 0, i64 0),
+// CHECK: [[STRING_SIGNATURE_EXT:@.*]] = private unnamed_addr constant [31 x i8] c"@\22NSString\2224@0:8@\22NSString\2216\00"
+// CHECK: [[ARRAY_SIGNATURE_EXT:@.*]] = private unnamed_addr constant [29 x i8] c"@\22NSArray\2224@0:8@\22NSArray\2216\00"
+// CHECK: [[DICT_SIGNATURE_EXT:@.*]] = private unnamed_addr constant [39 x i8] c"@\22NSDictionary\2224@0:8@\22NSDictionary\2216\00"
+// CHECK: [[SET_SIGNATURE_EXT:@.*]] = private unnamed_addr constant [25 x i8] c"@\22NSSet\2224@0:8@\22NSSet\2216\00"
+// CHECK: @_PROTOCOL_METHOD_TYPES__TtP12objc_methods7Fooable_ = private constant { [6 x i8*] } {
+// CHECK:   [6 x i8*] [
+// CHECK:     i8* getelementptr inbounds ([18 x i8], [18 x i8]* [[BLOCK_SIGNATURE_EXT_1]], i64 0, i64 0)
 // CHECK:     i8* getelementptr inbounds ([19 x i8], [19 x i8]* [[BLOCK_SIGNATURE_EXT_2]], i64 0, i64 0)
+// CHECK:     i8* getelementptr inbounds ([31 x i8], [31 x i8]* [[STRING_SIGNATURE_EXT]], i64 0, i64 0)
+// CHECK:     i8* getelementptr inbounds ([29 x i8], [29 x i8]* [[ARRAY_SIGNATURE_EXT]], i64 0, i64 0)
+// CHECK:     i8* getelementptr inbounds ([39 x i8], [39 x i8]* [[DICT_SIGNATURE_EXT]], i64 0, i64 0)
+// CHECK:     i8* getelementptr inbounds ([25 x i8], [25 x i8]* [[SET_SIGNATURE_EXT]], i64 0, i64 0)
 // CHECK:   ]
 // CHECK: }
 // CHECK: [[BAZ_SIGNATURE:@.*]] = private unnamed_addr constant [8 x i8] c"v16@0:8\00"
 // CHECK: [[GARPLY_SIGNATURE:@.*]] = private unnamed_addr constant [11 x i8] c"v24@0:8@16\00"
 // CHECK: @_INSTANCE_METHODS__TtC12objc_methods3Foo = private constant { {{.*}}] } {
 // CHECK:   i32 24,
-// CHECK:   i32 4,
-// CHECK:   [4 x { i8*, i8*, i8* }] [{
+// CHECK:   i32 8,
+// CHECK:   [8 x { i8*, i8*, i8* }] [{
 // CHECK:     i8* getelementptr inbounds ([4 x i8], [4 x i8]* @"\01L_selector_data(baz)", i64 0, i64 0),
 // CHECK:     i8* getelementptr inbounds ([8 x i8], [8 x i8]* [[BAZ_SIGNATURE]], i64 0, i64 0),
 // CHECK:     i8* bitcast (void (i8*, i8*)* @_TToFC12objc_methods3Foo3bazfS0_FT_T_ to i8*)
@@ -52,7 +74,6 @@ class Foo: Fooable {
 // CHECK: }, section "__DATA, __objc_const", align 8
 
 
-
 // rdar://16006333 - observing properties don't work in @objc classes
 @objc
 class ObservingAccessorTest {

test/IRGen/objc_property_attrs.swift

@@ -48,9 +48,9 @@ class Foo: NSManagedObject {
   // -- Bridged value types
 
   // nonatomic, copy, ivar k
-  // CHECK: private unnamed_addr constant {{.*}} c"T@,N,C,Vk\00"
+  // CHECK: private unnamed_addr constant {{.*}} c"T@\22NSString\22,N,C,Vk\00"
   var k: String = ""
   // nonatomic, readonly, ivar l
-  // CHECK: private unnamed_addr constant {{.*}} c"T@,N,R,Vl\00"
+  // CHECK: private unnamed_addr constant {{.*}} c"T@\22NSString\22,N,R,Vl\00"
   let l: String? = nil
 }