1 //===- unittest/Tooling/LexicallyOrderedRecursiveASTVisitorTest.cpp -------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "TestVisitor.h"
11 #include "clang/AST/LexicallyOrderedRecursiveASTVisitor.h"
14 using namespace clang;
18 class DummyMatchVisitor;
20 class LexicallyOrderedDeclVisitor
21 : public LexicallyOrderedRecursiveASTVisitor<LexicallyOrderedDeclVisitor> {
23 LexicallyOrderedDeclVisitor(DummyMatchVisitor &Matcher,
24 const SourceManager &SM, bool EmitDeclIndices,
26 : LexicallyOrderedRecursiveASTVisitor(SM), Matcher(Matcher),
27 EmitDeclIndices(EmitDeclIndices), EmitStmtIndices(EmitStmtIndices) {}
29 bool TraverseDecl(Decl *D) {
30 TraversalStack.push_back(D);
31 LexicallyOrderedRecursiveASTVisitor::TraverseDecl(D);
32 TraversalStack.pop_back();
36 bool TraverseStmt(Stmt *S);
38 bool VisitNamedDecl(const NamedDecl *D);
39 bool VisitDeclRefExpr(const DeclRefExpr *D);
42 DummyMatchVisitor &Matcher;
43 bool EmitDeclIndices, EmitStmtIndices;
45 llvm::SmallVector<Decl *, 8> TraversalStack;
48 class DummyMatchVisitor : public ExpectedLocationVisitor<DummyMatchVisitor> {
49 bool EmitDeclIndices, EmitStmtIndices;
52 DummyMatchVisitor(bool EmitDeclIndices = false, bool EmitStmtIndices = false)
53 : EmitDeclIndices(EmitDeclIndices), EmitStmtIndices(EmitStmtIndices) {}
54 bool VisitTranslationUnitDecl(TranslationUnitDecl *TU) {
55 const ASTContext &Context = TU->getASTContext();
56 const SourceManager &SM = Context.getSourceManager();
57 LexicallyOrderedDeclVisitor SubVisitor(*this, SM, EmitDeclIndices,
59 SubVisitor.TraverseDecl(TU);
63 template <class T> void match(StringRef Path, const T *D) {
64 Match(Path, D->getLocStart());
68 bool LexicallyOrderedDeclVisitor::TraverseStmt(Stmt *S) {
69 Matcher.match("overridden TraverseStmt", S);
70 return LexicallyOrderedRecursiveASTVisitor::TraverseStmt(S);
73 bool LexicallyOrderedDeclVisitor::VisitNamedDecl(const NamedDecl *D) {
75 llvm::raw_string_ostream OS(Path);
76 assert(TraversalStack.back() == D);
77 for (const Decl *D : TraversalStack) {
78 if (isa<TranslationUnitDecl>(D)) {
82 if (const auto *ND = dyn_cast<NamedDecl>(D))
83 OS << ND->getNameAsString();
86 if (isa<DeclContext>(D) || isa<TemplateDecl>(D))
91 Matcher.match(OS.str(), D);
95 bool LexicallyOrderedDeclVisitor::VisitDeclRefExpr(const DeclRefExpr *D) {
96 std::string Name = D->getFoundDecl()->getNameAsString();
97 llvm::raw_string_ostream OS(Name);
100 Matcher.match(OS.str(), D);
104 TEST(LexicallyOrderedRecursiveASTVisitor, VisitDeclsInImplementation) {
105 StringRef Source = R"(
110 int nestedFunction() { }
114 int anotherNestedFunction(int x) {
118 int innerVariable = 0;
122 int outerVariable = 0;
124 @implementation I(Cat)
130 void outerFunction() { }
132 DummyMatchVisitor Visitor;
133 Visitor.DisallowMatch("/nestedFunction/", 6, 1);
134 Visitor.ExpectMatch("/I/nestedFunction/", 6, 1);
135 Visitor.ExpectMatch("/I/method/", 8, 1);
136 Visitor.DisallowMatch("/anotherNestedFunction/", 10, 1);
137 Visitor.ExpectMatch("/I/anotherNestedFunction/", 10, 1);
138 Visitor.DisallowMatch("/innerVariable", 14, 1);
139 Visitor.ExpectMatch("/I/innerVariable", 14, 1);
140 Visitor.ExpectMatch("/outerVariable", 18, 1);
141 Visitor.DisallowMatch("/catF/", 22, 1);
142 Visitor.ExpectMatch("/Cat/catF/", 22, 1);
143 Visitor.ExpectMatch("/outerFunction/", 26, 1);
144 EXPECT_TRUE(Visitor.runOver(Source, DummyMatchVisitor::Lang_OBJC));
147 TEST(LexicallyOrderedRecursiveASTVisitor, VisitMacroDeclsInImplementation) {
148 StringRef Source = R"(
152 void outerFunction() { }
154 #define MACRO_F(x) void nestedFunction##x() { }
164 DummyMatchVisitor Visitor;
165 Visitor.ExpectMatch("/outerFunction/", 5, 1);
166 Visitor.ExpectMatch("/I/nestedFunction1/", 7, 20);
167 Visitor.ExpectMatch("/nestedFunction2/", 7, 20);
168 EXPECT_TRUE(Visitor.runOver(Source, DummyMatchVisitor::Lang_OBJC));
171 TEST(LexicallyOrderedRecursiveASTVisitor, VisitTemplateDecl) {
172 StringRef Source = R"(
173 template <class T> T f();
174 template <class U, class = void> class Class {};
176 DummyMatchVisitor Visitor(/*EmitIndices=*/true);
177 Visitor.ExpectMatch("/f/T@1", 2, 11);
178 Visitor.ExpectMatch("/f/f/@2", 2, 20);
179 Visitor.ExpectMatch("/Class/U@4", 3, 11);
180 Visitor.ExpectMatch("/Class/@5", 3, 20);
181 Visitor.ExpectMatch("/Class/Class/@6", 3, 34);
182 EXPECT_TRUE(Visitor.runOver(Source));
185 TEST(LexicallyOrderedRecursiveASTVisitor, VisitCXXOperatorCallExpr) {
186 StringRef Source = R"(
192 void operator()(int, int);
193 void operator[](int);
207 DummyMatchVisitor Visitor(/*EmitDeclIndices=*/false,
208 /*EmitStmtIndices=*/true);
209 // There are two overloaded operators that start at this point
210 // This makes sure they are both traversed using the overridden
211 // TraverseStmt, as the traversal is implemented by us for
212 // CXXOperatorCallExpr.
213 Visitor.ExpectMatch("overridden TraverseStmt", 14, 3, 2);
214 Visitor.ExpectMatch("a@0", 14, 3);
215 Visitor.ExpectMatch("operator=@1", 14, 5);
216 Visitor.ExpectMatch("b@2", 14, 7);
217 Visitor.ExpectMatch("operator+@3", 14, 9);
218 Visitor.ExpectMatch("c@4", 14, 11);
219 Visitor.ExpectMatch("operator->@6", 15, 4);
220 Visitor.ExpectMatch("operator()@8", 16, 4);
221 Visitor.ExpectMatch("operator[]@10", 17, 4);
222 Visitor.ExpectMatch("operator++@11", 18, 3);
223 Visitor.ExpectMatch("operator++@14", 19, 4);
224 EXPECT_TRUE(Visitor.runOver(Source));
227 } // end anonymous namespace