add go-to-definition for inlay hints (#2318) #2436
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Member
There was a problem hiding this comment. Could you add this file to CMakeLists.txt to make the tests pass on Windows? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift.org open source project | ||
| // | ||
| // Copyright (c) 2014 - 2026 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 | ||
| import IndexStoreDB | ||
| @_spi(SourceKitLSP) package import LanguageServerProtocol | ||
| import SemanticIndex | ||
| import SourceKitD | ||
| import SourceKitLSP | ||
|
|
||
| extension SwiftLanguageService { | ||
| /// resolves an inlay hint by looking up the type definition location | ||
| package func inlayHintResolve(_ req: InlayHintResolveRequest) async throws -> InlayHint { | ||
| var hint = req.inlayHint | ||
|
|
||
| // only resolve type hints that have stored data | ||
| // extract uri and position from the lspany dictionary | ||
| guard hint.kind == .type, | ||
| case .dictionary(let dict) = hint.data, | ||
| case .string(let uriString) = dict["uri"], | ||
| let uri = try? DocumentURI(string: uriString), | ||
| case .dictionary(let posDict) = dict["position"], | ||
| case .int(let line) = posDict["line"], | ||
| case .int(let character) = posDict["character"] | ||
| else { | ||
| return hint | ||
| } | ||
| let position = Position(line: line, utf16index: character) | ||
|
|
||
| // get the type usr by calling cursor info at the variable position | ||
| let typeLocation = try await lookupTypeDefinitionLocation( | ||
| uri: uri, | ||
| position: position | ||
| ) | ||
|
|
||
| guard let typeLocation else { | ||
| return hint | ||
| } | ||
|
|
||
| // return new hint with label parts that have location for go-to-definition | ||
| if case .string(let labelText) = hint.label { | ||
| return InlayHint( | ||
| position: hint.position, | ||
| label: .parts([InlayHintLabelPart(value: labelText, location: typeLocation)]), | ||
| kind: hint.kind, | ||
| textEdits: hint.textEdits, | ||
| tooltip: hint.tooltip, | ||
| paddingLeft: hint.paddingLeft, | ||
| paddingRight: hint.paddingRight, | ||
| data: hint.data | ||
| ) | ||
| } | ||
|
|
||
| return hint | ||
| } | ||
|
|
||
| /// Looks up the definition location for the type at the given position. | ||
| /// | ||
| /// This is used by both inlay hint resolution and the typeDefinition request. | ||
| /// It works by: | ||
| /// 1. Getting the type USR (mangled name) from cursorInfo at the position | ||
| /// 2. Converting the mangled type ($s prefix) to a proper USR (s: prefix) | ||
| /// 3. Looking up the type definition in the index or via cursorInfo | ||
| func lookupTypeDefinitionLocation( | ||
| uri: DocumentURI, | ||
| position: Position | ||
| ) async throws -> Location? { | ||
| // Step 1: Get type USR from cursor info at the position | ||
| let snapshot = try await self.latestSnapshot(for: uri) | ||
| let compileCommand = await self.compileCommand(for: uri, fallbackAfterTimeout: false) | ||
|
|
||
| let skreq = sourcekitd.dictionary([ | ||
| keys.cancelOnSubsequentRequest: 0, | ||
| keys.offset: snapshot.utf8Offset(of: position), | ||
| keys.sourceFile: snapshot.uri.sourcekitdSourceFile, | ||
| keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath, | ||
| keys.compilerArgs: compileCommand?.compilerArgs as [any SKDRequestValue]?, | ||
| ]) | ||
|
|
||
| let dict = try await send(sourcekitdRequest: \.cursorInfo, skreq, snapshot: snapshot) | ||
|
|
||
| // Get the type USR (this is of a mangled type like "$sSS" for String) | ||
| guard let typeUsr: String = dict[keys.typeUsr] else { | ||
| return nil | ||
| } | ||
|
|
||
| // step 2: Convert mangled type to proper USR | ||
| // The typeUsr is a mangled type like "$s4test6MyTypeVD" for struct MyType | ||
| // To get the declaration USR, we need to: | ||
| // 1. Replace "$s" prefix with "s:" | ||
| // 2. Strip the trailing "D" which is a mangling suffix (type descriptor) | ||
| var mangledName = typeUsr | ||
| if mangledName.hasPrefix("$s") { | ||
| mangledName = "s:" + mangledName.dropFirst(2) | ||
| } | ||
|
Member
There was a problem hiding this comment. Isn’t this duplicated with |
||
| // Strip trailing 'D' (type descriptor suffix in mangling) | ||
| if mangledName.hasSuffix("D") { | ||
| mangledName = String(mangledName.dropLast()) | ||
| } | ||
|
Member
There was a problem hiding this comment. Uh, this seems iffy to me. I really would prefer if we didn’t start interpreting mangled names, I just feel like there lie dragons that way (I’m somewhat fine with the Would you be able to handle USRs with a
Contributor
There was a problem hiding this comment. "D" in this case just means "type mangling", dropping it isn't guaranteed to give you the equivalent decl USR though, e.g you could have generic arguments present. The USR cursor info request should give back the right decl USR to use, I think it would make more sense to use that (though I don't know if an index lookup is still necessary in that case?) |
||
| let usr = mangledName | ||
|
|
||
| // step 3: Try index lookup first (works well for local and external types) | ||
| if let workspace = await sourceKitLSPServer?.workspaceForDocument(uri: uri), | ||
|
loveucifer marked this conversation as resolved.
Outdated
|
||
| let index = await workspace.index(checkedFor: .deletedFiles), | ||
| let occurrence = index.primaryDefinitionOrDeclarationOccurrence(ofUSR: usr) | ||
| { | ||
| let definitionUri = DocumentURI(filePath: occurrence.location.path, isDirectory: false) | ||
| let definitionPosition = Position( | ||
| line: occurrence.location.line - 1, | ||
| utf16index: occurrence.location.utf8Column - 1 | ||
| ) | ||
|
Member
There was a problem hiding this comment. Interpreting UTF-8 as UTF-16 columns isn’t correct if there are eg. emojis in the line. There are functions on |
||
| return Location(uri: definitionUri, range: Range(definitionPosition)) | ||
| } | ||
|
|
||
| // Fallback: Try cursorInfo with USR (for types not in index) | ||
|
loveucifer marked this conversation as resolved.
Outdated
|
||
| if let typeInfo = try await cursorInfoFromTypeUSR(typeUsr, in: uri), | ||
| let location = typeInfo.symbolInfo.bestLocalDeclaration | ||
| { | ||
| return location | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don’t think this comment is providing any value. Let’s just remove it.