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
|
//===----------------------------------------------------------------------===//
//
// 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 SwiftParser
import SwiftSyntax
import XCTest
import _SwiftSyntaxTestSupport
private extension String {
// This implementation is really slow; to use it outside a test it should be optimized.
func trimmingTrailingWhitespace() -> String {
return self.replacingOccurrences(of: "[ ]+\\n", with: "\n", options: .regularExpression)
}
}
class DebugDescriptionTests: XCTestCase {
public func testDump() {
struct TestCase {
let syntax: Any
let expectedDumped: String
}
let testCases: [UInt: TestCase] = [
#line: .init(
syntax: TokenSyntax.keyword(.associatedtype, leadingTrivia: [], trailingTrivia: []),
expectedDumped: """
▿ keyword(SwiftSyntax.Keyword.associatedtype)
- text: "associatedtype"
▿ leadingTrivia: []
- pieces: 0 elements
▿ trailingTrivia: []
- pieces: 0 elements
▿ tokenKind: SwiftSyntax.TokenKind.keyword
- keyword: SwiftSyntax.Keyword.associatedtype
"""
),
#line: {
let leftToken = TokenSyntax.leftSquareToken()
let elements = ArrayElementListSyntax([])
let rightToken = TokenSyntax.rightSquareToken()
let expr = ArrayExprSyntax(
leftSquare: leftToken,
elements: elements,
rightSquare: rightToken
)
return .init(
syntax: expr.tokens(viewMode: .sourceAccurate),
expectedDumped: """
▿ SwiftSyntax.TokenSequence
▿ leftSquare
- text: "["
▿ leadingTrivia: []
- pieces: 0 elements
▿ trailingTrivia: []
- pieces: 0 elements
- tokenKind: SwiftSyntax.TokenKind.leftSquare
▿ rightSquare
- text: "]"
▿ leadingTrivia: []
- pieces: 0 elements
▿ trailingTrivia: []
- pieces: 0 elements
- tokenKind: SwiftSyntax.TokenKind.rightSquare
"""
)
}(),
#line: {
let leftToken = TokenSyntax.leftSquareToken()
let elements = ArrayElementListSyntax([])
let rightToken = TokenSyntax.rightSquareToken()
let expr = ArrayExprSyntax(
leftSquare: leftToken,
elements: elements,
rightSquare: rightToken
)
return .init(
syntax: expr.tokens(viewMode: .sourceAccurate).reversed(),
expectedDumped: """
▿ SwiftSyntax.ReversedTokenSequence
▿ rightSquare
- text: "]"
▿ leadingTrivia: []
- pieces: 0 elements
▿ trailingTrivia: []
- pieces: 0 elements
- tokenKind: SwiftSyntax.TokenKind.rightSquare
▿ leftSquare
- text: "["
▿ leadingTrivia: []
- pieces: 0 elements
▿ trailingTrivia: []
- pieces: 0 elements
- tokenKind: SwiftSyntax.TokenKind.leftSquare
"""
)
}(),
#line: {
let token1 = TokenSyntax.integerLiteral("1")
let expr1 = IntegerLiteralExprSyntax(literal: token1)
let token2 = TokenSyntax.integerLiteral("2")
let expr2 = IntegerLiteralExprSyntax(literal: token2)
let elements = [
LabeledExprSyntax(expression: expr1),
LabeledExprSyntax(expression: expr2),
]
let tuples = LabeledExprListSyntax(elements)
return .init(
syntax: tuples,
expectedDumped: """
- LabeledExprListSyntax
├─[0]: LabeledExprSyntax
│ ╰─expression: IntegerLiteralExprSyntax
│ ╰─literal: integerLiteral("1")
╰─[1]: LabeledExprSyntax
╰─expression: IntegerLiteralExprSyntax
╰─literal: integerLiteral("2")
"""
)
}(),
#line: {
let token1 = TokenSyntax.integerLiteral("1")
let expr1 = IntegerLiteralExprSyntax(literal: token1)
let token2 = TokenSyntax.integerLiteral("2")
let expr2 = IntegerLiteralExprSyntax(literal: token2)
let elements = [
LabeledExprSyntax(expression: expr1),
LabeledExprSyntax(expression: expr2),
]
let tuples = LabeledExprListSyntax(elements)
return .init(
syntax: tuples.reversed(),
expectedDumped: """
▿ Swift.ReversedCollection<SwiftSyntax.LabeledExprListSyntax>
- _base: LabeledExprListSyntax
├─[0]: LabeledExprSyntax
│ ╰─expression: IntegerLiteralExprSyntax
│ ╰─literal: integerLiteral("1")
╰─[1]: LabeledExprSyntax
╰─expression: IntegerLiteralExprSyntax
╰─literal: integerLiteral("2")
"""
)
}(),
]
testCases.forEach { keyAndValue in
let (key:line, value:testCase) = keyAndValue
var actualDumped = ""
dump(testCase.syntax, to: &actualDumped)
assertStringsEqualWithDiff(
actualDumped.trimmingTrailingWhitespace(),
testCase.expectedDumped.trimmingTrailingWhitespace(),
line: line
)
}
}
#if DEBUG
// debugInitCall is only available in debug builds, so we can only test it in those.
// swift-format-ignore
@available(*, deprecated, message: "Purposefully tests debugInitCall, which is marked deprecated for debugger use only")
func testDebugInitCall() {
let sourceFile: SourceFileSyntax = """
test(1, 2)
"""
assertStringsEqualWithDiff(
sourceFile.debugInitCall(includeTrivia: true).trimmingTrailingWhitespace(),
"""
SourceFileSyntax(
statements: CodeBlockItemListSyntax([
CodeBlockItemSyntax(item: CodeBlockItemSyntax.Item(FunctionCallExprSyntax(
calledExpression: ExprSyntax(DeclReferenceExprSyntax(baseName: .identifier("test"))),
leftParen: .leftParenToken(),
arguments: LabeledExprListSyntax([
LabeledExprSyntax(
expression: ExprSyntax(IntegerLiteralExprSyntax(literal: .integerLiteral("1"))),
trailingComma: .commaToken(trailingTrivia: .space)
),
LabeledExprSyntax(expression: ExprSyntax(IntegerLiteralExprSyntax(literal: .integerLiteral("2"))))
]),
rightParen: .rightParenToken(),
additionalTrailingClosures: MultipleTrailingClosureElementListSyntax([])
)))
]),
endOfFileToken: .endOfFileToken()
)
"""
)
assertStringsEqualWithDiff(
sourceFile.debugInitCall(includeTrivia: false).trimmingTrailingWhitespace(),
"""
SourceFileSyntax(
statements: CodeBlockItemListSyntax([
CodeBlockItemSyntax(item: CodeBlockItemSyntax.Item(FunctionCallExprSyntax(
calledExpression: ExprSyntax(DeclReferenceExprSyntax(baseName: .identifier("test"))),
leftParen: .leftParenToken(),
arguments: LabeledExprListSyntax([
LabeledExprSyntax(
expression: ExprSyntax(IntegerLiteralExprSyntax(literal: .integerLiteral("1"))),
trailingComma: .commaToken()
),
LabeledExprSyntax(expression: ExprSyntax(IntegerLiteralExprSyntax(literal: .integerLiteral("2"))))
]),
rightParen: .rightParenToken(),
additionalTrailingClosures: MultipleTrailingClosureElementListSyntax([])
)))
]),
endOfFileToken: .endOfFileToken()
)
"""
)
}
#endif
}
|
