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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2023 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
*/
/// A reference to a URL.
public struct LinkReference: RenderReference, Equatable {
/// The type of this link reference.
///
/// This value is always `.link`.
public var type: RenderReferenceType = .link
/// The identifier of this reference.
public var identifier: RenderReferenceIdentifier
/// The plain text title of the destination page.
public var title: String
/// The formatted title of the destination page.
public var titleInlineContent: [RenderInlineContent]
/// The topic url for the destination page.
public var url: String
/// Creates a new link reference with its initial values.
///
/// - Parameters:
/// - identifier: The identifier of this reference.
/// - title: The plain text title of the destination page.
/// - titleInlineContent: The formatted title of the destination page.
/// - url: The topic url for the destination page.
public init(identifier: RenderReferenceIdentifier, title: String, titleInlineContent: [RenderInlineContent]? = nil, url: String) {
self.identifier = identifier
self.title = title
self.titleInlineContent = titleInlineContent ?? [.text(title)]
self.url = url
}
enum CodingKeys: String, CodingKey {
case type, identifier, title, titleInlineContent, url
}
public init(from decoder: Decoder) throws {
let values = try decoder.container(keyedBy: CodingKeys.self)
type = try values.decode(RenderReferenceType.self, forKey: .type)
identifier = try values.decode(RenderReferenceIdentifier.self, forKey: .identifier)
let urlPath = try values.decode(String.self, forKey: .url)
if let formattedTitle = try values.decodeIfPresent([RenderInlineContent].self, forKey: .titleInlineContent) {
self.titleInlineContent = formattedTitle
self.title = try values.decodeIfPresent(String.self, forKey: .title) ?? formattedTitle.plainText
} else if let plainTextTitle = try values.decodeIfPresent(String.self, forKey: .title) {
self.titleInlineContent = [.text(plainTextTitle)]
self.title = plainTextTitle
} else {
self.titleInlineContent = [.text(urlPath)]
self.title = urlPath
}
url = urlPath
}
public func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(type, forKey: .type)
try container.encode(identifier, forKey: .identifier)
try container.encode(title, forKey: .title)
try container.encode(titleInlineContent, forKey: .titleInlineContent)
try container.encode(url, forKey: .url)
}
}
// Diffable conformance
extension LinkReference: RenderJSONDiffable {
/// Returns the difference between this LinkReference and the given one.
func difference(from other: LinkReference, at path: CodablePath) -> JSONPatchDifferences {
var diffBuilder = DifferenceBuilder(current: self, other: other, basePath: path)
diffBuilder.addDifferences(atKeyPath: \.type, forKey: CodingKeys.type)
diffBuilder.addDifferences(atKeyPath: \.title, forKey: CodingKeys.title)
diffBuilder.addDifferences(atKeyPath: \.titleInlineContent, forKey: CodingKeys.titleInlineContent)
diffBuilder.addDifferences(atKeyPath: \.url, forKey: CodingKeys.url)
return diffBuilder.differences
}
}
|