1 //===--- RecursiveASTVisitor.h - Recursive AST Visitor ----------*- C++ -*-===//
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 // This file defines the RecursiveASTVisitor interface, which recursively
11 // traverses the entire AST.
13 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_AST_RECURSIVEASTVISITOR_H
15 #define LLVM_CLANG_AST_RECURSIVEASTVISITOR_H
17 #include "clang/AST/Attr.h"
18 #include "clang/AST/Decl.h"
19 #include "clang/AST/DeclarationName.h"
20 #include "clang/AST/DeclBase.h"
21 #include "clang/AST/DeclCXX.h"
22 #include "clang/AST/DeclFriend.h"
23 #include "clang/AST/DeclObjC.h"
24 #include "clang/AST/DeclOpenMP.h"
25 #include "clang/AST/DeclTemplate.h"
26 #include "clang/AST/Expr.h"
27 #include "clang/AST/ExprCXX.h"
28 #include "clang/AST/ExprObjC.h"
29 #include "clang/AST/ExprOpenMP.h"
30 #include "clang/AST/LambdaCapture.h"
31 #include "clang/AST/NestedNameSpecifier.h"
32 #include "clang/AST/OpenMPClause.h"
33 #include "clang/AST/Stmt.h"
34 #include "clang/AST/StmtCXX.h"
35 #include "clang/AST/StmtObjC.h"
36 #include "clang/AST/StmtOpenMP.h"
37 #include "clang/AST/TemplateBase.h"
38 #include "clang/AST/TemplateName.h"
39 #include "clang/AST/Type.h"
40 #include "clang/AST/TypeLoc.h"
41 #include "clang/Basic/LLVM.h"
42 #include "clang/Basic/OpenMPKinds.h"
43 #include "clang/Basic/Specifiers.h"
44 #include "llvm/ADT/PointerIntPair.h"
45 #include "llvm/ADT/SmallVector.h"
46 #include "llvm/Support/Casting.h"
49 #include <type_traits>
51 // The following three macros are used for meta programming. The code
52 // using them is responsible for defining macro OPERATOR().
54 // All unary operators.
55 #define UNARYOP_LIST() \
56 OPERATOR(PostInc) OPERATOR(PostDec) OPERATOR(PreInc) OPERATOR(PreDec) \
57 OPERATOR(AddrOf) OPERATOR(Deref) OPERATOR(Plus) OPERATOR(Minus) \
58 OPERATOR(Not) OPERATOR(LNot) OPERATOR(Real) OPERATOR(Imag) \
59 OPERATOR(Extension) OPERATOR(Coawait)
61 // All binary operators (excluding compound assign operators).
62 #define BINOP_LIST() \
63 OPERATOR(PtrMemD) OPERATOR(PtrMemI) OPERATOR(Mul) OPERATOR(Div) \
64 OPERATOR(Rem) OPERATOR(Add) OPERATOR(Sub) OPERATOR(Shl) OPERATOR(Shr) \
65 OPERATOR(LT) OPERATOR(GT) OPERATOR(LE) OPERATOR(GE) OPERATOR(EQ) \
66 OPERATOR(NE) OPERATOR(Cmp) OPERATOR(And) OPERATOR(Xor) OPERATOR(Or) \
67 OPERATOR(LAnd) OPERATOR(LOr) OPERATOR(Assign) OPERATOR(Comma)
69 // All compound assign operators.
71 OPERATOR(Mul) OPERATOR(Div) OPERATOR(Rem) OPERATOR(Add) OPERATOR(Sub) \
72 OPERATOR(Shl) OPERATOR(Shr) OPERATOR(And) OPERATOR(Or) OPERATOR(Xor)
76 // A helper macro to implement short-circuiting when recursing. It
77 // invokes CALL_EXPR, which must be a method call, on the derived
78 // object (s.t. a user of RecursiveASTVisitor can override the method
80 #define TRY_TO(CALL_EXPR) \
82 if (!getDerived().CALL_EXPR) \
86 /// A class that does preorder or postorder
87 /// depth-first traversal on the entire Clang AST and visits each node.
89 /// This class performs three distinct tasks:
90 /// 1. traverse the AST (i.e. go to each node);
91 /// 2. at a given node, walk up the class hierarchy, starting from
92 /// the node's dynamic type, until the top-most class (e.g. Stmt,
93 /// Decl, or Type) is reached.
94 /// 3. given a (node, class) combination, where 'class' is some base
95 /// class of the dynamic type of 'node', call a user-overridable
96 /// function to actually visit the node.
98 /// These tasks are done by three groups of methods, respectively:
99 /// 1. TraverseDecl(Decl *x) does task #1. It is the entry point
100 /// for traversing an AST rooted at x. This method simply
101 /// dispatches (i.e. forwards) to TraverseFoo(Foo *x) where Foo
102 /// is the dynamic type of *x, which calls WalkUpFromFoo(x) and
103 /// then recursively visits the child nodes of x.
104 /// TraverseStmt(Stmt *x) and TraverseType(QualType x) work
106 /// 2. WalkUpFromFoo(Foo *x) does task #2. It does not try to visit
107 /// any child node of x. Instead, it first calls WalkUpFromBar(x)
108 /// where Bar is the direct parent class of Foo (unless Foo has
109 /// no parent), and then calls VisitFoo(x) (see the next list item).
110 /// 3. VisitFoo(Foo *x) does task #3.
112 /// These three method groups are tiered (Traverse* > WalkUpFrom* >
113 /// Visit*). A method (e.g. Traverse*) may call methods from the same
114 /// tier (e.g. other Traverse*) or one tier lower (e.g. WalkUpFrom*).
115 /// It may not call methods from a higher tier.
117 /// Note that since WalkUpFromFoo() calls WalkUpFromBar() (where Bar
118 /// is Foo's super class) before calling VisitFoo(), the result is
119 /// that the Visit*() methods for a given node are called in the
120 /// top-down order (e.g. for a node of type NamespaceDecl, the order will
121 /// be VisitDecl(), VisitNamedDecl(), and then VisitNamespaceDecl()).
123 /// This scheme guarantees that all Visit*() calls for the same AST
124 /// node are grouped together. In other words, Visit*() methods for
125 /// different nodes are never interleaved.
127 /// Clients of this visitor should subclass the visitor (providing
128 /// themselves as the template argument, using the curiously recurring
129 /// template pattern) and override any of the Traverse*, WalkUpFrom*,
130 /// and Visit* methods for declarations, types, statements,
131 /// expressions, or other AST nodes where the visitor should customize
132 /// behavior. Most users only need to override Visit*. Advanced
133 /// users may override Traverse* and WalkUpFrom* to implement custom
134 /// traversal strategies. Returning false from one of these overridden
135 /// functions will abort the entire traversal.
137 /// By default, this visitor tries to visit every part of the explicit
138 /// source code exactly once. The default policy towards templates
139 /// is to descend into the 'pattern' class or function body, not any
140 /// explicit or implicit instantiations. Explicit specializations
141 /// are still visited, and the patterns of partial specializations
142 /// are visited separately. This behavior can be changed by
143 /// overriding shouldVisitTemplateInstantiations() in the derived class
144 /// to return true, in which case all known implicit and explicit
145 /// instantiations will be visited at the same time as the pattern
146 /// from which they were produced.
148 /// By default, this visitor preorder traverses the AST. If postorder traversal
149 /// is needed, the \c shouldTraversePostOrder method needs to be overridden
150 /// to return \c true.
151 template <typename Derived> class RecursiveASTVisitor {
153 /// A queue used for performing data recursion over statements.
154 /// Parameters involving this type are used to implement data
155 /// recursion over Stmts and Exprs within this class, and should
156 /// typically not be explicitly specified by derived classes.
157 /// The bool bit indicates whether the statement has been traversed or not.
158 typedef SmallVectorImpl<llvm::PointerIntPair<Stmt *, 1, bool>>
161 /// Return a reference to the derived class.
162 Derived &getDerived() { return *static_cast<Derived *>(this); }
164 /// Return whether this visitor should recurse into
165 /// template instantiations.
166 bool shouldVisitTemplateInstantiations() const { return false; }
168 /// Return whether this visitor should recurse into the types of
170 bool shouldWalkTypesOfTypeLocs() const { return true; }
172 /// Return whether this visitor should recurse into implicit
173 /// code, e.g., implicit constructors and destructors.
174 bool shouldVisitImplicitCode() const { return false; }
176 /// Return whether this visitor should traverse post-order.
177 bool shouldTraversePostOrder() const { return false; }
179 /// Recursively visit a statement or expression, by
180 /// dispatching to Traverse*() based on the argument's dynamic type.
182 /// \returns false if the visitation was terminated early, true
183 /// otherwise (including when the argument is nullptr).
184 bool TraverseStmt(Stmt *S, DataRecursionQueue *Queue = nullptr);
186 /// Invoked before visiting a statement or expression via data recursion.
188 /// \returns false to skip visiting the node, true otherwise.
189 bool dataTraverseStmtPre(Stmt *S) { return true; }
191 /// Invoked after visiting a statement or expression via data recursion.
192 /// This is not invoked if the previously invoked \c dataTraverseStmtPre
195 /// \returns false if the visitation was terminated early, true otherwise.
196 bool dataTraverseStmtPost(Stmt *S) { return true; }
198 /// Recursively visit a type, by dispatching to
199 /// Traverse*Type() based on the argument's getTypeClass() property.
201 /// \returns false if the visitation was terminated early, true
202 /// otherwise (including when the argument is a Null type).
203 bool TraverseType(QualType T);
205 /// Recursively visit a type with location, by dispatching to
206 /// Traverse*TypeLoc() based on the argument type's getTypeClass() property.
208 /// \returns false if the visitation was terminated early, true
209 /// otherwise (including when the argument is a Null type location).
210 bool TraverseTypeLoc(TypeLoc TL);
212 /// Recursively visit an attribute, by dispatching to
213 /// Traverse*Attr() based on the argument's dynamic type.
215 /// \returns false if the visitation was terminated early, true
216 /// otherwise (including when the argument is a Null type location).
217 bool TraverseAttr(Attr *At);
219 /// Recursively visit a declaration, by dispatching to
220 /// Traverse*Decl() based on the argument's dynamic type.
222 /// \returns false if the visitation was terminated early, true
223 /// otherwise (including when the argument is NULL).
224 bool TraverseDecl(Decl *D);
226 /// Recursively visit a C++ nested-name-specifier.
228 /// \returns false if the visitation was terminated early, true otherwise.
229 bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS);
231 /// Recursively visit a C++ nested-name-specifier with location
234 /// \returns false if the visitation was terminated early, true otherwise.
235 bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS);
237 /// Recursively visit a name with its location information.
239 /// \returns false if the visitation was terminated early, true otherwise.
240 bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo);
242 /// Recursively visit a template name and dispatch to the
243 /// appropriate method.
245 /// \returns false if the visitation was terminated early, true otherwise.
246 bool TraverseTemplateName(TemplateName Template);
248 /// Recursively visit a template argument and dispatch to the
249 /// appropriate method for the argument type.
251 /// \returns false if the visitation was terminated early, true otherwise.
252 // FIXME: migrate callers to TemplateArgumentLoc instead.
253 bool TraverseTemplateArgument(const TemplateArgument &Arg);
255 /// Recursively visit a template argument location and dispatch to the
256 /// appropriate method for the argument type.
258 /// \returns false if the visitation was terminated early, true otherwise.
259 bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc);
261 /// Recursively visit a set of template arguments.
262 /// This can be overridden by a subclass, but it's not expected that
263 /// will be needed -- this visitor always dispatches to another.
265 /// \returns false if the visitation was terminated early, true otherwise.
266 // FIXME: take a TemplateArgumentLoc* (or TemplateArgumentListInfo) instead.
267 bool TraverseTemplateArguments(const TemplateArgument *Args,
270 /// Recursively visit a base specifier. This can be overridden by a
273 /// \returns false if the visitation was terminated early, true otherwise.
274 bool TraverseCXXBaseSpecifier(const CXXBaseSpecifier &Base);
276 /// Recursively visit a constructor initializer. This
277 /// automatically dispatches to another visitor for the initializer
278 /// expression, but not for the name of the initializer, so may
279 /// be overridden for clients that need access to the name.
281 /// \returns false if the visitation was terminated early, true otherwise.
282 bool TraverseConstructorInitializer(CXXCtorInitializer *Init);
284 /// Recursively visit a lambda capture. \c Init is the expression that
285 /// will be used to initialize the capture.
287 /// \returns false if the visitation was terminated early, true otherwise.
288 bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C,
291 /// Recursively visit the body of a lambda expression.
293 /// This provides a hook for visitors that need more context when visiting
294 /// \c LE->getBody().
296 /// \returns false if the visitation was terminated early, true otherwise.
297 bool TraverseLambdaBody(LambdaExpr *LE, DataRecursionQueue *Queue = nullptr);
299 /// Recursively visit the syntactic or semantic form of an
300 /// initialization list.
302 /// \returns false if the visitation was terminated early, true otherwise.
303 bool TraverseSynOrSemInitListExpr(InitListExpr *S,
304 DataRecursionQueue *Queue = nullptr);
306 // ---- Methods on Attrs ----
308 // Visit an attribute.
309 bool VisitAttr(Attr *A) { return true; }
311 // Declare Traverse* and empty Visit* for all Attr classes.
312 #define ATTR_VISITOR_DECLS_ONLY
313 #include "clang/AST/AttrVisitor.inc"
314 #undef ATTR_VISITOR_DECLS_ONLY
316 // ---- Methods on Stmts ----
318 Stmt::child_range getStmtChildren(Stmt *S) { return S->children(); }
321 template<typename T, typename U>
322 struct has_same_member_pointer_type : std::false_type {};
323 template<typename T, typename U, typename R, typename... P>
324 struct has_same_member_pointer_type<R (T::*)(P...), R (U::*)(P...)>
327 // Traverse the given statement. If the most-derived traverse function takes a
328 // data recursion queue, pass it on; otherwise, discard it. Note that the
329 // first branch of this conditional must compile whether or not the derived
330 // class can take a queue, so if we're taking the second arm, make the first
331 // arm call our function rather than the derived class version.
332 #define TRAVERSE_STMT_BASE(NAME, CLASS, VAR, QUEUE) \
333 (has_same_member_pointer_type<decltype( \
334 &RecursiveASTVisitor::Traverse##NAME), \
335 decltype(&Derived::Traverse##NAME)>::value \
336 ? static_cast<typename std::conditional< \
337 has_same_member_pointer_type< \
338 decltype(&RecursiveASTVisitor::Traverse##NAME), \
339 decltype(&Derived::Traverse##NAME)>::value, \
340 Derived &, RecursiveASTVisitor &>::type>(*this) \
341 .Traverse##NAME(static_cast<CLASS *>(VAR), QUEUE) \
342 : getDerived().Traverse##NAME(static_cast<CLASS *>(VAR)))
344 // Try to traverse the given statement, or enqueue it if we're performing data
345 // recursion in the middle of traversing another statement. Can only be called
346 // from within a DEF_TRAVERSE_STMT body or similar context.
347 #define TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S) \
349 if (!TRAVERSE_STMT_BASE(Stmt, Stmt, S, Queue)) \
354 // Declare Traverse*() for all concrete Stmt classes.
355 #define ABSTRACT_STMT(STMT)
356 #define STMT(CLASS, PARENT) \
357 bool Traverse##CLASS(CLASS *S, DataRecursionQueue *Queue = nullptr);
358 #include "clang/AST/StmtNodes.inc"
359 // The above header #undefs ABSTRACT_STMT and STMT upon exit.
361 // Define WalkUpFrom*() and empty Visit*() for all Stmt classes.
362 bool WalkUpFromStmt(Stmt *S) { return getDerived().VisitStmt(S); }
363 bool VisitStmt(Stmt *S) { return true; }
364 #define STMT(CLASS, PARENT) \
365 bool WalkUpFrom##CLASS(CLASS *S) { \
366 TRY_TO(WalkUpFrom##PARENT(S)); \
367 TRY_TO(Visit##CLASS(S)); \
370 bool Visit##CLASS(CLASS *S) { return true; }
371 #include "clang/AST/StmtNodes.inc"
373 // Define Traverse*(), WalkUpFrom*(), and Visit*() for unary
374 // operator methods. Unary operators are not classes in themselves
375 // (they're all opcodes in UnaryOperator) but do have visitors.
376 #define OPERATOR(NAME) \
377 bool TraverseUnary##NAME(UnaryOperator *S, \
378 DataRecursionQueue *Queue = nullptr) { \
379 if (!getDerived().shouldTraversePostOrder()) \
380 TRY_TO(WalkUpFromUnary##NAME(S)); \
381 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getSubExpr()); \
384 bool WalkUpFromUnary##NAME(UnaryOperator *S) { \
385 TRY_TO(WalkUpFromUnaryOperator(S)); \
386 TRY_TO(VisitUnary##NAME(S)); \
389 bool VisitUnary##NAME(UnaryOperator *S) { return true; }
394 // Define Traverse*(), WalkUpFrom*(), and Visit*() for binary
395 // operator methods. Binary operators are not classes in themselves
396 // (they're all opcodes in BinaryOperator) but do have visitors.
397 #define GENERAL_BINOP_FALLBACK(NAME, BINOP_TYPE) \
398 bool TraverseBin##NAME(BINOP_TYPE *S, DataRecursionQueue *Queue = nullptr) { \
399 if (!getDerived().shouldTraversePostOrder()) \
400 TRY_TO(WalkUpFromBin##NAME(S)); \
401 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getLHS()); \
402 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getRHS()); \
405 bool WalkUpFromBin##NAME(BINOP_TYPE *S) { \
406 TRY_TO(WalkUpFrom##BINOP_TYPE(S)); \
407 TRY_TO(VisitBin##NAME(S)); \
410 bool VisitBin##NAME(BINOP_TYPE *S) { return true; }
412 #define OPERATOR(NAME) GENERAL_BINOP_FALLBACK(NAME, BinaryOperator)
416 // Define Traverse*(), WalkUpFrom*(), and Visit*() for compound
417 // assignment methods. Compound assignment operators are not
418 // classes in themselves (they're all opcodes in
419 // CompoundAssignOperator) but do have visitors.
420 #define OPERATOR(NAME) \
421 GENERAL_BINOP_FALLBACK(NAME##Assign, CompoundAssignOperator)
425 #undef GENERAL_BINOP_FALLBACK
427 // ---- Methods on Types ----
428 // FIXME: revamp to take TypeLoc's rather than Types.
430 // Declare Traverse*() for all concrete Type classes.
431 #define ABSTRACT_TYPE(CLASS, BASE)
432 #define TYPE(CLASS, BASE) bool Traverse##CLASS##Type(CLASS##Type *T);
433 #include "clang/AST/TypeNodes.def"
434 // The above header #undefs ABSTRACT_TYPE and TYPE upon exit.
436 // Define WalkUpFrom*() and empty Visit*() for all Type classes.
437 bool WalkUpFromType(Type *T) { return getDerived().VisitType(T); }
438 bool VisitType(Type *T) { return true; }
439 #define TYPE(CLASS, BASE) \
440 bool WalkUpFrom##CLASS##Type(CLASS##Type *T) { \
441 TRY_TO(WalkUpFrom##BASE(T)); \
442 TRY_TO(Visit##CLASS##Type(T)); \
445 bool Visit##CLASS##Type(CLASS##Type *T) { return true; }
446 #include "clang/AST/TypeNodes.def"
448 // ---- Methods on TypeLocs ----
449 // FIXME: this currently just calls the matching Type methods
451 // Declare Traverse*() for all concrete TypeLoc classes.
452 #define ABSTRACT_TYPELOC(CLASS, BASE)
453 #define TYPELOC(CLASS, BASE) bool Traverse##CLASS##TypeLoc(CLASS##TypeLoc TL);
454 #include "clang/AST/TypeLocNodes.def"
455 // The above header #undefs ABSTRACT_TYPELOC and TYPELOC upon exit.
457 // Define WalkUpFrom*() and empty Visit*() for all TypeLoc classes.
458 bool WalkUpFromTypeLoc(TypeLoc TL) { return getDerived().VisitTypeLoc(TL); }
459 bool VisitTypeLoc(TypeLoc TL) { return true; }
461 // QualifiedTypeLoc and UnqualTypeLoc are not declared in
462 // TypeNodes.def and thus need to be handled specially.
463 bool WalkUpFromQualifiedTypeLoc(QualifiedTypeLoc TL) {
464 return getDerived().VisitUnqualTypeLoc(TL.getUnqualifiedLoc());
466 bool VisitQualifiedTypeLoc(QualifiedTypeLoc TL) { return true; }
467 bool WalkUpFromUnqualTypeLoc(UnqualTypeLoc TL) {
468 return getDerived().VisitUnqualTypeLoc(TL.getUnqualifiedLoc());
470 bool VisitUnqualTypeLoc(UnqualTypeLoc TL) { return true; }
472 // Note that BASE includes trailing 'Type' which CLASS doesn't.
473 #define TYPE(CLASS, BASE) \
474 bool WalkUpFrom##CLASS##TypeLoc(CLASS##TypeLoc TL) { \
475 TRY_TO(WalkUpFrom##BASE##Loc(TL)); \
476 TRY_TO(Visit##CLASS##TypeLoc(TL)); \
479 bool Visit##CLASS##TypeLoc(CLASS##TypeLoc TL) { return true; }
480 #include "clang/AST/TypeNodes.def"
482 // ---- Methods on Decls ----
484 // Declare Traverse*() for all concrete Decl classes.
485 #define ABSTRACT_DECL(DECL)
486 #define DECL(CLASS, BASE) bool Traverse##CLASS##Decl(CLASS##Decl *D);
487 #include "clang/AST/DeclNodes.inc"
488 // The above header #undefs ABSTRACT_DECL and DECL upon exit.
490 // Define WalkUpFrom*() and empty Visit*() for all Decl classes.
491 bool WalkUpFromDecl(Decl *D) { return getDerived().VisitDecl(D); }
492 bool VisitDecl(Decl *D) { return true; }
493 #define DECL(CLASS, BASE) \
494 bool WalkUpFrom##CLASS##Decl(CLASS##Decl *D) { \
495 TRY_TO(WalkUpFrom##BASE(D)); \
496 TRY_TO(Visit##CLASS##Decl(D)); \
499 bool Visit##CLASS##Decl(CLASS##Decl *D) { return true; }
500 #include "clang/AST/DeclNodes.inc"
502 bool canIgnoreChildDeclWhileTraversingDeclContext(const Decl *Child);
505 // These are helper methods used by more than one Traverse* method.
506 bool TraverseTemplateParameterListHelper(TemplateParameterList *TPL);
508 // Traverses template parameter lists of either a DeclaratorDecl or TagDecl.
509 template <typename T>
510 bool TraverseDeclTemplateParameterLists(T *D);
512 #define DEF_TRAVERSE_TMPL_INST(TMPLDECLKIND) \
513 bool TraverseTemplateInstantiations(TMPLDECLKIND##TemplateDecl *D);
514 DEF_TRAVERSE_TMPL_INST(Class)
515 DEF_TRAVERSE_TMPL_INST(Var)
516 DEF_TRAVERSE_TMPL_INST(Function)
517 #undef DEF_TRAVERSE_TMPL_INST
518 bool TraverseTemplateArgumentLocsHelper(const TemplateArgumentLoc *TAL,
520 bool TraverseArrayTypeLocHelper(ArrayTypeLoc TL);
521 bool TraverseRecordHelper(RecordDecl *D);
522 bool TraverseCXXRecordHelper(CXXRecordDecl *D);
523 bool TraverseDeclaratorHelper(DeclaratorDecl *D);
524 bool TraverseDeclContextHelper(DeclContext *DC);
525 bool TraverseFunctionHelper(FunctionDecl *D);
526 bool TraverseVarHelper(VarDecl *D);
527 bool TraverseOMPExecutableDirective(OMPExecutableDirective *S);
528 bool TraverseOMPLoopDirective(OMPLoopDirective *S);
529 bool TraverseOMPClause(OMPClause *C);
530 #define OPENMP_CLAUSE(Name, Class) bool Visit##Class(Class *C);
531 #include "clang/Basic/OpenMPKinds.def"
532 /// Process clauses with list of variables.
533 template <typename T> bool VisitOMPClauseList(T *Node);
534 /// Process clauses with pre-initis.
535 bool VisitOMPClauseWithPreInit(OMPClauseWithPreInit *Node);
536 bool VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *Node);
538 bool dataTraverseNode(Stmt *S, DataRecursionQueue *Queue);
539 bool PostVisitStmt(Stmt *S);
542 template <typename Derived>
543 bool RecursiveASTVisitor<Derived>::dataTraverseNode(Stmt *S,
544 DataRecursionQueue *Queue) {
545 #define DISPATCH_STMT(NAME, CLASS, VAR) \
546 return TRAVERSE_STMT_BASE(NAME, CLASS, VAR, Queue);
548 // If we have a binary expr, dispatch to the subcode of the binop. A smart
549 // optimizer (e.g. LLVM) will fold this comparison into the switch stmt
551 if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(S)) {
552 switch (BinOp->getOpcode()) {
553 #define OPERATOR(NAME) \
555 DISPATCH_STMT(Bin##NAME, BinaryOperator, S);
561 #define OPERATOR(NAME) \
562 case BO_##NAME##Assign: \
563 DISPATCH_STMT(Bin##NAME##Assign, CompoundAssignOperator, S);
569 } else if (UnaryOperator *UnOp = dyn_cast<UnaryOperator>(S)) {
570 switch (UnOp->getOpcode()) {
571 #define OPERATOR(NAME) \
573 DISPATCH_STMT(Unary##NAME, UnaryOperator, S);
581 // Top switch stmt: dispatch to TraverseFooStmt for each concrete FooStmt.
582 switch (S->getStmtClass()) {
583 case Stmt::NoStmtClass:
585 #define ABSTRACT_STMT(STMT)
586 #define STMT(CLASS, PARENT) \
587 case Stmt::CLASS##Class: \
588 DISPATCH_STMT(CLASS, CLASS, S);
589 #include "clang/AST/StmtNodes.inc"
597 template <typename Derived>
598 bool RecursiveASTVisitor<Derived>::PostVisitStmt(Stmt *S) {
599 switch (S->getStmtClass()) {
600 case Stmt::NoStmtClass:
602 #define ABSTRACT_STMT(STMT)
603 #define STMT(CLASS, PARENT) \
604 case Stmt::CLASS##Class: \
605 TRY_TO(WalkUpFrom##CLASS(static_cast<CLASS *>(S))); break;
606 #define INITLISTEXPR(CLASS, PARENT) \
607 case Stmt::CLASS##Class: \
609 auto ILE = static_cast<CLASS *>(S); \
610 if (auto Syn = ILE->isSemanticForm() ? ILE->getSyntacticForm() : ILE) \
611 TRY_TO(WalkUpFrom##CLASS(Syn)); \
612 if (auto Sem = ILE->isSemanticForm() ? ILE : ILE->getSemanticForm()) \
613 TRY_TO(WalkUpFrom##CLASS(Sem)); \
616 #include "clang/AST/StmtNodes.inc"
624 template <typename Derived>
625 bool RecursiveASTVisitor<Derived>::TraverseStmt(Stmt *S,
626 DataRecursionQueue *Queue) {
631 Queue->push_back({S, false});
635 SmallVector<llvm::PointerIntPair<Stmt *, 1, bool>, 8> LocalQueue;
636 LocalQueue.push_back({S, false});
638 while (!LocalQueue.empty()) {
639 auto &CurrSAndVisited = LocalQueue.back();
640 Stmt *CurrS = CurrSAndVisited.getPointer();
641 bool Visited = CurrSAndVisited.getInt();
643 LocalQueue.pop_back();
644 TRY_TO(dataTraverseStmtPost(CurrS));
645 if (getDerived().shouldTraversePostOrder()) {
646 TRY_TO(PostVisitStmt(CurrS));
651 if (getDerived().dataTraverseStmtPre(CurrS)) {
652 CurrSAndVisited.setInt(true);
653 size_t N = LocalQueue.size();
654 TRY_TO(dataTraverseNode(CurrS, &LocalQueue));
655 // Process new children in the order they were added.
656 std::reverse(LocalQueue.begin() + N, LocalQueue.end());
658 LocalQueue.pop_back();
665 #define DISPATCH(NAME, CLASS, VAR) \
666 return getDerived().Traverse##NAME(static_cast<CLASS *>(VAR))
668 template <typename Derived>
669 bool RecursiveASTVisitor<Derived>::TraverseType(QualType T) {
673 switch (T->getTypeClass()) {
674 #define ABSTRACT_TYPE(CLASS, BASE)
675 #define TYPE(CLASS, BASE) \
677 DISPATCH(CLASS##Type, CLASS##Type, const_cast<Type *>(T.getTypePtr()));
678 #include "clang/AST/TypeNodes.def"
684 template <typename Derived>
685 bool RecursiveASTVisitor<Derived>::TraverseTypeLoc(TypeLoc TL) {
689 switch (TL.getTypeLocClass()) {
690 #define ABSTRACT_TYPELOC(CLASS, BASE)
691 #define TYPELOC(CLASS, BASE) \
692 case TypeLoc::CLASS: \
693 return getDerived().Traverse##CLASS##TypeLoc(TL.castAs<CLASS##TypeLoc>());
694 #include "clang/AST/TypeLocNodes.def"
700 // Define the Traverse*Attr(Attr* A) methods
701 #define VISITORCLASS RecursiveASTVisitor
702 #include "clang/AST/AttrVisitor.inc"
705 template <typename Derived>
706 bool RecursiveASTVisitor<Derived>::TraverseDecl(Decl *D) {
710 // As a syntax visitor, by default we want to ignore declarations for
711 // implicit declarations (ones not typed explicitly by the user).
712 if (!getDerived().shouldVisitImplicitCode() && D->isImplicit())
715 switch (D->getKind()) {
716 #define ABSTRACT_DECL(DECL)
717 #define DECL(CLASS, BASE) \
719 if (!getDerived().Traverse##CLASS##Decl(static_cast<CLASS##Decl *>(D))) \
722 #include "clang/AST/DeclNodes.inc"
725 // Visit any attributes attached to this declaration.
726 for (auto *I : D->attrs()) {
727 if (!getDerived().TraverseAttr(I))
735 template <typename Derived>
736 bool RecursiveASTVisitor<Derived>::TraverseNestedNameSpecifier(
737 NestedNameSpecifier *NNS) {
741 if (NNS->getPrefix())
742 TRY_TO(TraverseNestedNameSpecifier(NNS->getPrefix()));
744 switch (NNS->getKind()) {
745 case NestedNameSpecifier::Identifier:
746 case NestedNameSpecifier::Namespace:
747 case NestedNameSpecifier::NamespaceAlias:
748 case NestedNameSpecifier::Global:
749 case NestedNameSpecifier::Super:
752 case NestedNameSpecifier::TypeSpec:
753 case NestedNameSpecifier::TypeSpecWithTemplate:
754 TRY_TO(TraverseType(QualType(NNS->getAsType(), 0)));
760 template <typename Derived>
761 bool RecursiveASTVisitor<Derived>::TraverseNestedNameSpecifierLoc(
762 NestedNameSpecifierLoc NNS) {
766 if (NestedNameSpecifierLoc Prefix = NNS.getPrefix())
767 TRY_TO(TraverseNestedNameSpecifierLoc(Prefix));
769 switch (NNS.getNestedNameSpecifier()->getKind()) {
770 case NestedNameSpecifier::Identifier:
771 case NestedNameSpecifier::Namespace:
772 case NestedNameSpecifier::NamespaceAlias:
773 case NestedNameSpecifier::Global:
774 case NestedNameSpecifier::Super:
777 case NestedNameSpecifier::TypeSpec:
778 case NestedNameSpecifier::TypeSpecWithTemplate:
779 TRY_TO(TraverseTypeLoc(NNS.getTypeLoc()));
786 template <typename Derived>
787 bool RecursiveASTVisitor<Derived>::TraverseDeclarationNameInfo(
788 DeclarationNameInfo NameInfo) {
789 switch (NameInfo.getName().getNameKind()) {
790 case DeclarationName::CXXConstructorName:
791 case DeclarationName::CXXDestructorName:
792 case DeclarationName::CXXConversionFunctionName:
793 if (TypeSourceInfo *TSInfo = NameInfo.getNamedTypeInfo())
794 TRY_TO(TraverseTypeLoc(TSInfo->getTypeLoc()));
797 case DeclarationName::CXXDeductionGuideName:
798 TRY_TO(TraverseTemplateName(
799 TemplateName(NameInfo.getName().getCXXDeductionGuideTemplate())));
802 case DeclarationName::Identifier:
803 case DeclarationName::ObjCZeroArgSelector:
804 case DeclarationName::ObjCOneArgSelector:
805 case DeclarationName::ObjCMultiArgSelector:
806 case DeclarationName::CXXOperatorName:
807 case DeclarationName::CXXLiteralOperatorName:
808 case DeclarationName::CXXUsingDirective:
815 template <typename Derived>
816 bool RecursiveASTVisitor<Derived>::TraverseTemplateName(TemplateName Template) {
817 if (DependentTemplateName *DTN = Template.getAsDependentTemplateName())
818 TRY_TO(TraverseNestedNameSpecifier(DTN->getQualifier()));
819 else if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
820 TRY_TO(TraverseNestedNameSpecifier(QTN->getQualifier()));
825 template <typename Derived>
826 bool RecursiveASTVisitor<Derived>::TraverseTemplateArgument(
827 const TemplateArgument &Arg) {
828 switch (Arg.getKind()) {
829 case TemplateArgument::Null:
830 case TemplateArgument::Declaration:
831 case TemplateArgument::Integral:
832 case TemplateArgument::NullPtr:
835 case TemplateArgument::Type:
836 return getDerived().TraverseType(Arg.getAsType());
838 case TemplateArgument::Template:
839 case TemplateArgument::TemplateExpansion:
840 return getDerived().TraverseTemplateName(
841 Arg.getAsTemplateOrTemplatePattern());
843 case TemplateArgument::Expression:
844 return getDerived().TraverseStmt(Arg.getAsExpr());
846 case TemplateArgument::Pack:
847 return getDerived().TraverseTemplateArguments(Arg.pack_begin(),
854 // FIXME: no template name location?
855 // FIXME: no source locations for a template argument pack?
856 template <typename Derived>
857 bool RecursiveASTVisitor<Derived>::TraverseTemplateArgumentLoc(
858 const TemplateArgumentLoc &ArgLoc) {
859 const TemplateArgument &Arg = ArgLoc.getArgument();
861 switch (Arg.getKind()) {
862 case TemplateArgument::Null:
863 case TemplateArgument::Declaration:
864 case TemplateArgument::Integral:
865 case TemplateArgument::NullPtr:
868 case TemplateArgument::Type: {
869 // FIXME: how can TSI ever be NULL?
870 if (TypeSourceInfo *TSI = ArgLoc.getTypeSourceInfo())
871 return getDerived().TraverseTypeLoc(TSI->getTypeLoc());
873 return getDerived().TraverseType(Arg.getAsType());
876 case TemplateArgument::Template:
877 case TemplateArgument::TemplateExpansion:
878 if (ArgLoc.getTemplateQualifierLoc())
879 TRY_TO(getDerived().TraverseNestedNameSpecifierLoc(
880 ArgLoc.getTemplateQualifierLoc()));
881 return getDerived().TraverseTemplateName(
882 Arg.getAsTemplateOrTemplatePattern());
884 case TemplateArgument::Expression:
885 return getDerived().TraverseStmt(ArgLoc.getSourceExpression());
887 case TemplateArgument::Pack:
888 return getDerived().TraverseTemplateArguments(Arg.pack_begin(),
895 template <typename Derived>
896 bool RecursiveASTVisitor<Derived>::TraverseTemplateArguments(
897 const TemplateArgument *Args, unsigned NumArgs) {
898 for (unsigned I = 0; I != NumArgs; ++I) {
899 TRY_TO(TraverseTemplateArgument(Args[I]));
905 template <typename Derived>
906 bool RecursiveASTVisitor<Derived>::TraverseConstructorInitializer(
907 CXXCtorInitializer *Init) {
908 if (TypeSourceInfo *TInfo = Init->getTypeSourceInfo())
909 TRY_TO(TraverseTypeLoc(TInfo->getTypeLoc()));
911 if (Init->isWritten() || getDerived().shouldVisitImplicitCode())
912 TRY_TO(TraverseStmt(Init->getInit()));
917 template <typename Derived>
919 RecursiveASTVisitor<Derived>::TraverseLambdaCapture(LambdaExpr *LE,
920 const LambdaCapture *C,
922 if (LE->isInitCapture(C))
923 TRY_TO(TraverseDecl(C->getCapturedVar()));
925 TRY_TO(TraverseStmt(Init));
929 template <typename Derived>
930 bool RecursiveASTVisitor<Derived>::TraverseLambdaBody(
931 LambdaExpr *LE, DataRecursionQueue *Queue) {
932 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(LE->getBody());
936 // ----------------- Type traversal -----------------
938 // This macro makes available a variable T, the passed-in type.
939 #define DEF_TRAVERSE_TYPE(TYPE, CODE) \
940 template <typename Derived> \
941 bool RecursiveASTVisitor<Derived>::Traverse##TYPE(TYPE *T) { \
942 if (!getDerived().shouldTraversePostOrder()) \
943 TRY_TO(WalkUpFrom##TYPE(T)); \
945 if (getDerived().shouldTraversePostOrder()) \
946 TRY_TO(WalkUpFrom##TYPE(T)); \
950 DEF_TRAVERSE_TYPE(BuiltinType, {})
952 DEF_TRAVERSE_TYPE(ComplexType, { TRY_TO(TraverseType(T->getElementType())); })
954 DEF_TRAVERSE_TYPE(PointerType, { TRY_TO(TraverseType(T->getPointeeType())); })
956 DEF_TRAVERSE_TYPE(BlockPointerType,
957 { TRY_TO(TraverseType(T->getPointeeType())); })
959 DEF_TRAVERSE_TYPE(LValueReferenceType,
960 { TRY_TO(TraverseType(T->getPointeeType())); })
962 DEF_TRAVERSE_TYPE(RValueReferenceType,
963 { TRY_TO(TraverseType(T->getPointeeType())); })
965 DEF_TRAVERSE_TYPE(MemberPointerType, {
966 TRY_TO(TraverseType(QualType(T->getClass(), 0)));
967 TRY_TO(TraverseType(T->getPointeeType()));
970 DEF_TRAVERSE_TYPE(AdjustedType, { TRY_TO(TraverseType(T->getOriginalType())); })
972 DEF_TRAVERSE_TYPE(DecayedType, { TRY_TO(TraverseType(T->getOriginalType())); })
974 DEF_TRAVERSE_TYPE(ConstantArrayType,
975 { TRY_TO(TraverseType(T->getElementType())); })
977 DEF_TRAVERSE_TYPE(IncompleteArrayType,
978 { TRY_TO(TraverseType(T->getElementType())); })
980 DEF_TRAVERSE_TYPE(VariableArrayType, {
981 TRY_TO(TraverseType(T->getElementType()));
982 TRY_TO(TraverseStmt(T->getSizeExpr()));
985 DEF_TRAVERSE_TYPE(DependentSizedArrayType, {
986 TRY_TO(TraverseType(T->getElementType()));
987 if (T->getSizeExpr())
988 TRY_TO(TraverseStmt(T->getSizeExpr()));
991 DEF_TRAVERSE_TYPE(DependentAddressSpaceType, {
992 TRY_TO(TraverseStmt(T->getAddrSpaceExpr()));
993 TRY_TO(TraverseType(T->getPointeeType()));
996 DEF_TRAVERSE_TYPE(DependentVectorType, {
997 if (T->getSizeExpr())
998 TRY_TO(TraverseStmt(T->getSizeExpr()));
999 TRY_TO(TraverseType(T->getElementType()));
1002 DEF_TRAVERSE_TYPE(DependentSizedExtVectorType, {
1003 if (T->getSizeExpr())
1004 TRY_TO(TraverseStmt(T->getSizeExpr()));
1005 TRY_TO(TraverseType(T->getElementType()));
1008 DEF_TRAVERSE_TYPE(VectorType, { TRY_TO(TraverseType(T->getElementType())); })
1010 DEF_TRAVERSE_TYPE(ExtVectorType, { TRY_TO(TraverseType(T->getElementType())); })
1012 DEF_TRAVERSE_TYPE(FunctionNoProtoType,
1013 { TRY_TO(TraverseType(T->getReturnType())); })
1015 DEF_TRAVERSE_TYPE(FunctionProtoType, {
1016 TRY_TO(TraverseType(T->getReturnType()));
1018 for (const auto &A : T->param_types()) {
1019 TRY_TO(TraverseType(A));
1022 for (const auto &E : T->exceptions()) {
1023 TRY_TO(TraverseType(E));
1026 if (Expr *NE = T->getNoexceptExpr())
1027 TRY_TO(TraverseStmt(NE));
1030 DEF_TRAVERSE_TYPE(UnresolvedUsingType, {})
1031 DEF_TRAVERSE_TYPE(TypedefType, {})
1033 DEF_TRAVERSE_TYPE(TypeOfExprType,
1034 { TRY_TO(TraverseStmt(T->getUnderlyingExpr())); })
1036 DEF_TRAVERSE_TYPE(TypeOfType, { TRY_TO(TraverseType(T->getUnderlyingType())); })
1038 DEF_TRAVERSE_TYPE(DecltypeType,
1039 { TRY_TO(TraverseStmt(T->getUnderlyingExpr())); })
1041 DEF_TRAVERSE_TYPE(UnaryTransformType, {
1042 TRY_TO(TraverseType(T->getBaseType()));
1043 TRY_TO(TraverseType(T->getUnderlyingType()));
1046 DEF_TRAVERSE_TYPE(AutoType, { TRY_TO(TraverseType(T->getDeducedType())); })
1047 DEF_TRAVERSE_TYPE(DeducedTemplateSpecializationType, {
1048 TRY_TO(TraverseTemplateName(T->getTemplateName()));
1049 TRY_TO(TraverseType(T->getDeducedType()));
1052 DEF_TRAVERSE_TYPE(RecordType, {})
1053 DEF_TRAVERSE_TYPE(EnumType, {})
1054 DEF_TRAVERSE_TYPE(TemplateTypeParmType, {})
1055 DEF_TRAVERSE_TYPE(SubstTemplateTypeParmType, {
1056 TRY_TO(TraverseType(T->getReplacementType()));
1058 DEF_TRAVERSE_TYPE(SubstTemplateTypeParmPackType, {
1059 TRY_TO(TraverseTemplateArgument(T->getArgumentPack()));
1062 DEF_TRAVERSE_TYPE(TemplateSpecializationType, {
1063 TRY_TO(TraverseTemplateName(T->getTemplateName()));
1064 TRY_TO(TraverseTemplateArguments(T->getArgs(), T->getNumArgs()));
1067 DEF_TRAVERSE_TYPE(InjectedClassNameType, {})
1069 DEF_TRAVERSE_TYPE(AttributedType,
1070 { TRY_TO(TraverseType(T->getModifiedType())); })
1072 DEF_TRAVERSE_TYPE(ParenType, { TRY_TO(TraverseType(T->getInnerType())); })
1074 DEF_TRAVERSE_TYPE(ElaboratedType, {
1075 if (T->getQualifier()) {
1076 TRY_TO(TraverseNestedNameSpecifier(T->getQualifier()));
1078 TRY_TO(TraverseType(T->getNamedType()));
1081 DEF_TRAVERSE_TYPE(DependentNameType,
1082 { TRY_TO(TraverseNestedNameSpecifier(T->getQualifier())); })
1084 DEF_TRAVERSE_TYPE(DependentTemplateSpecializationType, {
1085 TRY_TO(TraverseNestedNameSpecifier(T->getQualifier()));
1086 TRY_TO(TraverseTemplateArguments(T->getArgs(), T->getNumArgs()));
1089 DEF_TRAVERSE_TYPE(PackExpansionType, { TRY_TO(TraverseType(T->getPattern())); })
1091 DEF_TRAVERSE_TYPE(ObjCTypeParamType, {})
1093 DEF_TRAVERSE_TYPE(ObjCInterfaceType, {})
1095 DEF_TRAVERSE_TYPE(ObjCObjectType, {
1096 // We have to watch out here because an ObjCInterfaceType's base
1098 if (T->getBaseType().getTypePtr() != T)
1099 TRY_TO(TraverseType(T->getBaseType()));
1100 for (auto typeArg : T->getTypeArgsAsWritten()) {
1101 TRY_TO(TraverseType(typeArg));
1105 DEF_TRAVERSE_TYPE(ObjCObjectPointerType,
1106 { TRY_TO(TraverseType(T->getPointeeType())); })
1108 DEF_TRAVERSE_TYPE(AtomicType, { TRY_TO(TraverseType(T->getValueType())); })
1110 DEF_TRAVERSE_TYPE(PipeType, { TRY_TO(TraverseType(T->getElementType())); })
1112 #undef DEF_TRAVERSE_TYPE
1114 // ----------------- TypeLoc traversal -----------------
1116 // This macro makes available a variable TL, the passed-in TypeLoc.
1117 // If requested, it calls WalkUpFrom* for the Type in the given TypeLoc,
1118 // in addition to WalkUpFrom* for the TypeLoc itself, such that existing
1119 // clients that override the WalkUpFrom*Type() and/or Visit*Type() methods
1120 // continue to work.
1121 #define DEF_TRAVERSE_TYPELOC(TYPE, CODE) \
1122 template <typename Derived> \
1123 bool RecursiveASTVisitor<Derived>::Traverse##TYPE##Loc(TYPE##Loc TL) { \
1124 if (getDerived().shouldWalkTypesOfTypeLocs()) \
1125 TRY_TO(WalkUpFrom##TYPE(const_cast<TYPE *>(TL.getTypePtr()))); \
1126 TRY_TO(WalkUpFrom##TYPE##Loc(TL)); \
1131 template <typename Derived>
1133 RecursiveASTVisitor<Derived>::TraverseQualifiedTypeLoc(QualifiedTypeLoc TL) {
1134 // Move this over to the 'main' typeloc tree. Note that this is a
1135 // move -- we pretend that we were really looking at the unqualified
1136 // typeloc all along -- rather than a recursion, so we don't follow
1137 // the normal CRTP plan of going through
1138 // getDerived().TraverseTypeLoc. If we did, we'd be traversing
1139 // twice for the same type (once as a QualifiedTypeLoc version of
1140 // the type, once as an UnqualifiedTypeLoc version of the type),
1141 // which in effect means we'd call VisitTypeLoc twice with the
1142 // 'same' type. This solves that problem, at the cost of never
1143 // seeing the qualified version of the type (unless the client
1144 // subclasses TraverseQualifiedTypeLoc themselves). It's not a
1145 // perfect solution. A perfect solution probably requires making
1146 // QualifiedTypeLoc a wrapper around TypeLoc -- like QualType is a
1147 // wrapper around Type* -- rather than being its own class in the
1149 return TraverseTypeLoc(TL.getUnqualifiedLoc());
1152 DEF_TRAVERSE_TYPELOC(BuiltinType, {})
1154 // FIXME: ComplexTypeLoc is unfinished
1155 DEF_TRAVERSE_TYPELOC(ComplexType, {
1156 TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1159 DEF_TRAVERSE_TYPELOC(PointerType,
1160 { TRY_TO(TraverseTypeLoc(TL.getPointeeLoc())); })
1162 DEF_TRAVERSE_TYPELOC(BlockPointerType,
1163 { TRY_TO(TraverseTypeLoc(TL.getPointeeLoc())); })
1165 DEF_TRAVERSE_TYPELOC(LValueReferenceType,
1166 { TRY_TO(TraverseTypeLoc(TL.getPointeeLoc())); })
1168 DEF_TRAVERSE_TYPELOC(RValueReferenceType,
1169 { TRY_TO(TraverseTypeLoc(TL.getPointeeLoc())); })
1171 // FIXME: location of base class?
1172 // We traverse this in the type case as well, but how is it not reached through
1173 // the pointee type?
1174 DEF_TRAVERSE_TYPELOC(MemberPointerType, {
1175 TRY_TO(TraverseType(QualType(TL.getTypePtr()->getClass(), 0)));
1176 TRY_TO(TraverseTypeLoc(TL.getPointeeLoc()));
1179 DEF_TRAVERSE_TYPELOC(AdjustedType,
1180 { TRY_TO(TraverseTypeLoc(TL.getOriginalLoc())); })
1182 DEF_TRAVERSE_TYPELOC(DecayedType,
1183 { TRY_TO(TraverseTypeLoc(TL.getOriginalLoc())); })
1185 template <typename Derived>
1186 bool RecursiveASTVisitor<Derived>::TraverseArrayTypeLocHelper(ArrayTypeLoc TL) {
1187 // This isn't available for ArrayType, but is for the ArrayTypeLoc.
1188 TRY_TO(TraverseStmt(TL.getSizeExpr()));
1192 DEF_TRAVERSE_TYPELOC(ConstantArrayType, {
1193 TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1194 return TraverseArrayTypeLocHelper(TL);
1197 DEF_TRAVERSE_TYPELOC(IncompleteArrayType, {
1198 TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1199 return TraverseArrayTypeLocHelper(TL);
1202 DEF_TRAVERSE_TYPELOC(VariableArrayType, {
1203 TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1204 return TraverseArrayTypeLocHelper(TL);
1207 DEF_TRAVERSE_TYPELOC(DependentSizedArrayType, {
1208 TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1209 return TraverseArrayTypeLocHelper(TL);
1212 DEF_TRAVERSE_TYPELOC(DependentAddressSpaceType, {
1213 TRY_TO(TraverseStmt(TL.getTypePtr()->getAddrSpaceExpr()));
1214 TRY_TO(TraverseType(TL.getTypePtr()->getPointeeType()));
1217 // FIXME: order? why not size expr first?
1218 // FIXME: base VectorTypeLoc is unfinished
1219 DEF_TRAVERSE_TYPELOC(DependentSizedExtVectorType, {
1220 if (TL.getTypePtr()->getSizeExpr())
1221 TRY_TO(TraverseStmt(TL.getTypePtr()->getSizeExpr()));
1222 TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1225 // FIXME: VectorTypeLoc is unfinished
1226 DEF_TRAVERSE_TYPELOC(VectorType, {
1227 TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1230 DEF_TRAVERSE_TYPELOC(DependentVectorType, {
1231 if (TL.getTypePtr()->getSizeExpr())
1232 TRY_TO(TraverseStmt(TL.getTypePtr()->getSizeExpr()));
1233 TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1236 // FIXME: size and attributes
1237 // FIXME: base VectorTypeLoc is unfinished
1238 DEF_TRAVERSE_TYPELOC(ExtVectorType, {
1239 TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1242 DEF_TRAVERSE_TYPELOC(FunctionNoProtoType,
1243 { TRY_TO(TraverseTypeLoc(TL.getReturnLoc())); })
1245 // FIXME: location of exception specifications (attributes?)
1246 DEF_TRAVERSE_TYPELOC(FunctionProtoType, {
1247 TRY_TO(TraverseTypeLoc(TL.getReturnLoc()));
1249 const FunctionProtoType *T = TL.getTypePtr();
1251 for (unsigned I = 0, E = TL.getNumParams(); I != E; ++I) {
1252 if (TL.getParam(I)) {
1253 TRY_TO(TraverseDecl(TL.getParam(I)));
1254 } else if (I < T->getNumParams()) {
1255 TRY_TO(TraverseType(T->getParamType(I)));
1259 for (const auto &E : T->exceptions()) {
1260 TRY_TO(TraverseType(E));
1263 if (Expr *NE = T->getNoexceptExpr())
1264 TRY_TO(TraverseStmt(NE));
1267 DEF_TRAVERSE_TYPELOC(UnresolvedUsingType, {})
1268 DEF_TRAVERSE_TYPELOC(TypedefType, {})
1270 DEF_TRAVERSE_TYPELOC(TypeOfExprType,
1271 { TRY_TO(TraverseStmt(TL.getUnderlyingExpr())); })
1273 DEF_TRAVERSE_TYPELOC(TypeOfType, {
1274 TRY_TO(TraverseTypeLoc(TL.getUnderlyingTInfo()->getTypeLoc()));
1277 // FIXME: location of underlying expr
1278 DEF_TRAVERSE_TYPELOC(DecltypeType, {
1279 TRY_TO(TraverseStmt(TL.getTypePtr()->getUnderlyingExpr()));
1282 DEF_TRAVERSE_TYPELOC(UnaryTransformType, {
1283 TRY_TO(TraverseTypeLoc(TL.getUnderlyingTInfo()->getTypeLoc()));
1286 DEF_TRAVERSE_TYPELOC(AutoType, {
1287 TRY_TO(TraverseType(TL.getTypePtr()->getDeducedType()));
1290 DEF_TRAVERSE_TYPELOC(DeducedTemplateSpecializationType, {
1291 TRY_TO(TraverseTemplateName(TL.getTypePtr()->getTemplateName()));
1292 TRY_TO(TraverseType(TL.getTypePtr()->getDeducedType()));
1295 DEF_TRAVERSE_TYPELOC(RecordType, {})
1296 DEF_TRAVERSE_TYPELOC(EnumType, {})
1297 DEF_TRAVERSE_TYPELOC(TemplateTypeParmType, {})
1298 DEF_TRAVERSE_TYPELOC(SubstTemplateTypeParmType, {
1299 TRY_TO(TraverseType(TL.getTypePtr()->getReplacementType()));
1301 DEF_TRAVERSE_TYPELOC(SubstTemplateTypeParmPackType, {
1302 TRY_TO(TraverseTemplateArgument(TL.getTypePtr()->getArgumentPack()));
1305 // FIXME: use the loc for the template name?
1306 DEF_TRAVERSE_TYPELOC(TemplateSpecializationType, {
1307 TRY_TO(TraverseTemplateName(TL.getTypePtr()->getTemplateName()));
1308 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I) {
1309 TRY_TO(TraverseTemplateArgumentLoc(TL.getArgLoc(I)));
1313 DEF_TRAVERSE_TYPELOC(InjectedClassNameType, {})
1315 DEF_TRAVERSE_TYPELOC(ParenType, { TRY_TO(TraverseTypeLoc(TL.getInnerLoc())); })
1317 DEF_TRAVERSE_TYPELOC(AttributedType,
1318 { TRY_TO(TraverseTypeLoc(TL.getModifiedLoc())); })
1320 DEF_TRAVERSE_TYPELOC(ElaboratedType, {
1321 if (TL.getQualifierLoc()) {
1322 TRY_TO(TraverseNestedNameSpecifierLoc(TL.getQualifierLoc()));
1324 TRY_TO(TraverseTypeLoc(TL.getNamedTypeLoc()));
1327 DEF_TRAVERSE_TYPELOC(DependentNameType, {
1328 TRY_TO(TraverseNestedNameSpecifierLoc(TL.getQualifierLoc()));
1331 DEF_TRAVERSE_TYPELOC(DependentTemplateSpecializationType, {
1332 if (TL.getQualifierLoc()) {
1333 TRY_TO(TraverseNestedNameSpecifierLoc(TL.getQualifierLoc()));
1336 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I) {
1337 TRY_TO(TraverseTemplateArgumentLoc(TL.getArgLoc(I)));
1341 DEF_TRAVERSE_TYPELOC(PackExpansionType,
1342 { TRY_TO(TraverseTypeLoc(TL.getPatternLoc())); })
1344 DEF_TRAVERSE_TYPELOC(ObjCTypeParamType, {})
1346 DEF_TRAVERSE_TYPELOC(ObjCInterfaceType, {})
1348 DEF_TRAVERSE_TYPELOC(ObjCObjectType, {
1349 // We have to watch out here because an ObjCInterfaceType's base
1351 if (TL.getTypePtr()->getBaseType().getTypePtr() != TL.getTypePtr())
1352 TRY_TO(TraverseTypeLoc(TL.getBaseLoc()));
1353 for (unsigned i = 0, n = TL.getNumTypeArgs(); i != n; ++i)
1354 TRY_TO(TraverseTypeLoc(TL.getTypeArgTInfo(i)->getTypeLoc()));
1357 DEF_TRAVERSE_TYPELOC(ObjCObjectPointerType,
1358 { TRY_TO(TraverseTypeLoc(TL.getPointeeLoc())); })
1360 DEF_TRAVERSE_TYPELOC(AtomicType, { TRY_TO(TraverseTypeLoc(TL.getValueLoc())); })
1362 DEF_TRAVERSE_TYPELOC(PipeType, { TRY_TO(TraverseTypeLoc(TL.getValueLoc())); })
1364 #undef DEF_TRAVERSE_TYPELOC
1366 // ----------------- Decl traversal -----------------
1368 // For a Decl, we automate (in the DEF_TRAVERSE_DECL macro) traversing
1369 // the children that come from the DeclContext associated with it.
1370 // Therefore each Traverse* only needs to worry about children other
1373 template <typename Derived>
1374 bool RecursiveASTVisitor<Derived>::canIgnoreChildDeclWhileTraversingDeclContext(
1375 const Decl *Child) {
1376 // BlockDecls and CapturedDecls are traversed through BlockExprs and
1377 // CapturedStmts respectively.
1378 return isa<BlockDecl>(Child) || isa<CapturedDecl>(Child);
1381 template <typename Derived>
1382 bool RecursiveASTVisitor<Derived>::TraverseDeclContextHelper(DeclContext *DC) {
1386 for (auto *Child : DC->decls()) {
1387 if (!canIgnoreChildDeclWhileTraversingDeclContext(Child))
1388 TRY_TO(TraverseDecl(Child));
1394 // This macro makes available a variable D, the passed-in decl.
1395 #define DEF_TRAVERSE_DECL(DECL, CODE) \
1396 template <typename Derived> \
1397 bool RecursiveASTVisitor<Derived>::Traverse##DECL(DECL *D) { \
1398 bool ShouldVisitChildren = true; \
1399 bool ReturnValue = true; \
1400 if (!getDerived().shouldTraversePostOrder()) \
1401 TRY_TO(WalkUpFrom##DECL(D)); \
1403 if (ReturnValue && ShouldVisitChildren) \
1404 TRY_TO(TraverseDeclContextHelper(dyn_cast<DeclContext>(D))); \
1405 if (ReturnValue && getDerived().shouldTraversePostOrder()) \
1406 TRY_TO(WalkUpFrom##DECL(D)); \
1407 return ReturnValue; \
1410 DEF_TRAVERSE_DECL(AccessSpecDecl, {})
1412 DEF_TRAVERSE_DECL(BlockDecl, {
1413 if (TypeSourceInfo *TInfo = D->getSignatureAsWritten())
1414 TRY_TO(TraverseTypeLoc(TInfo->getTypeLoc()));
1415 TRY_TO(TraverseStmt(D->getBody()));
1416 for (const auto &I : D->captures()) {
1417 if (I.hasCopyExpr()) {
1418 TRY_TO(TraverseStmt(I.getCopyExpr()));
1421 ShouldVisitChildren = false;
1424 DEF_TRAVERSE_DECL(CapturedDecl, {
1425 TRY_TO(TraverseStmt(D->getBody()));
1426 ShouldVisitChildren = false;
1429 DEF_TRAVERSE_DECL(EmptyDecl, {})
1431 DEF_TRAVERSE_DECL(FileScopeAsmDecl,
1432 { TRY_TO(TraverseStmt(D->getAsmString())); })
1434 DEF_TRAVERSE_DECL(ImportDecl, {})
1436 DEF_TRAVERSE_DECL(FriendDecl, {
1437 // Friend is either decl or a type.
1438 if (D->getFriendType())
1439 TRY_TO(TraverseTypeLoc(D->getFriendType()->getTypeLoc()));
1441 TRY_TO(TraverseDecl(D->getFriendDecl()));
1444 DEF_TRAVERSE_DECL(FriendTemplateDecl, {
1445 if (D->getFriendType())
1446 TRY_TO(TraverseTypeLoc(D->getFriendType()->getTypeLoc()));
1448 TRY_TO(TraverseDecl(D->getFriendDecl()));
1449 for (unsigned I = 0, E = D->getNumTemplateParameters(); I < E; ++I) {
1450 TemplateParameterList *TPL = D->getTemplateParameterList(I);
1451 for (TemplateParameterList::iterator ITPL = TPL->begin(), ETPL = TPL->end();
1452 ITPL != ETPL; ++ITPL) {
1453 TRY_TO(TraverseDecl(*ITPL));
1458 DEF_TRAVERSE_DECL(ClassScopeFunctionSpecializationDecl, {
1459 TRY_TO(TraverseDecl(D->getSpecialization()));
1461 if (D->hasExplicitTemplateArgs()) {
1462 const TemplateArgumentListInfo &args = D->templateArgs();
1463 TRY_TO(TraverseTemplateArgumentLocsHelper(args.getArgumentArray(),
1468 DEF_TRAVERSE_DECL(LinkageSpecDecl, {})
1470 DEF_TRAVERSE_DECL(ExportDecl, {})
1472 DEF_TRAVERSE_DECL(ObjCPropertyImplDecl, {// FIXME: implement this
1475 DEF_TRAVERSE_DECL(StaticAssertDecl, {
1476 TRY_TO(TraverseStmt(D->getAssertExpr()));
1477 TRY_TO(TraverseStmt(D->getMessage()));
1481 TranslationUnitDecl,
1482 {// Code in an unnamed namespace shows up automatically in
1483 // decls_begin()/decls_end(). Thus we don't need to recurse on
1484 // D->getAnonymousNamespace().
1487 DEF_TRAVERSE_DECL(PragmaCommentDecl, {})
1489 DEF_TRAVERSE_DECL(PragmaDetectMismatchDecl, {})
1491 DEF_TRAVERSE_DECL(ExternCContextDecl, {})
1493 DEF_TRAVERSE_DECL(NamespaceAliasDecl, {
1494 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1496 // We shouldn't traverse an aliased namespace, since it will be
1497 // defined (and, therefore, traversed) somewhere else.
1498 ShouldVisitChildren = false;
1501 DEF_TRAVERSE_DECL(LabelDecl, {// There is no code in a LabelDecl.
1506 {// Code in an unnamed namespace shows up automatically in
1507 // decls_begin()/decls_end(). Thus we don't need to recurse on
1508 // D->getAnonymousNamespace().
1511 DEF_TRAVERSE_DECL(ObjCCompatibleAliasDecl, {// FIXME: implement
1514 DEF_TRAVERSE_DECL(ObjCCategoryDecl, {// FIXME: implement
1515 if (ObjCTypeParamList *typeParamList = D->getTypeParamList()) {
1516 for (auto typeParam : *typeParamList) {
1517 TRY_TO(TraverseObjCTypeParamDecl(typeParam));
1522 DEF_TRAVERSE_DECL(ObjCCategoryImplDecl, {// FIXME: implement
1525 DEF_TRAVERSE_DECL(ObjCImplementationDecl, {// FIXME: implement
1528 DEF_TRAVERSE_DECL(ObjCInterfaceDecl, {// FIXME: implement
1529 if (ObjCTypeParamList *typeParamList = D->getTypeParamListAsWritten()) {
1530 for (auto typeParam : *typeParamList) {
1531 TRY_TO(TraverseObjCTypeParamDecl(typeParam));
1535 if (TypeSourceInfo *superTInfo = D->getSuperClassTInfo()) {
1536 TRY_TO(TraverseTypeLoc(superTInfo->getTypeLoc()));
1540 DEF_TRAVERSE_DECL(ObjCProtocolDecl, {// FIXME: implement
1543 DEF_TRAVERSE_DECL(ObjCMethodDecl, {
1544 if (D->getReturnTypeSourceInfo()) {
1545 TRY_TO(TraverseTypeLoc(D->getReturnTypeSourceInfo()->getTypeLoc()));
1547 for (ParmVarDecl *Parameter : D->parameters()) {
1548 TRY_TO(TraverseDecl(Parameter));
1550 if (D->isThisDeclarationADefinition()) {
1551 TRY_TO(TraverseStmt(D->getBody()));
1553 ShouldVisitChildren = false;
1556 DEF_TRAVERSE_DECL(ObjCTypeParamDecl, {
1557 if (D->hasExplicitBound()) {
1558 TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1559 // We shouldn't traverse D->getTypeForDecl(); it's a result of
1560 // declaring the type alias, not something that was written in the
1565 DEF_TRAVERSE_DECL(ObjCPropertyDecl, {
1566 if (D->getTypeSourceInfo())
1567 TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1569 TRY_TO(TraverseType(D->getType()));
1570 ShouldVisitChildren = false;
1573 DEF_TRAVERSE_DECL(UsingDecl, {
1574 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1575 TRY_TO(TraverseDeclarationNameInfo(D->getNameInfo()));
1578 DEF_TRAVERSE_DECL(UsingPackDecl, {})
1580 DEF_TRAVERSE_DECL(UsingDirectiveDecl, {
1581 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1584 DEF_TRAVERSE_DECL(UsingShadowDecl, {})
1586 DEF_TRAVERSE_DECL(ConstructorUsingShadowDecl, {})
1588 DEF_TRAVERSE_DECL(OMPThreadPrivateDecl, {
1589 for (auto *I : D->varlists()) {
1590 TRY_TO(TraverseStmt(I));
1594 DEF_TRAVERSE_DECL(OMPDeclareReductionDecl, {
1595 TRY_TO(TraverseStmt(D->getCombiner()));
1596 if (auto *Initializer = D->getInitializer())
1597 TRY_TO(TraverseStmt(Initializer));
1598 TRY_TO(TraverseType(D->getType()));
1602 DEF_TRAVERSE_DECL(OMPCapturedExprDecl, { TRY_TO(TraverseVarHelper(D)); })
1604 // A helper method for TemplateDecl's children.
1605 template <typename Derived>
1606 bool RecursiveASTVisitor<Derived>::TraverseTemplateParameterListHelper(
1607 TemplateParameterList *TPL) {
1609 for (TemplateParameterList::iterator I = TPL->begin(), E = TPL->end();
1611 TRY_TO(TraverseDecl(*I));
1617 template <typename Derived>
1618 template <typename T>
1619 bool RecursiveASTVisitor<Derived>::TraverseDeclTemplateParameterLists(T *D) {
1620 for (unsigned i = 0; i < D->getNumTemplateParameterLists(); i++) {
1621 TemplateParameterList *TPL = D->getTemplateParameterList(i);
1622 TraverseTemplateParameterListHelper(TPL);
1627 template <typename Derived>
1628 bool RecursiveASTVisitor<Derived>::TraverseTemplateInstantiations(
1629 ClassTemplateDecl *D) {
1630 for (auto *SD : D->specializations()) {
1631 for (auto *RD : SD->redecls()) {
1632 // We don't want to visit injected-class-names in this traversal.
1633 if (cast<CXXRecordDecl>(RD)->isInjectedClassName())
1637 cast<ClassTemplateSpecializationDecl>(RD)->getSpecializationKind()) {
1638 // Visit the implicit instantiations with the requested pattern.
1639 case TSK_Undeclared:
1640 case TSK_ImplicitInstantiation:
1641 TRY_TO(TraverseDecl(RD));
1644 // We don't need to do anything on an explicit instantiation
1645 // or explicit specialization because there will be an explicit
1646 // node for it elsewhere.
1647 case TSK_ExplicitInstantiationDeclaration:
1648 case TSK_ExplicitInstantiationDefinition:
1649 case TSK_ExplicitSpecialization:
1658 template <typename Derived>
1659 bool RecursiveASTVisitor<Derived>::TraverseTemplateInstantiations(
1660 VarTemplateDecl *D) {
1661 for (auto *SD : D->specializations()) {
1662 for (auto *RD : SD->redecls()) {
1664 cast<VarTemplateSpecializationDecl>(RD)->getSpecializationKind()) {
1665 case TSK_Undeclared:
1666 case TSK_ImplicitInstantiation:
1667 TRY_TO(TraverseDecl(RD));
1670 case TSK_ExplicitInstantiationDeclaration:
1671 case TSK_ExplicitInstantiationDefinition:
1672 case TSK_ExplicitSpecialization:
1681 // A helper method for traversing the instantiations of a
1682 // function while skipping its specializations.
1683 template <typename Derived>
1684 bool RecursiveASTVisitor<Derived>::TraverseTemplateInstantiations(
1685 FunctionTemplateDecl *D) {
1686 for (auto *FD : D->specializations()) {
1687 for (auto *RD : FD->redecls()) {
1688 switch (RD->getTemplateSpecializationKind()) {
1689 case TSK_Undeclared:
1690 case TSK_ImplicitInstantiation:
1691 // We don't know what kind of FunctionDecl this is.
1692 TRY_TO(TraverseDecl(RD));
1695 // FIXME: For now traverse explicit instantiations here. Change that
1696 // once they are represented as dedicated nodes in the AST.
1697 case TSK_ExplicitInstantiationDeclaration:
1698 case TSK_ExplicitInstantiationDefinition:
1699 TRY_TO(TraverseDecl(RD));
1702 case TSK_ExplicitSpecialization:
1711 // This macro unifies the traversal of class, variable and function
1712 // template declarations.
1713 #define DEF_TRAVERSE_TMPL_DECL(TMPLDECLKIND) \
1714 DEF_TRAVERSE_DECL(TMPLDECLKIND##TemplateDecl, { \
1715 TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters())); \
1716 TRY_TO(TraverseDecl(D->getTemplatedDecl())); \
1718 /* By default, we do not traverse the instantiations of \
1719 class templates since they do not appear in the user code. The \
1720 following code optionally traverses them. \
1722 We only traverse the class instantiations when we see the canonical \
1723 declaration of the template, to ensure we only visit them once. */ \
1724 if (getDerived().shouldVisitTemplateInstantiations() && \
1725 D == D->getCanonicalDecl()) \
1726 TRY_TO(TraverseTemplateInstantiations(D)); \
1728 /* Note that getInstantiatedFromMemberTemplate() is just a link \
1729 from a template instantiation back to the template from which \
1730 it was instantiated, and thus should not be traversed. */ \
1733 DEF_TRAVERSE_TMPL_DECL(Class)
1734 DEF_TRAVERSE_TMPL_DECL(Var)
1735 DEF_TRAVERSE_TMPL_DECL(Function)
1737 DEF_TRAVERSE_DECL(TemplateTemplateParmDecl, {
1738 // D is the "T" in something like
1739 // template <template <typename> class T> class container { };
1740 TRY_TO(TraverseDecl(D->getTemplatedDecl()));
1741 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited()) {
1742 TRY_TO(TraverseTemplateArgumentLoc(D->getDefaultArgument()));
1744 TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters()));
1747 DEF_TRAVERSE_DECL(BuiltinTemplateDecl, {
1748 TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters()));
1751 DEF_TRAVERSE_DECL(TemplateTypeParmDecl, {
1752 // D is the "T" in something like "template<typename T> class vector;"
1753 if (D->getTypeForDecl())
1754 TRY_TO(TraverseType(QualType(D->getTypeForDecl(), 0)));
1755 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
1756 TRY_TO(TraverseTypeLoc(D->getDefaultArgumentInfo()->getTypeLoc()));
1759 DEF_TRAVERSE_DECL(TypedefDecl, {
1760 TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1761 // We shouldn't traverse D->getTypeForDecl(); it's a result of
1762 // declaring the typedef, not something that was written in the
1766 DEF_TRAVERSE_DECL(TypeAliasDecl, {
1767 TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1768 // We shouldn't traverse D->getTypeForDecl(); it's a result of
1769 // declaring the type alias, not something that was written in the
1773 DEF_TRAVERSE_DECL(TypeAliasTemplateDecl, {
1774 TRY_TO(TraverseDecl(D->getTemplatedDecl()));
1775 TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters()));
1778 DEF_TRAVERSE_DECL(UnresolvedUsingTypenameDecl, {
1779 // A dependent using declaration which was marked with 'typename'.
1780 // template<class T> class A : public B<T> { using typename B<T>::foo; };
1781 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1782 // We shouldn't traverse D->getTypeForDecl(); it's a result of
1783 // declaring the type, not something that was written in the
1787 DEF_TRAVERSE_DECL(EnumDecl, {
1788 TRY_TO(TraverseDeclTemplateParameterLists(D));
1790 if (D->getTypeForDecl())
1791 TRY_TO(TraverseType(QualType(D->getTypeForDecl(), 0)));
1793 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1794 // The enumerators are already traversed by
1795 // decls_begin()/decls_end().
1798 // Helper methods for RecordDecl and its children.
1799 template <typename Derived>
1800 bool RecursiveASTVisitor<Derived>::TraverseRecordHelper(RecordDecl *D) {
1801 // We shouldn't traverse D->getTypeForDecl(); it's a result of
1802 // declaring the type, not something that was written in the source.
1804 TRY_TO(TraverseDeclTemplateParameterLists(D));
1805 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1809 template <typename Derived>
1810 bool RecursiveASTVisitor<Derived>::TraverseCXXBaseSpecifier(
1811 const CXXBaseSpecifier &Base) {
1812 TRY_TO(TraverseTypeLoc(Base.getTypeSourceInfo()->getTypeLoc()));
1816 template <typename Derived>
1817 bool RecursiveASTVisitor<Derived>::TraverseCXXRecordHelper(CXXRecordDecl *D) {
1818 if (!TraverseRecordHelper(D))
1820 if (D->isCompleteDefinition()) {
1821 for (const auto &I : D->bases()) {
1822 TRY_TO(TraverseCXXBaseSpecifier(I));
1824 // We don't traverse the friends or the conversions, as they are
1825 // already in decls_begin()/decls_end().
1830 DEF_TRAVERSE_DECL(RecordDecl, { TRY_TO(TraverseRecordHelper(D)); })
1832 DEF_TRAVERSE_DECL(CXXRecordDecl, { TRY_TO(TraverseCXXRecordHelper(D)); })
1834 #define DEF_TRAVERSE_TMPL_SPEC_DECL(TMPLDECLKIND) \
1835 DEF_TRAVERSE_DECL(TMPLDECLKIND##TemplateSpecializationDecl, { \
1836 /* For implicit instantiations ("set<int> x;"), we don't want to \
1837 recurse at all, since the instatiated template isn't written in \
1838 the source code anywhere. (Note the instatiated *type* -- \
1839 set<int> -- is written, and will still get a callback of \
1840 TemplateSpecializationType). For explicit instantiations \
1841 ("template set<int>;"), we do need a callback, since this \
1842 is the only callback that's made for this instantiation. \
1843 We use getTypeAsWritten() to distinguish. */ \
1844 if (TypeSourceInfo *TSI = D->getTypeAsWritten()) \
1845 TRY_TO(TraverseTypeLoc(TSI->getTypeLoc())); \
1847 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc())); \
1848 if (!getDerived().shouldVisitTemplateInstantiations() && \
1849 D->getTemplateSpecializationKind() != TSK_ExplicitSpecialization) \
1850 /* Returning from here skips traversing the \
1851 declaration context of the *TemplateSpecializationDecl \
1852 (embedded in the DEF_TRAVERSE_DECL() macro) \
1853 which contains the instantiated members of the template. */ \
1857 DEF_TRAVERSE_TMPL_SPEC_DECL(Class)
1858 DEF_TRAVERSE_TMPL_SPEC_DECL(Var)
1860 template <typename Derived>
1861 bool RecursiveASTVisitor<Derived>::TraverseTemplateArgumentLocsHelper(
1862 const TemplateArgumentLoc *TAL, unsigned Count) {
1863 for (unsigned I = 0; I < Count; ++I) {
1864 TRY_TO(TraverseTemplateArgumentLoc(TAL[I]));
1869 #define DEF_TRAVERSE_TMPL_PART_SPEC_DECL(TMPLDECLKIND, DECLKIND) \
1870 DEF_TRAVERSE_DECL(TMPLDECLKIND##TemplatePartialSpecializationDecl, { \
1871 /* The partial specialization. */ \
1872 if (TemplateParameterList *TPL = D->getTemplateParameters()) { \
1873 for (TemplateParameterList::iterator I = TPL->begin(), E = TPL->end(); \
1875 TRY_TO(TraverseDecl(*I)); \
1878 /* The args that remains unspecialized. */ \
1879 TRY_TO(TraverseTemplateArgumentLocsHelper( \
1880 D->getTemplateArgsAsWritten()->getTemplateArgs(), \
1881 D->getTemplateArgsAsWritten()->NumTemplateArgs)); \
1883 /* Don't need the *TemplatePartialSpecializationHelper, even \
1884 though that's our parent class -- we already visit all the \
1885 template args here. */ \
1886 TRY_TO(Traverse##DECLKIND##Helper(D)); \
1888 /* Instantiations will have been visited with the primary template. */ \
1891 DEF_TRAVERSE_TMPL_PART_SPEC_DECL(Class, CXXRecord)
1892 DEF_TRAVERSE_TMPL_PART_SPEC_DECL(Var, Var)
1894 DEF_TRAVERSE_DECL(EnumConstantDecl, { TRY_TO(TraverseStmt(D->getInitExpr())); })
1896 DEF_TRAVERSE_DECL(UnresolvedUsingValueDecl, {
1897 // Like UnresolvedUsingTypenameDecl, but without the 'typename':
1898 // template <class T> Class A : public Base<T> { using Base<T>::foo; };
1899 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1900 TRY_TO(TraverseDeclarationNameInfo(D->getNameInfo()));
1903 DEF_TRAVERSE_DECL(IndirectFieldDecl, {})
1905 template <typename Derived>
1906 bool RecursiveASTVisitor<Derived>::TraverseDeclaratorHelper(DeclaratorDecl *D) {
1907 TRY_TO(TraverseDeclTemplateParameterLists(D));
1908 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1909 if (D->getTypeSourceInfo())
1910 TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1912 TRY_TO(TraverseType(D->getType()));
1916 DEF_TRAVERSE_DECL(DecompositionDecl, {
1917 TRY_TO(TraverseVarHelper(D));
1918 for (auto *Binding : D->bindings()) {
1919 TRY_TO(TraverseDecl(Binding));
1923 DEF_TRAVERSE_DECL(BindingDecl, {
1924 if (getDerived().shouldVisitImplicitCode())
1925 TRY_TO(TraverseStmt(D->getBinding()));
1928 DEF_TRAVERSE_DECL(MSPropertyDecl, { TRY_TO(TraverseDeclaratorHelper(D)); })
1930 DEF_TRAVERSE_DECL(FieldDecl, {
1931 TRY_TO(TraverseDeclaratorHelper(D));
1932 if (D->isBitField())
1933 TRY_TO(TraverseStmt(D->getBitWidth()));
1934 else if (D->hasInClassInitializer())
1935 TRY_TO(TraverseStmt(D->getInClassInitializer()));
1938 DEF_TRAVERSE_DECL(ObjCAtDefsFieldDecl, {
1939 TRY_TO(TraverseDeclaratorHelper(D));
1940 if (D->isBitField())
1941 TRY_TO(TraverseStmt(D->getBitWidth()));
1942 // FIXME: implement the rest.
1945 DEF_TRAVERSE_DECL(ObjCIvarDecl, {
1946 TRY_TO(TraverseDeclaratorHelper(D));
1947 if (D->isBitField())
1948 TRY_TO(TraverseStmt(D->getBitWidth()));
1949 // FIXME: implement the rest.
1952 template <typename Derived>
1953 bool RecursiveASTVisitor<Derived>::TraverseFunctionHelper(FunctionDecl *D) {
1954 TRY_TO(TraverseDeclTemplateParameterLists(D));
1955 TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1956 TRY_TO(TraverseDeclarationNameInfo(D->getNameInfo()));
1958 // If we're an explicit template specialization, iterate over the
1959 // template args that were explicitly specified. If we were doing
1960 // this in typing order, we'd do it between the return type and
1961 // the function args, but both are handled by the FunctionTypeLoc
1962 // above, so we have to choose one side. I've decided to do before.
1963 if (const FunctionTemplateSpecializationInfo *FTSI =
1964 D->getTemplateSpecializationInfo()) {
1965 if (FTSI->getTemplateSpecializationKind() != TSK_Undeclared &&
1966 FTSI->getTemplateSpecializationKind() != TSK_ImplicitInstantiation) {
1967 // A specialization might not have explicit template arguments if it has
1968 // a templated return type and concrete arguments.
1969 if (const ASTTemplateArgumentListInfo *TALI =
1970 FTSI->TemplateArgumentsAsWritten) {
1971 TRY_TO(TraverseTemplateArgumentLocsHelper(TALI->getTemplateArgs(),
1972 TALI->NumTemplateArgs));
1977 // Visit the function type itself, which can be either
1978 // FunctionNoProtoType or FunctionProtoType, or a typedef. This
1979 // also covers the return type and the function parameters,
1980 // including exception specifications.
1981 if (TypeSourceInfo *TSI = D->getTypeSourceInfo()) {
1982 TRY_TO(TraverseTypeLoc(TSI->getTypeLoc()));
1983 } else if (getDerived().shouldVisitImplicitCode()) {
1984 // Visit parameter variable declarations of the implicit function
1985 // if the traverser is visiting implicit code. Parameter variable
1986 // declarations do not have valid TypeSourceInfo, so to visit them
1987 // we need to traverse the declarations explicitly.
1988 for (ParmVarDecl *Parameter : D->parameters()) {
1989 TRY_TO(TraverseDecl(Parameter));
1993 if (CXXConstructorDecl *Ctor = dyn_cast<CXXConstructorDecl>(D)) {
1994 // Constructor initializers.
1995 for (auto *I : Ctor->inits()) {
1996 TRY_TO(TraverseConstructorInitializer(I));
2000 if (D->isThisDeclarationADefinition()) {
2001 TRY_TO(TraverseStmt(D->getBody())); // Function body.
2006 DEF_TRAVERSE_DECL(FunctionDecl, {
2007 // We skip decls_begin/decls_end, which are already covered by
2008 // TraverseFunctionHelper().
2009 ShouldVisitChildren = false;
2010 ReturnValue = TraverseFunctionHelper(D);
2013 DEF_TRAVERSE_DECL(CXXDeductionGuideDecl, {
2014 // We skip decls_begin/decls_end, which are already covered by
2015 // TraverseFunctionHelper().
2016 ShouldVisitChildren = false;
2017 ReturnValue = TraverseFunctionHelper(D);
2020 DEF_TRAVERSE_DECL(CXXMethodDecl, {
2021 // We skip decls_begin/decls_end, which are already covered by
2022 // TraverseFunctionHelper().
2023 ShouldVisitChildren = false;
2024 ReturnValue = TraverseFunctionHelper(D);
2027 DEF_TRAVERSE_DECL(CXXConstructorDecl, {
2028 // We skip decls_begin/decls_end, which are already covered by
2029 // TraverseFunctionHelper().
2030 ShouldVisitChildren = false;
2031 ReturnValue = TraverseFunctionHelper(D);
2034 // CXXConversionDecl is the declaration of a type conversion operator.
2035 // It's not a cast expression.
2036 DEF_TRAVERSE_DECL(CXXConversionDecl, {
2037 // We skip decls_begin/decls_end, which are already covered by
2038 // TraverseFunctionHelper().
2039 ShouldVisitChildren = false;
2040 ReturnValue = TraverseFunctionHelper(D);
2043 DEF_TRAVERSE_DECL(CXXDestructorDecl, {
2044 // We skip decls_begin/decls_end, which are already covered by
2045 // TraverseFunctionHelper().
2046 ShouldVisitChildren = false;
2047 ReturnValue = TraverseFunctionHelper(D);
2050 template <typename Derived>
2051 bool RecursiveASTVisitor<Derived>::TraverseVarHelper(VarDecl *D) {
2052 TRY_TO(TraverseDeclaratorHelper(D));
2053 // Default params are taken care of when we traverse the ParmVarDecl.
2054 if (!isa<ParmVarDecl>(D) &&
2055 (!D->isCXXForRangeDecl() || getDerived().shouldVisitImplicitCode()))
2056 TRY_TO(TraverseStmt(D->getInit()));
2060 DEF_TRAVERSE_DECL(VarDecl, { TRY_TO(TraverseVarHelper(D)); })
2062 DEF_TRAVERSE_DECL(ImplicitParamDecl, { TRY_TO(TraverseVarHelper(D)); })
2064 DEF_TRAVERSE_DECL(NonTypeTemplateParmDecl, {
2065 // A non-type template parameter, e.g. "S" in template<int S> class Foo ...
2066 TRY_TO(TraverseDeclaratorHelper(D));
2067 if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
2068 TRY_TO(TraverseStmt(D->getDefaultArgument()));
2071 DEF_TRAVERSE_DECL(ParmVarDecl, {
2072 TRY_TO(TraverseVarHelper(D));
2074 if (D->hasDefaultArg() && D->hasUninstantiatedDefaultArg() &&
2075 !D->hasUnparsedDefaultArg())
2076 TRY_TO(TraverseStmt(D->getUninstantiatedDefaultArg()));
2078 if (D->hasDefaultArg() && !D->hasUninstantiatedDefaultArg() &&
2079 !D->hasUnparsedDefaultArg())
2080 TRY_TO(TraverseStmt(D->getDefaultArg()));
2083 #undef DEF_TRAVERSE_DECL
2085 // ----------------- Stmt traversal -----------------
2087 // For stmts, we automate (in the DEF_TRAVERSE_STMT macro) iterating
2088 // over the children defined in children() (every stmt defines these,
2089 // though sometimes the range is empty). Each individual Traverse*
2090 // method only needs to worry about children other than those. To see
2091 // what children() does for a given class, see, e.g.,
2092 // http://clang.llvm.org/doxygen/Stmt_8cpp_source.html
2094 // This macro makes available a variable S, the passed-in stmt.
2095 #define DEF_TRAVERSE_STMT(STMT, CODE) \
2096 template <typename Derived> \
2097 bool RecursiveASTVisitor<Derived>::Traverse##STMT( \
2098 STMT *S, DataRecursionQueue *Queue) { \
2099 bool ShouldVisitChildren = true; \
2100 bool ReturnValue = true; \
2101 if (!getDerived().shouldTraversePostOrder()) \
2102 TRY_TO(WalkUpFrom##STMT(S)); \
2104 if (ShouldVisitChildren) { \
2105 for (Stmt * SubStmt : getDerived().getStmtChildren(S)) { \
2106 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(SubStmt); \
2109 if (!Queue && ReturnValue && getDerived().shouldTraversePostOrder()) \
2110 TRY_TO(WalkUpFrom##STMT(S)); \
2111 return ReturnValue; \
2114 DEF_TRAVERSE_STMT(GCCAsmStmt, {
2115 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getAsmString());
2116 for (unsigned I = 0, E = S->getNumInputs(); I < E; ++I) {
2117 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getInputConstraintLiteral(I));
2119 for (unsigned I = 0, E = S->getNumOutputs(); I < E; ++I) {
2120 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getOutputConstraintLiteral(I));
2122 for (unsigned I = 0, E = S->getNumClobbers(); I < E; ++I) {
2123 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getClobberStringLiteral(I));
2125 // children() iterates over inputExpr and outputExpr.
2130 {// FIXME: MS Asm doesn't currently parse Constraints, Clobbers, etc. Once
2131 // added this needs to be implemented.
2134 DEF_TRAVERSE_STMT(CXXCatchStmt, {
2135 TRY_TO(TraverseDecl(S->getExceptionDecl()));
2136 // children() iterates over the handler block.
2139 DEF_TRAVERSE_STMT(DeclStmt, {
2140 for (auto *I : S->decls()) {
2141 TRY_TO(TraverseDecl(I));
2143 // Suppress the default iteration over children() by
2144 // returning. Here's why: A DeclStmt looks like 'type var [=
2145 // initializer]'. The decls above already traverse over the
2146 // initializers, so we don't have to do it again (which
2147 // children() would do).
2148 ShouldVisitChildren = false;
2151 // These non-expr stmts (most of them), do not need any action except
2152 // iterating over the children.
2153 DEF_TRAVERSE_STMT(BreakStmt, {})
2154 DEF_TRAVERSE_STMT(CXXTryStmt, {})
2155 DEF_TRAVERSE_STMT(CaseStmt, {})
2156 DEF_TRAVERSE_STMT(CompoundStmt, {})
2157 DEF_TRAVERSE_STMT(ContinueStmt, {})
2158 DEF_TRAVERSE_STMT(DefaultStmt, {})
2159 DEF_TRAVERSE_STMT(DoStmt, {})
2160 DEF_TRAVERSE_STMT(ForStmt, {})
2161 DEF_TRAVERSE_STMT(GotoStmt, {})
2162 DEF_TRAVERSE_STMT(IfStmt, {})
2163 DEF_TRAVERSE_STMT(IndirectGotoStmt, {})
2164 DEF_TRAVERSE_STMT(LabelStmt, {})
2165 DEF_TRAVERSE_STMT(AttributedStmt, {})
2166 DEF_TRAVERSE_STMT(NullStmt, {})
2167 DEF_TRAVERSE_STMT(ObjCAtCatchStmt, {})
2168 DEF_TRAVERSE_STMT(ObjCAtFinallyStmt, {})
2169 DEF_TRAVERSE_STMT(ObjCAtSynchronizedStmt, {})
2170 DEF_TRAVERSE_STMT(ObjCAtThrowStmt, {})
2171 DEF_TRAVERSE_STMT(ObjCAtTryStmt, {})
2172 DEF_TRAVERSE_STMT(ObjCForCollectionStmt, {})
2173 DEF_TRAVERSE_STMT(ObjCAutoreleasePoolStmt, {})
2175 DEF_TRAVERSE_STMT(CXXForRangeStmt, {
2176 if (!getDerived().shouldVisitImplicitCode()) {
2177 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getLoopVarStmt());
2178 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getRangeInit());
2179 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getBody());
2180 // Visit everything else only if shouldVisitImplicitCode().
2181 ShouldVisitChildren = false;
2185 DEF_TRAVERSE_STMT(MSDependentExistsStmt, {
2186 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2187 TRY_TO(TraverseDeclarationNameInfo(S->getNameInfo()));
2190 DEF_TRAVERSE_STMT(ReturnStmt, {})
2191 DEF_TRAVERSE_STMT(SwitchStmt, {})
2192 DEF_TRAVERSE_STMT(WhileStmt, {})
2194 DEF_TRAVERSE_STMT(CXXDependentScopeMemberExpr, {
2195 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2196 TRY_TO(TraverseDeclarationNameInfo(S->getMemberNameInfo()));
2197 if (S->hasExplicitTemplateArgs()) {
2198 TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2199 S->getNumTemplateArgs()));
2203 DEF_TRAVERSE_STMT(DeclRefExpr, {
2204 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2205 TRY_TO(TraverseDeclarationNameInfo(S->getNameInfo()));
2206 TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2207 S->getNumTemplateArgs()));
2210 DEF_TRAVERSE_STMT(DependentScopeDeclRefExpr, {
2211 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2212 TRY_TO(TraverseDeclarationNameInfo(S->getNameInfo()));
2213 if (S->hasExplicitTemplateArgs()) {
2214 TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2215 S->getNumTemplateArgs()));
2219 DEF_TRAVERSE_STMT(MemberExpr, {
2220 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2221 TRY_TO(TraverseDeclarationNameInfo(S->getMemberNameInfo()));
2222 TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2223 S->getNumTemplateArgs()));
2228 {// We don't traverse the cast type, as it's not written in the
2232 DEF_TRAVERSE_STMT(CStyleCastExpr, {
2233 TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2236 DEF_TRAVERSE_STMT(CXXFunctionalCastExpr, {
2237 TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2240 DEF_TRAVERSE_STMT(CXXConstCastExpr, {
2241 TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2244 DEF_TRAVERSE_STMT(CXXDynamicCastExpr, {
2245 TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2248 DEF_TRAVERSE_STMT(CXXReinterpretCastExpr, {
2249 TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2252 DEF_TRAVERSE_STMT(CXXStaticCastExpr, {
2253 TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2256 template <typename Derived>
2257 bool RecursiveASTVisitor<Derived>::TraverseSynOrSemInitListExpr(
2258 InitListExpr *S, DataRecursionQueue *Queue) {
2260 // Skip this if we traverse postorder. We will visit it later
2261 // in PostVisitStmt.
2262 if (!getDerived().shouldTraversePostOrder())
2263 TRY_TO(WalkUpFromInitListExpr(S));
2265 // All we need are the default actions. FIXME: use a helper function.
2266 for (Stmt *SubStmt : S->children()) {
2267 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(SubStmt);
2273 // This method is called once for each pair of syntactic and semantic
2274 // InitListExpr, and it traverses the subtrees defined by the two forms. This
2275 // may cause some of the children to be visited twice, if they appear both in
2276 // the syntactic and the semantic form.
2278 // There is no guarantee about which form \p S takes when this method is called.
2279 template <typename Derived>
2280 bool RecursiveASTVisitor<Derived>::TraverseInitListExpr(
2281 InitListExpr *S, DataRecursionQueue *Queue) {
2282 TRY_TO(TraverseSynOrSemInitListExpr(
2283 S->isSemanticForm() ? S->getSyntacticForm() : S, Queue));
2284 TRY_TO(TraverseSynOrSemInitListExpr(
2285 S->isSemanticForm() ? S : S->getSemanticForm(), Queue));
2289 // GenericSelectionExpr is a special case because the types and expressions
2290 // are interleaved. We also need to watch out for null types (default
2291 // generic associations).
2292 DEF_TRAVERSE_STMT(GenericSelectionExpr, {
2293 TRY_TO(TraverseStmt(S->getControllingExpr()));
2294 for (unsigned i = 0; i != S->getNumAssocs(); ++i) {
2295 if (TypeSourceInfo *TS = S->getAssocTypeSourceInfo(i))
2296 TRY_TO(TraverseTypeLoc(TS->getTypeLoc()));
2297 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getAssocExpr(i));
2299 ShouldVisitChildren = false;
2302 // PseudoObjectExpr is a special case because of the weirdness with
2303 // syntactic expressions and opaque values.
2304 DEF_TRAVERSE_STMT(PseudoObjectExpr, {
2305 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getSyntacticForm());
2306 for (PseudoObjectExpr::semantics_iterator i = S->semantics_begin(),
2307 e = S->semantics_end();
2310 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(sub))
2311 sub = OVE->getSourceExpr();
2312 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(sub);
2314 ShouldVisitChildren = false;
2317 DEF_TRAVERSE_STMT(CXXScalarValueInitExpr, {
2318 // This is called for code like 'return T()' where T is a built-in
2319 // (i.e. non-class) type.
2320 TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2323 DEF_TRAVERSE_STMT(CXXNewExpr, {
2324 // The child-iterator will pick up the other arguments.
2325 TRY_TO(TraverseTypeLoc(S->getAllocatedTypeSourceInfo()->getTypeLoc()));
2328 DEF_TRAVERSE_STMT(OffsetOfExpr, {
2329 // The child-iterator will pick up the expression representing
2331 // FIMXE: for code like offsetof(Foo, a.b.c), should we get
2332 // making a MemberExpr callbacks for Foo.a, Foo.a.b, and Foo.a.b.c?
2333 TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2336 DEF_TRAVERSE_STMT(UnaryExprOrTypeTraitExpr, {
2337 // The child-iterator will pick up the arg if it's an expression,
2338 // but not if it's a type.
2339 if (S->isArgumentType())
2340 TRY_TO(TraverseTypeLoc(S->getArgumentTypeInfo()->getTypeLoc()));
2343 DEF_TRAVERSE_STMT(CXXTypeidExpr, {
2344 // The child-iterator will pick up the arg if it's an expression,
2345 // but not if it's a type.
2346 if (S->isTypeOperand())
2347 TRY_TO(TraverseTypeLoc(S->getTypeOperandSourceInfo()->getTypeLoc()));
2350 DEF_TRAVERSE_STMT(MSPropertyRefExpr, {
2351 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2354 DEF_TRAVERSE_STMT(MSPropertySubscriptExpr, {})
2356 DEF_TRAVERSE_STMT(CXXUuidofExpr, {
2357 // The child-iterator will pick up the arg if it's an expression,
2358 // but not if it's a type.
2359 if (S->isTypeOperand())
2360 TRY_TO(TraverseTypeLoc(S->getTypeOperandSourceInfo()->getTypeLoc()));
2363 DEF_TRAVERSE_STMT(TypeTraitExpr, {
2364 for (unsigned I = 0, N = S->getNumArgs(); I != N; ++I)
2365 TRY_TO(TraverseTypeLoc(S->getArg(I)->getTypeLoc()));
2368 DEF_TRAVERSE_STMT(ArrayTypeTraitExpr, {
2369 TRY_TO(TraverseTypeLoc(S->getQueriedTypeSourceInfo()->getTypeLoc()));
2372 DEF_TRAVERSE_STMT(ExpressionTraitExpr,
2373 { TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getQueriedExpression()); })
2375 DEF_TRAVERSE_STMT(VAArgExpr, {
2376 // The child-iterator will pick up the expression argument.
2377 TRY_TO(TraverseTypeLoc(S->getWrittenTypeInfo()->getTypeLoc()));
2380 DEF_TRAVERSE_STMT(CXXTemporaryObjectExpr, {
2381 // This is called for code like 'return T()' where T is a class type.
2382 TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2385 // Walk only the visible parts of lambda expressions.
2386 DEF_TRAVERSE_STMT(LambdaExpr, {
2387 for (unsigned I = 0, N = S->capture_size(); I != N; ++I) {
2388 const LambdaCapture *C = S->capture_begin() + I;
2389 if (C->isExplicit() || getDerived().shouldVisitImplicitCode()) {
2390 TRY_TO(TraverseLambdaCapture(S, C, S->capture_init_begin()[I]));
2394 TypeLoc TL = S->getCallOperator()->getTypeSourceInfo()->getTypeLoc();
2395 FunctionProtoTypeLoc Proto = TL.getAsAdjusted<FunctionProtoTypeLoc>();
2397 if (S->hasExplicitParameters() && S->hasExplicitResultType()) {
2398 // Visit the whole type.
2399 TRY_TO(TraverseTypeLoc(TL));
2401 if (S->hasExplicitParameters()) {
2402 // Visit parameters.
2403 for (unsigned I = 0, N = Proto.getNumParams(); I != N; ++I) {
2404 TRY_TO(TraverseDecl(Proto.getParam(I)));
2406 } else if (S->hasExplicitResultType()) {
2407 TRY_TO(TraverseTypeLoc(Proto.getReturnLoc()));
2410 auto *T = Proto.getTypePtr();
2411 for (const auto &E : T->exceptions()) {
2412 TRY_TO(TraverseType(E));
2415 if (Expr *NE = T->getNoexceptExpr())
2416 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(NE);
2419 ReturnValue = TRAVERSE_STMT_BASE(LambdaBody, LambdaExpr, S, Queue);
2420 ShouldVisitChildren = false;
2423 DEF_TRAVERSE_STMT(CXXUnresolvedConstructExpr, {
2424 // This is called for code like 'T()', where T is a template argument.
2425 TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2428 // These expressions all might take explicit template arguments.
2429 // We traverse those if so. FIXME: implement these.
2430 DEF_TRAVERSE_STMT(CXXConstructExpr, {})
2431 DEF_TRAVERSE_STMT(CallExpr, {})
2432 DEF_TRAVERSE_STMT(CXXMemberCallExpr, {})
2434 // These exprs (most of them), do not need any action except iterating
2435 // over the children.
2436 DEF_TRAVERSE_STMT(AddrLabelExpr, {})
2437 DEF_TRAVERSE_STMT(ArraySubscriptExpr, {})
2438 DEF_TRAVERSE_STMT(OMPArraySectionExpr, {})
2440 DEF_TRAVERSE_STMT(BlockExpr, {
2441 TRY_TO(TraverseDecl(S->getBlockDecl()));
2442 return true; // no child statements to loop through.
2445 DEF_TRAVERSE_STMT(ChooseExpr, {})
2446 DEF_TRAVERSE_STMT(CompoundLiteralExpr, {
2447 TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2449 DEF_TRAVERSE_STMT(CXXBindTemporaryExpr, {})
2450 DEF_TRAVERSE_STMT(CXXBoolLiteralExpr, {})
2452 DEF_TRAVERSE_STMT(CXXDefaultArgExpr, {
2453 if (getDerived().shouldVisitImplicitCode())
2454 TRY_TO(TraverseStmt(S->getExpr()));
2457 DEF_TRAVERSE_STMT(CXXDefaultInitExpr, {})
2458 DEF_TRAVERSE_STMT(CXXDeleteExpr, {})
2459 DEF_TRAVERSE_STMT(ExprWithCleanups, {})
2460 DEF_TRAVERSE_STMT(CXXInheritedCtorInitExpr, {})
2461 DEF_TRAVERSE_STMT(CXXNullPtrLiteralExpr, {})
2462 DEF_TRAVERSE_STMT(CXXStdInitializerListExpr, {})
2464 DEF_TRAVERSE_STMT(CXXPseudoDestructorExpr, {
2465 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2466 if (TypeSourceInfo *ScopeInfo = S->getScopeTypeInfo())
2467 TRY_TO(TraverseTypeLoc(ScopeInfo->getTypeLoc()));
2468 if (TypeSourceInfo *DestroyedTypeInfo = S->getDestroyedTypeInfo())
2469 TRY_TO(TraverseTypeLoc(DestroyedTypeInfo->getTypeLoc()));
2472 DEF_TRAVERSE_STMT(CXXThisExpr, {})
2473 DEF_TRAVERSE_STMT(CXXThrowExpr, {})
2474 DEF_TRAVERSE_STMT(UserDefinedLiteral, {})
2475 DEF_TRAVERSE_STMT(DesignatedInitExpr, {})
2476 DEF_TRAVERSE_STMT(DesignatedInitUpdateExpr, {})
2477 DEF_TRAVERSE_STMT(ExtVectorElementExpr, {})
2478 DEF_TRAVERSE_STMT(GNUNullExpr, {})
2479 DEF_TRAVERSE_STMT(ImplicitValueInitExpr, {})
2480 DEF_TRAVERSE_STMT(NoInitExpr, {})
2481 DEF_TRAVERSE_STMT(ArrayInitLoopExpr, {
2482 // FIXME: The source expression of the OVE should be listed as
2483 // a child of the ArrayInitLoopExpr.
2484 if (OpaqueValueExpr *OVE = S->getCommonExpr())
2485 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(OVE->getSourceExpr());
2487 DEF_TRAVERSE_STMT(ArrayInitIndexExpr, {})
2488 DEF_TRAVERSE_STMT(ObjCBoolLiteralExpr, {})
2490 DEF_TRAVERSE_STMT(ObjCEncodeExpr, {
2491 if (TypeSourceInfo *TInfo = S->getEncodedTypeSourceInfo())
2492 TRY_TO(TraverseTypeLoc(TInfo->getTypeLoc()));
2495 DEF_TRAVERSE_STMT(ObjCIsaExpr, {})
2496 DEF_TRAVERSE_STMT(ObjCIvarRefExpr, {})
2498 DEF_TRAVERSE_STMT(ObjCMessageExpr, {
2499 if (TypeSourceInfo *TInfo = S->getClassReceiverTypeInfo())
2500 TRY_TO(TraverseTypeLoc(TInfo->getTypeLoc()));
2503 DEF_TRAVERSE_STMT(ObjCPropertyRefExpr, {})
2504 DEF_TRAVERSE_STMT(ObjCSubscriptRefExpr, {})
2505 DEF_TRAVERSE_STMT(ObjCProtocolExpr, {})
2506 DEF_TRAVERSE_STMT(ObjCSelectorExpr, {})
2507 DEF_TRAVERSE_STMT(ObjCIndirectCopyRestoreExpr, {})
2509 DEF_TRAVERSE_STMT(ObjCBridgedCastExpr, {
2510 TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2513 DEF_TRAVERSE_STMT(ObjCAvailabilityCheckExpr, {})
2514 DEF_TRAVERSE_STMT(ParenExpr, {})
2515 DEF_TRAVERSE_STMT(ParenListExpr, {})
2516 DEF_TRAVERSE_STMT(PredefinedExpr, {})
2517 DEF_TRAVERSE_STMT(ShuffleVectorExpr, {})
2518 DEF_TRAVERSE_STMT(ConvertVectorExpr, {})
2519 DEF_TRAVERSE_STMT(StmtExpr, {})
2520 DEF_TRAVERSE_STMT(UnresolvedLookupExpr, {
2521 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2522 if (S->hasExplicitTemplateArgs()) {
2523 TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2524 S->getNumTemplateArgs()));
2528 DEF_TRAVERSE_STMT(UnresolvedMemberExpr, {
2529 TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2530 if (S->hasExplicitTemplateArgs()) {
2531 TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2532 S->getNumTemplateArgs()));
2536 DEF_TRAVERSE_STMT(SEHTryStmt, {})
2537 DEF_TRAVERSE_STMT(SEHExceptStmt, {})
2538 DEF_TRAVERSE_STMT(SEHFinallyStmt, {})
2539 DEF_TRAVERSE_STMT(SEHLeaveStmt, {})
2540 DEF_TRAVERSE_STMT(CapturedStmt, { TRY_TO(TraverseDecl(S->getCapturedDecl())); })
2542 DEF_TRAVERSE_STMT(CXXOperatorCallExpr, {})
2543 DEF_TRAVERSE_STMT(OpaqueValueExpr, {})
2544 DEF_TRAVERSE_STMT(TypoExpr, {})
2545 DEF_TRAVERSE_STMT(CUDAKernelCallExpr, {})
2547 // These operators (all of them) do not need any action except
2548 // iterating over the children.
2549 DEF_TRAVERSE_STMT(BinaryConditionalOperator, {})
2550 DEF_TRAVERSE_STMT(ConditionalOperator, {})
2551 DEF_TRAVERSE_STMT(UnaryOperator, {})
2552 DEF_TRAVERSE_STMT(BinaryOperator, {})
2553 DEF_TRAVERSE_STMT(CompoundAssignOperator, {})
2554 DEF_TRAVERSE_STMT(CXXNoexceptExpr, {})
2555 DEF_TRAVERSE_STMT(PackExpansionExpr, {})
2556 DEF_TRAVERSE_STMT(SizeOfPackExpr, {})
2557 DEF_TRAVERSE_STMT(SubstNonTypeTemplateParmPackExpr, {})
2558 DEF_TRAVERSE_STMT(SubstNonTypeTemplateParmExpr, {})
2559 DEF_TRAVERSE_STMT(FunctionParmPackExpr, {})
2560 DEF_TRAVERSE_STMT(MaterializeTemporaryExpr, {})
2561 DEF_TRAVERSE_STMT(CXXFoldExpr, {})
2562 DEF_TRAVERSE_STMT(AtomicExpr, {})
2564 // For coroutines expressions, traverse either the operand
2565 // as written or the implied calls, depending on what the
2566 // derived class requests.
2567 DEF_TRAVERSE_STMT(CoroutineBodyStmt, {
2568 if (!getDerived().shouldVisitImplicitCode()) {
2569 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getBody());
2570 ShouldVisitChildren = false;
2573 DEF_TRAVERSE_STMT(CoreturnStmt, {
2574 if (!getDerived().shouldVisitImplicitCode()) {
2575 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getOperand());
2576 ShouldVisitChildren = false;
2579 DEF_TRAVERSE_STMT(CoawaitExpr, {
2580 if (!getDerived().shouldVisitImplicitCode()) {
2581 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getOperand());
2582 ShouldVisitChildren = false;
2585 DEF_TRAVERSE_STMT(DependentCoawaitExpr, {
2586 if (!getDerived().shouldVisitImplicitCode()) {
2587 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getOperand());
2588 ShouldVisitChildren = false;
2591 DEF_TRAVERSE_STMT(CoyieldExpr, {
2592 if (!getDerived().shouldVisitImplicitCode()) {
2593 TRY_TO_TRAVERSE_OR_ENQUEUE_STMT(S->getOperand());
2594 ShouldVisitChildren = false;
2598 // These literals (all of them) do not need any action.
2599 DEF_TRAVERSE_STMT(IntegerLiteral, {})
2600 DEF_TRAVERSE_STMT(FixedPointLiteral, {})
2601 DEF_TRAVERSE_STMT(CharacterLiteral, {})
2602 DEF_TRAVERSE_STMT(FloatingLiteral, {})
2603 DEF_TRAVERSE_STMT(ImaginaryLiteral, {})
2604 DEF_TRAVERSE_STMT(StringLiteral, {})
2605 DEF_TRAVERSE_STMT(ObjCStringLiteral, {})
2606 DEF_TRAVERSE_STMT(ObjCBoxedExpr, {})
2607 DEF_TRAVERSE_STMT(ObjCArrayLiteral, {})
2608 DEF_TRAVERSE_STMT(ObjCDictionaryLiteral, {})
2610 // Traverse OpenCL: AsType, Convert.
2611 DEF_TRAVERSE_STMT(AsTypeExpr, {})
2613 // OpenMP directives.
2614 template <typename Derived>
2615 bool RecursiveASTVisitor<Derived>::TraverseOMPExecutableDirective(
2616 OMPExecutableDirective *S) {
2617 for (auto *C : S->clauses()) {
2618 TRY_TO(TraverseOMPClause(C));
2623 template <typename Derived>
2625 RecursiveASTVisitor<Derived>::TraverseOMPLoopDirective(OMPLoopDirective *S) {
2626 return TraverseOMPExecutableDirective(S);
2629 DEF_TRAVERSE_STMT(OMPParallelDirective,
2630 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2632 DEF_TRAVERSE_STMT(OMPSimdDirective,
2633 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2635 DEF_TRAVERSE_STMT(OMPForDirective,
2636 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2638 DEF_TRAVERSE_STMT(OMPForSimdDirective,
2639 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2641 DEF_TRAVERSE_STMT(OMPSectionsDirective,
2642 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2644 DEF_TRAVERSE_STMT(OMPSectionDirective,
2645 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2647 DEF_TRAVERSE_STMT(OMPSingleDirective,
2648 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2650 DEF_TRAVERSE_STMT(OMPMasterDirective,
2651 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2653 DEF_TRAVERSE_STMT(OMPCriticalDirective, {
2654 TRY_TO(TraverseDeclarationNameInfo(S->getDirectiveName()));
2655 TRY_TO(TraverseOMPExecutableDirective(S));
2658 DEF_TRAVERSE_STMT(OMPParallelForDirective,
2659 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2661 DEF_TRAVERSE_STMT(OMPParallelForSimdDirective,
2662 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2664 DEF_TRAVERSE_STMT(OMPParallelSectionsDirective,
2665 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2667 DEF_TRAVERSE_STMT(OMPTaskDirective,
2668 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2670 DEF_TRAVERSE_STMT(OMPTaskyieldDirective,
2671 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2673 DEF_TRAVERSE_STMT(OMPBarrierDirective,
2674 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2676 DEF_TRAVERSE_STMT(OMPTaskwaitDirective,
2677 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2679 DEF_TRAVERSE_STMT(OMPTaskgroupDirective,
2680 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2682 DEF_TRAVERSE_STMT(OMPCancellationPointDirective,
2683 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2685 DEF_TRAVERSE_STMT(OMPCancelDirective,
2686 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2688 DEF_TRAVERSE_STMT(OMPFlushDirective,
2689 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2691 DEF_TRAVERSE_STMT(OMPOrderedDirective,
2692 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2694 DEF_TRAVERSE_STMT(OMPAtomicDirective,
2695 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2697 DEF_TRAVERSE_STMT(OMPTargetDirective,
2698 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2700 DEF_TRAVERSE_STMT(OMPTargetDataDirective,
2701 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2703 DEF_TRAVERSE_STMT(OMPTargetEnterDataDirective,
2704 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2706 DEF_TRAVERSE_STMT(OMPTargetExitDataDirective,
2707 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2709 DEF_TRAVERSE_STMT(OMPTargetParallelDirective,
2710 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2712 DEF_TRAVERSE_STMT(OMPTargetParallelForDirective,
2713 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2715 DEF_TRAVERSE_STMT(OMPTeamsDirective,
2716 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2718 DEF_TRAVERSE_STMT(OMPTargetUpdateDirective,
2719 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2721 DEF_TRAVERSE_STMT(OMPTaskLoopDirective,
2722 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2724 DEF_TRAVERSE_STMT(OMPTaskLoopSimdDirective,
2725 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2727 DEF_TRAVERSE_STMT(OMPDistributeDirective,
2728 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2730 DEF_TRAVERSE_STMT(OMPDistributeParallelForDirective,
2731 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2733 DEF_TRAVERSE_STMT(OMPDistributeParallelForSimdDirective,
2734 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2736 DEF_TRAVERSE_STMT(OMPDistributeSimdDirective,
2737 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2739 DEF_TRAVERSE_STMT(OMPTargetParallelForSimdDirective,
2740 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2742 DEF_TRAVERSE_STMT(OMPTargetSimdDirective,
2743 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2745 DEF_TRAVERSE_STMT(OMPTeamsDistributeDirective,
2746 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2748 DEF_TRAVERSE_STMT(OMPTeamsDistributeSimdDirective,
2749 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2751 DEF_TRAVERSE_STMT(OMPTeamsDistributeParallelForSimdDirective,
2752 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2754 DEF_TRAVERSE_STMT(OMPTeamsDistributeParallelForDirective,
2755 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2757 DEF_TRAVERSE_STMT(OMPTargetTeamsDirective,
2758 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2760 DEF_TRAVERSE_STMT(OMPTargetTeamsDistributeDirective,
2761 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2763 DEF_TRAVERSE_STMT(OMPTargetTeamsDistributeParallelForDirective,
2764 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2766 DEF_TRAVERSE_STMT(OMPTargetTeamsDistributeParallelForSimdDirective,
2767 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2769 DEF_TRAVERSE_STMT(OMPTargetTeamsDistributeSimdDirective,
2770 { TRY_TO(TraverseOMPExecutableDirective(S)); })
2773 template <typename Derived>
2774 bool RecursiveASTVisitor<Derived>::TraverseOMPClause(OMPClause *C) {
2777 switch (C->getClauseKind()) {
2778 #define OPENMP_CLAUSE(Name, Class) \
2780 TRY_TO(Visit##Class(static_cast<Class *>(C))); \
2782 #include "clang/Basic/OpenMPKinds.def"
2783 case OMPC_threadprivate:
2791 template <typename Derived>
2792 bool RecursiveASTVisitor<Derived>::VisitOMPClauseWithPreInit(
2793 OMPClauseWithPreInit *Node) {
2794 TRY_TO(TraverseStmt(Node->getPreInitStmt()));
2798 template <typename Derived>
2799 bool RecursiveASTVisitor<Derived>::VisitOMPClauseWithPostUpdate(
2800 OMPClauseWithPostUpdate *Node) {
2801 TRY_TO(VisitOMPClauseWithPreInit(Node));
2802 TRY_TO(TraverseStmt(Node->getPostUpdateExpr()));
2806 template <typename Derived>
2807 bool RecursiveASTVisitor<Derived>::VisitOMPIfClause(OMPIfClause *C) {
2808 TRY_TO(VisitOMPClauseWithPreInit(C));
2809 TRY_TO(TraverseStmt(C->getCondition()));
2813 template <typename Derived>
2814 bool RecursiveASTVisitor<Derived>::VisitOMPFinalClause(OMPFinalClause *C) {
2815 TRY_TO(TraverseStmt(C->getCondition()));
2819 template <typename Derived>
2821 RecursiveASTVisitor<Derived>::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
2822 TRY_TO(VisitOMPClauseWithPreInit(C));
2823 TRY_TO(TraverseStmt(C->getNumThreads()));
2827 template <typename Derived>
2828 bool RecursiveASTVisitor<Derived>::VisitOMPSafelenClause(OMPSafelenClause *C) {
2829 TRY_TO(TraverseStmt(C->getSafelen()));
2833 template <typename Derived>
2834 bool RecursiveASTVisitor<Derived>::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
2835 TRY_TO(TraverseStmt(C->getSimdlen()));
2839 template <typename Derived>
2841 RecursiveASTVisitor<Derived>::VisitOMPCollapseClause(OMPCollapseClause *C) {
2842 TRY_TO(TraverseStmt(C->getNumForLoops()));
2846 template <typename Derived>
2847 bool RecursiveASTVisitor<Derived>::VisitOMPDefaultClause(OMPDefaultClause *) {
2851 template <typename Derived>
2852 bool RecursiveASTVisitor<Derived>::VisitOMPProcBindClause(OMPProcBindClause *) {
2856 template <typename Derived>
2858 RecursiveASTVisitor<Derived>::VisitOMPScheduleClause(OMPScheduleClause *C) {
2859 TRY_TO(VisitOMPClauseWithPreInit(C));
2860 TRY_TO(TraverseStmt(C->getChunkSize()));
2864 template <typename Derived>
2865 bool RecursiveASTVisitor<Derived>::VisitOMPOrderedClause(OMPOrderedClause *C) {
2866 TRY_TO(TraverseStmt(C->getNumForLoops()));
2870 template <typename Derived>
2871 bool RecursiveASTVisitor<Derived>::VisitOMPNowaitClause(OMPNowaitClause *) {
2875 template <typename Derived>
2876 bool RecursiveASTVisitor<Derived>::VisitOMPUntiedClause(OMPUntiedClause *) {
2880 template <typename Derived>
2882 RecursiveASTVisitor<Derived>::VisitOMPMergeableClause(OMPMergeableClause *) {
2886 template <typename Derived>
2887 bool RecursiveASTVisitor<Derived>::VisitOMPReadClause(OMPReadClause *) {
2891 template <typename Derived>
2892 bool RecursiveASTVisitor<Derived>::VisitOMPWriteClause(OMPWriteClause *) {
2896 template <typename Derived>
2897 bool RecursiveASTVisitor<Derived>::VisitOMPUpdateClause(OMPUpdateClause *) {
2901 template <typename Derived>
2902 bool RecursiveASTVisitor<Derived>::VisitOMPCaptureClause(OMPCaptureClause *) {
2906 template <typename Derived>
2907 bool RecursiveASTVisitor<Derived>::VisitOMPSeqCstClause(OMPSeqCstClause *) {
2911 template <typename Derived>
2912 bool RecursiveASTVisitor<Derived>::VisitOMPThreadsClause(OMPThreadsClause *) {
2916 template <typename Derived>
2917 bool RecursiveASTVisitor<Derived>::VisitOMPSIMDClause(OMPSIMDClause *) {
2921 template <typename Derived>
2922 bool RecursiveASTVisitor<Derived>::VisitOMPNogroupClause(OMPNogroupClause *) {
2926 template <typename Derived>
2927 template <typename T>
2928 bool RecursiveASTVisitor<Derived>::VisitOMPClauseList(T *Node) {
2929 for (auto *E : Node->varlists()) {
2930 TRY_TO(TraverseStmt(E));
2935 template <typename Derived>
2936 bool RecursiveASTVisitor<Derived>::VisitOMPPrivateClause(OMPPrivateClause *C) {
2937 TRY_TO(VisitOMPClauseList(C));
2938 for (auto *E : C->private_copies()) {
2939 TRY_TO(TraverseStmt(E));
2944 template <typename Derived>
2945 bool RecursiveASTVisitor<Derived>::VisitOMPFirstprivateClause(
2946 OMPFirstprivateClause *C) {
2947 TRY_TO(VisitOMPClauseList(C));
2948 TRY_TO(VisitOMPClauseWithPreInit(C));
2949 for (auto *E : C->private_copies()) {
2950 TRY_TO(TraverseStmt(E));
2952 for (auto *E : C->inits()) {
2953 TRY_TO(TraverseStmt(E));
2958 template <typename Derived>
2959 bool RecursiveASTVisitor<Derived>::VisitOMPLastprivateClause(
2960 OMPLastprivateClause *C) {
2961 TRY_TO(VisitOMPClauseList(C));
2962 TRY_TO(VisitOMPClauseWithPostUpdate(C));
2963 for (auto *E : C->private_copies()) {
2964 TRY_TO(TraverseStmt(E));
2966 for (auto *E : C->source_exprs()) {
2967 TRY_TO(TraverseStmt(E));
2969 for (auto *E : C->destination_exprs()) {
2970 TRY_TO(TraverseStmt(E));
2972 for (auto *E : C->assignment_ops()) {
2973 TRY_TO(TraverseStmt(E));
2978 template <typename Derived>
2979 bool RecursiveASTVisitor<Derived>::VisitOMPSharedClause(OMPSharedClause *C) {
2980 TRY_TO(VisitOMPClauseList(C));
2984 template <typename Derived>
2985 bool RecursiveASTVisitor<Derived>::VisitOMPLinearClause(OMPLinearClause *C) {
2986 TRY_TO(TraverseStmt(C->getStep()));
2987 TRY_TO(TraverseStmt(C->getCalcStep()));
2988 TRY_TO(VisitOMPClauseList(C));
2989 TRY_TO(VisitOMPClauseWithPostUpdate(C));
2990 for (auto *E : C->privates()) {
2991 TRY_TO(TraverseStmt(E));
2993 for (auto *E : C->inits()) {
2994 TRY_TO(TraverseStmt(E));
2996 for (auto *E : C->updates()) {
2997 TRY_TO(TraverseStmt(E));
2999 for (auto *E : C->finals()) {
3000 TRY_TO(TraverseStmt(E));
3005 template <typename Derived>
3006 bool RecursiveASTVisitor<Derived>::VisitOMPAlignedClause(OMPAlignedClause *C) {
3007 TRY_TO(TraverseStmt(C->getAlignment()));
3008 TRY_TO(VisitOMPClauseList(C));
3012 template <typename Derived>
3013 bool RecursiveASTVisitor<Derived>::VisitOMPCopyinClause(OMPCopyinClause *C) {
3014 TRY_TO(VisitOMPClauseList(C));
3015 for (auto *E : C->source_exprs()) {
3016 TRY_TO(TraverseStmt(E));
3018 for (auto *E : C->destination_exprs()) {
3019 TRY_TO(TraverseStmt(E));
3021 for (auto *E : C->assignment_ops()) {
3022 TRY_TO(TraverseStmt(E));
3027 template <typename Derived>
3028 bool RecursiveASTVisitor<Derived>::VisitOMPCopyprivateClause(
3029 OMPCopyprivateClause *C) {
3030 TRY_TO(VisitOMPClauseList(C));
3031 for (auto *E : C->source_exprs()) {
3032 TRY_TO(TraverseStmt(E));
3034 for (auto *E : C->destination_exprs()) {
3035 TRY_TO(TraverseStmt(E));
3037 for (auto *E : C->assignment_ops()) {
3038 TRY_TO(TraverseStmt(E));
3043 template <typename Derived>
3045 RecursiveASTVisitor<Derived>::VisitOMPReductionClause(OMPReductionClause *C) {
3046 TRY_TO(TraverseNestedNameSpecifierLoc(C->getQualifierLoc()));
3047 TRY_TO(TraverseDeclarationNameInfo(C->getNameInfo()));
3048 TRY_TO(VisitOMPClauseList(C));
3049 TRY_TO(VisitOMPClauseWithPostUpdate(C));
3050 for (auto *E : C->privates()) {
3051 TRY_TO(TraverseStmt(E));
3053 for (auto *E : C->lhs_exprs()) {
3054 TRY_TO(TraverseStmt(E));
3056 for (auto *E : C->rhs_exprs()) {
3057 TRY_TO(TraverseStmt(E));
3059 for (auto *E : C->reduction_ops()) {
3060 TRY_TO(TraverseStmt(E));
3065 template <typename Derived>
3066 bool RecursiveASTVisitor<Derived>::VisitOMPTaskReductionClause(
3067 OMPTaskReductionClause *C) {
3068 TRY_TO(TraverseNestedNameSpecifierLoc(C->getQualifierLoc()));
3069 TRY_TO(TraverseDeclarationNameInfo(C->getNameInfo()));
3070 TRY_TO(VisitOMPClauseList(C));
3071 TRY_TO(VisitOMPClauseWithPostUpdate(C));
3072 for (auto *E : C->privates()) {
3073 TRY_TO(TraverseStmt(E));
3075 for (auto *E : C->lhs_exprs()) {
3076 TRY_TO(TraverseStmt(E));
3078 for (auto *E : C->rhs_exprs()) {
3079 TRY_TO(TraverseStmt(E));
3081 for (auto *E : C->reduction_ops()) {
3082 TRY_TO(TraverseStmt(E));
3087 template <typename Derived>
3088 bool RecursiveASTVisitor<Derived>::VisitOMPInReductionClause(
3089 OMPInReductionClause *C) {
3090 TRY_TO(TraverseNestedNameSpecifierLoc(C->getQualifierLoc()));
3091 TRY_TO(TraverseDeclarationNameInfo(C->getNameInfo()));
3092 TRY_TO(VisitOMPClauseList(C));
3093 TRY_TO(VisitOMPClauseWithPostUpdate(C));
3094 for (auto *E : C->privates()) {
3095 TRY_TO(TraverseStmt(E));
3097 for (auto *E : C->lhs_exprs()) {
3098 TRY_TO(TraverseStmt(E));
3100 for (auto *E : C->rhs_exprs()) {
3101 TRY_TO(TraverseStmt(E));
3103 for (auto *E : C->reduction_ops()) {
3104 TRY_TO(TraverseStmt(E));
3106 for (auto *E : C->taskgroup_descriptors())
3107 TRY_TO(TraverseStmt(E));
3111 template <typename Derived>
3112 bool RecursiveASTVisitor<Derived>::VisitOMPFlushClause(OMPFlushClause *C) {
3113 TRY_TO(VisitOMPClauseList(C));
3117 template <typename Derived>
3118 bool RecursiveASTVisitor<Derived>::VisitOMPDependClause(OMPDependClause *C) {
3119 TRY_TO(VisitOMPClauseList(C));
3123 template <typename Derived>
3124 bool RecursiveASTVisitor<Derived>::VisitOMPDeviceClause(OMPDeviceClause *C) {
3125 TRY_TO(VisitOMPClauseWithPreInit(C));
3126 TRY_TO(TraverseStmt(C->getDevice()));
3130 template <typename Derived>
3131 bool RecursiveASTVisitor<Derived>::VisitOMPMapClause(OMPMapClause *C) {
3132 TRY_TO(VisitOMPClauseList(C));
3136 template <typename Derived>
3137 bool RecursiveASTVisitor<Derived>::VisitOMPNumTeamsClause(
3138 OMPNumTeamsClause *C) {
3139 TRY_TO(VisitOMPClauseWithPreInit(C));
3140 TRY_TO(TraverseStmt(C->getNumTeams()));
3144 template <typename Derived>
3145 bool RecursiveASTVisitor<Derived>::VisitOMPThreadLimitClause(
3146 OMPThreadLimitClause *C) {
3147 TRY_TO(VisitOMPClauseWithPreInit(C));
3148 TRY_TO(TraverseStmt(C->getThreadLimit()));
3152 template <typename Derived>
3153 bool RecursiveASTVisitor<Derived>::VisitOMPPriorityClause(
3154 OMPPriorityClause *C) {
3155 TRY_TO(TraverseStmt(C->getPriority()));
3159 template <typename Derived>
3160 bool RecursiveASTVisitor<Derived>::VisitOMPGrainsizeClause(
3161 OMPGrainsizeClause *C) {
3162 TRY_TO(TraverseStmt(C->getGrainsize()));
3166 template <typename Derived>
3167 bool RecursiveASTVisitor<Derived>::VisitOMPNumTasksClause(
3168 OMPNumTasksClause *C) {
3169 TRY_TO(TraverseStmt(C->getNumTasks()));
3173 template <typename Derived>
3174 bool RecursiveASTVisitor<Derived>::VisitOMPHintClause(OMPHintClause *C) {
3175 TRY_TO(TraverseStmt(C->getHint()));
3179 template <typename Derived>
3180 bool RecursiveASTVisitor<Derived>::VisitOMPDistScheduleClause(
3181 OMPDistScheduleClause *C) {
3182 TRY_TO(VisitOMPClauseWithPreInit(C));
3183 TRY_TO(TraverseStmt(C->getChunkSize()));
3187 template <typename Derived>
3189 RecursiveASTVisitor<Derived>::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
3193 template <typename Derived>
3194 bool RecursiveASTVisitor<Derived>::VisitOMPToClause(OMPToClause *C) {
3195 TRY_TO(VisitOMPClauseList(C));
3199 template <typename Derived>
3200 bool RecursiveASTVisitor<Derived>::VisitOMPFromClause(OMPFromClause *C) {
3201 TRY_TO(VisitOMPClauseList(C));
3205 template <typename Derived>
3206 bool RecursiveASTVisitor<Derived>::VisitOMPUseDevicePtrClause(
3207 OMPUseDevicePtrClause *C) {
3208 TRY_TO(VisitOMPClauseList(C));
3212 template <typename Derived>
3213 bool RecursiveASTVisitor<Derived>::VisitOMPIsDevicePtrClause(
3214 OMPIsDevicePtrClause *C) {
3215 TRY_TO(VisitOMPClauseList(C));
3219 // FIXME: look at the following tricky-seeming exprs to see if we
3220 // need to recurse on anything. These are ones that have methods
3221 // returning decls or qualtypes or nestednamespecifier -- though I'm
3222 // not sure if they own them -- or just seemed very complicated, or
3223 // had lots of sub-types to explore.
3225 // VisitOverloadExpr and its children: recurse on template args? etc?
3227 // FIXME: go through all the stmts and exprs again, and see which of them
3228 // create new types, and recurse on the types (TypeLocs?) of those.
3231 // http://clang.llvm.org/doxygen/classclang_1_1CXXTypeidExpr.html
3232 // http://clang.llvm.org/doxygen/classclang_1_1UnaryExprOrTypeTraitExpr.html
3233 // http://clang.llvm.org/doxygen/classclang_1_1TypesCompatibleExpr.html
3234 // Every class that has getQualifier.
3236 #undef DEF_TRAVERSE_STMT
3237 #undef TRAVERSE_STMT
3238 #undef TRAVERSE_STMT_BASE
3242 } // end namespace clang
3244 #endif // LLVM_CLANG_AST_RECURSIVEASTVISITOR_H