Files
sourcekit-lsp/Sources/SourceKitD/SourceKitDRegistry.swift
Alex Hoppen be546308ca Use URL in many cases where we used AbsolutePath
We made quite a few fixes recently to make sure that path handling works correctly using `URL` on Windows. Use `URL` in most places to have a single type that represents file paths instead of sometimes using `AbsolutePath`.

While doing so, also remove usages of `TSCBasic.FileSystem` an `InMemoryFileSystem`. The pattern of using `InMemoryFileSystem` for tests was never consistently used and it was a little confusing that some types took a `FileSystem` parameter while other always assumed to work on the local file system.
2024-11-18 18:19:48 -08:00

80 lines
2.9 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2020 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
//
//===----------------------------------------------------------------------===//
#if compiler(>=6)
package import Foundation
#else
import Foundation
#endif
/// The set of known SourceKitD instances, uniqued by path.
///
/// It is not generally safe to have two instances of SourceKitD for the same libsourcekitd, so
/// care is taken to ensure that there is only ever one instance per path.
///
/// * To get a new instance, use `getOrAdd("path", create: { NewSourceKitD() })`.
/// * To remove an existing instance, use `remove("path")`, but be aware that if there are any other
/// references to the instances in the program, it can be resurrected if `getOrAdd` is called with
/// the same path. See note on `remove(_:)`
package actor SourceKitDRegistry {
/// Mapping from path to active SourceKitD instance.
private var active: [URL: SourceKitD] = [:]
/// Instances that have been unregistered, but may be resurrected if accessed before destruction.
private var cemetary: [URL: WeakSourceKitD] = [:]
/// Initialize an empty registry.
package init() {}
/// The global shared SourceKitD registry.
package static let shared: SourceKitDRegistry = SourceKitDRegistry()
/// Returns the existing SourceKitD for the given path, or creates it and registers it.
package func getOrAdd(
_ key: URL,
create: @Sendable () throws -> SourceKitD
) rethrows -> SourceKitD {
if let existing = active[key] {
return existing
}
if let resurrected = cemetary[key]?.value {
cemetary[key] = nil
active[key] = resurrected
return resurrected
}
let newValue = try create()
active[key] = newValue
return newValue
}
/// Removes the SourceKitD instance registered for the given path, if any, from the set of active
/// instances.
///
/// Since it is not generally safe to have two sourcekitd connections at once, the existing value
/// is converted to a weak reference until it is no longer referenced anywhere by the program. If
/// the same path is looked up again before the original service is deinitialized, the original
/// service is resurrected rather than creating a new instance.
package func remove(_ key: URL) -> SourceKitD? {
let existing = active.removeValue(forKey: key)
if let existing = existing {
assert(self.cemetary[key]?.value == nil)
cemetary[key] = WeakSourceKitD(value: existing)
}
return existing
}
}
fileprivate struct WeakSourceKitD {
weak var value: SourceKitD?
}