blob: 6785a0c2935ad09c87df9bb90abf170ae9fd2422 [file] [log] [blame]
Douglas Gregor36d1b142009-10-06 17:59:45 +00001//===------ CXXInheritance.cpp - C++ Inheritance ----------------*- C++ -*-===//
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// This file provides routines that help analyzing C++ inheritance hierarchies.
11//
12//===----------------------------------------------------------------------===//
13#include "clang/AST/CXXInheritance.h"
Benjamin Kramer2ef30312012-07-04 18:45:14 +000014#include "clang/AST/ASTContext.h"
Douglas Gregor36d1b142009-10-06 17:59:45 +000015#include "clang/AST/DeclCXX.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000016#include "clang/AST/RecordLayout.h"
Douglas Gregor18e1b522012-09-11 07:19:42 +000017#include "llvm/ADT/SetVector.h"
Douglas Gregor36d1b142009-10-06 17:59:45 +000018#include <algorithm>
19#include <set>
20
21using namespace clang;
22
23/// \brief Computes the set of declarations referenced by these base
24/// paths.
25void CXXBasePaths::ComputeDeclsFound() {
26 assert(NumDeclsFound == 0 && !DeclsFound &&
27 "Already computed the set of declarations");
Benjamin Kramer91c6b6a2012-02-23 15:18:31 +000028
Douglas Gregor18e1b522012-09-11 07:19:42 +000029 llvm::SetVector<NamedDecl *, SmallVector<NamedDecl *, 8> > Decls;
Benjamin Kramer91c6b6a2012-02-23 15:18:31 +000030 for (paths_iterator Path = begin(), PathEnd = end(); Path != PathEnd; ++Path)
David Blaikieff7d47a2012-12-19 00:45:41 +000031 Decls.insert(Path->Decls.front());
Benjamin Kramer91c6b6a2012-02-23 15:18:31 +000032
Douglas Gregor36d1b142009-10-06 17:59:45 +000033 NumDeclsFound = Decls.size();
David Blaikie8f2a7fe2015-08-18 23:56:00 +000034 DeclsFound = llvm::make_unique<NamedDecl *[]>(NumDeclsFound);
35 std::copy(Decls.begin(), Decls.end(), DeclsFound.get());
Douglas Gregor36d1b142009-10-06 17:59:45 +000036}
37
Aaron Ballmane6f465e2014-03-14 21:38:48 +000038CXXBasePaths::decl_range CXXBasePaths::found_decls() {
Douglas Gregor36d1b142009-10-06 17:59:45 +000039 if (NumDeclsFound == 0)
40 ComputeDeclsFound();
Douglas Gregor36d1b142009-10-06 17:59:45 +000041
David Blaikie8f2a7fe2015-08-18 23:56:00 +000042 return decl_range(decl_iterator(DeclsFound.get()),
43 decl_iterator(DeclsFound.get() + NumDeclsFound));
Douglas Gregor36d1b142009-10-06 17:59:45 +000044}
45
46/// isAmbiguous - Determines whether the set of paths provided is
47/// ambiguous, i.e., there are two or more paths that refer to
48/// different base class subobjects of the same type. BaseType must be
49/// an unqualified, canonical class type.
Douglas Gregor27ac4292010-05-21 20:29:55 +000050bool CXXBasePaths::isAmbiguous(CanQualType BaseType) {
51 BaseType = BaseType.getUnqualifiedType();
Douglas Gregor36d1b142009-10-06 17:59:45 +000052 std::pair<bool, unsigned>& Subobjects = ClassSubobjects[BaseType];
53 return Subobjects.second + (Subobjects.first? 1 : 0) > 1;
54}
55
56/// clear - Clear out all prior path information.
57void CXXBasePaths::clear() {
58 Paths.clear();
59 ClassSubobjects.clear();
60 ScratchPath.clear();
Craig Topper36250ad2014-05-12 05:36:57 +000061 DetectedVirtual = nullptr;
Douglas Gregor36d1b142009-10-06 17:59:45 +000062}
63
64/// @brief Swaps the contents of this CXXBasePaths structure with the
65/// contents of Other.
66void CXXBasePaths::swap(CXXBasePaths &Other) {
67 std::swap(Origin, Other.Origin);
68 Paths.swap(Other.Paths);
69 ClassSubobjects.swap(Other.ClassSubobjects);
70 std::swap(FindAmbiguities, Other.FindAmbiguities);
71 std::swap(RecordPaths, Other.RecordPaths);
72 std::swap(DetectVirtual, Other.DetectVirtual);
73 std::swap(DetectedVirtual, Other.DetectedVirtual);
74}
75
John McCall388ef532011-01-28 22:02:36 +000076bool CXXRecordDecl::isDerivedFrom(const CXXRecordDecl *Base) const {
Douglas Gregor36d1b142009-10-06 17:59:45 +000077 CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/false,
78 /*DetectVirtual=*/false);
79 return isDerivedFrom(Base, Paths);
80}
81
John McCall388ef532011-01-28 22:02:36 +000082bool CXXRecordDecl::isDerivedFrom(const CXXRecordDecl *Base,
83 CXXBasePaths &Paths) const {
Douglas Gregor36d1b142009-10-06 17:59:45 +000084 if (getCanonicalDecl() == Base->getCanonicalDecl())
85 return false;
86
John McCall84c16cf2009-11-12 03:15:40 +000087 Paths.setOrigin(const_cast<CXXRecordDecl*>(this));
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +000088
89 const CXXRecordDecl *BaseDecl = Base->getCanonicalDecl();
Benjamin Kramer1d38be92015-07-25 15:27:04 +000090 // FIXME: Capturing 'this' is a workaround for name lookup bugs in GCC 4.7.
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +000091 return lookupInBases(
Benjamin Kramer1d38be92015-07-25 15:27:04 +000092 [this, BaseDecl](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) {
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +000093 return FindBaseClass(Specifier, Path, BaseDecl);
94 },
95 Paths);
Douglas Gregor36d1b142009-10-06 17:59:45 +000096}
97
Jordan Rose55edf5ff2012-08-08 18:23:20 +000098bool CXXRecordDecl::isVirtuallyDerivedFrom(const CXXRecordDecl *Base) const {
Anders Carlsson15722da2010-06-04 01:40:08 +000099 if (!getNumVBases())
100 return false;
101
Douglas Gregor3e637462010-03-03 04:38:46 +0000102 CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/false,
103 /*DetectVirtual=*/false);
104
105 if (getCanonicalDecl() == Base->getCanonicalDecl())
106 return false;
107
Jordan Rose55edf5ff2012-08-08 18:23:20 +0000108 Paths.setOrigin(const_cast<CXXRecordDecl*>(this));
109
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000110 const CXXRecordDecl *BaseDecl = Base->getCanonicalDecl();
Benjamin Kramer1d38be92015-07-25 15:27:04 +0000111 // FIXME: Capturing 'this' is a workaround for name lookup bugs in GCC 4.7.
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000112 return lookupInBases(
Benjamin Kramer1d38be92015-07-25 15:27:04 +0000113 [this, BaseDecl](const CXXBaseSpecifier *Specifier, CXXBasePath &Path) {
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000114 return FindVirtualBaseClass(Specifier, Path, BaseDecl);
115 },
116 Paths);
John McCallddabf1a2009-12-08 07:42:38 +0000117}
118
119bool CXXRecordDecl::isProvablyNotDerivedFrom(const CXXRecordDecl *Base) const {
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000120 const CXXRecordDecl *TargetDecl = Base->getCanonicalDecl();
121 return forallBases([TargetDecl](const CXXRecordDecl *Base) {
122 return Base->getCanonicalDecl() != TargetDecl;
123 });
John McCallddabf1a2009-12-08 07:42:38 +0000124}
125
Richard Smithd80b2d52012-11-22 00:24:47 +0000126bool
127CXXRecordDecl::isCurrentInstantiation(const DeclContext *CurContext) const {
128 assert(isDependentContext());
129
130 for (; !CurContext->isFileContext(); CurContext = CurContext->getParent())
131 if (CurContext->Equals(this))
132 return true;
133
134 return false;
135}
136
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000137bool CXXRecordDecl::forallBases(ForallBasesCallback BaseMatches,
Douglas Gregordc974572012-11-10 07:24:09 +0000138 bool AllowShortCircuit) const {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000139 SmallVector<const CXXRecordDecl*, 8> Queue;
John McCallddabf1a2009-12-08 07:42:38 +0000140
141 const CXXRecordDecl *Record = this;
142 bool AllMatches = true;
143 while (true) {
Aaron Ballman574705e2014-03-13 15:41:46 +0000144 for (const auto &I : Record->bases()) {
145 const RecordType *Ty = I.getType()->getAs<RecordType>();
Douglas Gregordc974572012-11-10 07:24:09 +0000146 if (!Ty) {
John McCallddabf1a2009-12-08 07:42:38 +0000147 if (AllowShortCircuit) return false;
148 AllMatches = false;
149 continue;
150 }
151
Douglas Gregordc974572012-11-10 07:24:09 +0000152 CXXRecordDecl *Base =
153 cast_or_null<CXXRecordDecl>(Ty->getDecl()->getDefinition());
Richard Smithd80b2d52012-11-22 00:24:47 +0000154 if (!Base ||
155 (Base->isDependentContext() &&
156 !Base->isCurrentInstantiation(Record))) {
John McCallddabf1a2009-12-08 07:42:38 +0000157 if (AllowShortCircuit) return false;
158 AllMatches = false;
159 continue;
160 }
161
Anders Carlssonf9812782009-12-09 04:26:02 +0000162 Queue.push_back(Base);
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000163 if (!BaseMatches(Base)) {
John McCallddabf1a2009-12-08 07:42:38 +0000164 if (AllowShortCircuit) return false;
165 AllMatches = false;
166 continue;
167 }
168 }
169
Robert Wilhelm25284cc2013-08-23 16:11:15 +0000170 if (Queue.empty())
171 break;
172 Record = Queue.pop_back_val(); // not actually a queue.
John McCallddabf1a2009-12-08 07:42:38 +0000173 }
174
175 return AllMatches;
176}
177
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000178bool CXXBasePaths::lookupInBases(
179 ASTContext &Context, const CXXRecordDecl *Record,
180 CXXRecordDecl::BaseMatchesCallback BaseMatches) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000181 bool FoundPath = false;
John McCall401982f2010-01-20 21:53:11 +0000182
John McCall553c0792010-01-23 00:46:32 +0000183 // The access of the path down to this record.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000184 AccessSpecifier AccessToHere = ScratchPath.Access;
185 bool IsFirstStep = ScratchPath.empty();
John McCall553c0792010-01-23 00:46:32 +0000186
Aaron Ballman574705e2014-03-13 15:41:46 +0000187 for (const auto &BaseSpec : Record->bases()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000188 // Find the record of the base class subobjects for this type.
Aaron Ballman574705e2014-03-13 15:41:46 +0000189 QualType BaseType =
190 Context.getCanonicalType(BaseSpec.getType()).getUnqualifiedType();
191
Douglas Gregor36d1b142009-10-06 17:59:45 +0000192 // C++ [temp.dep]p3:
193 // In the definition of a class template or a member of a class template,
194 // if a base class of the class template depends on a template-parameter,
195 // the base class scope is not examined during unqualified name lookup
196 // either at the point of definition of the class template or member or
197 // during an instantiation of the class tem- plate or member.
198 if (BaseType->isDependentType())
199 continue;
200
201 // Determine whether we need to visit this base class at all,
202 // updating the count of subobjects appropriately.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000203 std::pair<bool, unsigned>& Subobjects = ClassSubobjects[BaseType];
Douglas Gregor36d1b142009-10-06 17:59:45 +0000204 bool VisitBase = true;
205 bool SetVirtual = false;
Aaron Ballman574705e2014-03-13 15:41:46 +0000206 if (BaseSpec.isVirtual()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000207 VisitBase = !Subobjects.first;
208 Subobjects.first = true;
Craig Topper36250ad2014-05-12 05:36:57 +0000209 if (isDetectingVirtual() && DetectedVirtual == nullptr) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000210 // If this is the first virtual we find, remember it. If it turns out
211 // there is no base path here, we'll reset it later.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000212 DetectedVirtual = BaseType->getAs<RecordType>();
Douglas Gregor36d1b142009-10-06 17:59:45 +0000213 SetVirtual = true;
214 }
215 } else
216 ++Subobjects.second;
217
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000218 if (isRecordingPaths()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000219 // Add this base specifier to the current path.
220 CXXBasePathElement Element;
Aaron Ballman574705e2014-03-13 15:41:46 +0000221 Element.Base = &BaseSpec;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000222 Element.Class = Record;
Aaron Ballman574705e2014-03-13 15:41:46 +0000223 if (BaseSpec.isVirtual())
Douglas Gregor36d1b142009-10-06 17:59:45 +0000224 Element.SubobjectNumber = 0;
225 else
226 Element.SubobjectNumber = Subobjects.second;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000227 ScratchPath.push_back(Element);
John McCall401982f2010-01-20 21:53:11 +0000228
John McCall553c0792010-01-23 00:46:32 +0000229 // Calculate the "top-down" access to this base class.
230 // The spec actually describes this bottom-up, but top-down is
231 // equivalent because the definition works out as follows:
232 // 1. Write down the access along each step in the inheritance
233 // chain, followed by the access of the decl itself.
234 // For example, in
235 // class A { public: int foo; };
236 // class B : protected A {};
237 // class C : public B {};
238 // class D : private C {};
239 // we would write:
240 // private public protected public
241 // 2. If 'private' appears anywhere except far-left, access is denied.
242 // 3. Otherwise, overall access is determined by the most restrictive
243 // access in the sequence.
244 if (IsFirstStep)
Aaron Ballman574705e2014-03-13 15:41:46 +0000245 ScratchPath.Access = BaseSpec.getAccessSpecifier();
John McCall553c0792010-01-23 00:46:32 +0000246 else
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000247 ScratchPath.Access = CXXRecordDecl::MergeAccess(AccessToHere,
Aaron Ballman574705e2014-03-13 15:41:46 +0000248 BaseSpec.getAccessSpecifier());
Douglas Gregor36d1b142009-10-06 17:59:45 +0000249 }
John McCall6f891402010-02-09 00:57:12 +0000250
251 // Track whether there's a path involving this specific base.
252 bool FoundPathThroughBase = false;
253
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000254 if (BaseMatches(&BaseSpec, ScratchPath)) {
John McCall553c0792010-01-23 00:46:32 +0000255 // We've found a path that terminates at this base.
John McCall6f891402010-02-09 00:57:12 +0000256 FoundPath = FoundPathThroughBase = true;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000257 if (isRecordingPaths()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000258 // We have a path. Make a copy of it before moving on.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000259 Paths.push_back(ScratchPath);
260 } else if (!isFindingAmbiguities()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000261 // We found a path and we don't care about ambiguities;
262 // return immediately.
263 return FoundPath;
264 }
265 } else if (VisitBase) {
266 CXXRecordDecl *BaseRecord
Aaron Ballman574705e2014-03-13 15:41:46 +0000267 = cast<CXXRecordDecl>(BaseSpec.getType()->castAs<RecordType>()
Douglas Gregor36d1b142009-10-06 17:59:45 +0000268 ->getDecl());
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000269 if (lookupInBases(Context, BaseRecord, BaseMatches)) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000270 // C++ [class.member.lookup]p2:
271 // A member name f in one sub-object B hides a member name f in
272 // a sub-object A if A is a base class sub-object of B. Any
273 // declarations that are so hidden are eliminated from
274 // consideration.
275
276 // There is a path to a base class that meets the criteria. If we're
277 // not collecting paths or finding ambiguities, we're done.
John McCall6f891402010-02-09 00:57:12 +0000278 FoundPath = FoundPathThroughBase = true;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000279 if (!isFindingAmbiguities())
Douglas Gregor36d1b142009-10-06 17:59:45 +0000280 return FoundPath;
281 }
282 }
283
284 // Pop this base specifier off the current path (if we're
285 // collecting paths).
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000286 if (isRecordingPaths()) {
287 ScratchPath.pop_back();
John McCall401982f2010-01-20 21:53:11 +0000288 }
289
Douglas Gregor36d1b142009-10-06 17:59:45 +0000290 // If we set a virtual earlier, and this isn't a path, forget it again.
John McCall6f891402010-02-09 00:57:12 +0000291 if (SetVirtual && !FoundPathThroughBase) {
Craig Topper36250ad2014-05-12 05:36:57 +0000292 DetectedVirtual = nullptr;
Douglas Gregor36d1b142009-10-06 17:59:45 +0000293 }
294 }
John McCall553c0792010-01-23 00:46:32 +0000295
296 // Reset the scratch path access.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000297 ScratchPath.Access = AccessToHere;
Douglas Gregor36d1b142009-10-06 17:59:45 +0000298
299 return FoundPath;
300}
301
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000302bool CXXRecordDecl::lookupInBases(BaseMatchesCallback BaseMatches,
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000303 CXXBasePaths &Paths) const {
Douglas Gregor3e637462010-03-03 04:38:46 +0000304 // If we didn't find anything, report that.
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000305 if (!Paths.lookupInBases(getASTContext(), this, BaseMatches))
Douglas Gregor3e637462010-03-03 04:38:46 +0000306 return false;
307
308 // If we're not recording paths or we won't ever find ambiguities,
309 // we're done.
310 if (!Paths.isRecordingPaths() || !Paths.isFindingAmbiguities())
311 return true;
312
313 // C++ [class.member.lookup]p6:
314 // When virtual base classes are used, a hidden declaration can be
315 // reached along a path through the sub-object lattice that does
316 // not pass through the hiding declaration. This is not an
317 // ambiguity. The identical use with nonvirtual base classes is an
318 // ambiguity; in that case there is no unique instance of the name
319 // that hides all the others.
320 //
321 // FIXME: This is an O(N^2) algorithm, but DPG doesn't see an easy
322 // way to make it any faster.
Benjamin Kramerece036e2015-02-11 19:09:16 +0000323 Paths.Paths.remove_if([&Paths](const CXXBasePath &Path) {
324 for (const CXXBasePathElement &PE : Path) {
325 if (!PE.Base->isVirtual())
326 continue;
Douglas Gregor3e637462010-03-03 04:38:46 +0000327
Benjamin Kramerece036e2015-02-11 19:09:16 +0000328 CXXRecordDecl *VBase = nullptr;
329 if (const RecordType *Record = PE.Base->getType()->getAs<RecordType>())
330 VBase = cast<CXXRecordDecl>(Record->getDecl());
331 if (!VBase)
332 break;
333
334 // The declaration(s) we found along this path were found in a
335 // subobject of a virtual base. Check whether this virtual
336 // base is a subobject of any other path; if so, then the
337 // declaration in this path are hidden by that patch.
338 for (const CXXBasePath &HidingP : Paths) {
339 CXXRecordDecl *HidingClass = nullptr;
340 if (const RecordType *Record =
341 HidingP.back().Base->getType()->getAs<RecordType>())
342 HidingClass = cast<CXXRecordDecl>(Record->getDecl());
343 if (!HidingClass)
Douglas Gregor3e637462010-03-03 04:38:46 +0000344 break;
345
Benjamin Kramerece036e2015-02-11 19:09:16 +0000346 if (HidingClass->isVirtuallyDerivedFrom(VBase))
347 return true;
Douglas Gregor3e637462010-03-03 04:38:46 +0000348 }
349 }
Benjamin Kramerece036e2015-02-11 19:09:16 +0000350 return false;
351 });
Douglas Gregor3e637462010-03-03 04:38:46 +0000352
Douglas Gregor3e637462010-03-03 04:38:46 +0000353 return true;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000354}
355
John McCall84c16cf2009-11-12 03:15:40 +0000356bool CXXRecordDecl::FindBaseClass(const CXXBaseSpecifier *Specifier,
Douglas Gregor36d1b142009-10-06 17:59:45 +0000357 CXXBasePath &Path,
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000358 const CXXRecordDecl *BaseRecord) {
Benjamin Kramer1d38be92015-07-25 15:27:04 +0000359 assert(BaseRecord->getCanonicalDecl() == BaseRecord &&
Douglas Gregor36d1b142009-10-06 17:59:45 +0000360 "User data for FindBaseClass is not canonical!");
Ted Kremenek28831752012-08-23 20:46:57 +0000361 return Specifier->getType()->castAs<RecordType>()->getDecl()
362 ->getCanonicalDecl() == BaseRecord;
Douglas Gregor36d1b142009-10-06 17:59:45 +0000363}
364
Douglas Gregor3e637462010-03-03 04:38:46 +0000365bool CXXRecordDecl::FindVirtualBaseClass(const CXXBaseSpecifier *Specifier,
366 CXXBasePath &Path,
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000367 const CXXRecordDecl *BaseRecord) {
Benjamin Kramer1d38be92015-07-25 15:27:04 +0000368 assert(BaseRecord->getCanonicalDecl() == BaseRecord &&
Douglas Gregor3e637462010-03-03 04:38:46 +0000369 "User data for FindBaseClass is not canonical!");
370 return Specifier->isVirtual() &&
Ted Kremenek28831752012-08-23 20:46:57 +0000371 Specifier->getType()->castAs<RecordType>()->getDecl()
372 ->getCanonicalDecl() == BaseRecord;
Douglas Gregor3e637462010-03-03 04:38:46 +0000373}
374
John McCall84c16cf2009-11-12 03:15:40 +0000375bool CXXRecordDecl::FindTagMember(const CXXBaseSpecifier *Specifier,
Douglas Gregor36d1b142009-10-06 17:59:45 +0000376 CXXBasePath &Path,
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000377 DeclarationName Name) {
Ted Kremenek28831752012-08-23 20:46:57 +0000378 RecordDecl *BaseRecord =
379 Specifier->getType()->castAs<RecordType>()->getDecl();
Douglas Gregor36d1b142009-10-06 17:59:45 +0000380
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000381 for (Path.Decls = BaseRecord->lookup(Name);
David Blaikieff7d47a2012-12-19 00:45:41 +0000382 !Path.Decls.empty();
383 Path.Decls = Path.Decls.slice(1)) {
384 if (Path.Decls.front()->isInIdentifierNamespace(IDNS_Tag))
Douglas Gregor36d1b142009-10-06 17:59:45 +0000385 return true;
386 }
387
388 return false;
389}
390
John McCall84c16cf2009-11-12 03:15:40 +0000391bool CXXRecordDecl::FindOrdinaryMember(const CXXBaseSpecifier *Specifier,
Douglas Gregor36d1b142009-10-06 17:59:45 +0000392 CXXBasePath &Path,
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000393 DeclarationName Name) {
Ted Kremenek28831752012-08-23 20:46:57 +0000394 RecordDecl *BaseRecord =
395 Specifier->getType()->castAs<RecordType>()->getDecl();
Douglas Gregor36d1b142009-10-06 17:59:45 +0000396
397 const unsigned IDNS = IDNS_Ordinary | IDNS_Tag | IDNS_Member;
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000398 for (Path.Decls = BaseRecord->lookup(Name);
David Blaikieff7d47a2012-12-19 00:45:41 +0000399 !Path.Decls.empty();
400 Path.Decls = Path.Decls.slice(1)) {
401 if (Path.Decls.front()->isInIdentifierNamespace(IDNS))
Douglas Gregor36d1b142009-10-06 17:59:45 +0000402 return true;
403 }
404
405 return false;
406}
407
John McCall84c16cf2009-11-12 03:15:40 +0000408bool CXXRecordDecl::
409FindNestedNameSpecifierMember(const CXXBaseSpecifier *Specifier,
410 CXXBasePath &Path,
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000411 DeclarationName Name) {
Ted Kremenek28831752012-08-23 20:46:57 +0000412 RecordDecl *BaseRecord =
413 Specifier->getType()->castAs<RecordType>()->getDecl();
Douglas Gregor36d1b142009-10-06 17:59:45 +0000414
Benjamin Kramer6e4f6e12015-07-25 15:07:25 +0000415 for (Path.Decls = BaseRecord->lookup(Name);
David Blaikieff7d47a2012-12-19 00:45:41 +0000416 !Path.Decls.empty();
417 Path.Decls = Path.Decls.slice(1)) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000418 // FIXME: Refactor the "is it a nested-name-specifier?" check
David Blaikieff7d47a2012-12-19 00:45:41 +0000419 if (isa<TypedefNameDecl>(Path.Decls.front()) ||
420 Path.Decls.front()->isInIdentifierNamespace(IDNS_Tag))
Douglas Gregor36d1b142009-10-06 17:59:45 +0000421 return true;
422 }
423
424 return false;
Mike Stump512c5b72009-10-06 23:38:59 +0000425}
Douglas Gregor4165bd62010-03-23 23:47:56 +0000426
427void OverridingMethods::add(unsigned OverriddenSubobject,
428 UniqueVirtualMethod Overriding) {
Craig Topper2341c0d2013-07-04 03:08:24 +0000429 SmallVectorImpl<UniqueVirtualMethod> &SubobjectOverrides
Douglas Gregor4165bd62010-03-23 23:47:56 +0000430 = Overrides[OverriddenSubobject];
431 if (std::find(SubobjectOverrides.begin(), SubobjectOverrides.end(),
432 Overriding) == SubobjectOverrides.end())
433 SubobjectOverrides.push_back(Overriding);
434}
435
436void OverridingMethods::add(const OverridingMethods &Other) {
437 for (const_iterator I = Other.begin(), IE = Other.end(); I != IE; ++I) {
438 for (overriding_const_iterator M = I->second.begin(),
439 MEnd = I->second.end();
440 M != MEnd;
441 ++M)
442 add(I->first, *M);
443 }
444}
445
446void OverridingMethods::replaceAll(UniqueVirtualMethod Overriding) {
447 for (iterator I = begin(), IEnd = end(); I != IEnd; ++I) {
448 I->second.clear();
449 I->second.push_back(Overriding);
450 }
451}
452
453
454namespace {
455 class FinalOverriderCollector {
456 /// \brief The number of subobjects of a given class type that
457 /// occur within the class hierarchy.
458 llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCount;
459
460 /// \brief Overriders for each virtual base subobject.
461 llvm::DenseMap<const CXXRecordDecl *, CXXFinalOverriderMap *> VirtualOverriders;
462
463 CXXFinalOverriderMap FinalOverriders;
464
465 public:
466 ~FinalOverriderCollector();
467
468 void Collect(const CXXRecordDecl *RD, bool VirtualBase,
469 const CXXRecordDecl *InVirtualSubobject,
470 CXXFinalOverriderMap &Overriders);
471 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000472}
Douglas Gregor4165bd62010-03-23 23:47:56 +0000473
474void FinalOverriderCollector::Collect(const CXXRecordDecl *RD,
475 bool VirtualBase,
476 const CXXRecordDecl *InVirtualSubobject,
477 CXXFinalOverriderMap &Overriders) {
478 unsigned SubobjectNumber = 0;
479 if (!VirtualBase)
480 SubobjectNumber
481 = ++SubobjectCount[cast<CXXRecordDecl>(RD->getCanonicalDecl())];
482
Aaron Ballman574705e2014-03-13 15:41:46 +0000483 for (const auto &Base : RD->bases()) {
484 if (const RecordType *RT = Base.getType()->getAs<RecordType>()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000485 const CXXRecordDecl *BaseDecl = cast<CXXRecordDecl>(RT->getDecl());
486 if (!BaseDecl->isPolymorphic())
487 continue;
488
Aaron Ballman574705e2014-03-13 15:41:46 +0000489 if (Overriders.empty() && !Base.isVirtual()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000490 // There are no other overriders of virtual member functions,
491 // so let the base class fill in our overriders for us.
492 Collect(BaseDecl, false, InVirtualSubobject, Overriders);
493 continue;
494 }
495
496 // Collect all of the overridders from the base class subobject
497 // and merge them into the set of overridders for this class.
498 // For virtual base classes, populate or use the cached virtual
499 // overrides so that we do not walk the virtual base class (and
500 // its base classes) more than once.
501 CXXFinalOverriderMap ComputedBaseOverriders;
502 CXXFinalOverriderMap *BaseOverriders = &ComputedBaseOverriders;
Aaron Ballman574705e2014-03-13 15:41:46 +0000503 if (Base.isVirtual()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000504 CXXFinalOverriderMap *&MyVirtualOverriders = VirtualOverriders[BaseDecl];
Benjamin Kramerea388a22012-05-27 22:41:08 +0000505 BaseOverriders = MyVirtualOverriders;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000506 if (!MyVirtualOverriders) {
507 MyVirtualOverriders = new CXXFinalOverriderMap;
Benjamin Kramerea388a22012-05-27 22:41:08 +0000508
509 // Collect may cause VirtualOverriders to reallocate, invalidating the
510 // MyVirtualOverriders reference. Set BaseOverriders to the right
511 // value now.
512 BaseOverriders = MyVirtualOverriders;
513
Douglas Gregor4165bd62010-03-23 23:47:56 +0000514 Collect(BaseDecl, true, BaseDecl, *MyVirtualOverriders);
515 }
Douglas Gregor4165bd62010-03-23 23:47:56 +0000516 } else
517 Collect(BaseDecl, false, InVirtualSubobject, ComputedBaseOverriders);
518
519 // Merge the overriders from this base class into our own set of
520 // overriders.
521 for (CXXFinalOverriderMap::iterator OM = BaseOverriders->begin(),
522 OMEnd = BaseOverriders->end();
523 OM != OMEnd;
524 ++OM) {
525 const CXXMethodDecl *CanonOM
526 = cast<CXXMethodDecl>(OM->first->getCanonicalDecl());
527 Overriders[CanonOM].add(OM->second);
528 }
529 }
530 }
531
Aaron Ballman2b124d12014-03-13 16:36:16 +0000532 for (auto *M : RD->methods()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000533 // We only care about virtual methods.
534 if (!M->isVirtual())
535 continue;
536
537 CXXMethodDecl *CanonM = cast<CXXMethodDecl>(M->getCanonicalDecl());
538
539 if (CanonM->begin_overridden_methods()
540 == CanonM->end_overridden_methods()) {
541 // This is a new virtual function that does not override any
542 // other virtual function. Add it to the map of virtual
543 // functions for which we are tracking overridders.
544
545 // C++ [class.virtual]p2:
546 // For convenience we say that any virtual function overrides itself.
547 Overriders[CanonM].add(SubobjectNumber,
548 UniqueVirtualMethod(CanonM, SubobjectNumber,
549 InVirtualSubobject));
550 continue;
551 }
552
553 // This virtual method overrides other virtual methods, so it does
554 // not add any new slots into the set of overriders. Instead, we
555 // replace entries in the set of overriders with the new
556 // overrider. To do so, we dig down to the original virtual
557 // functions using data recursion and update all of the methods it
558 // overrides.
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000559 typedef llvm::iterator_range<CXXMethodDecl::method_iterator>
560 OverriddenMethods;
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000561 SmallVector<OverriddenMethods, 4> Stack;
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000562 Stack.push_back(llvm::make_range(CanonM->begin_overridden_methods(),
563 CanonM->end_overridden_methods()));
Douglas Gregor4165bd62010-03-23 23:47:56 +0000564 while (!Stack.empty()) {
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000565 for (const CXXMethodDecl *OM : Stack.pop_back_val()) {
566 const CXXMethodDecl *CanonOM = OM->getCanonicalDecl();
Anders Carlssona2f74f32010-06-03 01:00:02 +0000567
568 // C++ [class.virtual]p2:
569 // A virtual member function C::vf of a class object S is
570 // a final overrider unless the most derived class (1.8)
571 // of which S is a base class subobject (if any) declares
572 // or inherits another member function that overrides vf.
573 //
574 // Treating this object like the most derived class, we
575 // replace any overrides from base classes with this
576 // overriding virtual function.
577 Overriders[CanonOM].replaceAll(
578 UniqueVirtualMethod(CanonM, SubobjectNumber,
579 InVirtualSubobject));
580
Douglas Gregor4165bd62010-03-23 23:47:56 +0000581 if (CanonOM->begin_overridden_methods()
Anders Carlssona2f74f32010-06-03 01:00:02 +0000582 == CanonOM->end_overridden_methods())
Douglas Gregor4165bd62010-03-23 23:47:56 +0000583 continue;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000584
585 // Continue recursion to the methods that this virtual method
586 // overrides.
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000587 Stack.push_back(llvm::make_range(CanonOM->begin_overridden_methods(),
588 CanonOM->end_overridden_methods()));
Douglas Gregor4165bd62010-03-23 23:47:56 +0000589 }
590 }
Anders Carlssona2f74f32010-06-03 01:00:02 +0000591
592 // C++ [class.virtual]p2:
593 // For convenience we say that any virtual function overrides itself.
594 Overriders[CanonM].add(SubobjectNumber,
595 UniqueVirtualMethod(CanonM, SubobjectNumber,
596 InVirtualSubobject));
Douglas Gregor4165bd62010-03-23 23:47:56 +0000597 }
598}
599
600FinalOverriderCollector::~FinalOverriderCollector() {
601 for (llvm::DenseMap<const CXXRecordDecl *, CXXFinalOverriderMap *>::iterator
602 VO = VirtualOverriders.begin(), VOEnd = VirtualOverriders.end();
603 VO != VOEnd;
604 ++VO)
605 delete VO->second;
606}
607
608void
609CXXRecordDecl::getFinalOverriders(CXXFinalOverriderMap &FinalOverriders) const {
610 FinalOverriderCollector Collector;
Craig Topper36250ad2014-05-12 05:36:57 +0000611 Collector.Collect(this, false, nullptr, FinalOverriders);
Douglas Gregor4165bd62010-03-23 23:47:56 +0000612
613 // Weed out any final overriders that come from virtual base class
614 // subobjects that were hidden by other subobjects along any path.
615 // This is the final-overrider variant of C++ [class.member.lookup]p10.
Benjamin Kramerece036e2015-02-11 19:09:16 +0000616 for (auto &OM : FinalOverriders) {
617 for (auto &SO : OM.second) {
618 SmallVectorImpl<UniqueVirtualMethod> &Overriding = SO.second;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000619 if (Overriding.size() < 2)
620 continue;
621
Benjamin Kramerece036e2015-02-11 19:09:16 +0000622 auto IsHidden = [&Overriding](const UniqueVirtualMethod &M) {
623 if (!M.InVirtualSubobject)
624 return false;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000625
626 // We have an overriding method in a virtual base class
627 // subobject (or non-virtual base class subobject thereof);
628 // determine whether there exists an other overriding method
629 // in a base class subobject that hides the virtual base class
630 // subobject.
Benjamin Kramerece036e2015-02-11 19:09:16 +0000631 for (const UniqueVirtualMethod &OP : Overriding)
632 if (&M != &OP &&
633 OP.Method->getParent()->isVirtuallyDerivedFrom(
634 M.InVirtualSubobject))
635 return true;
636 return false;
637 };
Douglas Gregor4165bd62010-03-23 23:47:56 +0000638
Benjamin Kramerece036e2015-02-11 19:09:16 +0000639 Overriding.erase(
640 std::remove_if(Overriding.begin(), Overriding.end(), IsHidden),
641 Overriding.end());
Douglas Gregor4165bd62010-03-23 23:47:56 +0000642 }
643 }
644}
Anders Carlsson4131f002010-11-24 22:50:27 +0000645
646static void
647AddIndirectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
648 CXXIndirectPrimaryBaseSet& Bases) {
649 // If the record has a virtual primary base class, add it to our set.
650 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000651 if (Layout.isPrimaryBaseVirtual())
Anders Carlsson4131f002010-11-24 22:50:27 +0000652 Bases.insert(Layout.getPrimaryBase());
653
Aaron Ballman574705e2014-03-13 15:41:46 +0000654 for (const auto &I : RD->bases()) {
655 assert(!I.getType()->isDependentType() &&
Anders Carlsson4131f002010-11-24 22:50:27 +0000656 "Cannot get indirect primary bases for class with dependent bases.");
657
658 const CXXRecordDecl *BaseDecl =
Aaron Ballman574705e2014-03-13 15:41:46 +0000659 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson4131f002010-11-24 22:50:27 +0000660
661 // Only bases with virtual bases participate in computing the
662 // indirect primary virtual base classes.
663 if (BaseDecl->getNumVBases())
664 AddIndirectPrimaryBases(BaseDecl, Context, Bases);
665 }
666
667}
668
669void
670CXXRecordDecl::getIndirectPrimaryBases(CXXIndirectPrimaryBaseSet& Bases) const {
671 ASTContext &Context = getASTContext();
672
673 if (!getNumVBases())
674 return;
675
Aaron Ballman574705e2014-03-13 15:41:46 +0000676 for (const auto &I : bases()) {
677 assert(!I.getType()->isDependentType() &&
Anders Carlsson4131f002010-11-24 22:50:27 +0000678 "Cannot get indirect primary bases for class with dependent bases.");
679
680 const CXXRecordDecl *BaseDecl =
Aaron Ballman574705e2014-03-13 15:41:46 +0000681 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson4131f002010-11-24 22:50:27 +0000682
683 // Only bases with virtual bases participate in computing the
684 // indirect primary virtual base classes.
685 if (BaseDecl->getNumVBases())
686 AddIndirectPrimaryBases(BaseDecl, Context, Bases);
687 }
688}