Support Semantic Functionality in Macro Expansion Reference Documents & Nested Macro Expansions

Author: lokesh-tr

Package.swift

@@ -124,7 +124,10 @@ let package = Package(
         .product(name: "SwiftParser", package: "swift-syntax"),
         .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
       ],
-      exclude: ["CMakeLists.txt"]
+      exclude: ["CMakeLists.txt"],
+      swiftSettings: [
+        .enableUpcomingFeature("BareSlashRegexLiterals")
+      ]
     ),
 
     .testTarget(

Sources/Diagnose/ActiveRequestsCommand.swift

@@ -13,6 +13,7 @@
 import ArgumentParser
 import Foundation
 import RegexBuilder
+
 import class TSCBasic.Process
 
 package struct ActiveRequestsCommand: AsyncParsableCommand {

Sources/SourceKitLSP/Swift/CursorInfo.swift

@@ -147,7 +147,7 @@ extension SwiftLanguageService {
     additionalParameters appendAdditionalParameters: ((SKDRequestDictionary) -> Void)? = nil
   ) async throws -> (cursorInfo: [CursorInfo], refactorActions: [SemanticRefactorCommand]) {
     let documentManager = try self.documentManager
-    let snapshot = try documentManager.latestSnapshot(uri)
+    let snapshot = try await self.latestSnapshot(for: uri)
 
     let offsetRange = snapshot.utf8OffsetRange(of: range)
 
@@ -158,7 +158,8 @@ extension SwiftLanguageService {
       keys.cancelOnSubsequentRequest: 0,
       keys.offset: offsetRange.lowerBound,
       keys.length: offsetRange.upperBound != offsetRange.lowerBound ? offsetRange.count : nil,
-      keys.sourceFile: snapshot.uri.pseudoPath,
+      keys.sourceFile: snapshot.uri.sourcekitdSourceFile,
+      keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath,
       keys.compilerArgs: await self.buildSettings(for: uri)?.compilerArgs as [SKDRequestValue]?,
     ])
 

Sources/SourceKitLSP/Swift/DiagnosticReportManager.swift

@@ -104,7 +104,8 @@ actor DiagnosticReportManager {
 
     let skreq = sourcekitd.dictionary([
       keys.request: requests.diagnostics,
-      keys.sourceFile: snapshot.uri.pseudoPath,
+      keys.sourceFile: snapshot.uri.sourcekitdSourceFile,
+      keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath,
       keys.compilerArgs: compilerArgs as [SKDRequestValue],
     ])
 

Sources/SourceKitLSP/Swift/MacroExpansion.swift

@@ -252,10 +252,30 @@ extension SwiftLanguageService {
       let expansionURIs = try macroExpansionReferenceDocumentURLs.map {
         return DocumentURI(try $0.url)
       }
+
+      let primaryFileCursorPosition =
+        switch try? ReferenceDocumentURL(from: expandMacroCommand.textDocument.uri) {
+        case .macroExpansion(let data):
+          data.primaryFileCursorPosition
+        case nil:
+          expandMacroCommand.positionRange.lowerBound
+        }
+
+      // If there was only one expansion, show the peeked editor in the position's lower bound at which the macro
+      // expands. If there are multiple expansions available, show the peeked editor in the cursor's selected
+      // position's lower bound in the `primaryFile`.
+      let peekedEditorPosition =
+        switch macroExpansionReferenceDocumentURLs.only {
+        case .macroExpansion(let data):
+          data.macroExpansionEditRange.lowerBound
+        default:
+          primaryFileCursorPosition
+        }
+
       Task {
         let req = PeekDocumentsRequest(
-          uri: expandMacroCommand.textDocument.uri,
-          position: expandMacroCommand.positionRange.lowerBound,
+          uri: expandMacroCommand.textDocument.uri.primaryFile ?? expandMacroCommand.textDocument.uri,
+          position: peekedEditorPosition,
           locations: expansionURIs
         )
 

Sources/SourceKitLSP/Swift/MacroExpansionReferenceDocumentURLData.swift

@@ -15,15 +15,15 @@ import LanguageServerProtocol
 import RegexBuilder
 
 /// Represents url of macro expansion reference document as follows:
-/// `sourcekit-lsp://swift-macro-expansion/LaCb-LcCd.swift?parent=&fromLine=&fromColumn=&toLine=&toColumn=&bufferName=`
+/// `sourcekit-lsp://swift-macro-expansion/LaCb-LcCd.swift?fromLine=&fromColumn=&toLine=&toColumn=&bufferName=&parent=`
 ///
 /// Here,
 ///  - `LaCb-LcCd.swift`, the `displayName`, represents where the macro will expand to or
 ///    replace in the source file (i.e. `macroExpansionEditRange`)
-///  - `parent` denoting the URI of the document from which the macro was expanded. For a first-level macro expansion,
-///    this is a file URI. For nested macro expansions, this is a `sourcekit-lsp://swift-macro-expansion` URL.
 ///  - `fromLine`, `fromColumn`, `toLine`, `toColumn` represents the cursor's `selectionRange`
 ///  - `bufferName` denotes the buffer name of the specific macro expansion edit
+///  - `parent` denoting the URI of the document from which the macro was expanded. For a first-level macro expansion,
+///    this is a file URI. For nested macro expansions, this is a `sourcekit-lsp://swift-macro-expansion` URL.
 package struct MacroExpansionReferenceDocumentURLData {
   package static let documentType = "swift-macro-expansion"
 
@@ -47,7 +47,7 @@ package struct MacroExpansionReferenceDocumentURLData {
   ///
   /// Generated content of reference document url:
   /// URL:
-  /// `sourcekit-lsp://swift-macro-expansion/L3C7-L3C23.swift?primaryFilePath=/path/to/swift_file.swift&fromLine=3&fromColumn=8&toLine=3&toColumn=8&bufferName=@__swift_macro_..._Stringify_.swift`
+  /// `sourcekit-lsp://swift-macro-expansion/L3C7-L3C23.swift?fromLine=3&fromColumn=8&toLine=3&toColumn=8&bufferName=@__swift_macro_..._Stringify_.swift&parent=/path/to/swift_file.swift`
   /// ```swift
   /// (a + b, "a + b")
   /// ```
@@ -78,13 +78,17 @@ package struct MacroExpansionReferenceDocumentURLData {
   }
 
   package var queryItems: [URLQueryItem] {
-    return [
-      URLQueryItem(name: Parameters.parent, value: parent.stringValue),
+    [
       URLQueryItem(name: Parameters.fromLine, value: String(selectionRange.lowerBound.line)),
       URLQueryItem(name: Parameters.fromColumn, value: String(selectionRange.lowerBound.utf16index)),
       URLQueryItem(name: Parameters.toLine, value: String(selectionRange.upperBound.line)),
       URLQueryItem(name: Parameters.toColumn, value: String(selectionRange.upperBound.utf16index)),
       URLQueryItem(name: Parameters.bufferName, value: bufferName),
+
+      // *Note*: Having `parent` as the last parameter will ensure that the url's parameters aren't mistaken to be its
+      // `parent`'s parameters in certain environments where percent encoding gets removed or added
+      // unnecessarily (for example: VS Code)
+      URLQueryItem(name: Parameters.parent, value: parent.stringValue),
     ]
   }
 
@@ -121,7 +125,7 @@ package struct MacroExpansionReferenceDocumentURLData {
   ///
   /// Generated content of reference document url:
   /// URL:
-  /// `sourcekit-lsp://swift-macro-expansion/L3C7-L3C23.swift?primaryFilePath=/path/to/swift_file.swift&fromLine=3&fromColumn=8&toLine=3&toColumn=8&bufferName=@__swift_macro_..._Stringify_.swift`
+  /// `sourcekit-lsp://swift-macro-expansion/L3C7-L3C23.swift?fromLine=3&fromColumn=8&toLine=3&toColumn=8&bufferName=@__swift_macro_..._Stringify_.swift&parent=/path/to/swift_file.swift`
   /// ```swift
   /// (a + b, "a + b")
   /// ```
@@ -140,6 +144,16 @@ package struct MacroExpansionReferenceDocumentURLData {
     }
   }
 
+  /// The cursor position's lower bound in the `primaryFile`
+  package var primaryFileCursorPosition: Position {
+    switch try? ReferenceDocumentURL(from: parent) {
+    case .macroExpansion(let data):
+      return data.primaryFileCursorPosition
+    case nil:
+      return self.selectionRange.lowerBound
+    }
+  }
+
   private struct Parameters {
     static let parent = "parent"
     static let fromLine = "fromLine"

Sources/SourceKitLSP/Swift/OpenInterface.swift

@@ -37,7 +37,7 @@ extension SwiftLanguageService {
     let interfaceFilePath = self.generatedInterfacesPath.appendingPathComponent("\(name).swiftinterface")
     let interfaceDocURI = DocumentURI(interfaceFilePath)
     // has interface already been generated
-    if let snapshot = try? self.documentManager.latestSnapshot(interfaceDocURI) {
+    if let snapshot = try? await self.latestSnapshot(for: interfaceDocURI) {
       return await self.generatedInterfaceDetails(
         uri: interfaceDocURI,
         snapshot: snapshot,
@@ -111,7 +111,8 @@ extension SwiftLanguageService {
       let keys = self.keys
       let skreq = sourcekitd.dictionary([
         keys.request: requests.editorFindUSR,
-        keys.sourceFile: uri.pseudoPath,
+        keys.sourceFile: uri.sourcekitdSourceFile,
+        keys.primaryFile: uri.primaryFile?.pseudoPath,
         keys.usr: symbol,
       ])
 

Sources/SourceKitLSP/Swift/RelatedIdentifiers.swift

@@ -69,7 +69,8 @@ extension SwiftLanguageService {
       keys.request: requests.relatedIdents,
       keys.cancelOnSubsequentRequest: 0,
       keys.offset: snapshot.utf8Offset(of: position),
-      keys.sourceFile: snapshot.uri.pseudoPath,
+      keys.sourceFile: snapshot.uri.sourcekitdSourceFile,
+      keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath,
       keys.includeNonEditableBaseNames: includeNonEditableBaseNames ? 1 : 0,
       keys.compilerArgs: await self.buildSettings(for: snapshot.uri)?.compilerArgs as [SKDRequestValue]?,
     ])

Sources/SourceKitLSP/Swift/SemanticTokens.swift

@@ -26,7 +26,8 @@ extension SwiftLanguageService {
 
     let skreq = sourcekitd.dictionary([
       keys.request: requests.semanticTokens,
-      keys.sourceFile: snapshot.uri.pseudoPath,
+      keys.sourceFile: snapshot.uri.sourcekitdSourceFile,
+      keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath,
       keys.compilerArgs: buildSettings.compilerArgs as [SKDRequestValue],
     ])
 
@@ -84,7 +85,7 @@ extension SwiftLanguageService {
   package func documentSemanticTokens(
     _ req: DocumentSemanticTokensRequest
   ) async throws -> DocumentSemanticTokensResponse? {
-    let snapshot = try self.documentManager.latestSnapshot(req.textDocument.uri)
+    let snapshot = try await self.latestSnapshot(for: req.textDocument.uri)
 
     let tokens = try await mergedAndSortedTokens(for: snapshot)
     let encodedTokens = tokens.lspEncoded

Sources/SourceKitLSP/Swift/SwiftLanguageService.swift

@@ -538,7 +538,7 @@ extension SwiftLanguageService {
         return
       }
       do {
-        let snapshot = try await documentManager.latestSnapshot(document)
+        let snapshot = try await self.latestSnapshot(for: document)
         let buildSettings = await self.buildSettings(for: document)
         let diagnosticReport = try await self.diagnosticReportManager.diagnosticReport(
           for: snapshot,
@@ -775,7 +775,7 @@ extension SwiftLanguageService {
   }
 
   package func documentSymbolHighlight(_ req: DocumentHighlightRequest) async throws -> [DocumentHighlight]? {
-    let snapshot = try self.documentManager.latestSnapshot(req.textDocument.uri)
+    let snapshot = try await self.latestSnapshot(for: req.textDocument.uri)
 
     let relatedIdentifiers = try await self.relatedIdentifiers(
       at: req.position,
@@ -879,7 +879,7 @@ extension SwiftLanguageService {
   }
 
   func retrieveQuickFixCodeActions(_ params: CodeActionRequest) async throws -> [CodeAction] {
-    let snapshot = try documentManager.latestSnapshot(params.textDocument.uri)
+    let snapshot = try await self.latestSnapshot(for: params.textDocument.uri)
     let buildSettings = await self.buildSettings(for: params.textDocument.uri)
     let diagnosticReport = try await self.diagnosticReportManager.diagnosticReport(
       for: snapshot,
@@ -972,7 +972,7 @@ extension SwiftLanguageService {
       await semanticIndexManager?.prepareFileForEditorFunctionality(
         req.textDocument.uri.primaryFile ?? req.textDocument.uri
       )
-      let snapshot = try documentManager.latestSnapshot(req.textDocument.uri)
+      let snapshot = try await self.latestSnapshot(for: req.textDocument.uri)
       let buildSettings = await self.buildSettings(for: req.textDocument.uri)
       let diagnosticReport = try await self.diagnosticReportManager.diagnosticReport(
         for: snapshot,

Sources/SourceKitLSP/Swift/VariableTypeInfo.swift

@@ -83,11 +83,12 @@ extension SwiftLanguageService {
     _ uri: DocumentURI,
     _ range: Range<Position>? = nil
   ) async throws -> [VariableTypeInfo] {
-    let snapshot = try documentManager.latestSnapshot(uri)
+    let snapshot = try await self.latestSnapshot(for: uri)
 
     let skreq = sourcekitd.dictionary([
       keys.request: requests.collectVariableType,
-      keys.sourceFile: snapshot.uri.pseudoPath,
+      keys.sourceFile: snapshot.uri.sourcekitdSourceFile,
+      keys.primaryFile: snapshot.uri.primaryFile?.pseudoPath,
       keys.compilerArgs: await self.buildSettings(for: uri)?.compilerArgs as [SKDRequestValue]?,
     ])