mirror of
https://github.com/apple/sourcekit-lsp.git
synced 2026-03-06 18:24:36 +01:00
e5caf44fda
Introduce a `BuildSystemDelegate` to handle notifications from the build system
* `SourceKitServer` is the main delegate to process these notifications
* Currently limited to changes in `FileBuildSettings`
* Delegate informs the `BuildSystem` of files to watch via `registerChangeWatching(for: URL)` and `unregisterChangeWatching(for: URL)`
* In the future we could have more integration for handling changes in dependencies
Handling changes in `FileBuildSettings`
* `SourceKitServer` sends notifications to the internal LSPs informing them of any opened documents that have changes in their compiler flags
* For clangd, we send a notification to update the compilation database
* For SourceKit/sourcekitd we must close and reopen the file to force a new AST with the new compiler flags
96 lines
3.3 KiB
Swift
96 lines
3.3 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2018 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
/// The `settings` field of a `workspace/didChangeConfiguration`.
|
|
///
|
|
/// This is typed as `Any` in the protocol, and this enum contains the formats we support.
|
|
public enum WorkspaceSettingsChange: Codable, Hashable {
|
|
|
|
case clangd(ClangWorkspaceSettings)
|
|
case documentUpdated(DocumentUpdatedBuildSettings)
|
|
case unknown
|
|
|
|
public init(from decoder: Decoder) throws {
|
|
// FIXME: doing trial deserialization only works if we have at least one non-optional unique
|
|
// key, which we don't yet. For now, assume that if we add another kind of workspace settings
|
|
// it will rectify this issue.
|
|
if let settings = try? ClangWorkspaceSettings(from: decoder) {
|
|
self = .clangd(settings)
|
|
} else if let settings = try? DocumentUpdatedBuildSettings(from: decoder) {
|
|
self = .documentUpdated(settings)
|
|
} else {
|
|
self = .unknown
|
|
}
|
|
}
|
|
|
|
public func encode(to encoder: Encoder) throws {
|
|
switch self {
|
|
case .clangd(let settings):
|
|
try settings.encode(to: encoder)
|
|
case .documentUpdated(let settings):
|
|
try settings.encode(to: encoder)
|
|
case .unknown:
|
|
break // Nothing to do.
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Workspace settings for clangd, represented by a compilation database.
|
|
///
|
|
/// Clangd will accept *either* a path to a compilation database on disk, or the contents of a
|
|
/// compilation database to be managed in-memory, but they cannot be mixed.
|
|
public struct ClangWorkspaceSettings: Codable, Hashable {
|
|
|
|
/// The path to a json compilation database.
|
|
public var compilationDatabasePath: String?
|
|
|
|
/// Mapping from file name to compilation command.
|
|
public var compilationDatabaseChanges: [String: ClangCompileCommand]?
|
|
|
|
public init(
|
|
compilationDatabasePath: String? = nil,
|
|
compilationDatabaseChanges: [String: ClangCompileCommand]? = nil
|
|
) {
|
|
self.compilationDatabasePath = compilationDatabasePath
|
|
self.compilationDatabaseChanges = compilationDatabaseChanges
|
|
}
|
|
}
|
|
|
|
/// A single compile command for use in a clangd workspace settings.
|
|
public struct ClangCompileCommand: Codable, Hashable {
|
|
|
|
/// The command (executable + compiler arguments).
|
|
public var compilationCommand: [String]
|
|
|
|
/// The directory to perform the compilation in.
|
|
public var workingDirectory: String
|
|
|
|
public init(compilationCommand: [String], workingDirectory: String) {
|
|
self.compilationCommand = compilationCommand
|
|
self.workingDirectory = workingDirectory
|
|
}
|
|
}
|
|
|
|
/// Workspace settings for a document that has updated build settings.
|
|
public struct DocumentUpdatedBuildSettings: Codable, Hashable {
|
|
/// The url of the document that has updated.
|
|
public var url: URL
|
|
|
|
/// The language of the document that has updated.
|
|
public var language: Language
|
|
|
|
public init(url: URL, language: Language) {
|
|
self.url = url
|
|
self.language = language
|
|
}
|
|
}
|