Merge pull request #66389 from apple/egorzhdan/5.9-borrow-cxx-convertible

🍒[cxx-interop] Initializing a Swift.Array from CxxConvertibleToCollection should not copy the collection

Author: egorzhdan

stdlib/public/Cxx/CxxConvertibleToCollection.swift

@@ -55,7 +55,8 @@ extension RangeReplaceableCollection {
   ///   container when each element is copied in O(1). Note that this might not
   ///   be true for certain C++ types, e.g. those with a custom copy
   ///   constructor that performs additional logic.
-  public init<C: CxxConvertibleToCollection>(_ elements: C)
+  @inlinable
+  public init<C: CxxConvertibleToCollection>(_ elements: __shared C)
     where C.RawIterator.Pointee == Element {
 
     self.init()
@@ -72,7 +73,8 @@ extension SetAlgebra {
   ///   container when each element is copied in O(1). Note that this might not
   ///   be true for certain C++ types, e.g. those with a custom copy
   ///   constructor that performs additional logic.
-  public init<C: CxxConvertibleToCollection>(_ elements: C)
+  @inlinable
+  public init<C: CxxConvertibleToCollection>(_ elements: __shared C)
     where C.RawIterator.Pointee == Element {
 
     self.init()

stdlib/public/Cxx/CxxSet.swift

@@ -18,6 +18,7 @@ public protocol CxxSet<Element> {
 }
 
 extension CxxSet {
+  @inlinable
   public func contains(_ element: Element) -> Bool {
     return count(element) > 0
   }

test/Interop/Cxx/stdlib/overlay/Inputs/custom-sequence.h

@@ -14,6 +14,16 @@ struct SimpleSequenceWithOutOfLineEqualEqual {
   ConstIteratorOutOfLineEq end() const { return ConstIteratorOutOfLineEq(5); }
 };
 
+static int copiesCount = 0;
+
+struct SimpleCopyAwareSequence {
+  ConstIterator begin() const { return ConstIterator(1); }
+  ConstIterator end() const { return ConstIterator(5); }
+
+  SimpleCopyAwareSequence() {}
+  SimpleCopyAwareSequence(const SimpleCopyAwareSequence &other) { copiesCount++; }
+};
+
 struct SimpleArrayWrapper {
 private:
   int a[5] = {10, 20, 30, 40, 50};

test/Interop/Cxx/stdlib/overlay/custom-convertible-to-collection.swift

@@ -15,6 +15,21 @@ CxxSequenceTestSuite.test("SimpleSequence to Swift.Array") {
   expectEqual([1, 2, 3, 4] as [Int32], array)
 }
 
+#if !os(Linux) // this test crashes on Linux (https://github.com/apple/swift/issues/66363)
+CxxSequenceTestSuite.test("SimpleCopyAwareSequence to Swift.Array") {
+  copiesCount = 0
+
+  let seq = SimpleCopyAwareSequence()
+
+  let seqCopy = seq
+  expectEqual(1, copiesCount) // make sure our copy tracking mechanism works
+
+  let array = Array(seq)
+
+  expectEqual(1, copiesCount) // make sure we don't copy the C++ sequence value unnecessarily
+}
+#endif
+
 CxxSequenceTestSuite.test("SimpleSequenceWithOutOfLineEqualEqual to Swift.Array") {
   let seq = SimpleSequenceWithOutOfLineEqualEqual()
   let array = Array(seq)