1//===- DelayedDiagnostic.h - Delayed declarator diagnostics -----*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9/// \file
10/// Defines the classes clang::DelayedDiagnostic and
11/// clang::AccessedEntity.
12///
13/// DelayedDiangostic is used to record diagnostics that are being
14/// conditionally produced during declarator parsing. Certain kinds of
15/// diagnostics -- notably deprecation and access control -- are suppressed
16/// based on semantic properties of the parsed declaration that aren't known
17/// until it is fully parsed.
18//
19//===----------------------------------------------------------------------===//
20
21#ifndef LLVM_CLANG_SEMA_DELAYEDDIAGNOSTIC_H
22#define LLVM_CLANG_SEMA_DELAYEDDIAGNOSTIC_H
23
24#include "clang/AST/DeclAccessPair.h"
25#include "clang/AST/DeclBase.h"
26#include "clang/AST/DeclCXX.h"
27#include "clang/AST/Type.h"
28#include "clang/Basic/LLVM.h"
29#include "clang/Basic/PartialDiagnostic.h"
30#include "clang/Basic/SourceLocation.h"
31#include "clang/Basic/Specifiers.h"
32#include "clang/Sema/Sema.h"
33#include "llvm/ADT/ArrayRef.h"
34#include "llvm/ADT/SmallVector.h"
35#include "llvm/ADT/StringRef.h"
36#include "llvm/Support/Casting.h"
37#include <cassert>
38#include <cstddef>
39#include <utility>
40
41namespace clang {
42
43class ObjCInterfaceDecl;
44class ObjCPropertyDecl;
45
46namespace sema {
47
48/// A declaration being accessed, together with information about how
49/// it was accessed.
50class AccessedEntity {
51public:
52 /// A member declaration found through lookup. The target is the
53 /// member.
54 enum MemberNonce { Member };
55
56 /// A hierarchy (base-to-derived or derived-to-base) conversion.
57 /// The target is the base class.
58 enum BaseNonce { Base };
59
60 AccessedEntity(PartialDiagnostic::DiagStorageAllocator &Allocator,
61 MemberNonce _, CXXRecordDecl *NamingClass,
62 DeclAccessPair FoundDecl, QualType BaseObjectType)
63 : Access(FoundDecl.getAccess()), IsMember(true),
64 Target(FoundDecl.getDecl()), NamingClass(NamingClass),
65 BaseObjectType(BaseObjectType), Diag(0, Allocator) {}
66
67 AccessedEntity(PartialDiagnostic::DiagStorageAllocator &Allocator,
68 BaseNonce _, CXXRecordDecl *BaseClass,
69 CXXRecordDecl *DerivedClass, AccessSpecifier Access)
70 : Access(Access), IsMember(false), Target(BaseClass),
71 NamingClass(DerivedClass), Diag(0, Allocator) {}
72
73 bool isMemberAccess() const { return IsMember; }
74
75 bool isQuiet() const { return Diag.getDiagID() == 0; }
76
77 AccessSpecifier getAccess() const { return AccessSpecifier(Access); }
78
79 // These apply to member decls...
80 NamedDecl *getTargetDecl() const { return Target; }
81 CXXRecordDecl *getNamingClass() const { return NamingClass; }
82
83 // ...and these apply to hierarchy conversions.
84 CXXRecordDecl *getBaseClass() const {
85 assert(!IsMember); return cast<CXXRecordDecl>(Val: Target);
86 }
87 CXXRecordDecl *getDerivedClass() const { return NamingClass; }
88
89 /// Retrieves the base object type, important when accessing
90 /// an instance member.
91 QualType getBaseObjectType() const { return BaseObjectType; }
92
93 /// Sets a diagnostic to be performed. The diagnostic is given
94 /// four (additional) arguments:
95 /// %0 - 0 if the entity was private, 1 if protected
96 /// %1 - the DeclarationName of the entity
97 /// %2 - the TypeDecl type of the naming class
98 /// %3 - the TypeDecl type of the declaring class
99 void setDiag(const PartialDiagnostic &PDiag) {
100 assert(isQuiet() && "partial diagnostic already defined");
101 Diag = PDiag;
102 }
103 PartialDiagnostic &setDiag(unsigned DiagID) {
104 assert(isQuiet() && "partial diagnostic already defined");
105 assert(DiagID && "creating null diagnostic");
106 Diag.Reset(DiagID);
107 return Diag;
108 }
109 const PartialDiagnostic &getDiag() const {
110 return Diag;
111 }
112
113private:
114 LLVM_PREFERRED_TYPE(AccessSpecifier)
115 unsigned Access : 2;
116 LLVM_PREFERRED_TYPE(bool)
117 unsigned IsMember : 1;
118 NamedDecl *Target;
119 CXXRecordDecl *NamingClass;
120 QualType BaseObjectType;
121 PartialDiagnostic Diag;
122};
123
124/// A diagnostic message which has been conditionally emitted pending
125/// the complete parsing of the current declaration.
126class DelayedDiagnostic {
127public:
128 enum DDKind : unsigned char { Availability, Access, ForbiddenType };
129
130 DDKind Kind;
131 bool Triggered;
132
133 SourceLocation Loc;
134
135 void Destroy();
136
137 static DelayedDiagnostic makeAvailability(AvailabilityResult AR,
138 ArrayRef<SourceLocation> Locs,
139 const NamedDecl *ReferringDecl,
140 const NamedDecl *OffendingDecl,
141 const ObjCInterfaceDecl *UnknownObjCClass,
142 const ObjCPropertyDecl *ObjCProperty,
143 StringRef Msg,
144 bool ObjCPropertyAccess);
145
146 static DelayedDiagnostic makeAccess(SourceLocation Loc,
147 const AccessedEntity &Entity) {
148 DelayedDiagnostic DD;
149 DD.Kind = Access;
150 DD.Triggered = false;
151 DD.Loc = Loc;
152 new (&DD.getAccessData()) AccessedEntity(Entity);
153 return DD;
154 }
155
156 static DelayedDiagnostic makeForbiddenType(SourceLocation loc,
157 unsigned diagnostic,
158 QualType type,
159 unsigned argument) {
160 DelayedDiagnostic DD;
161 DD.Kind = ForbiddenType;
162 DD.Triggered = false;
163 DD.Loc = loc;
164 DD.ForbiddenTypeData.Diagnostic = diagnostic;
165 DD.ForbiddenTypeData.OperandType = type.getAsOpaquePtr();
166 DD.ForbiddenTypeData.Argument = argument;
167 return DD;
168 }
169
170 AccessedEntity &getAccessData() {
171 assert(Kind == Access && "Not an access diagnostic.");
172 return *reinterpret_cast<AccessedEntity*>(AccessData);
173 }
174 const AccessedEntity &getAccessData() const {
175 assert(Kind == Access && "Not an access diagnostic.");
176 return *reinterpret_cast<const AccessedEntity*>(AccessData);
177 }
178
179 const NamedDecl *getAvailabilityReferringDecl() const {
180 assert(Kind == Availability && "Not an availability diagnostic.");
181 return AvailabilityData.ReferringDecl;
182 }
183
184 const NamedDecl *getAvailabilityOffendingDecl() const {
185 return AvailabilityData.OffendingDecl;
186 }
187
188 StringRef getAvailabilityMessage() const {
189 assert(Kind == Availability && "Not an availability diagnostic.");
190 return StringRef(AvailabilityData.Message, AvailabilityData.MessageLen);
191 }
192
193 ArrayRef<SourceLocation> getAvailabilitySelectorLocs() const {
194 assert(Kind == Availability && "Not an availability diagnostic.");
195 return llvm::ArrayRef(AvailabilityData.SelectorLocs,
196 AvailabilityData.NumSelectorLocs);
197 }
198
199 AvailabilityResult getAvailabilityResult() const {
200 assert(Kind == Availability && "Not an availability diagnostic.");
201 return AvailabilityData.AR;
202 }
203
204 /// The diagnostic ID to emit. Used like so:
205 /// Diag(diag.Loc, diag.getForbiddenTypeDiagnostic())
206 /// << diag.getForbiddenTypeOperand()
207 /// << diag.getForbiddenTypeArgument();
208 unsigned getForbiddenTypeDiagnostic() const {
209 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
210 return ForbiddenTypeData.Diagnostic;
211 }
212
213 unsigned getForbiddenTypeArgument() const {
214 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
215 return ForbiddenTypeData.Argument;
216 }
217
218 QualType getForbiddenTypeOperand() const {
219 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
220 return QualType::getFromOpaquePtr(Ptr: ForbiddenTypeData.OperandType);
221 }
222
223 const ObjCInterfaceDecl *getUnknownObjCClass() const {
224 return AvailabilityData.UnknownObjCClass;
225 }
226
227 const ObjCPropertyDecl *getObjCProperty() const {
228 return AvailabilityData.ObjCProperty;
229 }
230
231 bool getObjCPropertyAccess() const {
232 return AvailabilityData.ObjCPropertyAccess;
233 }
234
235private:
236 struct AD {
237 const NamedDecl *ReferringDecl;
238 const NamedDecl *OffendingDecl;
239 const ObjCInterfaceDecl *UnknownObjCClass;
240 const ObjCPropertyDecl *ObjCProperty;
241 const char *Message;
242 size_t MessageLen;
243 SourceLocation *SelectorLocs;
244 size_t NumSelectorLocs;
245 AvailabilityResult AR;
246 bool ObjCPropertyAccess;
247 };
248
249 struct FTD {
250 unsigned Diagnostic;
251 unsigned Argument;
252 void *OperandType;
253 };
254
255 union {
256 struct AD AvailabilityData;
257 struct FTD ForbiddenTypeData;
258
259 /// Access control.
260 char AccessData[sizeof(AccessedEntity)];
261 };
262};
263
264/// A collection of diagnostics which were delayed.
265class DelayedDiagnosticPool {
266 const DelayedDiagnosticPool *Parent;
267 SmallVector<DelayedDiagnostic, 4> Diagnostics;
268
269public:
270 DelayedDiagnosticPool(const DelayedDiagnosticPool *parent) : Parent(parent) {}
271
272 DelayedDiagnosticPool(const DelayedDiagnosticPool &) = delete;
273 DelayedDiagnosticPool &operator=(const DelayedDiagnosticPool &) = delete;
274
275 DelayedDiagnosticPool(DelayedDiagnosticPool &&Other)
276 : Parent(Other.Parent), Diagnostics(std::move(Other.Diagnostics)) {
277 Other.Diagnostics.clear();
278 }
279
280 DelayedDiagnosticPool &operator=(DelayedDiagnosticPool &&Other) {
281 Parent = Other.Parent;
282 Diagnostics = std::move(Other.Diagnostics);
283 Other.Diagnostics.clear();
284 return *this;
285 }
286
287 ~DelayedDiagnosticPool() {
288 for (SmallVectorImpl<DelayedDiagnostic>::iterator
289 i = Diagnostics.begin(), e = Diagnostics.end(); i != e; ++i)
290 i->Destroy();
291 }
292
293 const DelayedDiagnosticPool *getParent() const { return Parent; }
294
295 /// Does this pool, or any of its ancestors, contain any diagnostics?
296 bool empty() const {
297 return (Diagnostics.empty() && (!Parent || Parent->empty()));
298 }
299
300 /// Add a diagnostic to this pool.
301 void add(const DelayedDiagnostic &diag) {
302 Diagnostics.push_back(Elt: diag);
303 }
304
305 /// Steal the diagnostics from the given pool.
306 void steal(DelayedDiagnosticPool &pool) {
307 if (pool.Diagnostics.empty()) return;
308
309 if (Diagnostics.empty()) {
310 Diagnostics = std::move(pool.Diagnostics);
311 } else {
312 Diagnostics.append(in_start: pool.pool_begin(), in_end: pool.pool_end());
313 }
314 pool.Diagnostics.clear();
315 }
316
317 using pool_iterator = SmallVectorImpl<DelayedDiagnostic>::const_iterator;
318
319 pool_iterator pool_begin() const { return Diagnostics.begin(); }
320 pool_iterator pool_end() const { return Diagnostics.end(); }
321 bool pool_empty() const { return Diagnostics.empty(); }
322};
323
324} // namespace clang
325
326/// Add a diagnostic to the current delay pool.
327inline void Sema::DelayedDiagnostics::add(const sema::DelayedDiagnostic &diag) {
328 assert(shouldDelayDiagnostics() && "trying to delay without pool");
329 CurPool->add(diag);
330}
331
332} // namespace clang
333
334#endif // LLVM_CLANG_SEMA_DELAYEDDIAGNOSTIC_H
335

source code of clang/include/clang/Sema/DelayedDiagnostic.h