mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-02 18:23:24 +01:00
cf19900d84
Remove `settings(for:)` from the BuildSystem API in favor of the change callback - With the `settings(for:)` method removed, we instead block on a callback from the `BuildSystemManager` which itself handles the primary build system callback in conjunction with the fallback system - We queue up notifications / requests that reference documents until we receive the callback. - Remove language from FileBuildSettings as it is no longer needed, Swift-specific working dir fixes are now in SwiftCompileCommand - registerForChangeNotifications should inform its delegate asynchronously instead of immediately
66 lines
2.8 KiB
Swift
66 lines
2.8 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import BuildServerProtocol
|
|
import LanguageServerProtocol
|
|
import TSCBasic
|
|
|
|
/// Provider of FileBuildSettings and other build-related information.
|
|
///
|
|
/// The primary role of the build system is to answer queries for
|
|
/// FileBuildSettings and to notify its delegate when they change. The
|
|
/// BuildSystem is also the source of related information, such as where the
|
|
/// index datastore is located.
|
|
///
|
|
/// For example, a SwiftPMWorkspace provides compiler arguments for the files
|
|
/// contained in a SwiftPM package root directory.
|
|
public protocol BuildSystem: AnyObject {
|
|
|
|
/// The path to the raw index store data, if any.
|
|
var indexStorePath: AbsolutePath? { get }
|
|
|
|
/// The path to put the index database, if any.
|
|
var indexDatabasePath: AbsolutePath? { get }
|
|
|
|
/// Delegate to handle any build system events such as file build settings
|
|
/// initial reports as well as changes.
|
|
var delegate: BuildSystemDelegate? { get set }
|
|
|
|
/// Register the given file for build-system level change notifications, such
|
|
/// as command line flag changes, dependency changes, etc.
|
|
///
|
|
/// IMPORTANT: When first receiving a register request, the `BuildSystem` MUST asynchronously
|
|
/// inform its delegate of any initial settings for the given file via the
|
|
/// `fileBuildSettingsChanged` method, even if unavailable.
|
|
func registerForChangeNotifications(for: DocumentURI, language: Language)
|
|
|
|
/// Unregister the given file for build-system level change notifications,
|
|
/// such as command line flag changes, dependency changes, etc.
|
|
func unregisterForChangeNotifications(for: DocumentURI)
|
|
|
|
/// Returns the build targets in the workspace. If the build system does not
|
|
/// support build targets the `buildTargetsNotSupported` error should be
|
|
/// returned.
|
|
func buildTargets(reply: @escaping (LSPResult<[BuildTarget]>) -> Void)
|
|
|
|
/// Returns the sources for the requested build targets
|
|
func buildTargetSources(targets: [BuildTargetIdentifier],
|
|
reply: @escaping (LSPResult<[SourcesItem]>) -> Void)
|
|
|
|
/// Returns the output paths for the requested build targets
|
|
func buildTargetOutputPaths(targets: [BuildTargetIdentifier],
|
|
reply: @escaping (LSPResult<[OutputsItem]>) -> Void)
|
|
}
|
|
|
|
public let buildTargetsNotSupported =
|
|
ResponseError.methodNotFound(BuildTargets.method)
|