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
|
//===- unittest/AST/RecursiveASTVisitorTest.cpp ---------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "clang/AST/RecursiveASTVisitor.h"
#include "clang/AST/ASTConsumer.h"
#include "clang/AST/ASTContext.h"
#include "clang/AST/Attr.h"
#include "clang/AST/Decl.h"
#include "clang/AST/TypeLoc.h"
#include "clang/Frontend/FrontendAction.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/ADT/FunctionExtras.h"
#include "llvm/ADT/STLExtras.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include <cassert>
using namespace clang;
using ::testing::ElementsAre;
namespace {
class ProcessASTAction : public clang::ASTFrontendAction {
public:
ProcessASTAction(llvm::unique_function<void(clang::ASTContext &)> Process)
: Process(std::move(Process)) {
assert(this->Process);
}
std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI,
StringRef InFile) {
class Consumer : public ASTConsumer {
public:
Consumer(llvm::function_ref<void(ASTContext &CTx)> Process)
: Process(Process) {}
void HandleTranslationUnit(ASTContext &Ctx) override { Process(Ctx); }
private:
llvm::function_ref<void(ASTContext &CTx)> Process;
};
return std::make_unique<Consumer>(Process);
}
private:
llvm::unique_function<void(clang::ASTContext &)> Process;
};
enum class VisitEvent {
StartTraverseFunction,
EndTraverseFunction,
StartTraverseAttr,
EndTraverseAttr,
StartTraverseEnum,
EndTraverseEnum,
StartTraverseTypedefType,
EndTraverseTypedefType,
StartTraverseObjCInterface,
EndTraverseObjCInterface,
StartTraverseObjCProtocol,
EndTraverseObjCProtocol,
StartTraverseObjCProtocolLoc,
EndTraverseObjCProtocolLoc,
};
class CollectInterestingEvents
: public RecursiveASTVisitor<CollectInterestingEvents> {
public:
bool TraverseFunctionDecl(FunctionDecl *D) {
Events.push_back(VisitEvent::StartTraverseFunction);
bool Ret = RecursiveASTVisitor::TraverseFunctionDecl(D);
Events.push_back(VisitEvent::EndTraverseFunction);
return Ret;
}
bool TraverseAttr(Attr *A) {
Events.push_back(VisitEvent::StartTraverseAttr);
bool Ret = RecursiveASTVisitor::TraverseAttr(A);
Events.push_back(VisitEvent::EndTraverseAttr);
return Ret;
}
bool TraverseEnumDecl(EnumDecl *D) {
Events.push_back(VisitEvent::StartTraverseEnum);
bool Ret = RecursiveASTVisitor::TraverseEnumDecl(D);
Events.push_back(VisitEvent::EndTraverseEnum);
return Ret;
}
bool TraverseTypedefTypeLoc(TypedefTypeLoc TL) {
Events.push_back(VisitEvent::StartTraverseTypedefType);
bool Ret = RecursiveASTVisitor::TraverseTypedefTypeLoc(TL);
Events.push_back(VisitEvent::EndTraverseTypedefType);
return Ret;
}
bool TraverseObjCInterfaceDecl(ObjCInterfaceDecl *ID) {
Events.push_back(VisitEvent::StartTraverseObjCInterface);
bool Ret = RecursiveASTVisitor::TraverseObjCInterfaceDecl(ID);
Events.push_back(VisitEvent::EndTraverseObjCInterface);
return Ret;
}
bool TraverseObjCProtocolDecl(ObjCProtocolDecl *PD) {
Events.push_back(VisitEvent::StartTraverseObjCProtocol);
bool Ret = RecursiveASTVisitor::TraverseObjCProtocolDecl(PD);
Events.push_back(VisitEvent::EndTraverseObjCProtocol);
return Ret;
}
bool TraverseObjCProtocolLoc(ObjCProtocolLoc ProtocolLoc) {
Events.push_back(VisitEvent::StartTraverseObjCProtocolLoc);
bool Ret = RecursiveASTVisitor::TraverseObjCProtocolLoc(ProtocolLoc);
Events.push_back(VisitEvent::EndTraverseObjCProtocolLoc);
return Ret;
}
std::vector<VisitEvent> takeEvents() && { return std::move(Events); }
private:
std::vector<VisitEvent> Events;
};
std::vector<VisitEvent> collectEvents(llvm::StringRef Code,
const Twine &FileName = "input.cc") {
CollectInterestingEvents Visitor;
clang::tooling::runToolOnCode(
std::make_unique<ProcessASTAction>(
[&](clang::ASTContext &Ctx) { Visitor.TraverseAST(Ctx); }),
Code, FileName);
return std::move(Visitor).takeEvents();
}
} // namespace
TEST(RecursiveASTVisitorTest, AttributesInsideDecls) {
/// Check attributes are traversed inside TraverseFunctionDecl.
llvm::StringRef Code = R"cpp(
__attribute__((annotate("something"))) int foo() { return 10; }
)cpp";
EXPECT_THAT(collectEvents(Code),
ElementsAre(VisitEvent::StartTraverseFunction,
VisitEvent::StartTraverseAttr,
VisitEvent::EndTraverseAttr,
VisitEvent::EndTraverseFunction));
}
TEST(RecursiveASTVisitorTest, EnumDeclWithBase) {
// Check enum and its integer base is visited.
llvm::StringRef Code = R"cpp(
typedef int Foo;
enum Bar : Foo;
)cpp";
EXPECT_THAT(collectEvents(Code),
ElementsAre(VisitEvent::StartTraverseEnum,
VisitEvent::StartTraverseTypedefType,
VisitEvent::EndTraverseTypedefType,
VisitEvent::EndTraverseEnum));
}
TEST(RecursiveASTVisitorTest, InterfaceDeclWithProtocols) {
// Check interface and its protocols are visited.
llvm::StringRef Code = R"cpp(
@protocol Foo
@end
@protocol Bar
@end
@interface SomeObject <Foo, Bar>
@end
)cpp";
EXPECT_THAT(collectEvents(Code, "input.m"),
ElementsAre(VisitEvent::StartTraverseObjCProtocol,
VisitEvent::EndTraverseObjCProtocol,
VisitEvent::StartTraverseObjCProtocol,
VisitEvent::EndTraverseObjCProtocol,
VisitEvent::StartTraverseObjCInterface,
VisitEvent::StartTraverseObjCProtocolLoc,
VisitEvent::EndTraverseObjCProtocolLoc,
VisitEvent::StartTraverseObjCProtocolLoc,
VisitEvent::EndTraverseObjCProtocolLoc,
VisitEvent::EndTraverseObjCInterface));
}
|
