blob: 800c8f83b8800ee8b1e4b4daea02b297d3a74edf [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();
34 DeclsFound = new NamedDecl * [NumDeclsFound];
35 std::copy(Decls.begin(), Decls.end(), DeclsFound);
36}
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
Aaron Ballmane6f465e2014-03-14 21:38:48 +000042 return decl_range(decl_iterator(DeclsFound),
43 decl_iterator(DeclsFound + 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));
John McCall388ef532011-01-28 22:02:36 +000088 return lookupInBases(&FindBaseClass,
89 const_cast<CXXRecordDecl*>(Base->getCanonicalDecl()),
90 Paths);
Douglas Gregor36d1b142009-10-06 17:59:45 +000091}
92
Jordan Rose55edf5ff2012-08-08 18:23:20 +000093bool CXXRecordDecl::isVirtuallyDerivedFrom(const CXXRecordDecl *Base) const {
Anders Carlsson15722da2010-06-04 01:40:08 +000094 if (!getNumVBases())
95 return false;
96
Douglas Gregor3e637462010-03-03 04:38:46 +000097 CXXBasePaths Paths(/*FindAmbiguities=*/false, /*RecordPaths=*/false,
98 /*DetectVirtual=*/false);
99
100 if (getCanonicalDecl() == Base->getCanonicalDecl())
101 return false;
102
Jordan Rose55edf5ff2012-08-08 18:23:20 +0000103 Paths.setOrigin(const_cast<CXXRecordDecl*>(this));
104
105 const void *BasePtr = static_cast<const void*>(Base->getCanonicalDecl());
106 return lookupInBases(&FindVirtualBaseClass,
107 const_cast<void *>(BasePtr),
108 Paths);
Douglas Gregor3e637462010-03-03 04:38:46 +0000109}
110
John McCallddabf1a2009-12-08 07:42:38 +0000111static bool BaseIsNot(const CXXRecordDecl *Base, void *OpaqueTarget) {
112 // OpaqueTarget is a CXXRecordDecl*.
113 return Base->getCanonicalDecl() != (const CXXRecordDecl*) OpaqueTarget;
114}
115
116bool CXXRecordDecl::isProvablyNotDerivedFrom(const CXXRecordDecl *Base) const {
David Greene94319262013-01-15 22:09:40 +0000117 return forallBases(BaseIsNot,
118 const_cast<CXXRecordDecl *>(Base->getCanonicalDecl()));
John McCallddabf1a2009-12-08 07:42:38 +0000119}
120
Richard Smithd80b2d52012-11-22 00:24:47 +0000121bool
122CXXRecordDecl::isCurrentInstantiation(const DeclContext *CurContext) const {
123 assert(isDependentContext());
124
125 for (; !CurContext->isFileContext(); CurContext = CurContext->getParent())
126 if (CurContext->Equals(this))
127 return true;
128
129 return false;
130}
131
John McCallddabf1a2009-12-08 07:42:38 +0000132bool CXXRecordDecl::forallBases(ForallBasesCallback *BaseMatches,
133 void *OpaqueData,
Douglas Gregordc974572012-11-10 07:24:09 +0000134 bool AllowShortCircuit) const {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000135 SmallVector<const CXXRecordDecl*, 8> Queue;
John McCallddabf1a2009-12-08 07:42:38 +0000136
137 const CXXRecordDecl *Record = this;
138 bool AllMatches = true;
139 while (true) {
Aaron Ballman574705e2014-03-13 15:41:46 +0000140 for (const auto &I : Record->bases()) {
141 const RecordType *Ty = I.getType()->getAs<RecordType>();
Douglas Gregordc974572012-11-10 07:24:09 +0000142 if (!Ty) {
John McCallddabf1a2009-12-08 07:42:38 +0000143 if (AllowShortCircuit) return false;
144 AllMatches = false;
145 continue;
146 }
147
Douglas Gregordc974572012-11-10 07:24:09 +0000148 CXXRecordDecl *Base =
149 cast_or_null<CXXRecordDecl>(Ty->getDecl()->getDefinition());
Richard Smithd80b2d52012-11-22 00:24:47 +0000150 if (!Base ||
151 (Base->isDependentContext() &&
152 !Base->isCurrentInstantiation(Record))) {
John McCallddabf1a2009-12-08 07:42:38 +0000153 if (AllowShortCircuit) return false;
154 AllMatches = false;
155 continue;
156 }
157
Anders Carlssonf9812782009-12-09 04:26:02 +0000158 Queue.push_back(Base);
159 if (!BaseMatches(Base, OpaqueData)) {
John McCallddabf1a2009-12-08 07:42:38 +0000160 if (AllowShortCircuit) return false;
161 AllMatches = false;
162 continue;
163 }
164 }
165
Robert Wilhelm25284cc2013-08-23 16:11:15 +0000166 if (Queue.empty())
167 break;
168 Record = Queue.pop_back_val(); // not actually a queue.
John McCallddabf1a2009-12-08 07:42:38 +0000169 }
170
171 return AllMatches;
172}
173
Jordan Rose55edf5ff2012-08-08 18:23:20 +0000174bool CXXBasePaths::lookupInBases(ASTContext &Context,
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000175 const CXXRecordDecl *Record,
176 CXXRecordDecl::BaseMatchesCallback *BaseMatches,
177 void *UserData) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000178 bool FoundPath = false;
John McCall401982f2010-01-20 21:53:11 +0000179
John McCall553c0792010-01-23 00:46:32 +0000180 // The access of the path down to this record.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000181 AccessSpecifier AccessToHere = ScratchPath.Access;
182 bool IsFirstStep = ScratchPath.empty();
John McCall553c0792010-01-23 00:46:32 +0000183
Aaron Ballman574705e2014-03-13 15:41:46 +0000184 for (const auto &BaseSpec : Record->bases()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000185 // Find the record of the base class subobjects for this type.
Aaron Ballman574705e2014-03-13 15:41:46 +0000186 QualType BaseType =
187 Context.getCanonicalType(BaseSpec.getType()).getUnqualifiedType();
188
Douglas Gregor36d1b142009-10-06 17:59:45 +0000189 // C++ [temp.dep]p3:
190 // In the definition of a class template or a member of a class template,
191 // if a base class of the class template depends on a template-parameter,
192 // the base class scope is not examined during unqualified name lookup
193 // either at the point of definition of the class template or member or
194 // during an instantiation of the class tem- plate or member.
195 if (BaseType->isDependentType())
196 continue;
197
198 // Determine whether we need to visit this base class at all,
199 // updating the count of subobjects appropriately.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000200 std::pair<bool, unsigned>& Subobjects = ClassSubobjects[BaseType];
Douglas Gregor36d1b142009-10-06 17:59:45 +0000201 bool VisitBase = true;
202 bool SetVirtual = false;
Aaron Ballman574705e2014-03-13 15:41:46 +0000203 if (BaseSpec.isVirtual()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000204 VisitBase = !Subobjects.first;
205 Subobjects.first = true;
Craig Topper36250ad2014-05-12 05:36:57 +0000206 if (isDetectingVirtual() && DetectedVirtual == nullptr) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000207 // If this is the first virtual we find, remember it. If it turns out
208 // there is no base path here, we'll reset it later.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000209 DetectedVirtual = BaseType->getAs<RecordType>();
Douglas Gregor36d1b142009-10-06 17:59:45 +0000210 SetVirtual = true;
211 }
212 } else
213 ++Subobjects.second;
214
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000215 if (isRecordingPaths()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000216 // Add this base specifier to the current path.
217 CXXBasePathElement Element;
Aaron Ballman574705e2014-03-13 15:41:46 +0000218 Element.Base = &BaseSpec;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000219 Element.Class = Record;
Aaron Ballman574705e2014-03-13 15:41:46 +0000220 if (BaseSpec.isVirtual())
Douglas Gregor36d1b142009-10-06 17:59:45 +0000221 Element.SubobjectNumber = 0;
222 else
223 Element.SubobjectNumber = Subobjects.second;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000224 ScratchPath.push_back(Element);
John McCall401982f2010-01-20 21:53:11 +0000225
John McCall553c0792010-01-23 00:46:32 +0000226 // Calculate the "top-down" access to this base class.
227 // The spec actually describes this bottom-up, but top-down is
228 // equivalent because the definition works out as follows:
229 // 1. Write down the access along each step in the inheritance
230 // chain, followed by the access of the decl itself.
231 // For example, in
232 // class A { public: int foo; };
233 // class B : protected A {};
234 // class C : public B {};
235 // class D : private C {};
236 // we would write:
237 // private public protected public
238 // 2. If 'private' appears anywhere except far-left, access is denied.
239 // 3. Otherwise, overall access is determined by the most restrictive
240 // access in the sequence.
241 if (IsFirstStep)
Aaron Ballman574705e2014-03-13 15:41:46 +0000242 ScratchPath.Access = BaseSpec.getAccessSpecifier();
John McCall553c0792010-01-23 00:46:32 +0000243 else
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000244 ScratchPath.Access = CXXRecordDecl::MergeAccess(AccessToHere,
Aaron Ballman574705e2014-03-13 15:41:46 +0000245 BaseSpec.getAccessSpecifier());
Douglas Gregor36d1b142009-10-06 17:59:45 +0000246 }
John McCall6f891402010-02-09 00:57:12 +0000247
248 // Track whether there's a path involving this specific base.
249 bool FoundPathThroughBase = false;
250
Aaron Ballman574705e2014-03-13 15:41:46 +0000251 if (BaseMatches(&BaseSpec, ScratchPath, UserData)) {
John McCall553c0792010-01-23 00:46:32 +0000252 // We've found a path that terminates at this base.
John McCall6f891402010-02-09 00:57:12 +0000253 FoundPath = FoundPathThroughBase = true;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000254 if (isRecordingPaths()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000255 // We have a path. Make a copy of it before moving on.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000256 Paths.push_back(ScratchPath);
257 } else if (!isFindingAmbiguities()) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000258 // We found a path and we don't care about ambiguities;
259 // return immediately.
260 return FoundPath;
261 }
262 } else if (VisitBase) {
263 CXXRecordDecl *BaseRecord
Aaron Ballman574705e2014-03-13 15:41:46 +0000264 = cast<CXXRecordDecl>(BaseSpec.getType()->castAs<RecordType>()
Douglas Gregor36d1b142009-10-06 17:59:45 +0000265 ->getDecl());
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000266 if (lookupInBases(Context, BaseRecord, BaseMatches, UserData)) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000267 // C++ [class.member.lookup]p2:
268 // A member name f in one sub-object B hides a member name f in
269 // a sub-object A if A is a base class sub-object of B. Any
270 // declarations that are so hidden are eliminated from
271 // consideration.
272
273 // There is a path to a base class that meets the criteria. If we're
274 // not collecting paths or finding ambiguities, we're done.
John McCall6f891402010-02-09 00:57:12 +0000275 FoundPath = FoundPathThroughBase = true;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000276 if (!isFindingAmbiguities())
Douglas Gregor36d1b142009-10-06 17:59:45 +0000277 return FoundPath;
278 }
279 }
280
281 // Pop this base specifier off the current path (if we're
282 // collecting paths).
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000283 if (isRecordingPaths()) {
284 ScratchPath.pop_back();
John McCall401982f2010-01-20 21:53:11 +0000285 }
286
Douglas Gregor36d1b142009-10-06 17:59:45 +0000287 // If we set a virtual earlier, and this isn't a path, forget it again.
John McCall6f891402010-02-09 00:57:12 +0000288 if (SetVirtual && !FoundPathThroughBase) {
Craig Topper36250ad2014-05-12 05:36:57 +0000289 DetectedVirtual = nullptr;
Douglas Gregor36d1b142009-10-06 17:59:45 +0000290 }
291 }
John McCall553c0792010-01-23 00:46:32 +0000292
293 // Reset the scratch path access.
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000294 ScratchPath.Access = AccessToHere;
Douglas Gregor36d1b142009-10-06 17:59:45 +0000295
296 return FoundPath;
297}
298
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000299bool CXXRecordDecl::lookupInBases(BaseMatchesCallback *BaseMatches,
300 void *UserData,
301 CXXBasePaths &Paths) const {
Douglas Gregor3e637462010-03-03 04:38:46 +0000302 // If we didn't find anything, report that.
303 if (!Paths.lookupInBases(getASTContext(), this, BaseMatches, UserData))
304 return false;
305
306 // If we're not recording paths or we won't ever find ambiguities,
307 // we're done.
308 if (!Paths.isRecordingPaths() || !Paths.isFindingAmbiguities())
309 return true;
310
311 // C++ [class.member.lookup]p6:
312 // When virtual base classes are used, a hidden declaration can be
313 // reached along a path through the sub-object lattice that does
314 // not pass through the hiding declaration. This is not an
315 // ambiguity. The identical use with nonvirtual base classes is an
316 // ambiguity; in that case there is no unique instance of the name
317 // that hides all the others.
318 //
319 // FIXME: This is an O(N^2) algorithm, but DPG doesn't see an easy
320 // way to make it any faster.
Benjamin Kramerece036e2015-02-11 19:09:16 +0000321 Paths.Paths.remove_if([&Paths](const CXXBasePath &Path) {
322 for (const CXXBasePathElement &PE : Path) {
323 if (!PE.Base->isVirtual())
324 continue;
Douglas Gregor3e637462010-03-03 04:38:46 +0000325
Benjamin Kramerece036e2015-02-11 19:09:16 +0000326 CXXRecordDecl *VBase = nullptr;
327 if (const RecordType *Record = PE.Base->getType()->getAs<RecordType>())
328 VBase = cast<CXXRecordDecl>(Record->getDecl());
329 if (!VBase)
330 break;
331
332 // The declaration(s) we found along this path were found in a
333 // subobject of a virtual base. Check whether this virtual
334 // base is a subobject of any other path; if so, then the
335 // declaration in this path are hidden by that patch.
336 for (const CXXBasePath &HidingP : Paths) {
337 CXXRecordDecl *HidingClass = nullptr;
338 if (const RecordType *Record =
339 HidingP.back().Base->getType()->getAs<RecordType>())
340 HidingClass = cast<CXXRecordDecl>(Record->getDecl());
341 if (!HidingClass)
Douglas Gregor3e637462010-03-03 04:38:46 +0000342 break;
343
Benjamin Kramerece036e2015-02-11 19:09:16 +0000344 if (HidingClass->isVirtuallyDerivedFrom(VBase))
345 return true;
Douglas Gregor3e637462010-03-03 04:38:46 +0000346 }
347 }
Benjamin Kramerece036e2015-02-11 19:09:16 +0000348 return false;
349 });
Douglas Gregor3e637462010-03-03 04:38:46 +0000350
Douglas Gregor3e637462010-03-03 04:38:46 +0000351 return true;
Douglas Gregor0555f7e2010-03-03 02:18:00 +0000352}
353
John McCall84c16cf2009-11-12 03:15:40 +0000354bool CXXRecordDecl::FindBaseClass(const CXXBaseSpecifier *Specifier,
Douglas Gregor36d1b142009-10-06 17:59:45 +0000355 CXXBasePath &Path,
356 void *BaseRecord) {
357 assert(((Decl *)BaseRecord)->getCanonicalDecl() == BaseRecord &&
358 "User data for FindBaseClass is not canonical!");
Ted Kremenek28831752012-08-23 20:46:57 +0000359 return Specifier->getType()->castAs<RecordType>()->getDecl()
360 ->getCanonicalDecl() == BaseRecord;
Douglas Gregor36d1b142009-10-06 17:59:45 +0000361}
362
Douglas Gregor3e637462010-03-03 04:38:46 +0000363bool CXXRecordDecl::FindVirtualBaseClass(const CXXBaseSpecifier *Specifier,
364 CXXBasePath &Path,
365 void *BaseRecord) {
366 assert(((Decl *)BaseRecord)->getCanonicalDecl() == BaseRecord &&
367 "User data for FindBaseClass is not canonical!");
368 return Specifier->isVirtual() &&
Ted Kremenek28831752012-08-23 20:46:57 +0000369 Specifier->getType()->castAs<RecordType>()->getDecl()
370 ->getCanonicalDecl() == BaseRecord;
Douglas Gregor3e637462010-03-03 04:38:46 +0000371}
372
John McCall84c16cf2009-11-12 03:15:40 +0000373bool CXXRecordDecl::FindTagMember(const CXXBaseSpecifier *Specifier,
Douglas Gregor36d1b142009-10-06 17:59:45 +0000374 CXXBasePath &Path,
375 void *Name) {
Ted Kremenek28831752012-08-23 20:46:57 +0000376 RecordDecl *BaseRecord =
377 Specifier->getType()->castAs<RecordType>()->getDecl();
Douglas Gregor36d1b142009-10-06 17:59:45 +0000378
379 DeclarationName N = DeclarationName::getFromOpaquePtr(Name);
380 for (Path.Decls = BaseRecord->lookup(N);
David Blaikieff7d47a2012-12-19 00:45:41 +0000381 !Path.Decls.empty();
382 Path.Decls = Path.Decls.slice(1)) {
383 if (Path.Decls.front()->isInIdentifierNamespace(IDNS_Tag))
Douglas Gregor36d1b142009-10-06 17:59:45 +0000384 return true;
385 }
386
387 return false;
388}
389
John McCall84c16cf2009-11-12 03:15:40 +0000390bool CXXRecordDecl::FindOrdinaryMember(const CXXBaseSpecifier *Specifier,
Douglas Gregor36d1b142009-10-06 17:59:45 +0000391 CXXBasePath &Path,
392 void *Name) {
Ted Kremenek28831752012-08-23 20:46:57 +0000393 RecordDecl *BaseRecord =
394 Specifier->getType()->castAs<RecordType>()->getDecl();
Douglas Gregor36d1b142009-10-06 17:59:45 +0000395
396 const unsigned IDNS = IDNS_Ordinary | IDNS_Tag | IDNS_Member;
397 DeclarationName N = DeclarationName::getFromOpaquePtr(Name);
398 for (Path.Decls = BaseRecord->lookup(N);
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,
411 void *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
415 DeclarationName N = DeclarationName::getFromOpaquePtr(Name);
416 for (Path.Decls = BaseRecord->lookup(N);
David Blaikieff7d47a2012-12-19 00:45:41 +0000417 !Path.Decls.empty();
418 Path.Decls = Path.Decls.slice(1)) {
Douglas Gregor36d1b142009-10-06 17:59:45 +0000419 // FIXME: Refactor the "is it a nested-name-specifier?" check
David Blaikieff7d47a2012-12-19 00:45:41 +0000420 if (isa<TypedefNameDecl>(Path.Decls.front()) ||
421 Path.Decls.front()->isInIdentifierNamespace(IDNS_Tag))
Douglas Gregor36d1b142009-10-06 17:59:45 +0000422 return true;
423 }
424
425 return false;
Mike Stump512c5b72009-10-06 23:38:59 +0000426}
Douglas Gregor4165bd62010-03-23 23:47:56 +0000427
428void OverridingMethods::add(unsigned OverriddenSubobject,
429 UniqueVirtualMethod Overriding) {
Craig Topper2341c0d2013-07-04 03:08:24 +0000430 SmallVectorImpl<UniqueVirtualMethod> &SubobjectOverrides
Douglas Gregor4165bd62010-03-23 23:47:56 +0000431 = Overrides[OverriddenSubobject];
432 if (std::find(SubobjectOverrides.begin(), SubobjectOverrides.end(),
433 Overriding) == SubobjectOverrides.end())
434 SubobjectOverrides.push_back(Overriding);
435}
436
437void OverridingMethods::add(const OverridingMethods &Other) {
438 for (const_iterator I = Other.begin(), IE = Other.end(); I != IE; ++I) {
439 for (overriding_const_iterator M = I->second.begin(),
440 MEnd = I->second.end();
441 M != MEnd;
442 ++M)
443 add(I->first, *M);
444 }
445}
446
447void OverridingMethods::replaceAll(UniqueVirtualMethod Overriding) {
448 for (iterator I = begin(), IEnd = end(); I != IEnd; ++I) {
449 I->second.clear();
450 I->second.push_back(Overriding);
451 }
452}
453
454
455namespace {
456 class FinalOverriderCollector {
457 /// \brief The number of subobjects of a given class type that
458 /// occur within the class hierarchy.
459 llvm::DenseMap<const CXXRecordDecl *, unsigned> SubobjectCount;
460
461 /// \brief Overriders for each virtual base subobject.
462 llvm::DenseMap<const CXXRecordDecl *, CXXFinalOverriderMap *> VirtualOverriders;
463
464 CXXFinalOverriderMap FinalOverriders;
465
466 public:
467 ~FinalOverriderCollector();
468
469 void Collect(const CXXRecordDecl *RD, bool VirtualBase,
470 const CXXRecordDecl *InVirtualSubobject,
471 CXXFinalOverriderMap &Overriders);
472 };
473}
474
475void FinalOverriderCollector::Collect(const CXXRecordDecl *RD,
476 bool VirtualBase,
477 const CXXRecordDecl *InVirtualSubobject,
478 CXXFinalOverriderMap &Overriders) {
479 unsigned SubobjectNumber = 0;
480 if (!VirtualBase)
481 SubobjectNumber
482 = ++SubobjectCount[cast<CXXRecordDecl>(RD->getCanonicalDecl())];
483
Aaron Ballman574705e2014-03-13 15:41:46 +0000484 for (const auto &Base : RD->bases()) {
485 if (const RecordType *RT = Base.getType()->getAs<RecordType>()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000486 const CXXRecordDecl *BaseDecl = cast<CXXRecordDecl>(RT->getDecl());
487 if (!BaseDecl->isPolymorphic())
488 continue;
489
Aaron Ballman574705e2014-03-13 15:41:46 +0000490 if (Overriders.empty() && !Base.isVirtual()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000491 // There are no other overriders of virtual member functions,
492 // so let the base class fill in our overriders for us.
493 Collect(BaseDecl, false, InVirtualSubobject, Overriders);
494 continue;
495 }
496
497 // Collect all of the overridders from the base class subobject
498 // and merge them into the set of overridders for this class.
499 // For virtual base classes, populate or use the cached virtual
500 // overrides so that we do not walk the virtual base class (and
501 // its base classes) more than once.
502 CXXFinalOverriderMap ComputedBaseOverriders;
503 CXXFinalOverriderMap *BaseOverriders = &ComputedBaseOverriders;
Aaron Ballman574705e2014-03-13 15:41:46 +0000504 if (Base.isVirtual()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000505 CXXFinalOverriderMap *&MyVirtualOverriders = VirtualOverriders[BaseDecl];
Benjamin Kramerea388a22012-05-27 22:41:08 +0000506 BaseOverriders = MyVirtualOverriders;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000507 if (!MyVirtualOverriders) {
508 MyVirtualOverriders = new CXXFinalOverriderMap;
Benjamin Kramerea388a22012-05-27 22:41:08 +0000509
510 // Collect may cause VirtualOverriders to reallocate, invalidating the
511 // MyVirtualOverriders reference. Set BaseOverriders to the right
512 // value now.
513 BaseOverriders = MyVirtualOverriders;
514
Douglas Gregor4165bd62010-03-23 23:47:56 +0000515 Collect(BaseDecl, true, BaseDecl, *MyVirtualOverriders);
516 }
Douglas Gregor4165bd62010-03-23 23:47:56 +0000517 } else
518 Collect(BaseDecl, false, InVirtualSubobject, ComputedBaseOverriders);
519
520 // Merge the overriders from this base class into our own set of
521 // overriders.
522 for (CXXFinalOverriderMap::iterator OM = BaseOverriders->begin(),
523 OMEnd = BaseOverriders->end();
524 OM != OMEnd;
525 ++OM) {
526 const CXXMethodDecl *CanonOM
527 = cast<CXXMethodDecl>(OM->first->getCanonicalDecl());
528 Overriders[CanonOM].add(OM->second);
529 }
530 }
531 }
532
Aaron Ballman2b124d12014-03-13 16:36:16 +0000533 for (auto *M : RD->methods()) {
Douglas Gregor4165bd62010-03-23 23:47:56 +0000534 // We only care about virtual methods.
535 if (!M->isVirtual())
536 continue;
537
538 CXXMethodDecl *CanonM = cast<CXXMethodDecl>(M->getCanonicalDecl());
539
540 if (CanonM->begin_overridden_methods()
541 == CanonM->end_overridden_methods()) {
542 // This is a new virtual function that does not override any
543 // other virtual function. Add it to the map of virtual
544 // functions for which we are tracking overridders.
545
546 // C++ [class.virtual]p2:
547 // For convenience we say that any virtual function overrides itself.
548 Overriders[CanonM].add(SubobjectNumber,
549 UniqueVirtualMethod(CanonM, SubobjectNumber,
550 InVirtualSubobject));
551 continue;
552 }
553
554 // This virtual method overrides other virtual methods, so it does
555 // not add any new slots into the set of overriders. Instead, we
556 // replace entries in the set of overriders with the new
557 // overrider. To do so, we dig down to the original virtual
558 // functions using data recursion and update all of the methods it
559 // overrides.
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000560 typedef llvm::iterator_range<CXXMethodDecl::method_iterator>
561 OverriddenMethods;
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000562 SmallVector<OverriddenMethods, 4> Stack;
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000563 Stack.push_back(llvm::make_range(CanonM->begin_overridden_methods(),
564 CanonM->end_overridden_methods()));
Douglas Gregor4165bd62010-03-23 23:47:56 +0000565 while (!Stack.empty()) {
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000566 for (const CXXMethodDecl *OM : Stack.pop_back_val()) {
567 const CXXMethodDecl *CanonOM = OM->getCanonicalDecl();
Anders Carlssona2f74f32010-06-03 01:00:02 +0000568
569 // C++ [class.virtual]p2:
570 // A virtual member function C::vf of a class object S is
571 // a final overrider unless the most derived class (1.8)
572 // of which S is a base class subobject (if any) declares
573 // or inherits another member function that overrides vf.
574 //
575 // Treating this object like the most derived class, we
576 // replace any overrides from base classes with this
577 // overriding virtual function.
578 Overriders[CanonOM].replaceAll(
579 UniqueVirtualMethod(CanonM, SubobjectNumber,
580 InVirtualSubobject));
581
Douglas Gregor4165bd62010-03-23 23:47:56 +0000582 if (CanonOM->begin_overridden_methods()
Anders Carlssona2f74f32010-06-03 01:00:02 +0000583 == CanonOM->end_overridden_methods())
Douglas Gregor4165bd62010-03-23 23:47:56 +0000584 continue;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000585
586 // Continue recursion to the methods that this virtual method
587 // overrides.
Benjamin Kramerb4ef6682015-02-06 17:25:10 +0000588 Stack.push_back(llvm::make_range(CanonOM->begin_overridden_methods(),
589 CanonOM->end_overridden_methods()));
Douglas Gregor4165bd62010-03-23 23:47:56 +0000590 }
591 }
Anders Carlssona2f74f32010-06-03 01:00:02 +0000592
593 // C++ [class.virtual]p2:
594 // For convenience we say that any virtual function overrides itself.
595 Overriders[CanonM].add(SubobjectNumber,
596 UniqueVirtualMethod(CanonM, SubobjectNumber,
597 InVirtualSubobject));
Douglas Gregor4165bd62010-03-23 23:47:56 +0000598 }
599}
600
601FinalOverriderCollector::~FinalOverriderCollector() {
602 for (llvm::DenseMap<const CXXRecordDecl *, CXXFinalOverriderMap *>::iterator
603 VO = VirtualOverriders.begin(), VOEnd = VirtualOverriders.end();
604 VO != VOEnd;
605 ++VO)
606 delete VO->second;
607}
608
609void
610CXXRecordDecl::getFinalOverriders(CXXFinalOverriderMap &FinalOverriders) const {
611 FinalOverriderCollector Collector;
Craig Topper36250ad2014-05-12 05:36:57 +0000612 Collector.Collect(this, false, nullptr, FinalOverriders);
Douglas Gregor4165bd62010-03-23 23:47:56 +0000613
614 // Weed out any final overriders that come from virtual base class
615 // subobjects that were hidden by other subobjects along any path.
616 // This is the final-overrider variant of C++ [class.member.lookup]p10.
Benjamin Kramerece036e2015-02-11 19:09:16 +0000617 for (auto &OM : FinalOverriders) {
618 for (auto &SO : OM.second) {
619 SmallVectorImpl<UniqueVirtualMethod> &Overriding = SO.second;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000620 if (Overriding.size() < 2)
621 continue;
622
Benjamin Kramerece036e2015-02-11 19:09:16 +0000623 auto IsHidden = [&Overriding](const UniqueVirtualMethod &M) {
624 if (!M.InVirtualSubobject)
625 return false;
Douglas Gregor4165bd62010-03-23 23:47:56 +0000626
627 // We have an overriding method in a virtual base class
628 // subobject (or non-virtual base class subobject thereof);
629 // determine whether there exists an other overriding method
630 // in a base class subobject that hides the virtual base class
631 // subobject.
Benjamin Kramerece036e2015-02-11 19:09:16 +0000632 for (const UniqueVirtualMethod &OP : Overriding)
633 if (&M != &OP &&
634 OP.Method->getParent()->isVirtuallyDerivedFrom(
635 M.InVirtualSubobject))
636 return true;
637 return false;
638 };
Douglas Gregor4165bd62010-03-23 23:47:56 +0000639
Benjamin Kramerece036e2015-02-11 19:09:16 +0000640 Overriding.erase(
641 std::remove_if(Overriding.begin(), Overriding.end(), IsHidden),
642 Overriding.end());
Douglas Gregor4165bd62010-03-23 23:47:56 +0000643 }
644 }
645}
Anders Carlsson4131f002010-11-24 22:50:27 +0000646
647static void
648AddIndirectPrimaryBases(const CXXRecordDecl *RD, ASTContext &Context,
649 CXXIndirectPrimaryBaseSet& Bases) {
650 // If the record has a virtual primary base class, add it to our set.
651 const ASTRecordLayout &Layout = Context.getASTRecordLayout(RD);
Anders Carlsson7f95cd12010-11-24 23:12:57 +0000652 if (Layout.isPrimaryBaseVirtual())
Anders Carlsson4131f002010-11-24 22:50:27 +0000653 Bases.insert(Layout.getPrimaryBase());
654
Aaron Ballman574705e2014-03-13 15:41:46 +0000655 for (const auto &I : RD->bases()) {
656 assert(!I.getType()->isDependentType() &&
Anders Carlsson4131f002010-11-24 22:50:27 +0000657 "Cannot get indirect primary bases for class with dependent bases.");
658
659 const CXXRecordDecl *BaseDecl =
Aaron Ballman574705e2014-03-13 15:41:46 +0000660 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson4131f002010-11-24 22:50:27 +0000661
662 // Only bases with virtual bases participate in computing the
663 // indirect primary virtual base classes.
664 if (BaseDecl->getNumVBases())
665 AddIndirectPrimaryBases(BaseDecl, Context, Bases);
666 }
667
668}
669
670void
671CXXRecordDecl::getIndirectPrimaryBases(CXXIndirectPrimaryBaseSet& Bases) const {
672 ASTContext &Context = getASTContext();
673
674 if (!getNumVBases())
675 return;
676
Aaron Ballman574705e2014-03-13 15:41:46 +0000677 for (const auto &I : bases()) {
678 assert(!I.getType()->isDependentType() &&
Anders Carlsson4131f002010-11-24 22:50:27 +0000679 "Cannot get indirect primary bases for class with dependent bases.");
680
681 const CXXRecordDecl *BaseDecl =
Aaron Ballman574705e2014-03-13 15:41:46 +0000682 cast<CXXRecordDecl>(I.getType()->castAs<RecordType>()->getDecl());
Anders Carlsson4131f002010-11-24 22:50:27 +0000683
684 // Only bases with virtual bases participate in computing the
685 // indirect primary virtual base classes.
686 if (BaseDecl->getNumVBases())
687 AddIndirectPrimaryBases(BaseDecl, Context, Bases);
688 }
689}