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
|
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//==========================================================================//
// IMPORTANT: The macros defined in this file are intended to test the //
// behavior of MacroSystem. Many of them do not serve as good examples of //
// how macros should be written. In particular, they often lack error //
// handling because it is not needed in the few test cases in which these //
// macros are invoked. //
//==========================================================================//
import SwiftDiagnostics
import SwiftSyntax
@_spi(Testing) import SwiftSyntaxMacroExpansion
@_spi(ExperimentalLanguageFeature) import SwiftSyntaxMacros
import SwiftSyntaxMacrosTestSupport
import XCTest
struct TracedPreambleMacro: PreambleMacro {
static func expansion(
of node: AttributeSyntax,
providingPreambleFor declaration: some DeclSyntaxProtocol & WithOptionalCodeBlockSyntax,
in context: some MacroExpansionContext
) throws -> [CodeBlockItemSyntax] {
// FIXME: Should be able to support (de-)initializers and accessors as
// well, but this is a lazy implementation.
guard let funcDecl = declaration.as(FunctionDeclSyntax.self) else {
return []
}
let funcBaseName = funcDecl.name
let paramNames = funcDecl.signature.parameterClause.parameters.map { param in
param.parameterName?.text ?? "_"
}
let passedArgs = paramNames.map { "\($0): \\(\($0))" }.joined(separator: ", ")
let entry: CodeBlockItemSyntax = """
log("Entering \(funcBaseName)(\(raw: passedArgs))")
"""
let argLabels = paramNames.map { "\($0):" }.joined()
let exit: CodeBlockItemSyntax = """
log("Exiting \(funcBaseName)(\(raw: argLabels))")
"""
return [
entry,
"""
defer {
\(exit)
}
""",
]
}
}
final class PreambleMacroTests: XCTestCase {
private let indentationWidth: Trivia = .spaces(2)
func testPreambleExpansion() {
assertMacroExpansion(
"""
@Traced
func doSomethingDangerous(operation: String) {
print("This is the operation: \\(operation)")
}
""",
expandedSource: """
func doSomethingDangerous(operation: String) {
log("Entering doSomethingDangerous(operation: \\(operation))")
defer {
log("Exiting doSomethingDangerous(operation:)")
}
print("This is the operation: \\(operation)")
}
""",
macros: ["Traced": TracedPreambleMacro.self],
indentationWidth: indentationWidth
)
}
func testPreambleExpansionTwice() {
assertMacroExpansion(
"""
@Traced @Traced
func doSomethingDangerous(operation: String) {
print("This is the operation: \\(operation)")
}
""",
expandedSource: """
func doSomethingDangerous(operation: String) {
log("Entering doSomethingDangerous(operation: \\(operation))")
defer {
log("Exiting doSomethingDangerous(operation:)")
}
log("Entering doSomethingDangerous(operation: \\(operation))")
defer {
log("Exiting doSomethingDangerous(operation:)")
}
print("This is the operation: \\(operation)")
}
""",
macros: ["Traced": TracedPreambleMacro.self],
indentationWidth: indentationWidth
)
}
func testBodyAndPreambleExpansion() {
assertMacroExpansion(
"""
@Remote @Traced
func f(a: Int, b: String) async throws -> String
""",
expandedSource: """
func f(a: Int, b: String) async throws -> String {
log("Entering f(a: \\(a), b: \\(b))")
defer {
log("Exiting f(a:b:)")
}
return try await remoteCall(function: "f", arguments: ["a": a, "b": b])
}
""",
macros: [
"Remote": RemoteBodyMacro.self,
"Traced": TracedPreambleMacro.self,
],
indentationWidth: indentationWidth
)
}
func testPreambleExpansionWithoutBody() {
assertMacroExpansion(
"""
@Traced
func f(a: Int, b: String) async throws -> String
""",
expandedSource: """
func f(a: Int, b: String) async throws -> String
""",
diagnostics: [
DiagnosticSpec(
message: "preamble macro cannot be applied to a function with no body",
line: 1,
column: 1
)
],
macros: [
"Traced": TracedPreambleMacro.self
],
indentationWidth: indentationWidth
)
}
}
|
