clang  9.0.0svn
RecursiveSymbolVisitor.h
Go to the documentation of this file.
1 //===--- RecursiveSymbolVisitor.h - Clang refactoring library -------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// A wrapper class around \c RecursiveASTVisitor that visits each
11 /// occurrences of a named symbol.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_TOOLING_REFACTOR_RECURSIVE_SYMBOL_VISITOR_H
16 #define LLVM_CLANG_TOOLING_REFACTOR_RECURSIVE_SYMBOL_VISITOR_H
17 
18 #include "clang/AST/AST.h"
20 #include "clang/Lex/Lexer.h"
21 
22 namespace clang {
23 namespace tooling {
24 
25 /// Traverses the AST and visits the occurrence of each named symbol in the
26 /// given nodes.
27 template <typename T>
29  : public RecursiveASTVisitor<RecursiveSymbolVisitor<T>> {
31 
32 public:
33  RecursiveSymbolVisitor(const SourceManager &SM, const LangOptions &LangOpts)
34  : SM(SM), LangOpts(LangOpts) {}
35 
37  ArrayRef<SourceRange> NameRanges) {
38  return true;
39  }
40 
41  // Declaration visitors:
42 
43  bool VisitNamedDecl(const NamedDecl *D) {
44  return isa<CXXConversionDecl>(D) ? true : visit(D, D->getLocation());
45  }
46 
48  for (const auto *Initializer : CD->inits()) {
49  // Ignore implicit initializers.
50  if (!Initializer->isWritten())
51  continue;
52  if (const FieldDecl *FD = Initializer->getMember()) {
53  if (!visit(FD, Initializer->getSourceLocation(),
54  Lexer::getLocForEndOfToken(Initializer->getSourceLocation(),
55  0, SM, LangOpts)))
56  return false;
57  }
58  }
59  return true;
60  }
61 
62  // Expression visitors:
63 
65  return visit(Expr->getFoundDecl(), Expr->getLocation());
66  }
67 
69  return visit(Expr->getFoundDecl().getDecl(), Expr->getMemberLoc());
70  }
71 
73  for (unsigned I = 0, E = S->getNumComponents(); I != E; ++I) {
74  const OffsetOfNode &Component = S->getComponent(I);
75  if (Component.getKind() == OffsetOfNode::Field) {
76  if (!visit(Component.getField(), Component.getEndLoc()))
77  return false;
78  }
79  // FIXME: Try to resolve dependent field references.
80  }
81  return true;
82  }
83 
84  // Other visitors:
85 
86  bool VisitTypeLoc(const TypeLoc Loc) {
87  const SourceLocation TypeBeginLoc = Loc.getBeginLoc();
88  const SourceLocation TypeEndLoc =
89  Lexer::getLocForEndOfToken(TypeBeginLoc, 0, SM, LangOpts);
90  if (const auto *TemplateTypeParm =
91  dyn_cast<TemplateTypeParmType>(Loc.getType())) {
92  if (!visit(TemplateTypeParm->getDecl(), TypeBeginLoc, TypeEndLoc))
93  return false;
94  }
95  if (const auto *TemplateSpecType =
96  dyn_cast<TemplateSpecializationType>(Loc.getType())) {
97  if (!visit(TemplateSpecType->getTemplateName().getAsTemplateDecl(),
98  TypeBeginLoc, TypeEndLoc))
99  return false;
100  }
101  return visit(Loc.getType()->getAsCXXRecordDecl(), TypeBeginLoc, TypeEndLoc);
102  }
103 
105  // The base visitor will visit NNSL prefixes, so we should only look at
106  // the current NNS.
107  if (NNS) {
109  if (!visit(ND, NNS.getLocalBeginLoc(), NNS.getLocalEndLoc()))
110  return false;
111  }
113  }
114 
115 private:
116  const SourceManager &SM;
117  const LangOptions &LangOpts;
118 
119  bool visit(const NamedDecl *ND, SourceLocation BeginLoc,
120  SourceLocation EndLoc) {
121  return static_cast<T *>(this)->visitSymbolOccurrence(
122  ND, SourceRange(BeginLoc, EndLoc));
123  }
124  bool visit(const NamedDecl *ND, SourceLocation Loc) {
125  return visit(ND, Loc,
126  Loc.getLocWithOffset(ND->getNameAsString().length() - 1));
127  }
128 };
129 
130 } // end namespace tooling
131 } // end namespace clang
132 
133 #endif // LLVM_CLANG_TOOLING_REFACTOR_RECURSIVE_SYMBOL_VISITOR_H
NamedDecl * getFoundDecl()
Get the NamedDecl through which this reference occurred.
Definition: Expr.h:1184
SourceLocation getLocWithOffset(int Offset) const
Return a source location with the specified offset from this SourceLocation.
bool VisitCXXConstructorDecl(const CXXConstructorDecl *CD)
Traverses the AST and visits the occurrence of each named symbol in the given nodes.
NamedDecl * getDecl() const
Represent a C++ namespace.
Definition: Decl.h:514
Represents a C++ constructor within a class.
Definition: DeclCXX.h:2491
SourceLocation getLocalBeginLoc() const
Retrieve the location of the beginning of this component of the nested-name-specifier.
bool VisitDeclRefExpr(const DeclRefExpr *Expr)
Base wrapper for a particular "section" of type source info.
Definition: TypeLoc.h:56
FieldDecl * getField() const
For a field offsetof node, returns the field.
Definition: Expr.h:2110
A C++ nested-name-specifier augmented with source location information.
Represents a member of a struct/union/class.
Definition: Decl.h:2578
RecursiveSymbolVisitor(const SourceManager &SM, const LangOptions &LangOpts)
bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS)
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
SourceLocation getLocalEndLoc() const
Retrieve the location of the end of this component of the nested-name-specifier.
Helper class for OffsetOfExpr.
Definition: Expr.h:2046
A class that does preorder or postorder depth-first traversal on the entire Clang AST and visits each...
CXXRecordDecl * getAsCXXRecordDecl() const
Retrieves the CXXRecordDecl that this type refers to, either because the type is a RecordType or beca...
Definition: Type.cpp:1635
SourceLocation getLocation() const
Definition: Expr.h:1155
SourceLocation getBeginLoc() const
Get the begin source location.
Definition: TypeLoc.cpp:189
NamespaceDecl * getAsNamespace() const
Retrieve the namespace stored in this nested name specifier.
DeclAccessPair getFoundDecl() const
Retrieves the declaration found by lookup.
Definition: Expr.h:2815
This represents one expression.
Definition: Expr.h:108
static SourceLocation getLocForEndOfToken(SourceLocation Loc, unsigned Offset, const SourceManager &SM, const LangOptions &LangOpts)
Computes the source location just past the end of the token at this source location.
Definition: Lexer.cpp:770
Kind getKind() const
Determine what kind of offsetof node this is.
Definition: Expr.h:2100
SourceLocation getMemberLoc() const
getMemberLoc - Return the location of the "member", in X->F, it is the location of &#39;F&#39;...
Definition: Expr.h:2917
const OffsetOfNode & getComponent(unsigned Idx) const
Definition: Expr.h:2199
SourceLocation getEndLoc() const LLVM_READONLY
Definition: Expr.h:2133
Encodes a location in the source.
std::string getNameAsString() const
Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ c...
Definition: Decl.h:291
bool VisitOffsetOfExpr(const OffsetOfExpr *S)
bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS)
Recursively visit a C++ nested-name-specifier with location information.
Dataflow Directional Tag Classes.
NestedNameSpecifier * getNestedNameSpecifier() const
Retrieve the nested-name-specifier to which this instance refers.
bool VisitMemberExpr(const MemberExpr *Expr)
QualType getType() const
Get the type for which this source info wrapper provides information.
Definition: TypeLoc.h:130
MemberExpr - [C99 6.5.2.3] Structure and Union Members.
Definition: Expr.h:2720
unsigned getNumComponents() const
Definition: Expr.h:2209
A reference to a declared variable, function, enum, etc.
Definition: Expr.h:1074
A trivial tuple used to represent a source range.
This represents a decl that may have a name.
Definition: Decl.h:248
OffsetOfExpr - [C99 7.17] - This represents an expression of the form offsetof(record-type, member-designator).
Definition: Expr.h:2150
bool visitSymbolOccurrence(const NamedDecl *ND, ArrayRef< SourceRange > NameRanges)
This class handles loading and caching of source files into memory.
SourceLocation getLocation() const
Definition: DeclBase.h:420