Merge pull request #77496 from tbkka/tbkka-rdar138132321

[ObjC Bridging] Consistently bridge block types verbatim

Author: tbkka

stdlib/public/runtime/Casting.cpp

@@ -1289,9 +1289,8 @@ static id bridgeAnythingNonVerbatimToObjectiveC(OpaqueValue *src,
       swift_unknownObjectRetain(result);
     return result;
   }
-  
   // Dig through existential types.
-  if (auto srcExistentialTy = dyn_cast<ExistentialTypeMetadata>(srcType)) {
+  else if (auto srcExistentialTy = dyn_cast<ExistentialTypeMetadata>(srcType)) {
     OpaqueValue *srcInnerValue;
     const Metadata *srcInnerType;
     bool isOutOfLine;
@@ -1320,10 +1319,9 @@ static id bridgeAnythingNonVerbatimToObjectiveC(OpaqueValue *src,
     }
     return result;
   }
-  
-  // Handle metatypes.
-  if (isa<ExistentialMetatypeMetadata>(srcType)
-      || isa<MetatypeMetadata>(srcType)) {
+  // Handle metatypes and existential metatypes
+  else if (isa<ExistentialMetatypeMetadata>(srcType)
+	   || isa<MetatypeMetadata>(srcType)) {
     const Metadata *srcMetatypeValue;
     memcpy(&srcMetatypeValue, src, sizeof(srcMetatypeValue));
 
@@ -1342,8 +1340,9 @@ static id bridgeAnythingNonVerbatimToObjectiveC(OpaqueValue *src,
         return objc_retain(protocolObj);
       }
     }
+  }
   // Handle bridgeable types.
-  } else if (auto srcBridgeWitness = findBridgeWitness(srcType)) {
+  else if (auto srcBridgeWitness = findBridgeWitness(srcType)) {
     // Bridge the source value to an object.
     auto srcBridgedObject =
       srcBridgeWitness->bridgeToObjectiveC(src, srcType, srcBridgeWitness);
@@ -1353,13 +1352,24 @@ static id bridgeAnythingNonVerbatimToObjectiveC(OpaqueValue *src,
       srcType->vw_destroy(src);
 
     return (id)srcBridgedObject;
+  }
   // Handle Errors.
-  } else if (auto srcErrorWitness = findErrorWitness(srcType)) {
+  else if (auto srcErrorWitness = findErrorWitness(srcType)) {
     // Bridge the source value to an NSError.
     auto flags = consume ? DynamicCastFlags::TakeOnSuccess
                          : DynamicCastFlags::Default;
     return dynamicCastValueToNSError(src, srcType, srcErrorWitness, flags);
   }
+  // Handle functions:  "Block" types can be bridged literally
+  else if (auto fn = dyn_cast<FunctionTypeMetadata>(srcType)) {
+    if (fn->getConvention() == FunctionMetadataConvention::Block) {
+      id result;
+      memcpy(&result, src, sizeof(id));
+      if (!consume)
+	swift_unknownObjectRetain(result);
+      return result;
+    }
+  }
 
   // Fall back to boxing.
   return (id)bridgeAnythingToSwiftValueObject(src, srcType, consume);

test/Casting/Cast_Blocks.swift

@@ -0,0 +1,76 @@
+// Casts.swift - Tests for conversion between types.
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+// -----------------------------------------------------------------------------
+///
+/// Contains tests for non-trapping type conversions reported by users.
+///
+// -----------------------------------------------------------------------------
+// RUN: %empty-directory(%t)
+//
+// RUN: %clang %target-cc-options -isysroot %sdk -fobjc-arc %S/Inputs/Cast_Blocks/Cast_Blocks.m -c -o %t/Cast_Blocks.o -g
+//
+// RUN: %target-build-swift -I %S/Inputs/Cast_Blocks %t/Cast_Blocks.o -swift-version 6 -g -Onone  -module-name a %s -o %t/a.swift6.Onone.out
+// RUN: %target-codesign %t/a.swift6.Onone.out
+// RUN: %target-run %t/a.swift6.Onone.out
+//
+// RUN: %target-build-swift -I %S/Inputs/Cast_Blocks %t/Cast_Blocks.o -swift-version 6 -g -O  -module-name a %s -o %t/a.swift6.O.out
+// RUN: %target-codesign %t/a.swift6.O.out
+// RUN: %target-run %t/a.swift6.O.out
+//
+// RUN: %target-build-swift -I %S/Inputs/Cast_Blocks %t/Cast_Blocks.o -swift-version 5 -g -Onone  -module-name a %s -o %t/a.swift5.Onone.out
+// RUN: %target-codesign %t/a.swift5.Onone.out
+// RUN: %target-run %t/a.swift5.Onone.out
+//
+// RUN: %target-build-swift -I %S/Inputs/Cast_Blocks %t/Cast_Blocks.o -swift-version 5 -g -O  -module-name a %s -o %t/a.swift5.O.out
+// RUN: %target-codesign %t/a.swift5.O.out
+// RUN: %target-run %t/a.swift5.O.out
+//
+// REQUIRES: executable_test
+// REQUIRES: objc_interop
+// UNSUPPORTED: use_os_stdlib
+// UNSUPPORTED: back_deployment_runtime
+
+import StdlibUnittest
+import Foundation
+import Cast_Blocks
+
+fileprivate func SwiftThinksObjectIsSwiftValue<T>(_ t: T) -> Bool {
+  let type = "\(type(of: t))"
+  return type == "__SwiftValue"
+}
+
+let CastsTests = TestSuite("Cast_Blocks")
+
+CastsTests.test("block closures should bridge without __SwiftValue")
+{
+  let x: @convention(block) () -> Void = {}
+
+  expectFalse(ObjCThinksObjectIsSwiftValue(x))
+
+  expectFalse(SwiftThinksObjectIsSwiftValue(x))
+
+  ObjCCanCallBlock(x);
+}
+
+// Bug:  @convention(block) closure used to be incorrectly wrapped in
+// SwiftValue box when bridged to Objective-C as a member of an array
+CastsTests.test("block closures in array should bridge without __SwiftValue")
+{
+  let f: @convention(block) () -> Void = {}
+  let x = ([f] as NSArray)[0]
+
+  expectFalse(ObjCThinksObjectIsSwiftValue(x))
+  expectFalse(SwiftThinksObjectIsSwiftValue(x))
+  ObjCCanCallBlock(x);
+}
+
+
+runAllTests()

test/Casting/Inputs/Cast_Blocks/Cast_Blocks.h

@@ -0,0 +1,9 @@
+#ifndef SWIFT_TEST_CAST_BLOCKS_H
+#define SWIFT_TEST_CAST_BLOCKS_H
+
+#import <Foundation/Foundation.h>
+
+BOOL ObjCThinksObjectIsSwiftValue(id obj);
+void ObjCCanCallBlock(id block_as_id);
+
+#endif

test/Casting/Inputs/Cast_Blocks/Cast_Blocks.m

@@ -0,0 +1,19 @@
+#import <objc/runtime.h>
+
+#import "Cast_Blocks.h"
+
+BOOL ObjCThinksObjectIsSwiftValue(id obj) {
+  Class cls = object_getClass(obj);
+  const char *name = class_getName(cls);
+  if (strcmp(name, "__SwiftValue") == 0) {
+    return TRUE;
+  } else {
+    return FALSE;
+  }
+}
+
+void ObjCCanCallBlock(id block_as_id) {
+  typedef void(^blockType)(void);
+  blockType block = (blockType)block_as_id;
+  block();
+}

test/Casting/Inputs/Cast_Blocks/module.modulemap

@@ -0,0 +1,4 @@
+module Cast_Blocks {
+  header "Cast_Blocks.h"
+  export *
+}