Show container name as the detail of a call hierarchy item

The container name, showing the class a method is defined on, is more useful than the module name.

Author: ahoppen

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -2039,14 +2039,14 @@ extension SourceKitLSPServer {
 
   private func indexToLSPCallHierarchyItem(
     symbol: Symbol,
-    moduleName: String?,
+    containerName: String?,
     location: Location
   ) -> CallHierarchyItem {
     CallHierarchyItem(
       name: symbol.name,
       kind: symbol.kind.asLspSymbolKind(),
       tags: nil,
-      detail: moduleName,
+      detail: containerName,
       uri: location.uri,
       range: location.range,
       selectionRange: location.range,
@@ -2077,7 +2077,7 @@ extension SourceKitLSPServer {
 
     // Only return a single call hierarchy item. Returning multiple doesn't make sense because they will all have the
     // same USR (because we query them by USR) and will thus expand to the exact same call hierarchy.
-    var callHierarchyItems = usrs.compactMap { (usr) -> CallHierarchyItem? in
+    let callHierarchyItems = usrs.compactMap { (usr) -> CallHierarchyItem? in
       guard let definition = index.primaryDefinitionOrDeclarationOccurrence(ofUSR: usr) else {
         return nil
       }
@@ -2086,7 +2086,7 @@ extension SourceKitLSPServer {
       }
       return self.indexToLSPCallHierarchyItem(
         symbol: definition.symbol,
-        moduleName: definition.location.moduleName,
+        containerName: definition.containerName,
         location: location
       )
     }.sorted(by: { Location(uri: $0.uri, range: $0.range) < Location(uri: $1.uri, range: $1.range) })
@@ -2143,7 +2143,7 @@ extension SourceKitLSPServer {
           return CallHierarchyIncomingCall(
             from: indexToLSPCallHierarchyItem(
               symbol: related.symbol,
-              moduleName: definitionSymbolLocation?.moduleName,
+              containerName: definition?.containerName,
               location: definitionLocation ?? location  // Use occurrence location as fallback
             ),
             fromRanges: [location.range]
@@ -2174,7 +2174,7 @@ extension SourceKitLSPServer {
       return CallHierarchyOutgoingCall(
         to: indexToLSPCallHierarchyItem(
           symbol: occurrence.symbol,
-          moduleName: definitionSymbolLocation?.moduleName,
+          containerName: definition?.containerName,
           location: definitionLocation ?? location  // Use occurrence location as fallback
         ),
         fromRanges: [location.range]
@@ -2472,14 +2472,28 @@ extension IndexSymbolKind {
   }
 }
 
+fileprivate extension IndexSymbolKind {
+  /// Whether this symbol should be considered as a container in `SymbolOccurrence.containerName`
+  var isContainer: Bool {
+    switch self {
+    case .module, .namespace, .enum, .struct, .class, .protocol, .extension:
+      return true
+    case .unknown, .namespaceAlias, .macro, .union, .typealias, .function, .variable, .field, .enumConstant,
+      .instanceMethod, .classMethod, .staticMethod, .instanceProperty, .classProperty, .staticProperty, .constructor,
+      .destructor, .conversionFunction, .parameter, .using, .concept, .commentTag:
+      return false
+    }
+  }
+}
+
 extension SymbolOccurrence {
   /// Get the name of the symbol that is a parent of this symbol, if one exists
-  func getContainerName() -> String? {
+  var containerName: String? {
     let containers = relations.filter { $0.roles.contains(.childOf) }
     if containers.count > 1 {
       logger.fault("Expected an occurrence to a child of at most one symbol, not multiple")
     }
-    return containers.sorted().first?.symbol.name
+    return containers.filter(\.symbol.kind.isContainer).sorted().first?.symbol.name
   }
 }
 
@@ -2547,7 +2561,7 @@ extension WorkspaceSymbolItem {
         kind: symbolOccurrence.symbol.kind.asLspSymbolKind(),
         deprecated: nil,
         location: symbolLocation,
-        containerName: symbolOccurrence.getContainerName()
+        containerName: symbolOccurrence.containerName
       )
     )
   }

Tests/SourceKitLSPTests/CallHierarchyTests.swift

@@ -90,7 +90,7 @@ final class CallHierarchyTests: XCTestCase {
     func item(
       _ name: String,
       _ kind: SymbolKind,
-      detail: String = "test",
+      detail: String? = nil,
       usr: String,
       at position: Position
     ) -> CallHierarchyItem {
@@ -215,7 +215,7 @@ final class CallHierarchyTests: XCTestCase {
           name: "foo",
           kind: .method,
           tags: nil,
-          detail: "",
+          detail: "FilePathIndex",
           uri: try project.uri(for: "lib.cpp"),
           range: try Range(project.position(of: "2️⃣", in: "lib.cpp")),
           selectionRange: try Range(project.position(of: "2️⃣", in: "lib.cpp")),
@@ -255,7 +255,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "testFunc(x:)",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["2️⃣"]),
             selectionRange: Range(project.positions["2️⃣"]),
@@ -297,7 +297,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "getter:testVar",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["2️⃣"]),
             selectionRange: Range(project.positions["2️⃣"]),
@@ -339,7 +339,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "testFunc()",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["2️⃣"]),
             selectionRange: Range(project.positions["2️⃣"]),
@@ -355,7 +355,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "testFunc()",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["2️⃣"]),
             selectionRange: Range(project.positions["2️⃣"]),
@@ -396,7 +396,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "getter:foo",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["1️⃣"]),
             selectionRange: Range(project.positions["1️⃣"]),
@@ -436,7 +436,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "testFunc()",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["1️⃣"]),
             selectionRange: Range(project.positions["1️⃣"]),
@@ -485,7 +485,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "test(proto:)",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["2️⃣"]),
             selectionRange: Range(project.positions["2️⃣"]),
@@ -534,7 +534,7 @@ final class CallHierarchyTests: XCTestCase {
             name: "test(base:)",
             kind: .function,
             tags: nil,
-            detail: "test",  // test is the module name because the file is called test.swift
+            detail: nil,
             uri: project.fileURI,
             range: Range(project.positions["2️⃣"]),
             selectionRange: Range(project.positions["2️⃣"]),
@@ -548,4 +548,47 @@ final class CallHierarchyTests: XCTestCase {
       ]
     )
   }
+
+  func testCallHierarchyContainsContainerNameAsDetail() async throws {
+    let project = try await IndexedSingleSwiftFileTestProject(
+      """
+      class MyClass {
+        func 1️⃣foo() {
+          2️⃣bar()
+        }
+      }
+      func 3️⃣bar() {
+      }
+      """
+    )
+    let prepare = try await project.testClient.send(
+      CallHierarchyPrepareRequest(
+        textDocument: TextDocumentIdentifier(project.fileURI),
+        position: project.positions["3️⃣"]
+      )
+    )
+    let initialItem = try XCTUnwrap(prepare?.only)
+    let calls = try await project.testClient.send(CallHierarchyIncomingCallsRequest(item: initialItem))
+    XCTAssertEqual(
+      calls,
+      [
+        CallHierarchyIncomingCall(
+          from: CallHierarchyItem(
+            name: "foo()",
+            kind: .method,
+            tags: nil,
+            detail: "MyClass",
+            uri: project.fileURI,
+            range: Range(project.positions["1️⃣"]),
+            selectionRange: Range(project.positions["1️⃣"]),
+            data: .dictionary([
+              "usr": .string("s:4test7MyClassC3fooyyF"),
+              "uri": .string(project.fileURI.stringValue),
+            ])
+          ),
+          fromRanges: [Range(project.positions["2️⃣"])]
+        )
+      ]
+    )
+  }
 }