Skip to content

Read extended module from SymbolGraph. #1397

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

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

Read extended module from SymbolGraph. #1397

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ struct PathHierarchy {
let moduleNode: Node

if !loader.hasPrimaryURL(moduleName: moduleName) {
guard let moduleName = SymbolGraphLoader.moduleNameFor(url),
let existingModuleNode = roots[moduleName]
let (moduleName, _) = GraphCollector.moduleNameFor(graph, at: url)
guard let existingModuleNode = roots[moduleName]
else { continue }
moduleNode = existingModuleNode
} else if let existingModuleNode = roots[moduleName] {
Expand Down
40 changes: 2 additions & 38 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 @@ -314,48 +314,12 @@ struct SymbolGraphLoader {
symbolGraph.symbols = symbolsWithFilledIntroducedVersions
}
}

/// Returns the module name, if any, in the file name of a given symbol-graph URL.
///
/// Returns "Combine", if it's a main symbol-graph file, such as "Combine.symbols.json".
/// Returns "Swift", if it's an extension file such as, "Combine@Swift.symbols.json".
/// - parameter url: A URL to a symbol graph file.
/// - returns: A module name, or `nil` if the file name cannot be parsed.
static func moduleNameFor(_ url: URL) -> String? {
let fileName = url.lastPathComponent.components(separatedBy: ".symbols.json")[0]

let fileNameComponents = fileName.components(separatedBy: "@")
if fileNameComponents.count > 2 {
// Two "@"s found in the name - it's a cross import symbol graph:
// "Framework1@Framework2@_Framework1_Framework2.symbols.json"
return fileNameComponents[0]
}

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 {
// 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)
return GraphCollector.moduleNameFor(symbolGraph, at: url)
}

private static func applyWorkaroundFor139305015(to symbolGraph: inout SymbolGraph) {
Expand Down