Skip to content

Fix module definition jumping in Swift interface files #2233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
+86 −10
Open

Fix module definition jumping in Swift interface files #2233

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
4058ac6
fixed group of module can't navi, no langserver for swiftinterface
Aug 11, 2025
dd7de19
fixed second swiftinterface page won't response
Aug 11, 2025
62334c0
revert cache strategy
Aug 12, 2025
d0e544e
clean old implementation
Aug 12, 2025
f509987
drop unnecessary change of sourcekitdDocumentName
Aug 12, 2025
e147601
drop unnecessary change of cachedIndex
Aug 12, 2025
67e5f17
revert changes
Aug 12, 2025
82cc691
find buildSettingsFile, primaryFile for RefenceDocumentURL
Aug 12, 2025
d143d8d
clean Language+Inference.swift
Aug 12, 2025
8dfcbfa
buildSettingFrom can be only file://
Aug 12, 2025
c9a943e
add unit test for supporting swiftinterface
Aug 12, 2025
b372182
revert unnecessary changes
Aug 13, 2025
05d8d02
fixed various test issues, format
Aug 13, 2025
6f4ee70
revert changes
Aug 13, 2025
36a5f83
fixed tests and format
Aug 13, 2025
00cfa79
fixed unit test
Aug 14, 2025
6f214ea
fix: prevent duplicating interface
Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Sources/SourceKitLSP/SourceKitLSPServer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2086,10 +2086,10 @@ extension SourceKitLSPServer {
return Location(uri: originatorUri, range: Range(Position(line: 0, utf16index: 0)))
}
}

// If the originator URI is already a generated interface, use its primary file for build settings
let documentForBuildSettings = originatorUri.primaryFile ?? originatorUri
let documentForBuildSettings = originatorUri.buildSettingsFile

guard
let interfaceDetails = try await languageService.openGeneratedInterface(
document: documentForBuildSettings,
Expand Down
9 changes: 8 additions & 1 deletion Sources/SourceKitLSP/Swift/GeneratedInterfaceDocumentURLData.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,14 @@ package struct GeneratedInterfaceDocumentURLData: Hashable, ReferenceURLData {
self.moduleName = moduleName
self.groupName = groupName
self.sourcekitdDocumentName = sourcekitdDocumentName
self.buildSettingsFrom = primaryFile
if let referenceDocumentURL = try? ReferenceDocumentURL(from: primaryFile),
let fileURL = referenceDocumentURL.buildSettingsFile.fileURL {
self.buildSettingsFrom = DocumentURI(fileURL)
} else if let fileURL = primaryFile.fileURL {
self.buildSettingsFrom = DocumentURI(fileURL)
} else {
self.buildSettingsFrom = primaryFile
}
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ahoppen

make sure buildSettingsFrom can be only an actual file otherwise

it could be
sourcekit-lsp://xxx?buildSettingsFrom=A
A=sourcekit-lsp://xxx?buildSettingsFrom=B

NOTE: this happens if we enable navigation inside swiftinterface in this PR

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have an accessor on DocumentURI that should do exactly the same, so you should be able to simplify this to

Suggested change
self.buildSettingsFrom = primaryFile
if let referenceDocumentURL = try? ReferenceDocumentURL(from: primaryFile),
let fileURL = referenceDocumentURL.buildSettingsFile.fileURL {
self.buildSettingsFrom = DocumentURI(fileURL)
} else if let fileURL = primaryFile.fileURL {
self.buildSettingsFrom = DocumentURI(fileURL)
} else {
self.buildSettingsFrom = primaryFile
}
self.buildSettingsFrom = primaryFile.buildSettingsFile

}

init(queryItems: [URLQueryItem]) throws {
Expand Down
13 changes: 8 additions & 5 deletions Sources/SourceKitLSP/Swift/ReferenceDocumentURL.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,9 @@ package enum ReferenceDocumentURL {
switch self {
case .macroExpansion(let data): return data.primaryFile
case .generatedInterface(let data):
if let referenceDocumentURL = try? ReferenceDocumentURL(from: data.buildSettingsFrom) {
return referenceDocumentURL.buildSettingsFile
if let referenceDocumentURL = try? ReferenceDocumentURL(from: data.buildSettingsFrom),
let fileURL = referenceDocumentURL.buildSettingsFile.fileURL {
return DocumentURI(fileURL)
}
return data.buildSettingsFrom
}
Expand All @@ -134,10 +135,12 @@ package enum ReferenceDocumentURL {
switch self {
case .macroExpansion(let data): return data.primaryFile
case .generatedInterface(let data):
if let referenceDocumentURL = try? ReferenceDocumentURL(from: data.buildSettingsFrom) {
return referenceDocumentURL.primaryFile
if let referenceDocumentURL = try? ReferenceDocumentURL(from: data.buildSettingsFrom),
let primaryFile = referenceDocumentURL.primaryFile,
let fileURL = primaryFile.fileURL {
return DocumentURI(fileURL)
}
return data.buildSettingsFrom.primaryFile
return data.buildSettingsFrom.primaryFile
}
}
}
Expand Down