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
|
/*
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
import Markdown
/// Walks a markup tree and collects any links external to a given bundle.
struct ExternalMarkupReferenceWalker: MarkupVisitor {
/// The local bundle ID, used to identify and skip absolute fully qualified local links.
var localBundleID: BundleIdentifier
/// After walking a markup tree, all encountered external links are collected grouped by the bundle ID.
var collectedExternalLinks = [BundleIdentifier: Set<ValidatedURL>]()
/// Descends down the given elements' children.
mutating func defaultVisit(_ markup: Markup) {
for child in markup.children {
self.visit(child)
}
}
/// Collects the link URL, if the link is not to a topic in the current bundle.
mutating func visitLink(_ link: Link) {
// Only process documentation links to external bundles
guard let destination = link.destination,
let url = ValidatedURL(parsingAuthoredLink: destination)?.requiring(scheme: ResolvedTopicReference.urlScheme),
let bundleID = url.components.host,
bundleID != localBundleID
else {
return
}
// Collect the external link.
collectedExternalLinks[bundleID, default: []].insert(url)
}
}
|
