1 //===--- DelayedDiagnostic.h - Delayed declarator diagnostics ---*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// \brief Defines the classes clang::DelayedDiagnostic and
12 /// clang::AccessedEntity.
14 /// DelayedDiangostic is used to record diagnostics that are being
15 /// conditionally produced during declarator parsing. Certain kinds of
16 /// diagnostics -- notably deprecation and access control -- are suppressed
17 /// based on semantic properties of the parsed declaration that aren't known
18 /// until it is fully parsed.
20 //===----------------------------------------------------------------------===//
22 #ifndef LLVM_CLANG_SEMA_DELAYEDDIAGNOSTIC_H
23 #define LLVM_CLANG_SEMA_DELAYEDDIAGNOSTIC_H
25 #include "clang/Sema/Sema.h"
30 /// A declaration being accessed, together with information about how
32 class AccessedEntity {
34 /// A member declaration found through lookup. The target is the
36 enum MemberNonce { Member };
38 /// A hierarchy (base-to-derived or derived-to-base) conversion.
39 /// The target is the base class.
40 enum BaseNonce { Base };
42 bool isMemberAccess() const { return IsMember; }
44 AccessedEntity(PartialDiagnostic::StorageAllocator &Allocator,
46 CXXRecordDecl *NamingClass,
47 DeclAccessPair FoundDecl,
48 QualType BaseObjectType)
49 : Access(FoundDecl.getAccess()), IsMember(true),
50 Target(FoundDecl.getDecl()), NamingClass(NamingClass),
51 BaseObjectType(BaseObjectType), Diag(0, Allocator) {
54 AccessedEntity(PartialDiagnostic::StorageAllocator &Allocator,
56 CXXRecordDecl *BaseClass,
57 CXXRecordDecl *DerivedClass,
58 AccessSpecifier Access)
59 : Access(Access), IsMember(false),
61 NamingClass(DerivedClass),
65 bool isQuiet() const { return Diag.getDiagID() == 0; }
67 AccessSpecifier getAccess() const { return AccessSpecifier(Access); }
69 // These apply to member decls...
70 NamedDecl *getTargetDecl() const { return Target; }
71 CXXRecordDecl *getNamingClass() const { return NamingClass; }
73 // ...and these apply to hierarchy conversions.
74 CXXRecordDecl *getBaseClass() const {
75 assert(!IsMember); return cast<CXXRecordDecl>(Target);
77 CXXRecordDecl *getDerivedClass() const { return NamingClass; }
79 /// Retrieves the base object type, important when accessing
80 /// an instance member.
81 QualType getBaseObjectType() const { return BaseObjectType; }
83 /// Sets a diagnostic to be performed. The diagnostic is given
84 /// four (additional) arguments:
85 /// %0 - 0 if the entity was private, 1 if protected
86 /// %1 - the DeclarationName of the entity
87 /// %2 - the TypeDecl type of the naming class
88 /// %3 - the TypeDecl type of the declaring class
89 void setDiag(const PartialDiagnostic &PDiag) {
90 assert(isQuiet() && "partial diagnostic already defined");
93 PartialDiagnostic &setDiag(unsigned DiagID) {
94 assert(isQuiet() && "partial diagnostic already defined");
95 assert(DiagID && "creating null diagnostic");
99 const PartialDiagnostic &getDiag() const {
105 unsigned IsMember : 1;
107 CXXRecordDecl *NamingClass;
108 QualType BaseObjectType;
109 PartialDiagnostic Diag;
112 /// A diagnostic message which has been conditionally emitted pending
113 /// the complete parsing of the current declaration.
114 class DelayedDiagnostic {
116 enum DDKind { Deprecation, Unavailable, Access, ForbiddenType };
118 unsigned char Kind; // actually a DDKind
125 static DelayedDiagnostic makeAvailability(Sema::AvailabilityDiagnostic AD,
128 const ObjCInterfaceDecl *UnknownObjCClass,
129 const ObjCPropertyDecl *ObjCProperty,
131 bool ObjCPropertyAccess);
134 static DelayedDiagnostic makeAccess(SourceLocation Loc,
135 const AccessedEntity &Entity) {
136 DelayedDiagnostic DD;
138 DD.Triggered = false;
140 new (&DD.getAccessData()) AccessedEntity(Entity);
144 static DelayedDiagnostic makeForbiddenType(SourceLocation loc,
148 DelayedDiagnostic DD;
149 DD.Kind = ForbiddenType;
150 DD.Triggered = false;
152 DD.ForbiddenTypeData.Diagnostic = diagnostic;
153 DD.ForbiddenTypeData.OperandType = type.getAsOpaquePtr();
154 DD.ForbiddenTypeData.Argument = argument;
158 AccessedEntity &getAccessData() {
159 assert(Kind == Access && "Not an access diagnostic.");
160 return *reinterpret_cast<AccessedEntity*>(AccessData);
162 const AccessedEntity &getAccessData() const {
163 assert(Kind == Access && "Not an access diagnostic.");
164 return *reinterpret_cast<const AccessedEntity*>(AccessData);
167 const NamedDecl *getDeprecationDecl() const {
168 assert((Kind == Deprecation || Kind == Unavailable) &&
169 "Not a deprecation diagnostic.");
170 return DeprecationData.Decl;
173 StringRef getDeprecationMessage() const {
174 assert((Kind == Deprecation || Kind == Unavailable) &&
175 "Not a deprecation diagnostic.");
176 return StringRef(DeprecationData.Message,
177 DeprecationData.MessageLen);
180 /// The diagnostic ID to emit. Used like so:
181 /// Diag(diag.Loc, diag.getForbiddenTypeDiagnostic())
182 /// << diag.getForbiddenTypeOperand()
183 /// << diag.getForbiddenTypeArgument();
184 unsigned getForbiddenTypeDiagnostic() const {
185 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
186 return ForbiddenTypeData.Diagnostic;
189 unsigned getForbiddenTypeArgument() const {
190 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
191 return ForbiddenTypeData.Argument;
194 QualType getForbiddenTypeOperand() const {
195 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
196 return QualType::getFromOpaquePtr(ForbiddenTypeData.OperandType);
199 const ObjCInterfaceDecl *getUnknownObjCClass() const {
200 return DeprecationData.UnknownObjCClass;
203 const ObjCPropertyDecl *getObjCProperty() const {
204 return DeprecationData.ObjCProperty;
207 bool getObjCPropertyAccess() const {
208 return DeprecationData.ObjCPropertyAccess;
214 const NamedDecl *Decl;
215 const ObjCInterfaceDecl *UnknownObjCClass;
216 const ObjCPropertyDecl *ObjCProperty;
219 bool ObjCPropertyAccess;
230 struct DD DeprecationData;
231 struct FTD ForbiddenTypeData;
234 char AccessData[sizeof(AccessedEntity)];
238 /// \brief A collection of diagnostics which were delayed.
239 class DelayedDiagnosticPool {
240 const DelayedDiagnosticPool *Parent;
241 SmallVector<DelayedDiagnostic, 4> Diagnostics;
243 DelayedDiagnosticPool(const DelayedDiagnosticPool &) LLVM_DELETED_FUNCTION;
244 void operator=(const DelayedDiagnosticPool &) LLVM_DELETED_FUNCTION;
246 DelayedDiagnosticPool(const DelayedDiagnosticPool *parent) : Parent(parent) {}
247 ~DelayedDiagnosticPool() {
248 for (SmallVectorImpl<DelayedDiagnostic>::iterator
249 i = Diagnostics.begin(), e = Diagnostics.end(); i != e; ++i)
253 const DelayedDiagnosticPool *getParent() const { return Parent; }
255 /// Does this pool, or any of its ancestors, contain any diagnostics?
257 return (Diagnostics.empty() && (!Parent || Parent->empty()));
260 /// Add a diagnostic to this pool.
261 void add(const DelayedDiagnostic &diag) {
262 Diagnostics.push_back(diag);
265 /// Steal the diagnostics from the given pool.
266 void steal(DelayedDiagnosticPool &pool) {
267 if (pool.Diagnostics.empty()) return;
269 if (Diagnostics.empty()) {
270 Diagnostics = std::move(pool.Diagnostics);
272 Diagnostics.append(pool.pool_begin(), pool.pool_end());
274 pool.Diagnostics.clear();
277 typedef SmallVectorImpl<DelayedDiagnostic>::const_iterator pool_iterator;
278 pool_iterator pool_begin() const { return Diagnostics.begin(); }
279 pool_iterator pool_end() const { return Diagnostics.end(); }
280 bool pool_empty() const { return Diagnostics.empty(); }
285 /// Add a diagnostic to the current delay pool.
286 inline void Sema::DelayedDiagnostics::add(const sema::DelayedDiagnostic &diag) {
287 assert(shouldDelayDiagnostics() && "trying to delay without pool");