Skip to content
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

Jump to bottom

Add identifierItems for TaskGroupRenderSection #505

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

Add identifierItems for TaskGroupRenderSection #505

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 11 additions & 9 deletions Sources/SwiftDocC/Model/Rendering/RenderNodeTranslator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1060,7 +1060,7 @@ public struct RenderNodeTranslator: SemanticVisitor {
title: group.heading?.plainText,
abstract: abstractContent,
discussion: discussion,
identifiers: group.links.compactMap { link in
identifierItems: group.links.compactMap { link in
switch link {
case let link as Link:
if !allowExternalLinks {
Expand All @@ -1082,12 +1082,13 @@ public struct RenderNodeTranslator: SemanticVisitor {
case let RenderInlineContent.reference(
identifier: identifier,
isActive: _,
overridingTitle: _,
overridingTitleInlineContent: _
overridingTitle: overridingTitle,
overridingTitleInlineContent: overridingTitleInlineContent
) = renderReference
{
return isTopicAvailableInAllowedTraits(identifier: identifier.identifier)
? identifier.identifier : nil
let identifier = identifier.identifier
return isTopicAvailableInAllowedTraits(identifier: identifier)
? TaskGroupRenderSection.IdentifierItem(identifier: identifier, overrideTitle: overridingTitle, overridingTitleInlineContent: overridingTitleInlineContent) : nil
}
case let link as SymbolLink:
if let referenceInlines = contentCompiler.visitSymbolLink(link) as? [RenderInlineContent],
Expand All @@ -1102,12 +1103,13 @@ public struct RenderNodeTranslator: SemanticVisitor {
case let RenderInlineContent.reference(
identifier: identifier,
isActive: _,
overridingTitle: _,
overridingTitleInlineContent: _
overridingTitle: overridingTitle,
overridingTitleInlineContent: overridingTitleInlineContent
) = renderReference
{
return isTopicAvailableInAllowedTraits(identifier: identifier.identifier)
? identifier.identifier : nil
let identifier = identifier.identifier
return isTopicAvailableInAllowedTraits(identifier: identifier)
? TaskGroupRenderSection.IdentifierItem(identifier: identifier, overrideTitle: overridingTitle, overridingTitleInlineContent: overridingTitleInlineContent) : nil
}
default: break
}
Expand Down
55 changes: 47 additions & 8 deletions Sources/SwiftDocC/Model/Rendering/Symbol/TaskGroupRenderSection.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,59 @@ public struct TaskGroupRenderSection: RenderSection {
/// An optional discussion for the section.
public let discussion: RenderSection?
/// A list of topic graph references.
public let identifiers: [String]
@available(*, deprecated, message: "Please use identifierItems instead.")
public var identifiers: [String] { identifierItems.map { $0.identifier } }
/// A list of topic graph reference items
public let identifierItems: [IdentifierItem]
/// If true, this is an automatically generated group. If false, this is an authored group.
public let generated: Bool

public struct IdentifierItem: Codable {
public let identifier: String
public let overrideTitle: String?
public let overridingTitleInlineContent: [RenderInlineContent]?

public init(identifier: String, overrideTitle: String? = nil, overridingTitleInlineContent: [RenderInlineContent]? = nil) {
self.identifier = identifier
self.overrideTitle = overrideTitle
self.overridingTitleInlineContent = overridingTitleInlineContent
}
}

/// Creates a new task group.
/// - Parameters:
/// - title: An optional title for the section.
/// - abstract: An optional abstract summary for the section.
/// - discussion: An optional discussion for the section.
/// - identifiers: A list of topic-graph references.
/// - generated: If `true`, this is an automatically generated group. If `false`, this is an authored group.
@available(*, deprecated, message: "Please use TaskGroupRenderSection.init(title:abstract:discussion:identifierItems:generated:) instead.")
public init(title: String?, abstract: [RenderInlineContent]?, discussion: RenderSection?, identifiers: [String], generated: Bool = false) {
self.title = title
self.abstract = abstract
self.discussion = discussion
self.identifiers = identifiers
self.identifierItems = identifiers.map { IdentifierItem(identifier: $0) }
self.generated = generated
}

/// Creates a new task group.
/// - Parameters:
/// - title: An optional title for the section.
/// - abstract: An optional abstract summary for the section.
/// - discussion: An optional discussion for the section.
/// - identifiers: A list of topic-graph references.
/// - generated: If `true`, this is an automatically generated group. If `false`, this is an authored group.
public init(title: String?, abstract: [RenderInlineContent]?, discussion: RenderSection?, identifierItems: [IdentifierItem], generated: Bool = false) {
self.title = title
self.abstract = abstract
self.discussion = discussion
self.identifierItems = identifierItems
self.generated = generated
}

/// The list of keys you use to encode or decode this section.
private enum CodingKeys: CodingKey {
case title, abstract, discussion, identifiers, generated
case title, abstract, discussion, identifiers, identifierItems, generated
}

public func encode(to encoder: Encoder) throws {
Expand All @@ -50,6 +81,7 @@ public struct TaskGroupRenderSection: RenderSection {
try container.encodeIfPresent(abstract, forKey: .abstract)
try container.encodeIfPresent(discussion.map(CodableRenderSection.init), forKey: .discussion)
try container.encode(identifiers, forKey: .identifiers)
try container.encode(identifierItems, forKey: .identifierItems)
if generated {
try container.encode(generated, forKey: .generated)
}
Expand All @@ -61,11 +93,18 @@ public struct TaskGroupRenderSection: RenderSection {
title = try container.decodeIfPresent(String.self, forKey: .title)
abstract = try container.decodeIfPresent([RenderInlineContent].self, forKey: .abstract)
discussion = (try container.decodeIfPresent(CodableContentSection.self, forKey: .discussion)).map { $0.section }
identifiers = try container.decode([String].self, forKey: .identifiers)

decoder.registerReferences(identifiers)


let identifiers = try container.decodeIfPresent([String].self, forKey: .identifiers)
let identifierItems = try container.decodeIfPresent([IdentifierItem].self, forKey: .identifierItems)
if let identifierItems = identifierItems {
self.identifierItems = identifierItems
} else if let identifiers = identifiers {
self.identifierItems = identifiers.map { IdentifierItem(identifier: $0) }
} else {
self.identifierItems = []
}
generated = try container.decodeIfPresent(Bool.self, forKey: .generated) ?? false
decoder.registerReferences(self.identifiers)
}
}

Expand All @@ -76,7 +115,7 @@ extension TaskGroupRenderSection {
self.title = group.title
self.abstract = nil
self.discussion = nil
self.identifiers = group.references.map({ $0.absoluteString })
self.identifierItems = group.references.map{ IdentifierItem(identifier: $0.absoluteString) }
self.generated = false
}
}