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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 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 the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import SwiftDiagnostics
import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros
public struct MetaEnumMacro {
let parentTypeName: TokenSyntax
let childCases: [EnumCaseElementSyntax]
let access: DeclModifierListSyntax.Element?
let parentParamName: TokenSyntax
init(node: AttributeSyntax, declaration: some DeclGroupSyntax, context: some MacroExpansionContext) throws {
guard let enumDecl = declaration.as(EnumDeclSyntax.self) else {
throw DiagnosticsError(diagnostics: [
CaseMacroDiagnostic.notAnEnum(declaration).diagnose(at: Syntax(node))
])
}
parentTypeName = enumDecl.name.with(\.trailingTrivia, [])
access = enumDecl.modifiers.first(where: \.isNeededAccessLevelModifier)
childCases = enumDecl.caseElements.map { parentCase in
parentCase.with(\.parameterClause, nil)
}
parentParamName = context.makeUniqueName("parent")
}
func makeMetaEnum() -> DeclSyntax {
// FIXME: Why does this need to be a string to make trailing trivia work properly?
let caseDecls =
childCases
.map { childCase in
" case \(childCase.name)"
}
.joined(separator: "\n")
return """
\(access)enum Meta {
\(raw: caseDecls)
\(makeMetaInit())
}
"""
}
func makeMetaInit() -> DeclSyntax {
// FIXME: Why does this need to be a string to make trailing trivia work properly?
let caseStatements =
childCases
.map { childCase in
"""
case .\(childCase.name):
self = .\(childCase.name)
"""
}
.joined(separator: "\n")
return """
\(access)init(_ \(parentParamName): \(parentTypeName)) {
switch \(parentParamName) {
\(raw: caseStatements)
}
}
"""
}
}
extension MetaEnumMacro: MemberMacro {
public static func expansion(
of node: AttributeSyntax,
providingMembersOf declaration: some DeclGroupSyntax,
in context: some MacroExpansionContext
) throws -> [DeclSyntax] {
let macro = try MetaEnumMacro(node: node, declaration: declaration, context: context)
return [macro.makeMetaEnum()]
}
}
extension EnumDeclSyntax {
var caseElements: [EnumCaseElementSyntax] {
memberBlock.members.flatMap { member in
guard let caseDecl = member.decl.as(EnumCaseDeclSyntax.self) else {
return Array<EnumCaseElementSyntax>()
}
return Array(caseDecl.elements)
}
}
}
enum CaseMacroDiagnostic {
case notAnEnum(DeclGroupSyntax)
}
extension CaseMacroDiagnostic: DiagnosticMessage {
var message: String {
switch self {
case .notAnEnum(let decl):
return "'@MetaEnum' can only be attached to an enum, not \(decl.descriptiveDeclKind(withArticle: true))"
}
}
var diagnosticID: MessageID {
switch self {
case .notAnEnum:
return MessageID(domain: "MetaEnumDiagnostic", id: "notAnEnum")
}
}
var severity: DiagnosticSeverity {
switch self {
case .notAnEnum:
return .error
}
}
func diagnose(at node: Syntax) -> Diagnostic {
Diagnostic(node: node, message: self)
}
}
extension DeclGroupSyntax {
func descriptiveDeclKind(withArticle article: Bool = false) -> String {
switch self {
case is ActorDeclSyntax:
return article ? "an actor" : "actor"
case is ClassDeclSyntax:
return article ? "a class" : "class"
case is ExtensionDeclSyntax:
return article ? "an extension" : "extension"
case is ProtocolDeclSyntax:
return article ? "a protocol" : "protocol"
case is StructDeclSyntax:
return article ? "a struct" : "struct"
case is EnumDeclSyntax:
return article ? "an enum" : "enum"
default:
fatalError("Unknown DeclGroupSyntax")
}
}
}
|