mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
102 lines
3.5 KiB
Swift
102 lines
3.5 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2024 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 BuildServerProtocol
|
|
import LanguageServerProtocol
|
|
import SKLogging
|
|
import SwiftExtensions
|
|
|
|
/// A lightweight way of describing tasks that are created from handling BSP
|
|
/// requests or notifications for the purpose of dependency tracking.
|
|
package enum BuildSystemMessageDependencyTracker: DependencyTracker {
|
|
/// A task that modifies some state. It is a barrier for all requests that read state.
|
|
case stateChange
|
|
|
|
/// A task that reads state, such as getting all build targets. These tasks can be run concurrently with other tasks
|
|
/// that read state but needs to wait for all state changes to be handled first.
|
|
case stateRead
|
|
|
|
/// A task that is responsible for logging information to the client. They can be run concurrently to any state read
|
|
/// and changes but logging tasks must be ordered among each other.
|
|
case logging
|
|
|
|
/// Whether this request needs to finish before `other` can start executing.
|
|
package func isDependency(of other: BuildSystemMessageDependencyTracker) -> Bool {
|
|
switch (self, other) {
|
|
case (.stateChange, .stateChange): return true
|
|
case (.stateChange, .stateRead): return true
|
|
case (.stateRead, .stateChange): return true
|
|
case (.stateRead, .stateRead): return false
|
|
case (.logging, .logging): return true
|
|
case (.logging, _): return false
|
|
case (_, .logging): return false
|
|
}
|
|
}
|
|
|
|
init(_ notification: any NotificationType) {
|
|
switch notification {
|
|
case is FileOptionsChangedNotification:
|
|
self = .stateChange
|
|
case is OnBuildExitNotification:
|
|
self = .stateChange
|
|
case is OnBuildInitializedNotification:
|
|
self = .stateChange
|
|
case is OnBuildLogMessageNotification:
|
|
self = .logging
|
|
case is OnBuildTargetDidChangeNotification:
|
|
self = .stateChange
|
|
case is OnWatchedFilesDidChangeNotification:
|
|
self = .stateChange
|
|
default:
|
|
logger.error(
|
|
"""
|
|
Unknown notification \(type(of: notification)). Treating as a stateChange notification. \
|
|
This might lead to sub-optimal performance because it inhibits parallelism.
|
|
"""
|
|
)
|
|
self = .stateRead
|
|
}
|
|
}
|
|
|
|
init(_ request: any RequestType) {
|
|
switch request {
|
|
case is BuildShutdownRequest:
|
|
self = .stateChange
|
|
case is BuildTargetPrepareRequest:
|
|
self = .stateRead
|
|
case is BuildTargetSourcesRequest:
|
|
self = .stateRead
|
|
case is BuildServerProtocol.CreateWorkDoneProgressRequest:
|
|
self = .logging
|
|
case is InitializeBuildRequest:
|
|
self = .stateChange
|
|
case is RegisterForChanges:
|
|
self = .stateChange
|
|
case is TextDocumentSourceKitOptionsRequest:
|
|
self = .stateRead
|
|
case is WorkspaceBuildTargetsRequest:
|
|
self = .stateRead
|
|
case is WorkspaceWaitForBuildSystemUpdatesRequest:
|
|
self = .stateRead
|
|
|
|
default:
|
|
logger.error(
|
|
"""
|
|
Unknown request \(type(of: request)). Treating as a stateChange request. \
|
|
This might lead to sub-optimal performance because it inhibits parallelism.
|
|
"""
|
|
)
|
|
self = .stateChange
|
|
}
|
|
}
|
|
}
|