Show container name in call hierarchy item name instead of detail field

The container name isn’t displayed very prominently and it’s easy to miss. I think the call hierarchy looks nicer when we prepend the container name with language-specific logic.

rdar://128396648

Author: ahoppen

Sources/SourceKitLSP/SourceKitLSPServer.swift

@@ -1851,11 +1851,28 @@ extension SourceKitLSPServer {
     containerName: String?,
     location: Location
   ) -> CallHierarchyItem {
-    CallHierarchyItem(
-      name: symbol.name,
+    let name: String
+    if let containerName {
+      switch symbol.language {
+      case .objc where symbol.kind == .instanceMethod || symbol.kind == .instanceProperty:
+        name = "-[\(containerName) \(symbol.name)]"
+      case .objc where symbol.kind == .classMethod || symbol.kind == .classProperty:
+        name = "+[\(containerName) \(symbol.name)]"
+      case .cxx, .c, .objc:
+        // C shouldn't have container names for call hierarchy and Objective-C should be covered above.
+        // Fall back to using the C++ notation using `::`.
+        name = "\(containerName)::\(symbol.name)"
+      case .swift:
+        name = "\(containerName).\(symbol.name)"
+      }
+    } else {
+      name = symbol.name
+    }
+    return CallHierarchyItem(
+      name: name,
       kind: symbol.kind.asLspSymbolKind(),
       tags: nil,
-      detail: containerName,
+      detail: nil,
       uri: location.uri,
       range: location.range,
       selectionRange: location.range,
@@ -2289,8 +2306,15 @@ extension IndexSymbolKind {
       return .struct
     case .parameter:
       return .typeParameter
-
-    default:
+    case .module, .namespace:
+      return .namespace
+    case .field:
+      return .property
+    case .constructor:
+      return .constructor
+    case .destructor:
+      return .null
+    case .commentTag, .concept, .extension, .macro, .namespaceAlias, .typealias, .union, .unknown, .using:
       return .null
     }
   }

Tests/SourceKitLSPTests/CallHierarchyTests.swift

@@ -212,10 +212,9 @@ final class CallHierarchyTests: XCTestCase {
       result,
       [
         CallHierarchyItem(
-          name: "foo",
+          name: "FilePathIndex::foo",
           kind: .method,
           tags: nil,
-          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")),
@@ -583,10 +582,9 @@ final class CallHierarchyTests: XCTestCase {
       [
         CallHierarchyIncomingCall(
           from: CallHierarchyItem(
-            name: "foo()",
+            name: "MyClass.foo()",
             kind: .method,
             tags: nil,
-            detail: "MyClass",
             uri: project.fileURI,
             range: Range(project.positions["1️⃣"]),
             selectionRange: Range(project.positions["1️⃣"]),
@@ -764,4 +762,92 @@ final class CallHierarchyTests: XCTestCase {
       ]
     )
   }
+
+  func testInitializerInCallHierarchy() async throws {
+    try await SkipUnless.indexOnlyHasContainedByRelationsToIndexedDecls()
+    let project = try await IndexedSingleSwiftFileTestProject(
+      """
+      func 1️⃣foo() {}
+
+      struct Bar {
+        2️⃣init() {
+          3️⃣foo()
+        }
+      }
+      """
+    )
+    let prepare = try await project.testClient.send(
+      CallHierarchyPrepareRequest(
+        textDocument: TextDocumentIdentifier(project.fileURI),
+        position: project.positions["1️⃣"]
+      )
+    )
+    let initialItem = try XCTUnwrap(prepare?.only)
+    let calls = try await project.testClient.send(CallHierarchyIncomingCallsRequest(item: initialItem))
+    XCTAssertEqual(
+      calls,
+      [
+        CallHierarchyIncomingCall(
+          from: CallHierarchyItem(
+            name: "Bar.init()",
+            kind: .constructor,
+            tags: nil,
+            uri: project.fileURI,
+            range: Range(project.positions["2️⃣"]),
+            selectionRange: Range(project.positions["2️⃣"]),
+            data: .dictionary([
+              "usr": .string("s:4test3BarVACycfc"),
+              "uri": .string(project.fileURI.stringValue),
+            ])
+          ),
+          fromRanges: [Range(project.positions["3️⃣"])]
+        )
+      ]
+    )
+  }
+
+  func testCallHierarchyOfNestedClass() async throws {
+    try await SkipUnless.indexOnlyHasContainedByRelationsToIndexedDecls()
+    let project = try await IndexedSingleSwiftFileTestProject(
+      """
+      func 1️⃣foo() {}
+
+      struct Outer {
+        struct Bar {
+          2️⃣init() {
+            3️⃣foo()
+          }
+        }
+      }
+      """
+    )
+    let prepare = try await project.testClient.send(
+      CallHierarchyPrepareRequest(
+        textDocument: TextDocumentIdentifier(project.fileURI),
+        position: project.positions["1️⃣"]
+      )
+    )
+    let initialItem = try XCTUnwrap(prepare?.only)
+    let calls = try await project.testClient.send(CallHierarchyIncomingCallsRequest(item: initialItem))
+    XCTAssertEqual(
+      calls,
+      [
+        CallHierarchyIncomingCall(
+          from: CallHierarchyItem(
+            name: "Bar.init()",
+            kind: .constructor,
+            tags: nil,
+            uri: project.fileURI,
+            range: Range(project.positions["2️⃣"]),
+            selectionRange: Range(project.positions["2️⃣"]),
+            data: .dictionary([
+              "usr": .string("s:4test5OuterV3BarVAEycfc"),
+              "uri": .string(project.fileURI.stringValue),
+            ])
+          ),
+          fromRanges: [Range(project.positions["3️⃣"])]
+        )
+      ]
+    )
+  }
 }