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_DELAYED_DIAGNOSTIC_H
23 #define LLVM_CLANG_SEMA_DELAYED_DIAGNOSTIC_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,
133 static DelayedDiagnostic makeAccess(SourceLocation Loc,
134 const AccessedEntity &Entity) {
135 DelayedDiagnostic DD;
137 DD.Triggered = false;
139 new (&DD.getAccessData()) AccessedEntity(Entity);
143 static DelayedDiagnostic makeForbiddenType(SourceLocation loc,
147 DelayedDiagnostic DD;
148 DD.Kind = ForbiddenType;
149 DD.Triggered = false;
151 DD.ForbiddenTypeData.Diagnostic = diagnostic;
152 DD.ForbiddenTypeData.OperandType = type.getAsOpaquePtr();
153 DD.ForbiddenTypeData.Argument = argument;
157 AccessedEntity &getAccessData() {
158 assert(Kind == Access && "Not an access diagnostic.");
159 return *reinterpret_cast<AccessedEntity*>(AccessData);
161 const AccessedEntity &getAccessData() const {
162 assert(Kind == Access && "Not an access diagnostic.");
163 return *reinterpret_cast<const AccessedEntity*>(AccessData);
166 const NamedDecl *getDeprecationDecl() const {
167 assert((Kind == Deprecation || Kind == Unavailable) &&
168 "Not a deprecation diagnostic.");
169 return DeprecationData.Decl;
172 StringRef getDeprecationMessage() const {
173 assert((Kind == Deprecation || Kind == Unavailable) &&
174 "Not a deprecation diagnostic.");
175 return StringRef(DeprecationData.Message,
176 DeprecationData.MessageLen);
179 /// The diagnostic ID to emit. Used like so:
180 /// Diag(diag.Loc, diag.getForbiddenTypeDiagnostic())
181 /// << diag.getForbiddenTypeOperand()
182 /// << diag.getForbiddenTypeArgument();
183 unsigned getForbiddenTypeDiagnostic() const {
184 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
185 return ForbiddenTypeData.Diagnostic;
188 unsigned getForbiddenTypeArgument() const {
189 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
190 return ForbiddenTypeData.Argument;
193 QualType getForbiddenTypeOperand() const {
194 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
195 return QualType::getFromOpaquePtr(ForbiddenTypeData.OperandType);
198 const ObjCInterfaceDecl *getUnknownObjCClass() const {
199 return DeprecationData.UnknownObjCClass;
202 const ObjCPropertyDecl *getObjCProperty() const {
203 return DeprecationData.ObjCProperty;
209 const NamedDecl *Decl;
210 const ObjCInterfaceDecl *UnknownObjCClass;
211 const ObjCPropertyDecl *ObjCProperty;
224 struct DD DeprecationData;
225 struct FTD ForbiddenTypeData;
228 char AccessData[sizeof(AccessedEntity)];
232 /// \brief A collection of diagnostics which were delayed.
233 class DelayedDiagnosticPool {
234 const DelayedDiagnosticPool *Parent;
235 SmallVector<DelayedDiagnostic, 4> Diagnostics;
237 DelayedDiagnosticPool(const DelayedDiagnosticPool &) LLVM_DELETED_FUNCTION;
238 void operator=(const DelayedDiagnosticPool &) LLVM_DELETED_FUNCTION;
240 DelayedDiagnosticPool(const DelayedDiagnosticPool *parent) : Parent(parent) {}
241 ~DelayedDiagnosticPool() {
242 for (SmallVectorImpl<DelayedDiagnostic>::iterator
243 i = Diagnostics.begin(), e = Diagnostics.end(); i != e; ++i)
247 const DelayedDiagnosticPool *getParent() const { return Parent; }
249 /// Does this pool, or any of its ancestors, contain any diagnostics?
251 return (Diagnostics.empty() && (!Parent || Parent->empty()));
254 /// Add a diagnostic to this pool.
255 void add(const DelayedDiagnostic &diag) {
256 Diagnostics.push_back(diag);
259 /// Steal the diagnostics from the given pool.
260 void steal(DelayedDiagnosticPool &pool) {
261 if (pool.Diagnostics.empty()) return;
263 if (Diagnostics.empty()) {
264 Diagnostics = std::move(pool.Diagnostics);
266 Diagnostics.append(pool.pool_begin(), pool.pool_end());
268 pool.Diagnostics.clear();
271 typedef SmallVectorImpl<DelayedDiagnostic>::const_iterator pool_iterator;
272 pool_iterator pool_begin() const { return Diagnostics.begin(); }
273 pool_iterator pool_end() const { return Diagnostics.end(); }
274 bool pool_empty() const { return Diagnostics.empty(); }
279 /// Add a diagnostic to the current delay pool.
280 inline void Sema::DelayedDiagnostics::add(const sema::DelayedDiagnostic &diag) {
281 assert(shouldDelayDiagnostics() && "trying to delay without pool");