File: RelatedIdentifiers.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (100 lines) | stat: -rw-r--r-- 3,410 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 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 LSPLogging
import LanguageServerProtocol
import SourceKitD

struct RelatedIdentifier {
  let range: Range<Position>
  let usage: RenameLocation.Usage
}

extension RenameLocation.Usage {
  fileprivate init?(_ uid: sourcekitd_api_uid_t?, _ values: sourcekitd_api_values) {
    switch uid {
    case values.definition:
      self = .definition
    case values.reference:
      self = .reference
    case values.call:
      self = .call
    case values.unknown:
      self = .unknown
    default:
      return nil
    }
  }

  func uid(values: sourcekitd_api_values) -> sourcekitd_api_uid_t {
    switch self {
    case .definition:
      return values.definition
    case .reference:
      return values.reference
    case .call:
      return values.call
    case .unknown:
      return values.unknown
    }
  }
}

struct RelatedIdentifiersResponse {
  let relatedIdentifiers: [RelatedIdentifier]
  /// The compound decl name at the requested location. This can be used as `name` parameter to a
  /// `find-syntactic-rename-ranges` request.
  ///
  /// `nil` if `sourcekitd` is too old and doesn't return the `name` as part of the related identifiers request or
  /// `relatedIdentifiers` is empty (eg. when performing a related identifiers request on `self`).
  let name: String?
}

extension SwiftLanguageService {
  func relatedIdentifiers(
    at position: Position,
    in snapshot: DocumentSnapshot,
    includeNonEditableBaseNames: Bool
  ) async throws -> RelatedIdentifiersResponse {
    let skreq = sourcekitd.dictionary([
      keys.request: requests.relatedIdents,
      keys.cancelOnSubsequentRequest: 0,
      keys.offset: snapshot.utf8Offset(of: position),
      keys.sourceFile: snapshot.uri.pseudoPath,
      keys.includeNonEditableBaseNames: includeNonEditableBaseNames ? 1 : 0,
      keys.compilerArgs: await self.buildSettings(for: snapshot.uri)?.compilerArgs as [SKDRequestValue]?,
    ])

    let dict = try await sendSourcekitdRequest(skreq, fileContents: snapshot.text)

    guard let results: SKDResponseArray = dict[self.keys.results] else {
      throw ResponseError.internalError("sourcekitd response did not contain results")
    }
    let name: String? = dict[self.keys.name]

    try Task.checkCancellation()

    var relatedIdentifiers: [RelatedIdentifier] = []

    results.forEach { _, value in
      guard let offset: Int = value[keys.offset], let length: Int = value[keys.length] else {
        return true  // continue
      }
      let start = snapshot.positionOf(utf8Offset: offset)
      let end = snapshot.positionOf(utf8Offset: offset + length)
      let usage = RenameLocation.Usage(value[keys.nameType], values) ?? .unknown
      relatedIdentifiers.append(RelatedIdentifier(range: start..<end, usage: usage))
      return true  // continue
    }
    return RelatedIdentifiersResponse(relatedIdentifiers: relatedIdentifiers, name: name)
  }
}