clang
15.0.0git
|
A class that does preorder or postorder depth-first traversal on the entire Clang AST and visits each node. More...
#include "clang/AST/RecursiveASTVisitor.h"
Public Types | |
typedef SmallVectorImpl< llvm::PointerIntPair< Stmt *, 1, bool > > | DataRecursionQueue |
A queue used for performing data recursion over statements. More... | |
Public Member Functions | |
Derived & | getDerived () |
Return a reference to the derived class. More... | |
bool | shouldVisitTemplateInstantiations () const |
Return whether this visitor should recurse into template instantiations. More... | |
bool | shouldWalkTypesOfTypeLocs () const |
Return whether this visitor should recurse into the types of TypeLocs. More... | |
bool | shouldVisitImplicitCode () const |
Return whether this visitor should recurse into implicit code, e.g., implicit constructors and destructors. More... | |
bool | shouldVisitLambdaBody () const |
Return whether this visitor should recurse into lambda body. More... | |
bool | shouldTraversePostOrder () const |
Return whether this visitor should traverse post-order. More... | |
bool | TraverseAST (ASTContext &AST) |
Recursively visits an entire AST, starting from the TranslationUnitDecl. More... | |
bool | TraverseStmt (Stmt *S, DataRecursionQueue *Queue=nullptr) |
Recursively visit a statement or expression, by dispatching to Traverse*() based on the argument's dynamic type. More... | |
bool | dataTraverseStmtPre (Stmt *S) |
Invoked before visiting a statement or expression via data recursion. More... | |
bool | dataTraverseStmtPost (Stmt *S) |
Invoked after visiting a statement or expression via data recursion. More... | |
bool | TraverseType (QualType T) |
Recursively visit a type, by dispatching to Traverse*Type() based on the argument's getTypeClass() property. More... | |
bool | TraverseTypeLoc (TypeLoc TL) |
Recursively visit a type with location, by dispatching to Traverse*TypeLoc() based on the argument type's getTypeClass() property. More... | |
bool | TraverseAttr (Attr *At) |
Recursively visit an attribute, by dispatching to Traverse*Attr() based on the argument's dynamic type. More... | |
bool | TraverseDecl (Decl *D) |
Recursively visit a declaration, by dispatching to Traverse*Decl() based on the argument's dynamic type. More... | |
bool | TraverseNestedNameSpecifier (NestedNameSpecifier *NNS) |
Recursively visit a C++ nested-name-specifier. More... | |
bool | TraverseNestedNameSpecifierLoc (NestedNameSpecifierLoc NNS) |
Recursively visit a C++ nested-name-specifier with location information. More... | |
bool | TraverseDeclarationNameInfo (DeclarationNameInfo NameInfo) |
Recursively visit a name with its location information. More... | |
bool | TraverseTemplateName (TemplateName Template) |
Recursively visit a template name and dispatch to the appropriate method. More... | |
bool | TraverseTemplateArgument (const TemplateArgument &Arg) |
Recursively visit a template argument and dispatch to the appropriate method for the argument type. More... | |
bool | TraverseTemplateArgumentLoc (const TemplateArgumentLoc &ArgLoc) |
Recursively visit a template argument location and dispatch to the appropriate method for the argument type. More... | |
bool | TraverseTemplateArguments (const TemplateArgument *Args, unsigned NumArgs) |
Recursively visit a set of template arguments. More... | |
bool | TraverseCXXBaseSpecifier (const CXXBaseSpecifier &Base) |
Recursively visit a base specifier. More... | |
bool | TraverseConstructorInitializer (CXXCtorInitializer *Init) |
Recursively visit a constructor initializer. More... | |
bool | TraverseLambdaCapture (LambdaExpr *LE, const LambdaCapture *C, Expr *Init) |
Recursively visit a lambda capture. More... | |
bool | TraverseSynOrSemInitListExpr (InitListExpr *S, DataRecursionQueue *Queue=nullptr) |
Recursively visit the syntactic or semantic form of an initialization list. More... | |
bool | TraverseObjCProtocolLoc (ObjCProtocolLoc ProtocolLoc) |
Recursively visit an Objective-C protocol reference with location information. More... | |
bool | VisitAttr (Attr *A) |
Stmt::child_range | getStmtChildren (Stmt *S) |
bool | WalkUpFromStmt (Stmt *S) |
bool | VisitStmt (Stmt *S) |
bool | WalkUpFromType (Type *T) |
bool | VisitType (Type *T) |
bool | WalkUpFromTypeLoc (TypeLoc TL) |
bool | VisitTypeLoc (TypeLoc TL) |
bool | WalkUpFromQualifiedTypeLoc (QualifiedTypeLoc TL) |
bool | VisitQualifiedTypeLoc (QualifiedTypeLoc TL) |
bool | WalkUpFromUnqualTypeLoc (UnqualTypeLoc TL) |
bool | VisitUnqualTypeLoc (UnqualTypeLoc TL) |
bool | WalkUpFromDecl (Decl *D) |
bool | VisitDecl (Decl *D) |
bool | canIgnoreChildDeclWhileTraversingDeclContext (const Decl *Child) |
bool | TraverseTypeConstraint (const TypeConstraint *C) |
bool | TraverseConceptRequirement (concepts::Requirement *R) |
bool | TraverseConceptTypeRequirement (concepts::TypeRequirement *R) |
bool | TraverseConceptExprRequirement (concepts::ExprRequirement *R) |
bool | TraverseConceptNestedRequirement (concepts::NestedRequirement *R) |
bool | dataTraverseNode (Stmt *S, DataRecursionQueue *Queue) |
A class that does preorder or postorder depth-first traversal on the entire Clang AST and visits each node.
This class performs three distinct tasks:
These tasks are done by three groups of methods, respectively:
These three method groups are tiered (Traverse* > WalkUpFrom* > Visit*). A method (e.g. Traverse*) may call methods from the same tier (e.g. other Traverse*) or one tier lower (e.g. WalkUpFrom*). It may not call methods from a higher tier.
Note that since WalkUpFromFoo() calls WalkUpFromBar() (where Bar is Foo's super class) before calling VisitFoo(), the result is that the Visit*() methods for a given node are called in the top-down order (e.g. for a node of type NamespaceDecl, the order will be VisitDecl(), VisitNamedDecl(), and then VisitNamespaceDecl()).
This scheme guarantees that all Visit*() calls for the same AST node are grouped together. In other words, Visit*() methods for different nodes are never interleaved.
Clients of this visitor should subclass the visitor (providing themselves as the template argument, using the curiously recurring template pattern) and override any of the Traverse*, WalkUpFrom*, and Visit* methods for declarations, types, statements, expressions, or other AST nodes where the visitor should customize behavior. Most users only need to override Visit*. Advanced users may override Traverse* and WalkUpFrom* to implement custom traversal strategies. Returning false from one of these overridden functions will abort the entire traversal.
By default, this visitor tries to visit every part of the explicit source code exactly once. The default policy towards templates is to descend into the 'pattern' class or function body, not any explicit or implicit instantiations. Explicit specializations are still visited, and the patterns of partial specializations are visited separately. This behavior can be changed by overriding shouldVisitTemplateInstantiations() in the derived class to return true, in which case all known implicit and explicit instantiations will be visited at the same time as the pattern from which they were produced.
By default, this visitor preorder traverses the AST. If postorder traversal is needed, the shouldTraversePostOrder
method needs to be overridden to return true
.
Definition at line 165 of file RecursiveASTVisitor.h.
typedef SmallVectorImpl<llvm::PointerIntPair<Stmt *, 1, bool> > clang::RecursiveASTVisitor< Derived >::DataRecursionQueue |
A queue used for performing data recursion over statements.
Parameters involving this type are used to implement data recursion over Stmts and Exprs within this class, and should typically not be explicitly specified by derived classes. The bool bit indicates whether the statement has been traversed or not.
Definition at line 173 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::canIgnoreChildDeclWhileTraversingDeclContext | ( | const Decl * | Child | ) |
Definition at line 1487 of file RecursiveASTVisitor.h.
Referenced by clang::LexicallyOrderedRecursiveASTVisitor< Derived >::TraverseDeclContextHelper().
bool clang::RecursiveASTVisitor< Derived >::dataTraverseNode | ( | Stmt * | S, |
DataRecursionQueue * | Queue | ||
) |
Definition at line 570 of file RecursiveASTVisitor.h.
|
inline |
Invoked after visiting a statement or expression via data recursion.
This is not invoked if the previously invoked dataTraverseStmtPre
returned false.
Definition at line 221 of file RecursiveASTVisitor.h.
|
inline |
Invoked before visiting a statement or expression via data recursion.
Definition at line 214 of file RecursiveASTVisitor.h.
|
inline |
Return a reference to the derived class.
Definition at line 176 of file RecursiveASTVisitor.h.
Referenced by clang::RecursiveASTVisitor< CallGraph >::TraverseAST(), clang::LexicallyOrderedRecursiveASTVisitor< Derived >::TraverseDeclContextHelper(), clang::RecursiveASTVisitor< CallGraph >::WalkUpFromDecl(), clang::RecursiveASTVisitor< CallGraph >::WalkUpFromQualifiedTypeLoc(), clang::RecursiveASTVisitor< CallGraph >::WalkUpFromType(), clang::RecursiveASTVisitor< CallGraph >::WalkUpFromTypeLoc(), and clang::RecursiveASTVisitor< CallGraph >::WalkUpFromUnqualTypeLoc().
|
inline |
Definition at line 341 of file RecursiveASTVisitor.h.
|
inline |
Return whether this visitor should traverse post-order.
Definition at line 194 of file RecursiveASTVisitor.h.
|
inline |
Return whether this visitor should recurse into implicit code, e.g., implicit constructors and destructors.
Definition at line 188 of file RecursiveASTVisitor.h.
|
inline |
Return whether this visitor should recurse into lambda body.
Definition at line 191 of file RecursiveASTVisitor.h.
|
inline |
Return whether this visitor should recurse into template instantiations.
Definition at line 180 of file RecursiveASTVisitor.h.
|
inline |
Return whether this visitor should recurse into the types of TypeLocs.
Definition at line 184 of file RecursiveASTVisitor.h.
|
inline |
Recursively visits an entire AST, starting from the TranslationUnitDecl.
Definition at line 198 of file RecursiveASTVisitor.h.
Referenced by clang::ParentMapContext::ParentMap::ParentMap().
bool clang::RecursiveASTVisitor< Derived >::TraverseAttr | ( | Attr * | At | ) |
Recursively visit an attribute, by dispatching to Traverse*Attr() based on the argument's dynamic type.
bool clang::RecursiveASTVisitor< Derived >::TraverseConceptExprRequirement | ( | concepts::ExprRequirement * | R | ) |
Definition at line 597 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseConceptNestedRequirement | ( | concepts::NestedRequirement * | R | ) |
Definition at line 615 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseConceptRequirement | ( | concepts::Requirement * | R | ) |
Definition at line 540 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseConceptTypeRequirement | ( | concepts::TypeRequirement * | R | ) |
Definition at line 589 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseConstructorInitializer | ( | CXXCtorInitializer * | Init | ) |
Recursively visit a constructor initializer.
This automatically dispatches to another visitor for the initializer expression, but not for the name of the initializer, so may be overridden for clients that need access to the name.
Definition at line 948 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseCXXBaseSpecifier | ( | const CXXBaseSpecifier & | Base | ) |
Recursively visit a base specifier.
This can be overridden by a subclass.
bool clang::RecursiveASTVisitor< Derived >::TraverseDecl | ( | Decl * | D | ) |
Recursively visit a declaration, by dispatching to Traverse*Decl() based on the argument's dynamic type.
Definition at line 750 of file RecursiveASTVisitor.h.
Referenced by clang::LexicallyOrderedRecursiveASTVisitor< Derived >::TraverseDeclContextHelper().
bool clang::RecursiveASTVisitor< Derived >::TraverseDeclarationNameInfo | ( | DeclarationNameInfo | NameInfo | ) |
Recursively visit a name with its location information.
Definition at line 829 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseLambdaCapture | ( | LambdaExpr * | LE, |
const LambdaCapture * | C, | ||
Expr * | Init | ||
) |
Recursively visit a lambda capture.
Init
is the expression that will be used to initialize the capture.
Definition at line 961 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseNestedNameSpecifier | ( | NestedNameSpecifier * | NNS | ) |
Recursively visit a C++ nested-name-specifier.
Definition at line 778 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseNestedNameSpecifierLoc | ( | NestedNameSpecifierLoc | NNS | ) |
Recursively visit a C++ nested-name-specifier with location information.
Definition at line 803 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseObjCProtocolLoc | ( | ObjCProtocolLoc | ProtocolLoc | ) |
Recursively visit an Objective-C protocol reference with location information.
bool clang::RecursiveASTVisitor< Derived >::TraverseStmt | ( | Stmt * | S, |
DataRecursionQueue * | Queue = nullptr |
||
) |
Recursively visit a statement or expression, by dispatching to Traverse*() based on the argument's dynamic type.
Definition at line 671 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseSynOrSemInitListExpr | ( | InitListExpr * | S, |
DataRecursionQueue * | Queue = nullptr |
||
) |
Recursively visit the syntactic or semantic form of an initialization list.
bool clang::RecursiveASTVisitor< Derived >::TraverseTemplateArgument | ( | const TemplateArgument & | Arg | ) |
Recursively visit a template argument and dispatch to the appropriate method for the argument type.
Definition at line 868 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseTemplateArgumentLoc | ( | const TemplateArgumentLoc & | ArgLoc | ) |
Recursively visit a template argument location and dispatch to the appropriate method for the argument type.
Definition at line 899 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseTemplateArguments | ( | const TemplateArgument * | Args, |
unsigned | NumArgs | ||
) |
Recursively visit a set of template arguments.
This can be overridden by a subclass, but it's not expected that will be needed – this visitor always dispatches to another.
Definition at line 938 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseTemplateName | ( | TemplateName | Template | ) |
Recursively visit a template name and dispatch to the appropriate method.
Definition at line 858 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseType | ( | QualType | T | ) |
Recursively visit a type, by dispatching to Traverse*Type() based on the argument's getTypeClass() property.
Definition at line 712 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseTypeConstraint | ( | const TypeConstraint * | C | ) |
Definition at line 521 of file RecursiveASTVisitor.h.
bool clang::RecursiveASTVisitor< Derived >::TraverseTypeLoc | ( | TypeLoc | TL | ) |
Recursively visit a type with location, by dispatching to Traverse*TypeLoc() based on the argument type's getTypeClass() property.
Definition at line 729 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 332 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 455 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 429 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 380 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 401 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 422 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 433 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 454 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 426 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 379 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 400 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 421 of file RecursiveASTVisitor.h.
|
inline |
Definition at line 430 of file RecursiveASTVisitor.h.