1 //===- IndexTypeSourceInfo.cpp - Indexing types ---------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "IndexingContext.h"
11 #include "clang/AST/RecursiveASTVisitor.h"
12 
13 using namespace clang;
14 using namespace index;
15 
16 namespace {
17 
18 class TypeIndexer : public RecursiveASTVisitor<TypeIndexer> {
19   IndexingContext &IndexCtx;
20   const NamedDecl *Parent;
21   const DeclContext *ParentDC;
22   bool IsBase;
23   SmallVector<SymbolRelation, 3> Relations;
24 
25   typedef RecursiveASTVisitor<TypeIndexer> base;
26 
27 public:
28   TypeIndexer(IndexingContext &indexCtx, const NamedDecl *parent,
29               const DeclContext *DC, bool isBase, bool isIBType)
30     : IndexCtx(indexCtx), Parent(parent), ParentDC(DC), IsBase(isBase) {
31     if (IsBase) {
32       assert(Parent);
33       Relations.emplace_back((unsigned)SymbolRole::RelationBaseOf, Parent);
34     }
35     if (isIBType) {
36       assert(Parent);
37       Relations.emplace_back((unsigned)SymbolRole::RelationIBTypeOf, Parent);
38     }
39   }
40 
41   bool shouldWalkTypesOfTypeLocs() const { return false; }
42 
43 #define TRY_TO(CALL_EXPR)                                                      \
44   do {                                                                         \
45     if (!CALL_EXPR)                                                            \
46       return false;                                                            \
47   } while (0)
48 
49   bool VisitTypedefTypeLoc(TypedefTypeLoc TL) {
50     SourceLocation Loc = TL.getNameLoc();
51     TypedefNameDecl *ND = TL.getTypedefNameDecl();
52     if (ND->isTransparentTag()) {
53       TagDecl *Underlying = ND->getUnderlyingType()->getAsTagDecl();
54       return IndexCtx.handleReference(Underlying, Loc, Parent,
55                                       ParentDC, SymbolRoleSet(), Relations);
56     }
57     if (IsBase) {
58       TRY_TO(IndexCtx.handleReference(ND, Loc,
59                                       Parent, ParentDC, SymbolRoleSet()));
60       if (auto *CD = TL.getType()->getAsCXXRecordDecl()) {
61         TRY_TO(IndexCtx.handleReference(CD, Loc, Parent, ParentDC,
62                                         (unsigned)SymbolRole::Implicit,
63                                         Relations));
64       }
65     } else {
66       TRY_TO(IndexCtx.handleReference(ND, Loc,
67                                       Parent, ParentDC, SymbolRoleSet(),
68                                       Relations));
69     }
70     return true;
71   }
72 
73   bool traverseParamVarHelper(ParmVarDecl *D) {
74     TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
75     if (D->getTypeSourceInfo())
76       TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
77     return true;
78   }
79 
80   bool TraverseParmVarDecl(ParmVarDecl *D) {
81     // Avoid visiting default arguments from the definition that were already
82     // visited in the declaration.
83     // FIXME: A free function definition can have default arguments.
84     // Avoiding double visitaiton of default arguments should be handled by the
85     // visitor probably with a bit in the AST to indicate if the attached
86     // default argument was 'inherited' or written in source.
87     if (auto FD = dyn_cast<FunctionDecl>(D->getDeclContext())) {
88       if (FD->isThisDeclarationADefinition()) {
89         return traverseParamVarHelper(D);
90       }
91     }
92 
93     return base::TraverseParmVarDecl(D);
94   }
95 
96   bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
97     IndexCtx.indexNestedNameSpecifierLoc(NNS, Parent, ParentDC);
98     return true;
99   }
100 
101   bool VisitTagTypeLoc(TagTypeLoc TL) {
102     TagDecl *D = TL.getDecl();
103     if (D->getParentFunctionOrMethod())
104       return true;
105 
106     if (TL.isDefinition()) {
107       IndexCtx.indexTagDecl(D);
108       return true;
109     }
110 
111     return IndexCtx.handleReference(D, TL.getNameLoc(),
112                                     Parent, ParentDC, SymbolRoleSet(),
113                                     Relations);
114   }
115 
116   bool VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
117     return IndexCtx.handleReference(TL.getIFaceDecl(), TL.getNameLoc(),
118                                     Parent, ParentDC, SymbolRoleSet(), Relations);
119   }
120 
121   bool VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
122     for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i) {
123       IndexCtx.handleReference(TL.getProtocol(i), TL.getProtocolLoc(i),
124                                Parent, ParentDC, SymbolRoleSet(), Relations);
125     }
126     return true;
127   }
128 
129   bool VisitTemplateSpecializationTypeLoc(TemplateSpecializationTypeLoc TL) {
130     if (const TemplateSpecializationType *T = TL.getTypePtr()) {
131       if (IndexCtx.shouldIndexImplicitTemplateInsts()) {
132         if (CXXRecordDecl *RD = T->getAsCXXRecordDecl())
133           IndexCtx.handleReference(RD, TL.getTemplateNameLoc(),
134                                    Parent, ParentDC, SymbolRoleSet(), Relations);
135       } else {
136         if (const TemplateDecl *D = T->getTemplateName().getAsTemplateDecl())
137           IndexCtx.handleReference(D, TL.getTemplateNameLoc(),
138                                    Parent, ParentDC, SymbolRoleSet(), Relations);
139       }
140     }
141     return true;
142   }
143 
144   bool TraverseStmt(Stmt *S) {
145     IndexCtx.indexBody(S, Parent, ParentDC);
146     return true;
147   }
148 };
149 
150 } // anonymous namespace
151 
152 void IndexingContext::indexTypeSourceInfo(TypeSourceInfo *TInfo,
153                                           const NamedDecl *Parent,
154                                           const DeclContext *DC,
155                                           bool isBase,
156                                           bool isIBType) {
157   if (!TInfo || TInfo->getTypeLoc().isNull())
158     return;
159 
160   indexTypeLoc(TInfo->getTypeLoc(), Parent, DC, isBase, isIBType);
161 }
162 
163 void IndexingContext::indexTypeLoc(TypeLoc TL,
164                                    const NamedDecl *Parent,
165                                    const DeclContext *DC,
166                                    bool isBase,
167                                    bool isIBType) {
168   if (TL.isNull())
169     return;
170 
171   if (!DC)
172     DC = Parent->getLexicalDeclContext();
173   TypeIndexer(*this, Parent, DC, isBase, isIBType).TraverseTypeLoc(TL);
174 }
175 
176 void IndexingContext::indexNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS,
177                                                   const NamedDecl *Parent,
178                                                   const DeclContext *DC) {
179   if (!NNS)
180     return;
181 
182   if (NestedNameSpecifierLoc Prefix = NNS.getPrefix())
183     indexNestedNameSpecifierLoc(Prefix, Parent, DC);
184 
185   if (!DC)
186     DC = Parent->getLexicalDeclContext();
187   SourceLocation Loc = NNS.getSourceRange().getBegin();
188 
189   switch (NNS.getNestedNameSpecifier()->getKind()) {
190   case NestedNameSpecifier::Identifier:
191   case NestedNameSpecifier::Global:
192   case NestedNameSpecifier::Super:
193     break;
194 
195   case NestedNameSpecifier::Namespace:
196     handleReference(NNS.getNestedNameSpecifier()->getAsNamespace(),
197                     Loc, Parent, DC, SymbolRoleSet());
198     break;
199   case NestedNameSpecifier::NamespaceAlias:
200     handleReference(NNS.getNestedNameSpecifier()->getAsNamespaceAlias(),
201                     Loc, Parent, DC, SymbolRoleSet());
202     break;
203 
204   case NestedNameSpecifier::TypeSpec:
205   case NestedNameSpecifier::TypeSpecWithTemplate:
206     indexTypeLoc(NNS.getTypeLoc(), Parent, DC);
207     break;
208   }
209 }
210 
211 void IndexingContext::indexTagDecl(const TagDecl *D) {
212   if (!shouldIndexFunctionLocalSymbols() && isFunctionLocalSymbol(D))
213     return;
214 
215   if (handleDecl(D)) {
216     if (D->isThisDeclarationADefinition()) {
217       indexNestedNameSpecifierLoc(D->getQualifierLoc(), D);
218       if (auto CXXRD = dyn_cast<CXXRecordDecl>(D)) {
219         for (const auto &I : CXXRD->bases()) {
220           indexTypeSourceInfo(I.getTypeSourceInfo(), CXXRD, CXXRD, /*isBase=*/true);
221         }
222       }
223       indexDeclContext(D);
224     }
225   }
226 }
227