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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2023-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
*/
// This API isn't exposed anywhere and is only used from a debugger.
#if DEBUG
/// A node in a tree structure that can be printed into a visual representation for debugging.
private struct DumpableNode {
var name: String
var children: [DumpableNode]
}
private extension PathHierarchy.Node {
/// Maps the path hierarchy subtree into a representation that can be printed into a visual form for debugging.
func dumpableNode() -> DumpableNode {
// Each node is printed as 3-layer hierarchy with the child names, their kind disambiguation, and their hash disambiguation.
return DumpableNode(
name: symbol.map { "{ \($0.identifier.precise) : \($0.kind.identifier.identifier) [\(languages.map(\.name).joined(separator: ", "))] }" } ?? "[ \(name) ]",
children: children.sorted(by: \.key).map { (key, disambiguationTree) -> DumpableNode in
let grouped = [String: [PathHierarchy.DisambiguationContainer.Element]](grouping: disambiguationTree.storage, by: { $0.kind ?? "_" })
return DumpableNode(
name: key,
children: grouped.sorted(by: \.key).map { (kind, kindTree) -> DumpableNode in
DumpableNode(
name: kind,
children: kindTree.sorted(by: { lhs, rhs in (lhs.hash ?? "_") < (rhs.hash ?? "_") }).map { (element) -> DumpableNode in
DumpableNode(
name: element.hash ?? "_",
children: [element.node.dumpableNode()]
)
}
)
}
)
}
)
}
}
extension PathHierarchy {
/// Creates a visual representation or the path hierarchy for debugging.
func dump() -> String {
var children = modules.sorted(by: \.name).map { $0.dumpableNode() }
if articlesContainer.symbol == nil {
children.append(articlesContainer.dumpableNode()) // The article parent can be the same node as the module
}
children.append(contentsOf: [tutorialContainer.dumpableNode(), tutorialOverviewContainer.dumpableNode()])
let root = DumpableNode(name: ".", children: children)
return Self.dump(root)
}
fileprivate static func dump(_ node: DumpableNode, decorator: String = "") -> String {
var result = ""
result.append("\(decorator) \(node.name)\n")
let children = node.children
for (index, child) in children.enumerated() {
var decorator = decorator
if decorator.hasSuffix("├") {
decorator = decorator.dropLast() + "│"
}
if decorator.hasSuffix("╰") {
decorator = decorator.dropLast() + " "
}
let newDecorator = decorator + " " + (index == children.count-1 ? "╰" : "├")
result.append(dump(child, decorator: newDecorator))
}
return result
}
}
#endif
|
