blob: 2ff5c9d8aeb5781121f04f7ce7a6aff39780793e [file] [log] [blame]
Ted Kremenekf8e32cf2008-06-20 21:40:36 +00001//===--- ParentMap.cpp - Mappings from Stmts to their Parents ---*- C++ -*-===//
2//
Chandler Carruth324f9182019-01-19 08:50:56 +00003// 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
Ted Kremenekf8e32cf2008-06-20 21:40:36 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the ParentMap class.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/AST/ParentMap.h"
Daniel Dunbaracc5f3e2008-08-11 06:23:49 +000014#include "clang/AST/Decl.h"
Ted Kremenekf8e32cf2008-06-20 21:40:36 +000015#include "clang/AST/Expr.h"
Jordan Rosefb6f75f2013-06-06 01:57:24 +000016#include "clang/AST/ExprCXX.h"
George Karpenkovab58e022018-03-08 02:53:39 +000017#include "clang/AST/StmtObjC.h"
Ted Kremenekf8e32cf2008-06-20 21:40:36 +000018#include "llvm/ADT/DenseMap.h"
19
20using namespace clang;
21
22typedef llvm::DenseMap<Stmt*, Stmt*> MapTy;
23
Jordan Rose1e5101e2012-10-06 01:19:36 +000024enum OpaqueValueMode {
25 OV_Transparent,
26 OV_Opaque
27};
28
Jordan Rosebb518992013-05-18 02:26:50 +000029static void BuildParentMap(MapTy& M, Stmt* S,
Jordan Rose1e5101e2012-10-06 01:19:36 +000030 OpaqueValueMode OVMode = OV_Transparent) {
Argyrios Kyrtzidisa8746872016-07-14 20:21:16 +000031 if (!S)
32 return;
Jordan Rose1e5101e2012-10-06 01:19:36 +000033
34 switch (S->getStmtClass()) {
35 case Stmt::PseudoObjectExprClass: {
36 assert(OVMode == OV_Transparent && "Should not appear alongside OVEs");
37 PseudoObjectExpr *POE = cast<PseudoObjectExpr>(S);
38
Jordan Roseb9fdfb52013-05-18 02:27:09 +000039 // If we are rebuilding the map, clear out any existing state.
40 if (M[POE->getSyntacticForm()])
Benjamin Kramer247b5bd2015-07-02 21:03:14 +000041 for (Stmt *SubStmt : S->children())
42 M[SubStmt] = nullptr;
Jordan Roseb9fdfb52013-05-18 02:27:09 +000043
Jordan Rosebb518992013-05-18 02:26:50 +000044 M[POE->getSyntacticForm()] = S;
45 BuildParentMap(M, POE->getSyntacticForm(), OV_Transparent);
Jordan Rose1e5101e2012-10-06 01:19:36 +000046
47 for (PseudoObjectExpr::semantics_iterator I = POE->semantics_begin(),
48 E = POE->semantics_end();
49 I != E; ++I) {
50 M[*I] = S;
Jordan Rosebb518992013-05-18 02:26:50 +000051 BuildParentMap(M, *I, OV_Opaque);
Jordan Rose1e5101e2012-10-06 01:19:36 +000052 }
53 break;
54 }
55 case Stmt::BinaryConditionalOperatorClass: {
56 assert(OVMode == OV_Transparent && "Should not appear alongside OVEs");
57 BinaryConditionalOperator *BCO = cast<BinaryConditionalOperator>(S);
58
59 M[BCO->getCommon()] = S;
Jordan Rosebb518992013-05-18 02:26:50 +000060 BuildParentMap(M, BCO->getCommon(), OV_Transparent);
Jordan Rose1e5101e2012-10-06 01:19:36 +000061
62 M[BCO->getCond()] = S;
Jordan Rosebb518992013-05-18 02:26:50 +000063 BuildParentMap(M, BCO->getCond(), OV_Opaque);
Jordan Rose1e5101e2012-10-06 01:19:36 +000064
65 M[BCO->getTrueExpr()] = S;
Jordan Rosebb518992013-05-18 02:26:50 +000066 BuildParentMap(M, BCO->getTrueExpr(), OV_Opaque);
Jordan Rose1e5101e2012-10-06 01:19:36 +000067
68 M[BCO->getFalseExpr()] = S;
Jordan Rosebb518992013-05-18 02:26:50 +000069 BuildParentMap(M, BCO->getFalseExpr(), OV_Transparent);
Jordan Rose1e5101e2012-10-06 01:19:36 +000070
71 break;
72 }
Jordan Roseb9fdfb52013-05-18 02:27:09 +000073 case Stmt::OpaqueValueExprClass: {
74 // FIXME: This isn't correct; it assumes that multiple OpaqueValueExprs
75 // share a single source expression, but in the AST a single
76 // OpaqueValueExpr is shared among multiple parent expressions.
77 // The right thing to do is to give the OpaqueValueExpr its syntactic
78 // parent, then not reassign that when traversing the semantic expressions.
79 OpaqueValueExpr *OVE = cast<OpaqueValueExpr>(S);
Serge Pavlovfa047c52013-05-18 04:32:15 +000080 if (OVMode == OV_Transparent || !M[OVE->getSourceExpr()]) {
Jordan Rose1e5101e2012-10-06 01:19:36 +000081 M[OVE->getSourceExpr()] = S;
Jordan Rosebb518992013-05-18 02:26:50 +000082 BuildParentMap(M, OVE->getSourceExpr(), OV_Transparent);
Jordan Rose1e5101e2012-10-06 01:19:36 +000083 }
84 break;
Jordan Roseb9fdfb52013-05-18 02:27:09 +000085 }
Alexey Bataev2688e582019-07-17 18:03:39 +000086 case Stmt::CapturedStmtClass:
87 for (Stmt *SubStmt : S->children()) {
88 if (SubStmt) {
89 M[SubStmt] = S;
90 BuildParentMap(M, SubStmt, OVMode);
91 }
92 }
93 if (Stmt *SubStmt = cast<CapturedStmt>(S)->getCapturedStmt()) {
94 M[SubStmt] = S;
95 BuildParentMap(M, SubStmt, OVMode);
96 }
97 break;
Jordan Rose1e5101e2012-10-06 01:19:36 +000098 default:
Benjamin Kramer247b5bd2015-07-02 21:03:14 +000099 for (Stmt *SubStmt : S->children()) {
100 if (SubStmt) {
101 M[SubStmt] = S;
102 BuildParentMap(M, SubStmt, OVMode);
Jordan Rose2b1b0252012-08-06 21:28:11 +0000103 }
Ted Kremenekf8e32cf2008-06-20 21:40:36 +0000104 }
Jordan Rose1e5101e2012-10-06 01:19:36 +0000105 break;
Jordan Rose2b1b0252012-08-06 21:28:11 +0000106 }
Ted Kremenekf8e32cf2008-06-20 21:40:36 +0000107}
108
Craig Topper613c4e12014-05-12 05:36:57 +0000109ParentMap::ParentMap(Stmt *S) : Impl(nullptr) {
Ted Kremenekf8e32cf2008-06-20 21:40:36 +0000110 if (S) {
111 MapTy *M = new MapTy();
Jordan Rosebb518992013-05-18 02:26:50 +0000112 BuildParentMap(*M, S);
Mike Stump1eb44332009-09-09 15:08:12 +0000113 Impl = M;
Ted Kremenekf8e32cf2008-06-20 21:40:36 +0000114 }
115}
116
117ParentMap::~ParentMap() {
118 delete (MapTy*) Impl;
119}
120
Ted Kremenekd6543f82010-11-15 20:54:24 +0000121void ParentMap::addStmt(Stmt* S) {
122 if (S) {
Jordan Rosebb518992013-05-18 02:26:50 +0000123 BuildParentMap(*(MapTy*) Impl, S);
Ted Kremenekd6543f82010-11-15 20:54:24 +0000124 }
125}
126
Jordan Rose49a246f2013-06-06 21:53:45 +0000127void ParentMap::setParent(const Stmt *S, const Stmt *Parent) {
128 assert(S);
129 assert(Parent);
130 MapTy *M = reinterpret_cast<MapTy *>(Impl);
131 M->insert(std::make_pair(const_cast<Stmt *>(S), const_cast<Stmt *>(Parent)));
132}
133
Ted Kremenekf8e32cf2008-06-20 21:40:36 +0000134Stmt* ParentMap::getParent(Stmt* S) const {
135 MapTy* M = (MapTy*) Impl;
136 MapTy::iterator I = M->find(S);
Craig Topper613c4e12014-05-12 05:36:57 +0000137 return I == M->end() ? nullptr : I->second;
Ted Kremenekf8e32cf2008-06-20 21:40:36 +0000138}
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000139
Ted Kremenekb1b9f682009-05-11 19:49:27 +0000140Stmt *ParentMap::getParentIgnoreParens(Stmt *S) const {
141 do { S = getParent(S); } while (S && isa<ParenExpr>(S));
142 return S;
143}
144
Ted Kremenekf4e532b2011-02-12 00:17:19 +0000145Stmt *ParentMap::getParentIgnoreParenCasts(Stmt *S) const {
146 do {
147 S = getParent(S);
148 }
149 while (S && (isa<ParenExpr>(S) || isa<CastExpr>(S)));
150
Fangrui Songabdbb602018-07-30 19:24:48 +0000151 return S;
Ted Kremenekf4e532b2011-02-12 00:17:19 +0000152}
153
Argyrios Kyrtzidis18fd0c62011-07-27 05:28:18 +0000154Stmt *ParentMap::getParentIgnoreParenImpCasts(Stmt *S) const {
155 do {
156 S = getParent(S);
157 } while (S && isa<Expr>(S) && cast<Expr>(S)->IgnoreParenImpCasts() != S);
158
159 return S;
160}
161
John McCallf85e1932011-06-15 23:02:42 +0000162Stmt *ParentMap::getOuterParenParent(Stmt *S) const {
Craig Topper613c4e12014-05-12 05:36:57 +0000163 Stmt *Paren = nullptr;
John McCallf85e1932011-06-15 23:02:42 +0000164 while (isa<ParenExpr>(S)) {
165 Paren = S;
166 S = getParent(S);
167 };
168 return Paren;
169}
170
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000171bool ParentMap::isConsumedExpr(Expr* E) const {
172 Stmt *P = getParent(E);
173 Stmt *DirectChild = E;
Mike Stump1eb44332009-09-09 15:08:12 +0000174
Jordan Rosefb6f75f2013-06-06 01:57:24 +0000175 // Ignore parents that don't guarantee consumption.
176 while (P && (isa<ParenExpr>(P) || isa<CastExpr>(P) ||
Bill Wendling0680f972018-10-31 03:48:47 +0000177 isa<FullExpr>(P))) {
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000178 DirectChild = P;
179 P = getParent(P);
180 }
Mike Stump1eb44332009-09-09 15:08:12 +0000181
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000182 if (!P)
183 return false;
Mike Stump1eb44332009-09-09 15:08:12 +0000184
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000185 switch (P->getStmtClass()) {
186 default:
187 return isa<Expr>(P);
188 case Stmt::DeclStmtClass:
189 return true;
190 case Stmt::BinaryOperatorClass: {
191 BinaryOperator *BE = cast<BinaryOperator>(P);
Ted Kremenek24ae89a2009-04-09 05:34:31 +0000192 // If it is a comma, only the right side is consumed.
Ted Kremeneke42ac982009-04-08 18:49:36 +0000193 // If it isn't a comma, both sides are consumed.
John McCall2de56d12010-08-25 11:45:40 +0000194 return BE->getOpcode()!=BO_Comma ||DirectChild==BE->getRHS();
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000195 }
196 case Stmt::ForStmtClass:
197 return DirectChild == cast<ForStmt>(P)->getCond();
198 case Stmt::WhileStmtClass:
Mike Stump1eb44332009-09-09 15:08:12 +0000199 return DirectChild == cast<WhileStmt>(P)->getCond();
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000200 case Stmt::DoStmtClass:
201 return DirectChild == cast<DoStmt>(P)->getCond();
202 case Stmt::IfStmtClass:
203 return DirectChild == cast<IfStmt>(P)->getCond();
204 case Stmt::IndirectGotoStmtClass:
205 return DirectChild == cast<IndirectGotoStmt>(P)->getTarget();
206 case Stmt::SwitchStmtClass:
207 return DirectChild == cast<SwitchStmt>(P)->getCond();
George Karpenkovab58e022018-03-08 02:53:39 +0000208 case Stmt::ObjCForCollectionStmtClass:
209 return DirectChild == cast<ObjCForCollectionStmt>(P)->getCollection();
Ted Kremenekb930d7a2009-04-01 06:52:48 +0000210 case Stmt::ReturnStmtClass:
211 return true;
212 }
213}
214