|
| 1 | +//===----------------------------------------------------------------------===// |
| 2 | +// |
| 3 | +// This source file is part of the Swift.org open source project |
| 4 | +// |
| 5 | +// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors |
| 6 | +// Licensed under Apache License v2.0 with Runtime Library Exception |
| 7 | +// |
| 8 | +// See http://swift.org/LICENSE.txt for license information |
| 9 | +// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors |
| 10 | +// |
| 11 | +//===----------------------------------------------------------------------===// |
| 12 | + |
| 13 | +#if NS_BUILDING_FOUNDATION_NETWORKING |
| 14 | +#if os(macOS) || os(iOS) || os(watchOS) || os(tvOS) |
| 15 | +import SwiftFoundation |
| 16 | +#else |
| 17 | +import Foundation |
| 18 | +#endif |
| 19 | +#endif |
| 20 | + |
| 21 | +/// A class type which acts as a handle (pointer-to-pointer) to a Foundation reference type which has only a mutable class (e.g., NSURLComponents). |
| 22 | +/// |
| 23 | +/// Note: This assumes that the result of calling copy() is mutable. The documentation says that classes which do not have a mutable/immutable distinction should just adopt NSCopying instead of NSMutableCopying. |
| 24 | +internal final class _MutableHandle<MutableType : NSObject> where MutableType : NSCopying { |
| 25 | + @usableFromInline internal var _pointer : MutableType |
| 26 | + |
| 27 | + init(reference : MutableType) { |
| 28 | + _pointer = reference.copy() as! MutableType |
| 29 | + } |
| 30 | + |
| 31 | + init(adoptingReference reference: MutableType) { |
| 32 | + _pointer = reference |
| 33 | + } |
| 34 | + |
| 35 | + /// Apply a closure to the reference type. |
| 36 | + func map<ReturnType>(_ whatToDo : (MutableType) throws -> ReturnType) rethrows -> ReturnType { |
| 37 | + return try whatToDo(_pointer) |
| 38 | + } |
| 39 | + |
| 40 | + func _copiedReference() -> MutableType { |
| 41 | + return _pointer.copy() as! MutableType |
| 42 | + } |
| 43 | + |
| 44 | + func _uncopiedReference() -> MutableType { |
| 45 | + return _pointer |
| 46 | + } |
| 47 | +} |
| 48 | + |
| 49 | +/// Describes common operations for Foundation struct types that are bridged to a mutable object (e.g. NSURLComponents). |
| 50 | +internal protocol _MutableBoxing : ReferenceConvertible { |
| 51 | + var _handle : _MutableHandle<ReferenceType> { get set } |
| 52 | + |
| 53 | + /// Apply a mutating closure to the reference type, regardless if it is mutable or immutable. |
| 54 | + /// |
| 55 | + /// This function performs the correct copy-on-write check for efficient mutation. |
| 56 | + mutating func _applyMutation<ReturnType>(_ whatToDo : (ReferenceType) -> ReturnType) -> ReturnType |
| 57 | +} |
| 58 | + |
| 59 | +extension _MutableBoxing { |
| 60 | + @inline(__always) |
| 61 | + mutating func _applyMutation<ReturnType>(_ whatToDo : (ReferenceType) -> ReturnType) -> ReturnType { |
| 62 | + // Only create a new box if we are not uniquely referenced |
| 63 | + if !isKnownUniquelyReferenced(&_handle) { |
| 64 | + let ref = _handle._pointer |
| 65 | + _handle = _MutableHandle(reference: ref) |
| 66 | + } |
| 67 | + return whatToDo(_handle._pointer) |
| 68 | + } |
| 69 | +} |
| 70 | + |
| 71 | +internal enum _MutableUnmanagedWrapper<ImmutableType : NSObject, MutableType : NSObject> where MutableType : NSMutableCopying { |
| 72 | + case Immutable(Unmanaged<ImmutableType>) |
| 73 | + case Mutable(Unmanaged<MutableType>) |
| 74 | +} |
| 75 | + |
| 76 | +internal protocol _SwiftNativeFoundationType : class { |
| 77 | + associatedtype ImmutableType : NSObject |
| 78 | + associatedtype MutableType : NSObject, NSMutableCopying |
| 79 | + var __wrapped : _MutableUnmanagedWrapper<ImmutableType, MutableType> { get } |
| 80 | + |
| 81 | + init(unmanagedImmutableObject: Unmanaged<ImmutableType>) |
| 82 | + init(unmanagedMutableObject: Unmanaged<MutableType>) |
| 83 | + |
| 84 | + func mutableCopy(with zone : NSZone) -> Any |
| 85 | + |
| 86 | + func hash(into hasher: inout Hasher) |
| 87 | + var hashValue: Int { get } |
| 88 | + |
| 89 | + var description: String { get } |
| 90 | + var debugDescription: String { get } |
| 91 | + |
| 92 | + func releaseWrappedObject() |
| 93 | +} |
| 94 | + |
| 95 | +extension _SwiftNativeFoundationType { |
| 96 | + |
| 97 | + @inline(__always) |
| 98 | + func _mapUnmanaged<ReturnType>(_ whatToDo : (ImmutableType) throws -> ReturnType) rethrows -> ReturnType { |
| 99 | + defer { _fixLifetime(self) } |
| 100 | + |
| 101 | + switch __wrapped { |
| 102 | + case .Immutable(let i): |
| 103 | + return try i._withUnsafeGuaranteedRef { |
| 104 | + _onFastPath() |
| 105 | + return try whatToDo($0) |
| 106 | + } |
| 107 | + case .Mutable(let m): |
| 108 | + return try m._withUnsafeGuaranteedRef { |
| 109 | + _onFastPath() |
| 110 | + return try whatToDo(_unsafeReferenceCast($0, to: ImmutableType.self)) |
| 111 | + } |
| 112 | + } |
| 113 | + } |
| 114 | + |
| 115 | + func releaseWrappedObject() { |
| 116 | + switch __wrapped { |
| 117 | + case .Immutable(let i): |
| 118 | + i.release() |
| 119 | + case .Mutable(let m): |
| 120 | + m.release() |
| 121 | + } |
| 122 | + } |
| 123 | + |
| 124 | + func mutableCopy(with zone : NSZone) -> Any { |
| 125 | + return _mapUnmanaged { ($0 as NSObject).mutableCopy() } |
| 126 | + } |
| 127 | + |
| 128 | + func hash(into hasher: inout Hasher) { |
| 129 | + _mapUnmanaged { hasher.combine($0) } |
| 130 | + } |
| 131 | + |
| 132 | + var hashValue: Int { |
| 133 | + return _mapUnmanaged { return $0.hashValue } |
| 134 | + } |
| 135 | + |
| 136 | + var description: String { |
| 137 | + return _mapUnmanaged { return $0.description } |
| 138 | + } |
| 139 | + |
| 140 | + var debugDescription: String { |
| 141 | + return _mapUnmanaged { return $0.debugDescription } |
| 142 | + } |
| 143 | + |
| 144 | + func isEqual(_ other: AnyObject) -> Bool { |
| 145 | + return _mapUnmanaged { return $0.isEqual(other) } |
| 146 | + } |
| 147 | +} |
| 148 | + |
| 149 | +internal protocol _MutablePairBoxing { |
| 150 | + associatedtype WrappedSwiftNSType : _SwiftNativeFoundationType |
| 151 | + var _wrapped : WrappedSwiftNSType { get set } |
| 152 | +} |
| 153 | + |
| 154 | +extension _MutablePairBoxing { |
| 155 | + @inline(__always) |
| 156 | + func _mapUnmanaged<ReturnType>(_ whatToDo : (WrappedSwiftNSType.ImmutableType) throws -> ReturnType) rethrows -> ReturnType { |
| 157 | + // We are using Unmanaged. Make sure that the owning container class |
| 158 | + // 'self' is guaranteed to be alive by extending the lifetime of 'self' |
| 159 | + // to the end of the scope of this function. |
| 160 | + // Note: At the time of this writing using withExtendedLifetime here |
| 161 | + // instead of _fixLifetime causes different ARC pair matching behavior |
| 162 | + // foiling optimization. This is why we explicitly use _fixLifetime here |
| 163 | + // instead. |
| 164 | + defer { _fixLifetime(self) } |
| 165 | + |
| 166 | + let unmanagedHandle = Unmanaged.passUnretained(_wrapped) |
| 167 | + let wrapper = unmanagedHandle._withUnsafeGuaranteedRef { $0.__wrapped } |
| 168 | + switch (wrapper) { |
| 169 | + case .Immutable(let i): |
| 170 | + return try i._withUnsafeGuaranteedRef { |
| 171 | + return try whatToDo($0) |
| 172 | + } |
| 173 | + case .Mutable(let m): |
| 174 | + return try m._withUnsafeGuaranteedRef { |
| 175 | + return try whatToDo(_unsafeReferenceCast($0, to: WrappedSwiftNSType.ImmutableType.self)) |
| 176 | + } |
| 177 | + } |
| 178 | + } |
| 179 | + |
| 180 | + @inline(__always) |
| 181 | + mutating func _applyUnmanagedMutation<ReturnType>(_ whatToDo : (WrappedSwiftNSType.MutableType) throws -> ReturnType) rethrows -> ReturnType { |
| 182 | + // We are using Unmanaged. Make sure that the owning container class |
| 183 | + // 'self' is guaranteed to be alive by extending the lifetime of 'self' |
| 184 | + // to the end of the scope of this function. |
| 185 | + // Note: At the time of this writing using withExtendedLifetime here |
| 186 | + // instead of _fixLifetime causes different ARC pair matching behavior |
| 187 | + // foiling optimization. This is why we explicitly use _fixLifetime here |
| 188 | + // instead. |
| 189 | + defer { _fixLifetime(self) } |
| 190 | + |
| 191 | + var unique = true |
| 192 | + let _unmanagedHandle = Unmanaged.passUnretained(_wrapped) |
| 193 | + let wrapper = _unmanagedHandle._withUnsafeGuaranteedRef { $0.__wrapped } |
| 194 | + |
| 195 | + // This check is done twice because: <rdar://problem/24939065> Value kept live for too long causing uniqueness check to fail |
| 196 | + switch (wrapper) { |
| 197 | + case .Immutable: |
| 198 | + break |
| 199 | + case .Mutable: |
| 200 | + unique = isKnownUniquelyReferenced(&_wrapped) |
| 201 | + } |
| 202 | + |
| 203 | + switch (wrapper) { |
| 204 | + case .Immutable(let i): |
| 205 | + // We need to become mutable; by creating a new instance we also become unique |
| 206 | + let copy = Unmanaged.passRetained(i._withUnsafeGuaranteedRef { |
| 207 | + return _unsafeReferenceCast($0.mutableCopy(), to: WrappedSwiftNSType.MutableType.self) } |
| 208 | + ) |
| 209 | + |
| 210 | + // Be sure to set the var before calling out; otherwise references to the struct in the closure may be looking at the old value |
| 211 | + _wrapped = WrappedSwiftNSType(unmanagedMutableObject: copy) |
| 212 | + return try copy._withUnsafeGuaranteedRef { |
| 213 | + _onFastPath() |
| 214 | + return try whatToDo($0) |
| 215 | + } |
| 216 | + case .Mutable(let m): |
| 217 | + // Only create a new box if we are not uniquely referenced |
| 218 | + if !unique { |
| 219 | + let copy = Unmanaged.passRetained(m._withUnsafeGuaranteedRef { |
| 220 | + return _unsafeReferenceCast($0.mutableCopy(), to: WrappedSwiftNSType.MutableType.self) |
| 221 | + }) |
| 222 | + _wrapped = WrappedSwiftNSType(unmanagedMutableObject: copy) |
| 223 | + return try copy._withUnsafeGuaranteedRef { |
| 224 | + _onFastPath() |
| 225 | + return try whatToDo($0) |
| 226 | + } |
| 227 | + } else { |
| 228 | + return try m._withUnsafeGuaranteedRef { |
| 229 | + _onFastPath() |
| 230 | + return try whatToDo($0) |
| 231 | + } |
| 232 | + } |
| 233 | + } |
| 234 | + } |
| 235 | +} |
0 commit comments