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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 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 Foundation
import IndexStoreDB
package import SemanticIndex
@_spi(LinkCompletion) @preconcurrency import SwiftDocC
import SymbolKit
package struct DocCSymbolInformation {
let components: [(name: String, information: LinkCompletionTools.SymbolInformation)]
/// Find the DocCSymbolLink for a given symbol USR.
///
/// - Parameters:
/// - usr: The symbol USR to find in the index.
/// - index: The CheckedIndex to search within.
package init?(fromUSR usr: String, in index: CheckedIndex) {
guard let topLevelSymbolOccurrence = index.primaryDefinitionOrDeclarationOccurrence(ofUSR: usr) else {
return nil
}
let moduleName = topLevelSymbolOccurrence.location.moduleName
var components = [topLevelSymbolOccurrence]
// Find any parent symbols
var symbolOccurrence: SymbolOccurrence = topLevelSymbolOccurrence
while let parentSymbolOccurrence = symbolOccurrence.parent(index) {
components.insert(parentSymbolOccurrence, at: 0)
symbolOccurrence = parentSymbolOccurrence
}
self.components =
[(name: moduleName, LinkCompletionTools.SymbolInformation(fromModuleName: moduleName))]
+ components.map {
(name: $0.symbol.name, information: LinkCompletionTools.SymbolInformation(fromSymbolOccurrence: $0))
}
}
package func matches(_ link: DocCSymbolLink) -> Bool {
guard link.components.count == components.count else {
return false
}
return zip(link.components, components).allSatisfy { linkComponent, symbolComponent in
linkComponent.name == symbolComponent.name && symbolComponent.information.matches(linkComponent.disambiguation)
}
}
}
fileprivate typealias KindIdentifier = SymbolGraph.Symbol.KindIdentifier
extension SymbolOccurrence {
var doccSymbolKind: String {
switch symbol.kind {
case .module:
KindIdentifier.module.identifier
case .namespace, .namespaceAlias:
KindIdentifier.namespace.identifier
case .macro:
KindIdentifier.macro.identifier
case .enum:
KindIdentifier.enum.identifier
case .struct:
KindIdentifier.struct.identifier
case .class:
KindIdentifier.class.identifier
case .protocol:
KindIdentifier.protocol.identifier
case .extension:
KindIdentifier.extension.identifier
case .union:
KindIdentifier.union.identifier
case .typealias:
KindIdentifier.typealias.identifier
case .function:
KindIdentifier.func.identifier
case .variable:
KindIdentifier.var.identifier
case .field:
KindIdentifier.property.identifier
case .enumConstant:
KindIdentifier.case.identifier
case .instanceMethod:
KindIdentifier.func.identifier
case .classMethod:
KindIdentifier.func.identifier
case .staticMethod:
KindIdentifier.func.identifier
case .instanceProperty:
KindIdentifier.property.identifier
case .classProperty, .staticProperty:
KindIdentifier.typeProperty.identifier
case .constructor:
KindIdentifier.`init`.identifier
case .destructor:
KindIdentifier.deinit.identifier
case .conversionFunction:
KindIdentifier.func.identifier
case .unknown, .using, .concept, .commentTag, .parameter:
"unknown"
}
}
}
extension LinkCompletionTools.SymbolInformation {
init(fromModuleName moduleName: String) {
self.init(
kind: KindIdentifier.module.identifier,
symbolIDHash: Self.hash(uniqueSymbolID: moduleName)
)
}
init(fromSymbolOccurrence occurrence: SymbolOccurrence) {
self.init(
kind: occurrence.doccSymbolKind,
symbolIDHash: Self.hash(uniqueSymbolID: occurrence.symbol.usr),
parameterTypes: nil,
returnTypes: nil
)
}
}
|
