|
| 1 | +/* |
| 2 | + This source file is part of the Swift.org open source project |
| 3 | + |
| 4 | + Copyright (c) 2024-2025 Apple Inc. and the Swift project authors |
| 5 | + Licensed under Apache License v2.0 with Runtime Library Exception |
| 6 | + |
| 7 | + See https://swift.org/LICENSE.txt for license information |
| 8 | + See https://swift.org/CONTRIBUTORS.txt for Swift project authors |
| 9 | +*/ |
| 10 | + |
| 11 | +import Foundation |
| 12 | + |
| 13 | +/// A collection of API for link completion. |
| 14 | +/// |
| 15 | +/// An example link completion workflow could look something like this; |
| 16 | +/// Assume that there's already an partial link in progress: `First/Second-enum/` |
| 17 | +/// |
| 18 | +/// - First, parse the link into link components using ``parse(linkString:)``. |
| 19 | +/// - Second, narrow down the possible symbols to suggest as completion using ``SymbolInformation/matches(_:)`` |
| 20 | +/// - Third, determine the minimal unique disambiguation for each completion suggestion using ``suggestedDisambiguation(forCollidingSymbols:)`` |
| 21 | +/// |
| 22 | +/// > Tip: You can use ``SymbolInformation/hash(uniqueSymbolID:)`` to compute the hashed symbol identifiers needed for steps 2 and 3 above. |
| 23 | +@_spi(LinkCompletion) // LinkCompletionTools isn't stable API yet |
| 24 | +public enum LinkCompletionTools { |
| 25 | + |
| 26 | + // MARK: Parsing |
| 27 | + |
| 28 | + /// Parses link string into link components; each consisting of a base name and a disambiguation suffix. |
| 29 | + /// |
| 30 | + /// - Parameter linkString: The link string to parse. |
| 31 | + /// - Returns: A list of link components, each consisting of a base name and a disambiguation suffix. |
| 32 | + public static func parse(linkString: String) -> [(name: String, disambiguation: ParsedDisambiguation)] { |
| 33 | + PathHierarchy.PathParser.parse(path: linkString).components.map { pathComponent in |
| 34 | + (name: String(pathComponent.name), disambiguation: ParsedDisambiguation(pathComponent.disambiguation) ) |
| 35 | + } |
| 36 | + } |
| 37 | + |
| 38 | + /// A disambiguation suffix for a parsed link component. |
| 39 | + public enum ParsedDisambiguation: Equatable { |
| 40 | + /// This link component isn't disambiguated. |
| 41 | + case none |
| 42 | + |
| 43 | + /// This path component uses a combination of kind and hash disambiguation. |
| 44 | + /// |
| 45 | + /// At least one of `kind` and `hash` will be non-`nil`. |
| 46 | + /// It's never _necessary_ to specify both a `kind` and a `hash` to disambiguate a link component, but it's supported for the developer to include both. |
| 47 | + case kindAndOrHash(kind: String?, hash: String?) |
| 48 | + |
| 49 | + /// This path component uses type signature information for disambiguation. |
| 50 | + /// |
| 51 | + /// At least one of `parameterTypes` and `returnTypes` will be non-`nil`. |
| 52 | + case typeSignature(parameterTypes: [String]?, returnTypes: [String]?) |
| 53 | + |
| 54 | + // This empty-marker case is here because non-frozen enums are only available when Library Evolution is enabled, |
| 55 | + // which is not available to Swift Packages without unsafe flags (rdar://78773361). |
| 56 | + // This can be removed once that is available and applied to Swift-DocC (rdar://89033233). |
| 57 | + @available(*, deprecated, message: "this enum is non-frozen and may be expanded in the future; add a `default` case instead of matching this one") |
| 58 | + case _nonFrozenEnum_useDefaultCase |
| 59 | + |
| 60 | + init(_ disambiguation: PathHierarchy.PathComponent.Disambiguation?) { |
| 61 | + // This initializer is intended to be internal-only. |
| 62 | + switch disambiguation { |
| 63 | + case .kindAndHash(let kind, let hash): |
| 64 | + self = .kindAndOrHash( |
| 65 | + kind: kind.map { String($0) }, |
| 66 | + hash: hash.map { String($0) } |
| 67 | + ) |
| 68 | + case .typeSignature(let parameterTypes, let returnTypes): |
| 69 | + self = .typeSignature( |
| 70 | + parameterTypes: parameterTypes?.map { String($0) }, |
| 71 | + returnTypes: returnTypes?.map { String($0) } |
| 72 | + ) |
| 73 | + case nil: |
| 74 | + self = .none |
| 75 | + } |
| 76 | + } |
| 77 | + |
| 78 | + /// A string representation of the disambiguation. |
| 79 | + public var suffix: String { |
| 80 | + typealias Disambiguation = PathHierarchy.DisambiguationContainer.Disambiguation |
| 81 | + |
| 82 | + switch self { |
| 83 | + case .kindAndOrHash(let kind?, nil): |
| 84 | + return Disambiguation.kind(kind).makeSuffix() |
| 85 | + case .kindAndOrHash(nil, let hash?): |
| 86 | + return Disambiguation.hash(hash).makeSuffix() |
| 87 | + case .kindAndOrHash(let kind?, let hash?): // This is never necessary but a developer could redundantly write it in a parsed link |
| 88 | + return Disambiguation.kind(kind).makeSuffix() + Disambiguation.hash(hash).makeSuffix() |
| 89 | + |
| 90 | + case .typeSignature(let parameterTypes?, nil): |
| 91 | + return Disambiguation.parameterTypes(parameterTypes).makeSuffix() |
| 92 | + case .typeSignature(nil, let returnTypes?): |
| 93 | + return Disambiguation.returnTypes(returnTypes).makeSuffix() |
| 94 | + case .typeSignature(let parameterTypes?, let returnTypes?): |
| 95 | + return Disambiguation.mixedTypes(parameterTypes: parameterTypes, returnTypes: returnTypes).makeSuffix() |
| 96 | + |
| 97 | + // Unexpected error cases |
| 98 | + case .kindAndOrHash(kind: nil, hash: nil): |
| 99 | + assertionFailure("Parsed `.kindAndOrHash` disambiguation missing both kind and hash should use `.none` instead. This is a logic bug.") |
| 100 | + return Disambiguation.none.makeSuffix() |
| 101 | + case .typeSignature(parameterTypes: nil, returnTypes: nil): |
| 102 | + assertionFailure("Parsed `.typeSignature` disambiguation missing both parameter types and return types should use `.none` instead. This is a logic bug.") |
| 103 | + return Disambiguation.none.makeSuffix() |
| 104 | + |
| 105 | + // Since this is within DocC we want to have an error if we don't handle new future cases. |
| 106 | + case .none, ._nonFrozenEnum_useDefaultCase: |
| 107 | + return Disambiguation.none.makeSuffix() |
| 108 | + } |
| 109 | + } |
| 110 | + } |
| 111 | + |
| 112 | + /// Suggests the minimal most readable disambiguation string for each symbol with the same name. |
| 113 | + /// - Parameters: |
| 114 | + /// - collidingSymbols: A list of symbols that all have the same name. |
| 115 | + /// - Returns: A collection of disambiguation strings in the same order as the provided symbol information. |
| 116 | + /// |
| 117 | + /// - Important: It's the callers responsibility to create symbol information that matches what the compilers emit in symbol graph files. |
| 118 | + /// If there are mismatches, DocC may suggest disambiguation that won't resolve with the real compiler emitted symbol data. |
| 119 | + public static func suggestedDisambiguation(forCollidingSymbols collidingSymbols: [SymbolInformation]) -> [String] { |
| 120 | + // Track the order of the symbols so that the disambiguations can be ordered to align with their respective symbols. |
| 121 | + var identifiersInOrder: [ResolvedIdentifier] = [] |
| 122 | + identifiersInOrder.reserveCapacity(collidingSymbols.count) |
| 123 | + |
| 124 | + // Construct a disambiguation container with all the symbol's information. |
| 125 | + var disambiguationContainer = PathHierarchy.DisambiguationContainer() |
| 126 | + for symbol in collidingSymbols { |
| 127 | + let (node, identifier) = Self._makeNodeAndIdentifier(name: "unused") |
| 128 | + identifiersInOrder.append(identifier) |
| 129 | + |
| 130 | + disambiguationContainer.add( |
| 131 | + node, |
| 132 | + kind: symbol.kind, |
| 133 | + hash: symbol.symbolIDHash, |
| 134 | + parameterTypes: symbol.parameterTypes, |
| 135 | + returnTypes: symbol.returnTypes |
| 136 | + ) |
| 137 | + } |
| 138 | + |
| 139 | + let disambiguatedValues = disambiguationContainer.disambiguatedValues() |
| 140 | + // Compute the minimal suggested disambiguation for each symbol and return their string suffixes in the original symbol's order. |
| 141 | + return identifiersInOrder.map { identifier in |
| 142 | + guard let (_, disambiguation) = disambiguatedValues.first(where: { $0.value.identifier == identifier }) else { |
| 143 | + fatalError("Each node in the `DisambiguationContainer` should always have a entry in the `disambiguatedValues`") |
| 144 | + } |
| 145 | + return disambiguation.makeSuffix() |
| 146 | + } |
| 147 | + } |
| 148 | + |
| 149 | + /// Information about a symbol for link completion purposes. |
| 150 | + /// |
| 151 | + /// > Note: |
| 152 | + /// > This symbol information doesn't include the name. |
| 153 | + /// > It's the callers responsibility to group symbols by their name. |
| 154 | + /// |
| 155 | + /// > Important: |
| 156 | + /// > It's the callers responsibility to create symbol information that matches what the compilers emit in symbol graph files. |
| 157 | + /// > If there are mismatches, DocC may suggest disambiguation that won't resolve with the real compiler emitted symbol data. |
| 158 | + public struct SymbolInformation { |
| 159 | + /// The kind of symbol, for example `"class"` or `"func.op`. |
| 160 | + /// |
| 161 | + /// ## See Also |
| 162 | + /// - ``/SymbolKit/SymbolGraph/Symbol/KindIdentifier`` |
| 163 | + public var kind: String |
| 164 | + /// A hash of the symbol's unique identifier. |
| 165 | + /// |
| 166 | + /// ## See Also |
| 167 | + /// - ``hash(uniqueSymbolID:)`` |
| 168 | + public var symbolIDHash: String |
| 169 | + /// The type names of this symbol's parameters, or `nil` if this symbol has no function signature information. |
| 170 | + /// |
| 171 | + /// A function without parameters represents i |
| 172 | + public var parameterTypes: [String]? |
| 173 | + /// The type names of this symbol's return value, or `nil` if this symbol has no function signature information. |
| 174 | + public var returnTypes: [String]? |
| 175 | + |
| 176 | + public init( |
| 177 | + kind: String, |
| 178 | + symbolIDHash: String, |
| 179 | + parameterTypes: [String]? = nil, |
| 180 | + returnTypes: [String]? = nil |
| 181 | + ) { |
| 182 | + self.kind = kind |
| 183 | + self.symbolIDHash = symbolIDHash |
| 184 | + self.parameterTypes = parameterTypes |
| 185 | + self.returnTypes = returnTypes |
| 186 | + } |
| 187 | + |
| 188 | + /// Creates a hashed representation of a symbol's unique identifier. |
| 189 | + /// |
| 190 | + /// # See Also |
| 191 | + /// - ``symbolIDHash`` |
| 192 | + public static func hash(uniqueSymbolID: String) -> String { |
| 193 | + uniqueSymbolID.stableHashString |
| 194 | + } |
| 195 | + |
| 196 | + // MARK: Filtering |
| 197 | + |
| 198 | + /// Returns a Boolean value that indicates whether this symbol information matches the parsed disambiguation from one of the link components of a parsed link string. |
| 199 | + public func matches(_ parsedDisambiguation: LinkCompletionTools.ParsedDisambiguation) -> Bool { |
| 200 | + guard let disambiguation = PathHierarchy.PathComponent.Disambiguation(parsedDisambiguation) else { |
| 201 | + return true // No disambiguation to match against. |
| 202 | + } |
| 203 | + |
| 204 | + var disambiguationContainer = PathHierarchy.DisambiguationContainer() |
| 205 | + let (node, _) = LinkCompletionTools._makeNodeAndIdentifier(name: "unused") |
| 206 | + |
| 207 | + disambiguationContainer.add( |
| 208 | + node, |
| 209 | + kind: self.kind, |
| 210 | + hash: self.symbolIDHash, |
| 211 | + parameterTypes: self.parameterTypes, |
| 212 | + returnTypes: self.returnTypes |
| 213 | + ) |
| 214 | + |
| 215 | + do { |
| 216 | + return try disambiguationContainer.find(disambiguation) != nil |
| 217 | + } catch { |
| 218 | + return false |
| 219 | + } |
| 220 | + } |
| 221 | + } |
| 222 | +} |
| 223 | + |
| 224 | +private extension PathHierarchy.PathComponent.Disambiguation { |
| 225 | + init?(_ parsedDisambiguation: LinkCompletionTools.ParsedDisambiguation) { |
| 226 | + switch parsedDisambiguation { |
| 227 | + case .kindAndOrHash(let kind, let hash): |
| 228 | + self = .kindAndHash(kind: kind.map { $0[...] }, hash: hash.map { $0[...] }) |
| 229 | + |
| 230 | + case .typeSignature(let parameterTypes, let returnTypes): |
| 231 | + self = .typeSignature(parameterTypes: parameterTypes?.map { $0[...] }, returnTypes: returnTypes?.map { $0[...] }) |
| 232 | + |
| 233 | + // Since this is within DocC we want to have an error if we don't handle new future cases. |
| 234 | + case .none, ._nonFrozenEnum_useDefaultCase: |
| 235 | + return nil |
| 236 | + } |
| 237 | + } |
| 238 | +} |
0 commit comments