1 //===--- Attr.h - Classes for representing attributes ----------*- 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 Attr interface and subclasses.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_AST_ATTR_H
15 #define LLVM_CLANG_AST_ATTR_H
17 #include "clang/AST/AttrIterator.h"
18 #include "clang/AST/Decl.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/Type.h"
21 #include "clang/Basic/AttrKinds.h"
22 #include "clang/Basic/LLVM.h"
23 #include "clang/Basic/OpenMPKinds.h"
24 #include "clang/Basic/Sanitizers.h"
25 #include "clang/Basic/SourceLocation.h"
26 #include "llvm/ADT/StringSwitch.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Support/VersionTuple.h"
29 #include "llvm/Support/raw_ostream.h"
36 class ObjCInterfaceDecl;
42 /// Attr - This represents one attribute.
46 unsigned AttrKind : 16;
49 /// An index into the spelling list of an
50 /// attribute defined in Attr.td file.
51 unsigned SpellingListIndex : 4;
52 unsigned Inherited : 1;
53 unsigned IsPackExpansion : 1;
54 unsigned Implicit : 1;
55 // FIXME: These are properties of the attribute kind, not state for this
56 // instance of the attribute.
57 unsigned IsLateParsed : 1;
58 unsigned InheritEvenIfAlreadyPresent : 1;
60 void *operator new(size_t bytes) noexcept {
61 llvm_unreachable("Attrs cannot be allocated with regular 'new'.");
63 void operator delete(void *data) noexcept {
64 llvm_unreachable("Attrs cannot be released with regular 'delete'.");
68 // Forward so that the regular new and delete do not hide global ones.
69 void *operator new(size_t Bytes, ASTContext &C,
70 size_t Alignment = 8) noexcept {
71 return ::operator new(Bytes, C, Alignment);
73 void operator delete(void *Ptr, ASTContext &C, size_t Alignment) noexcept {
74 return ::operator delete(Ptr, C, Alignment);
78 Attr(attr::Kind AK, SourceRange R, unsigned SpellingListIndex,
80 : Range(R), AttrKind(AK), SpellingListIndex(SpellingListIndex),
81 Inherited(false), IsPackExpansion(false), Implicit(false),
82 IsLateParsed(IsLateParsed), InheritEvenIfAlreadyPresent(false) {}
86 attr::Kind getKind() const {
87 return static_cast<attr::Kind>(AttrKind);
90 unsigned getSpellingListIndex() const { return SpellingListIndex; }
91 const char *getSpelling() const;
93 SourceLocation getLocation() const { return Range.getBegin(); }
94 SourceRange getRange() const { return Range; }
95 void setRange(SourceRange R) { Range = R; }
97 bool isInherited() const { return Inherited; }
99 /// Returns true if the attribute has been implicitly created instead
100 /// of explicitly written by the user.
101 bool isImplicit() const { return Implicit; }
102 void setImplicit(bool I) { Implicit = I; }
104 void setPackExpansion(bool PE) { IsPackExpansion = PE; }
105 bool isPackExpansion() const { return IsPackExpansion; }
107 // Clone this attribute.
108 Attr *clone(ASTContext &C) const;
110 bool isLateParsed() const { return IsLateParsed; }
112 // Pretty print this attribute.
113 void printPretty(raw_ostream &OS, const PrintingPolicy &Policy) const;
116 class StmtAttr : public Attr {
118 StmtAttr(attr::Kind AK, SourceRange R, unsigned SpellingListIndex,
120 : Attr(AK, R, SpellingListIndex, IsLateParsed) {}
123 static bool classof(const Attr *A) {
124 return A->getKind() >= attr::FirstStmtAttr &&
125 A->getKind() <= attr::LastStmtAttr;
129 class InheritableAttr : public Attr {
131 InheritableAttr(attr::Kind AK, SourceRange R, unsigned SpellingListIndex,
132 bool IsLateParsed, bool InheritEvenIfAlreadyPresent)
133 : Attr(AK, R, SpellingListIndex, IsLateParsed) {
134 this->InheritEvenIfAlreadyPresent = InheritEvenIfAlreadyPresent;
138 void setInherited(bool I) { Inherited = I; }
140 /// Should this attribute be inherited from a prior declaration even if it's
141 /// explicitly provided in the current declaration?
142 bool shouldInheritEvenIfAlreadyPresent() const {
143 return InheritEvenIfAlreadyPresent;
146 // Implement isa/cast/dyncast/etc.
147 static bool classof(const Attr *A) {
148 return A->getKind() >= attr::FirstInheritableAttr &&
149 A->getKind() <= attr::LastInheritableAttr;
153 class InheritableParamAttr : public InheritableAttr {
155 InheritableParamAttr(attr::Kind AK, SourceRange R, unsigned SpellingListIndex,
156 bool IsLateParsed, bool InheritEvenIfAlreadyPresent)
157 : InheritableAttr(AK, R, SpellingListIndex, IsLateParsed,
158 InheritEvenIfAlreadyPresent) {}
161 // Implement isa/cast/dyncast/etc.
162 static bool classof(const Attr *A) {
163 return A->getKind() >= attr::FirstInheritableParamAttr &&
164 A->getKind() <= attr::LastInheritableParamAttr;
168 /// A parameter attribute which changes the argument-passing ABI rule
169 /// for the parameter.
170 class ParameterABIAttr : public InheritableParamAttr {
172 ParameterABIAttr(attr::Kind AK, SourceRange R,
173 unsigned SpellingListIndex, bool IsLateParsed,
174 bool InheritEvenIfAlreadyPresent)
175 : InheritableParamAttr(AK, R, SpellingListIndex, IsLateParsed,
176 InheritEvenIfAlreadyPresent) {}
179 ParameterABI getABI() const {
181 case attr::SwiftContext:
182 return ParameterABI::SwiftContext;
183 case attr::SwiftErrorResult:
184 return ParameterABI::SwiftErrorResult;
185 case attr::SwiftIndirectResult:
186 return ParameterABI::SwiftIndirectResult;
188 llvm_unreachable("bad parameter ABI attribute kind");
192 static bool classof(const Attr *A) {
193 return A->getKind() >= attr::FirstParameterABIAttr &&
194 A->getKind() <= attr::LastParameterABIAttr;
198 /// A single parameter index whose accessors require each use to make explicit
199 /// the parameter index encoding needed.
201 // Idx is exposed only via accessors that specify specific encodings.
203 unsigned HasThis : 1;
204 unsigned IsValid : 1;
206 void assertComparable(const ParamIdx &I) const {
207 assert(isValid() && I.isValid() &&
208 "ParamIdx must be valid to be compared");
209 // It's possible to compare indices from separate functions, but so far
210 // it's not proven useful. Moreover, it might be confusing because a
211 // comparison on the results of getASTIndex might be inconsistent with a
212 // comparison on the ParamIdx objects themselves.
213 assert(HasThis == I.HasThis &&
214 "ParamIdx must be for the same function to be compared");
218 /// Construct an invalid parameter index (\c isValid returns false and
219 /// accessors fail an assert).
220 ParamIdx() : Idx(0), HasThis(false), IsValid(false) {}
222 /// \param Idx is the parameter index as it is normally specified in
223 /// attributes in the source: one-origin including any C++ implicit this
226 /// \param D is the declaration containing the parameters. It is used to
227 /// determine if there is a C++ implicit this parameter.
228 ParamIdx(unsigned Idx, const Decl *D)
229 : Idx(Idx), HasThis(false), IsValid(true) {
230 assert(Idx >= 1 && "Idx must be one-origin");
231 if (const auto *FD = dyn_cast<FunctionDecl>(D))
232 HasThis = FD->isCXXInstanceMember();
235 /// A type into which \c ParamIdx can be serialized.
237 /// A static assertion that it's of the correct size follows the \c ParamIdx
238 /// class definition.
239 typedef uint32_t SerialType;
241 /// Produce a representation that can later be passed to \c deserialize to
242 /// construct an equivalent \c ParamIdx.
243 SerialType serialize() const {
244 return *reinterpret_cast<const SerialType *>(this);
247 /// Construct from a result from \c serialize.
248 static ParamIdx deserialize(SerialType S) {
249 ParamIdx P(*reinterpret_cast<ParamIdx *>(&S));
250 assert((!P.IsValid || P.Idx >= 1) && "valid Idx must be one-origin");
254 /// Is this parameter index valid?
255 bool isValid() const { return IsValid; }
257 /// Get the parameter index as it would normally be encoded for attributes at
258 /// the source level of representation: one-origin including any C++ implicit
261 /// This encoding thus makes sense for diagnostics, pretty printing, and
262 /// constructing new attributes from a source-like specification.
263 unsigned getSourceIndex() const {
264 assert(isValid() && "ParamIdx must be valid");
268 /// Get the parameter index as it would normally be encoded at the AST level
269 /// of representation: zero-origin not including any C++ implicit this
272 /// This is the encoding primarily used in Sema. However, in diagnostics,
273 /// Sema uses \c getSourceIndex instead.
274 unsigned getASTIndex() const {
275 assert(isValid() && "ParamIdx must be valid");
276 assert(Idx >= 1 + HasThis &&
277 "stored index must be base-1 and not specify C++ implicit this");
278 return Idx - 1 - HasThis;
281 /// Get the parameter index as it would normally be encoded at the LLVM level
282 /// of representation: zero-origin including any C++ implicit this parameter.
284 /// This is the encoding primarily used in CodeGen.
285 unsigned getLLVMIndex() const {
286 assert(isValid() && "ParamIdx must be valid");
287 assert(Idx >= 1 && "stored index must be base-1");
291 bool operator==(const ParamIdx &I) const {
295 bool operator!=(const ParamIdx &I) const {
299 bool operator<(const ParamIdx &I) const {
303 bool operator>(const ParamIdx &I) const {
307 bool operator<=(const ParamIdx &I) const {
311 bool operator>=(const ParamIdx &I) const {
317 static_assert(sizeof(ParamIdx) == sizeof(ParamIdx::SerialType),
318 "ParamIdx does not fit its serialization type");
320 #include "clang/AST/Attrs.inc"
322 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
324 DB.AddTaggedVal(reinterpret_cast<intptr_t>(At),
325 DiagnosticsEngine::ak_attr);
329 inline const PartialDiagnostic &operator<<(const PartialDiagnostic &PD,
331 PD.AddTaggedVal(reinterpret_cast<intptr_t>(At),
332 DiagnosticsEngine::ak_attr);
335 } // end namespace clang