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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022-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
*/
import Foundation
import Markdown
struct DirectiveMirror {
let reflectedDirective: ReflectedDirective
init(reflecting directive: AutomaticDirectiveConvertible.Type) {
let mirror = Mirror(
reflecting: directive.init(
originalMarkup: BlockDirective(
name: "temporary",
children: []
)
)
)
let reflectedArguments = mirror.children.compactMap { child -> ReflectedArgument? in
guard let argument = child.value as? _DirectiveArgumentProtocol else {
return nil
}
guard var label = child.label else {
return nil
}
// Property wrappers have underscore-prefixed names
if label.first == "_" {
label.removeFirst()
}
let unnamed: Bool
let argumentName: String
switch argument.name {
case .unnamed:
unnamed = true
argumentName = ""
case .custom(let value):
unnamed = false
argumentName = value
case .inferredFromPropertyName:
unnamed = false
argumentName = label
}
return ReflectedArgument(
storedAsOptional: argument.storedAsOptional,
required: argument.required,
typeDisplayName: argument.typeDisplayName,
name: argumentName,
unnamed: unnamed,
allowedValues: argument.allowedValues,
expectedFormat: argument.expectedFormat,
propertyLabel: label,
argument: argument,
parseArgument: argument.parseArgument
)
}
let reflectedChildDirectives = mirror.children.compactMap { child -> ReflectedChildDirective? in
guard let childDirective = child.value as? _ChildDirectiveProtocol else {
return nil
}
guard var label = child.label else {
return nil
}
// Property wrappers have underscore-prefixed names
if label.first == "_" {
label.removeFirst()
}
let requirements: ReflectedChildDirective.Requirements
switch childDirective.requirements {
case .zeroOrMore:
requirements = .zeroOrMore
case .one:
requirements = .one
case .zeroOrOne:
requirements = .zeroOrOne
case .oneOrMore:
requirements = .oneOrMore
}
return ReflectedChildDirective(
type: childDirective.directiveConvertible,
requirements: requirements,
storedAsArray: childDirective.storedAsArray,
storedAsOptional: childDirective.storedAsOptional,
propertyLabel: label,
childDirective: childDirective
)
}
let reflectedMarkupContainerRequirements = mirror.children.compactMap { child -> ReflectedChildMarkup? in
guard let childMarkup = child.value as? _ChildMarkupProtocol else {
return nil
}
guard var label = child.label else {
return nil
}
// Property wrappers have underscore-prefixed names
if label.first == "_" {
label.removeFirst()
}
return ReflectedChildMarkup(
propertyLabel: label,
markup: childMarkup
)
}
let childMarkupSupport: ReflectedDirective.ChildMarkupSupport
if !reflectedMarkupContainerRequirements.isEmpty {
childMarkupSupport = .supportsMarkup(reflectedMarkupContainerRequirements)
} else {
childMarkupSupport = .disallowsMarkup
}
self.reflectedDirective = ReflectedDirective(
arguments: reflectedArguments,
childDirectives: reflectedChildDirectives,
childMarkupSupport: childMarkupSupport,
type: directive
)
}
}
extension DirectiveMirror {
struct ReflectedArgument {
let storedAsOptional: Bool
/// Whether or not this argument is required.
let required: Bool
/// The name of this argument's type for use in diagnostics and documentation.
let typeDisplayName: String
var labelDisplayName: String {
if unnamed {
return "_ \(propertyLabel)"
} else {
return name
}
}
var hiddenFromDocumentation: Bool {
return argument.hiddenFromDocumentation
}
let name: String
let unnamed: Bool
let allowedValues: [String]?
let expectedFormat: String?
let propertyLabel: String
let argument: _DirectiveArgumentProtocol
let parseArgument: (_ bundle: DocumentationBundle, _ argumentValue: String) -> (Any?)
func setValue(
on containingDirective: some AutomaticDirectiveConvertible,
to any: Any
) {
argument.setProperty(
on: containingDirective,
named: propertyLabel,
to: any
)
}
}
struct ReflectedChildDirective {
enum Requirements {
case zeroOrOne
case one
case zeroOrMore
case oneOrMore
}
let type: DirectiveConvertible.Type
let requirements: Requirements
var storedAsArray: Bool
var storedAsOptional: Bool
var name: String {
return type.directiveName
}
var required: Bool {
return requirements == .one || requirements == .oneOrMore
}
let propertyLabel: String
let childDirective: _ChildDirectiveProtocol
func setValue(
on containingDirective: some AutomaticDirectiveConvertible,
to any: Any
) {
childDirective.setProperty(
on: containingDirective,
named: propertyLabel,
to: any
)
}
}
struct ReflectedDirective {
var name: String {
return type.directiveName
}
var introducedVersion: String {
return type.introducedVersion
}
let arguments: [ReflectedArgument]
let childDirectives: [ReflectedChildDirective]
enum ChildMarkupSupport {
case supportsMarkup([ReflectedChildMarkup])
case disallowsMarkup
}
let childMarkupSupport: ChildMarkupSupport
var allowsMarkup: Bool {
switch childMarkupSupport {
case .supportsMarkup:
return true
case .disallowsMarkup:
return false
}
}
var allowsStructuredMarkup: Bool {
switch childMarkupSupport {
case .supportsMarkup(let markupRequirements):
return markupRequirements.first?.markup.supportsStructuredMarkup ?? false
case .disallowsMarkup:
return false
}
}
var requiresMarkup: Bool {
switch childMarkupSupport {
case .supportsMarkup(let markupRequirements):
return markupRequirements.contains(where: \.required)
case .disallowsMarkup:
return false
}
}
var hiddenFromDocumentation: Bool {
(type as? AutomaticDirectiveConvertible.Type)?.hiddenFromDocumentation ?? false
}
let type: DirectiveConvertible.Type
}
struct ReflectedChildMarkup {
let propertyLabel: String
var required: Bool {
switch markup.numberOfParagraphs {
case .oneOrMore:
return true
case .zeroOrMore:
return false
case .zeroOrOne:
return false
case .custom(let value):
return value > 0
}
}
let markup: _ChildMarkupProtocol
func setValue(
on containingDirective: some AutomaticDirectiveConvertible,
to any: Any
) {
markup.setProperty(
on: containingDirective,
named: propertyLabel,
to: any
)
}
}
}
|