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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-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 Swift project authors
*/
import Foundation
extension UnifiedSymbolGraph {
/// A combined symbol from multiple languages' views of the same symbol.
public class Symbol {
/// The unique identifier for the symbol.
///
/// This is intended to be unique across languages, and is used to select symbol information to combine.
public var uniqueIdentifier: String
/// The selector that originated from the "main module" symbol graph, as opposed to an extension.
public var mainGraphSelectors: [Selector]
/// All the selectors that this symbol appeared in, regardless of whether it was for a
/// "main module" symbol graph or an extension.
public var allSelectors: [Selector] {
.init(modules.keys)
}
/// The module information where this symbol appears.
public var modules: [Selector: SymbolGraph.Module]
/// The kind of symbol.
public var kind: [Selector: SymbolGraph.Symbol.Kind]
/// A short convenience path that uniquely identifies a symbol when there are no ambiguities using only URL-compatible characters.
///
/// See ``SymbolGraph/Symbol/pathComponents`` for more information. This is separated per-language to allow for language-specific symbol/module/namespace names to reference the symbol.
public var pathComponents: [Selector: [String]]
/// If the static type of a symbol is known, the precise identifier of
/// the symbol that declares the type.
public var type: String?
/// The context-specific names of a symbol.
public var names: [Selector: SymbolGraph.Symbol.Names]
/// The in-source documentation comment attached to a symbol.
public var docComment: [Selector: SymbolGraph.LineList]
/// The access level of the symbol.
public var accessLevel: [Selector: SymbolGraph.Symbol.AccessControl]
/// If true, the symbol was created implicitly and not from source.
public var isVirtual: [Selector: Bool]
/// Information about a symbol that is not necessarily common to all symbols.
///
/// Like an individual symbol's mixins, the `String` key for each mixin is its ``Mixin/mixinKey``.
public var mixins: [Selector: [String: Mixin]]
/// Mixin information that has been unified across selectors.
///
/// Some mixins, for example ``SymbolGraph/Symbol/OverloadData``, can be collected together
/// for a unified view across available selectors, rather than showing individual views for
/// each selector. These mixins can be populated here when a unified symbol graph is
/// finished in the ``GraphCollector``.
///
/// Like an individual symbol's mixins, the `String` key for each mixin is its ``Mixin/mixinKey``.
public var unifiedMixins: [String: Mixin]
/// Initialize an empty symbol with the given identifier.
init(uniqueIdentifier: String) {
self.uniqueIdentifier = uniqueIdentifier
self.mainGraphSelectors = []
self.modules = [:]
self.kind = [:]
self.pathComponents = [:]
self.type = nil
self.names = [:]
self.docComment = [:]
self.accessLevel = [:]
self.isVirtual = [:]
self.mixins = [:]
self.unifiedMixins = [:]
}
/// Initialize a combined symbol view from a single symbol.
public init(fromSingleSymbol sym: SymbolGraph.Symbol, module: SymbolGraph.Module, isMainGraph: Bool) {
let lang = sym.identifier.interfaceLanguage
let selector = Selector(interfaceLanguage: lang, platform: module.platform.name)
self.uniqueIdentifier = sym.identifier.precise
self.mainGraphSelectors = []
if isMainGraph {
self.mainGraphSelectors.append(selector)
}
self.modules = [selector: module]
self.kind = [selector: sym.kind]
self.pathComponents = [selector: sym.pathComponents]
self.type = sym.type
self.names = [selector: sym.names]
self.docComment = [:]
if let docComment = sym.docComment {
self.docComment[selector] = docComment
}
self.accessLevel = [selector: sym.accessLevel]
self.isVirtual = [selector: sym.isVirtual]
self.mixins = [selector: sym.mixins]
self.unifiedMixins = [:]
}
/// Add the given symbol to this unified view.
///
/// - Warning: `symbol` must refer to the same symbol as this view (i.e. their precise identifiers must be the same).
///
/// - Parameters:
/// - symbol: The symbol to add to this view.
public func mergeSymbol(symbol: SymbolGraph.Symbol, module: SymbolGraph.Module, isMainGraph: Bool) {
precondition(self.uniqueIdentifier == symbol.identifier.precise)
let selector = Selector(
interfaceLanguage: symbol.identifier.interfaceLanguage,
platform: module.platform.name)
if isMainGraph && !self.mainGraphSelectors.contains(selector) {
self.mainGraphSelectors.append(selector)
}
// Add a new variant to the fields that track it
self.modules[selector] = module
self.kind[selector] = symbol.kind
self.pathComponents[selector] = symbol.pathComponents
self.names[selector] = symbol.names
self.docComment[selector] = symbol.docComment
self.accessLevel[selector] = symbol.accessLevel
self.isVirtual[selector] = symbol.isVirtual
self.mixins[selector] = symbol.mixins
}
}
}
|
