Files
sourcekit-lsp/Sources/BuildServerIntegration/BuildServerHooks.swift
Alex Hoppen 7f4f92e5bd Rename build system to build server in most cases
The term *build system* predated our wide-spread adoption of BSP for communicating between SourceKit-LSP to the build system and was never really the correct term anyway – ie. a `JSONCompilationDatabaseBuildSystem` never really sounded right. We now have a correct term for the communication layer between SourceKit-LSP: A build server. Rename most occurrences of *build system* to *build server* to reflect this. There are unfortunately a couple lingering instances of *build system* that we can’t change, most notably: `fallbackBuildSystem` in the config file, the `workspace/waitForBuildSystemUpdates` BSP extension request and the `synchronize-for-build-system-updates` experimental feature.
2025-08-02 08:45:01 +02:00

54 lines
2.1 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
//
//===----------------------------------------------------------------------===//
package import Foundation
package import LanguageServerProtocol
package struct SwiftPMTestHooks: Sendable {
package var reloadPackageDidStart: (@Sendable () async -> Void)?
package var reloadPackageDidFinish: (@Sendable () async -> Void)?
package init(
reloadPackageDidStart: (@Sendable () async -> Void)? = nil,
reloadPackageDidFinish: (@Sendable () async -> Void)? = nil
) {
self.reloadPackageDidStart = reloadPackageDidStart
self.reloadPackageDidFinish = reloadPackageDidFinish
}
}
package struct BuildServerHooks: Sendable {
package var swiftPMTestHooks: SwiftPMTestHooks
/// A hook that will be executed before a request is handled by a `BuiltInBuildServer`.
///
/// This allows requests to be artificially delayed.
package var preHandleRequest: (@Sendable (any RequestType) async -> Void)?
/// When running SourceKit-LSP in-process, allows the creator of `SourceKitLSPServer` to create a message handler that
/// handles BSP requests instead of SourceKit-LSP creating build server as needed.
package var injectBuildServer:
(@Sendable (_ projectRoot: URL, _ connectionToSourceKitLSP: any Connection) async -> any Connection)?
package init(
swiftPMTestHooks: SwiftPMTestHooks = SwiftPMTestHooks(),
preHandleRequest: (@Sendable (any RequestType) async -> Void)? = nil,
injectBuildServer: (
@Sendable (_ projectRoot: URL, _ connectionToSourceKitLSP: any Connection) async -> any Connection
)? = nil
) {
self.swiftPMTestHooks = swiftPMTestHooks
self.preHandleRequest = preHandleRequest
self.injectBuildServer = injectBuildServer
}
}