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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/*
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
/// A storage for render reference information.
///
/// This store stores render references which can be looked up during ``RenderNode`` conversion. It's commonly created by a
/// ``RenderContext``, which precomputes render reference information before render node conversion.
///
/// ## See Also
/// - ``RenderContext``
public struct RenderReferenceStore: Codable {
/// The topics in the store.
public var topics: [ResolvedTopicReference: TopicContent]
/// The assets in the store.
public var assets: [AssetReference: DataAsset]
/// Creates a new render reference store given resolved topics and their reference information.
public init(
topics: [ResolvedTopicReference: TopicContent] = [:],
assets: [AssetReference: DataAsset] = [:]
) {
self.topics = topics
self.assets = assets
}
/// Returns render reference information for the given topic.
public func content(for topic: ResolvedTopicReference) -> TopicContent? {
topics[topic]
}
/// Returns asset information for the given asset name.
public func content(forAssetNamed assetName: String, bundleIdentifier: String) -> DataAsset? {
assets[AssetReference(assetName: assetName, bundleIdentifier: bundleIdentifier)]
}
}
public extension RenderReferenceStore {
/// Pre-rendered pieces of content for a given node.
struct TopicContent: Codable {
/// The topic render reference.
public let renderReference: RenderReference
/// Render reference dependencies.
public let renderReferenceDependencies: RenderReferenceDependencies
/// The canonical path to a node.
public let canonicalPath: [ResolvedTopicReference]?
/// A lookup of a topic's task groups.
public let taskGroups: [DocumentationContentRenderer.ReferenceGroup]?
/// The original source file of the topic.
public let source: URL?
/// Whether the topic is a documentation extension.
public let isDocumentationExtensionContent: Bool
private enum CodingKeys: CodingKey {
case renderReference, canonicalPath, taskGroups, source, isDocumentationExtensionContent, renderReferenceDependencies
}
/// Creates a new content value given a render reference, canonical path, and task group information.
/// - Parameters:
/// - renderReference: The topic render reference.
/// - canonicalPath: The canonical path to a node.
/// - taskGroups: A lookup of a topic's task groups.
/// - source: The original source file location of the topic.
/// - isDocumentationExtensionContent: Whether the topic is a documentation extension.
/// - renderReferenceDependencies: Render reference dependencies.
public init(
renderReference: RenderReference,
canonicalPath: [ResolvedTopicReference]?,
taskGroups: [DocumentationContentRenderer.ReferenceGroup]?,
source: URL?,
isDocumentationExtensionContent: Bool,
renderReferenceDependencies: RenderReferenceDependencies = RenderReferenceDependencies()
) {
self.renderReference = renderReference
self.canonicalPath = canonicalPath
self.taskGroups = taskGroups
self.source = source
self.isDocumentationExtensionContent = isDocumentationExtensionContent
self.renderReferenceDependencies = renderReferenceDependencies
}
public init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: CodingKeys.self)
renderReference = try container.decode(
CodableRenderReference.self, forKey: .renderReference).reference
canonicalPath = try container.decodeIfPresent(
[ResolvedTopicReference].self, forKey: .canonicalPath)
taskGroups = try container.decodeIfPresent(
[DocumentationContentRenderer.ReferenceGroup].self, forKey: .taskGroups)
source = try container.decodeIfPresent(URL.self, forKey: .source)
isDocumentationExtensionContent = try container.decode(Bool.self, forKey: .isDocumentationExtensionContent)
renderReferenceDependencies = try container.decodeIfPresent(RenderReferenceDependencies.self, forKey: .renderReferenceDependencies) ?? RenderReferenceDependencies()
}
public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(CodableRenderReference(renderReference), forKey: .renderReference)
try container.encodeIfPresent(canonicalPath, forKey: .canonicalPath)
try container.encodeIfPresent(taskGroups, forKey: .taskGroups)
try container.encodeIfPresent(source, forKey: .source)
try container.encode(isDocumentationExtensionContent, forKey: .isDocumentationExtensionContent)
try container.encode(renderReferenceDependencies, forKey: .renderReferenceDependencies)
}
}
}
|
