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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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
/// Hierarchical information for a render node.
///
/// A render node's hierarchy information, such as its parent topics,
/// describes an API reference hierarchy that starts with a framework
/// landing page, or a Tutorials hierarchy that starts with a Tutorials landing page.
/// ## Topics
/// ### Hierarchy Types
/// - ``RenderReferenceHierarchy``
/// - ``RenderTutorialsHierarchy``
public enum RenderHierarchy: Codable, Equatable {
/// The hierarchy for an API reference render node.
case reference(RenderReferenceHierarchy)
/// The hierarchy for tutorials-related render node.
case tutorials(RenderTutorialsHierarchy)
public init(from decoder: Decoder) throws {
if let tutorialsHierarchy = try? RenderTutorialsHierarchy(from: decoder) {
self = .tutorials(tutorialsHierarchy)
decoder.registerReferences(tutorialsHierarchy.paths.flatMap { $0 })
return
}
let referenceHierarchy = try RenderReferenceHierarchy(from: decoder)
self = .reference(referenceHierarchy)
decoder.registerReferences(referenceHierarchy.paths.flatMap { $0 })
}
public func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
switch self {
case .reference(let hierarchy):
try container.encode(hierarchy)
case .tutorials(let hierarchy):
try container.encode(hierarchy)
}
}
}
// Diffable conformance
extension RenderHierarchy: RenderJSONDiffable {
/// Returns the difference between this RenderHierarchy and the given one.
func difference(from other: RenderHierarchy, at path: CodablePath) -> JSONPatchDifferences {
var differences = JSONPatchDifferences()
switch (self, other) {
case (let .reference(selfReferenceHierarchy), let .reference(otherReferenceHierarchy)):
differences.append(contentsOf: selfReferenceHierarchy.difference(from: otherReferenceHierarchy, at: path))
case (.tutorials(_), _), (_, .tutorials(_)):
return differences // Diffing tutorials is not currently supported
}
return differences
}
func isSimilar(to other: RenderHierarchy) -> Bool {
switch (self, other) {
case (let .reference(selfReferenceHierarchy), let .reference(otherReferenceHierarchy)):
return selfReferenceHierarchy.isSimilar(to: otherReferenceHierarchy)
case (.tutorials(_), _), (_, .tutorials(_)):
return false // Diffing tutorials is not currently supported
}
}
}
|
