Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

removes logic duplicated in SymbolKit #1091

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

removes logic duplicated in SymbolKit #1091

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 2 additions & 26 deletions Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ struct SymbolGraphLoader {

symbolGraphTransformer?(&symbolGraph)

let (moduleName, isMainSymbolGraph) = Self.moduleNameFor(symbolGraph, at: symbolGraphURL)
let (moduleName, isMainSymbolGraph) = GraphCollector.moduleNameFor(symbolGraph, at: symbolGraphURL)
// If the bundle provides availability defaults add symbol availability data.
self.addDefaultAvailability(to: &symbolGraph, moduleName: moduleName)

Expand Down Expand Up @@ -193,7 +193,7 @@ struct SymbolGraphLoader {
private func loadSymbolGraph(at url: URL) throws -> (SymbolGraph, isMainSymbolGraph: Bool) {
// This is a private method, the `url` key is known to exist
var symbolGraph = symbolGraphs[url]!
let (moduleName, isMainSymbolGraph) = Self.moduleNameFor(symbolGraph, at: url)
let (moduleName, isMainSymbolGraph) = GraphCollector.moduleNameFor(symbolGraph, at: url)

if !isMainSymbolGraph && symbolGraph.module.bystanders == nil {
// If this is an extending another module, change the module name to match the extended module.
Expand Down Expand Up @@ -340,31 +340,7 @@ struct SymbolGraphLoader {

return fileName.split(separator: "@", maxSplits: 1).last.map({ String($0) })
}

/// Returns the module name of a symbol graph based on the JSON data and file name.
///
/// Useful during decoding the symbol graphs to implement the correct name logic starting with the module name in the JSON.
private static func moduleNameFor(_ symbolGraph: SymbolGraph, at url: URL) -> (String, Bool) {
let isMainSymbolGraph = !url.lastPathComponent.contains("@")

let moduleName: String
if isMainSymbolGraph || symbolGraph.module.bystanders != nil {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I see that this version has a symbolGraph.module.bystanders != nil check, but the SymbolKit version doesn't. Do we need it? cc @QuietMisdreavus

// For main symbol graphs, get the module name from the symbol graph's data

// When bystander modules are present, the symbol graph is a cross-import overlay, and
// we need to preserve the original module name to properly render it. It is still
// kept with the extension symbols, due to the merging behavior of UnifiedSymbolGraph.
moduleName = symbolGraph.module.name
} else {
// For extension symbol graphs, derive the extended module's name from the file name.
//
// The per-symbol `extendedModule` value is the same as the main module for most symbols, so it's not a good way to find the name
// of the module that was extended (rdar://63200368).
moduleName = SymbolGraphLoader.moduleNameFor(url)!
}
return (moduleName, isMainSymbolGraph)
}

private static func applyWorkaroundFor139305015(to symbolGraph: inout SymbolGraph) {
guard symbolGraph.symbols.values.mapFirst(where: { SourceLanguage(id: $0.identifier.interfaceLanguage) }) == .objectiveC else {
return
Expand Down