clang 19.0.0git
DelayedDiagnostic.h
Go to the documentation of this file.
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
25#include "clang/AST/DeclBase.h"
26#include "clang/AST/DeclCXX.h"
27#include "clang/AST/Type.h"
28#include "clang/Basic/LLVM.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.
51public:
52 /// A member declaration found through lookup. The target is the
53 /// 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
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
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.
85 assert(!IsMember); return cast<CXXRecordDecl>(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;
119 CXXRecordDecl *NamingClass;
120 QualType BaseObjectType;
122};
123
124/// A diagnostic message which has been conditionally emitted pending
125/// the complete parsing of the current declaration.
127public:
128 enum DDKind : unsigned char { Availability, Access, ForbiddenType };
129
132
134
135 void Destroy();
136
139 const NamedDecl *ReferringDecl,
140 const NamedDecl *OffendingDecl,
141 const ObjCInterfaceDecl *UnknownObjCClass,
142 const ObjCPropertyDecl *ObjCProperty,
143 StringRef Msg,
144 bool ObjCPropertyAccess);
145
147 const AccessedEntity &Entity) {
149 DD.Kind = Access;
150 DD.Triggered = false;
151 DD.Loc = Loc;
152 new (&DD.getAccessData()) AccessedEntity(Entity);
153 return DD;
154 }
155
157 unsigned diagnostic,
159 unsigned argument) {
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
171 assert(Kind == Access && "Not an access diagnostic.");
172 return *reinterpret_cast<AccessedEntity*>(AccessData);
173 }
175 assert(Kind == Access && "Not an access diagnostic.");
176 return *reinterpret_cast<const AccessedEntity*>(AccessData);
177 }
178
180 assert(Kind == Availability && "Not an availability diagnostic.");
181 return AvailabilityData.ReferringDecl;
182 }
183
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
194 assert(Kind == Availability && "Not an availability diagnostic.");
195 return llvm::ArrayRef(AvailabilityData.SelectorLocs,
196 AvailabilityData.NumSelectorLocs);
197 }
198
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
219 assert(Kind == ForbiddenType && "not a forbidden-type diagnostic");
221 }
222
224 return AvailabilityData.UnknownObjCClass;
225 }
226
228 return AvailabilityData.ObjCProperty;
229 }
230
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;
246 bool ObjCPropertyAccess;
247 };
248
249 struct FTD {
250 unsigned Diagnostic;
251 unsigned Argument;
252 void *OperandType;
253 };
254
255 union {
258
259 /// Access control.
261 };
262};
263
264/// A collection of diagnostics which were delayed.
266 const DelayedDiagnosticPool *Parent;
268
269public:
271
274
276 : Parent(Other.Parent), Diagnostics(std::move(Other.Diagnostics)) {
277 Other.Diagnostics.clear();
278 }
279
281 Parent = Other.Parent;
282 Diagnostics = std::move(Other.Diagnostics);
283 Other.Diagnostics.clear();
284 return *this;
285 }
286
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(diag);
303 }
304
305 /// Steal the diagnostics from the given pool.
307 if (pool.Diagnostics.empty()) return;
308
309 if (Diagnostics.empty()) {
310 Diagnostics = std::move(pool.Diagnostics);
311 } else {
312 Diagnostics.append(pool.pool_begin(), pool.pool_end());
313 }
314 pool.Diagnostics.clear();
315 }
316
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.
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
NodeId Parent
Definition: ASTDiff.cpp:191
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate....
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
llvm::MachO::Target Target
Definition: MachO.h:50
Implements a partial diagnostic that can be emitted anwyhere in a DiagnosticBuilder stream.
Defines the clang::SourceLocation class and associated facilities.
Defines various enumerations that describe declaration and type specifiers.
C Language Family Type Representation.
Represents a C++ struct/union/class.
Definition: DeclCXX.h:258
A POD class for pairing a NamedDecl* with an access specifier.
A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) ...
Definition: Diagnostic.h:1571
This represents a decl that may have a name.
Definition: Decl.h:249
Represents an ObjC class declaration.
Definition: DeclObjC.h:1153
Represents one property declaration in an Objective-C interface.
Definition: DeclObjC.h:730
void Reset(unsigned DiagID=0)
Clear out this partial diagnostic, giving it a new diagnostic ID and removing all of its arguments,...
A (possibly-)qualified type.
Definition: Type.h:940
static QualType getFromOpaquePtr(const void *Ptr)
Definition: Type.h:989
bool shouldDelayDiagnostics()
Determines whether diagnostics should be delayed.
Definition: Sema.h:939
void add(const sema::DelayedDiagnostic &diag)
Adds a delayed diagnostic.
Encodes a location in the source.
An allocator for DiagnosticStorage objects, which uses a small cache to objects, used to reduce mallo...
Definition: Diagnostic.h:1119
A declaration being accessed, together with information about how it was accessed.
PartialDiagnostic & setDiag(unsigned DiagID)
void setDiag(const PartialDiagnostic &PDiag)
Sets a diagnostic to be performed.
CXXRecordDecl * getNamingClass() const
BaseNonce
A hierarchy (base-to-derived or derived-to-base) conversion.
AccessedEntity(PartialDiagnostic::DiagStorageAllocator &Allocator, MemberNonce _, CXXRecordDecl *NamingClass, DeclAccessPair FoundDecl, QualType BaseObjectType)
CXXRecordDecl * getBaseClass() const
const PartialDiagnostic & getDiag() const
CXXRecordDecl * getDerivedClass() const
NamedDecl * getTargetDecl() const
AccessedEntity(PartialDiagnostic::DiagStorageAllocator &Allocator, BaseNonce _, CXXRecordDecl *BaseClass, CXXRecordDecl *DerivedClass, AccessSpecifier Access)
QualType getBaseObjectType() const
Retrieves the base object type, important when accessing an instance member.
AccessSpecifier getAccess() const
MemberNonce
A member declaration found through lookup.
A collection of diagnostics which were delayed.
const DelayedDiagnosticPool * getParent() const
DelayedDiagnosticPool(DelayedDiagnosticPool &&Other)
void steal(DelayedDiagnosticPool &pool)
Steal the diagnostics from the given pool.
DelayedDiagnosticPool(const DelayedDiagnosticPool &)=delete
void add(const DelayedDiagnostic &diag)
Add a diagnostic to this pool.
DelayedDiagnosticPool & operator=(DelayedDiagnosticPool &&Other)
bool empty() const
Does this pool, or any of its ancestors, contain any diagnostics?
SmallVectorImpl< DelayedDiagnostic >::const_iterator pool_iterator
DelayedDiagnosticPool(const DelayedDiagnosticPool *parent)
DelayedDiagnosticPool & operator=(const DelayedDiagnosticPool &)=delete
A diagnostic message which has been conditionally emitted pending the complete parsing of the current...
static DelayedDiagnostic makeAvailability(AvailabilityResult AR, ArrayRef< SourceLocation > Locs, const NamedDecl *ReferringDecl, const NamedDecl *OffendingDecl, const ObjCInterfaceDecl *UnknownObjCClass, const ObjCPropertyDecl *ObjCProperty, StringRef Msg, bool ObjCPropertyAccess)
QualType getForbiddenTypeOperand() const
const ObjCInterfaceDecl * getUnknownObjCClass() const
static DelayedDiagnostic makeForbiddenType(SourceLocation loc, unsigned diagnostic, QualType type, unsigned argument)
const NamedDecl * getAvailabilityOffendingDecl() const
static DelayedDiagnostic makeAccess(SourceLocation Loc, const AccessedEntity &Entity)
unsigned getForbiddenTypeDiagnostic() const
The diagnostic ID to emit.
char AccessData[sizeof(AccessedEntity)]
Access control.
const ObjCPropertyDecl * getObjCProperty() const
StringRef getAvailabilityMessage() const
ArrayRef< SourceLocation > getAvailabilitySelectorLocs() const
AvailabilityResult getAvailabilityResult() const
const NamedDecl * getAvailabilityReferringDecl() const
unsigned getForbiddenTypeArgument() const
const AccessedEntity & getAccessData() const
const internal::VariadicAllOfMatcher< Type > type
Matches Types in the clang AST.
The JSON file list parser is used to communicate input to InstallAPI.
AvailabilityResult
Captures the result of checking the availability of a declaration.
Definition: DeclBase.h:72
@ Other
Other implicit parameter.
AccessSpecifier
A C++ access specifier (public, private, protected), plus the special value "none" which means differ...
Definition: Specifiers.h:120
Definition: Format.h:5428
#define true
Definition: stdbool.h:25
#define false
Definition: stdbool.h:26