contrib/llvm/tools/clang/lib/Index/IndexBody.cpp

   1 //===- IndexBody.cpp - Indexing statements --------------------------------===//
   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 clang::index;
  15
  16 namespace {
  17
  18 class BodyIndexer : public RecursiveASTVisitor<BodyIndexer> {
  19   IndexingContext &IndexCtx;
  20   const NamedDecl *Parent;
  21   const DeclContext *ParentDC;
  22   SmallVector<Stmt*, 16> StmtStack;
  23
  24   typedef RecursiveASTVisitor<BodyIndexer> base;
  25
  26   Stmt *getParentStmt() const {
  27     return StmtStack.size() < 2 ? nullptr : StmtStack.end()[-2];
  28   }
  29 public:
  30   BodyIndexer(IndexingContext &indexCtx,
  31               const NamedDecl *Parent, const DeclContext *DC)
  32     : IndexCtx(indexCtx), Parent(Parent), ParentDC(DC) { }
  33
  34   bool shouldWalkTypesOfTypeLocs() const { return false; }
  35
  36   bool dataTraverseStmtPre(Stmt *S) {
  37     StmtStack.push_back(S);
  38     return true;
  39   }
  40
  41   bool dataTraverseStmtPost(Stmt *S) {
  42     assert(StmtStack.back() == S);
  43     StmtStack.pop_back();
  44     return true;
  45   }
  46
  47   bool TraverseTypeLoc(TypeLoc TL) {
  48     IndexCtx.indexTypeLoc(TL, Parent, ParentDC);
  49     return true;
  50   }
  51
  52   bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
  53     IndexCtx.indexNestedNameSpecifierLoc(NNS, Parent, ParentDC);
  54     return true;
  55   }
  56
  57   SymbolRoleSet getRolesForRef(const Expr *E,
  58                                SmallVectorImpl<SymbolRelation> &Relations) {
  59     SymbolRoleSet Roles{};
  60     assert(!StmtStack.empty() && E == StmtStack.back());
  61     if (StmtStack.size() == 1)
  62       return Roles;
  63     auto It = StmtStack.end()-2;
  64     while (isa<CastExpr>(*It) || isa<ParenExpr>(*It)) {
  65       if (auto ICE = dyn_cast<ImplicitCastExpr>(*It)) {
  66         if (ICE->getCastKind() == CK_LValueToRValue)
  67           Roles |= (unsigned)(unsigned)SymbolRole::Read;
  68       }
  69       if (It == StmtStack.begin())
  70         break;
  71       --It;
  72     }
  73     const Stmt *Parent = *It;
  74
  75     if (auto BO = dyn_cast<BinaryOperator>(Parent)) {
  76       if (BO->getOpcode() == BO_Assign && BO->getLHS()->IgnoreParenCasts() == E)
  77         Roles |= (unsigned)SymbolRole::Write;
  78
  79     } else if (auto UO = dyn_cast<UnaryOperator>(Parent)) {
  80       if (UO->isIncrementDecrementOp()) {
  81         Roles |= (unsigned)SymbolRole::Read;
  82         Roles |= (unsigned)SymbolRole::Write;
  83       } else if (UO->getOpcode() == UO_AddrOf) {
  84         Roles |= (unsigned)SymbolRole::AddressOf;
  85       }
  86
  87     } else if (auto CA = dyn_cast<CompoundAssignOperator>(Parent)) {
  88       if (CA->getLHS()->IgnoreParenCasts() == E) {
  89         Roles |= (unsigned)SymbolRole::Read;
  90         Roles |= (unsigned)SymbolRole::Write;
  91       }
  92
  93     } else if (auto CE = dyn_cast<CallExpr>(Parent)) {
  94       if (CE->getCallee()->IgnoreParenCasts() == E) {
  95         addCallRole(Roles, Relations);
  96         if (auto *ME = dyn_cast<MemberExpr>(E)) {
  97           if (auto *CXXMD = dyn_cast_or_null<CXXMethodDecl>(ME->getMemberDecl()))
  98             if (CXXMD->isVirtual() && !ME->hasQualifier()) {
  99               Roles |= (unsigned)SymbolRole::Dynamic;
 100               auto BaseTy = ME->getBase()->IgnoreImpCasts()->getType();
 101               if (!BaseTy.isNull())
 102                 if (auto *CXXRD = BaseTy->getPointeeCXXRecordDecl())
 103                   Relations.emplace_back((unsigned)SymbolRole::RelationReceivedBy,
 104                                          CXXRD);
 105             }
 106         }
 107       } else if (auto CXXOp = dyn_cast<CXXOperatorCallExpr>(CE)) {
 108         if (CXXOp->getNumArgs() > 0 && CXXOp->getArg(0)->IgnoreParenCasts() == E) {
 109           OverloadedOperatorKind Op = CXXOp->getOperator();
 110           if (Op == OO_Equal) {
 111             Roles |= (unsigned)SymbolRole::Write;
 112           } else if ((Op >= OO_PlusEqual && Op <= OO_PipeEqual) ||
 113                      Op == OO_LessLessEqual || Op == OO_GreaterGreaterEqual ||
 114                      Op == OO_PlusPlus || Op == OO_MinusMinus) {
 115             Roles |= (unsigned)SymbolRole::Read;
 116             Roles |= (unsigned)SymbolRole::Write;
 117           } else if (Op == OO_Amp) {
 118             Roles |= (unsigned)SymbolRole::AddressOf;
 119           }
 120         }
 121       }
 122     }
 123
 124     return Roles;
 125   }
 126
 127   void addCallRole(SymbolRoleSet &Roles,
 128                    SmallVectorImpl<SymbolRelation> &Relations) {
 129     Roles |= (unsigned)SymbolRole::Call;
 130     if (auto *FD = dyn_cast<FunctionDecl>(ParentDC))
 131       Relations.emplace_back((unsigned)SymbolRole::RelationCalledBy, FD);
 132     else if (auto *MD = dyn_cast<ObjCMethodDecl>(ParentDC))
 133       Relations.emplace_back((unsigned)SymbolRole::RelationCalledBy, MD);
 134   }
 135
 136   bool VisitDeclRefExpr(DeclRefExpr *E) {
 137     SmallVector<SymbolRelation, 4> Relations;
 138     SymbolRoleSet Roles = getRolesForRef(E, Relations);
 139     return IndexCtx.handleReference(E->getDecl(), E->getLocation(),
 140                                     Parent, ParentDC, Roles, Relations, E);
 141   }
 142
 143   bool VisitMemberExpr(MemberExpr *E) {
 144     SourceLocation Loc = E->getMemberLoc();
 145     if (Loc.isInvalid())
 146       Loc = E->getLocStart();
 147     SmallVector<SymbolRelation, 4> Relations;
 148     SymbolRoleSet Roles = getRolesForRef(E, Relations);
 149     return IndexCtx.handleReference(E->getMemberDecl(), Loc,
 150                                     Parent, ParentDC, Roles, Relations, E);
 151   }
 152
 153   bool indexDependentReference(
 154       const Expr *E, const Type *T, const DeclarationNameInfo &NameInfo,
 155       llvm::function_ref<bool(const NamedDecl *ND)> Filter) {
 156     if (!T)
 157       return true;
 158     const TemplateSpecializationType *TST =
 159         T->getAs<TemplateSpecializationType>();
 160     if (!TST)
 161       return true;
 162     TemplateName TN = TST->getTemplateName();
 163     const ClassTemplateDecl *TD =
 164         dyn_cast_or_null<ClassTemplateDecl>(TN.getAsTemplateDecl());
 165     if (!TD)
 166       return true;
 167     CXXRecordDecl *RD = TD->getTemplatedDecl();
 168     if (!RD->hasDefinition())
 169       return true;
 170     RD = RD->getDefinition();
 171     std::vector<const NamedDecl *> Symbols =
 172         RD->lookupDependentName(NameInfo.getName(), Filter);
 173     // FIXME: Improve overload handling.
 174     if (Symbols.size() != 1)
 175       return true;
 176     SourceLocation Loc = NameInfo.getLoc();
 177     if (Loc.isInvalid())
 178       Loc = E->getLocStart();
 179     SmallVector<SymbolRelation, 4> Relations;
 180     SymbolRoleSet Roles = getRolesForRef(E, Relations);
 181     return IndexCtx.handleReference(Symbols[0], Loc, Parent, ParentDC, Roles,
 182                                     Relations, E);
 183   }
 184
 185   bool VisitCXXDependentScopeMemberExpr(CXXDependentScopeMemberExpr *E) {
 186     const DeclarationNameInfo &Info = E->getMemberNameInfo();
 187     return indexDependentReference(
 188         E, E->getBaseType().getTypePtrOrNull(), Info,
 189         [](const NamedDecl *D) { return D->isCXXInstanceMember(); });
 190   }
 191
 192   bool VisitDependentScopeDeclRefExpr(DependentScopeDeclRefExpr *E) {
 193     const DeclarationNameInfo &Info = E->getNameInfo();
 194     const NestedNameSpecifier *NNS = E->getQualifier();
 195     return indexDependentReference(
 196         E, NNS->getAsType(), Info,
 197         [](const NamedDecl *D) { return !D->isCXXInstanceMember(); });
 198   }
 199
 200   bool VisitDesignatedInitExpr(DesignatedInitExpr *E) {
 201     for (DesignatedInitExpr::Designator &D : llvm::reverse(E->designators())) {
 202       if (D.isFieldDesignator() && D.getField())
 203         return IndexCtx.handleReference(D.getField(), D.getFieldLoc(), Parent,
 204                                         ParentDC, SymbolRoleSet(), {}, E);
 205     }
 206     return true;
 207   }
 208
 209   bool VisitObjCIvarRefExpr(ObjCIvarRefExpr *E) {
 210     SmallVector<SymbolRelation, 4> Relations;
 211     SymbolRoleSet Roles = getRolesForRef(E, Relations);
 212     return IndexCtx.handleReference(E->getDecl(), E->getLocation(),
 213                                     Parent, ParentDC, Roles, Relations, E);
 214   }
 215
 216   bool VisitObjCMessageExpr(ObjCMessageExpr *E) {
 217     auto isDynamic = [](const ObjCMessageExpr *MsgE)->bool {
 218       if (MsgE->getReceiverKind() != ObjCMessageExpr::Instance)
 219         return false;
 220       if (auto *RecE = dyn_cast<ObjCMessageExpr>(
 221               MsgE->getInstanceReceiver()->IgnoreParenCasts())) {
 222         if (RecE->getMethodFamily() == OMF_alloc)
 223           return false;
 224       }
 225       return true;
 226     };
 227
 228     if (ObjCMethodDecl *MD = E->getMethodDecl()) {
 229       SymbolRoleSet Roles{};
 230       SmallVector<SymbolRelation, 2> Relations;
 231       addCallRole(Roles, Relations);
 232       Stmt *Containing = getParentStmt();
 233       if (E->isImplicit() || (Containing && isa<PseudoObjectExpr>(Containing)))
 234         Roles |= (unsigned)SymbolRole::Implicit;
 235
 236       if (isDynamic(E)) {
 237         Roles |= (unsigned)SymbolRole::Dynamic;
 238         if (auto *RecD = E->getReceiverInterface())
 239           Relations.emplace_back((unsigned)SymbolRole::RelationReceivedBy, RecD);
 240       }
 241
 242       return IndexCtx.handleReference(MD, E->getSelectorStartLoc(),
 243                                       Parent, ParentDC, Roles, Relations, E);
 244     }
 245     return true;
 246   }
 247
 248   bool VisitObjCPropertyRefExpr(ObjCPropertyRefExpr *E) {
 249     if (E->isClassReceiver())
 250       IndexCtx.handleReference(E->getClassReceiver(), E->getReceiverLocation(),
 251                                Parent, ParentDC);
 252     if (E->isExplicitProperty()) {
 253       SmallVector<SymbolRelation, 2> Relations;
 254       SymbolRoleSet Roles = getRolesForRef(E, Relations);
 255       return IndexCtx.handleReference(E->getExplicitProperty(), E->getLocation(),
 256                                       Parent, ParentDC, Roles, Relations, E);
 257     }
 258
 259     // No need to do a handleReference for the objc method, because there will
 260     // be a message expr as part of PseudoObjectExpr.
 261     return true;
 262   }
 263
 264   bool VisitMSPropertyRefExpr(MSPropertyRefExpr *E) {
 265     return IndexCtx.handleReference(E->getPropertyDecl(), E->getMemberLoc(),
 266                                     Parent, ParentDC, SymbolRoleSet(), {}, E);
 267   }
 268
 269   bool VisitObjCProtocolExpr(ObjCProtocolExpr *E) {
 270     return IndexCtx.handleReference(E->getProtocol(), E->getProtocolIdLoc(),
 271                                     Parent, ParentDC, SymbolRoleSet(), {}, E);
 272   }
 273
 274   bool passObjCLiteralMethodCall(const ObjCMethodDecl *MD, const Expr *E) {
 275     SymbolRoleSet Roles{};
 276     SmallVector<SymbolRelation, 2> Relations;
 277     addCallRole(Roles, Relations);
 278     Roles |= (unsigned)SymbolRole::Implicit;
 279     return IndexCtx.handleReference(MD, E->getLocStart(),
 280                                     Parent, ParentDC, Roles, Relations, E);
 281   }
 282
 283   bool VisitObjCBoxedExpr(ObjCBoxedExpr *E) {
 284     if (ObjCMethodDecl *MD = E->getBoxingMethod()) {
 285       return passObjCLiteralMethodCall(MD, E);
 286     }
 287     return true;
 288   }
 289
 290   bool VisitObjCDictionaryLiteral(ObjCDictionaryLiteral *E) {
 291     if (ObjCMethodDecl *MD = E->getDictWithObjectsMethod()) {
 292       return passObjCLiteralMethodCall(MD, E);
 293     }
 294     return true;
 295   }
 296
 297   bool VisitObjCArrayLiteral(ObjCArrayLiteral *E) {
 298     if (ObjCMethodDecl *MD = E->getArrayWithObjectsMethod()) {
 299       return passObjCLiteralMethodCall(MD, E);
 300     }
 301     return true;
 302   }
 303
 304   bool VisitCXXConstructExpr(CXXConstructExpr *E) {
 305     SymbolRoleSet Roles{};
 306     SmallVector<SymbolRelation, 2> Relations;
 307     addCallRole(Roles, Relations);
 308     return IndexCtx.handleReference(E->getConstructor(), E->getLocation(),
 309                                     Parent, ParentDC, Roles, Relations, E);
 310   }
 311
 312   bool TraverseCXXOperatorCallExpr(CXXOperatorCallExpr *E,
 313                                    DataRecursionQueue *Q = nullptr) {
 314     if (E->getOperatorLoc().isInvalid())
 315       return true; // implicit.
 316     return base::TraverseCXXOperatorCallExpr(E, Q);
 317   }
 318
 319   bool VisitDeclStmt(DeclStmt *S) {
 320     if (IndexCtx.shouldIndexFunctionLocalSymbols()) {
 321       IndexCtx.indexDeclGroupRef(S->getDeclGroup());
 322       return true;
 323     }
 324
 325     DeclGroupRef DG = S->getDeclGroup();
 326     for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I) {
 327       const Decl *D = *I;
 328       if (!D)
 329         continue;
 330       if (!isFunctionLocalSymbol(D))
 331         IndexCtx.indexTopLevelDecl(D);
 332     }
 333
 334     return true;
 335   }
 336
 337   bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C,
 338                              Expr *Init) {
 339     if (C->capturesThis() || C->capturesVLAType())
 340       return true;
 341
 342     if (C->capturesVariable() && IndexCtx.shouldIndexFunctionLocalSymbols())
 343       return IndexCtx.handleReference(C->getCapturedVar(), C->getLocation(),
 344                                       Parent, ParentDC, SymbolRoleSet());
 345
 346     // FIXME: Lambda init-captures.
 347     return true;
 348   }
 349
 350   // RecursiveASTVisitor visits both syntactic and semantic forms, duplicating
 351   // the things that we visit. Make sure to only visit the semantic form.
 352   // Also visit things that are in the syntactic form but not the semantic one,
 353   // for example the indices in DesignatedInitExprs.
 354   bool TraverseInitListExpr(InitListExpr *S, DataRecursionQueue *Q = nullptr) {
 355     auto visitForm = [&](InitListExpr *Form) {
 356       for (Stmt *SubStmt : Form->children()) {
 357         if (!TraverseStmt(SubStmt, Q))
 358           return false;
 359       }
 360       return true;
 361     };
 362
 363     auto visitSyntacticDesignatedInitExpr = [&](DesignatedInitExpr *E) -> bool {
 364       for (DesignatedInitExpr::Designator &D : llvm::reverse(E->designators())) {
 365         if (D.isFieldDesignator())
 366           return IndexCtx.handleReference(D.getField(), D.getFieldLoc(),
 367                                           Parent, ParentDC, SymbolRoleSet(),
 368                                           {}, E);
 369       }
 370       return true;
 371     };
 372
 373     InitListExpr *SemaForm = S->isSemanticForm() ? S : S->getSemanticForm();
 374     InitListExpr *SyntaxForm = S->isSemanticForm() ? S->getSyntacticForm() : S;
 375
 376     if (SemaForm) {
 377       // Visit things present in syntactic form but not the semantic form.
 378       if (SyntaxForm) {
 379         for (Expr *init : SyntaxForm->inits()) {
 380           if (auto *DIE = dyn_cast<DesignatedInitExpr>(init))
 381             visitSyntacticDesignatedInitExpr(DIE);
 382         }
 383       }
 384       return visitForm(SemaForm);
 385     }
 386
 387     // No semantic, try the syntactic.
 388     if (SyntaxForm) {
 389       return visitForm(SyntaxForm);
 390     }
 391
 392     return true;
 393   }
 394 };
 395
 396 } // anonymous namespace
 397
 398 void IndexingContext::indexBody(const Stmt *S, const NamedDecl *Parent,
 399                                 const DeclContext *DC) {
 400   if (!S)
 401     return;
 402
 403   if (!DC)
 404     DC = Parent->getLexicalDeclContext();
 405   BodyIndexer(*this, Parent, DC).TraverseStmt(const_cast<Stmt*>(S));
 406 }