1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 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 Foundation
package import LanguageServerProtocol
package import SKOptions
import SwiftExtensions
package import SwiftSyntax
package import ToolchainRegistry
package actor DocumentationLanguageService: LanguageService, Sendable {
/// The ``SourceKitLSPServer`` instance that created this `DocumentationLanguageService`.
private(set) weak var sourceKitLSPServer: SourceKitLSPServer?
var documentManager: DocumentManager {
get throws {
guard let sourceKitLSPServer else {
throw ResponseError.unknown("Connection to the editor closed")
}
return sourceKitLSPServer.documentManager
}
}
package init?(
sourceKitLSPServer: SourceKitLSPServer,
toolchain: Toolchain,
options: SourceKitLSPOptions,
hooks: Hooks,
workspace: Workspace
) async throws {
self.sourceKitLSPServer = sourceKitLSPServer
}
func workspaceForDocument(uri: DocumentURI) async throws -> Workspace? {
guard let sourceKitLSPServer else {
throw ResponseError.unknown("Connection to the editor closed")
}
return await sourceKitLSPServer.workspaceForDocument(uri: uri)
}
func languageService(
for uri: DocumentURI,
_ language: Language,
in workspace: Workspace
) async throws -> LanguageService? {
guard let sourceKitLSPServer else {
throw ResponseError.unknown("Connection to the editor closed")
}
return await sourceKitLSPServer.languageService(for: uri, language, in: workspace)
}
package nonisolated func canHandle(workspace: Workspace, toolchain: Toolchain) -> Bool {
return true
}
package func initialize(
_ initialize: InitializeRequest
) async throws -> InitializeResult {
return InitializeResult(
capabilities: ServerCapabilities()
)
}
package func clientInitialized(_ initialized: InitializedNotification) async {
// Nothing to set up
}
package func shutdown() async {
// Nothing to tear down
}
package func addStateChangeHandler(
handler: @escaping @Sendable (LanguageServerState, LanguageServerState) -> Void
) async {
// There is no underlying language server with which to report state
}
package func openDocument(
_ notification: DidOpenTextDocumentNotification,
snapshot: DocumentSnapshot
) async {
// The DocumentationLanguageService does not do anything with document events
}
package func closeDocument(_ notification: DidCloseTextDocumentNotification) async {
// The DocumentationLanguageService does not do anything with document events
}
package func reopenDocument(_ notification: ReopenTextDocumentNotification) async {
// The DocumentationLanguageService does not do anything with document events
}
package func changeDocument(
_ notification: DidChangeTextDocumentNotification,
preEditSnapshot: DocumentSnapshot,
postEditSnapshot: DocumentSnapshot,
edits: [SwiftSyntax.SourceEdit]
) async {
// The DocumentationLanguageService does not do anything with document events
}
package func willSaveDocument(_ notification: WillSaveTextDocumentNotification) async {
// The DocumentationLanguageService does not do anything with document events
}
package func didSaveDocument(_ notification: DidSaveTextDocumentNotification) async {
// The DocumentationLanguageService does not do anything with document events
}
package func documentUpdatedBuildSettings(_ uri: DocumentURI) async {
// The DocumentationLanguageService does not do anything with document events
}
package func documentDependenciesUpdated(_ uris: Set<DocumentURI>) async {
// The DocumentationLanguageService does not do anything with document events
}
package func completion(_ req: CompletionRequest) async throws -> CompletionList {
CompletionList(isIncomplete: false, items: [])
}
package func completionItemResolve(_ req: CompletionItemResolveRequest) async throws -> CompletionItem {
return req.item
}
package func hover(_ req: HoverRequest) async throws -> HoverResponse? {
nil
}
package func symbolInfo(_ request: SymbolInfoRequest) async throws -> [SymbolDetails] {
[]
}
package func openGeneratedInterface(
document: DocumentURI,
moduleName: String,
groupName: String?,
symbolUSR symbol: String?
) async throws -> GeneratedInterfaceDetails? {
nil
}
package func definition(_ request: DefinitionRequest) async throws -> LocationsOrLocationLinksResponse? {
nil
}
package func declaration(_ request: DeclarationRequest) async throws -> LocationsOrLocationLinksResponse? {
nil
}
package func documentSymbolHighlight(_ req: DocumentHighlightRequest) async throws -> [DocumentHighlight]? {
nil
}
package func foldingRange(_ req: FoldingRangeRequest) async throws -> [FoldingRange]? {
nil
}
package func documentSymbol(_ req: DocumentSymbolRequest) async throws -> DocumentSymbolResponse? {
nil
}
package func documentColor(_ req: DocumentColorRequest) async throws -> [ColorInformation] {
[]
}
package func documentSemanticTokens(
_ req: DocumentSemanticTokensRequest
) async throws -> DocumentSemanticTokensResponse? {
nil
}
package func documentSemanticTokensDelta(
_ req: DocumentSemanticTokensDeltaRequest
) async throws -> DocumentSemanticTokensDeltaResponse? {
nil
}
package func documentSemanticTokensRange(
_ req: DocumentSemanticTokensRangeRequest
) async throws -> DocumentSemanticTokensResponse? {
nil
}
package func colorPresentation(_ req: ColorPresentationRequest) async throws -> [ColorPresentation] {
[]
}
package func codeAction(_ req: CodeActionRequest) async throws -> CodeActionRequestResponse? {
nil
}
package func inlayHint(_ req: InlayHintRequest) async throws -> [InlayHint] {
[]
}
package func codeLens(_ req: CodeLensRequest) async throws -> [CodeLens] {
[]
}
package func documentDiagnostic(_ req: DocumentDiagnosticsRequest) async throws -> DocumentDiagnosticReport {
.full(RelatedFullDocumentDiagnosticReport(items: []))
}
package func documentFormatting(_ req: DocumentFormattingRequest) async throws -> [TextEdit]? {
nil
}
package func documentRangeFormatting(
_ req: LanguageServerProtocol.DocumentRangeFormattingRequest
) async throws -> [LanguageServerProtocol.TextEdit]? {
return nil
}
package func documentOnTypeFormatting(_ req: DocumentOnTypeFormattingRequest) async throws -> [TextEdit]? {
return nil
}
package func rename(_ request: RenameRequest) async throws -> (edits: WorkspaceEdit, usr: String?) {
(edits: WorkspaceEdit(), usr: nil)
}
package func editsToRename(
locations renameLocations: [RenameLocation],
in snapshot: DocumentSnapshot,
oldName: CrossLanguageName,
newName: CrossLanguageName
) async throws -> [TextEdit] {
[]
}
package func prepareRename(
_ request: PrepareRenameRequest
) async throws -> (prepareRename: PrepareRenameResponse, usr: String?)? {
nil
}
package func indexedRename(_ request: IndexedRenameRequest) async throws -> WorkspaceEdit? {
nil
}
package func editsToRenameParametersInFunctionBody(
snapshot: DocumentSnapshot,
renameLocation: RenameLocation,
newName: CrossLanguageName
) async -> [TextEdit] {
[]
}
package func executeCommand(_ req: ExecuteCommandRequest) async throws -> LSPAny? {
nil
}
package func getReferenceDocument(_ req: GetReferenceDocumentRequest) async throws -> GetReferenceDocumentResponse {
GetReferenceDocumentResponse(content: "")
}
package func syntacticDocumentTests(
for uri: DocumentURI,
in workspace: Workspace
) async throws -> [AnnotatedTestItem]? {
nil
}
package func canonicalDeclarationPosition(
of position: Position,
in uri: DocumentURI
) async -> Position? {
nil
}
package func crash() async {
// There's no way to crash the DocumentationLanguageService
}
}
|