Files
sourcekit-lsp/Sources/SwiftExtensions/ThreadSafeBox.swift
Alex Hoppen 2877675bd5 Adopt package access level
Change a l public declarations to the `package` access level, accept for:
- The `LanguageServerProtocol` module
- The `BuildServerProtocol` module
- `InProcessClient.InProcessSourceKitLSPClient`
- `LanguageServerProtocolJSONRPC` (I would like to create a more ergonomic API for this like `InProcessSourceKitLSPClient` in the future, but for now, we’ll leave it public)

Unfortunately, our pattern of marking functions as `@_spi(Testing) public` no longer works with the `package` access level because declarations at the `package` access level cannot be marked as SPI. I have decided to just mark these functions as `package`. Alternatives would be:
- Add an underscore to these functions, like we did for functions exposed for testing before the introduction of `SPI`
- Use `@testable` import in the test targets and mark the methods as `internal`

Resolves #1315
rdar://128295618
2024-07-19 09:54:30 -07:00

62 lines
1.6 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 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
//
//===----------------------------------------------------------------------===//
import Foundation
/// A thread safe container that contains a value of type `T`.
///
/// - Note: Unchecked sendable conformance because value is guarded by a lock.
package class ThreadSafeBox<T: Sendable>: @unchecked Sendable {
/// Lock guarding `_value`.
private let lock = NSLock()
private var _value: T
package var value: T {
get {
return lock.withLock {
return _value
}
}
set {
lock.withLock {
_value = newValue
}
}
_modify {
lock.lock()
defer { lock.unlock() }
yield &_value
}
}
package init(initialValue: T) {
_value = initialValue
}
package func withLock<Result>(_ body: (inout T) -> Result) -> Result {
return lock.withLock {
return body(&_value)
}
}
/// If the value in the box is an optional, return it and reset it to `nil`
/// in an atomic operation.
package func takeValue<U>() -> T where U? == T {
lock.withLock {
guard let value = self._value else { return nil }
self._value = nil
return value
}
}
}