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
|
//===- 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,
};
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;
}
std::vector<VisitEvent> takeEvents() && { return std::move(Events); }
private:
std::vector<VisitEvent> Events;
};
std::vector<VisitEvent> collectEvents(llvm::StringRef Code) {
CollectInterestingEvents Visitor;
clang::tooling::runToolOnCode(
std::make_unique<ProcessASTAction>(
[&](clang::ASTContext &Ctx) { Visitor.TraverseAST(Ctx); }),
Code);
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));
}
|
