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 //===----------------------------------------------------------------------===//
10 // This file defines the DelayedDiagnostic class, which is used to
11 // record diagnostics that are being conditionally produced during
12 // declarator parsing. Certain kinds of diagnostics --- notably
13 // deprecation and access control --- are suppressed based on
14 // semantic properties of the parsed declaration that aren't known
15 // until it is fully parsed.
17 // This file also defines AccessedEntity.
19 //===----------------------------------------------------------------------===//
21 #ifndef LLVM_CLANG_SEMA_DELAYED_DIAGNOSTIC_H
22 #define LLVM_CLANG_SEMA_DELAYED_DIAGNOSTIC_H
24 #include "clang/AST/DeclCXX.h"
29 /// A declaration being accessed, together with information about how
31 class AccessedEntity {
33 /// A member declaration found through lookup. The target is the
35 enum MemberNonce { Member };
37 /// A hierarchy (base-to-derived or derived-to-base) conversion.
38 /// The target is the base class.
39 enum BaseNonce { Base };
41 bool isMemberAccess() const { return IsMember; }
43 AccessedEntity(ASTContext &Context,
45 CXXRecordDecl *NamingClass,
46 DeclAccessPair FoundDecl,
47 QualType BaseObjectType)
48 : Access(FoundDecl.getAccess()), IsMember(true),
49 Target(FoundDecl.getDecl()), NamingClass(NamingClass),
50 BaseObjectType(BaseObjectType), Diag(0, Context.getDiagAllocator()) {
53 AccessedEntity(ASTContext &Context,
55 CXXRecordDecl *BaseClass,
56 CXXRecordDecl *DerivedClass,
57 AccessSpecifier Access)
58 : Access(Access), IsMember(false),
60 NamingClass(DerivedClass),
61 Diag(0, Context.getDiagAllocator()) {
64 bool isQuiet() const { return Diag.getDiagID() == 0; }
66 AccessSpecifier getAccess() const { return AccessSpecifier(Access); }
68 // These apply to member decls...
69 NamedDecl *getTargetDecl() const { return Target; }
70 CXXRecordDecl *getNamingClass() const { return NamingClass; }
72 // ...and these apply to hierarchy conversions.
73 CXXRecordDecl *getBaseClass() const {
74 assert(!IsMember); return cast<CXXRecordDecl>(Target);
76 CXXRecordDecl *getDerivedClass() const { return NamingClass; }
78 /// Retrieves the base object type, important when accessing
79 /// an instance member.
80 QualType getBaseObjectType() const { return BaseObjectType; }
82 /// Sets a diagnostic to be performed. The diagnostic is given
83 /// four (additional) arguments:
84 /// %0 - 0 if the entity was private, 1 if protected
85 /// %1 - the DeclarationName of the entity
86 /// %2 - the TypeDecl type of the naming class
87 /// %3 - the TypeDecl type of the declaring class
88 void setDiag(const PartialDiagnostic &PDiag) {
89 assert(isQuiet() && "partial diagnostic already defined");
92 PartialDiagnostic &setDiag(unsigned DiagID) {
93 assert(isQuiet() && "partial diagnostic already defined");
94 assert(DiagID && "creating null diagnostic");
98 const PartialDiagnostic &getDiag() const {
104 unsigned IsMember : 1;
106 CXXRecordDecl *NamingClass;
107 QualType BaseObjectType;
108 PartialDiagnostic Diag;
111 /// A diagnostic message which has been conditionally emitted pending
112 /// the complete parsing of the current declaration.
113 class DelayedDiagnostic {
115 enum DDKind { Deprecation, Access };
117 unsigned char Kind; // actually a DDKind
124 case Access: getAccessData().~AccessedEntity(); break;
125 case Deprecation: break;
129 static DelayedDiagnostic makeDeprecation(SourceLocation Loc,
131 llvm::StringRef Msg) {
132 DelayedDiagnostic DD;
133 DD.Kind = Deprecation;
134 DD.Triggered = false;
136 DD.DeprecationData.Decl = D;
137 DD.DeprecationData.Message = Msg.data();
138 DD.DeprecationData.MessageLen = Msg.size();
142 static DelayedDiagnostic makeAccess(SourceLocation Loc,
143 const AccessedEntity &Entity) {
144 DelayedDiagnostic DD;
146 DD.Triggered = false;
148 new (&DD.getAccessData()) AccessedEntity(Entity);
152 AccessedEntity &getAccessData() {
153 assert(Kind == Access && "Not an access diagnostic.");
154 return *reinterpret_cast<AccessedEntity*>(AccessData);
156 const AccessedEntity &getAccessData() const {
157 assert(Kind == Access && "Not an access diagnostic.");
158 return *reinterpret_cast<const AccessedEntity*>(AccessData);
161 const NamedDecl *getDeprecationDecl() const {
162 assert(Kind == Deprecation && "Not a deprecation diagnostic.");
163 return DeprecationData.Decl;
166 llvm::StringRef getDeprecationMessage() const {
167 assert(Kind == Deprecation && "Not a deprecation diagnostic.");
168 return llvm::StringRef(DeprecationData.Message,
169 DeprecationData.MessageLen);
176 const NamedDecl *Decl;
182 char AccessData[sizeof(AccessedEntity)];