CXXInheritance.h revision 5a0c5fb984577232cdaaf527c3e275620b3100a7
1//===------ CXXInheritance.h - 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 14#ifndef LLVM_CLANG_AST_CXXINHERITANCE_H 15#define LLVM_CLANG_AST_CXXINHERITANCE_H 16 17#include "clang/AST/DeclarationName.h" 18#include "clang/AST/DeclBase.h" 19#include "clang/AST/Type.h" 20#include "clang/AST/TypeOrdering.h" 21#include "llvm/ADT/SmallVector.h" 22#include <list> 23#include <map> 24#include <cassert> 25 26namespace clang { 27 28class CXXBaseSpecifier; 29class CXXMethodDecl; 30class CXXRecordDecl; 31class NamedDecl; 32 33/// \brief Represents an element in a path from a derived class to a 34/// base class. 35/// 36/// Each step in the path references the link from a 37/// derived class to one of its direct base classes, along with a 38/// base "number" that identifies which base subobject of the 39/// original derived class we are referencing. 40struct CXXBasePathElement { 41 /// \brief The base specifier that states the link from a derived 42 /// class to a base class, which will be followed by this base 43 /// path element. 44 const CXXBaseSpecifier *Base; 45 46 /// \brief The record decl of the class that the base is a base of. 47 const CXXRecordDecl *Class; 48 49 /// \brief Identifies which base class subobject (of type 50 /// \c Base->getType()) this base path element refers to. 51 /// 52 /// This value is only valid if \c !Base->isVirtual(), because there 53 /// is no base numbering for the zero or one virtual bases of a 54 /// given type. 55 int SubobjectNumber; 56}; 57 58/// \brief Represents a path from a specific derived class 59/// (which is not represented as part of the path) to a particular 60/// (direct or indirect) base class subobject. 61/// 62/// Individual elements in the path are described by the \c CXXBasePathElement 63/// structure, which captures both the link from a derived class to one of its 64/// direct bases and identification describing which base class 65/// subobject is being used. 66class CXXBasePath : public llvm::SmallVector<CXXBasePathElement, 4> { 67public: 68 /// \brief The set of declarations found inside this base class 69 /// subobject. 70 DeclContext::lookup_result Decls; 71}; 72 73/// BasePaths - Represents the set of paths from a derived class to 74/// one of its (direct or indirect) bases. For example, given the 75/// following class hierachy: 76/// 77/// @code 78/// class A { }; 79/// class B : public A { }; 80/// class C : public A { }; 81/// class D : public B, public C{ }; 82/// @endcode 83/// 84/// There are two potential BasePaths to represent paths from D to a 85/// base subobject of type A. One path is (D,0) -> (B,0) -> (A,0) 86/// and another is (D,0)->(C,0)->(A,1). These two paths actually 87/// refer to two different base class subobjects of the same type, 88/// so the BasePaths object refers to an ambiguous path. On the 89/// other hand, consider the following class hierarchy: 90/// 91/// @code 92/// class A { }; 93/// class B : public virtual A { }; 94/// class C : public virtual A { }; 95/// class D : public B, public C{ }; 96/// @endcode 97/// 98/// Here, there are two potential BasePaths again, (D, 0) -> (B, 0) 99/// -> (A,v) and (D, 0) -> (C, 0) -> (A, v), but since both of them 100/// refer to the same base class subobject of type A (the virtual 101/// one), there is no ambiguity. 102class CXXBasePaths { 103 /// \brief The type from which this search originated. 104 CXXRecordDecl *Origin; 105 106 /// Paths - The actual set of paths that can be taken from the 107 /// derived class to the same base class. 108 std::list<CXXBasePath> Paths; 109 110 /// ClassSubobjects - Records the class subobjects for each class 111 /// type that we've seen. The first element in the pair says 112 /// whether we found a path to a virtual base for that class type, 113 /// while the element contains the number of non-virtual base 114 /// class subobjects for that class type. The key of the map is 115 /// the cv-unqualified canonical type of the base class subobject. 116 std::map<QualType, std::pair<bool, unsigned>, QualTypeOrdering> 117 ClassSubobjects; 118 119 /// FindAmbiguities - Whether Sema::IsDerivedFrom should try find 120 /// ambiguous paths while it is looking for a path from a derived 121 /// type to a base type. 122 bool FindAmbiguities; 123 124 /// RecordPaths - Whether Sema::IsDerivedFrom should record paths 125 /// while it is determining whether there are paths from a derived 126 /// type to a base type. 127 bool RecordPaths; 128 129 /// DetectVirtual - Whether Sema::IsDerivedFrom should abort the search 130 /// if it finds a path that goes across a virtual base. The virtual class 131 /// is also recorded. 132 bool DetectVirtual; 133 134 /// ScratchPath - A BasePath that is used by Sema::IsDerivedFrom 135 /// to help build the set of paths. 136 CXXBasePath ScratchPath; 137 138 /// DetectedVirtual - The base class that is virtual. 139 const RecordType *DetectedVirtual; 140 141 /// \brief Array of the declarations that have been found. This 142 /// array is constructed only if needed, e.g., to iterate over the 143 /// results within LookupResult. 144 NamedDecl **DeclsFound; 145 unsigned NumDeclsFound; 146 147 friend class CXXRecordDecl; 148 149 void ComputeDeclsFound(); 150 151public: 152 typedef std::list<CXXBasePath>::const_iterator paths_iterator; 153 typedef NamedDecl **decl_iterator; 154 155 /// BasePaths - Construct a new BasePaths structure to record the 156 /// paths for a derived-to-base search. 157 explicit CXXBasePaths(bool FindAmbiguities = true, 158 bool RecordPaths = true, 159 bool DetectVirtual = true) 160 : FindAmbiguities(FindAmbiguities), RecordPaths(RecordPaths), 161 DetectVirtual(DetectVirtual), DetectedVirtual(0), DeclsFound(0), 162 NumDeclsFound(0) { } 163 164 ~CXXBasePaths() { delete [] DeclsFound; } 165 166 paths_iterator begin() const { return Paths.begin(); } 167 paths_iterator end() const { return Paths.end(); } 168 169 CXXBasePath& front() { return Paths.front(); } 170 const CXXBasePath& front() const { return Paths.front(); } 171 172 decl_iterator found_decls_begin(); 173 decl_iterator found_decls_end(); 174 175 /// \brief Determine whether the path from the most-derived type to the 176 /// given base type is ambiguous (i.e., it refers to multiple subobjects of 177 /// the same base type). 178 bool isAmbiguous(QualType BaseType); 179 180 /// \brief Whether we are finding multiple paths to detect ambiguities. 181 bool isFindingAmbiguities() const { return FindAmbiguities; } 182 183 /// \brief Whether we are recording paths. 184 bool isRecordingPaths() const { return RecordPaths; } 185 186 /// \brief Specify whether we should be recording paths or not. 187 void setRecordingPaths(bool RP) { RecordPaths = RP; } 188 189 /// \brief Whether we are detecting virtual bases. 190 bool isDetectingVirtual() const { return DetectVirtual; } 191 192 /// \brief The virtual base discovered on the path (if we are merely 193 /// detecting virtuals). 194 const RecordType* getDetectedVirtual() const { 195 return DetectedVirtual; 196 } 197 198 /// \brief Retrieve the type from which this base-paths search 199 /// began 200 CXXRecordDecl *getOrigin() const { return Origin; } 201 void setOrigin(CXXRecordDecl *Rec) { Origin = Rec; } 202 203 /// \brief Clear the base-paths results. 204 void clear(); 205 206 /// \brief Swap this data structure's contents with another CXXBasePaths 207 /// object. 208 void swap(CXXBasePaths &Other); 209}; 210 211} // end namespace clang 212 213#endif 214