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
120
121
122
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022 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
import Markdown
protocol _ChildMarkupProtocol {
var numberOfParagraphs: _ChildMarkupParagraphs { get }
var index: Int? { get }
var supportsStructuredMarkup: Bool { get }
func setProperty(
on containingDirective: some AutomaticDirectiveConvertible,
named propertyName: String,
to any: Any
)
}
enum _ChildMarkupParagraphs {
case zeroOrMore
case zeroOrOne
case oneOrMore
case custom(Int)
}
/// A property wrapper that represents general-purpose markup within a directive.
///
/// This property wrapper is used internally in Swift-DocC when declaring directives
/// that support child markup content.
///
/// class Column: Semantic, AutomaticDirectiveConvertible {
/// let originalMarkup: BlockDirective
///
/// @ChildMarkup(numberOfParagraphs: .oneOrMore)
/// public private(set) var content: MarkupContainer
///
/// static var keyPaths: [String : AnyKeyPath] = [
/// "content" : \Column._content,
/// ]
///
/// init(originalMarkup: BlockDirective) {
/// self.originalMarkup = originalMarkup
/// }
/// }
///
/// > Warning: This property wrapper is exposed as public API of SwiftDocC so that clients
/// > have access to its projected value, but it is unsupported to attach this property
/// > wrapper to new declarations outside of SwiftDocC.
@propertyWrapper
public struct ChildMarkup<Value>: _ChildMarkupProtocol {
var parsedValue: Value?
var index: Int?
var numberOfParagraphs: _ChildMarkupParagraphs
/// Returns true if the child markup can contain structured markup content like
/// rows and columns.
var supportsStructuredMarkup: Bool
public var wrappedValue: Value {
get {
parsedValue!
}
set {
parsedValue = newValue
}
}
@available(*, unavailable,
message: "The value type must be a 'MarkupContainer'."
)
public init() {
fatalError()
}
func setProperty<T>(
on containingDirective: T,
named propertyName: String,
to any: Any
) where T: AutomaticDirectiveConvertible {
let path = T.keyPaths[propertyName] as! ReferenceWritableKeyPath<T, ChildMarkup<Value>>
let wrappedValuePath = path.appending(path: \Self.parsedValue)
containingDirective[keyPath: wrappedValuePath] = any as! Value?
}
}
extension ChildMarkup<MarkupContainer> {
init(
numberOfParagraphs: _ChildMarkupParagraphs = .oneOrMore,
index: Int? = nil,
supportsStructure: Bool = false
) {
self.parsedValue = MarkupContainer()
self.numberOfParagraphs = numberOfParagraphs
self.index = index
self.supportsStructuredMarkup = supportsStructure
}
}
extension ChildMarkup<MarkupContainer?> {
init(
value: Value,
numberOfParagraphs: _ChildMarkupParagraphs = .zeroOrMore,
index: Int? = nil,
supportsStructure: Bool = false
) {
self.parsedValue = value
self.numberOfParagraphs = numberOfParagraphs
self.index = index
self.supportsStructuredMarkup = supportsStructure
}
}
|
