mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
c9a1a08255
We need a mapping from source file to its output path in order to support source files that are part of multiple targets (because we need the output path to check if we have an up-to-date unit for a file in a given target). To achieve this mapping, it’s easier to tag the output path for each source file onto the `buildTarget/sources` request.
66 lines
2.7 KiB
Swift
66 lines
2.7 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
package import BuildServerProtocol
|
|
package import Foundation
|
|
package import LanguageServerProtocol
|
|
import SKLogging
|
|
import SKOptions
|
|
import ToolchainRegistry
|
|
|
|
/// An error build systems can throw from `prepare` if they don't support preparation of targets.
|
|
package struct PrepareNotSupportedError: Error, CustomStringConvertible {
|
|
package init() {}
|
|
|
|
package var description: String { "Preparation not supported" }
|
|
}
|
|
|
|
/// Provider of FileBuildSettings and other build-related information.
|
|
package protocol BuiltInBuildSystem: AnyObject, Sendable {
|
|
/// The files to watch for changes.
|
|
var fileWatchers: [FileSystemWatcher] { get async }
|
|
|
|
/// The path to the raw index store data, if any.
|
|
var indexStorePath: URL? { get async }
|
|
|
|
/// The path to put the index database, if any.
|
|
var indexDatabasePath: URL? { get async }
|
|
|
|
/// Whether the build system is capable of preparing a target for indexing and determining the output paths for the
|
|
/// target, ie. whether the `prepare` method has been implemented and this build server populates the `outputPath`
|
|
/// property in the `buildTarget/sources` request.
|
|
var supportsPreparationAndOutputPaths: Bool { get }
|
|
|
|
/// Returns all targets in the build system
|
|
func buildTargets(request: WorkspaceBuildTargetsRequest) async throws -> WorkspaceBuildTargetsResponse
|
|
|
|
/// Returns all the source files in the given targets
|
|
func buildTargetSources(request: BuildTargetSourcesRequest) async throws -> BuildTargetSourcesResponse
|
|
|
|
/// Called when files in the project change.
|
|
func didChangeWatchedFiles(notification: OnWatchedFilesDidChangeNotification) async
|
|
|
|
/// Prepare the given targets for indexing and semantic functionality. This should build all swift modules of target
|
|
/// dependencies.
|
|
func prepare(request: BuildTargetPrepareRequest) async throws -> VoidResponse
|
|
|
|
/// Retrieve build settings for the given document.
|
|
///
|
|
/// Returns `nil` if the build system can't provide build settings for this file.
|
|
func sourceKitOptions(
|
|
request: TextDocumentSourceKitOptionsRequest
|
|
) async throws -> TextDocumentSourceKitOptionsResponse?
|
|
|
|
/// Wait until the build graph has been loaded.
|
|
func waitForBuildSystemUpdates(request: WorkspaceWaitForBuildSystemUpdatesRequest) async -> VoidResponse
|
|
}
|