123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168 |
- //
- // Protected.swift
- //
- // Copyright (c) 2014-2020 Alamofire Software Foundation (http://alamofire.org/)
- //
- // Permission is hereby granted, free of charge, to any person obtaining a copy
- // of this software and associated documentation files (the "Software"), to deal
- // in the Software without restriction, including without limitation the rights
- // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- // copies of the Software, and to permit persons to whom the Software is
- // furnished to do so, subject to the following conditions:
- //
- // The above copyright notice and this permission notice shall be included in
- // all copies or substantial portions of the Software.
- //
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- // THE SOFTWARE.
- //
- import Foundation
- private protocol Lock {
- func lock()
- func unlock()
- }
- extension Lock {
- /// Executes a closure returning a value while acquiring the lock.
- ///
- /// - Parameter closure: The closure to run.
- ///
- /// - Returns: The value the closure generated.
- func around<T>(_ closure: () throws -> T) rethrows -> T {
- lock(); defer { unlock() }
- return try closure()
- }
- /// Execute a closure while acquiring the lock.
- ///
- /// - Parameter closure: The closure to run.
- func around(_ closure: () throws -> Void) rethrows {
- lock(); defer { unlock() }
- try closure()
- }
- }
- #if canImport(Darwin)
- /// An `os_unfair_lock` wrapper.
- final class UnfairLock: Lock {
- private let unfairLock: os_unfair_lock_t
- init() {
- unfairLock = .allocate(capacity: 1)
- unfairLock.initialize(to: os_unfair_lock())
- }
- deinit {
- unfairLock.deinitialize(count: 1)
- unfairLock.deallocate()
- }
- fileprivate func lock() {
- os_unfair_lock_lock(unfairLock)
- }
- fileprivate func unlock() {
- os_unfair_lock_unlock(unfairLock)
- }
- }
- #elseif canImport(Foundation)
- extension NSLock: Lock {}
- #else
- #error("This platform needs a Lock-conforming type without Foundation.")
- #endif
- /// A thread-safe wrapper around a value.
- @dynamicMemberLookup
- final class Protected<Value> {
- #if canImport(Darwin)
- private let lock = UnfairLock()
- #elseif canImport(Foundation)
- private let lock = NSLock()
- #else
- #error("This platform needs a Lock-conforming type without Foundation.")
- #endif
- private var value: Value
- init(_ value: Value) {
- self.value = value
- }
- /// Synchronously read or transform the contained value.
- ///
- /// - Parameter closure: The closure to execute.
- ///
- /// - Returns: The return value of the closure passed.
- func read<U>(_ closure: (Value) throws -> U) rethrows -> U {
- try lock.around { try closure(self.value) }
- }
- /// Synchronously modify the protected value.
- ///
- /// - Parameter closure: The closure to execute.
- ///
- /// - Returns: The modified value.
- @discardableResult
- func write<U>(_ closure: (inout Value) throws -> U) rethrows -> U {
- try lock.around { try closure(&self.value) }
- }
- /// Synchronously update the protected value.
- ///
- /// - Parameter value: The `Value`.
- func write(_ value: Value) {
- write { $0 = value }
- }
- subscript<Property>(dynamicMember keyPath: WritableKeyPath<Value, Property>) -> Property {
- get { lock.around { value[keyPath: keyPath] } }
- set { lock.around { value[keyPath: keyPath] = newValue } }
- }
- subscript<Property>(dynamicMember keyPath: KeyPath<Value, Property>) -> Property {
- lock.around { value[keyPath: keyPath] }
- }
- }
- extension Protected where Value == Request.MutableState {
- /// Attempts to transition to the passed `State`.
- ///
- /// - Parameter state: The `State` to attempt transition to.
- ///
- /// - Returns: Whether the transition occurred.
- func attemptToTransitionTo(_ state: Request.State) -> Bool {
- lock.around {
- guard value.state.canTransitionTo(state) else { return false }
- value.state = state
- return true
- }
- }
- /// Perform a closure while locked with the provided `Request.State`.
- ///
- /// - Parameter perform: The closure to perform while locked.
- func withState(perform: (Request.State) -> Void) {
- lock.around { perform(value.state) }
- }
- }
- extension Protected: Equatable where Value: Equatable {
- static func ==(lhs: Protected<Value>, rhs: Protected<Value>) -> Bool {
- lhs.read { left in rhs.read { right in left == right }}
- }
- }
- extension Protected: Hashable where Value: Hashable {
- func hash(into hasher: inout Hasher) {
- read { hasher.combine($0) }
- }
- }
|