1 //===- Decl.h - Classes for representing declarations -----------*- C++ -*-===//
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
7 //===----------------------------------------------------------------------===//
9 // This file defines the Decl subclasses.
11 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_CLANG_AST_DECL_H
14 #define LLVM_CLANG_AST_DECL_H
16 #include "clang/AST/APValue.h"
17 #include "clang/AST/ASTContextAllocate.h"
18 #include "clang/AST/DeclBase.h"
19 #include "clang/AST/DeclarationName.h"
20 #include "clang/AST/ExternalASTSource.h"
21 #include "clang/AST/NestedNameSpecifier.h"
22 #include "clang/AST/Redeclarable.h"
23 #include "clang/AST/Type.h"
24 #include "clang/Basic/AddressSpaces.h"
25 #include "clang/Basic/Diagnostic.h"
26 #include "clang/Basic/IdentifierTable.h"
27 #include "clang/Basic/LLVM.h"
28 #include "clang/Basic/Linkage.h"
29 #include "clang/Basic/OperatorKinds.h"
30 #include "clang/Basic/PartialDiagnostic.h"
31 #include "clang/Basic/PragmaKinds.h"
32 #include "clang/Basic/SourceLocation.h"
33 #include "clang/Basic/Specifiers.h"
34 #include "clang/Basic/Visibility.h"
35 #include "llvm/ADT/APSInt.h"
36 #include "llvm/ADT/ArrayRef.h"
37 #include "llvm/ADT/Optional.h"
38 #include "llvm/ADT/PointerIntPair.h"
39 #include "llvm/ADT/PointerUnion.h"
40 #include "llvm/ADT/StringRef.h"
41 #include "llvm/ADT/iterator_range.h"
42 #include "llvm/Support/Casting.h"
43 #include "llvm/Support/Compiler.h"
44 #include "llvm/Support/TrailingObjects.h"
54 struct ASTTemplateArgumentListInfo;
57 class DependentFunctionTemplateSpecializationInfo;
60 class FunctionTemplateDecl;
61 class FunctionTemplateSpecializationInfo;
63 class MemberSpecializationInfo;
71 class TemplateArgumentList;
72 class TemplateArgumentListInfo;
73 class TemplateParameterList;
74 class TypeAliasTemplateDecl;
76 class UnresolvedSetImpl;
77 class VarTemplateDecl;
79 /// A container of type source information.
81 /// A client can read the relevant info using TypeLoc wrappers, e.g:
83 /// TypeLoc TL = TypeSourceInfo->getTypeLoc();
84 /// TL.getBeginLoc().print(OS, SrcMgr);
86 class alignas(8) TypeSourceInfo {
87 // Contains a memory block after the class, used for type source information,
88 // allocated by ASTContext.
89 friend class ASTContext;
93 TypeSourceInfo(QualType ty) : Ty(ty) {}
96 /// Return the type wrapped by this type source info.
97 QualType getType() const { return Ty; }
99 /// Return the TypeLoc wrapper for the type source info.
100 TypeLoc getTypeLoc() const; // implemented in TypeLoc.h
102 /// Override the type stored in this TypeSourceInfo. Use with caution!
103 void overrideType(QualType T) { Ty = T; }
106 /// The top declaration context.
107 class TranslationUnitDecl : public Decl, public DeclContext {
110 /// The (most recently entered) anonymous namespace for this
111 /// translation unit, if one has been created.
112 NamespaceDecl *AnonymousNamespace = nullptr;
114 explicit TranslationUnitDecl(ASTContext &ctx);
116 virtual void anchor();
119 ASTContext &getASTContext() const { return Ctx; }
121 NamespaceDecl *getAnonymousNamespace() const { return AnonymousNamespace; }
122 void setAnonymousNamespace(NamespaceDecl *D) { AnonymousNamespace = D; }
124 static TranslationUnitDecl *Create(ASTContext &C);
126 // Implement isa/cast/dyncast/etc.
127 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
128 static bool classofKind(Kind K) { return K == TranslationUnit; }
129 static DeclContext *castToDeclContext(const TranslationUnitDecl *D) {
130 return static_cast<DeclContext *>(const_cast<TranslationUnitDecl*>(D));
132 static TranslationUnitDecl *castFromDeclContext(const DeclContext *DC) {
133 return static_cast<TranslationUnitDecl *>(const_cast<DeclContext*>(DC));
137 /// Represents a `#pragma comment` line. Always a child of
138 /// TranslationUnitDecl.
139 class PragmaCommentDecl final
141 private llvm::TrailingObjects<PragmaCommentDecl, char> {
142 friend class ASTDeclReader;
143 friend class ASTDeclWriter;
144 friend TrailingObjects;
146 PragmaMSCommentKind CommentKind;
148 PragmaCommentDecl(TranslationUnitDecl *TU, SourceLocation CommentLoc,
149 PragmaMSCommentKind CommentKind)
150 : Decl(PragmaComment, TU, CommentLoc), CommentKind(CommentKind) {}
152 virtual void anchor();
155 static PragmaCommentDecl *Create(const ASTContext &C, TranslationUnitDecl *DC,
156 SourceLocation CommentLoc,
157 PragmaMSCommentKind CommentKind,
159 static PragmaCommentDecl *CreateDeserialized(ASTContext &C, unsigned ID,
162 PragmaMSCommentKind getCommentKind() const { return CommentKind; }
164 StringRef getArg() const { return getTrailingObjects<char>(); }
166 // Implement isa/cast/dyncast/etc.
167 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
168 static bool classofKind(Kind K) { return K == PragmaComment; }
171 /// Represents a `#pragma detect_mismatch` line. Always a child of
172 /// TranslationUnitDecl.
173 class PragmaDetectMismatchDecl final
175 private llvm::TrailingObjects<PragmaDetectMismatchDecl, char> {
176 friend class ASTDeclReader;
177 friend class ASTDeclWriter;
178 friend TrailingObjects;
182 PragmaDetectMismatchDecl(TranslationUnitDecl *TU, SourceLocation Loc,
184 : Decl(PragmaDetectMismatch, TU, Loc), ValueStart(ValueStart) {}
186 virtual void anchor();
189 static PragmaDetectMismatchDecl *Create(const ASTContext &C,
190 TranslationUnitDecl *DC,
191 SourceLocation Loc, StringRef Name,
193 static PragmaDetectMismatchDecl *
194 CreateDeserialized(ASTContext &C, unsigned ID, unsigned NameValueSize);
196 StringRef getName() const { return getTrailingObjects<char>(); }
197 StringRef getValue() const { return getTrailingObjects<char>() + ValueStart; }
199 // Implement isa/cast/dyncast/etc.
200 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
201 static bool classofKind(Kind K) { return K == PragmaDetectMismatch; }
204 /// Declaration context for names declared as extern "C" in C++. This
205 /// is neither the semantic nor lexical context for such declarations, but is
206 /// used to check for conflicts with other extern "C" declarations. Example:
209 /// namespace N { extern "C" void f(); } // #1
210 /// void N::f() {} // #2
211 /// namespace M { extern "C" void f(); } // #3
214 /// The semantic context of #1 is namespace N and its lexical context is the
215 /// LinkageSpecDecl; the semantic context of #2 is namespace N and its lexical
216 /// context is the TU. However, both declarations are also visible in the
217 /// extern "C" context.
219 /// The declaration at #3 finds it is a redeclaration of \c N::f through
220 /// lookup in the extern "C" context.
221 class ExternCContextDecl : public Decl, public DeclContext {
222 explicit ExternCContextDecl(TranslationUnitDecl *TU)
223 : Decl(ExternCContext, TU, SourceLocation()),
224 DeclContext(ExternCContext) {}
226 virtual void anchor();
229 static ExternCContextDecl *Create(const ASTContext &C,
230 TranslationUnitDecl *TU);
232 // Implement isa/cast/dyncast/etc.
233 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
234 static bool classofKind(Kind K) { return K == ExternCContext; }
235 static DeclContext *castToDeclContext(const ExternCContextDecl *D) {
236 return static_cast<DeclContext *>(const_cast<ExternCContextDecl*>(D));
238 static ExternCContextDecl *castFromDeclContext(const DeclContext *DC) {
239 return static_cast<ExternCContextDecl *>(const_cast<DeclContext*>(DC));
243 /// This represents a decl that may have a name. Many decls have names such
244 /// as ObjCMethodDecl, but not \@class, etc.
246 /// Note that not every NamedDecl is actually named (e.g., a struct might
247 /// be anonymous), and not every name is an identifier.
248 class NamedDecl : public Decl {
249 /// The name of this declaration, which is typically a normal
250 /// identifier but may also be a special kind of name (C++
251 /// constructor, Objective-C selector, etc.)
252 DeclarationName Name;
254 virtual void anchor();
257 NamedDecl *getUnderlyingDeclImpl() LLVM_READONLY;
260 NamedDecl(Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
261 : Decl(DK, DC, L), Name(N) {}
264 /// Get the identifier that names this declaration, if there is one.
266 /// This will return NULL if this declaration has no name (e.g., for
267 /// an unnamed class) or if the name is a special name (C++ constructor,
268 /// Objective-C selector, etc.).
269 IdentifierInfo *getIdentifier() const { return Name.getAsIdentifierInfo(); }
271 /// Get the name of identifier for this declaration as a StringRef.
273 /// This requires that the declaration have a name and that it be a simple
275 StringRef getName() const {
276 assert(Name.isIdentifier() && "Name is not a simple identifier");
277 return getIdentifier() ? getIdentifier()->getName() : "";
280 /// Get a human-readable name for the declaration, even if it is one of the
281 /// special kinds of names (C++ constructor, Objective-C selector, etc).
283 /// Creating this name requires expensive string manipulation, so it should
284 /// be called only when performance doesn't matter. For simple declarations,
285 /// getNameAsCString() should suffice.
287 // FIXME: This function should be renamed to indicate that it is not just an
288 // alternate form of getName(), and clients should move as appropriate.
290 // FIXME: Deprecated, move clients to getName().
291 std::string getNameAsString() const { return Name.getAsString(); }
293 virtual void printName(raw_ostream &os) const;
295 /// Get the actual, stored name of the declaration, which may be a special
297 DeclarationName getDeclName() const { return Name; }
299 /// Set the name of this declaration.
300 void setDeclName(DeclarationName N) { Name = N; }
302 /// Returns a human-readable qualified name for this declaration, like
303 /// A::B::i, for i being member of namespace A::B.
305 /// If the declaration is not a member of context which can be named (record,
306 /// namespace), it will return the same result as printName().
308 /// Creating this name is expensive, so it should be called only when
309 /// performance doesn't matter.
310 void printQualifiedName(raw_ostream &OS) const;
311 void printQualifiedName(raw_ostream &OS, const PrintingPolicy &Policy) const;
313 // FIXME: Remove string version.
314 std::string getQualifiedNameAsString() const;
316 /// Appends a human-readable name for this declaration into the given stream.
318 /// This is the method invoked by Sema when displaying a NamedDecl
319 /// in a diagnostic. It does not necessarily produce the same
320 /// result as printName(); for example, class template
321 /// specializations are printed with their template arguments.
322 virtual void getNameForDiagnostic(raw_ostream &OS,
323 const PrintingPolicy &Policy,
324 bool Qualified) const;
326 /// Determine whether this declaration, if known to be well-formed within
327 /// its context, will replace the declaration OldD if introduced into scope.
329 /// A declaration will replace another declaration if, for example, it is
330 /// a redeclaration of the same variable or function, but not if it is a
331 /// declaration of a different kind (function vs. class) or an overloaded
334 /// \param IsKnownNewer \c true if this declaration is known to be newer
335 /// than \p OldD (for instance, if this declaration is newly-created).
336 bool declarationReplaces(NamedDecl *OldD, bool IsKnownNewer = true) const;
338 /// Determine whether this declaration has linkage.
339 bool hasLinkage() const;
341 using Decl::isModulePrivate;
342 using Decl::setModulePrivate;
344 /// Determine whether this declaration is a C++ class member.
345 bool isCXXClassMember() const {
346 const DeclContext *DC = getDeclContext();
348 // C++0x [class.mem]p1:
349 // The enumerators of an unscoped enumeration defined in
350 // the class are members of the class.
351 if (isa<EnumDecl>(DC))
352 DC = DC->getRedeclContext();
354 return DC->isRecord();
357 /// Determine whether the given declaration is an instance member of
359 bool isCXXInstanceMember() const;
361 /// Determine what kind of linkage this entity has.
363 /// This is not the linkage as defined by the standard or the codegen notion
364 /// of linkage. It is just an implementation detail that is used to compute
366 Linkage getLinkageInternal() const;
368 /// Get the linkage from a semantic point of view. Entities in
369 /// anonymous namespaces are external (in c++98).
370 Linkage getFormalLinkage() const {
371 return clang::getFormalLinkage(getLinkageInternal());
374 /// True if this decl has external linkage.
375 bool hasExternalFormalLinkage() const {
376 return isExternalFormalLinkage(getLinkageInternal());
379 bool isExternallyVisible() const {
380 return clang::isExternallyVisible(getLinkageInternal());
383 /// Determine whether this declaration can be redeclared in a
384 /// different translation unit.
385 bool isExternallyDeclarable() const {
386 return isExternallyVisible() && !getOwningModuleForLinkage();
389 /// Determines the visibility of this entity.
390 Visibility getVisibility() const {
391 return getLinkageAndVisibility().getVisibility();
394 /// Determines the linkage and visibility of this entity.
395 LinkageInfo getLinkageAndVisibility() const;
397 /// Kinds of explicit visibility.
398 enum ExplicitVisibilityKind {
399 /// Do an LV computation for, ultimately, a type.
400 /// Visibility may be restricted by type visibility settings and
401 /// the visibility of template arguments.
404 /// Do an LV computation for, ultimately, a non-type declaration.
405 /// Visibility may be restricted by value visibility settings and
406 /// the visibility of template arguments.
410 /// If visibility was explicitly specified for this
411 /// declaration, return that visibility.
413 getExplicitVisibility(ExplicitVisibilityKind kind) const;
415 /// True if the computed linkage is valid. Used for consistency
416 /// checking. Should always return true.
417 bool isLinkageValid() const;
419 /// True if something has required us to compute the linkage
420 /// of this declaration.
422 /// Language features which can retroactively change linkage (like a
423 /// typedef name for linkage purposes) may need to consider this,
424 /// but hopefully only in transitory ways during parsing.
425 bool hasLinkageBeenComputed() const {
426 return hasCachedLinkage();
429 /// Looks through UsingDecls and ObjCCompatibleAliasDecls for
430 /// the underlying named decl.
431 NamedDecl *getUnderlyingDecl() {
432 // Fast-path the common case.
433 if (this->getKind() != UsingShadow &&
434 this->getKind() != ConstructorUsingShadow &&
435 this->getKind() != ObjCCompatibleAlias &&
436 this->getKind() != NamespaceAlias)
439 return getUnderlyingDeclImpl();
441 const NamedDecl *getUnderlyingDecl() const {
442 return const_cast<NamedDecl*>(this)->getUnderlyingDecl();
445 NamedDecl *getMostRecentDecl() {
446 return cast<NamedDecl>(static_cast<Decl *>(this)->getMostRecentDecl());
448 const NamedDecl *getMostRecentDecl() const {
449 return const_cast<NamedDecl*>(this)->getMostRecentDecl();
452 ObjCStringFormatFamily getObjCFStringFormattingFamily() const;
454 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
455 static bool classofKind(Kind K) { return K >= firstNamed && K <= lastNamed; }
458 inline raw_ostream &operator<<(raw_ostream &OS, const NamedDecl &ND) {
463 /// Represents the declaration of a label. Labels also have a
464 /// corresponding LabelStmt, which indicates the position that the label was
465 /// defined at. For normal labels, the location of the decl is the same as the
466 /// location of the statement. For GNU local labels (__label__), the decl
467 /// location is where the __label__ is.
468 class LabelDecl : public NamedDecl {
471 bool MSAsmNameResolved = false;
473 /// For normal labels, this is the same as the main declaration
474 /// label, i.e., the location of the identifier; for GNU local labels,
475 /// this is the location of the __label__ keyword.
476 SourceLocation LocStart;
478 LabelDecl(DeclContext *DC, SourceLocation IdentL, IdentifierInfo *II,
479 LabelStmt *S, SourceLocation StartL)
480 : NamedDecl(Label, DC, IdentL, II), TheStmt(S), LocStart(StartL) {}
482 void anchor() override;
485 static LabelDecl *Create(ASTContext &C, DeclContext *DC,
486 SourceLocation IdentL, IdentifierInfo *II);
487 static LabelDecl *Create(ASTContext &C, DeclContext *DC,
488 SourceLocation IdentL, IdentifierInfo *II,
489 SourceLocation GnuLabelL);
490 static LabelDecl *CreateDeserialized(ASTContext &C, unsigned ID);
492 LabelStmt *getStmt() const { return TheStmt; }
493 void setStmt(LabelStmt *T) { TheStmt = T; }
495 bool isGnuLocal() const { return LocStart != getLocation(); }
496 void setLocStart(SourceLocation L) { LocStart = L; }
498 SourceRange getSourceRange() const override LLVM_READONLY {
499 return SourceRange(LocStart, getLocation());
502 bool isMSAsmLabel() const { return !MSAsmName.empty(); }
503 bool isResolvedMSAsmLabel() const { return isMSAsmLabel() && MSAsmNameResolved; }
504 void setMSAsmLabel(StringRef Name);
505 StringRef getMSAsmLabel() const { return MSAsmName; }
506 void setMSAsmLabelResolved() { MSAsmNameResolved = true; }
508 // Implement isa/cast/dyncast/etc.
509 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
510 static bool classofKind(Kind K) { return K == Label; }
513 /// Represent a C++ namespace.
514 class NamespaceDecl : public NamedDecl, public DeclContext,
515 public Redeclarable<NamespaceDecl>
517 /// The starting location of the source range, pointing
518 /// to either the namespace or the inline keyword.
519 SourceLocation LocStart;
521 /// The ending location of the source range.
522 SourceLocation RBraceLoc;
524 /// A pointer to either the anonymous namespace that lives just inside
525 /// this namespace or to the first namespace in the chain (the latter case
526 /// only when this is not the first in the chain), along with a
527 /// boolean value indicating whether this is an inline namespace.
528 llvm::PointerIntPair<NamespaceDecl *, 1, bool> AnonOrFirstNamespaceAndInline;
530 NamespaceDecl(ASTContext &C, DeclContext *DC, bool Inline,
531 SourceLocation StartLoc, SourceLocation IdLoc,
532 IdentifierInfo *Id, NamespaceDecl *PrevDecl);
534 using redeclarable_base = Redeclarable<NamespaceDecl>;
536 NamespaceDecl *getNextRedeclarationImpl() override;
537 NamespaceDecl *getPreviousDeclImpl() override;
538 NamespaceDecl *getMostRecentDeclImpl() override;
541 friend class ASTDeclReader;
542 friend class ASTDeclWriter;
544 static NamespaceDecl *Create(ASTContext &C, DeclContext *DC,
545 bool Inline, SourceLocation StartLoc,
546 SourceLocation IdLoc, IdentifierInfo *Id,
547 NamespaceDecl *PrevDecl);
549 static NamespaceDecl *CreateDeserialized(ASTContext &C, unsigned ID);
551 using redecl_range = redeclarable_base::redecl_range;
552 using redecl_iterator = redeclarable_base::redecl_iterator;
554 using redeclarable_base::redecls_begin;
555 using redeclarable_base::redecls_end;
556 using redeclarable_base::redecls;
557 using redeclarable_base::getPreviousDecl;
558 using redeclarable_base::getMostRecentDecl;
559 using redeclarable_base::isFirstDecl;
561 /// Returns true if this is an anonymous namespace declaration.
569 /// q.v. C++ [namespace.unnamed]
570 bool isAnonymousNamespace() const {
571 return !getIdentifier();
574 /// Returns true if this is an inline namespace declaration.
575 bool isInline() const {
576 return AnonOrFirstNamespaceAndInline.getInt();
579 /// Set whether this is an inline namespace declaration.
580 void setInline(bool Inline) {
581 AnonOrFirstNamespaceAndInline.setInt(Inline);
584 /// Get the original (first) namespace declaration.
585 NamespaceDecl *getOriginalNamespace();
587 /// Get the original (first) namespace declaration.
588 const NamespaceDecl *getOriginalNamespace() const;
590 /// Return true if this declaration is an original (first) declaration
591 /// of the namespace. This is false for non-original (subsequent) namespace
592 /// declarations and anonymous namespaces.
593 bool isOriginalNamespace() const;
595 /// Retrieve the anonymous namespace nested inside this namespace,
597 NamespaceDecl *getAnonymousNamespace() const {
598 return getOriginalNamespace()->AnonOrFirstNamespaceAndInline.getPointer();
601 void setAnonymousNamespace(NamespaceDecl *D) {
602 getOriginalNamespace()->AnonOrFirstNamespaceAndInline.setPointer(D);
605 /// Retrieves the canonical declaration of this namespace.
606 NamespaceDecl *getCanonicalDecl() override {
607 return getOriginalNamespace();
609 const NamespaceDecl *getCanonicalDecl() const {
610 return getOriginalNamespace();
613 SourceRange getSourceRange() const override LLVM_READONLY {
614 return SourceRange(LocStart, RBraceLoc);
617 SourceLocation getBeginLoc() const LLVM_READONLY { return LocStart; }
618 SourceLocation getRBraceLoc() const { return RBraceLoc; }
619 void setLocStart(SourceLocation L) { LocStart = L; }
620 void setRBraceLoc(SourceLocation L) { RBraceLoc = L; }
622 // Implement isa/cast/dyncast/etc.
623 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
624 static bool classofKind(Kind K) { return K == Namespace; }
625 static DeclContext *castToDeclContext(const NamespaceDecl *D) {
626 return static_cast<DeclContext *>(const_cast<NamespaceDecl*>(D));
628 static NamespaceDecl *castFromDeclContext(const DeclContext *DC) {
629 return static_cast<NamespaceDecl *>(const_cast<DeclContext*>(DC));
633 /// Represent the declaration of a variable (in which case it is
634 /// an lvalue) a function (in which case it is a function designator) or
635 /// an enum constant.
636 class ValueDecl : public NamedDecl {
639 void anchor() override;
642 ValueDecl(Kind DK, DeclContext *DC, SourceLocation L,
643 DeclarationName N, QualType T)
644 : NamedDecl(DK, DC, L, N), DeclType(T) {}
647 QualType getType() const { return DeclType; }
648 void setType(QualType newType) { DeclType = newType; }
650 /// Determine whether this symbol is weakly-imported,
651 /// or declared with the weak or weak-ref attr.
654 // Implement isa/cast/dyncast/etc.
655 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
656 static bool classofKind(Kind K) { return K >= firstValue && K <= lastValue; }
659 /// A struct with extended info about a syntactic
660 /// name qualifier, to be used for the case of out-of-line declarations.
661 struct QualifierInfo {
662 NestedNameSpecifierLoc QualifierLoc;
664 /// The number of "outer" template parameter lists.
665 /// The count includes all of the template parameter lists that were matched
666 /// against the template-ids occurring into the NNS and possibly (in the
667 /// case of an explicit specialization) a final "template <>".
668 unsigned NumTemplParamLists = 0;
670 /// A new-allocated array of size NumTemplParamLists,
671 /// containing pointers to the "outer" template parameter lists.
672 /// It includes all of the template parameter lists that were matched
673 /// against the template-ids occurring into the NNS and possibly (in the
674 /// case of an explicit specialization) a final "template <>".
675 TemplateParameterList** TemplParamLists = nullptr;
677 QualifierInfo() = default;
678 QualifierInfo(const QualifierInfo &) = delete;
679 QualifierInfo& operator=(const QualifierInfo &) = delete;
681 /// Sets info about "outer" template parameter lists.
682 void setTemplateParameterListsInfo(ASTContext &Context,
683 ArrayRef<TemplateParameterList *> TPLists);
686 /// Represents a ValueDecl that came out of a declarator.
687 /// Contains type source information through TypeSourceInfo.
688 class DeclaratorDecl : public ValueDecl {
689 // A struct representing both a TInfo and a syntactic qualifier,
690 // to be used for the (uncommon) case of out-of-line declarations.
691 struct ExtInfo : public QualifierInfo {
692 TypeSourceInfo *TInfo;
695 llvm::PointerUnion<TypeSourceInfo *, ExtInfo *> DeclInfo;
697 /// The start of the source range for this declaration,
698 /// ignoring outer template declarations.
699 SourceLocation InnerLocStart;
701 bool hasExtInfo() const { return DeclInfo.is<ExtInfo*>(); }
702 ExtInfo *getExtInfo() { return DeclInfo.get<ExtInfo*>(); }
703 const ExtInfo *getExtInfo() const { return DeclInfo.get<ExtInfo*>(); }
706 DeclaratorDecl(Kind DK, DeclContext *DC, SourceLocation L,
707 DeclarationName N, QualType T, TypeSourceInfo *TInfo,
708 SourceLocation StartL)
709 : ValueDecl(DK, DC, L, N, T), DeclInfo(TInfo), InnerLocStart(StartL) {}
712 friend class ASTDeclReader;
713 friend class ASTDeclWriter;
715 TypeSourceInfo *getTypeSourceInfo() const {
717 ? getExtInfo()->TInfo
718 : DeclInfo.get<TypeSourceInfo*>();
721 void setTypeSourceInfo(TypeSourceInfo *TI) {
723 getExtInfo()->TInfo = TI;
728 /// Return start of source range ignoring outer template declarations.
729 SourceLocation getInnerLocStart() const { return InnerLocStart; }
730 void setInnerLocStart(SourceLocation L) { InnerLocStart = L; }
732 /// Return start of source range taking into account any outer template
734 SourceLocation getOuterLocStart() const;
736 SourceRange getSourceRange() const override LLVM_READONLY;
738 SourceLocation getBeginLoc() const LLVM_READONLY {
739 return getOuterLocStart();
742 /// Retrieve the nested-name-specifier that qualifies the name of this
743 /// declaration, if it was present in the source.
744 NestedNameSpecifier *getQualifier() const {
745 return hasExtInfo() ? getExtInfo()->QualifierLoc.getNestedNameSpecifier()
749 /// Retrieve the nested-name-specifier (with source-location
750 /// information) that qualifies the name of this declaration, if it was
751 /// present in the source.
752 NestedNameSpecifierLoc getQualifierLoc() const {
753 return hasExtInfo() ? getExtInfo()->QualifierLoc
754 : NestedNameSpecifierLoc();
757 void setQualifierInfo(NestedNameSpecifierLoc QualifierLoc);
759 unsigned getNumTemplateParameterLists() const {
760 return hasExtInfo() ? getExtInfo()->NumTemplParamLists : 0;
763 TemplateParameterList *getTemplateParameterList(unsigned index) const {
764 assert(index < getNumTemplateParameterLists());
765 return getExtInfo()->TemplParamLists[index];
768 void setTemplateParameterListsInfo(ASTContext &Context,
769 ArrayRef<TemplateParameterList *> TPLists);
771 SourceLocation getTypeSpecStartLoc() const;
773 // Implement isa/cast/dyncast/etc.
774 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
775 static bool classofKind(Kind K) {
776 return K >= firstDeclarator && K <= lastDeclarator;
780 /// Structure used to store a statement, the constant value to
781 /// which it was evaluated (if any), and whether or not the statement
782 /// is an integral constant expression (if known).
783 struct EvaluatedStmt {
784 /// Whether this statement was already evaluated.
785 bool WasEvaluated : 1;
787 /// Whether this statement is being evaluated.
788 bool IsEvaluating : 1;
790 /// Whether we already checked whether this statement was an
791 /// integral constant expression.
794 /// Whether we are checking whether this statement is an
795 /// integral constant expression.
796 bool CheckingICE : 1;
798 /// Whether this statement is an integral constant expression,
799 /// or in C++11, whether the statement is a constant expression. Only
800 /// valid if CheckedICE is true.
806 EvaluatedStmt() : WasEvaluated(false), IsEvaluating(false), CheckedICE(false),
807 CheckingICE(false), IsICE(false) {}
811 /// Represents a variable declaration or definition.
812 class VarDecl : public DeclaratorDecl, public Redeclarable<VarDecl> {
814 /// Initialization styles.
815 enum InitializationStyle {
816 /// C-style initialization with assignment
819 /// Call-style initialization (C++98)
822 /// Direct list-initialization (C++11)
826 /// Kinds of thread-local storage.
828 /// Not a TLS variable.
831 /// TLS with a known-constant initializer.
834 /// TLS with a dynamic initializer.
838 /// Return the string used to specify the storage class \p SC.
840 /// It is illegal to call this function with SC == None.
841 static const char *getStorageClassSpecifierString(StorageClass SC);
844 // A pointer union of Stmt * and EvaluatedStmt *. When an EvaluatedStmt, we
845 // have allocated the auxiliary struct of information there.
847 // TODO: It is a bit unfortunate to use a PointerUnion inside the VarDecl for
848 // this as *many* VarDecls are ParmVarDecls that don't have default
849 // arguments. We could save some space by moving this pointer union to be
850 // allocated in trailing space when necessary.
851 using InitType = llvm::PointerUnion<Stmt *, EvaluatedStmt *>;
853 /// The initializer for this variable or, for a ParmVarDecl, the
854 /// C++ default argument.
855 mutable InitType Init;
858 friend class ASTDeclReader;
859 friend class ASTNodeImporter;
860 friend class StmtIteratorBase;
862 class VarDeclBitfields {
863 friend class ASTDeclReader;
864 friend class VarDecl;
867 unsigned TSCSpec : 2;
868 unsigned InitStyle : 2;
870 /// Whether this variable is an ARC pseudo-__strong variable; see
871 /// isARCPseudoStrong() for details.
872 unsigned ARCPseudoStrong : 1;
874 enum { NumVarDeclBits = 8 };
877 enum { NumParameterIndexBits = 8 };
879 enum DefaultArgKind {
886 class ParmVarDeclBitfields {
887 friend class ASTDeclReader;
888 friend class ParmVarDecl;
890 unsigned : NumVarDeclBits;
892 /// Whether this parameter inherits a default argument from a
893 /// prior declaration.
894 unsigned HasInheritedDefaultArg : 1;
896 /// Describes the kind of default argument for this parameter. By default
897 /// this is none. If this is normal, then the default argument is stored in
898 /// the \c VarDecl initializer expression unless we were unable to parse
899 /// (even an invalid) expression for the default argument.
900 unsigned DefaultArgKind : 2;
902 /// Whether this parameter undergoes K&R argument promotion.
903 unsigned IsKNRPromoted : 1;
905 /// Whether this parameter is an ObjC method parameter or not.
906 unsigned IsObjCMethodParam : 1;
908 /// If IsObjCMethodParam, a Decl::ObjCDeclQualifier.
909 /// Otherwise, the number of function parameter scopes enclosing
910 /// the function parameter scope in which this parameter was
912 unsigned ScopeDepthOrObjCQuals : 7;
914 /// The number of parameters preceding this parameter in the
915 /// function parameter scope in which it was declared.
916 unsigned ParameterIndex : NumParameterIndexBits;
919 class NonParmVarDeclBitfields {
920 friend class ASTDeclReader;
921 friend class ImplicitParamDecl;
922 friend class VarDecl;
924 unsigned : NumVarDeclBits;
926 // FIXME: We need something similar to CXXRecordDecl::DefinitionData.
927 /// Whether this variable is a definition which was demoted due to
929 unsigned IsThisDeclarationADemotedDefinition : 1;
931 /// Whether this variable is the exception variable in a C++ catch
932 /// or an Objective-C @catch statement.
933 unsigned ExceptionVar : 1;
935 /// Whether this local variable could be allocated in the return
936 /// slot of its function, enabling the named return value optimization
938 unsigned NRVOVariable : 1;
940 /// Whether this variable is the for-range-declaration in a C++0x
941 /// for-range statement.
942 unsigned CXXForRangeDecl : 1;
944 /// Whether this variable is the for-in loop declaration in Objective-C.
945 unsigned ObjCForDecl : 1;
947 /// Whether this variable is (C++1z) inline.
948 unsigned IsInline : 1;
950 /// Whether this variable has (C++1z) inline explicitly specified.
951 unsigned IsInlineSpecified : 1;
953 /// Whether this variable is (C++0x) constexpr.
954 unsigned IsConstexpr : 1;
956 /// Whether this variable is the implicit variable for a lambda
958 unsigned IsInitCapture : 1;
960 /// Whether this local extern variable's previous declaration was
961 /// declared in the same block scope. This controls whether we should merge
962 /// the type of this declaration with its previous declaration.
963 unsigned PreviousDeclInSameBlockScope : 1;
965 /// Defines kind of the ImplicitParamDecl: 'this', 'self', 'vtt', '_cmd' or
967 unsigned ImplicitParamKind : 3;
969 unsigned EscapingByref : 1;
974 VarDeclBitfields VarDeclBits;
975 ParmVarDeclBitfields ParmVarDeclBits;
976 NonParmVarDeclBitfields NonParmVarDeclBits;
979 VarDecl(Kind DK, ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
980 SourceLocation IdLoc, IdentifierInfo *Id, QualType T,
981 TypeSourceInfo *TInfo, StorageClass SC);
983 using redeclarable_base = Redeclarable<VarDecl>;
985 VarDecl *getNextRedeclarationImpl() override {
986 return getNextRedeclaration();
989 VarDecl *getPreviousDeclImpl() override {
990 return getPreviousDecl();
993 VarDecl *getMostRecentDeclImpl() override {
994 return getMostRecentDecl();
998 using redecl_range = redeclarable_base::redecl_range;
999 using redecl_iterator = redeclarable_base::redecl_iterator;
1001 using redeclarable_base::redecls_begin;
1002 using redeclarable_base::redecls_end;
1003 using redeclarable_base::redecls;
1004 using redeclarable_base::getPreviousDecl;
1005 using redeclarable_base::getMostRecentDecl;
1006 using redeclarable_base::isFirstDecl;
1008 static VarDecl *Create(ASTContext &C, DeclContext *DC,
1009 SourceLocation StartLoc, SourceLocation IdLoc,
1010 IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo,
1013 static VarDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1015 SourceRange getSourceRange() const override LLVM_READONLY;
1017 /// Returns the storage class as written in the source. For the
1018 /// computed linkage of symbol, see getLinkage.
1019 StorageClass getStorageClass() const {
1020 return (StorageClass) VarDeclBits.SClass;
1022 void setStorageClass(StorageClass SC);
1024 void setTSCSpec(ThreadStorageClassSpecifier TSC) {
1025 VarDeclBits.TSCSpec = TSC;
1026 assert(VarDeclBits.TSCSpec == TSC && "truncation");
1028 ThreadStorageClassSpecifier getTSCSpec() const {
1029 return static_cast<ThreadStorageClassSpecifier>(VarDeclBits.TSCSpec);
1031 TLSKind getTLSKind() const;
1033 /// Returns true if a variable with function scope is a non-static local
1035 bool hasLocalStorage() const {
1036 if (getStorageClass() == SC_None) {
1037 // OpenCL v1.2 s6.5.3: The __constant or constant address space name is
1038 // used to describe variables allocated in global memory and which are
1039 // accessed inside a kernel(s) as read-only variables. As such, variables
1040 // in constant address space cannot have local storage.
1041 if (getType().getAddressSpace() == LangAS::opencl_constant)
1043 // Second check is for C++11 [dcl.stc]p4.
1044 return !isFileVarDecl() && getTSCSpec() == TSCS_unspecified;
1047 // Global Named Register (GNU extension)
1048 if (getStorageClass() == SC_Register && !isLocalVarDeclOrParm())
1051 // Return true for: Auto, Register.
1052 // Return false for: Extern, Static, PrivateExtern, OpenCLWorkGroupLocal.
1054 return getStorageClass() >= SC_Auto;
1057 /// Returns true if a variable with function scope is a static local
1059 bool isStaticLocal() const {
1060 return (getStorageClass() == SC_Static ||
1061 // C++11 [dcl.stc]p4
1062 (getStorageClass() == SC_None && getTSCSpec() == TSCS_thread_local))
1063 && !isFileVarDecl();
1066 /// Returns true if a variable has extern or __private_extern__
1068 bool hasExternalStorage() const {
1069 return getStorageClass() == SC_Extern ||
1070 getStorageClass() == SC_PrivateExtern;
1073 /// Returns true for all variables that do not have local storage.
1075 /// This includes all global variables as well as static variables declared
1076 /// within a function.
1077 bool hasGlobalStorage() const { return !hasLocalStorage(); }
1079 /// Get the storage duration of this variable, per C++ [basic.stc].
1080 StorageDuration getStorageDuration() const {
1081 return hasLocalStorage() ? SD_Automatic :
1082 getTSCSpec() ? SD_Thread : SD_Static;
1085 /// Compute the language linkage.
1086 LanguageLinkage getLanguageLinkage() const;
1088 /// Determines whether this variable is a variable with external, C linkage.
1089 bool isExternC() const;
1091 /// Determines whether this variable's context is, or is nested within,
1092 /// a C++ extern "C" linkage spec.
1093 bool isInExternCContext() const;
1095 /// Determines whether this variable's context is, or is nested within,
1096 /// a C++ extern "C++" linkage spec.
1097 bool isInExternCXXContext() const;
1099 /// Returns true for local variable declarations other than parameters.
1100 /// Note that this includes static variables inside of functions. It also
1101 /// includes variables inside blocks.
1103 /// void foo() { int x; static int y; extern int z; }
1104 bool isLocalVarDecl() const {
1105 if (getKind() != Decl::Var && getKind() != Decl::Decomposition)
1107 if (const DeclContext *DC = getLexicalDeclContext())
1108 return DC->getRedeclContext()->isFunctionOrMethod();
1112 /// Similar to isLocalVarDecl but also includes parameters.
1113 bool isLocalVarDeclOrParm() const {
1114 return isLocalVarDecl() || getKind() == Decl::ParmVar;
1117 /// Similar to isLocalVarDecl, but excludes variables declared in blocks.
1118 bool isFunctionOrMethodVarDecl() const {
1119 if (getKind() != Decl::Var && getKind() != Decl::Decomposition)
1121 const DeclContext *DC = getLexicalDeclContext()->getRedeclContext();
1122 return DC->isFunctionOrMethod() && DC->getDeclKind() != Decl::Block;
1125 /// Determines whether this is a static data member.
1127 /// This will only be true in C++, and applies to, e.g., the
1128 /// variable 'x' in:
1134 bool isStaticDataMember() const {
1135 // If it wasn't static, it would be a FieldDecl.
1136 return getKind() != Decl::ParmVar && getDeclContext()->isRecord();
1139 VarDecl *getCanonicalDecl() override;
1140 const VarDecl *getCanonicalDecl() const {
1141 return const_cast<VarDecl*>(this)->getCanonicalDecl();
1144 enum DefinitionKind {
1145 /// This declaration is only a declaration.
1148 /// This declaration is a tentative definition.
1149 TentativeDefinition,
1151 /// This declaration is definitely a definition.
1155 /// Check whether this declaration is a definition. If this could be
1156 /// a tentative definition (in C), don't check whether there's an overriding
1158 DefinitionKind isThisDeclarationADefinition(ASTContext &) const;
1159 DefinitionKind isThisDeclarationADefinition() const {
1160 return isThisDeclarationADefinition(getASTContext());
1163 /// Check whether this variable is defined in this translation unit.
1164 DefinitionKind hasDefinition(ASTContext &) const;
1165 DefinitionKind hasDefinition() const {
1166 return hasDefinition(getASTContext());
1169 /// Get the tentative definition that acts as the real definition in a TU.
1170 /// Returns null if there is a proper definition available.
1171 VarDecl *getActingDefinition();
1172 const VarDecl *getActingDefinition() const {
1173 return const_cast<VarDecl*>(this)->getActingDefinition();
1176 /// Get the real (not just tentative) definition for this declaration.
1177 VarDecl *getDefinition(ASTContext &);
1178 const VarDecl *getDefinition(ASTContext &C) const {
1179 return const_cast<VarDecl*>(this)->getDefinition(C);
1181 VarDecl *getDefinition() {
1182 return getDefinition(getASTContext());
1184 const VarDecl *getDefinition() const {
1185 return const_cast<VarDecl*>(this)->getDefinition();
1188 /// Determine whether this is or was instantiated from an out-of-line
1189 /// definition of a static data member.
1190 bool isOutOfLine() const override;
1192 /// Returns true for file scoped variable declaration.
1193 bool isFileVarDecl() const {
1195 if (K == ParmVar || K == ImplicitParam)
1198 if (getLexicalDeclContext()->getRedeclContext()->isFileContext())
1201 if (isStaticDataMember())
1207 /// Get the initializer for this variable, no matter which
1208 /// declaration it is attached to.
1209 const Expr *getAnyInitializer() const {
1211 return getAnyInitializer(D);
1214 /// Get the initializer for this variable, no matter which
1215 /// declaration it is attached to. Also get that declaration.
1216 const Expr *getAnyInitializer(const VarDecl *&D) const;
1218 bool hasInit() const;
1219 const Expr *getInit() const {
1220 return const_cast<VarDecl *>(this)->getInit();
1224 /// Retrieve the address of the initializer expression.
1225 Stmt **getInitAddress();
1227 void setInit(Expr *I);
1229 /// Determine whether this variable's value might be usable in a
1230 /// constant expression, according to the relevant language standard.
1231 /// This only checks properties of the declaration, and does not check
1232 /// whether the initializer is in fact a constant expression.
1233 bool mightBeUsableInConstantExpressions(ASTContext &C) const;
1235 /// Determine whether this variable's value can be used in a
1236 /// constant expression, according to the relevant language standard,
1237 /// including checking whether it was initialized by a constant expression.
1238 bool isUsableInConstantExpressions(ASTContext &C) const;
1240 EvaluatedStmt *ensureEvaluatedStmt() const;
1242 /// Attempt to evaluate the value of the initializer attached to this
1243 /// declaration, and produce notes explaining why it cannot be evaluated or is
1244 /// not a constant expression. Returns a pointer to the value if evaluation
1245 /// succeeded, 0 otherwise.
1246 APValue *evaluateValue() const;
1247 APValue *evaluateValue(SmallVectorImpl<PartialDiagnosticAt> &Notes) const;
1249 /// Return the already-evaluated value of this variable's
1250 /// initializer, or NULL if the value is not yet known. Returns pointer
1251 /// to untyped APValue if the value could not be evaluated.
1252 APValue *getEvaluatedValue() const;
1254 /// Determines whether it is already known whether the
1255 /// initializer is an integral constant expression or not.
1256 bool isInitKnownICE() const;
1258 /// Determines whether the initializer is an integral constant
1259 /// expression, or in C++11, whether the initializer is a constant
1262 /// \pre isInitKnownICE()
1263 bool isInitICE() const;
1265 /// Determine whether the value of the initializer attached to this
1266 /// declaration is an integral constant expression.
1267 bool checkInitIsICE() const;
1269 void setInitStyle(InitializationStyle Style) {
1270 VarDeclBits.InitStyle = Style;
1273 /// The style of initialization for this declaration.
1275 /// C-style initialization is "int x = 1;". Call-style initialization is
1276 /// a C++98 direct-initializer, e.g. "int x(1);". The Init expression will be
1277 /// the expression inside the parens or a "ClassType(a,b,c)" class constructor
1278 /// expression for class types. List-style initialization is C++11 syntax,
1279 /// e.g. "int x{1};". Clients can distinguish between different forms of
1280 /// initialization by checking this value. In particular, "int x = {1};" is
1281 /// C-style, "int x({1})" is call-style, and "int x{1};" is list-style; the
1282 /// Init expression in all three cases is an InitListExpr.
1283 InitializationStyle getInitStyle() const {
1284 return static_cast<InitializationStyle>(VarDeclBits.InitStyle);
1287 /// Whether the initializer is a direct-initializer (list or call).
1288 bool isDirectInit() const {
1289 return getInitStyle() != CInit;
1292 /// If this definition should pretend to be a declaration.
1293 bool isThisDeclarationADemotedDefinition() const {
1294 return isa<ParmVarDecl>(this) ? false :
1295 NonParmVarDeclBits.IsThisDeclarationADemotedDefinition;
1298 /// This is a definition which should be demoted to a declaration.
1300 /// In some cases (mostly module merging) we can end up with two visible
1301 /// definitions one of which needs to be demoted to a declaration to keep
1302 /// the AST invariants.
1303 void demoteThisDefinitionToDeclaration() {
1304 assert(isThisDeclarationADefinition() && "Not a definition!");
1305 assert(!isa<ParmVarDecl>(this) && "Cannot demote ParmVarDecls!");
1306 NonParmVarDeclBits.IsThisDeclarationADemotedDefinition = 1;
1309 /// Determine whether this variable is the exception variable in a
1310 /// C++ catch statememt or an Objective-C \@catch statement.
1311 bool isExceptionVariable() const {
1312 return isa<ParmVarDecl>(this) ? false : NonParmVarDeclBits.ExceptionVar;
1314 void setExceptionVariable(bool EV) {
1315 assert(!isa<ParmVarDecl>(this));
1316 NonParmVarDeclBits.ExceptionVar = EV;
1319 /// Determine whether this local variable can be used with the named
1320 /// return value optimization (NRVO).
1322 /// The named return value optimization (NRVO) works by marking certain
1323 /// non-volatile local variables of class type as NRVO objects. These
1324 /// locals can be allocated within the return slot of their containing
1325 /// function, in which case there is no need to copy the object to the
1326 /// return slot when returning from the function. Within the function body,
1327 /// each return that returns the NRVO object will have this variable as its
1329 bool isNRVOVariable() const {
1330 return isa<ParmVarDecl>(this) ? false : NonParmVarDeclBits.NRVOVariable;
1332 void setNRVOVariable(bool NRVO) {
1333 assert(!isa<ParmVarDecl>(this));
1334 NonParmVarDeclBits.NRVOVariable = NRVO;
1337 /// Determine whether this variable is the for-range-declaration in
1338 /// a C++0x for-range statement.
1339 bool isCXXForRangeDecl() const {
1340 return isa<ParmVarDecl>(this) ? false : NonParmVarDeclBits.CXXForRangeDecl;
1342 void setCXXForRangeDecl(bool FRD) {
1343 assert(!isa<ParmVarDecl>(this));
1344 NonParmVarDeclBits.CXXForRangeDecl = FRD;
1347 /// Determine whether this variable is a for-loop declaration for a
1348 /// for-in statement in Objective-C.
1349 bool isObjCForDecl() const {
1350 return NonParmVarDeclBits.ObjCForDecl;
1353 void setObjCForDecl(bool FRD) {
1354 NonParmVarDeclBits.ObjCForDecl = FRD;
1357 /// Determine whether this variable is an ARC pseudo-__strong variable. A
1358 /// pseudo-__strong variable has a __strong-qualified type but does not
1359 /// actually retain the object written into it. Generally such variables are
1360 /// also 'const' for safety. There are 3 cases where this will be set, 1) if
1361 /// the variable is annotated with the objc_externally_retained attribute, 2)
1362 /// if its 'self' in a non-init method, or 3) if its the variable in an for-in
1364 bool isARCPseudoStrong() const { return VarDeclBits.ARCPseudoStrong; }
1365 void setARCPseudoStrong(bool PS) { VarDeclBits.ARCPseudoStrong = PS; }
1367 /// Whether this variable is (C++1z) inline.
1368 bool isInline() const {
1369 return isa<ParmVarDecl>(this) ? false : NonParmVarDeclBits.IsInline;
1371 bool isInlineSpecified() const {
1372 return isa<ParmVarDecl>(this) ? false
1373 : NonParmVarDeclBits.IsInlineSpecified;
1375 void setInlineSpecified() {
1376 assert(!isa<ParmVarDecl>(this));
1377 NonParmVarDeclBits.IsInline = true;
1378 NonParmVarDeclBits.IsInlineSpecified = true;
1380 void setImplicitlyInline() {
1381 assert(!isa<ParmVarDecl>(this));
1382 NonParmVarDeclBits.IsInline = true;
1385 /// Whether this variable is (C++11) constexpr.
1386 bool isConstexpr() const {
1387 return isa<ParmVarDecl>(this) ? false : NonParmVarDeclBits.IsConstexpr;
1389 void setConstexpr(bool IC) {
1390 assert(!isa<ParmVarDecl>(this));
1391 NonParmVarDeclBits.IsConstexpr = IC;
1394 /// Whether this variable is the implicit variable for a lambda init-capture.
1395 bool isInitCapture() const {
1396 return isa<ParmVarDecl>(this) ? false : NonParmVarDeclBits.IsInitCapture;
1398 void setInitCapture(bool IC) {
1399 assert(!isa<ParmVarDecl>(this));
1400 NonParmVarDeclBits.IsInitCapture = IC;
1403 /// Determine whether this variable is actually a function parameter pack or
1404 /// init-capture pack.
1405 bool isParameterPack() const;
1407 /// Whether this local extern variable declaration's previous declaration
1408 /// was declared in the same block scope. Only correct in C++.
1409 bool isPreviousDeclInSameBlockScope() const {
1410 return isa<ParmVarDecl>(this)
1412 : NonParmVarDeclBits.PreviousDeclInSameBlockScope;
1414 void setPreviousDeclInSameBlockScope(bool Same) {
1415 assert(!isa<ParmVarDecl>(this));
1416 NonParmVarDeclBits.PreviousDeclInSameBlockScope = Same;
1419 /// Indicates the capture is a __block variable that is captured by a block
1420 /// that can potentially escape (a block for which BlockDecl::doesNotEscape
1422 bool isEscapingByref() const;
1424 /// Indicates the capture is a __block variable that is never captured by an
1426 bool isNonEscapingByref() const;
1428 void setEscapingByref() {
1429 NonParmVarDeclBits.EscapingByref = true;
1432 /// Retrieve the variable declaration from which this variable could
1433 /// be instantiated, if it is an instantiation (rather than a non-template).
1434 VarDecl *getTemplateInstantiationPattern() const;
1436 /// If this variable is an instantiated static data member of a
1437 /// class template specialization, returns the templated static data member
1438 /// from which it was instantiated.
1439 VarDecl *getInstantiatedFromStaticDataMember() const;
1441 /// If this variable is an instantiation of a variable template or a
1442 /// static data member of a class template, determine what kind of
1443 /// template specialization or instantiation this is.
1444 TemplateSpecializationKind getTemplateSpecializationKind() const;
1446 /// Get the template specialization kind of this variable for the purposes of
1447 /// template instantiation. This differs from getTemplateSpecializationKind()
1448 /// for an instantiation of a class-scope explicit specialization.
1449 TemplateSpecializationKind
1450 getTemplateSpecializationKindForInstantiation() const;
1452 /// If this variable is an instantiation of a variable template or a
1453 /// static data member of a class template, determine its point of
1455 SourceLocation getPointOfInstantiation() const;
1457 /// If this variable is an instantiation of a static data member of a
1458 /// class template specialization, retrieves the member specialization
1460 MemberSpecializationInfo *getMemberSpecializationInfo() const;
1462 /// For a static data member that was instantiated from a static
1463 /// data member of a class template, set the template specialiation kind.
1464 void setTemplateSpecializationKind(TemplateSpecializationKind TSK,
1465 SourceLocation PointOfInstantiation = SourceLocation());
1467 /// Specify that this variable is an instantiation of the
1468 /// static data member VD.
1469 void setInstantiationOfStaticDataMember(VarDecl *VD,
1470 TemplateSpecializationKind TSK);
1472 /// Retrieves the variable template that is described by this
1473 /// variable declaration.
1475 /// Every variable template is represented as a VarTemplateDecl and a
1476 /// VarDecl. The former contains template properties (such as
1477 /// the template parameter lists) while the latter contains the
1478 /// actual description of the template's
1479 /// contents. VarTemplateDecl::getTemplatedDecl() retrieves the
1480 /// VarDecl that from a VarTemplateDecl, while
1481 /// getDescribedVarTemplate() retrieves the VarTemplateDecl from
1483 VarTemplateDecl *getDescribedVarTemplate() const;
1485 void setDescribedVarTemplate(VarTemplateDecl *Template);
1487 // Is this variable known to have a definition somewhere in the complete
1488 // program? This may be true even if the declaration has internal linkage and
1489 // has no definition within this source file.
1490 bool isKnownToBeDefined() const;
1492 /// Do we need to emit an exit-time destructor for this variable?
1493 bool isNoDestroy(const ASTContext &) const;
1495 // Implement isa/cast/dyncast/etc.
1496 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1497 static bool classofKind(Kind K) { return K >= firstVar && K <= lastVar; }
1500 class ImplicitParamDecl : public VarDecl {
1501 void anchor() override;
1504 /// Defines the kind of the implicit parameter: is this an implicit parameter
1505 /// with pointer to 'this', 'self', '_cmd', virtual table pointers, captured
1506 /// context or something else.
1507 enum ImplicitParamKind : unsigned {
1508 /// Parameter for Objective-C 'self' argument
1511 /// Parameter for Objective-C '_cmd' argument
1514 /// Parameter for C++ 'this' argument
1517 /// Parameter for C++ virtual table pointers
1520 /// Parameter for captured context
1523 /// Other implicit parameter
1527 /// Create implicit parameter.
1528 static ImplicitParamDecl *Create(ASTContext &C, DeclContext *DC,
1529 SourceLocation IdLoc, IdentifierInfo *Id,
1530 QualType T, ImplicitParamKind ParamKind);
1531 static ImplicitParamDecl *Create(ASTContext &C, QualType T,
1532 ImplicitParamKind ParamKind);
1534 static ImplicitParamDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1536 ImplicitParamDecl(ASTContext &C, DeclContext *DC, SourceLocation IdLoc,
1537 IdentifierInfo *Id, QualType Type,
1538 ImplicitParamKind ParamKind)
1539 : VarDecl(ImplicitParam, C, DC, IdLoc, IdLoc, Id, Type,
1540 /*TInfo=*/nullptr, SC_None) {
1541 NonParmVarDeclBits.ImplicitParamKind = ParamKind;
1545 ImplicitParamDecl(ASTContext &C, QualType Type, ImplicitParamKind ParamKind)
1546 : VarDecl(ImplicitParam, C, /*DC=*/nullptr, SourceLocation(),
1547 SourceLocation(), /*Id=*/nullptr, Type,
1548 /*TInfo=*/nullptr, SC_None) {
1549 NonParmVarDeclBits.ImplicitParamKind = ParamKind;
1553 /// Returns the implicit parameter kind.
1554 ImplicitParamKind getParameterKind() const {
1555 return static_cast<ImplicitParamKind>(NonParmVarDeclBits.ImplicitParamKind);
1558 // Implement isa/cast/dyncast/etc.
1559 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1560 static bool classofKind(Kind K) { return K == ImplicitParam; }
1563 /// Represents a parameter to a function.
1564 class ParmVarDecl : public VarDecl {
1566 enum { MaxFunctionScopeDepth = 255 };
1567 enum { MaxFunctionScopeIndex = 255 };
1570 ParmVarDecl(Kind DK, ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
1571 SourceLocation IdLoc, IdentifierInfo *Id, QualType T,
1572 TypeSourceInfo *TInfo, StorageClass S, Expr *DefArg)
1573 : VarDecl(DK, C, DC, StartLoc, IdLoc, Id, T, TInfo, S) {
1574 assert(ParmVarDeclBits.HasInheritedDefaultArg == false);
1575 assert(ParmVarDeclBits.DefaultArgKind == DAK_None);
1576 assert(ParmVarDeclBits.IsKNRPromoted == false);
1577 assert(ParmVarDeclBits.IsObjCMethodParam == false);
1578 setDefaultArg(DefArg);
1582 static ParmVarDecl *Create(ASTContext &C, DeclContext *DC,
1583 SourceLocation StartLoc,
1584 SourceLocation IdLoc, IdentifierInfo *Id,
1585 QualType T, TypeSourceInfo *TInfo,
1586 StorageClass S, Expr *DefArg);
1588 static ParmVarDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1590 SourceRange getSourceRange() const override LLVM_READONLY;
1592 void setObjCMethodScopeInfo(unsigned parameterIndex) {
1593 ParmVarDeclBits.IsObjCMethodParam = true;
1594 setParameterIndex(parameterIndex);
1597 void setScopeInfo(unsigned scopeDepth, unsigned parameterIndex) {
1598 assert(!ParmVarDeclBits.IsObjCMethodParam);
1600 ParmVarDeclBits.ScopeDepthOrObjCQuals = scopeDepth;
1601 assert(ParmVarDeclBits.ScopeDepthOrObjCQuals == scopeDepth
1604 setParameterIndex(parameterIndex);
1607 bool isObjCMethodParameter() const {
1608 return ParmVarDeclBits.IsObjCMethodParam;
1611 unsigned getFunctionScopeDepth() const {
1612 if (ParmVarDeclBits.IsObjCMethodParam) return 0;
1613 return ParmVarDeclBits.ScopeDepthOrObjCQuals;
1616 /// Returns the index of this parameter in its prototype or method scope.
1617 unsigned getFunctionScopeIndex() const {
1618 return getParameterIndex();
1621 ObjCDeclQualifier getObjCDeclQualifier() const {
1622 if (!ParmVarDeclBits.IsObjCMethodParam) return OBJC_TQ_None;
1623 return ObjCDeclQualifier(ParmVarDeclBits.ScopeDepthOrObjCQuals);
1625 void setObjCDeclQualifier(ObjCDeclQualifier QTVal) {
1626 assert(ParmVarDeclBits.IsObjCMethodParam);
1627 ParmVarDeclBits.ScopeDepthOrObjCQuals = QTVal;
1630 /// True if the value passed to this parameter must undergo
1631 /// K&R-style default argument promotion:
1634 /// If the expression that denotes the called function has a type
1635 /// that does not include a prototype, the integer promotions are
1636 /// performed on each argument, and arguments that have type float
1637 /// are promoted to double.
1638 bool isKNRPromoted() const {
1639 return ParmVarDeclBits.IsKNRPromoted;
1641 void setKNRPromoted(bool promoted) {
1642 ParmVarDeclBits.IsKNRPromoted = promoted;
1645 Expr *getDefaultArg();
1646 const Expr *getDefaultArg() const {
1647 return const_cast<ParmVarDecl *>(this)->getDefaultArg();
1650 void setDefaultArg(Expr *defarg);
1652 /// Retrieve the source range that covers the entire default
1654 SourceRange getDefaultArgRange() const;
1655 void setUninstantiatedDefaultArg(Expr *arg);
1656 Expr *getUninstantiatedDefaultArg();
1657 const Expr *getUninstantiatedDefaultArg() const {
1658 return const_cast<ParmVarDecl *>(this)->getUninstantiatedDefaultArg();
1661 /// Determines whether this parameter has a default argument,
1662 /// either parsed or not.
1663 bool hasDefaultArg() const;
1665 /// Determines whether this parameter has a default argument that has not
1666 /// yet been parsed. This will occur during the processing of a C++ class
1667 /// whose member functions have default arguments, e.g.,
1671 /// void f(int x = 17); // x has an unparsed default argument now
1672 /// }; // x has a regular default argument now
1674 bool hasUnparsedDefaultArg() const {
1675 return ParmVarDeclBits.DefaultArgKind == DAK_Unparsed;
1678 bool hasUninstantiatedDefaultArg() const {
1679 return ParmVarDeclBits.DefaultArgKind == DAK_Uninstantiated;
1682 /// Specify that this parameter has an unparsed default argument.
1683 /// The argument will be replaced with a real default argument via
1684 /// setDefaultArg when the class definition enclosing the function
1685 /// declaration that owns this default argument is completed.
1686 void setUnparsedDefaultArg() {
1687 ParmVarDeclBits.DefaultArgKind = DAK_Unparsed;
1690 bool hasInheritedDefaultArg() const {
1691 return ParmVarDeclBits.HasInheritedDefaultArg;
1694 void setHasInheritedDefaultArg(bool I = true) {
1695 ParmVarDeclBits.HasInheritedDefaultArg = I;
1698 QualType getOriginalType() const;
1700 /// Sets the function declaration that owns this
1701 /// ParmVarDecl. Since ParmVarDecls are often created before the
1702 /// FunctionDecls that own them, this routine is required to update
1703 /// the DeclContext appropriately.
1704 void setOwningFunction(DeclContext *FD) { setDeclContext(FD); }
1706 // Implement isa/cast/dyncast/etc.
1707 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1708 static bool classofKind(Kind K) { return K == ParmVar; }
1711 enum { ParameterIndexSentinel = (1 << NumParameterIndexBits) - 1 };
1713 void setParameterIndex(unsigned parameterIndex) {
1714 if (parameterIndex >= ParameterIndexSentinel) {
1715 setParameterIndexLarge(parameterIndex);
1719 ParmVarDeclBits.ParameterIndex = parameterIndex;
1720 assert(ParmVarDeclBits.ParameterIndex == parameterIndex && "truncation!");
1722 unsigned getParameterIndex() const {
1723 unsigned d = ParmVarDeclBits.ParameterIndex;
1724 return d == ParameterIndexSentinel ? getParameterIndexLarge() : d;
1727 void setParameterIndexLarge(unsigned parameterIndex);
1728 unsigned getParameterIndexLarge() const;
1731 enum class MultiVersionKind {
1738 /// Represents a function declaration or definition.
1740 /// Since a given function can be declared several times in a program,
1741 /// there may be several FunctionDecls that correspond to that
1742 /// function. Only one of those FunctionDecls will be found when
1743 /// traversing the list of declarations in the context of the
1744 /// FunctionDecl (e.g., the translation unit); this FunctionDecl
1745 /// contains all of the information known about the function. Other,
1746 /// previous declarations of the function are available via the
1747 /// getPreviousDecl() chain.
1748 class FunctionDecl : public DeclaratorDecl,
1750 public Redeclarable<FunctionDecl> {
1751 // This class stores some data in DeclContext::FunctionDeclBits
1752 // to save some space. Use the provided accessors to access it.
1754 /// The kind of templated function a FunctionDecl can be.
1755 enum TemplatedKind {
1758 // The pattern in a function template declaration.
1759 TK_FunctionTemplate,
1760 // A non-template function that is an instantiation or explicit
1761 // specialization of a member of a templated class.
1762 TK_MemberSpecialization,
1763 // An instantiation or explicit specialization of a function template.
1764 // Note: this might have been instantiated from a templated class if it
1765 // is a class-scope explicit specialization.
1766 TK_FunctionTemplateSpecialization,
1767 // A function template specialization that hasn't yet been resolved to a
1768 // particular specialized function template.
1769 TK_DependentFunctionTemplateSpecialization
1773 /// A new[]'d array of pointers to VarDecls for the formal
1774 /// parameters of this function. This is null if a prototype or if there are
1776 ParmVarDecl **ParamInfo = nullptr;
1778 LazyDeclStmtPtr Body;
1782 /// End part of this FunctionDecl's source range.
1784 /// We could compute the full range in getSourceRange(). However, when we're
1785 /// dealing with a function definition deserialized from a PCH/AST file,
1786 /// we can only compute the full range once the function body has been
1787 /// de-serialized, so it's far better to have the (sometimes-redundant)
1789 SourceLocation EndRangeLoc;
1791 /// The template or declaration that this declaration
1792 /// describes or was instantiated from, respectively.
1794 /// For non-templates, this value will be NULL. For function
1795 /// declarations that describe a function template, this will be a
1796 /// pointer to a FunctionTemplateDecl. For member functions
1797 /// of class template specializations, this will be a MemberSpecializationInfo
1798 /// pointer containing information about the specialization.
1799 /// For function template specializations, this will be a
1800 /// FunctionTemplateSpecializationInfo, which contains information about
1801 /// the template being specialized and the template arguments involved in
1802 /// that specialization.
1803 llvm::PointerUnion4<FunctionTemplateDecl *,
1804 MemberSpecializationInfo *,
1805 FunctionTemplateSpecializationInfo *,
1806 DependentFunctionTemplateSpecializationInfo *>
1807 TemplateOrSpecialization;
1809 /// Provides source/type location info for the declaration name embedded in
1810 /// the DeclaratorDecl base class.
1811 DeclarationNameLoc DNLoc;
1813 /// Specify that this function declaration is actually a function
1814 /// template specialization.
1816 /// \param C the ASTContext.
1818 /// \param Template the function template that this function template
1819 /// specialization specializes.
1821 /// \param TemplateArgs the template arguments that produced this
1822 /// function template specialization from the template.
1824 /// \param InsertPos If non-NULL, the position in the function template
1825 /// specialization set where the function template specialization data will
1828 /// \param TSK the kind of template specialization this is.
1830 /// \param TemplateArgsAsWritten location info of template arguments.
1832 /// \param PointOfInstantiation point at which the function template
1833 /// specialization was first instantiated.
1834 void setFunctionTemplateSpecialization(ASTContext &C,
1835 FunctionTemplateDecl *Template,
1836 const TemplateArgumentList *TemplateArgs,
1838 TemplateSpecializationKind TSK,
1839 const TemplateArgumentListInfo *TemplateArgsAsWritten,
1840 SourceLocation PointOfInstantiation);
1842 /// Specify that this record is an instantiation of the
1843 /// member function FD.
1844 void setInstantiationOfMemberFunction(ASTContext &C, FunctionDecl *FD,
1845 TemplateSpecializationKind TSK);
1847 void setParams(ASTContext &C, ArrayRef<ParmVarDecl *> NewParamInfo);
1849 // This is unfortunately needed because ASTDeclWriter::VisitFunctionDecl
1850 // need to access this bit but we want to avoid making ASTDeclWriter
1851 // a friend of FunctionDeclBitfields just for this.
1852 bool isDeletedBit() const { return FunctionDeclBits.IsDeleted; }
1854 /// Whether an ODRHash has been stored.
1855 bool hasODRHash() const { return FunctionDeclBits.HasODRHash; }
1857 /// State that an ODRHash has been stored.
1858 void setHasODRHash(bool B = true) { FunctionDeclBits.HasODRHash = B; }
1861 FunctionDecl(Kind DK, ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
1862 const DeclarationNameInfo &NameInfo, QualType T,
1863 TypeSourceInfo *TInfo, StorageClass S, bool isInlineSpecified,
1864 ConstexprSpecKind ConstexprKind);
1866 using redeclarable_base = Redeclarable<FunctionDecl>;
1868 FunctionDecl *getNextRedeclarationImpl() override {
1869 return getNextRedeclaration();
1872 FunctionDecl *getPreviousDeclImpl() override {
1873 return getPreviousDecl();
1876 FunctionDecl *getMostRecentDeclImpl() override {
1877 return getMostRecentDecl();
1881 friend class ASTDeclReader;
1882 friend class ASTDeclWriter;
1884 using redecl_range = redeclarable_base::redecl_range;
1885 using redecl_iterator = redeclarable_base::redecl_iterator;
1887 using redeclarable_base::redecls_begin;
1888 using redeclarable_base::redecls_end;
1889 using redeclarable_base::redecls;
1890 using redeclarable_base::getPreviousDecl;
1891 using redeclarable_base::getMostRecentDecl;
1892 using redeclarable_base::isFirstDecl;
1894 static FunctionDecl *
1895 Create(ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
1896 SourceLocation NLoc, DeclarationName N, QualType T,
1897 TypeSourceInfo *TInfo, StorageClass SC, bool isInlineSpecified = false,
1898 bool hasWrittenPrototype = true,
1899 ConstexprSpecKind ConstexprKind = CSK_unspecified) {
1900 DeclarationNameInfo NameInfo(N, NLoc);
1901 return FunctionDecl::Create(C, DC, StartLoc, NameInfo, T, TInfo, SC,
1902 isInlineSpecified, hasWrittenPrototype,
1906 static FunctionDecl *Create(ASTContext &C, DeclContext *DC,
1907 SourceLocation StartLoc,
1908 const DeclarationNameInfo &NameInfo, QualType T,
1909 TypeSourceInfo *TInfo, StorageClass SC,
1910 bool isInlineSpecified, bool hasWrittenPrototype,
1911 ConstexprSpecKind ConstexprKind);
1913 static FunctionDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1915 DeclarationNameInfo getNameInfo() const {
1916 return DeclarationNameInfo(getDeclName(), getLocation(), DNLoc);
1919 void getNameForDiagnostic(raw_ostream &OS, const PrintingPolicy &Policy,
1920 bool Qualified) const override;
1922 void setRangeEnd(SourceLocation E) { EndRangeLoc = E; }
1924 SourceRange getSourceRange() const override LLVM_READONLY;
1926 // Function definitions.
1928 // A function declaration may be:
1929 // - a non defining declaration,
1930 // - a definition. A function may be defined because:
1931 // - it has a body, or will have it in the case of late parsing.
1932 // - it has an uninstantiated body. The body does not exist because the
1933 // function is not used yet, but the declaration is considered a
1934 // definition and does not allow other definition of this function.
1935 // - it does not have a user specified body, but it does not allow
1936 // redefinition, because it is deleted/defaulted or is defined through
1937 // some other mechanism (alias, ifunc).
1939 /// Returns true if the function has a body.
1941 /// The function body might be in any of the (re-)declarations of this
1942 /// function. The variant that accepts a FunctionDecl pointer will set that
1943 /// function declaration to the actual declaration containing the body (if
1945 bool hasBody(const FunctionDecl *&Definition) const;
1947 bool hasBody() const override {
1948 const FunctionDecl* Definition;
1949 return hasBody(Definition);
1952 /// Returns whether the function has a trivial body that does not require any
1953 /// specific codegen.
1954 bool hasTrivialBody() const;
1956 /// Returns true if the function has a definition that does not need to be
1959 /// The variant that accepts a FunctionDecl pointer will set that function
1960 /// declaration to the declaration that is a definition (if there is one).
1961 bool isDefined(const FunctionDecl *&Definition) const;
1963 virtual bool isDefined() const {
1964 const FunctionDecl* Definition;
1965 return isDefined(Definition);
1968 /// Get the definition for this declaration.
1969 FunctionDecl *getDefinition() {
1970 const FunctionDecl *Definition;
1971 if (isDefined(Definition))
1972 return const_cast<FunctionDecl *>(Definition);
1975 const FunctionDecl *getDefinition() const {
1976 return const_cast<FunctionDecl *>(this)->getDefinition();
1979 /// Retrieve the body (definition) of the function. The function body might be
1980 /// in any of the (re-)declarations of this function. The variant that accepts
1981 /// a FunctionDecl pointer will set that function declaration to the actual
1982 /// declaration containing the body (if there is one).
1983 /// NOTE: For checking if there is a body, use hasBody() instead, to avoid
1984 /// unnecessary AST de-serialization of the body.
1985 Stmt *getBody(const FunctionDecl *&Definition) const;
1987 Stmt *getBody() const override {
1988 const FunctionDecl* Definition;
1989 return getBody(Definition);
1992 /// Returns whether this specific declaration of the function is also a
1993 /// definition that does not contain uninstantiated body.
1995 /// This does not determine whether the function has been defined (e.g., in a
1996 /// previous definition); for that information, use isDefined.
1997 bool isThisDeclarationADefinition() const {
1998 return isDeletedAsWritten() || isDefaulted() || Body || hasSkippedBody() ||
1999 isLateTemplateParsed() || willHaveBody() || hasDefiningAttr();
2002 /// Returns whether this specific declaration of the function has a body.
2003 bool doesThisDeclarationHaveABody() const {
2004 return Body || isLateTemplateParsed();
2007 void setBody(Stmt *B);
2008 void setLazyBody(uint64_t Offset) { Body = Offset; }
2010 /// Whether this function is variadic.
2011 bool isVariadic() const;
2013 /// Whether this function is marked as virtual explicitly.
2014 bool isVirtualAsWritten() const {
2015 return FunctionDeclBits.IsVirtualAsWritten;
2018 /// State that this function is marked as virtual explicitly.
2019 void setVirtualAsWritten(bool V) { FunctionDeclBits.IsVirtualAsWritten = V; }
2021 /// Whether this virtual function is pure, i.e. makes the containing class
2023 bool isPure() const { return FunctionDeclBits.IsPure; }
2024 void setPure(bool P = true);
2026 /// Whether this templated function will be late parsed.
2027 bool isLateTemplateParsed() const {
2028 return FunctionDeclBits.IsLateTemplateParsed;
2031 /// State that this templated function will be late parsed.
2032 void setLateTemplateParsed(bool ILT = true) {
2033 FunctionDeclBits.IsLateTemplateParsed = ILT;
2036 /// Whether this function is "trivial" in some specialized C++ senses.
2037 /// Can only be true for default constructors, copy constructors,
2038 /// copy assignment operators, and destructors. Not meaningful until
2039 /// the class has been fully built by Sema.
2040 bool isTrivial() const { return FunctionDeclBits.IsTrivial; }
2041 void setTrivial(bool IT) { FunctionDeclBits.IsTrivial = IT; }
2043 bool isTrivialForCall() const { return FunctionDeclBits.IsTrivialForCall; }
2044 void setTrivialForCall(bool IT) { FunctionDeclBits.IsTrivialForCall = IT; }
2046 /// Whether this function is defaulted per C++0x. Only valid for
2047 /// special member functions.
2048 bool isDefaulted() const { return FunctionDeclBits.IsDefaulted; }
2049 void setDefaulted(bool D = true) { FunctionDeclBits.IsDefaulted = D; }
2051 /// Whether this function is explicitly defaulted per C++0x. Only valid
2052 /// for special member functions.
2053 bool isExplicitlyDefaulted() const {
2054 return FunctionDeclBits.IsExplicitlyDefaulted;
2057 /// State that this function is explicitly defaulted per C++0x. Only valid
2058 /// for special member functions.
2059 void setExplicitlyDefaulted(bool ED = true) {
2060 FunctionDeclBits.IsExplicitlyDefaulted = ED;
2063 /// Whether falling off this function implicitly returns null/zero.
2064 /// If a more specific implicit return value is required, front-ends
2065 /// should synthesize the appropriate return statements.
2066 bool hasImplicitReturnZero() const {
2067 return FunctionDeclBits.HasImplicitReturnZero;
2070 /// State that falling off this function implicitly returns null/zero.
2071 /// If a more specific implicit return value is required, front-ends
2072 /// should synthesize the appropriate return statements.
2073 void setHasImplicitReturnZero(bool IRZ) {
2074 FunctionDeclBits.HasImplicitReturnZero = IRZ;
2077 /// Whether this function has a prototype, either because one
2078 /// was explicitly written or because it was "inherited" by merging
2079 /// a declaration without a prototype with a declaration that has a
2081 bool hasPrototype() const {
2082 return hasWrittenPrototype() || hasInheritedPrototype();
2085 /// Whether this function has a written prototype.
2086 bool hasWrittenPrototype() const {
2087 return FunctionDeclBits.HasWrittenPrototype;
2090 /// State that this function has a written prototype.
2091 void setHasWrittenPrototype(bool P = true) {
2092 FunctionDeclBits.HasWrittenPrototype = P;
2095 /// Whether this function inherited its prototype from a
2096 /// previous declaration.
2097 bool hasInheritedPrototype() const {
2098 return FunctionDeclBits.HasInheritedPrototype;
2101 /// State that this function inherited its prototype from a
2102 /// previous declaration.
2103 void setHasInheritedPrototype(bool P = true) {
2104 FunctionDeclBits.HasInheritedPrototype = P;
2107 /// Whether this is a (C++11) constexpr function or constexpr constructor.
2108 bool isConstexpr() const {
2109 return FunctionDeclBits.ConstexprKind != CSK_unspecified;
2111 void setConstexprKind(ConstexprSpecKind CSK) {
2112 FunctionDeclBits.ConstexprKind = CSK;
2114 ConstexprSpecKind getConstexprKind() const {
2115 return static_cast<ConstexprSpecKind>(FunctionDeclBits.ConstexprKind);
2117 bool isConstexprSpecified() const {
2118 return FunctionDeclBits.ConstexprKind == CSK_constexpr;
2120 bool isConsteval() const {
2121 return FunctionDeclBits.ConstexprKind == CSK_consteval;
2124 /// Whether the instantiation of this function is pending.
2125 /// This bit is set when the decision to instantiate this function is made
2126 /// and unset if and when the function body is created. That leaves out
2127 /// cases where instantiation did not happen because the template definition
2128 /// was not seen in this TU. This bit remains set in those cases, under the
2129 /// assumption that the instantiation will happen in some other TU.
2130 bool instantiationIsPending() const {
2131 return FunctionDeclBits.InstantiationIsPending;
2134 /// State that the instantiation of this function is pending.
2135 /// (see instantiationIsPending)
2136 void setInstantiationIsPending(bool IC) {
2137 FunctionDeclBits.InstantiationIsPending = IC;
2140 /// Indicates the function uses __try.
2141 bool usesSEHTry() const { return FunctionDeclBits.UsesSEHTry; }
2142 void setUsesSEHTry(bool UST) { FunctionDeclBits.UsesSEHTry = UST; }
2144 /// Whether this function has been deleted.
2146 /// A function that is "deleted" (via the C++0x "= delete" syntax)
2147 /// acts like a normal function, except that it cannot actually be
2148 /// called or have its address taken. Deleted functions are
2149 /// typically used in C++ overload resolution to attract arguments
2150 /// whose type or lvalue/rvalue-ness would permit the use of a
2151 /// different overload that would behave incorrectly. For example,
2152 /// one might use deleted functions to ban implicit conversion from
2153 /// a floating-point number to an Integer type:
2156 /// struct Integer {
2157 /// Integer(long); // construct from a long
2158 /// Integer(double) = delete; // no construction from float or double
2159 /// Integer(long double) = delete; // no construction from long double
2162 // If a function is deleted, its first declaration must be.
2163 bool isDeleted() const {
2164 return getCanonicalDecl()->FunctionDeclBits.IsDeleted;
2167 bool isDeletedAsWritten() const {
2168 return FunctionDeclBits.IsDeleted && !isDefaulted();
2171 void setDeletedAsWritten(bool D = true) { FunctionDeclBits.IsDeleted = D; }
2173 /// Determines whether this function is "main", which is the
2174 /// entry point into an executable program.
2175 bool isMain() const;
2177 /// Determines whether this function is a MSVCRT user defined entry
2179 bool isMSVCRTEntryPoint() const;
2181 /// Determines whether this operator new or delete is one
2182 /// of the reserved global placement operators:
2183 /// void *operator new(size_t, void *);
2184 /// void *operator new[](size_t, void *);
2185 /// void operator delete(void *, void *);
2186 /// void operator delete[](void *, void *);
2187 /// These functions have special behavior under [new.delete.placement]:
2188 /// These functions are reserved, a C++ program may not define
2189 /// functions that displace the versions in the Standard C++ library.
2190 /// The provisions of [basic.stc.dynamic] do not apply to these
2191 /// reserved placement forms of operator new and operator delete.
2193 /// This function must be an allocation or deallocation function.
2194 bool isReservedGlobalPlacementOperator() const;
2196 /// Determines whether this function is one of the replaceable
2197 /// global allocation functions:
2198 /// void *operator new(size_t);
2199 /// void *operator new(size_t, const std::nothrow_t &) noexcept;
2200 /// void *operator new[](size_t);
2201 /// void *operator new[](size_t, const std::nothrow_t &) noexcept;
2202 /// void operator delete(void *) noexcept;
2203 /// void operator delete(void *, std::size_t) noexcept; [C++1y]
2204 /// void operator delete(void *, const std::nothrow_t &) noexcept;
2205 /// void operator delete[](void *) noexcept;
2206 /// void operator delete[](void *, std::size_t) noexcept; [C++1y]
2207 /// void operator delete[](void *, const std::nothrow_t &) noexcept;
2208 /// These functions have special behavior under C++1y [expr.new]:
2209 /// An implementation is allowed to omit a call to a replaceable global
2210 /// allocation function. [...]
2212 /// If this function is an aligned allocation/deallocation function, return
2213 /// true through IsAligned.
2214 bool isReplaceableGlobalAllocationFunction(bool *IsAligned = nullptr) const;
2216 /// Determine whether this is a destroying operator delete.
2217 bool isDestroyingOperatorDelete() const;
2219 /// Compute the language linkage.
2220 LanguageLinkage getLanguageLinkage() const;
2222 /// Determines whether this function is a function with
2223 /// external, C linkage.
2224 bool isExternC() const;
2226 /// Determines whether this function's context is, or is nested within,
2227 /// a C++ extern "C" linkage spec.
2228 bool isInExternCContext() const;
2230 /// Determines whether this function's context is, or is nested within,
2231 /// a C++ extern "C++" linkage spec.
2232 bool isInExternCXXContext() const;
2234 /// Determines whether this is a global function.
2235 bool isGlobal() const;
2237 /// Determines whether this function is known to be 'noreturn', through
2238 /// an attribute on its declaration or its type.
2239 bool isNoReturn() const;
2241 /// True if the function was a definition but its body was skipped.
2242 bool hasSkippedBody() const { return FunctionDeclBits.HasSkippedBody; }
2243 void setHasSkippedBody(bool Skipped = true) {
2244 FunctionDeclBits.HasSkippedBody = Skipped;
2247 /// True if this function will eventually have a body, once it's fully parsed.
2248 bool willHaveBody() const { return FunctionDeclBits.WillHaveBody; }
2249 void setWillHaveBody(bool V = true) { FunctionDeclBits.WillHaveBody = V; }
2251 /// True if this function is considered a multiversioned function.
2252 bool isMultiVersion() const {
2253 return getCanonicalDecl()->FunctionDeclBits.IsMultiVersion;
2256 /// Sets the multiversion state for this declaration and all of its
2258 void setIsMultiVersion(bool V = true) {
2259 getCanonicalDecl()->FunctionDeclBits.IsMultiVersion = V;
2262 /// Gets the kind of multiversioning attribute this declaration has. Note that
2263 /// this can return a value even if the function is not multiversion, such as
2264 /// the case of 'target'.
2265 MultiVersionKind getMultiVersionKind() const;
2268 /// True if this function is a multiversioned dispatch function as a part of
2269 /// the cpu_specific/cpu_dispatch functionality.
2270 bool isCPUDispatchMultiVersion() const;
2271 /// True if this function is a multiversioned processor specific function as a
2272 /// part of the cpu_specific/cpu_dispatch functionality.
2273 bool isCPUSpecificMultiVersion() const;
2275 /// True if this function is a multiversioned dispatch function as a part of
2276 /// the target functionality.
2277 bool isTargetMultiVersion() const;
2279 void setPreviousDeclaration(FunctionDecl * PrevDecl);
2281 FunctionDecl *getCanonicalDecl() override;
2282 const FunctionDecl *getCanonicalDecl() const {
2283 return const_cast<FunctionDecl*>(this)->getCanonicalDecl();
2286 unsigned getBuiltinID(bool ConsiderWrapperFunctions = false) const;
2288 // ArrayRef interface to parameters.
2289 ArrayRef<ParmVarDecl *> parameters() const {
2290 return {ParamInfo, getNumParams()};
2292 MutableArrayRef<ParmVarDecl *> parameters() {
2293 return {ParamInfo, getNumParams()};
2296 // Iterator access to formal parameters.
2297 using param_iterator = MutableArrayRef<ParmVarDecl *>::iterator;
2298 using param_const_iterator = ArrayRef<ParmVarDecl *>::const_iterator;
2300 bool param_empty() const { return parameters().empty(); }
2301 param_iterator param_begin() { return parameters().begin(); }
2302 param_iterator param_end() { return parameters().end(); }
2303 param_const_iterator param_begin() const { return parameters().begin(); }
2304 param_const_iterator param_end() const { return parameters().end(); }
2305 size_t param_size() const { return parameters().size(); }
2307 /// Return the number of parameters this function must have based on its
2308 /// FunctionType. This is the length of the ParamInfo array after it has been
2310 unsigned getNumParams() const;
2312 const ParmVarDecl *getParamDecl(unsigned i) const {
2313 assert(i < getNumParams() && "Illegal param #");
2314 return ParamInfo[i];
2316 ParmVarDecl *getParamDecl(unsigned i) {
2317 assert(i < getNumParams() && "Illegal param #");
2318 return ParamInfo[i];
2320 void setParams(ArrayRef<ParmVarDecl *> NewParamInfo) {
2321 setParams(getASTContext(), NewParamInfo);
2324 /// Returns the minimum number of arguments needed to call this function. This
2325 /// may be fewer than the number of function parameters, if some of the
2326 /// parameters have default arguments (in C++).
2327 unsigned getMinRequiredArguments() const;
2329 QualType getReturnType() const {
2330 return getType()->castAs<FunctionType>()->getReturnType();
2333 /// Attempt to compute an informative source range covering the
2334 /// function return type. This may omit qualifiers and other information with
2335 /// limited representation in the AST.
2336 SourceRange getReturnTypeSourceRange() const;
2338 /// Get the declared return type, which may differ from the actual return
2339 /// type if the return type is deduced.
2340 QualType getDeclaredReturnType() const {
2341 auto *TSI = getTypeSourceInfo();
2342 QualType T = TSI ? TSI->getType() : getType();
2343 return T->castAs<FunctionType>()->getReturnType();
2346 /// Gets the ExceptionSpecificationType as declared.
2347 ExceptionSpecificationType getExceptionSpecType() const {
2348 auto *TSI = getTypeSourceInfo();
2349 QualType T = TSI ? TSI->getType() : getType();
2350 const auto *FPT = T->getAs<FunctionProtoType>();
2351 return FPT ? FPT->getExceptionSpecType() : EST_None;
2354 /// Attempt to compute an informative source range covering the
2355 /// function exception specification, if any.
2356 SourceRange getExceptionSpecSourceRange() const;
2358 /// Determine the type of an expression that calls this function.
2359 QualType getCallResultType() const {
2360 return getType()->castAs<FunctionType>()->getCallResultType(
2364 /// Returns the storage class as written in the source. For the
2365 /// computed linkage of symbol, see getLinkage.
2366 StorageClass getStorageClass() const {
2367 return static_cast<StorageClass>(FunctionDeclBits.SClass);
2370 /// Sets the storage class as written in the source.
2371 void setStorageClass(StorageClass SClass) {
2372 FunctionDeclBits.SClass = SClass;
2375 /// Determine whether the "inline" keyword was specified for this
2377 bool isInlineSpecified() const { return FunctionDeclBits.IsInlineSpecified; }
2379 /// Set whether the "inline" keyword was specified for this function.
2380 void setInlineSpecified(bool I) {
2381 FunctionDeclBits.IsInlineSpecified = I;
2382 FunctionDeclBits.IsInline = I;
2385 /// Flag that this function is implicitly inline.
2386 void setImplicitlyInline(bool I = true) { FunctionDeclBits.IsInline = I; }
2388 /// Determine whether this function should be inlined, because it is
2389 /// either marked "inline" or "constexpr" or is a member function of a class
2390 /// that was defined in the class body.
2391 bool isInlined() const { return FunctionDeclBits.IsInline; }
2393 bool isInlineDefinitionExternallyVisible() const;
2395 bool isMSExternInline() const;
2397 bool doesDeclarationForceExternallyVisibleDefinition() const;
2399 bool isStatic() const { return getStorageClass() == SC_Static; }
2401 /// Whether this function declaration represents an C++ overloaded
2402 /// operator, e.g., "operator+".
2403 bool isOverloadedOperator() const {
2404 return getOverloadedOperator() != OO_None;
2407 OverloadedOperatorKind getOverloadedOperator() const;
2409 const IdentifierInfo *getLiteralIdentifier() const;
2411 /// If this function is an instantiation of a member function
2412 /// of a class template specialization, retrieves the function from
2413 /// which it was instantiated.
2415 /// This routine will return non-NULL for (non-templated) member
2416 /// functions of class templates and for instantiations of function
2417 /// templates. For example, given:
2420 /// template<typename T>
2426 /// The declaration for X<int>::f is a (non-templated) FunctionDecl
2427 /// whose parent is the class template specialization X<int>. For
2428 /// this declaration, getInstantiatedFromFunction() will return
2429 /// the FunctionDecl X<T>::A. When a complete definition of
2430 /// X<int>::A is required, it will be instantiated from the
2431 /// declaration returned by getInstantiatedFromMemberFunction().
2432 FunctionDecl *getInstantiatedFromMemberFunction() const;
2434 /// What kind of templated function this is.
2435 TemplatedKind getTemplatedKind() const;
2437 /// If this function is an instantiation of a member function of a
2438 /// class template specialization, retrieves the member specialization
2440 MemberSpecializationInfo *getMemberSpecializationInfo() const;
2442 /// Specify that this record is an instantiation of the
2443 /// member function FD.
2444 void setInstantiationOfMemberFunction(FunctionDecl *FD,
2445 TemplateSpecializationKind TSK) {
2446 setInstantiationOfMemberFunction(getASTContext(), FD, TSK);
2449 /// Retrieves the function template that is described by this
2450 /// function declaration.
2452 /// Every function template is represented as a FunctionTemplateDecl
2453 /// and a FunctionDecl (or something derived from FunctionDecl). The
2454 /// former contains template properties (such as the template
2455 /// parameter lists) while the latter contains the actual
2456 /// description of the template's
2457 /// contents. FunctionTemplateDecl::getTemplatedDecl() retrieves the
2458 /// FunctionDecl that describes the function template,
2459 /// getDescribedFunctionTemplate() retrieves the
2460 /// FunctionTemplateDecl from a FunctionDecl.
2461 FunctionTemplateDecl *getDescribedFunctionTemplate() const;
2463 void setDescribedFunctionTemplate(FunctionTemplateDecl *Template);
2465 /// Determine whether this function is a function template
2467 bool isFunctionTemplateSpecialization() const {
2468 return getPrimaryTemplate() != nullptr;
2471 /// If this function is actually a function template specialization,
2472 /// retrieve information about this function template specialization.
2473 /// Otherwise, returns NULL.
2474 FunctionTemplateSpecializationInfo *getTemplateSpecializationInfo() const;
2476 /// Determines whether this function is a function template
2477 /// specialization or a member of a class template specialization that can
2478 /// be implicitly instantiated.
2479 bool isImplicitlyInstantiable() const;
2481 /// Determines if the given function was instantiated from a
2482 /// function template.
2483 bool isTemplateInstantiation() const;
2485 /// Retrieve the function declaration from which this function could
2486 /// be instantiated, if it is an instantiation (rather than a non-template
2487 /// or a specialization, for example).
2488 FunctionDecl *getTemplateInstantiationPattern() const;
2490 /// Retrieve the primary template that this function template
2491 /// specialization either specializes or was instantiated from.
2493 /// If this function declaration is not a function template specialization,
2495 FunctionTemplateDecl *getPrimaryTemplate() const;
2497 /// Retrieve the template arguments used to produce this function
2498 /// template specialization from the primary template.
2500 /// If this function declaration is not a function template specialization,
2502 const TemplateArgumentList *getTemplateSpecializationArgs() const;
2504 /// Retrieve the template argument list as written in the sources,
2507 /// If this function declaration is not a function template specialization
2508 /// or if it had no explicit template argument list, returns NULL.
2509 /// Note that it an explicit template argument list may be written empty,
2510 /// e.g., template<> void foo<>(char* s);
2511 const ASTTemplateArgumentListInfo*
2512 getTemplateSpecializationArgsAsWritten() const;
2514 /// Specify that this function declaration is actually a function
2515 /// template specialization.
2517 /// \param Template the function template that this function template
2518 /// specialization specializes.
2520 /// \param TemplateArgs the template arguments that produced this
2521 /// function template specialization from the template.
2523 /// \param InsertPos If non-NULL, the position in the function template
2524 /// specialization set where the function template specialization data will
2527 /// \param TSK the kind of template specialization this is.
2529 /// \param TemplateArgsAsWritten location info of template arguments.
2531 /// \param PointOfInstantiation point at which the function template
2532 /// specialization was first instantiated.
2533 void setFunctionTemplateSpecialization(FunctionTemplateDecl *Template,
2534 const TemplateArgumentList *TemplateArgs,
2536 TemplateSpecializationKind TSK = TSK_ImplicitInstantiation,
2537 const TemplateArgumentListInfo *TemplateArgsAsWritten = nullptr,
2538 SourceLocation PointOfInstantiation = SourceLocation()) {
2539 setFunctionTemplateSpecialization(getASTContext(), Template, TemplateArgs,
2540 InsertPos, TSK, TemplateArgsAsWritten,
2541 PointOfInstantiation);
2544 /// Specifies that this function declaration is actually a
2545 /// dependent function template specialization.
2546 void setDependentTemplateSpecialization(ASTContext &Context,
2547 const UnresolvedSetImpl &Templates,
2548 const TemplateArgumentListInfo &TemplateArgs);
2550 DependentFunctionTemplateSpecializationInfo *
2551 getDependentSpecializationInfo() const;
2553 /// Determine what kind of template instantiation this function
2555 TemplateSpecializationKind getTemplateSpecializationKind() const;
2557 /// Determine the kind of template specialization this function represents
2558 /// for the purpose of template instantiation.
2559 TemplateSpecializationKind
2560 getTemplateSpecializationKindForInstantiation() const;
2562 /// Determine what kind of template instantiation this function
2564 void setTemplateSpecializationKind(TemplateSpecializationKind TSK,
2565 SourceLocation PointOfInstantiation = SourceLocation());
2567 /// Retrieve the (first) point of instantiation of a function template
2568 /// specialization or a member of a class template specialization.
2570 /// \returns the first point of instantiation, if this function was
2571 /// instantiated from a template; otherwise, returns an invalid source
2573 SourceLocation getPointOfInstantiation() const;
2575 /// Determine whether this is or was instantiated from an out-of-line
2576 /// definition of a member function.
2577 bool isOutOfLine() const override;
2579 /// Identify a memory copying or setting function.
2580 /// If the given function is a memory copy or setting function, returns
2581 /// the corresponding Builtin ID. If the function is not a memory function,
2583 unsigned getMemoryFunctionKind() const;
2585 /// Returns ODRHash of the function. This value is calculated and
2586 /// stored on first call, then the stored value returned on the other calls.
2587 unsigned getODRHash();
2589 /// Returns cached ODRHash of the function. This must have been previously
2590 /// computed and stored.
2591 unsigned getODRHash() const;
2593 // Implement isa/cast/dyncast/etc.
2594 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2595 static bool classofKind(Kind K) {
2596 return K >= firstFunction && K <= lastFunction;
2598 static DeclContext *castToDeclContext(const FunctionDecl *D) {
2599 return static_cast<DeclContext *>(const_cast<FunctionDecl*>(D));
2601 static FunctionDecl *castFromDeclContext(const DeclContext *DC) {
2602 return static_cast<FunctionDecl *>(const_cast<DeclContext*>(DC));
2606 /// Represents a member of a struct/union/class.
2607 class FieldDecl : public DeclaratorDecl, public Mergeable<FieldDecl> {
2608 unsigned BitField : 1;
2609 unsigned Mutable : 1;
2610 mutable unsigned CachedFieldIndex : 30;
2612 /// The kinds of value we can store in InitializerOrBitWidth.
2614 /// Note that this is compatible with InClassInitStyle except for
2615 /// ISK_CapturedVLAType.
2616 enum InitStorageKind {
2617 /// If the pointer is null, there's nothing special. Otherwise,
2618 /// this is a bitfield and the pointer is the Expr* storing the
2620 ISK_NoInit = (unsigned) ICIS_NoInit,
2622 /// The pointer is an (optional due to delayed parsing) Expr*
2623 /// holding the copy-initializer.
2624 ISK_InClassCopyInit = (unsigned) ICIS_CopyInit,
2626 /// The pointer is an (optional due to delayed parsing) Expr*
2627 /// holding the list-initializer.
2628 ISK_InClassListInit = (unsigned) ICIS_ListInit,
2630 /// The pointer is a VariableArrayType* that's been captured;
2631 /// the enclosing context is a lambda or captured statement.
2632 ISK_CapturedVLAType,
2635 /// If this is a bitfield with a default member initializer, this
2636 /// structure is used to represent the two expressions.
2637 struct InitAndBitWidth {
2642 /// Storage for either the bit-width, the in-class initializer, or
2643 /// both (via InitAndBitWidth), or the captured variable length array bound.
2645 /// If the storage kind is ISK_InClassCopyInit or
2646 /// ISK_InClassListInit, but the initializer is null, then this
2647 /// field has an in-class initializer that has not yet been parsed
2649 // FIXME: Tail-allocate this to reduce the size of FieldDecl in the
2650 // overwhelmingly common case that we have none of these things.
2651 llvm::PointerIntPair<void *, 2, InitStorageKind> InitStorage;
2654 FieldDecl(Kind DK, DeclContext *DC, SourceLocation StartLoc,
2655 SourceLocation IdLoc, IdentifierInfo *Id,
2656 QualType T, TypeSourceInfo *TInfo, Expr *BW, bool Mutable,
2657 InClassInitStyle InitStyle)
2658 : DeclaratorDecl(DK, DC, IdLoc, Id, T, TInfo, StartLoc),
2659 BitField(false), Mutable(Mutable), CachedFieldIndex(0),
2660 InitStorage(nullptr, (InitStorageKind) InitStyle) {
2666 friend class ASTDeclReader;
2667 friend class ASTDeclWriter;
2669 static FieldDecl *Create(const ASTContext &C, DeclContext *DC,
2670 SourceLocation StartLoc, SourceLocation IdLoc,
2671 IdentifierInfo *Id, QualType T,
2672 TypeSourceInfo *TInfo, Expr *BW, bool Mutable,
2673 InClassInitStyle InitStyle);
2675 static FieldDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2677 /// Returns the index of this field within its record,
2678 /// as appropriate for passing to ASTRecordLayout::getFieldOffset.
2679 unsigned getFieldIndex() const;
2681 /// Determines whether this field is mutable (C++ only).
2682 bool isMutable() const { return Mutable; }
2684 /// Determines whether this field is a bitfield.
2685 bool isBitField() const { return BitField; }
2687 /// Determines whether this is an unnamed bitfield.
2688 bool isUnnamedBitfield() const { return isBitField() && !getDeclName(); }
2690 /// Determines whether this field is a
2691 /// representative for an anonymous struct or union. Such fields are
2692 /// unnamed and are implicitly generated by the implementation to
2693 /// store the data for the anonymous union or struct.
2694 bool isAnonymousStructOrUnion() const;
2696 Expr *getBitWidth() const {
2699 void *Ptr = InitStorage.getPointer();
2700 if (getInClassInitStyle())
2701 return static_cast<InitAndBitWidth*>(Ptr)->BitWidth;
2702 return static_cast<Expr*>(Ptr);
2705 unsigned getBitWidthValue(const ASTContext &Ctx) const;
2707 /// Set the bit-field width for this member.
2708 // Note: used by some clients (i.e., do not remove it).
2709 void setBitWidth(Expr *Width) {
2710 assert(!hasCapturedVLAType() && !BitField &&
2711 "bit width or captured type already set");
2712 assert(Width && "no bit width specified");
2713 InitStorage.setPointer(
2714 InitStorage.getInt()
2715 ? new (getASTContext())
2716 InitAndBitWidth{getInClassInitializer(), Width}
2717 : static_cast<void*>(Width));
2721 /// Remove the bit-field width from this member.
2722 // Note: used by some clients (i.e., do not remove it).
2723 void removeBitWidth() {
2724 assert(isBitField() && "no bitfield width to remove");
2725 InitStorage.setPointer(getInClassInitializer());
2729 /// Is this a zero-length bit-field? Such bit-fields aren't really bit-fields
2730 /// at all and instead act as a separator between contiguous runs of other
2732 bool isZeroLengthBitField(const ASTContext &Ctx) const;
2734 /// Determine if this field is a subobject of zero size, that is, either a
2735 /// zero-length bit-field or a field of empty class type with the
2736 /// [[no_unique_address]] attribute.
2737 bool isZeroSize(const ASTContext &Ctx) const;
2739 /// Get the kind of (C++11) default member initializer that this field has.
2740 InClassInitStyle getInClassInitStyle() const {
2741 InitStorageKind storageKind = InitStorage.getInt();
2742 return (storageKind == ISK_CapturedVLAType
2743 ? ICIS_NoInit : (InClassInitStyle) storageKind);
2746 /// Determine whether this member has a C++11 default member initializer.
2747 bool hasInClassInitializer() const {
2748 return getInClassInitStyle() != ICIS_NoInit;
2751 /// Get the C++11 default member initializer for this member, or null if one
2752 /// has not been set. If a valid declaration has a default member initializer,
2753 /// but this returns null, then we have not parsed and attached it yet.
2754 Expr *getInClassInitializer() const {
2755 if (!hasInClassInitializer())
2757 void *Ptr = InitStorage.getPointer();
2759 return static_cast<InitAndBitWidth*>(Ptr)->Init;
2760 return static_cast<Expr*>(Ptr);
2763 /// Set the C++11 in-class initializer for this member.
2764 void setInClassInitializer(Expr *Init) {
2765 assert(hasInClassInitializer() && !getInClassInitializer());
2767 static_cast<InitAndBitWidth*>(InitStorage.getPointer())->Init = Init;
2769 InitStorage.setPointer(Init);
2772 /// Remove the C++11 in-class initializer from this member.
2773 void removeInClassInitializer() {
2774 assert(hasInClassInitializer() && "no initializer to remove");
2775 InitStorage.setPointerAndInt(getBitWidth(), ISK_NoInit);
2778 /// Determine whether this member captures the variable length array
2780 bool hasCapturedVLAType() const {
2781 return InitStorage.getInt() == ISK_CapturedVLAType;
2784 /// Get the captured variable length array type.
2785 const VariableArrayType *getCapturedVLAType() const {
2786 return hasCapturedVLAType() ? static_cast<const VariableArrayType *>(
2787 InitStorage.getPointer())
2791 /// Set the captured variable length array type for this field.
2792 void setCapturedVLAType(const VariableArrayType *VLAType);
2794 /// Returns the parent of this field declaration, which
2795 /// is the struct in which this field is defined.
2796 const RecordDecl *getParent() const {
2797 return cast<RecordDecl>(getDeclContext());
2800 RecordDecl *getParent() {
2801 return cast<RecordDecl>(getDeclContext());
2804 SourceRange getSourceRange() const override LLVM_READONLY;
2806 /// Retrieves the canonical declaration of this field.
2807 FieldDecl *getCanonicalDecl() override { return getFirstDecl(); }
2808 const FieldDecl *getCanonicalDecl() const { return getFirstDecl(); }
2810 // Implement isa/cast/dyncast/etc.
2811 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2812 static bool classofKind(Kind K) { return K >= firstField && K <= lastField; }
2815 /// An instance of this object exists for each enum constant
2816 /// that is defined. For example, in "enum X {a,b}", each of a/b are
2817 /// EnumConstantDecl's, X is an instance of EnumDecl, and the type of a/b is a
2818 /// TagType for the X EnumDecl.
2819 class EnumConstantDecl : public ValueDecl, public Mergeable<EnumConstantDecl> {
2820 Stmt *Init; // an integer constant expression
2821 llvm::APSInt Val; // The value.
2824 EnumConstantDecl(DeclContext *DC, SourceLocation L,
2825 IdentifierInfo *Id, QualType T, Expr *E,
2826 const llvm::APSInt &V)
2827 : ValueDecl(EnumConstant, DC, L, Id, T), Init((Stmt*)E), Val(V) {}
2830 friend class StmtIteratorBase;
2832 static EnumConstantDecl *Create(ASTContext &C, EnumDecl *DC,
2833 SourceLocation L, IdentifierInfo *Id,
2834 QualType T, Expr *E,
2835 const llvm::APSInt &V);
2836 static EnumConstantDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2838 const Expr *getInitExpr() const { return (const Expr*) Init; }
2839 Expr *getInitExpr() { return (Expr*) Init; }
2840 const llvm::APSInt &getInitVal() const { return Val; }
2842 void setInitExpr(Expr *E) { Init = (Stmt*) E; }
2843 void setInitVal(const llvm::APSInt &V) { Val = V; }
2845 SourceRange getSourceRange() const override LLVM_READONLY;
2847 /// Retrieves the canonical declaration of this enumerator.
2848 EnumConstantDecl *getCanonicalDecl() override { return getFirstDecl(); }
2849 const EnumConstantDecl *getCanonicalDecl() const { return getFirstDecl(); }
2851 // Implement isa/cast/dyncast/etc.
2852 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2853 static bool classofKind(Kind K) { return K == EnumConstant; }
2856 /// Represents a field injected from an anonymous union/struct into the parent
2857 /// scope. These are always implicit.
2858 class IndirectFieldDecl : public ValueDecl,
2859 public Mergeable<IndirectFieldDecl> {
2860 NamedDecl **Chaining;
2861 unsigned ChainingSize;
2863 IndirectFieldDecl(ASTContext &C, DeclContext *DC, SourceLocation L,
2864 DeclarationName N, QualType T,
2865 MutableArrayRef<NamedDecl *> CH);
2867 void anchor() override;
2870 friend class ASTDeclReader;
2872 static IndirectFieldDecl *Create(ASTContext &C, DeclContext *DC,
2873 SourceLocation L, IdentifierInfo *Id,
2874 QualType T, llvm::MutableArrayRef<NamedDecl *> CH);
2876 static IndirectFieldDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2878 using chain_iterator = ArrayRef<NamedDecl *>::const_iterator;
2880 ArrayRef<NamedDecl *> chain() const {
2881 return llvm::makeArrayRef(Chaining, ChainingSize);
2883 chain_iterator chain_begin() const { return chain().begin(); }
2884 chain_iterator chain_end() const { return chain().end(); }
2886 unsigned getChainingSize() const { return ChainingSize; }
2888 FieldDecl *getAnonField() const {
2889 assert(chain().size() >= 2);
2890 return cast<FieldDecl>(chain().back());
2893 VarDecl *getVarDecl() const {
2894 assert(chain().size() >= 2);
2895 return dyn_cast<VarDecl>(chain().front());
2898 IndirectFieldDecl *getCanonicalDecl() override { return getFirstDecl(); }
2899 const IndirectFieldDecl *getCanonicalDecl() const { return getFirstDecl(); }
2901 // Implement isa/cast/dyncast/etc.
2902 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2903 static bool classofKind(Kind K) { return K == IndirectField; }
2906 /// Represents a declaration of a type.
2907 class TypeDecl : public NamedDecl {
2908 friend class ASTContext;
2910 /// This indicates the Type object that represents
2911 /// this TypeDecl. It is a cache maintained by
2912 /// ASTContext::getTypedefType, ASTContext::getTagDeclType, and
2913 /// ASTContext::getTemplateTypeParmType, and TemplateTypeParmDecl.
2914 mutable const Type *TypeForDecl = nullptr;
2916 /// The start of the source range for this declaration.
2917 SourceLocation LocStart;
2919 void anchor() override;
2922 TypeDecl(Kind DK, DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
2923 SourceLocation StartL = SourceLocation())
2924 : NamedDecl(DK, DC, L, Id), LocStart(StartL) {}
2927 // Low-level accessor. If you just want the type defined by this node,
2928 // check out ASTContext::getTypeDeclType or one of
2929 // ASTContext::getTypedefType, ASTContext::getRecordType, etc. if you
2930 // already know the specific kind of node this is.
2931 const Type *getTypeForDecl() const { return TypeForDecl; }
2932 void setTypeForDecl(const Type *TD) { TypeForDecl = TD; }
2934 SourceLocation getBeginLoc() const LLVM_READONLY { return LocStart; }
2935 void setLocStart(SourceLocation L) { LocStart = L; }
2936 SourceRange getSourceRange() const override LLVM_READONLY {
2937 if (LocStart.isValid())
2938 return SourceRange(LocStart, getLocation());
2940 return SourceRange(getLocation());
2943 // Implement isa/cast/dyncast/etc.
2944 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2945 static bool classofKind(Kind K) { return K >= firstType && K <= lastType; }
2948 /// Base class for declarations which introduce a typedef-name.
2949 class TypedefNameDecl : public TypeDecl, public Redeclarable<TypedefNameDecl> {
2950 struct alignas(8) ModedTInfo {
2951 TypeSourceInfo *first;
2955 /// If int part is 0, we have not computed IsTransparentTag.
2956 /// Otherwise, IsTransparentTag is (getInt() >> 1).
2957 mutable llvm::PointerIntPair<
2958 llvm::PointerUnion<TypeSourceInfo *, ModedTInfo *>, 2>
2961 void anchor() override;
2964 TypedefNameDecl(Kind DK, ASTContext &C, DeclContext *DC,
2965 SourceLocation StartLoc, SourceLocation IdLoc,
2966 IdentifierInfo *Id, TypeSourceInfo *TInfo)
2967 : TypeDecl(DK, DC, IdLoc, Id, StartLoc), redeclarable_base(C),
2968 MaybeModedTInfo(TInfo, 0) {}
2970 using redeclarable_base = Redeclarable<TypedefNameDecl>;
2972 TypedefNameDecl *getNextRedeclarationImpl() override {
2973 return getNextRedeclaration();
2976 TypedefNameDecl *getPreviousDeclImpl() override {
2977 return getPreviousDecl();
2980 TypedefNameDecl *getMostRecentDeclImpl() override {
2981 return getMostRecentDecl();
2985 using redecl_range = redeclarable_base::redecl_range;
2986 using redecl_iterator = redeclarable_base::redecl_iterator;
2988 using redeclarable_base::redecls_begin;
2989 using redeclarable_base::redecls_end;
2990 using redeclarable_base::redecls;
2991 using redeclarable_base::getPreviousDecl;
2992 using redeclarable_base::getMostRecentDecl;
2993 using redeclarable_base::isFirstDecl;
2995 bool isModed() const {
2996 return MaybeModedTInfo.getPointer().is<ModedTInfo *>();
2999 TypeSourceInfo *getTypeSourceInfo() const {
3000 return isModed() ? MaybeModedTInfo.getPointer().get<ModedTInfo *>()->first
3001 : MaybeModedTInfo.getPointer().get<TypeSourceInfo *>();
3004 QualType getUnderlyingType() const {
3005 return isModed() ? MaybeModedTInfo.getPointer().get<ModedTInfo *>()->second
3006 : MaybeModedTInfo.getPointer()
3007 .get<TypeSourceInfo *>()
3011 void setTypeSourceInfo(TypeSourceInfo *newType) {
3012 MaybeModedTInfo.setPointer(newType);
3015 void setModedTypeSourceInfo(TypeSourceInfo *unmodedTSI, QualType modedTy) {
3016 MaybeModedTInfo.setPointer(new (getASTContext(), 8)
3017 ModedTInfo({unmodedTSI, modedTy}));
3020 /// Retrieves the canonical declaration of this typedef-name.
3021 TypedefNameDecl *getCanonicalDecl() override { return getFirstDecl(); }
3022 const TypedefNameDecl *getCanonicalDecl() const { return getFirstDecl(); }
3024 /// Retrieves the tag declaration for which this is the typedef name for
3025 /// linkage purposes, if any.
3027 /// \param AnyRedecl Look for the tag declaration in any redeclaration of
3028 /// this typedef declaration.
3029 TagDecl *getAnonDeclWithTypedefName(bool AnyRedecl = false) const;
3031 /// Determines if this typedef shares a name and spelling location with its
3032 /// underlying tag type, as is the case with the NS_ENUM macro.
3033 bool isTransparentTag() const {
3034 if (MaybeModedTInfo.getInt())
3035 return MaybeModedTInfo.getInt() & 0x2;
3036 return isTransparentTagSlow();
3039 // Implement isa/cast/dyncast/etc.
3040 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3041 static bool classofKind(Kind K) {
3042 return K >= firstTypedefName && K <= lastTypedefName;
3046 bool isTransparentTagSlow() const;
3049 /// Represents the declaration of a typedef-name via the 'typedef'
3051 class TypedefDecl : public TypedefNameDecl {
3052 TypedefDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
3053 SourceLocation IdLoc, IdentifierInfo *Id, TypeSourceInfo *TInfo)
3054 : TypedefNameDecl(Typedef, C, DC, StartLoc, IdLoc, Id, TInfo) {}
3057 static TypedefDecl *Create(ASTContext &C, DeclContext *DC,
3058 SourceLocation StartLoc, SourceLocation IdLoc,
3059 IdentifierInfo *Id, TypeSourceInfo *TInfo);
3060 static TypedefDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3062 SourceRange getSourceRange() const override LLVM_READONLY;
3064 // Implement isa/cast/dyncast/etc.
3065 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3066 static bool classofKind(Kind K) { return K == Typedef; }
3069 /// Represents the declaration of a typedef-name via a C++11
3070 /// alias-declaration.
3071 class TypeAliasDecl : public TypedefNameDecl {
3072 /// The template for which this is the pattern, if any.
3073 TypeAliasTemplateDecl *Template;
3075 TypeAliasDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
3076 SourceLocation IdLoc, IdentifierInfo *Id, TypeSourceInfo *TInfo)
3077 : TypedefNameDecl(TypeAlias, C, DC, StartLoc, IdLoc, Id, TInfo),
3078 Template(nullptr) {}
3081 static TypeAliasDecl *Create(ASTContext &C, DeclContext *DC,
3082 SourceLocation StartLoc, SourceLocation IdLoc,
3083 IdentifierInfo *Id, TypeSourceInfo *TInfo);
3084 static TypeAliasDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3086 SourceRange getSourceRange() const override LLVM_READONLY;
3088 TypeAliasTemplateDecl *getDescribedAliasTemplate() const { return Template; }
3089 void setDescribedAliasTemplate(TypeAliasTemplateDecl *TAT) { Template = TAT; }
3091 // Implement isa/cast/dyncast/etc.
3092 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3093 static bool classofKind(Kind K) { return K == TypeAlias; }
3096 /// Represents the declaration of a struct/union/class/enum.
3097 class TagDecl : public TypeDecl,
3099 public Redeclarable<TagDecl> {
3100 // This class stores some data in DeclContext::TagDeclBits
3101 // to save some space. Use the provided accessors to access it.
3103 // This is really ugly.
3104 using TagKind = TagTypeKind;
3107 SourceRange BraceRange;
3109 // A struct representing syntactic qualifier info,
3110 // to be used for the (uncommon) case of out-of-line declarations.
3111 using ExtInfo = QualifierInfo;
3113 /// If the (out-of-line) tag declaration name
3114 /// is qualified, it points to the qualifier info (nns and range);
3115 /// otherwise, if the tag declaration is anonymous and it is part of
3116 /// a typedef or alias, it points to the TypedefNameDecl (used for mangling);
3117 /// otherwise, if the tag declaration is anonymous and it is used as a
3118 /// declaration specifier for variables, it points to the first VarDecl (used
3120 /// otherwise, it is a null (TypedefNameDecl) pointer.
3121 llvm::PointerUnion<TypedefNameDecl *, ExtInfo *> TypedefNameDeclOrQualifier;
3123 bool hasExtInfo() const { return TypedefNameDeclOrQualifier.is<ExtInfo *>(); }
3124 ExtInfo *getExtInfo() { return TypedefNameDeclOrQualifier.get<ExtInfo *>(); }
3125 const ExtInfo *getExtInfo() const {
3126 return TypedefNameDeclOrQualifier.get<ExtInfo *>();
3130 TagDecl(Kind DK, TagKind TK, const ASTContext &C, DeclContext *DC,
3131 SourceLocation L, IdentifierInfo *Id, TagDecl *PrevDecl,
3132 SourceLocation StartL);
3134 using redeclarable_base = Redeclarable<TagDecl>;
3136 TagDecl *getNextRedeclarationImpl() override {
3137 return getNextRedeclaration();
3140 TagDecl *getPreviousDeclImpl() override {
3141 return getPreviousDecl();
3144 TagDecl *getMostRecentDeclImpl() override {
3145 return getMostRecentDecl();
3148 /// Completes the definition of this tag declaration.
3150 /// This is a helper function for derived classes.
3151 void completeDefinition();
3153 /// True if this decl is currently being defined.
3154 void setBeingDefined(bool V = true) { TagDeclBits.IsBeingDefined = V; }
3156 /// Indicates whether it is possible for declarations of this kind
3157 /// to have an out-of-date definition.
3159 /// This option is only enabled when modules are enabled.
3160 void setMayHaveOutOfDateDef(bool V = true) {
3161 TagDeclBits.MayHaveOutOfDateDef = V;
3165 friend class ASTDeclReader;
3166 friend class ASTDeclWriter;
3168 using redecl_range = redeclarable_base::redecl_range;
3169 using redecl_iterator = redeclarable_base::redecl_iterator;
3171 using redeclarable_base::redecls_begin;
3172 using redeclarable_base::redecls_end;
3173 using redeclarable_base::redecls;
3174 using redeclarable_base::getPreviousDecl;
3175 using redeclarable_base::getMostRecentDecl;
3176 using redeclarable_base::isFirstDecl;
3178 SourceRange getBraceRange() const { return BraceRange; }
3179 void setBraceRange(SourceRange R) { BraceRange = R; }
3181 /// Return SourceLocation representing start of source
3182 /// range ignoring outer template declarations.
3183 SourceLocation getInnerLocStart() const { return getBeginLoc(); }
3185 /// Return SourceLocation representing start of source
3186 /// range taking into account any outer template declarations.
3187 SourceLocation getOuterLocStart() const;
3188 SourceRange getSourceRange() const override LLVM_READONLY;
3190 TagDecl *getCanonicalDecl() override;
3191 const TagDecl *getCanonicalDecl() const {
3192 return const_cast<TagDecl*>(this)->getCanonicalDecl();
3195 /// Return true if this declaration is a completion definition of the type.
3196 /// Provided for consistency.
3197 bool isThisDeclarationADefinition() const {
3198 return isCompleteDefinition();
3201 /// Return true if this decl has its body fully specified.
3202 bool isCompleteDefinition() const { return TagDeclBits.IsCompleteDefinition; }
3204 /// True if this decl has its body fully specified.
3205 void setCompleteDefinition(bool V = true) {
3206 TagDeclBits.IsCompleteDefinition = V;
3209 /// Return true if this complete decl is
3210 /// required to be complete for some existing use.
3211 bool isCompleteDefinitionRequired() const {
3212 return TagDeclBits.IsCompleteDefinitionRequired;
3215 /// True if this complete decl is
3216 /// required to be complete for some existing use.
3217 void setCompleteDefinitionRequired(bool V = true) {
3218 TagDeclBits.IsCompleteDefinitionRequired = V;
3221 /// Return true if this decl is currently being defined.
3222 bool isBeingDefined() const { return TagDeclBits.IsBeingDefined; }
3224 /// True if this tag declaration is "embedded" (i.e., defined or declared
3225 /// for the very first time) in the syntax of a declarator.
3226 bool isEmbeddedInDeclarator() const {
3227 return TagDeclBits.IsEmbeddedInDeclarator;
3230 /// True if this tag declaration is "embedded" (i.e., defined or declared
3231 /// for the very first time) in the syntax of a declarator.
3232 void setEmbeddedInDeclarator(bool isInDeclarator) {
3233 TagDeclBits.IsEmbeddedInDeclarator = isInDeclarator;
3236 /// True if this tag is free standing, e.g. "struct foo;".
3237 bool isFreeStanding() const { return TagDeclBits.IsFreeStanding; }
3239 /// True if this tag is free standing, e.g. "struct foo;".
3240 void setFreeStanding(bool isFreeStanding = true) {
3241 TagDeclBits.IsFreeStanding = isFreeStanding;
3244 /// Indicates whether it is possible for declarations of this kind
3245 /// to have an out-of-date definition.
3247 /// This option is only enabled when modules are enabled.
3248 bool mayHaveOutOfDateDef() const { return TagDeclBits.MayHaveOutOfDateDef; }
3250 /// Whether this declaration declares a type that is
3251 /// dependent, i.e., a type that somehow depends on template
3253 bool isDependentType() const { return isDependentContext(); }
3255 /// Starts the definition of this tag declaration.
3257 /// This method should be invoked at the beginning of the definition
3258 /// of this tag declaration. It will set the tag type into a state
3259 /// where it is in the process of being defined.
3260 void startDefinition();
3262 /// Returns the TagDecl that actually defines this
3263 /// struct/union/class/enum. When determining whether or not a
3264 /// struct/union/class/enum has a definition, one should use this
3265 /// method as opposed to 'isDefinition'. 'isDefinition' indicates
3266 /// whether or not a specific TagDecl is defining declaration, not
3267 /// whether or not the struct/union/class/enum type is defined.
3268 /// This method returns NULL if there is no TagDecl that defines
3269 /// the struct/union/class/enum.
3270 TagDecl *getDefinition() const;
3272 StringRef getKindName() const {
3273 return TypeWithKeyword::getTagTypeKindName(getTagKind());
3276 TagKind getTagKind() const {
3277 return static_cast<TagKind>(TagDeclBits.TagDeclKind);
3280 void setTagKind(TagKind TK) { TagDeclBits.TagDeclKind = TK; }
3282 bool isStruct() const { return getTagKind() == TTK_Struct; }
3283 bool isInterface() const { return getTagKind() == TTK_Interface; }
3284 bool isClass() const { return getTagKind() == TTK_Class; }
3285 bool isUnion() const { return getTagKind() == TTK_Union; }
3286 bool isEnum() const { return getTagKind() == TTK_Enum; }
3288 /// Is this tag type named, either directly or via being defined in
3289 /// a typedef of this type?
3291 /// C++11 [basic.link]p8:
3292 /// A type is said to have linkage if and only if:
3293 /// - it is a class or enumeration type that is named (or has a
3294 /// name for linkage purposes) and the name has linkage; ...
3295 /// C++11 [dcl.typedef]p9:
3296 /// If the typedef declaration defines an unnamed class (or enum),
3297 /// the first typedef-name declared by the declaration to be that
3298 /// class type (or enum type) is used to denote the class type (or
3299 /// enum type) for linkage purposes only.
3301 /// C does not have an analogous rule, but the same concept is
3302 /// nonetheless useful in some places.
3303 bool hasNameForLinkage() const {
3304 return (getDeclName() || getTypedefNameForAnonDecl());
3307 TypedefNameDecl *getTypedefNameForAnonDecl() const {
3308 return hasExtInfo() ? nullptr
3309 : TypedefNameDeclOrQualifier.get<TypedefNameDecl *>();
3312 void setTypedefNameForAnonDecl(TypedefNameDecl *TDD);
3314 /// Retrieve the nested-name-specifier that qualifies the name of this
3315 /// declaration, if it was present in the source.
3316 NestedNameSpecifier *getQualifier() const {
3317 return hasExtInfo() ? getExtInfo()->QualifierLoc.getNestedNameSpecifier()
3321 /// Retrieve the nested-name-specifier (with source-location
3322 /// information) that qualifies the name of this declaration, if it was
3323 /// present in the source.
3324 NestedNameSpecifierLoc getQualifierLoc() const {
3325 return hasExtInfo() ? getExtInfo()->QualifierLoc
3326 : NestedNameSpecifierLoc();
3329 void setQualifierInfo(NestedNameSpecifierLoc QualifierLoc);
3331 unsigned getNumTemplateParameterLists() const {
3332 return hasExtInfo() ? getExtInfo()->NumTemplParamLists : 0;
3335 TemplateParameterList *getTemplateParameterList(unsigned i) const {
3336 assert(i < getNumTemplateParameterLists());
3337 return getExtInfo()->TemplParamLists[i];
3340 void setTemplateParameterListsInfo(ASTContext &Context,
3341 ArrayRef<TemplateParameterList *> TPLists);
3343 // Implement isa/cast/dyncast/etc.
3344 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3345 static bool classofKind(Kind K) { return K >= firstTag && K <= lastTag; }
3347 static DeclContext *castToDeclContext(const TagDecl *D) {
3348 return static_cast<DeclContext *>(const_cast<TagDecl*>(D));
3351 static TagDecl *castFromDeclContext(const DeclContext *DC) {
3352 return static_cast<TagDecl *>(const_cast<DeclContext*>(DC));
3356 /// Represents an enum. In C++11, enums can be forward-declared
3357 /// with a fixed underlying type, and in C we allow them to be forward-declared
3358 /// with no underlying type as an extension.
3359 class EnumDecl : public TagDecl {
3360 // This class stores some data in DeclContext::EnumDeclBits
3361 // to save some space. Use the provided accessors to access it.
3363 /// This represent the integer type that the enum corresponds
3364 /// to for code generation purposes. Note that the enumerator constants may
3365 /// have a different type than this does.
3367 /// If the underlying integer type was explicitly stated in the source
3368 /// code, this is a TypeSourceInfo* for that type. Otherwise this type
3369 /// was automatically deduced somehow, and this is a Type*.
3371 /// Normally if IsFixed(), this would contain a TypeSourceInfo*, but in
3372 /// some cases it won't.
3374 /// The underlying type of an enumeration never has any qualifiers, so
3375 /// we can get away with just storing a raw Type*, and thus save an
3376 /// extra pointer when TypeSourceInfo is needed.
3377 llvm::PointerUnion<const Type *, TypeSourceInfo *> IntegerType;
3379 /// The integer type that values of this type should
3380 /// promote to. In C, enumerators are generally of an integer type
3381 /// directly, but gcc-style large enumerators (and all enumerators
3382 /// in C++) are of the enum type instead.
3383 QualType PromotionType;
3385 /// If this enumeration is an instantiation of a member enumeration
3386 /// of a class template specialization, this is the member specialization
3388 MemberSpecializationInfo *SpecializationInfo = nullptr;
3390 /// Store the ODRHash after first calculation.
3391 /// The corresponding flag HasODRHash is in EnumDeclBits
3392 /// and can be accessed with the provided accessors.
3395 EnumDecl(ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
3396 SourceLocation IdLoc, IdentifierInfo *Id, EnumDecl *PrevDecl,
3397 bool Scoped, bool ScopedUsingClassTag, bool Fixed);
3399 void anchor() override;
3401 void setInstantiationOfMemberEnum(ASTContext &C, EnumDecl *ED,
3402 TemplateSpecializationKind TSK);
3404 /// Sets the width in bits required to store all the
3405 /// non-negative enumerators of this enum.
3406 void setNumPositiveBits(unsigned Num) {
3407 EnumDeclBits.NumPositiveBits = Num;
3408 assert(EnumDeclBits.NumPositiveBits == Num && "can't store this bitcount");
3411 /// Returns the width in bits required to store all the
3412 /// negative enumerators of this enum. (see getNumNegativeBits)
3413 void setNumNegativeBits(unsigned Num) { EnumDeclBits.NumNegativeBits = Num; }
3415 /// True if this tag declaration is a scoped enumeration. Only
3416 /// possible in C++11 mode.
3417 void setScoped(bool Scoped = true) { EnumDeclBits.IsScoped = Scoped; }
3419 /// If this tag declaration is a scoped enum,
3420 /// then this is true if the scoped enum was declared using the class
3421 /// tag, false if it was declared with the struct tag. No meaning is
3422 /// associated if this tag declaration is not a scoped enum.
3423 void setScopedUsingClassTag(bool ScopedUCT = true) {
3424 EnumDeclBits.IsScopedUsingClassTag = ScopedUCT;
3427 /// True if this is an Objective-C, C++11, or
3428 /// Microsoft-style enumeration with a fixed underlying type.
3429 void setFixed(bool Fixed = true) { EnumDeclBits.IsFixed = Fixed; }
3431 /// True if a valid hash is stored in ODRHash.
3432 bool hasODRHash() const { return EnumDeclBits.HasODRHash; }
3433 void setHasODRHash(bool Hash = true) { EnumDeclBits.HasODRHash = Hash; }
3436 friend class ASTDeclReader;
3438 EnumDecl *getCanonicalDecl() override {
3439 return cast<EnumDecl>(TagDecl::getCanonicalDecl());
3441 const EnumDecl *getCanonicalDecl() const {
3442 return const_cast<EnumDecl*>(this)->getCanonicalDecl();
3445 EnumDecl *getPreviousDecl() {
3446 return cast_or_null<EnumDecl>(
3447 static_cast<TagDecl *>(this)->getPreviousDecl());
3449 const EnumDecl *getPreviousDecl() const {
3450 return const_cast<EnumDecl*>(this)->getPreviousDecl();
3453 EnumDecl *getMostRecentDecl() {
3454 return cast<EnumDecl>(static_cast<TagDecl *>(this)->getMostRecentDecl());
3456 const EnumDecl *getMostRecentDecl() const {
3457 return const_cast<EnumDecl*>(this)->getMostRecentDecl();
3460 EnumDecl *getDefinition() const {
3461 return cast_or_null<EnumDecl>(TagDecl::getDefinition());
3464 static EnumDecl *Create(ASTContext &C, DeclContext *DC,
3465 SourceLocation StartLoc, SourceLocation IdLoc,
3466 IdentifierInfo *Id, EnumDecl *PrevDecl,
3467 bool IsScoped, bool IsScopedUsingClassTag,
3469 static EnumDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3471 /// When created, the EnumDecl corresponds to a
3472 /// forward-declared enum. This method is used to mark the
3473 /// declaration as being defined; its enumerators have already been
3474 /// added (via DeclContext::addDecl). NewType is the new underlying
3475 /// type of the enumeration type.
3476 void completeDefinition(QualType NewType,
3477 QualType PromotionType,
3478 unsigned NumPositiveBits,
3479 unsigned NumNegativeBits);
3481 // Iterates through the enumerators of this enumeration.
3482 using enumerator_iterator = specific_decl_iterator<EnumConstantDecl>;
3483 using enumerator_range =
3484 llvm::iterator_range<specific_decl_iterator<EnumConstantDecl>>;
3486 enumerator_range enumerators() const {
3487 return enumerator_range(enumerator_begin(), enumerator_end());
3490 enumerator_iterator enumerator_begin() const {
3491 const EnumDecl *E = getDefinition();
3494 return enumerator_iterator(E->decls_begin());
3497 enumerator_iterator enumerator_end() const {
3498 const EnumDecl *E = getDefinition();
3501 return enumerator_iterator(E->decls_end());
3504 /// Return the integer type that enumerators should promote to.
3505 QualType getPromotionType() const { return PromotionType; }
3507 /// Set the promotion type.
3508 void setPromotionType(QualType T) { PromotionType = T; }
3510 /// Return the integer type this enum decl corresponds to.
3511 /// This returns a null QualType for an enum forward definition with no fixed
3512 /// underlying type.
3513 QualType getIntegerType() const {
3516 if (const Type *T = IntegerType.dyn_cast<const Type*>())
3517 return QualType(T, 0);
3518 return IntegerType.get<TypeSourceInfo*>()->getType().getUnqualifiedType();
3521 /// Set the underlying integer type.
3522 void setIntegerType(QualType T) { IntegerType = T.getTypePtrOrNull(); }
3524 /// Set the underlying integer type source info.
3525 void setIntegerTypeSourceInfo(TypeSourceInfo *TInfo) { IntegerType = TInfo; }
3527 /// Return the type source info for the underlying integer type,
3528 /// if no type source info exists, return 0.
3529 TypeSourceInfo *getIntegerTypeSourceInfo() const {
3530 return IntegerType.dyn_cast<TypeSourceInfo*>();
3533 /// Retrieve the source range that covers the underlying type if
3535 SourceRange getIntegerTypeRange() const LLVM_READONLY;
3537 /// Returns the width in bits required to store all the
3538 /// non-negative enumerators of this enum.
3539 unsigned getNumPositiveBits() const { return EnumDeclBits.NumPositiveBits; }
3541 /// Returns the width in bits required to store all the
3542 /// negative enumerators of this enum. These widths include
3543 /// the rightmost leading 1; that is:
3545 /// MOST NEGATIVE ENUMERATOR PATTERN NUM NEGATIVE BITS
3546 /// ------------------------ ------- -----------------
3550 unsigned getNumNegativeBits() const { return EnumDeclBits.NumNegativeBits; }
3552 /// Returns true if this is a C++11 scoped enumeration.
3553 bool isScoped() const { return EnumDeclBits.IsScoped; }
3555 /// Returns true if this is a C++11 scoped enumeration.
3556 bool isScopedUsingClassTag() const {
3557 return EnumDeclBits.IsScopedUsingClassTag;
3560 /// Returns true if this is an Objective-C, C++11, or
3561 /// Microsoft-style enumeration with a fixed underlying type.
3562 bool isFixed() const { return EnumDeclBits.IsFixed; }
3564 unsigned getODRHash();
3566 /// Returns true if this can be considered a complete type.
3567 bool isComplete() const {
3568 // IntegerType is set for fixed type enums and non-fixed but implicitly
3569 // int-sized Microsoft enums.
3570 return isCompleteDefinition() || IntegerType;
3573 /// Returns true if this enum is either annotated with
3574 /// enum_extensibility(closed) or isn't annotated with enum_extensibility.
3575 bool isClosed() const;
3577 /// Returns true if this enum is annotated with flag_enum and isn't annotated
3578 /// with enum_extensibility(open).
3579 bool isClosedFlag() const;
3581 /// Returns true if this enum is annotated with neither flag_enum nor
3582 /// enum_extensibility(open).
3583 bool isClosedNonFlag() const;
3585 /// Retrieve the enum definition from which this enumeration could
3586 /// be instantiated, if it is an instantiation (rather than a non-template).
3587 EnumDecl *getTemplateInstantiationPattern() const;
3589 /// Returns the enumeration (declared within the template)
3590 /// from which this enumeration type was instantiated, or NULL if
3591 /// this enumeration was not instantiated from any template.
3592 EnumDecl *getInstantiatedFromMemberEnum() const;
3594 /// If this enumeration is a member of a specialization of a
3595 /// templated class, determine what kind of template specialization
3596 /// or instantiation this is.
3597 TemplateSpecializationKind getTemplateSpecializationKind() const;
3599 /// For an enumeration member that was instantiated from a member
3600 /// enumeration of a templated class, set the template specialiation kind.
3601 void setTemplateSpecializationKind(TemplateSpecializationKind TSK,
3602 SourceLocation PointOfInstantiation = SourceLocation());
3604 /// If this enumeration is an instantiation of a member enumeration of
3605 /// a class template specialization, retrieves the member specialization
3607 MemberSpecializationInfo *getMemberSpecializationInfo() const {
3608 return SpecializationInfo;
3611 /// Specify that this enumeration is an instantiation of the
3612 /// member enumeration ED.
3613 void setInstantiationOfMemberEnum(EnumDecl *ED,
3614 TemplateSpecializationKind TSK) {
3615 setInstantiationOfMemberEnum(getASTContext(), ED, TSK);
3618 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3619 static bool classofKind(Kind K) { return K == Enum; }
3622 /// Represents a struct/union/class. For example:
3623 /// struct X; // Forward declaration, no "body".
3624 /// union Y { int A, B; }; // Has body with members A and B (FieldDecls).
3625 /// This decl will be marked invalid if *any* members are invalid.
3626 class RecordDecl : public TagDecl {
3627 // This class stores some data in DeclContext::RecordDeclBits
3628 // to save some space. Use the provided accessors to access it.
3630 friend class DeclContext;
3631 /// Enum that represents the different ways arguments are passed to and
3632 /// returned from function calls. This takes into account the target-specific
3633 /// and version-specific rules along with the rules determined by the
3635 enum ArgPassingKind : unsigned {
3636 /// The argument of this type can be passed directly in registers.
3639 /// The argument of this type cannot be passed directly in registers.
3640 /// Records containing this type as a subobject are not forced to be passed
3641 /// indirectly. This value is used only in C++. This value is required by
3642 /// C++ because, in uncommon situations, it is possible for a class to have
3643 /// only trivial copy/move constructors even when one of its subobjects has
3644 /// a non-trivial copy/move constructor (if e.g. the corresponding copy/move
3645 /// constructor in the derived class is deleted).
3646 APK_CannotPassInRegs,
3648 /// The argument of this type cannot be passed directly in registers.
3649 /// Records containing this type as a subobject are forced to be passed
3651 APK_CanNeverPassInRegs
3655 RecordDecl(Kind DK, TagKind TK, const ASTContext &C, DeclContext *DC,
3656 SourceLocation StartLoc, SourceLocation IdLoc,
3657 IdentifierInfo *Id, RecordDecl *PrevDecl);
3660 static RecordDecl *Create(const ASTContext &C, TagKind TK, DeclContext *DC,
3661 SourceLocation StartLoc, SourceLocation IdLoc,
3662 IdentifierInfo *Id, RecordDecl* PrevDecl = nullptr);
3663 static RecordDecl *CreateDeserialized(const ASTContext &C, unsigned ID);
3665 RecordDecl *getPreviousDecl() {
3666 return cast_or_null<RecordDecl>(
3667 static_cast<TagDecl *>(this)->getPreviousDecl());
3669 const RecordDecl *getPreviousDecl() const {
3670 return const_cast<RecordDecl*>(this)->getPreviousDecl();
3673 RecordDecl *getMostRecentDecl() {
3674 return cast<RecordDecl>(static_cast<TagDecl *>(this)->getMostRecentDecl());
3676 const RecordDecl *getMostRecentDecl() const {
3677 return const_cast<RecordDecl*>(this)->getMostRecentDecl();
3680 bool hasFlexibleArrayMember() const {
3681 return RecordDeclBits.HasFlexibleArrayMember;
3684 void setHasFlexibleArrayMember(bool V) {
3685 RecordDeclBits.HasFlexibleArrayMember = V;
3688 /// Whether this is an anonymous struct or union. To be an anonymous
3689 /// struct or union, it must have been declared without a name and
3690 /// there must be no objects of this type declared, e.g.,
3692 /// union { int i; float f; };
3694 /// is an anonymous union but neither of the following are:
3696 /// union X { int i; float f; };
3697 /// union { int i; float f; } obj;
3699 bool isAnonymousStructOrUnion() const {
3700 return RecordDeclBits.AnonymousStructOrUnion;
3703 void setAnonymousStructOrUnion(bool Anon) {
3704 RecordDeclBits.AnonymousStructOrUnion = Anon;
3707 bool hasObjectMember() const { return RecordDeclBits.HasObjectMember; }
3708 void setHasObjectMember(bool val) { RecordDeclBits.HasObjectMember = val; }
3710 bool hasVolatileMember() const { return RecordDeclBits.HasVolatileMember; }
3712 void setHasVolatileMember(bool val) {
3713 RecordDeclBits.HasVolatileMember = val;
3716 bool hasLoadedFieldsFromExternalStorage() const {
3717 return RecordDeclBits.LoadedFieldsFromExternalStorage;
3720 void setHasLoadedFieldsFromExternalStorage(bool val) const {
3721 RecordDeclBits.LoadedFieldsFromExternalStorage = val;
3724 /// Functions to query basic properties of non-trivial C structs.
3725 bool isNonTrivialToPrimitiveDefaultInitialize() const {
3726 return RecordDeclBits.NonTrivialToPrimitiveDefaultInitialize;
3729 void setNonTrivialToPrimitiveDefaultInitialize(bool V) {
3730 RecordDeclBits.NonTrivialToPrimitiveDefaultInitialize = V;
3733 bool isNonTrivialToPrimitiveCopy() const {
3734 return RecordDeclBits.NonTrivialToPrimitiveCopy;
3737 void setNonTrivialToPrimitiveCopy(bool V) {
3738 RecordDeclBits.NonTrivialToPrimitiveCopy = V;
3741 bool isNonTrivialToPrimitiveDestroy() const {
3742 return RecordDeclBits.NonTrivialToPrimitiveDestroy;
3745 void setNonTrivialToPrimitiveDestroy(bool V) {
3746 RecordDeclBits.NonTrivialToPrimitiveDestroy = V;
3749 bool hasNonTrivialToPrimitiveDefaultInitializeCUnion() const {
3750 return RecordDeclBits.HasNonTrivialToPrimitiveDefaultInitializeCUnion;
3753 void setHasNonTrivialToPrimitiveDefaultInitializeCUnion(bool V) {
3754 RecordDeclBits.HasNonTrivialToPrimitiveDefaultInitializeCUnion = V;
3757 bool hasNonTrivialToPrimitiveDestructCUnion() const {
3758 return RecordDeclBits.HasNonTrivialToPrimitiveDestructCUnion;
3761 void setHasNonTrivialToPrimitiveDestructCUnion(bool V) {
3762 RecordDeclBits.HasNonTrivialToPrimitiveDestructCUnion = V;
3765 bool hasNonTrivialToPrimitiveCopyCUnion() const {
3766 return RecordDeclBits.HasNonTrivialToPrimitiveCopyCUnion;
3769 void setHasNonTrivialToPrimitiveCopyCUnion(bool V) {
3770 RecordDeclBits.HasNonTrivialToPrimitiveCopyCUnion = V;
3773 /// Determine whether this class can be passed in registers. In C++ mode,
3774 /// it must have at least one trivial, non-deleted copy or move constructor.
3775 /// FIXME: This should be set as part of completeDefinition.
3776 bool canPassInRegisters() const {
3777 return getArgPassingRestrictions() == APK_CanPassInRegs;
3780 ArgPassingKind getArgPassingRestrictions() const {
3781 return static_cast<ArgPassingKind>(RecordDeclBits.ArgPassingRestrictions);
3784 void setArgPassingRestrictions(ArgPassingKind Kind) {
3785 RecordDeclBits.ArgPassingRestrictions = Kind;
3788 bool isParamDestroyedInCallee() const {
3789 return RecordDeclBits.ParamDestroyedInCallee;
3792 void setParamDestroyedInCallee(bool V) {
3793 RecordDeclBits.ParamDestroyedInCallee = V;
3796 /// Determines whether this declaration represents the
3797 /// injected class name.
3799 /// The injected class name in C++ is the name of the class that
3800 /// appears inside the class itself. For example:
3804 /// // C is implicitly declared here as a synonym for the class name.
3807 /// C::C c; // same as "C c;"
3809 bool isInjectedClassName() const;
3811 /// Determine whether this record is a class describing a lambda
3812 /// function object.
3813 bool isLambda() const;
3815 /// Determine whether this record is a record for captured variables in
3816 /// CapturedStmt construct.
3817 bool isCapturedRecord() const;
3819 /// Mark the record as a record for captured variables in CapturedStmt
3821 void setCapturedRecord();
3823 /// Returns the RecordDecl that actually defines
3824 /// this struct/union/class. When determining whether or not a
3825 /// struct/union/class is completely defined, one should use this
3826 /// method as opposed to 'isCompleteDefinition'.
3827 /// 'isCompleteDefinition' indicates whether or not a specific
3828 /// RecordDecl is a completed definition, not whether or not the
3829 /// record type is defined. This method returns NULL if there is
3830 /// no RecordDecl that defines the struct/union/tag.
3831 RecordDecl *getDefinition() const {
3832 return cast_or_null<RecordDecl>(TagDecl::getDefinition());
3835 // Iterator access to field members. The field iterator only visits
3836 // the non-static data members of this class, ignoring any static
3837 // data members, functions, constructors, destructors, etc.
3838 using field_iterator = specific_decl_iterator<FieldDecl>;
3839 using field_range = llvm::iterator_range<specific_decl_iterator<FieldDecl>>;
3841 field_range fields() const { return field_range(field_begin(), field_end()); }
3842 field_iterator field_begin() const;
3844 field_iterator field_end() const {
3845 return field_iterator(decl_iterator());
3848 // Whether there are any fields (non-static data members) in this record.
3849 bool field_empty() const {
3850 return field_begin() == field_end();
3853 /// Note that the definition of this type is now complete.
3854 virtual void completeDefinition();
3856 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3857 static bool classofKind(Kind K) {
3858 return K >= firstRecord && K <= lastRecord;
3861 /// Get whether or not this is an ms_struct which can
3862 /// be turned on with an attribute, pragma, or -mms-bitfields
3863 /// commandline option.
3864 bool isMsStruct(const ASTContext &C) const;
3866 /// Whether we are allowed to insert extra padding between fields.
3867 /// These padding are added to help AddressSanitizer detect
3868 /// intra-object-overflow bugs.
3869 bool mayInsertExtraPadding(bool EmitRemark = false) const;
3871 /// Finds the first data member which has a name.
3872 /// nullptr is returned if no named data member exists.
3873 const FieldDecl *findFirstNamedDataMember() const;
3876 /// Deserialize just the fields.
3877 void LoadFieldsFromExternalStorage() const;
3880 class FileScopeAsmDecl : public Decl {
3881 StringLiteral *AsmString;
3882 SourceLocation RParenLoc;
3884 FileScopeAsmDecl(DeclContext *DC, StringLiteral *asmstring,
3885 SourceLocation StartL, SourceLocation EndL)
3886 : Decl(FileScopeAsm, DC, StartL), AsmString(asmstring), RParenLoc(EndL) {}
3888 virtual void anchor();
3891 static FileScopeAsmDecl *Create(ASTContext &C, DeclContext *DC,
3892 StringLiteral *Str, SourceLocation AsmLoc,
3893 SourceLocation RParenLoc);
3895 static FileScopeAsmDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3897 SourceLocation getAsmLoc() const { return getLocation(); }
3898 SourceLocation getRParenLoc() const { return RParenLoc; }
3899 void setRParenLoc(SourceLocation L) { RParenLoc = L; }
3900 SourceRange getSourceRange() const override LLVM_READONLY {
3901 return SourceRange(getAsmLoc(), getRParenLoc());
3904 const StringLiteral *getAsmString() const { return AsmString; }
3905 StringLiteral *getAsmString() { return AsmString; }
3906 void setAsmString(StringLiteral *Asm) { AsmString = Asm; }
3908 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
3909 static bool classofKind(Kind K) { return K == FileScopeAsm; }
3912 /// Represents a block literal declaration, which is like an
3913 /// unnamed FunctionDecl. For example:
3914 /// ^{ statement-body } or ^(int arg1, float arg2){ statement-body }
3915 class BlockDecl : public Decl, public DeclContext {
3916 // This class stores some data in DeclContext::BlockDeclBits
3917 // to save some space. Use the provided accessors to access it.
3919 /// A class which contains all the information about a particular
3927 /// The variable being captured.
3928 llvm::PointerIntPair<VarDecl*, 2> VariableAndFlags;
3930 /// The copy expression, expressed in terms of a DeclRef (or
3931 /// BlockDeclRef) to the captured variable. Only required if the
3932 /// variable has a C++ class type.
3936 Capture(VarDecl *variable, bool byRef, bool nested, Expr *copy)
3937 : VariableAndFlags(variable,
3938 (byRef ? flag_isByRef : 0) | (nested ? flag_isNested : 0)),
3941 /// The variable being captured.
3942 VarDecl *getVariable() const { return VariableAndFlags.getPointer(); }
3944 /// Whether this is a "by ref" capture, i.e. a capture of a __block
3946 bool isByRef() const { return VariableAndFlags.getInt() & flag_isByRef; }
3948 bool isEscapingByref() const {
3949 return getVariable()->isEscapingByref();
3952 bool isNonEscapingByref() const {
3953 return getVariable()->isNonEscapingByref();
3956 /// Whether this is a nested capture, i.e. the variable captured
3957 /// is not from outside the immediately enclosing function/block.
3958 bool isNested() const { return VariableAndFlags.getInt() & flag_isNested; }
3960 bool hasCopyExpr() const { return CopyExpr != nullptr; }
3961 Expr *getCopyExpr() const { return CopyExpr; }
3962 void setCopyExpr(Expr *e) { CopyExpr = e; }
3966 /// A new[]'d array of pointers to ParmVarDecls for the formal
3967 /// parameters of this function. This is null if a prototype or if there are
3969 ParmVarDecl **ParamInfo = nullptr;
3970 unsigned NumParams = 0;
3972 Stmt *Body = nullptr;
3973 TypeSourceInfo *SignatureAsWritten = nullptr;
3975 const Capture *Captures = nullptr;
3976 unsigned NumCaptures = 0;
3978 unsigned ManglingNumber = 0;
3979 Decl *ManglingContextDecl = nullptr;
3982 BlockDecl(DeclContext *DC, SourceLocation CaretLoc);
3985 static BlockDecl *Create(ASTContext &C, DeclContext *DC, SourceLocation L);
3986 static BlockDecl *CreateDeserialized(ASTContext &C, unsigned ID);
3988 SourceLocation getCaretLocation() const { return getLocation(); }
3990 bool isVariadic() const { return BlockDeclBits.IsVariadic; }
3991 void setIsVariadic(bool value) { BlockDeclBits.IsVariadic = value; }
3993 CompoundStmt *getCompoundBody() const { return (CompoundStmt*) Body; }
3994 Stmt *getBody() const override { return (Stmt*) Body; }
3995 void setBody(CompoundStmt *B) { Body = (Stmt*) B; }
3997 void setSignatureAsWritten(TypeSourceInfo *Sig) { SignatureAsWritten = Sig; }
3998 TypeSourceInfo *getSignatureAsWritten() const { return SignatureAsWritten; }
4000 // ArrayRef access to formal parameters.
4001 ArrayRef<ParmVarDecl *> parameters() const {
4002 return {ParamInfo, getNumParams()};
4004 MutableArrayRef<ParmVarDecl *> parameters() {
4005 return {ParamInfo, getNumParams()};
4008 // Iterator access to formal parameters.
4009 using param_iterator = MutableArrayRef<ParmVarDecl *>::iterator;
4010 using param_const_iterator = ArrayRef<ParmVarDecl *>::const_iterator;
4012 bool param_empty() const { return parameters().empty(); }
4013 param_iterator param_begin() { return parameters().begin(); }
4014 param_iterator param_end() { return parameters().end(); }
4015 param_const_iterator param_begin() const { return parameters().begin(); }
4016 param_const_iterator param_end() const { return parameters().end(); }
4017 size_t param_size() const { return parameters().size(); }
4019 unsigned getNumParams() const { return NumParams; }
4021 const ParmVarDecl *getParamDecl(unsigned i) const {
4022 assert(i < getNumParams() && "Illegal param #");
4023 return ParamInfo[i];
4025 ParmVarDecl *getParamDecl(unsigned i) {
4026 assert(i < getNumParams() && "Illegal param #");
4027 return ParamInfo[i];
4030 void setParams(ArrayRef<ParmVarDecl *> NewParamInfo);
4032 /// True if this block (or its nested blocks) captures
4033 /// anything of local storage from its enclosing scopes.
4034 bool hasCaptures() const { return NumCaptures || capturesCXXThis(); }
4036 /// Returns the number of captured variables.
4037 /// Does not include an entry for 'this'.
4038 unsigned getNumCaptures() const { return NumCaptures; }
4040 using capture_const_iterator = ArrayRef<Capture>::const_iterator;
4042 ArrayRef<Capture> captures() const { return {Captures, NumCaptures}; }
4044 capture_const_iterator capture_begin() const { return captures().begin(); }
4045 capture_const_iterator capture_end() const { return captures().end(); }
4047 bool capturesCXXThis() const { return BlockDeclBits.CapturesCXXThis; }
4048 void setCapturesCXXThis(bool B = true) { BlockDeclBits.CapturesCXXThis = B; }
4050 bool blockMissingReturnType() const {
4051 return BlockDeclBits.BlockMissingReturnType;
4054 void setBlockMissingReturnType(bool val = true) {
4055 BlockDeclBits.BlockMissingReturnType = val;
4058 bool isConversionFromLambda() const {
4059 return BlockDeclBits.IsConversionFromLambda;
4062 void setIsConversionFromLambda(bool val = true) {
4063 BlockDeclBits.IsConversionFromLambda = val;
4066 bool doesNotEscape() const { return BlockDeclBits.DoesNotEscape; }
4067 void setDoesNotEscape(bool B = true) { BlockDeclBits.DoesNotEscape = B; }
4069 bool canAvoidCopyToHeap() const {
4070 return BlockDeclBits.CanAvoidCopyToHeap;
4072 void setCanAvoidCopyToHeap(bool B = true) {
4073 BlockDeclBits.CanAvoidCopyToHeap = B;
4076 bool capturesVariable(const VarDecl *var) const;
4078 void setCaptures(ASTContext &Context, ArrayRef<Capture> Captures,
4079 bool CapturesCXXThis);
4081 unsigned getBlockManglingNumber() const {
4082 return ManglingNumber;
4085 Decl *getBlockManglingContextDecl() const {
4086 return ManglingContextDecl;
4089 void setBlockMangling(unsigned Number, Decl *Ctx) {
4090 ManglingNumber = Number;
4091 ManglingContextDecl = Ctx;
4094 SourceRange getSourceRange() const override LLVM_READONLY;
4096 // Implement isa/cast/dyncast/etc.
4097 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
4098 static bool classofKind(Kind K) { return K == Block; }
4099 static DeclContext *castToDeclContext(const BlockDecl *D) {
4100 return static_cast<DeclContext *>(const_cast<BlockDecl*>(D));
4102 static BlockDecl *castFromDeclContext(const DeclContext *DC) {
4103 return static_cast<BlockDecl *>(const_cast<DeclContext*>(DC));
4107 /// Represents the body of a CapturedStmt, and serves as its DeclContext.
4108 class CapturedDecl final
4111 private llvm::TrailingObjects<CapturedDecl, ImplicitParamDecl *> {
4113 size_t numTrailingObjects(OverloadToken<ImplicitParamDecl>) {
4118 /// The number of parameters to the outlined function.
4121 /// The position of context parameter in list of parameters.
4122 unsigned ContextParam;
4124 /// The body of the outlined function.
4125 llvm::PointerIntPair<Stmt *, 1, bool> BodyAndNothrow;
4127 explicit CapturedDecl(DeclContext *DC, unsigned NumParams);
4129 ImplicitParamDecl *const *getParams() const {
4130 return getTrailingObjects<ImplicitParamDecl *>();
4133 ImplicitParamDecl **getParams() {
4134 return getTrailingObjects<ImplicitParamDecl *>();
4138 friend class ASTDeclReader;
4139 friend class ASTDeclWriter;
4140 friend TrailingObjects;
4142 static CapturedDecl *Create(ASTContext &C, DeclContext *DC,
4143 unsigned NumParams);
4144 static CapturedDecl *CreateDeserialized(ASTContext &C, unsigned ID,
4145 unsigned NumParams);
4147 Stmt *getBody() const override;
4148 void setBody(Stmt *B);
4150 bool isNothrow() const;
4151 void setNothrow(bool Nothrow = true);
4153 unsigned getNumParams() const { return NumParams; }
4155 ImplicitParamDecl *getParam(unsigned i) const {
4156 assert(i < NumParams);
4157 return getParams()[i];
4159 void setParam(unsigned i, ImplicitParamDecl *P) {
4160 assert(i < NumParams);
4164 // ArrayRef interface to parameters.
4165 ArrayRef<ImplicitParamDecl *> parameters() const {
4166 return {getParams(), getNumParams()};
4168 MutableArrayRef<ImplicitParamDecl *> parameters() {
4169 return {getParams(), getNumParams()};
4172 /// Retrieve the parameter containing captured variables.
4173 ImplicitParamDecl *getContextParam() const {
4174 assert(ContextParam < NumParams);
4175 return getParam(ContextParam);
4177 void setContextParam(unsigned i, ImplicitParamDecl *P) {
4178 assert(i < NumParams);
4182 unsigned getContextParamPosition() const { return ContextParam; }
4184 using param_iterator = ImplicitParamDecl *const *;
4185 using param_range = llvm::iterator_range<param_iterator>;
4187 /// Retrieve an iterator pointing to the first parameter decl.
4188 param_iterator param_begin() const { return getParams(); }
4189 /// Retrieve an iterator one past the last parameter decl.
4190 param_iterator param_end() const { return getParams() + NumParams; }
4192 // Implement isa/cast/dyncast/etc.
4193 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
4194 static bool classofKind(Kind K) { return K == Captured; }
4195 static DeclContext *castToDeclContext(const CapturedDecl *D) {
4196 return static_cast<DeclContext *>(const_cast<CapturedDecl *>(D));
4198 static CapturedDecl *castFromDeclContext(const DeclContext *DC) {
4199 return static_cast<CapturedDecl *>(const_cast<DeclContext *>(DC));
4203 /// Describes a module import declaration, which makes the contents
4204 /// of the named module visible in the current translation unit.
4206 /// An import declaration imports the named module (or submodule). For example:
4208 /// @import std.vector;
4211 /// Import declarations can also be implicitly generated from
4212 /// \#include/\#import directives.
4213 class ImportDecl final : public Decl,
4214 llvm::TrailingObjects<ImportDecl, SourceLocation> {
4215 friend class ASTContext;
4216 friend class ASTDeclReader;
4217 friend class ASTReader;
4218 friend TrailingObjects;
4220 /// The imported module, along with a bit that indicates whether
4221 /// we have source-location information for each identifier in the module
4224 /// When the bit is false, we only have a single source location for the
4225 /// end of the import declaration.
4226 llvm::PointerIntPair<Module *, 1, bool> ImportedAndComplete;
4228 /// The next import in the list of imports local to the translation
4229 /// unit being parsed (not loaded from an AST file).
4230 ImportDecl *NextLocalImport = nullptr;
4232 ImportDecl(DeclContext *DC, SourceLocation StartLoc, Module *Imported,
4233 ArrayRef<SourceLocation> IdentifierLocs);
4235 ImportDecl(DeclContext *DC, SourceLocation StartLoc, Module *Imported,
4236 SourceLocation EndLoc);
4238 ImportDecl(EmptyShell Empty) : Decl(Import, Empty) {}
4241 /// Create a new module import declaration.
4242 static ImportDecl *Create(ASTContext &C, DeclContext *DC,
4243 SourceLocation StartLoc, Module *Imported,
4244 ArrayRef<SourceLocation> IdentifierLocs);
4246 /// Create a new module import declaration for an implicitly-generated
4248 static ImportDecl *CreateImplicit(ASTContext &C, DeclContext *DC,
4249 SourceLocation StartLoc, Module *Imported,
4250 SourceLocation EndLoc);
4252 /// Create a new, deserialized module import declaration.
4253 static ImportDecl *CreateDeserialized(ASTContext &C, unsigned ID,
4254 unsigned NumLocations);
4256 /// Retrieve the module that was imported by the import declaration.
4257 Module *getImportedModule() const { return ImportedAndComplete.getPointer(); }
4259 /// Retrieves the locations of each of the identifiers that make up
4260 /// the complete module name in the import declaration.
4262 /// This will return an empty array if the locations of the individual
4263 /// identifiers aren't available.
4264 ArrayRef<SourceLocation> getIdentifierLocs() const;
4266 SourceRange getSourceRange() const override LLVM_READONLY;
4268 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
4269 static bool classofKind(Kind K) { return K == Import; }
4272 /// Represents a C++ Modules TS module export declaration.
4276 /// export void foo();
4278 class ExportDecl final : public Decl, public DeclContext {
4279 virtual void anchor();
4282 friend class ASTDeclReader;
4284 /// The source location for the right brace (if valid).
4285 SourceLocation RBraceLoc;
4287 ExportDecl(DeclContext *DC, SourceLocation ExportLoc)
4288 : Decl(Export, DC, ExportLoc), DeclContext(Export),
4289 RBraceLoc(SourceLocation()) {}
4292 static ExportDecl *Create(ASTContext &C, DeclContext *DC,
4293 SourceLocation ExportLoc);
4294 static ExportDecl *CreateDeserialized(ASTContext &C, unsigned ID);
4296 SourceLocation getExportLoc() const { return getLocation(); }
4297 SourceLocation getRBraceLoc() const { return RBraceLoc; }
4298 void setRBraceLoc(SourceLocation L) { RBraceLoc = L; }
4300 bool hasBraces() const { return RBraceLoc.isValid(); }
4302 SourceLocation getEndLoc() const LLVM_READONLY {
4305 // No braces: get the end location of the (only) declaration in context
4307 return decls_empty() ? getLocation() : decls_begin()->getEndLoc();
4310 SourceRange getSourceRange() const override LLVM_READONLY {
4311 return SourceRange(getLocation(), getEndLoc());
4314 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
4315 static bool classofKind(Kind K) { return K == Export; }
4316 static DeclContext *castToDeclContext(const ExportDecl *D) {
4317 return static_cast<DeclContext *>(const_cast<ExportDecl*>(D));
4319 static ExportDecl *castFromDeclContext(const DeclContext *DC) {
4320 return static_cast<ExportDecl *>(const_cast<DeclContext*>(DC));
4324 /// Represents an empty-declaration.
4325 class EmptyDecl : public Decl {
4326 EmptyDecl(DeclContext *DC, SourceLocation L) : Decl(Empty, DC, L) {}
4328 virtual void anchor();
4331 static EmptyDecl *Create(ASTContext &C, DeclContext *DC,
4333 static EmptyDecl *CreateDeserialized(ASTContext &C, unsigned ID);
4335 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
4336 static bool classofKind(Kind K) { return K == Empty; }
4339 /// Insertion operator for diagnostics. This allows sending NamedDecl's
4340 /// into a diagnostic with <<.
4341 inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
4342 const NamedDecl* ND) {
4343 DB.AddTaggedVal(reinterpret_cast<intptr_t>(ND),
4344 DiagnosticsEngine::ak_nameddecl);
4347 inline const PartialDiagnostic &operator<<(const PartialDiagnostic &PD,
4348 const NamedDecl* ND) {
4349 PD.AddTaggedVal(reinterpret_cast<intptr_t>(ND),
4350 DiagnosticsEngine::ak_nameddecl);
4354 template<typename decl_type>
4355 void Redeclarable<decl_type>::setPreviousDecl(decl_type *PrevDecl) {
4356 // Note: This routine is implemented here because we need both NamedDecl
4357 // and Redeclarable to be defined.
4358 assert(RedeclLink.isFirst() &&
4359 "setPreviousDecl on a decl already in a redeclaration chain");
4362 // Point to previous. Make sure that this is actually the most recent
4363 // redeclaration, or we can build invalid chains. If the most recent
4364 // redeclaration is invalid, it won't be PrevDecl, but we want it anyway.
4365 First = PrevDecl->getFirstDecl();
4366 assert(First->RedeclLink.isFirst() && "Expected first");
4367 decl_type *MostRecent = First->getNextRedeclaration();
4368 RedeclLink = PreviousDeclLink(cast<decl_type>(MostRecent));
4370 // If the declaration was previously visible, a redeclaration of it remains
4371 // visible even if it wouldn't be visible by itself.
4372 static_cast<decl_type*>(this)->IdentifierNamespace |=
4373 MostRecent->getIdentifierNamespace() &
4374 (Decl::IDNS_Ordinary | Decl::IDNS_Tag | Decl::IDNS_Type);
4377 First = static_cast<decl_type*>(this);
4380 // First one will point to this one as latest.
4381 First->RedeclLink.setLatest(static_cast<decl_type*>(this));
4383 assert(!isa<NamedDecl>(static_cast<decl_type*>(this)) ||
4384 cast<NamedDecl>(static_cast<decl_type*>(this))->isLinkageValid());
4387 // Inline function definitions.
4389 /// Check if the given decl is complete.
4391 /// We use this function to break a cycle between the inline definitions in
4392 /// Type.h and Decl.h.
4393 inline bool IsEnumDeclComplete(EnumDecl *ED) {
4394 return ED->isComplete();
4397 /// Check if the given decl is scoped.
4399 /// We use this function to break a cycle between the inline definitions in
4400 /// Type.h and Decl.h.
4401 inline bool IsEnumDeclScoped(EnumDecl *ED) {
4402 return ED->isScoped();
4405 } // namespace clang
4407 #endif // LLVM_CLANG_AST_DECL_H