Merge pull request #19143 from itaiferber/foundation-overlay-owned-annotations

Annotate Foundation overlay with __shared/__owned

Author: Itai Ferber

Darwin/Foundation-swiftoverlay/AffineTransform.swift

@@ -33,7 +33,7 @@ public struct AffineTransform : ReferenceConvertible, Hashable, CustomStringConv
         self.tY = tY
     }
 
-    fileprivate init(reference: NSAffineTransform) {
+    fileprivate init(reference: __shared NSAffineTransform) {
         m11 = reference.transformStruct.m11
         m12 = reference.transformStruct.m12
         m21 = reference.transformStruct.m21

Darwin/Foundation-swiftoverlay/Boxing.swift

@@ -19,7 +19,7 @@ internal final class _MutableHandle<MutableType : NSObject>
   where MutableType : NSCopying {
     fileprivate var _pointer : MutableType
 
-    init(reference : MutableType) {
+    init(reference : __shared MutableType) {
         _pointer = reference.copy() as! MutableType
     }
 

Darwin/Foundation-swiftoverlay/Calendar.swift

@@ -97,7 +97,7 @@ public struct Calendar : Hashable, Equatable, ReferenceConvertible, _MutableBoxi
     /// Returns a new Calendar.
     ///
     /// - parameter identifier: The kind of calendar to use.
-    public init(identifier: Identifier) {
+    public init(identifier: __shared Identifier) {
         let result = __NSCalendarCreate(Calendar._toNSCalendarIdentifier(identifier))
         _handle = _MutableHandle(adoptingReference: result as! NSCalendar)
         _autoupdating = false
@@ -106,7 +106,7 @@ public struct Calendar : Hashable, Equatable, ReferenceConvertible, _MutableBoxi
     // MARK: -
     // MARK: Bridging
 
-    fileprivate init(reference : NSCalendar) {
+    fileprivate init(reference : __shared NSCalendar) {
         _handle = _MutableHandle(reference: reference)
         if __NSCalendarIsAutoupdating(reference) {
             _autoupdating = true

Darwin/Foundation-swiftoverlay/CharacterSet.swift

@@ -390,23 +390,23 @@ public struct CharacterSet : ReferenceConvertible, Equatable, Hashable, SetAlgeb
     /// Initialize with the characters in the given string.
     ///
     /// - parameter string: The string content to inspect for characters.
-    public init(charactersIn string: String) {
+    public init(charactersIn string: __shared String) {
         _storage = _CharacterSetStorage(immutableReference: CFCharacterSetCreateWithCharactersInString(nil, string as CFString))
     }
 
     /// Initialize with a bitmap representation.
     ///
     /// This method is useful for creating a character set object with data from a file or other external data source.
     /// - parameter data: The bitmap representation.
-    public init(bitmapRepresentation data: Data) {
+    public init(bitmapRepresentation data: __shared Data) {
         _storage = _CharacterSetStorage(immutableReference: CFCharacterSetCreateWithBitmapRepresentation(nil, data as CFData))
     }
 
     /// Initialize with the contents of a file.
     ///
     /// Returns `nil` if there was an error reading the file.
     /// - parameter file: The file to read.
-    public init?(contentsOfFile file: String) {
+    public init?(contentsOfFile file: __shared String) {
         do {
             let data = try Data(contentsOf: URL(fileURLWithPath: file), options: .mappedIfSafe)
             _storage = _CharacterSetStorage(immutableReference: CFCharacterSetCreateWithBitmapRepresentation(nil, data as CFData))
@@ -415,7 +415,7 @@ public struct CharacterSet : ReferenceConvertible, Equatable, Hashable, SetAlgeb
         }
     }
 
-    fileprivate init(_bridged characterSet: NSCharacterSet) {
+    fileprivate init(_bridged characterSet: __shared NSCharacterSet) {
         _storage = _CharacterSetStorage(immutableReference: characterSet.copy() as! CFCharacterSet)
     }
 
@@ -427,7 +427,7 @@ public struct CharacterSet : ReferenceConvertible, Equatable, Hashable, SetAlgeb
         _storage = _uncopiedStorage
     }
 
-    fileprivate init(_builtIn: CFCharacterSetPredefinedSet) {
+    fileprivate init(_builtIn: __shared CFCharacterSetPredefinedSet) {
         _storage = _CharacterSetStorage(immutableReference: CFCharacterSetGetPredefined(_builtIn))
     }
 

Darwin/Foundation-swiftoverlay/Data.swift

@@ -1178,7 +1178,7 @@ public struct Data : ReferenceConvertible, Equatable, Hashable, RandomAccessColl
     /// - parameter url: The `URL` to read.
     /// - parameter options: Options for the read operation. Default value is `[]`.
     /// - throws: An error in the Cocoa domain, if `url` cannot be read.
-    public init(contentsOf url: URL, options: Data.ReadingOptions = []) throws {
+    public init(contentsOf url: __shared URL, options: Data.ReadingOptions = []) throws {
         let d = try NSData(contentsOf: url, options: ReadingOptions(rawValue: options.rawValue))
         _backing = _DataStorage(immutableReference: d, offset: 0)
         _sliceRange = 0..<d.length
@@ -1189,7 +1189,7 @@ public struct Data : ReferenceConvertible, Equatable, Hashable, RandomAccessColl
     /// Returns nil when the input is not recognized as valid Base-64.
     /// - parameter base64String: The string to parse.
     /// - parameter options: Encoding options. Default value is `[]`.
-    public init?(base64Encoded base64String: String, options: Data.Base64DecodingOptions = []) {
+    public init?(base64Encoded base64String: __shared String, options: Data.Base64DecodingOptions = []) {
         if let d = NSData(base64Encoded: base64String, options: Base64DecodingOptions(rawValue: options.rawValue)) {
             _backing = _DataStorage(immutableReference: d, offset: 0)
             _sliceRange = 0..<d.length
@@ -1204,7 +1204,7 @@ public struct Data : ReferenceConvertible, Equatable, Hashable, RandomAccessColl
     ///
     /// - parameter base64Data: Base-64, UTF-8 encoded input data.
     /// - parameter options: Decoding options. Default value is `[]`.
-    public init?(base64Encoded base64Data: Data, options: Data.Base64DecodingOptions = []) {
+    public init?(base64Encoded base64Data: __shared Data, options: Data.Base64DecodingOptions = []) {
         if let d = NSData(base64Encoded: base64Data, options: Base64DecodingOptions(rawValue: options.rawValue)) {
             _backing = _DataStorage(immutableReference: d, offset: 0)
             _sliceRange = 0..<d.length
@@ -1220,7 +1220,7 @@ public struct Data : ReferenceConvertible, Equatable, Hashable, RandomAccessColl
     /// If the resulting value is mutated, then `Data` will invoke the `mutableCopy()` function on the reference to copy the contents. You may customize the behavior of that function if you wish to return a specialized mutable subclass.
     ///
     /// - parameter reference: The instance of `NSData` that you wish to wrap. This instance will be copied by `struct Data`.
-    public init(referencing reference: NSData) {
+    public init(referencing reference: __shared NSData) {
 #if DEPLOYMENT_RUNTIME_SWIFT
         let providesConcreteBacking = reference._providesConcreteBacking()
 #else

Darwin/Foundation-swiftoverlay/DateComponents.swift

@@ -269,7 +269,7 @@ public struct DateComponents : ReferenceConvertible, Hashable, Equatable, _Mutab
 
     // MARK: - Bridging Helpers
 
-    fileprivate init(reference: NSDateComponents) {
+    fileprivate init(reference: __shared NSDateComponents) {
         _handle = _MutableHandle(reference: reference)
     }
 

Darwin/Foundation-swiftoverlay/Decimal.swift

@@ -452,7 +452,7 @@ extension Decimal {
 }
 
 extension Decimal : CustomStringConvertible {
-    public init?(string: String, locale: Locale? = nil) {
+    public init?(string: __shared String, locale: __shared Locale? = nil) {
         let scan = Scanner(string: string)
         var theDecimal = Decimal()
         scan.locale = locale

Darwin/Foundation-swiftoverlay/IndexPath.swift

@@ -156,7 +156,7 @@ public struct IndexPath : ReferenceConvertible, Equatable, Hashable, MutableColl
             }
         }
 
-        mutating func append(contentsOf other: [Int]) {
+        mutating func append(contentsOf other: __owned [Int]) {
             switch self {
             case .empty:
                 switch other.count {
@@ -684,7 +684,7 @@ public struct IndexPath : ReferenceConvertible, Equatable, Hashable, MutableColl
 
     // MARK: - Bridging Helpers
 
-    fileprivate init(nsIndexPath: ReferenceType) {
+    fileprivate init(nsIndexPath: __shared ReferenceType) {
         let count = nsIndexPath.length
         if count == 0 {
             _indexes = []

Darwin/Foundation-swiftoverlay/IndexSet.swift

@@ -661,7 +661,7 @@ public struct IndexSet : ReferenceConvertible, Equatable, BidirectionalCollectio
         return _handle.reference
     }
 
-    fileprivate init(reference: NSIndexSet) {
+    fileprivate init(reference: __shared NSIndexSet) {
         _handle = _MutablePairHandle(reference)
     }
 }

Darwin/Foundation-swiftoverlay/JSONEncoder.swift

@@ -387,7 +387,7 @@ fileprivate struct _JSONEncodingStorage {
         return array
     }
 
-    fileprivate mutating func push(container: NSObject) {
+    fileprivate mutating func push(container: __owned NSObject) {
         self.containers.append(container)
     }
 
@@ -961,7 +961,7 @@ fileprivate class _JSONReferencingEncoder : _JSONEncoder {
 
     /// Initializes `self` by referencing the given dictionary container in the given encoder.
     fileprivate init(referencing encoder: _JSONEncoder,
-                     key: CodingKey, convertedKey: CodingKey, wrapping dictionary: NSMutableDictionary) {
+                     key: CodingKey, convertedKey: __shared CodingKey, wrapping dictionary: NSMutableDictionary) {
         self.encoder = encoder
         self.reference = .dictionary(dictionary, convertedKey.stringValue)
         super.init(options: encoder.options, codingPath: encoder.codingPath)
@@ -1273,7 +1273,7 @@ fileprivate struct _JSONDecodingStorage {
         return self.containers.last!
     }
 
-    fileprivate mutating func push(container: Any) {
+    fileprivate mutating func push(container: __owned Any) {
         self.containers.append(container)
     }
 
@@ -1616,7 +1616,7 @@ fileprivate struct _JSONKeyedDecodingContainer<K : CodingKey> : KeyedDecodingCon
         return _JSONUnkeyedDecodingContainer(referencing: self.decoder, wrapping: array)
     }
 
-    private func _superDecoder(forKey key: CodingKey) throws -> Decoder {
+    private func _superDecoder(forKey key: __owned CodingKey) throws -> Decoder {
         self.decoder.codingPath.append(key)
         defer { self.decoder.codingPath.removeLast() }