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
|
//===----------------------------------------------------------------------===//
//
// 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 SwiftSyntax
import XCTest
class VisitorTests: XCTestCase {
public func testVisitMissingNodes() {
let node = ReturnStmtSyntax(returnKeyword: .keyword(.return), expression: ExprSyntax(MissingExprSyntax()))
class MissingExprChecker: SyntaxVisitor {
var didSeeMissingExprSyntax = false
override func visit(_ node: MissingExprSyntax) -> SyntaxVisitorContinueKind {
didSeeMissingExprSyntax = true
return .visitChildren
}
static func check<Tree: SyntaxProtocol>(_ tree: Tree, viewMode: SyntaxTreeViewMode) -> Bool {
let visitor = MissingExprChecker(viewMode: viewMode)
visitor.walk(tree)
return visitor.didSeeMissingExprSyntax
}
}
XCTAssertTrue(MissingExprChecker.check(node, viewMode: .sourceAccurate))
XCTAssertTrue(MissingExprChecker.check(node, viewMode: .fixedUp))
}
public func testVisitMissingToken() {
let node = ReturnStmtSyntax(
returnKeyword: .keyword(.return, presence: .missing)
)
class MissingTokenChecker: SyntaxVisitor {
var didSeeToken = false
override func visit(_ node: TokenSyntax) -> SyntaxVisitorContinueKind {
didSeeToken = true
return .visitChildren
}
static func check<Tree: SyntaxProtocol>(_ tree: Tree, viewMode: SyntaxTreeViewMode) -> Bool {
let visitor = MissingTokenChecker(viewMode: viewMode)
visitor.walk(tree)
return visitor.didSeeToken
}
}
XCTAssertFalse(MissingTokenChecker.check(node, viewMode: .sourceAccurate))
XCTAssertTrue(MissingTokenChecker.check(node, viewMode: .fixedUp))
}
public func testVisitUnexpected() {
// This is just bunch of unexpected
let unexpectedReturnStmt = ReturnStmtSyntax(
UnexpectedNodesSyntax([
Syntax(TokenSyntax.identifier("starting")), Syntax(TokenSyntax.integerLiteral("unexpected")),
]),
returnKeyword: .keyword(.return, trailingTrivia: [.spaces(1)]),
UnexpectedNodesSyntax([Syntax(TokenSyntax.identifier("middle"))]),
expression: ExprSyntax(
NilLiteralExprSyntax(
UnexpectedNodesSyntax([Syntax(TokenSyntax.identifier("end"))]),
nilKeyword: TokenSyntax.keyword(.nil, trailingTrivia: [])
)
)
)
// This is more real-world where the user wrote null instead of nil.
let misspelledNil = ReturnStmtSyntax(
returnKeyword: .keyword(.return, trailingTrivia: [.spaces(1)]),
expression: ExprSyntax(
NilLiteralExprSyntax(
UnexpectedNodesSyntax([Syntax(TokenSyntax.identifier("null"))]),
nilKeyword: .keyword(.nil, presence: .missing)
)
)
)
// Test SyntaxVisitor
class TreePrinter: SyntaxVisitor {
var out = ""
override func visit(_ node: TokenSyntax) -> SyntaxVisitorContinueKind {
out += node.leadingTrivia.description
out += node.text
out += node.trailingTrivia.description
return .visitChildren
}
static func print<Tree: SyntaxProtocol>(_ tree: Tree, viewMode: SyntaxTreeViewMode) -> String {
let printer = TreePrinter(viewMode: viewMode)
printer.walk(tree)
return printer.out
}
}
XCTAssertEqual(TreePrinter.print(unexpectedReturnStmt, viewMode: .fixedUp), "return nil")
XCTAssertEqual(
TreePrinter.print(unexpectedReturnStmt, viewMode: .sourceAccurate),
"startingunexpectedreturn middleendnil"
)
XCTAssertEqual(TreePrinter.print(misspelledNil, viewMode: .fixedUp), "return nil")
XCTAssertEqual(TreePrinter.print(misspelledNil, viewMode: .sourceAccurate), "return null")
// Test SyntaxAnyVisitor
class AnyTreePrinter: SyntaxAnyVisitor {
var out = ""
override func visitAny(_ node: Syntax) -> SyntaxVisitorContinueKind {
if let token = node.as(TokenSyntax.self) {
out += token.leadingTrivia.description
out += token.text
out += token.trailingTrivia.description
}
return .visitChildren
}
static func print<Tree: SyntaxProtocol>(_ tree: Tree, viewMode: SyntaxTreeViewMode) -> String {
let printer = TreePrinter(viewMode: viewMode)
printer.walk(tree)
return printer.out
}
}
XCTAssertEqual(AnyTreePrinter.print(unexpectedReturnStmt, viewMode: .fixedUp), "return nil")
XCTAssertEqual(
AnyTreePrinter.print(unexpectedReturnStmt, viewMode: .sourceAccurate),
"startingunexpectedreturn middleendnil"
)
XCTAssertEqual(AnyTreePrinter.print(misspelledNil, viewMode: .fixedUp), "return nil")
XCTAssertEqual(AnyTreePrinter.print(misspelledNil, viewMode: .sourceAccurate), "return null")
// Test SyntaxRewriter
class RewritingTreePrinter: SyntaxRewriter {
var out = ""
override func visit(_ node: TokenSyntax) -> TokenSyntax {
out += node.leadingTrivia.description
out += node.text
out += node.trailingTrivia.description
return node
}
static func print<Tree: SyntaxProtocol>(_ tree: Tree, viewMode: SyntaxTreeViewMode) -> String {
let printer = RewritingTreePrinter(viewMode: viewMode)
_ = printer.rewrite(Syntax(tree))
return printer.out
}
}
XCTAssertEqual(RewritingTreePrinter.print(unexpectedReturnStmt, viewMode: .fixedUp), "return nil")
XCTAssertEqual(
RewritingTreePrinter.print(unexpectedReturnStmt, viewMode: .sourceAccurate),
"startingunexpectedreturn middleendnil"
)
XCTAssertEqual(RewritingTreePrinter.print(misspelledNil, viewMode: .fixedUp), "return nil")
XCTAssertEqual(RewritingTreePrinter.print(misspelledNil, viewMode: .sourceAccurate), "return null")
}
}
|
