clang 22.0.0git
clang::FunctionDecl Class Reference

Represents a function declaration or definition. More...

#include "clang/AST/Decl.h"

Inheritance diagram for clang::FunctionDecl:
[legend]

Classes

class  DefaultedOrDeletedFunctionInfo
 Stashed information about a defaulted/deleted function body. More...

Public Types

enum  TemplatedKind {
  TK_NonTemplate , TK_FunctionTemplate , TK_MemberSpecialization , TK_FunctionTemplateSpecialization ,
  TK_DependentFunctionTemplateSpecialization , TK_DependentNonTemplate
}
 The kind of templated function a FunctionDecl can be. More...
using redecl_range = redeclarable_base::redecl_range
using redecl_iterator = redeclarable_base::redecl_iterator
using param_iterator = MutableArrayRef<ParmVarDecl *>::iterator
using param_const_iterator = ArrayRef<ParmVarDecl *>::const_iterator
Public Types inherited from clang::NamedDecl
enum  ExplicitVisibilityKind { VisibilityForType , VisibilityForValue }
 Kinds of explicit visibility. More...
Public Types inherited from clang::Decl
enum  Kind
 Lists the kind of concrete classes of Decl. More...
enum  IdentifierNamespace {
  IDNS_Label = 0x0001 , IDNS_Tag = 0x0002 , IDNS_Type = 0x0004 , IDNS_Member = 0x0008 ,
  IDNS_Namespace = 0x0010 , IDNS_Ordinary = 0x0020 , IDNS_ObjCProtocol = 0x0040 , IDNS_OrdinaryFriend = 0x0080 ,
  IDNS_TagFriend = 0x0100 , IDNS_Using = 0x0200 , IDNS_NonMemberOperator = 0x0400 , IDNS_LocalExtern = 0x0800 ,
  IDNS_OMPReduction = 0x1000 , IDNS_OMPMapper = 0x2000
}
 IdentifierNamespace - The different namespaces in which declarations may appear. More...
enum  ObjCDeclQualifier {
  OBJC_TQ_None = 0x0 , OBJC_TQ_In = 0x1 , OBJC_TQ_Inout = 0x2 , OBJC_TQ_Out = 0x4 ,
  OBJC_TQ_Bycopy = 0x8 , OBJC_TQ_Byref = 0x10 , OBJC_TQ_Oneway = 0x20 , OBJC_TQ_CSNullability = 0x40
}
 ObjCDeclQualifier - 'Qualifiers' written next to the return and parameter types in method declarations. More...
enum class  ModuleOwnershipKind : unsigned char {
  Unowned , Visible , VisibleWhenImported , ReachableWhenImported ,
  ModulePrivate
}
 The kind of ownership a declaration has, for visibility purposes. More...
enum  FriendObjectKind { FOK_None , FOK_Declared , FOK_Undeclared }
using attr_iterator = AttrVec::const_iterator
using attr_range = llvm::iterator_range<attr_iterator>
using redecl_range = llvm::iterator_range<redecl_iterator>
Public Types inherited from clang::DeclContext
using decl_range = llvm::iterator_range<decl_iterator>
using lookup_result = DeclContextLookupResult
using lookup_iterator = lookup_result::iterator
using lookups_range = llvm::iterator_range<all_lookups_iterator>
using udir_iterator_base
using udir_range = llvm::iterator_range<udir_iterator>
using ddiag_range = llvm::iterator_range<DeclContext::ddiag_iterator>
Public Types inherited from clang::Redeclarable< FunctionDecl >
using redecl_range

Public Member Functions

DeclarationNameInfo getNameInfo () const
void getNameForDiagnostic (raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const override
 Appends a human-readable name for this declaration into the given stream.
void setRangeEnd (SourceLocation E)
void setDeclarationNameLoc (DeclarationNameLoc L)
SourceLocation getEllipsisLoc () const
 Returns the location of the ellipsis of a variadic function.
SourceRange getSourceRange () const override LLVM_READONLY
 Source range that this declaration covers.
bool hasBody (const FunctionDecl *&Definition) const
 Returns true if the function has a body.
bool hasBody () const override
 Returns true if this Decl represents a declaration for a body of code, such as a function or method definition.
bool hasTrivialBody () const
 Returns whether the function has a trivial body that does not require any specific codegen.
bool isDefined (const FunctionDecl *&Definition, bool CheckForPendingFriendDefinition=false) const
 Returns true if the function has a definition that does not need to be instantiated.
bool isDefined () const
FunctionDeclgetDefinition ()
 Get the definition for this declaration.
const FunctionDeclgetDefinition () const
StmtgetBody (const FunctionDecl *&Definition) const
 Retrieve the body (definition) of the function.
StmtgetBody () const override
 getBody - If this Decl represents a declaration for a body of code, such as a function or method definition, this method returns the top-level Stmt* of that body.
bool isThisDeclarationADefinition () const
 Returns whether this specific declaration of the function is also a definition that does not contain uninstantiated body.
bool isThisDeclarationInstantiatedFromAFriendDefinition () const
 Determine whether this specific declaration of the function is a friend declaration that was instantiated from a function definition.
bool doesThisDeclarationHaveABody () const
 Returns whether this specific declaration of the function has a body.
void setBody (Stmt *B)
void setLazyBody (uint64_t Offset)
void setDefaultedOrDeletedInfo (DefaultedOrDeletedFunctionInfo *Info)
DefaultedOrDeletedFunctionInfogetDefalutedOrDeletedInfo () const
bool isVariadic () const
 Whether this function is variadic.
bool isVirtualAsWritten () const
 Whether this function is marked as virtual explicitly.
void setVirtualAsWritten (bool V)
 State that this function is marked as virtual explicitly.
bool isPureVirtual () const
 Whether this virtual function is pure, i.e.
void setIsPureVirtual (bool P=true)
bool isLateTemplateParsed () const
 Whether this templated function will be late parsed.
void setLateTemplateParsed (bool ILT=true)
 State that this templated function will be late parsed.
bool isInstantiatedFromMemberTemplate () const
void setInstantiatedFromMemberTemplate (bool Val=true)
bool isTrivial () const
 Whether this function is "trivial" in some specialized C++ senses.
void setTrivial (bool IT)
bool isTrivialForCall () const
void setTrivialForCall (bool IT)
bool isDefaulted () const
 Whether this function is defaulted.
void setDefaulted (bool D=true)
bool isExplicitlyDefaulted () const
 Whether this function is explicitly defaulted.
void setExplicitlyDefaulted (bool ED=true)
 State that this function is explicitly defaulted.
SourceLocation getDefaultLoc () const
void setDefaultLoc (SourceLocation NewLoc)
bool isUserProvided () const
 True if this method is user-declared and was not deleted or defaulted on its first declaration.
bool isIneligibleOrNotSelected () const
void setIneligibleOrNotSelected (bool II)
bool hasImplicitReturnZero () const
 Whether falling off this function implicitly returns null/zero.
void setHasImplicitReturnZero (bool IRZ)
 State that falling off this function implicitly returns null/zero.
bool hasPrototype () const
 Whether this function has a prototype, either because one was explicitly written or because it was "inherited" by merging a declaration without a prototype with a declaration that has a prototype.
bool hasWrittenPrototype () const
 Whether this function has a written prototype.
void setHasWrittenPrototype (bool P=true)
 State that this function has a written prototype.
bool hasInheritedPrototype () const
 Whether this function inherited its prototype from a previous declaration.
void setHasInheritedPrototype (bool P=true)
 State that this function inherited its prototype from a previous declaration.
bool isConstexpr () const
 Whether this is a (C++11) constexpr function or constexpr constructor.
void setConstexprKind (ConstexprSpecKind CSK)
ConstexprSpecKind getConstexprKind () const
bool isConstexprSpecified () const
bool isConsteval () const
void setBodyContainsImmediateEscalatingExpressions (bool Set)
bool BodyContainsImmediateEscalatingExpressions () const
bool isImmediateEscalating () const
bool isImmediateFunction () const
bool instantiationIsPending () const
 Whether the instantiation of this function is pending.
void setInstantiationIsPending (bool IC)
 State that the instantiation of this function is pending.
bool usesSEHTry () const
 Indicates the function uses __try.
void setUsesSEHTry (bool UST)
bool isDeleted () const
 Whether this function has been deleted.
bool isDeletedAsWritten () const
void setDeletedAsWritten (bool D=true, StringLiteral *Message=nullptr)
bool isMain () const
 Determines whether this function is "main", which is the entry point into an executable program.
bool isMSVCRTEntryPoint () const
 Determines whether this function is a MSVCRT user defined entry point.
bool isReservedGlobalPlacementOperator () const
 Determines whether this operator new or delete is one of the reserved global placement operators: void *operator new(size_t, void *); void *operator new[](size_t, void *); void operator delete(void *, void *); void operator delete[](void *, void *); These functions have special behavior under [new.delete.placement]: These functions are reserved, a C++ program may not define functions that displace the versions in the Standard C++ library.
bool isReplaceableGlobalAllocationFunction (UnsignedOrNone *AlignmentParam=nullptr, bool *IsNothrow=nullptr) const
 Determines whether this function is one of the replaceable global allocation functions: void *operator new(size_t); void *operator new(size_t, const std::nothrow_t &) noexcept; void *operator new[](size_t); void *operator new[](size_t, const std::nothrow_t &) noexcept; void operator delete(void *) noexcept; void operator delete(void *, std::size_t) noexcept; [C++1y] void operator delete(void *, const std::nothrow_t &) noexcept; void operator delete[](void *) noexcept; void operator delete[](void *, std::size_t) noexcept; [C++1y] void operator delete[](void *, const std::nothrow_t &) noexcept; These functions have special behavior under C++1y [expr.new]: An implementation is allowed to omit a call to a replaceable global allocation function.
bool isUsableAsGlobalAllocationFunctionInConstantEvaluation (UnsignedOrNone *AlignmentParam=nullptr, bool *IsNothrow=nullptr) const
 Determines whether this function is one of the replaceable global allocation functions described in isReplaceableGlobalAllocationFunction, or is a function that may be treated as such during constant evaluation.
bool isInlineBuiltinDeclaration () const
 Determine if this function provides an inline implementation of a builtin.
bool isDestroyingOperatorDelete () const
 Determine whether this is a destroying operator delete.
void setIsDestroyingOperatorDelete (bool IsDestroyingDelete)
bool isTypeAwareOperatorNewOrDelete () const
 Determine whether this is a type aware operator new or delete.
void setIsTypeAwareOperatorNewOrDelete (bool IsTypeAwareOperator=true)
LanguageLinkage getLanguageLinkage () const
 Compute the language linkage.
bool isExternC () const
 Determines whether this function is a function with external, C linkage.
bool isInExternCContext () const
 Determines whether this function's context is, or is nested within, a C++ extern "C" linkage spec.
bool isInExternCXXContext () const
 Determines whether this function's context is, or is nested within, a C++ extern "C++" linkage spec.
bool isGlobal () const
 Determines whether this is a global function.
bool isNoReturn () const
 Determines whether this function is known to be 'noreturn', through an attribute on its declaration or its type.
bool isAnalyzerNoReturn () const
 Determines whether this function is known to be 'noreturn' for analyzer, through an analyzer_noreturn attribute on its declaration.
bool hasSkippedBody () const
 True if the function was a definition but its body was skipped.
void setHasSkippedBody (bool Skipped=true)
bool willHaveBody () const
 True if this function will eventually have a body, once it's fully parsed.
void setWillHaveBody (bool V=true)
bool isMultiVersion () const
 True if this function is considered a multiversioned function.
void setIsMultiVersion (bool V=true)
 Sets the multiversion state for this declaration and all of its redeclarations.
void setFriendConstraintRefersToEnclosingTemplate (bool V=true)
bool FriendConstraintRefersToEnclosingTemplate () const
bool isMemberLikeConstrainedFriend () const
 Determine whether a function is a friend function that cannot be redeclared outside of its class, per C++ [temp.friend]p9.
MultiVersionKind getMultiVersionKind () const
 Gets the kind of multiversioning attribute this declaration has.
bool isCPUDispatchMultiVersion () const
 True if this function is a multiversioned dispatch function as a part of the cpu_specific/cpu_dispatch functionality.
bool isCPUSpecificMultiVersion () const
 True if this function is a multiversioned processor specific function as a part of the cpu_specific/cpu_dispatch functionality.
bool isTargetMultiVersion () const
 True if this function is a multiversioned dispatch function as a part of the target functionality.
bool isTargetMultiVersionDefault () const
 True if this function is the default version of a multiversioned dispatch function as a part of the target functionality.
bool isTargetClonesMultiVersion () const
 True if this function is a multiversioned dispatch function as a part of the target-clones functionality.
bool isTargetVersionMultiVersion () const
 True if this function is a multiversioned dispatch function as a part of the target-version functionality.
void getAssociatedConstraints (SmallVectorImpl< AssociatedConstraint > &ACs) const
 Get the associated-constraints of this function declaration.
StringLiteralgetDeletedMessage () const
 Get the message that indicates why this function was deleted.
void setPreviousDeclaration (FunctionDecl *PrevDecl)
FunctionDeclgetCanonicalDecl () override
 Retrieves the "canonical" declaration of the given declaration.
const FunctionDeclgetCanonicalDecl () const
unsigned getBuiltinID (bool ConsiderWrapperFunctions=false) const
 Returns a value indicating whether this function corresponds to a builtin function.
ArrayRef< ParmVarDecl * > parameters () const
MutableArrayRef< ParmVarDecl * > parameters ()
bool param_empty () const
param_iterator param_begin ()
param_iterator param_end ()
param_const_iterator param_begin () const
param_const_iterator param_end () const
size_t param_size () const
unsigned getNumParams () const
 Return the number of parameters this function must have based on its FunctionType.
const ParmVarDeclgetParamDecl (unsigned i) const
ParmVarDeclgetParamDecl (unsigned i)
void setParams (ArrayRef< ParmVarDecl * > NewParamInfo)
unsigned getMinRequiredArguments () const
 Returns the minimum number of arguments needed to call this function.
unsigned getMinRequiredExplicitArguments () const
 Returns the minimum number of non-object arguments needed to call this function.
bool hasCXXExplicitFunctionObjectParameter () const
unsigned getNumNonObjectParams () const
const ParmVarDeclgetNonObjectParameter (unsigned I) const
ParmVarDeclgetNonObjectParameter (unsigned I)
bool hasOneParamOrDefaultArgs () const
 Determine whether this function has a single parameter, or multiple parameters where all but the first have default arguments.
FunctionTypeLoc getFunctionTypeLoc () const
 Find the source location information for how the type of this function was written.
QualType getReturnType () const
SourceRange getReturnTypeSourceRange () const
 Attempt to compute an informative source range covering the function return type.
SourceRange getParametersSourceRange () const
 Attempt to compute an informative source range covering the function parameters, including the ellipsis of a variadic function.
QualType getDeclaredReturnType () const
 Get the declared return type, which may differ from the actual return type if the return type is deduced.
ExceptionSpecificationType getExceptionSpecType () const
 Gets the ExceptionSpecificationType as declared.
SourceRange getExceptionSpecSourceRange () const
 Attempt to compute an informative source range covering the function exception specification, if any.
QualType getCallResultType () const
 Determine the type of an expression that calls this function.
StorageClass getStorageClass () const
 Returns the storage class as written in the source.
void setStorageClass (StorageClass SClass)
 Sets the storage class as written in the source.
bool isInlineSpecified () const
 Determine whether the "inline" keyword was specified for this function.
void setInlineSpecified (bool I)
 Set whether the "inline" keyword was specified for this function.
bool UsesFPIntrin () const
 Determine whether the function was declared in source context that requires constrained FP intrinsics.
void setUsesFPIntrin (bool I)
 Set whether the function was declared in source context that requires constrained FP intrinsics.
void setImplicitlyInline (bool I=true)
 Flag that this function is implicitly inline.
bool isInlined () const
 Determine whether this function should be inlined, because it is either marked "inline" or "constexpr" or is a member function of a class that was defined in the class body.
bool isInlineDefinitionExternallyVisible () const
 For an inline function definition in C, or for a gnu_inline function in C++, determine whether the definition will be externally visible.
bool isMSExternInline () const
 The combination of the extern and inline keywords under MSVC forces the function to be required.
bool doesDeclarationForceExternallyVisibleDefinition () const
 For a function declaration in C or C++, determine whether this declaration causes the definition to be externally visible.
bool isStatic () const
bool isOverloadedOperator () const
 Whether this function declaration represents an C++ overloaded operator, e.g., "operator+".
OverloadedOperatorKind getOverloadedOperator () const
 getOverloadedOperator - Which C++ overloaded operator this function represents, if any.
const IdentifierInfogetLiteralIdentifier () const
 getLiteralIdentifier - The literal suffix identifier this function represents, if any.
FunctionDeclgetInstantiatedFromMemberFunction () const
 If this function is an instantiation of a member function of a class template specialization, retrieves the function from which it was instantiated.
TemplatedKind getTemplatedKind () const
 What kind of templated function this is.
MemberSpecializationInfogetMemberSpecializationInfo () const
 If this function is an instantiation of a member function of a class template specialization, retrieves the member specialization information.
void setInstantiationOfMemberFunction (FunctionDecl *FD, TemplateSpecializationKind TSK)
 Specify that this record is an instantiation of the member function FD.
void setInstantiatedFromDecl (FunctionDecl *FD)
 Specify that this function declaration was instantiated from a FunctionDecl FD.
FunctionDeclgetInstantiatedFromDecl () const
FunctionTemplateDeclgetDescribedFunctionTemplate () const
 Retrieves the function template that is described by this function declaration.
void setDescribedFunctionTemplate (FunctionTemplateDecl *Template)
bool isFunctionTemplateSpecialization () const
 Determine whether this function is a function template specialization.
FunctionTemplateSpecializationInfogetTemplateSpecializationInfo () const
 If this function is actually a function template specialization, retrieve information about this function template specialization.
bool isImplicitlyInstantiable () const
 Determines whether this function is a function template specialization or a member of a class template specialization that can be implicitly instantiated.
bool isTemplateInstantiation () const
 Determines if the given function was instantiated from a function template.
FunctionDeclgetTemplateInstantiationPattern (bool ForDefinition=true) const
 Retrieve the function declaration from which this function could be instantiated, if it is an instantiation (rather than a non-template or a specialization, for example).
FunctionTemplateDeclgetPrimaryTemplate () const
 Retrieve the primary template that this function template specialization either specializes or was instantiated from.
const TemplateArgumentListgetTemplateSpecializationArgs () const
 Retrieve the template arguments used to produce this function template specialization from the primary template.
const ASTTemplateArgumentListInfogetTemplateSpecializationArgsAsWritten () const
 Retrieve the template argument list as written in the sources, if any.
void setFunctionTemplateSpecialization (FunctionTemplateDecl *Template, TemplateArgumentList *TemplateArgs, void *InsertPos, TemplateSpecializationKind TSK=TSK_ImplicitInstantiation, TemplateArgumentListInfo *TemplateArgsAsWritten=nullptr, SourceLocation PointOfInstantiation=SourceLocation())
 Specify that this function declaration is actually a function template specialization.
void setDependentTemplateSpecialization (ASTContext &Context, const UnresolvedSetImpl &Templates, const TemplateArgumentListInfo *TemplateArgs)
 Specifies that this function declaration is actually a dependent function template specialization.
DependentFunctionTemplateSpecializationInfogetDependentSpecializationInfo () const
TemplateSpecializationKind getTemplateSpecializationKind () const
 Determine what kind of template instantiation this function represents.
TemplateSpecializationKind getTemplateSpecializationKindForInstantiation () const
 Determine the kind of template specialization this function represents for the purpose of template instantiation.
void setTemplateSpecializationKind (TemplateSpecializationKind TSK, SourceLocation PointOfInstantiation=SourceLocation())
 Determine what kind of template instantiation this function represents.
SourceLocation getPointOfInstantiation () const
 Retrieve the (first) point of instantiation of a function template specialization or a member of a class template specialization.
bool isOutOfLine () const override
 Determine whether this is or was instantiated from an out-of-line definition of a member function.
unsigned getMemoryFunctionKind () const
 Identify a memory copying or setting function.
unsigned getODRHash ()
 Returns ODRHash of the function.
unsigned getODRHash () const
 Returns cached ODRHash of the function.
FunctionEffectsRef getFunctionEffects () const
bool isReferenceableKernel () const
redecl_iterator redecls_begin () const
redecl_iterator redecls_end () const
redecl_range redecls () const
 Returns an iterator range for all the redeclarations of the same decl.
FunctionDeclgetPreviousDecl ()
 Return the previous declaration of this declaration or NULL if this is the first declaration.
const FunctionDeclgetPreviousDecl () const
FunctionDeclgetMostRecentDecl ()
 Returns the most recent (re)declaration of this declaration.
const FunctionDeclgetMostRecentDecl () const
 Returns the most recent (re)declaration of this declaration.
bool isFirstDecl () const
 True if this is the first declaration in its redeclaration chain.
Public Member Functions inherited from clang::DeclaratorDecl
TypeSourceInfogetTypeSourceInfo () const
void setTypeSourceInfo (TypeSourceInfo *TI)
SourceLocation getInnerLocStart () const
 Return start of source range ignoring outer template declarations.
void setInnerLocStart (SourceLocation L)
SourceLocation getOuterLocStart () const
 Return start of source range taking into account any outer template declarations.
SourceLocation getBeginLoc () const LLVM_READONLY
NestedNameSpecifier getQualifier () const
 Retrieve the nested-name-specifier that qualifies the name of this declaration, if it was present in the source.
NestedNameSpecifierLoc getQualifierLoc () const
 Retrieve the nested-name-specifier (with source-location information) that qualifies the name of this declaration, if it was present in the source.
void setQualifierInfo (NestedNameSpecifierLoc QualifierLoc)
const AssociatedConstraintgetTrailingRequiresClause () const
 Get the constraint-expression introduced by the trailing requires-clause in the function/member declaration, or null if no requires-clause was provided.
void setTrailingRequiresClause (const AssociatedConstraint &AC)
unsigned getNumTemplateParameterLists () const
TemplateParameterListgetTemplateParameterList (unsigned index) const
void setTemplateParameterListsInfo (ASTContext &Context, ArrayRef< TemplateParameterList * > TPLists)
SourceLocation getTypeSpecStartLoc () const
SourceLocation getTypeSpecEndLoc () const
Public Member Functions inherited from clang::ValueDecl
QualType getType () const
void setType (QualType newType)
bool isWeak () const
 Determine whether this symbol is weakly-imported, or declared with the weak or weak-ref attr.
bool isInitCapture () const
 Whether this variable is the implicit variable for a lambda init-capture.
VarDeclgetPotentiallyDecomposedVarDecl ()
const VarDeclgetPotentiallyDecomposedVarDecl () const
bool isParameterPack () const
 Determine whether this value is actually a function parameter pack, init-capture pack, or structured binding pack.
Public Member Functions inherited from clang::NamedDecl
IdentifierInfogetIdentifier () const
 Get the identifier that names this declaration, if there is one.
StringRef getName () const
 Get the name of identifier for this declaration as a StringRef.
std::string getNameAsString () const
 Get a human-readable name for the declaration, even if it is one of the special kinds of names (C++ constructor, Objective-C selector, etc).
virtual void printName (raw_ostream &OS, const PrintingPolicy &Policy) const
 Pretty-print the unqualified name of this declaration.
void printName (raw_ostream &OS) const
 Calls printName() with the ASTContext printing policy from the decl.
DeclarationName getDeclName () const
 Get the actual, stored name of the declaration, which may be a special name.
void setDeclName (DeclarationName N)
 Set the name of this declaration.
void printQualifiedName (raw_ostream &OS) const
 Returns a human-readable qualified name for this declaration, like A::B::i, for i being member of namespace A::B.
void printQualifiedName (raw_ostream &OS, const PrintingPolicy &Policy) const
void printNestedNameSpecifier (raw_ostream &OS) const
 Print only the nested name specifier part of a fully-qualified name, including the '::' at the end.
void printNestedNameSpecifier (raw_ostream &OS, const PrintingPolicy &Policy) const
std::string getQualifiedNameAsString () const
bool declarationReplaces (const NamedDecl *OldD, bool IsKnownNewer=true) const
 Determine whether this declaration, if known to be well-formed within its context, will replace the declaration OldD if introduced into scope.
bool hasLinkage () const
 Determine whether this declaration has linkage.
bool isCXXClassMember () const
 Determine whether this declaration is a C++ class member.
bool isCXXInstanceMember () const
 Determine whether the given declaration is an instance member of a C++ class.
ReservedIdentifierStatus isReserved (const LangOptions &LangOpts) const
 Determine if the declaration obeys the reserved identifier rules of the given language.
Linkage getLinkageInternal () const
 Determine what kind of linkage this entity has.
Linkage getFormalLinkage () const
 Get the linkage from a semantic point of view.
bool hasExternalFormalLinkage () const
 True if this decl has external linkage.
bool isExternallyVisible () const
bool isExternallyDeclarable () const
 Determine whether this declaration can be redeclared in a different translation unit.
Visibility getVisibility () const
 Determines the visibility of this entity.
LinkageInfo getLinkageAndVisibility () const
 Determines the linkage and visibility of this entity.
std::optional< VisibilitygetExplicitVisibility (ExplicitVisibilityKind kind) const
 If visibility was explicitly specified for this declaration, return that visibility.
bool isLinkageValid () const
 True if the computed linkage is valid.
bool hasLinkageBeenComputed () const
 True if something has required us to compute the linkage of this declaration.
bool isPlaceholderVar (const LangOptions &LangOpts) const
NamedDeclgetUnderlyingDecl ()
 Looks through UsingDecls and ObjCCompatibleAliasDecls for the underlying named decl.
const NamedDeclgetUnderlyingDecl () const
NamedDeclgetMostRecentDecl ()
const NamedDeclgetMostRecentDecl () const
ObjCStringFormatFamily getObjCFStringFormattingFamily () const
bool isModulePrivate () const
 Whether this declaration was marked as being private to the module in which it was defined.
void setModulePrivate ()
 Specify that this declaration was marked as being private to the module in which it was defined.
Public Member Functions inherited from clang::Decl
 Decl ()=delete
 Decl (const Decl &)=delete
 Decl (Decl &&)=delete
Decloperator= (const Decl &)=delete
Decloperator= (Decl &&)=delete
SourceLocation getBeginLoc () const LLVM_READONLY
SourceLocation getEndLoc () const LLVM_READONLY
SourceLocation getLocation () const
void setLocation (SourceLocation L)
Kind getKind () const
const char * getDeclKindName () const
DeclgetNextDeclInContext ()
const DeclgetNextDeclInContext () const
DeclContextgetDeclContext ()
const DeclContextgetDeclContext () const
DeclContextgetNonTransparentDeclContext ()
 Return the non transparent context.
const DeclContextgetNonTransparentDeclContext () const
DeclgetNonClosureContext ()
 Find the innermost non-closure ancestor of this declaration, walking up through blocks, lambdas, etc.
const DeclgetNonClosureContext () const
TranslationUnitDeclgetTranslationUnitDecl ()
const TranslationUnitDeclgetTranslationUnitDecl () const
bool isInAnonymousNamespace () const
bool isInStdNamespace () const
bool isFileContextDecl () const
ASTContextgetASTContext () const LLVM_READONLY
const LangOptionsgetLangOpts () const LLVM_READONLY
 Helper to get the language options from the ASTContext.
void setAccess (AccessSpecifier AS)
AccessSpecifier getAccess () const
AccessSpecifier getAccessUnsafe () const
 Retrieve the access specifier for this declaration, even though it may not yet have been properly set.
bool hasAttrs () const
void setAttrs (const AttrVec &Attrs)
AttrVecgetAttrs ()
const AttrVecgetAttrs () const
void dropAttrs ()
void addAttr (Attr *A)
attr_range attrs () const
attr_iterator attr_begin () const
attr_iterator attr_end () const
template<typename... Ts>
void dropAttrs ()
template<typename T>
void dropAttr ()
template<typename T>
llvm::iterator_range< specific_attr_iterator< T > > specific_attrs () const
template<typename T>
specific_attr_iterator< Tspecific_attr_begin () const
template<typename T>
specific_attr_iterator< Tspecific_attr_end () const
template<typename T>
TgetAttr () const
template<typename T>
bool hasAttr () const
unsigned getMaxAlignment () const
 getMaxAlignment - return the maximum alignment specified by attributes on this decl, 0 if there are none.
void setInvalidDecl (bool Invalid=true)
 setInvalidDecl - Indicates the Decl had a semantic error.
bool isInvalidDecl () const
bool isImplicit () const
 isImplicit - Indicates whether the declaration was implicitly generated by the implementation.
void setImplicit (bool I=true)
bool isUsed (bool CheckUsedAttr=true) const
 Whether any (re-)declaration of the entity was used, meaning that a definition is required.
void setIsUsed ()
 Set whether the declaration is used, in the sense of odr-use.
void markUsed (ASTContext &C)
 Mark the declaration used, in the sense of odr-use.
bool isReferenced () const
 Whether any declaration of this entity was referenced.
bool isThisDeclarationReferenced () const
 Whether this declaration was referenced.
void setReferenced (bool R=true)
void invalidateCachedLinkage ()
 When doing manipulations which might change the computed linkage, such as changing the DeclContext after the declaration has already been used, invalidating the cache will make sure its linkage will be recomputed.
bool isTopLevelDeclInObjCContainer () const
 Whether this declaration is a top-level declaration (function, global variable, etc.) that is lexically inside an objc container definition.
void setTopLevelDeclInObjCContainer (bool V=true)
ExternalSourceSymbolAttr * getExternalSourceSymbolAttr () const
 Looks on this and related declarations for an applicable external source symbol attribute.
bool isModulePrivate () const
 Whether this declaration was marked as being private to the module in which it was defined.
bool isModuleLocal () const
 Whether this declaration was a local declaration to a C++20 named module.
bool isInExportDeclContext () const
 Whether this declaration was exported in a lexical context.
bool isInvisibleOutsideTheOwningModule () const
bool isInAnotherModuleUnit () const
 Whether this declaration comes from another module unit.
bool isInCurrentModuleUnit () const
 Whether this declaration comes from the same module unit being compiled.
bool shouldEmitInExternalSource () const
 Whether the definition of the declaration should be emitted in external sources.
bool isFromExplicitGlobalModule () const
 Whether this declaration comes from explicit global module.
bool isFromGlobalModule () const
 Whether this declaration comes from global module.
bool isInNamedModule () const
 Whether this declaration comes from a named module.
bool isFromHeaderUnit () const
 Whether this declaration comes from a header unit.
bool hasDefiningAttr () const
 Return true if this declaration has an attribute which acts as definition of the entity, such as 'alias' or 'ifunc'.
const AttrgetDefiningAttr () const
 Return this declaration's defining attribute if it has one.
void setFromASTFile ()
 Set the FromASTFile flag.
void setOwningModuleID (unsigned ID)
 Set the owning module ID.
AvailabilityResult getAvailability (std::string *Message=nullptr, VersionTuple EnclosingVersion=VersionTuple(), StringRef *RealizedPlatform=nullptr) const
 Determine the availability of the given declaration.
VersionTuple getVersionIntroduced () const
 Retrieve the version of the target platform in which this declaration was introduced.
bool isDeprecated (std::string *Message=nullptr) const
 Determine whether this declaration is marked 'deprecated'.
bool isUnavailable (std::string *Message=nullptr) const
 Determine whether this declaration is marked 'unavailable'.
bool isWeakImported () const
 Determine whether this is a weak-imported symbol.
bool canBeWeakImported (bool &IsDefinition) const
 Determines whether this symbol can be weak-imported, e.g., whether it would be well-formed to add the weak_import attribute.
bool isFromASTFile () const
 Determine whether this declaration came from an AST file (such as a precompiled header or module) rather than having been parsed.
GlobalDeclID getGlobalID () const
 Retrieve the global declaration ID associated with this declaration, which specifies where this Decl was loaded from.
unsigned getOwningModuleID () const
 Retrieve the global ID of the module that owns this particular declaration.
ModulegetImportedOwningModule () const
 Get the imported owning module, if this decl is from an imported (non-local) module.
ModulegetLocalOwningModule () const
 Get the local owning module, if known.
void setLocalOwningModule (Module *M)
bool hasOwningModule () const
 Is this declaration owned by some module?
ModulegetOwningModule () const
 Get the module that owns this declaration (for visibility purposes).
ModulegetTopLevelOwningNamedModule () const
 Get the top level owning named module that owns this declaration if any.
ModulegetOwningModuleForLinkage () const
 Get the module that owns this declaration for linkage purposes.
bool isUnconditionallyVisible () const
 Determine whether this declaration is definitely visible to name lookup, independent of whether the owning module is visible.
bool isReachable () const
void setVisibleDespiteOwningModule ()
 Set that this declaration is globally visible, even if it came from a module that is not visible.
ModuleOwnershipKind getModuleOwnershipKind () const
 Get the kind of module ownership for this declaration.
void setModuleOwnershipKind (ModuleOwnershipKind MOK)
 Set whether this declaration is hidden from name lookup.
unsigned getIdentifierNamespace () const
bool isInIdentifierNamespace (unsigned NS) const
bool hasTagIdentifierNamespace () const
DeclContextgetLexicalDeclContext ()
 getLexicalDeclContext - The declaration context where this Decl was lexically declared (LexicalDC).
const DeclContextgetLexicalDeclContext () const
void setDeclContext (DeclContext *DC)
 setDeclContext - Set both the semantic and lexical DeclContext to DC.
void setLexicalDeclContext (DeclContext *DC)
bool isTemplated () const
 Determine whether this declaration is a templated entity (whether it is.
unsigned getTemplateDepth () const
 Determine the number of levels of template parameter surrounding this declaration.
bool isDefinedOutsideFunctionOrMethod () const
 isDefinedOutsideFunctionOrMethod - This predicate returns true if this scoped decl is defined outside the current function or method.
bool isInLocalScopeForInstantiation () const
 Determine whether a substitution into this declaration would occur as part of a substitution into a dependent local scope.
const DeclContextgetParentFunctionOrMethod (bool LexicalParent=false) const
 If this decl is defined inside a function/method/block it returns the corresponding DeclContext, otherwise it returns null.
DeclContextgetParentFunctionOrMethod (bool LexicalParent=false)
const DeclgetCanonicalDecl () const
bool isCanonicalDecl () const
 Whether this particular Decl is a canonical one.
redecl_range redecls () const
 Returns an iterator range for all the redeclarations of the same decl.
redecl_iterator redecls_begin () const
redecl_iterator redecls_end () const
DeclgetPreviousDecl ()
 Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration.
const DeclgetPreviousDecl () const
 Retrieve the previous declaration that declares the same entity as this declaration, or NULL if there is no previous declaration.
bool isFirstDecl () const
 True if this is the first declaration in its redeclaration chain.
DeclgetMostRecentDecl ()
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration).
const DeclgetMostRecentDecl () const
 Retrieve the most recent declaration that declares the same entity as this declaration (which may be this declaration).
SourceLocation getBodyRBrace () const
 getBodyRBrace - Gets the right brace of the body, if a body exists.
bool isTemplateParameter () const
 isTemplateParameter - Determines whether this declaration is a template parameter.
bool isTemplateParameterPack () const
 isTemplateParameter - Determines whether this declaration is a template parameter pack.
bool isParameterPack () const
 Whether this declaration is a parameter pack.
bool isTemplateDecl () const
 returns true if this declaration is a template
bool isFunctionOrFunctionTemplate () const
 Whether this declaration is a function or function template.
TemplateDeclgetDescribedTemplate () const
 If this is a declaration that describes some template, this method returns that template declaration.
const TemplateParameterListgetDescribedTemplateParams () const
 If this is a declaration that describes some template or partial specialization, this returns the corresponding template parameter list.
FunctionDeclgetAsFunction () LLVM_READONLY
 Returns the function itself, or the templated function if this is a function template.
const FunctionDeclgetAsFunction () const
void setLocalExternDecl ()
 Changes the namespace of this declaration to reflect that it's a function-local extern declaration.
bool isLocalExternDecl () const
 Determine whether this is a block-scope declaration with linkage.
void setObjectOfFriendDecl (bool PerformFriendInjection=false)
 Changes the namespace of this declaration to reflect that it's the object of a friend declaration.
void clearIdentifierNamespace ()
 Clears the namespace of this declaration.
FriendObjectKind getFriendObjectKind () const
 Determines whether this declaration is the object of a friend declaration and, if so, what kind.
void setNonMemberOperator ()
 Specifies that this declaration is a C++ overloaded non-member.
void print (raw_ostream &Out, unsigned Indentation=0, bool PrintInstantiation=false) const
void print (raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0, bool PrintInstantiation=false) const
void dump () const
void dumpColor () const
void dump (raw_ostream &Out, bool Deserialize=false, ASTDumpOutputFormat OutputFormat=ADOF_Default) const
int64_t getID () const
const FunctionTypegetFunctionType (bool BlocksToo=true) const
 Looks through the Decl's underlying type to extract a FunctionType when possible.
bool isFunctionPointerType () const
Public Member Functions inherited from clang::DeclContext
 ~DeclContext ()
bool hasValidDeclKind () const
Decl::Kind getDeclKind () const
const char * getDeclKindName () const
DeclContextgetParent ()
 getParent - Returns the containing DeclContext.
const DeclContextgetParent () const
DeclContextgetLexicalParent ()
 getLexicalParent - Returns the containing lexical DeclContext.
const DeclContextgetLexicalParent () const
DeclContextgetLookupParent ()
 Find the parent context of this context that will be used for unqualified name lookup.
const DeclContextgetLookupParent () const
ASTContextgetParentASTContext () const
bool isClosure () const
const BlockDeclgetInnermostBlockDecl () const
 Return this DeclContext if it is a BlockDecl.
bool isObjCContainer () const
bool isFunctionOrMethod () const
bool isLookupContext () const
 Test whether the context supports looking up names.
bool isFileContext () const
bool isTranslationUnit () const
bool isRecord () const
bool isRequiresExprBody () const
bool isNamespace () const
bool isStdNamespace () const
bool isInlineNamespace () const
bool isDependentContext () const
 Determines whether this context is dependent on a template parameter.
bool isTransparentContext () const
 isTransparentContext - Determines whether this context is a "transparent" context, meaning that the members declared in this context are semantically declared in the nearest enclosing non-transparent (opaque) context but are lexically declared in this context.
bool isExternCContext () const
 Determines whether this context or some of its ancestors is a linkage specification context that specifies C linkage.
const LinkageSpecDeclgetExternCContext () const
 Retrieve the nearest enclosing C linkage specification context.
bool isExternCXXContext () const
 Determines whether this context or some of its ancestors is a linkage specification context that specifies C++ linkage.
bool Equals (const DeclContext *DC) const
 Determine whether this declaration context is equivalent to the declaration context DC.
bool Encloses (const DeclContext *DC) const
 Determine whether this declaration context semantically encloses the declaration context DC.
bool LexicallyEncloses (const DeclContext *DC) const
 Determine whether this declaration context lexically encloses the declaration context DC.
DeclgetNonClosureAncestor ()
 Find the nearest non-closure ancestor of this context, i.e.
const DeclgetNonClosureAncestor () const
DeclContextgetNonTransparentContext ()
const DeclContextgetNonTransparentContext () const
DeclContextgetPrimaryContext ()
 getPrimaryContext - There may be many different declarations of the same entity (including forward declarations of classes, multiple definitions of namespaces, etc.), each with a different set of declarations.
const DeclContextgetPrimaryContext () const
DeclContextgetRedeclContext ()
 getRedeclContext - Retrieve the context in which an entity conflicts with other entities of the same name, or where it is a redeclaration if the two entities are compatible.
const DeclContextgetRedeclContext () const
DeclContextgetEnclosingNamespaceContext ()
 Retrieve the nearest enclosing namespace context.
const DeclContextgetEnclosingNamespaceContext () const
RecordDeclgetOuterLexicalRecordContext ()
 Retrieve the outermost lexically enclosing record context.
const RecordDeclgetOuterLexicalRecordContext () const
bool InEnclosingNamespaceSetOf (const DeclContext *NS) const
 Test if this context is part of the enclosing namespace set of the context NS, as defined in C++0x [namespace.def]p9.
void collectAllContexts (SmallVectorImpl< DeclContext * > &Contexts)
 Collects all of the declaration contexts that are semantically connected to this declaration context.
decl_range decls () const
 decls_begin/decls_end - Iterate over the declarations stored in this context.
decl_iterator decls_begin () const
decl_iterator decls_end () const
bool decls_empty () const
decl_range noload_decls () const
 noload_decls_begin/end - Iterate over the declarations stored in this context that are currently loaded; don't attempt to retrieve anything from an external source.
decl_iterator noload_decls_begin () const
decl_iterator noload_decls_end () const
void addDecl (Decl *D)
 Add the declaration D into this context.
void addDeclInternal (Decl *D)
 Add the declaration D into this context, but suppress searches for external declarations with the same name.
void addHiddenDecl (Decl *D)
 Add the declaration D to this context without modifying any lookup tables.
void removeDecl (Decl *D)
 Removes a declaration from this context.
bool containsDecl (Decl *D) const
 Checks whether a declaration is in this context.
bool containsDeclAndLoad (Decl *D) const
 Checks whether a declaration is in this context.
lookup_result lookup (DeclarationName Name) const
 lookup - Find the declarations (if any) with the given Name in this context.
lookup_result noload_lookup (DeclarationName Name)
 Find the declarations with the given name that are visible within this context; don't attempt to retrieve anything from an external source.
void localUncachedLookup (DeclarationName Name, SmallVectorImpl< NamedDecl * > &Results)
 A simplistic name lookup mechanism that performs name lookup into this declaration context without consulting the external source.
void makeDeclVisibleInContext (NamedDecl *D)
 Makes a declaration visible within this context.
lookups_range lookups () const
lookups_range noload_lookups (bool PreserveInternalState) const
all_lookups_iterator lookups_begin () const
 Iterators over all possible lookups within this context.
all_lookups_iterator lookups_end () const
all_lookups_iterator noload_lookups_begin () const
 Iterators over all possible lookups within this context that are currently loaded; don't attempt to retrieve anything from an external source.
all_lookups_iterator noload_lookups_end () const
udir_range using_directives () const
 Returns iterator range [First, Last) of UsingDirectiveDecls stored within this context.
ddiag_range ddiags () const
void setMustBuildLookupTable ()
 Mark that there are external lexical declarations that we need to include in our lookup table (and that are not available as external visible lookups).
StoredDeclsMapgetLookupPtr () const
 Retrieve the internal representation of the lookup structure.
StoredDeclsMapbuildLookup ()
 Ensure the lookup structure is fully-built and return it.
bool hasExternalLexicalStorage () const
 Whether this DeclContext has external storage containing additional declarations that are lexically in this context.
void setHasExternalLexicalStorage (bool ES=true) const
 State whether this DeclContext has external storage for declarations lexically in this context.
bool hasExternalVisibleStorage () const
 Whether this DeclContext has external storage containing additional declarations that are visible in this context.
void setHasExternalVisibleStorage (bool ES=true) const
 State whether this DeclContext has external storage for declarations visible in this context.
bool isDeclInLexicalTraversal (const Decl *D) const
 Determine whether the given declaration is stored in the list of declarations lexically within this context.
void setUseQualifiedLookup (bool use=true) const
bool shouldUseQualifiedLookup () const
void dumpAsDecl () const
void dumpAsDecl (const ASTContext *Ctx) const
void dumpDeclContext () const
void dumpLookups () const
void dumpLookups (llvm::raw_ostream &OS, bool DumpDecls=false, bool Deserialize=false) const
Public Member Functions inherited from clang::Redeclarable< FunctionDecl >
 Redeclarable (const ASTContext &Ctx)
FunctionDeclgetPreviousDecl ()
 Return the previous declaration of this declaration or NULL if this is the first declaration.
const FunctionDeclgetPreviousDecl () const
FunctionDeclgetFirstDecl ()
 Return the first declaration of this declaration or itself if this is the only declaration.
const FunctionDeclgetFirstDecl () const
 Return the first declaration of this declaration or itself if this is the only declaration.
bool isFirstDecl () const
 True if this is the first declaration in its redeclaration chain.
FunctionDeclgetMostRecentDecl ()
 Returns the most recent (re)declaration of this declaration.
const FunctionDeclgetMostRecentDecl () const
 Returns the most recent (re)declaration of this declaration.
void setPreviousDecl (FunctionDecl *PrevDecl)
 Set the previous declaration.
redecl_range redecls () const
 Returns an iterator range for all the redeclarations of the same decl.
redecl_iterator redecls_begin () const
redecl_iterator redecls_end () const

Static Public Member Functions

static FunctionDeclCreate (ASTContext &C, DeclContext *DC, SourceLocation StartLoc, SourceLocation NLoc, DeclarationName N, QualType T, TypeSourceInfo *TInfo, StorageClass SC, bool UsesFPIntrin=false, bool isInlineSpecified=false, bool hasWrittenPrototype=true, ConstexprSpecKind ConstexprKind=ConstexprSpecKind::Unspecified, const AssociatedConstraint &TrailingRequiresClause={})
static FunctionDeclCreate (ASTContext &C, DeclContext *DC, SourceLocation StartLoc, const DeclarationNameInfo &NameInfo, QualType T, TypeSourceInfo *TInfo, StorageClass SC, bool UsesFPIntrin, bool isInlineSpecified, bool hasWrittenPrototype, ConstexprSpecKind ConstexprKind, const AssociatedConstraint &TrailingRequiresClause)
static FunctionDeclCreateDeserialized (ASTContext &C, GlobalDeclID ID)
static bool classof (const Decl *D)
static bool classofKind (Kind K)
static DeclContextcastToDeclContext (const FunctionDecl *D)
static FunctionDeclcastFromDeclContext (const DeclContext *DC)
Static Public Member Functions inherited from clang::DeclaratorDecl
static bool classof (const Decl *D)
static bool classofKind (Kind K)
Static Public Member Functions inherited from clang::ValueDecl
static bool classof (const Decl *D)
static bool classofKind (Kind K)
Static Public Member Functions inherited from clang::NamedDecl
static bool classof (const Decl *D)
static bool classofKind (Kind K)
Static Public Member Functions inherited from clang::Decl
static bool isFlexibleArrayMemberLike (const ASTContext &Context, const Decl *D, QualType Ty, LangOptions::StrictFlexArraysLevelKind StrictFlexArraysLevel, bool IgnoreTemplateOrMacroSubstitution)
 Whether it resembles a flexible array member.
static unsigned getIdentifierNamespaceForKind (Kind DK)
static bool isTagIdentifierNamespace (unsigned NS)
static void add (Kind k)
static void EnableStatistics ()
static void PrintStats ()
static bool classofKind (Kind K)
static DeclContextcastToDeclContext (const Decl *)
static DeclcastFromDeclContext (const DeclContext *)
static void printGroup (Decl **Begin, unsigned NumDecls, raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation=0)
Static Public Member Functions inherited from clang::DeclContext
static bool classof (const Decl *D)
static bool classof (const DeclContext *D)

Static Public Attributes

static constexpr unsigned RequiredTypeAwareNewParameterCount
 Count of mandatory parameters for type aware operator new.
static constexpr unsigned RequiredTypeAwareDeleteParameterCount
 Count of mandatory parameters for type aware operator delete.

Protected Types

using redeclarable_base = Redeclarable<FunctionDecl>
Protected Types inherited from clang::DeclContext
enum  { NumOdrHashBits = 25 }
enum  { NumDeclContextBits = 13 }
 Number of bits in DeclContextBitfields. More...
enum  { NumNamespaceDeclBits = NumDeclContextBits + 2 }
 Number of inherited and non-inherited bits in NamespaceDeclBitfields. More...
enum  { NumTagDeclBits = NumDeclContextBits + 10 }
 Number of inherited and non-inherited bits in TagDeclBitfields. More...
enum  { NumEnumDeclBits = NumTagDeclBits + 20 }
 Number of inherited and non-inherited bits in EnumDeclBitfields. More...
enum  { NumRecordDeclBits = NumTagDeclBits + 41 }
 Number of inherited and non-inherited bits in RecordDeclBitfields. More...
enum  { NumOMPDeclareReductionDeclBits = NumDeclContextBits + 2 }
 Number of inherited and non-inherited bits in OMPDeclareReductionDeclBitfields. More...
enum  { NumFunctionDeclBits = NumDeclContextBits + 32 }
 Number of inherited and non-inherited bits in FunctionDeclBitfields. More...
enum  { NumCXXConstructorDeclBits = NumFunctionDeclBits + 19 }
 Number of inherited and non-inherited bits in CXXConstructorDeclBitfields. More...
enum  { NumObjCMethodDeclBits = NumDeclContextBits + 24 }
 Number of inherited and non-inherited bits in ObjCMethodDeclBitfields. More...
enum  { NumObjCContainerDeclBits = 64 }
 Number of inherited and non-inherited bits in ObjCContainerDeclBitfields. More...
enum  { NumLinkageSpecDeclBits = NumDeclContextBits + 4 }
 Number of inherited and non-inherited bits in LinkageSpecDeclBitfields. More...
enum  { NumBlockDeclBits = NumDeclContextBits + 5 }
 Number of inherited and non-inherited bits in BlockDeclBitfields. More...

Protected Member Functions

 FunctionDecl (Kind DK, ASTContext &C, DeclContext *DC, SourceLocation StartLoc, const DeclarationNameInfo &NameInfo, QualType T, TypeSourceInfo *TInfo, StorageClass S, bool UsesFPIntrin, bool isInlineSpecified, ConstexprSpecKind ConstexprKind, const AssociatedConstraint &TrailingRequiresClause)
FunctionDeclgetNextRedeclarationImpl () override
 Returns the next redeclaration or itself if this is the only decl.
FunctionDeclgetPreviousDeclImpl () override
 Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain.
FunctionDeclgetMostRecentDeclImpl () override
 Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain.
Protected Member Functions inherited from clang::DeclaratorDecl
 DeclaratorDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N, QualType T, TypeSourceInfo *TInfo, SourceLocation StartL)
Protected Member Functions inherited from clang::ValueDecl
 ValueDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N, QualType T)
Protected Member Functions inherited from clang::NamedDecl
 NamedDecl (Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
Protected Member Functions inherited from clang::Decl
void * operator new (std::size_t Size, const ASTContext &Ctx, GlobalDeclID ID, std::size_t Extra=0)
 Allocate memory for a deserialized declaration.
void * operator new (std::size_t Size, const ASTContext &Ctx, DeclContext *Parent, std::size_t Extra=0)
 Allocate memory for a non-deserialized declaration.
 Decl (Kind DK, DeclContext *DC, SourceLocation L)
 Decl (Kind DK, EmptyShell Empty)
virtual ~Decl ()
Linkage getCachedLinkage () const
void setCachedLinkage (Linkage L) const
bool hasCachedLinkage () const
void setModulePrivate ()
 Specify that this declaration was marked as being private to the module in which it was defined.
bool hasLocalOwningModuleStorage () const
ASTMutationListenergetASTMutationListener () const
Protected Member Functions inherited from clang::DeclContext
 DeclContext (Decl::Kind K)
Protected Member Functions inherited from clang::Redeclarable< FunctionDecl >
FunctionDeclgetNextRedeclaration () const

Friends

class ASTDeclReader
class ASTDeclWriter

Additional Inherited Members

Static Protected Member Functions inherited from clang::DeclContext
static std::pair< Decl *, Decl * > BuildDeclChain (ArrayRef< Decl * > Decls, bool FieldsAlreadyLoaded)
 Build up a chain of declarations.
Static Protected Member Functions inherited from clang::Redeclarable< FunctionDecl >
static DeclLink PreviousDeclLink (FunctionDecl *D)
static DeclLink LatestDeclLink (const ASTContext &Ctx)
Protected Attributes inherited from clang::Decl
llvm::PointerIntPair< Decl *, 3, ModuleOwnershipKindNextInContextAndBits
 The next declaration within the same lexical DeclContext.
unsigned Access: 2
 Access - Used by C++ decls for the access specifier.
unsigned FromASTFile: 1
 Whether this declaration was loaded from an AST file.
unsigned IdentifierNamespace: 14
 IdentifierNamespace - This specifies what IDNS_* namespace this lives in.
unsigned CacheValidAndLinkage: 3
 If 0, we have not computed the linkage of this declaration.
Protected Attributes inherited from clang::DeclContext
StoredDeclsMapLookupPtr = nullptr
 Pointer to the data structure used to lookup declarations within this context (or a DependentStoredDeclsMap if this is a dependent context).
union { 
   DeclContextBitfields   DeclContextBits 
   NamespaceDeclBitfields   NamespaceDeclBits 
   TagDeclBitfields   TagDeclBits 
   EnumDeclBitfields   EnumDeclBits 
   RecordDeclBitfields   RecordDeclBits 
   OMPDeclareReductionDeclBitfields   OMPDeclareReductionDeclBits 
   FunctionDeclBitfields   FunctionDeclBits 
   CXXConstructorDeclBitfields   CXXConstructorDeclBits 
   ObjCMethodDeclBitfields   ObjCMethodDeclBits 
   ObjCContainerDeclBitfields   ObjCContainerDeclBits 
   LinkageSpecDeclBitfields   LinkageSpecDeclBits 
   BlockDeclBitfields   BlockDeclBits 
}; 
 This anonymous union stores the bits belonging to DeclContext and classes deriving from it.
DeclFirstDecl = nullptr
 FirstDecl - The first declaration stored within this declaration context.
DeclLastDecl = nullptr
 LastDecl - The last declaration stored within this declaration context.
Protected Attributes inherited from clang::Redeclarable< FunctionDecl >
DeclLink RedeclLink
 Points to the next redeclaration in the chain.
FunctionDeclFirst

Detailed Description

Represents a function declaration or definition.

Since a given function can be declared several times in a program, there may be several FunctionDecls that correspond to that function. Only one of those FunctionDecls will be found when traversing the list of declarations in the context of the FunctionDecl (e.g., the translation unit); this FunctionDecl contains all of the information known about the function. Other, previous declarations of the function are available via the getPreviousDecl() chain.

Definition at line 1997 of file Decl.h.

Member Typedef Documentation

◆ param_const_iterator

Definition at line 2780 of file Decl.h.

◆ param_iterator

Definition at line 2779 of file Decl.h.

◆ redecl_iterator

using clang::FunctionDecl::redecl_iterator = redeclarable_base::redecl_iterator

Definition at line 2178 of file Decl.h.

◆ redecl_range

◆ redeclarable_base

Definition at line 2159 of file Decl.h.

Member Enumeration Documentation

◆ TemplatedKind

The kind of templated function a FunctionDecl can be.

Enumerator
TK_NonTemplate 
TK_FunctionTemplate 
TK_MemberSpecialization 
TK_FunctionTemplateSpecialization 
TK_DependentFunctionTemplateSpecialization 
TK_DependentNonTemplate 

Definition at line 2004 of file Decl.h.

Constructor & Destructor Documentation

◆ FunctionDecl()

FunctionDecl::FunctionDecl ( Kind DK,
ASTContext & C,
DeclContext * DC,
SourceLocation StartLoc,
const DeclarationNameInfo & NameInfo,
QualType T,
TypeSourceInfo * TInfo,
StorageClass S,
bool UsesFPIntrin,
bool isInlineSpecified,
ConstexprSpecKind ConstexprKind,
const AssociatedConstraint & TrailingRequiresClause )
protected

Member Function Documentation

◆ BodyContainsImmediateEscalatingExpressions()

bool clang::FunctionDecl::BodyContainsImmediateEscalatingExpressions ( ) const
inline

Definition at line 2489 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by isImmediateFunction().

◆ castFromDeclContext()

FunctionDecl * clang::FunctionDecl::castFromDeclContext ( const DeclContext * DC)
inlinestatic

Definition at line 3149 of file Decl.h.

References clang::DeclContext::DeclContext(), and FunctionDecl().

◆ castToDeclContext()

DeclContext * clang::FunctionDecl::castToDeclContext ( const FunctionDecl * D)
inlinestatic

Definition at line 3146 of file Decl.h.

References clang::DeclContext::DeclContext(), and FunctionDecl().

◆ classof()

bool clang::FunctionDecl::classof ( const Decl * D)
inlinestatic

Definition at line 3142 of file Decl.h.

References classofKind(), and clang::Decl::getKind().

◆ classofKind()

bool clang::FunctionDecl::classofKind ( Kind K)
inlinestatic

Definition at line 3143 of file Decl.h.

Referenced by classof().

◆ Create() [1/2]

FunctionDecl * FunctionDecl::Create ( ASTContext & C,
DeclContext * DC,
SourceLocation StartLoc,
const DeclarationNameInfo & NameInfo,
QualType T,
TypeSourceInfo * TInfo,
StorageClass SC,
bool UsesFPIntrin,
bool isInlineSpecified,
bool hasWrittenPrototype,
ConstexprSpecKind ConstexprKind,
const AssociatedConstraint & TrailingRequiresClause )
static

◆ Create() [2/2]

◆ CreateDeserialized()

FunctionDecl * FunctionDecl::CreateDeserialized ( ASTContext & C,
GlobalDeclID ID )
static

Definition at line 5501 of file Decl.cpp.

References clang::C, clang::Function, FunctionDecl(), clang::SC_None, and clang::Unspecified.

◆ doesDeclarationForceExternallyVisibleDefinition()

bool FunctionDecl::doesDeclarationForceExternallyVisibleDefinition ( ) const

For a function declaration in C or C++, determine whether this declaration causes the definition to be externally visible.

For instance, this determines if adding the current declaration to the set of redeclarations of the given functions causes isInlineDefinitionExternallyVisible to change from false to true.

Definition at line 3882 of file Decl.cpp.

References clang::Definition, doesThisDeclarationHaveABody(), FunctionDecl(), clang::Decl::getASTContext(), getPreviousDecl(), getStorageClass(), clang::Decl::hasAttr(), hasBody(), isInlineSpecified(), RedeclForcesDefC99(), redeclForcesDefMSVC(), and clang::SC_Extern.

Referenced by clang::CodeGen::CodeGenModule::EmitGlobal().

◆ doesThisDeclarationHaveABody()

◆ FriendConstraintRefersToEnclosingTemplate()

bool clang::FunctionDecl::FriendConstraintRefersToEnclosingTemplate ( ) const
inline

◆ getAssociatedConstraints()

void clang::FunctionDecl::getAssociatedConstraints ( SmallVectorImpl< AssociatedConstraint > & ACs) const
inline

Get the associated-constraints of this function declaration.

Currently, this will either be a vector of size 1 containing the trailing-requires-clause or an empty vector.

Use this instead of getTrailingRequiresClause for concepts APIs that accept an ArrayRef of constraint expressions.

Definition at line 2749 of file Decl.h.

References clang::DeclaratorDecl::getTrailingRequiresClause().

Referenced by clang::Sema::getMoreConstrainedFunction().

◆ getBody() [1/2]

Stmt * clang::FunctionDecl::getBody ( ) const
inlineoverridevirtual

getBody - If this Decl represents a declaration for a body of code, such as a function or method definition, this method returns the top-level Stmt* of that body.

Otherwise this method returns null.

Reimplemented from clang::Decl.

Definition at line 2299 of file Decl.h.

References clang::Definition, FunctionDecl(), and getBody().

Referenced by getBody(), and hasTrivialBody().

◆ getBody() [2/2]

Stmt * FunctionDecl::getBody ( const FunctionDecl *& Definition) const

Retrieve the body (definition) of the function.

The function body might be in any of the (re-)declarations of this function. The variant that accepts a FunctionDecl pointer will set that function declaration to the actual declaration containing the body (if there is one). NOTE: For checking if there is a body, use hasBody() instead, to avoid unnecessary AST de-serialization of the body.

Definition at line 3271 of file Decl.cpp.

References clang::Definition, FunctionDecl(), clang::Decl::getASTContext(), and hasBody().

Referenced by addBlockPointerConversion(), clang::ASTRecordWriter::AddFunctionDefinition(), addFunctionPointerConversion(), clang::Sema::BuildLambdaExpr(), clang::Sema::CheckConstexprFunctionDefinition(), ComputeDefaultedComparisonExceptionSpec(), createOverloadsForFixedParams(), clang::CodeGen::CodeGenFunction::EmitConstructorBody(), clang::CodeGen::CodeGenFunction::EmitDestructorBody(), clang::CIRGen::CIRGenFunction::emitDestructorBody(), clang::CodeGen::CodeGenFunction::emitImplicitAssignmentOperatorBody(), endsWithReturn(), clang::findUnsafePointers(), clang::CodeGen::CodeGenFunction::GenerateCode(), getMethodBody(), clang::dataflow::getReferencedDecls(), HandleDestructionImpl(), clang::ASTNodeImporter::ImportFunctionDeclBody(), clang::Sema::InstantiateFunctionDefinition(), isKnownToAlwaysThrow(), clang::Expr::isPotentialConstantExpr(), clang::CodeGen::CodeGenFunction::StartFunction(), clang::interp::Compiler< Emitter >::visitFunc(), and clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitFunctionDecl().

◆ getBuiltinID()

unsigned FunctionDecl::getBuiltinID ( bool ConsiderWrapperFunctions = false) const

Returns a value indicating whether this function corresponds to a builtin function.

The function corresponds to a built-in function if it is declared at translation scope or within an extern "C" block and its name matches with the name of a builtin. The returned value will be 0 for functions that do not correspond to a builtin, a value of type Builtin::ID if in the target-independent range [1,Builtin::First), or a target-specific builtin value.

Parameters
ConsiderWrapperFunctionsIf true, we should consider wrapper functions as their wrapped builtins. This shouldn't be done in general, but it's useful in Sema to diagnose calls to wrappers based on their semantics.

Definition at line 3703 of file Decl.cpp.

References clang::CPlusPlus, clang::Decl::getASTContext(), clang::Decl::getAttr(), clang::Decl::getLangOpts(), getStorageClass(), clang::Decl::hasAttr(), and clang::SC_Static.

Referenced by clang::Sema::ActOnStartOfFunctionDef(), clang::Sema::AddKnownFunctionAttributes(), clang::Sema::BuildCallExpr(), clang::Sema::buildOverloadedCallSet(), clang::Sema::BuildResolvedCallExpr(), clang::ASTContext::canBuiltinBeRedeclared(), clang::Sema::checkCall(), clang::Sema::CheckEquivalentExceptionSpec(), checkFormatStringExpr(), clang::Sema::CheckFunctionCall(), clang::CodeGen::CodeGenFunction::checkTargetFeatures(), clang::CodeGen::CodeGenFunction::checkTargetFeatures(), clang::Sema::ConvertArgumentsForCall(), DiagnosedUnqualifiedCallsToStdFunctions(), clang::CodeGen::CodeGenFunction::EmitBranchOnBoolExpr(), EmitDirectCallee(), emitLibraryCall(), emitReplacement(), getAbsoluteValueFunctionKind(), clang::BodyFarm::getBody(), getMemoryFunctionKind(), handleDiagnoseAsBuiltinAttr(), clang::Sema::inferLifetimeBoundAttribute(), clang::ento::CheckerContext::isCLibraryFunction(), isInlineBuiltinDeclaration(), libc_func_matchers::isNormalPrintfFunc(), libc_func_matchers::isPredefinedUnsafeLibcFunc(), libc_func_matchers::isUnsafeSprintfFunc(), libc_func_matchers::isUnsafeVaListPrintfFunc(), clang::Sema::MergeFunctionDecl(), rewriteBuiltinFunctionDecl(), and clang::interp::Compiler< Emitter >::VisitCallExpr().

◆ getCallResultType()

QualType clang::FunctionDecl::getCallResultType ( ) const
inline

Determine the type of an expression that calls this function.

Definition at line 2878 of file Decl.h.

References clang::Type::castAs(), clang::Decl::getASTContext(), getCallResultType(), and clang::ValueDecl::getType().

Referenced by clang::Sema::BuildResolvedCallExpr(), getCallResultType(), and clang::consumed::ConsumedAnalyzer::run().

◆ getCanonicalDecl() [1/2]

const FunctionDecl * clang::FunctionDecl::getCanonicalDecl ( ) const
inline

Definition at line 2764 of file Decl.h.

References FunctionDecl(), and getCanonicalDecl().

◆ getCanonicalDecl() [2/2]

◆ getConstexprKind()

◆ getDeclaredReturnType()

QualType clang::FunctionDecl::getDeclaredReturnType ( ) const
inline

Get the declared return type, which may differ from the actual return type if the return type is deduced.

Definition at line 2859 of file Decl.h.

References getReturnType(), clang::ValueDecl::getType(), clang::DeclaratorDecl::getTypeSourceInfo(), and clang::T.

Referenced by clang::Sema::CheckExplicitlyDefaultedComparison(), isGRealloc(), IsOverloadOrOverrideImpl(), isStandardRealloc(), and clang::Sema::MergeFunctionDecl().

◆ getDefalutedOrDeletedInfo()

◆ getDefaultLoc()

◆ getDefinition() [1/2]

◆ getDefinition() [2/2]

const FunctionDecl * clang::FunctionDecl::getDefinition ( ) const
inline

Definition at line 2287 of file Decl.h.

References FunctionDecl(), and getDefinition().

◆ getDeletedMessage()

◆ getDependentSpecializationInfo()

◆ getDescribedFunctionTemplate()

FunctionTemplateDecl * FunctionDecl::getDescribedFunctionTemplate ( ) const

Retrieves the function template that is described by this function declaration.

Every function template is represented as a FunctionTemplateDecl and a FunctionDecl (or something derived from FunctionDecl). The former contains template properties (such as the template parameter lists) while the latter contains the actual description of the template's contents. FunctionTemplateDecl::getTemplatedDecl() retrieves the FunctionDecl that describes the function template, getDescribedFunctionTemplate() retrieves the FunctionTemplateDecl from a FunctionDecl.

Definition at line 4134 of file Decl.cpp.

Referenced by clang::Sema::ActOnConversionDeclarator(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::AddConversionCandidate(), addFunctionPointerConversion(), AreSpecialMemberFunctionsSameKind(), clang::Sema::BuildLambdaExpr(), clang::SemaCUDA::CheckCall(), clang::Sema::CheckCXXDefaultArguments(), clang::Sema::CheckFunctionDeclaration(), clang::Sema::CheckIfFunctionSpecializationIsImmediate(), clang::Sema::CheckLiteralOperatorDeclaration(), clang::Sema::CheckMain(), clang::Sema::CheckMSVCRTEntryPoint(), CheckOperatorNewDeleteTypes(), clang::Sema::DeclareAggregateDeductionGuideFromInitList(), clang::Sema::DeduceReturnType(), clang::Sema::DefineImplicitLambdaToFunctionPointerConversion(), clang::CodeGen::CodeGenFunction::EmitLambdaDelegatingInvokeBody(), clang::Sema::FriendConstraintsDependOnEnclosingTemplate(), FunctionsCorrespond(), clang::CXXRecordDecl::getGenericLambdaTemplateParameterList(), clang::interp::Context::getOrCreateFunction(), handleDeviceKernelAttr(), clang::CXXMethodDecl::isCopyAssignmentOperator(), clang::CXXConstructorDecl::isCopyOrMoveConstructor(), isMemberLikeConstrainedFriend(), clang::CXXMethodDecl::isMoveAssignmentOperator(), IsOverloadOrOverrideImpl(), clang::CXXConstructorDecl::isSpecializationCopyingObject(), isThisDeclarationInstantiatedFromAFriendDefinition(), clang::SemaCUDA::maybeAddHostDeviceAttrs(), NoteImplicitDeductionGuide(), clang::Sema::RebuildLambdaScopeInfo(), setPreviousDeclaration(), ShouldWarnAboutMissingPrototype(), SubstituteConstraintExpressionWithoutSatisfaction(), clang::TemplateDeclInstantiator::VisitCXXMethodDecl(), clang::ASTDeclReader::VisitFunctionDecl(), clang::ASTDeclWriter::VisitFunctionDecl(), clang::ASTNodeImporter::VisitFunctionDecl(), and clang::TemplateDeclInstantiator::VisitFunctionDecl().

◆ getEllipsisLoc()

SourceLocation clang::FunctionDecl::getEllipsisLoc ( ) const
inline

Returns the location of the ellipsis of a variadic function.

Definition at line 2222 of file Decl.h.

References clang::Type::getAs(), clang::FunctionProtoType::getEllipsisLoc(), and clang::ValueDecl::getType().

Referenced by getParametersSourceRange().

◆ getExceptionSpecSourceRange()

SourceRange FunctionDecl::getExceptionSpecSourceRange ( ) const

Attempt to compute an informative source range covering the function exception specification, if any.

Definition at line 3997 of file Decl.cpp.

References clang::FunctionTypeLoc::getExceptionSpecRange(), and getFunctionTypeLoc().

Referenced by EmitDiagForCXXThrowInNonThrowingFunc(), and clang::CodeGen::CodeGenFunction::EmitStartEHSpec().

◆ getExceptionSpecType()

◆ getFunctionEffects()

◆ getFunctionTypeLoc()

FunctionTypeLoc FunctionDecl::getFunctionTypeLoc ( ) const

Find the source location information for how the type of this function was written.

May be absent (for example if the function was declared via a typedef) and may contain a different type from that of the function (for example if the function type was adjusted by an attribute).

Definition at line 3942 of file Decl.cpp.

References clang::TypeLoc::getAs(), clang::TypeSourceInfo::getTypeLoc(), and clang::DeclaratorDecl::getTypeSourceInfo().

Referenced by getExceptionSpecSourceRange(), and getReturnTypeSourceRange().

◆ getInstantiatedFromDecl()

FunctionDecl * FunctionDecl::getInstantiatedFromDecl ( ) const

◆ getInstantiatedFromMemberFunction()

FunctionDecl * FunctionDecl::getInstantiatedFromMemberFunction ( ) const

If this function is an instantiation of a member function of a class template specialization, retrieves the function from which it was instantiated.

This routine will return non-NULL for (non-templated) member functions of class templates and for instantiations of function templates. For example, given:

template<typename T>
struct X {
void f(T);
};
#define X(type, name)
Definition Value.h:97
const FunctionProtoType * T

The declaration for X<int>::f is a (non-templated) FunctionDecl whose parent is the class template specialization X<int>. For this declaration, getInstantiatedFromFunction() will return the FunctionDecl X<T>::A. When a complete definition of X<int>::A is required, it will be instantiated from the declaration returned by getInstantiatedFromMemberFunction().

Definition at line 4106 of file Decl.cpp.

References clang::cast(), FunctionDecl(), and getMemberSpecializationInfo().

Referenced by adjustDeclToTemplate(), clang::Sema::CheckForFunctionRedefinition(), clang::Sema::CheckFunctionTemplateSpecialization(), clang::Sema::CheckMemberSpecialization(), getExplicitVisibilityAux(), getODRHash(), getPatternFunctionDecl(), hasExplicitMemberDefinition(), clang::ASTNodeImporter::ImportTemplateInformation(), isOutOfLine(), isThisDeclarationInstantiatedFromAFriendDefinition(), SetEligibleMethods(), and clang::TextNodeDumper::VisitFunctionDecl().

◆ getLanguageLinkage()

LanguageLinkage FunctionDecl::getLanguageLinkage ( ) const

Compute the language linkage.

Definition at line 3555 of file Decl.cpp.

References getDeclLanguageLinkage().

Referenced by clang::Sema::ActOnFunctionDeclarator().

◆ getLiteralIdentifier()

const IdentifierInfo * FunctionDecl::getLiteralIdentifier ( ) const

getLiteralIdentifier - The literal suffix identifier this function represents, if any.

Definition at line 4079 of file Decl.cpp.

References clang::DeclarationName::CXXLiteralOperatorName, clang::DeclarationName::getCXXLiteralIdentifier(), and clang::NamedDecl::getDeclName().

Referenced by clang::Sema::CheckFunctionDeclaration().

◆ getMemberSpecializationInfo()

MemberSpecializationInfo * FunctionDecl::getMemberSpecializationInfo ( ) const

If this function is an instantiation of a member function of a class template specialization, retrieves the member specialization information.

Definition at line 4113 of file Decl.cpp.

Referenced by clang::Sema::CheckMemberSpecialization(), getInstantiatedFromMemberFunction(), getTemplateInstantiationPattern(), clang::ASTNodeImporter::ImportTemplateInformation(), clang::ASTDeclReader::VisitFunctionDecl(), and clang::ASTDeclWriter::VisitFunctionDecl().

◆ getMemoryFunctionKind()

unsigned FunctionDecl::getMemoryFunctionKind ( ) const

Identify a memory copying or setting function.

If the given function is a memory copy or setting function, returns the corresponding Builtin ID. If the function is not a memory function, returns 0.

Definition at line 4494 of file Decl.cpp.

References getBuiltinID(), clang::NamedDecl::getIdentifier(), isExternC(), clang::Decl::isInStdNamespace(), and clang::IdentifierInfo::isStr().

Referenced by clang::Sema::CheckFunctionCall(), and getStrlenExprArg().

◆ getMinRequiredArguments()

unsigned FunctionDecl::getMinRequiredArguments ( ) const

Returns the minimum number of arguments needed to call this function.

getMinRequiredArguments - Returns the minimum number of arguments needed to call this function.

This may be fewer than the number of function parameters, if some of the parameters have default arguments (in C++).

This may be fewer than the number of function parameters, if some of the parameters have default arguments (in C++) or are parameter packs (C++11).

Definition at line 3788 of file Decl.cpp.

References clang::CPlusPlus, clang::Decl::getASTContext(), clang::Decl::getLangOpts(), getNumParams(), and parameters().

Referenced by compareOverloads(), clang::Sema::ConvertArgumentsForCall(), getMinRequiredExplicitArguments(), clang::CXXConstructorDecl::isConvertingConstructor(), clang::CXXConstructorDecl::isDefaultConstructor(), clang::Sema::MergeCXXFunctionDecl(), clang::Sema::SpecialMemberIsTrivial(), and clang::FunctionCallFilterCCC::ValidateCandidate().

◆ getMinRequiredExplicitArguments()

unsigned FunctionDecl::getMinRequiredExplicitArguments ( ) const

Returns the minimum number of non-object arguments needed to call this function.

This produces the same value as getMinRequiredArguments except it does not count the explicit object argument, if any.

Definition at line 3815 of file Decl.cpp.

References getMinRequiredArguments(), and hasCXXExplicitFunctionObjectParameter().

◆ getMostRecentDecl() [1/2]

◆ getMostRecentDecl() [2/2]

const FunctionDecl * clang::Redeclarable< FunctionDecl >::getMostRecentDecl ( ) const
inline

Returns the most recent (re)declaration of this declaration.

Definition at line 228 of file Redeclarable.h.

◆ getMostRecentDeclImpl()

FunctionDecl * clang::FunctionDecl::getMostRecentDeclImpl ( )
inlineoverrideprotectedvirtual

Implementation of getMostRecentDecl(), to be overridden by any subclass that has a redeclaration chain.

Reimplemented from clang::Decl.

Definition at line 2169 of file Decl.h.

References FunctionDecl(), and getMostRecentDecl().

◆ getMultiVersionKind()

MultiVersionKind FunctionDecl::getMultiVersionKind ( ) const

Gets the kind of multiversioning attribute this declaration has.

Note that this can return a value even if the function is not multiversion, such as the case of 'target'.

Definition at line 3629 of file Decl.cpp.

References clang::CPUDispatch, clang::CPUSpecific, clang::Decl::hasAttr(), clang::None, clang::Target, clang::TargetClones, and clang::TargetVersion.

Referenced by CheckMultiVersionAdditionalDecl(), CheckMultiVersionFirstFunction(), CheckMultiVersionFunction(), MultiVersionTypesCompatible(), patchDefaultTargetVersion(), and PreviousDeclsHaveMultiVersionAttribute().

◆ getNameForDiagnostic()

void FunctionDecl::getNameForDiagnostic ( raw_ostream & OS,
const PrintingPolicy & Policy,
bool Qualified ) const
overridevirtual

Appends a human-readable name for this declaration into the given stream.

This is the method invoked by Sema when displaying a NamedDecl in a diagnostic. It does not necessarily produce the same result as printName(); for example, class template specializations are printed with their template arguments.

Reimplemented from clang::NamedDecl.

Definition at line 3117 of file Decl.cpp.

References clang::TemplateArgumentList::asArray(), clang::NamedDecl::getNameForDiagnostic(), getTemplateSpecializationArgs(), and clang::Qualified.

Referenced by clang::interp::InterpFrame::describe(), and clang::Expr::isPotentialConstantExpr().

◆ getNameInfo()

◆ getNextRedeclarationImpl()

FunctionDecl * clang::FunctionDecl::getNextRedeclarationImpl ( )
inlineoverrideprotectedvirtual

Returns the next redeclaration or itself if this is the only decl.

Decl subclasses that can be redeclared should override this method so that Decl::redecl_iterator can iterate over them.

Reimplemented from clang::Decl.

Definition at line 2161 of file Decl.h.

References FunctionDecl(), and clang::Redeclarable< FunctionDecl >::getNextRedeclaration().

◆ getNonObjectParameter() [1/2]

ParmVarDecl * clang::FunctionDecl::getNonObjectParameter ( unsigned I)
inline

Definition at line 2824 of file Decl.h.

References getParamDecl(), and hasCXXExplicitFunctionObjectParameter().

◆ getNonObjectParameter() [2/2]

◆ getNumNonObjectParams()

◆ getNumParams()

unsigned FunctionDecl::getNumParams ( ) const

Return the number of parameters this function must have based on its FunctionType.

getNumParams - Return the number of parameters this function must have based on its FunctionType.

This is the length of the ParamInfo array after it has been created.

Definition at line 3767 of file Decl.cpp.

References clang::Type::getAs(), clang::FunctionProtoType::getNumParams(), and clang::ValueDecl::getType().

Referenced by clang::Sema::ActOnFinishFunctionBody(), clang::Sema::ActOnFunctionDeclarator(), clang::SemaOpenMP::ActOnOpenMPDeclareVariantDirective(), clang::Sema::ActOnReenterFunctionContext(), addFunctionPointerConversion(), clang::Sema::AddKnownFunctionAttributes(), addX86InterruptAttrs(), allowAmbiguity(), clang::Sema::BuildBlockForLambdaConversion(), clang::SemaSYCL::BuildSYCLKernelCallStmt(), clang::Sema::BuildTypeAwareUsualDelete(), clang::SemaHLSL::CheckCompatibleParameterABI(), clang::Sema::CheckCXXDefaultArguments(), clang::Sema::CheckCXXThrowOperand(), clang::Sema::CheckExplicitlyDefaultedComparison(), clang::Sema::checkLifetimeCaptureBy(), clang::Sema::CheckMain(), CheckOperatorNewDeleteTypes(), clang::Sema::CheckOverloadedOperatorDeclaration(), compareOverloads(), create_call_once(), createOverloadsForFixedParams(), clang::interp::InterpFrame::describe(), DiagnoseBadTarget(), clang::CodeGen::CodeGenFunction::EmitInheritedCXXConstructorCall(), emitReplacement(), evaluateCDTSize(), FunctionsCorrespond(), clang::CodeGen::CodeGenModule::GenKernelArgMetadata(), getMinRequiredArguments(), getNDSWDS(), clang::ento::CXXDeallocatorCall::getNumArgs(), clang::CXXMethodDecl::getNumExplicitParams(), getNumNonObjectParams(), getParamDecl(), getParamDecl(), getParametersSourceRange(), clang::consumed::ConsumedStmtVisitor::handleCall(), handleCleanupAttr(), handleDiagnoseAsBuiltinAttr(), hasCopyOrMoveCtorParam(), hasCXXExplicitFunctionObjectParameter(), hasIdenticalPassObjectSizeAttrs(), hasOneParamOrDefaultArgs(), libc_func_matchers::hasUnsafePrintfStringArg(), libc_func_matchers::hasUnsafeSnprintfBuffer(), clang::Sema::inferLifetimeBoundAttribute(), clang::Sema::InstantiateDefaultCtorDefaultArgs(), clang::CXXConstructorDecl::isConvertingConstructor(), clang::SemaCUDA::isEmptyConstructor(), isNonPlacementDeallocationFunction(), IsPotentiallyDestroyingOperatorDelete(), IsPotentiallyTypeAwareOperatorNewOrDelete(), isRelevantAttr(), isUsableAsGlobalAllocationFunctionInConstantEvaluation(), clang::CXXMethodDecl::isUsualDeallocationFunction(), clang::Sema::isUsualDeallocationFunction(), clang::ast_matchers::matchEachArgumentWithParamTypeImpl(), clang::Sema::MergeCompatibleFunctionDecls(), clang::Sema::MergeCXXFunctionDecl(), clang::Sema::MergeFunctionDecl(), parameters(), parameters(), ProcessAPINotes(), clang::sema::shouldTrackFirstArgument(), clang::Sema::SpecialMemberIsTrivial(), clang::FunctionCallFilterCCC::ValidateCandidate(), clang::sema::visitFunctionCallArguments(), and clang::TextNodeDumper::VisitFunctionDecl().

◆ getODRHash() [1/2]

unsigned FunctionDecl::getODRHash ( )

Returns ODRHash of the function.

This value is calculated and stored on first call, then the stored value returned on the other calls.

Definition at line 4620 of file Decl.cpp.

References clang::ODRHash::AddFunctionDecl(), clang::ODRHash::CalculateHash(), and getInstantiatedFromMemberFunction().

Referenced by clang::ODRDiagsEmitter::diagnoseMismatch(), and clang::ASTDeclWriter::VisitFunctionDecl().

◆ getODRHash() [2/2]

unsigned FunctionDecl::getODRHash ( ) const

Returns cached ODRHash of the function.

This must have been previously computed and stored.

Definition at line 4615 of file Decl.cpp.

◆ getOverloadedOperator()

◆ getParamDecl() [1/2]

ParmVarDecl * clang::FunctionDecl::getParamDecl ( unsigned i)
inline

Definition at line 2798 of file Decl.h.

References getNumParams().

◆ getParamDecl() [2/2]

const ParmVarDecl * clang::FunctionDecl::getParamDecl ( unsigned i) const
inline

Definition at line 2794 of file Decl.h.

References getNumParams().

Referenced by clang::SemaOpenMP::ActOnOpenMPDeclareVariantDirective(), clang::Sema::ActOnReenterFunctionContext(), addFunctionPointerConversion(), clang::Sema::AddKnownFunctionAttributes(), clang::Sema::AddSurrogateCandidate(), addX86InterruptAttrs(), allowAmbiguity(), clang::Sema::BuildBlockForLambdaConversion(), clang::Sema::BuildLiteralOperatorCall(), clang::Sema::BuildTypeAwareUsualDelete(), clang::SemaHLSL::CheckCompatibleParameterABI(), CheckConstexprParameterTypes(), clang::Sema::CheckCXXDefaultArguments(), clang::Sema::CheckCXXThrowOperand(), CheckDeleteOperator(), clang::Sema::CheckExplicitlyDefaultedFunction(), clang::Sema::CheckExplicitlyDefaultedSpecialMember(), clang::Sema::checkLifetimeCaptureBy(), clang::Sema::CheckLiteralOperatorDeclaration(), CheckOperatorDeleteDeclaration(), CheckOperatorNewDeleteTypes(), clang::Sema::CheckOverloadedOperatorDeclaration(), clang::Sema::CheckOverridingFunctionAttributes(), clang::Sema::ConvertArgumentsForCall(), create_call_once(), create_dispatch_once(), create_dispatch_sync(), create_OSAtomicCompareAndSwap(), create_std_move_forward(), clang::Sema::CreateOverloadedBinOp(), clang::Sema::CreateOverloadedUnaryOp(), createOverloadsForFixedParams(), clang::Sema::DeduceTemplateArguments(), clang::Sema::DefineDefaultedComparison(), clang::Sema::DefineImplicitCopyAssignment(), clang::Sema::DefineImplicitMoveAssignment(), clang::interp::InterpFrame::describe(), DiagnoseBadTarget(), DiagnoseInvalidRedeclaration(), clang::ODRDiagsEmitter::diagnoseMismatch(), clang::ODRDiagsEmitter::diagnoseMismatch(), clang::CodeGen::CodeGenFunction::EmitBuiltinExpr(), clang::CodeGen::CodeGenFunction::EmitCXXConstructorCall(), clang::CodeGen::CGHLSLRuntime::emitEntryFunction(), emitReplacement(), evaluateCDTSize(), clang::Sema::findInheritingConstructor(), FunctionsCorrespond(), clang::Sema::GatherArgumentsForCall(), clang::CodeGen::CodeGenModule::GenKernelArgMetadata(), getNDSWDS(), getNonObjectParameter(), getNonObjectParameter(), getPlacementNewBufferArg(), clang::consumed::ConsumedStmtVisitor::handleCall(), handleCleanupAttr(), handleDiagnoseAsBuiltinAttr(), HandleFunctionCall(), HandleLambdaCapture(), hasCopyOrMoveCtorParam(), hasCXXExplicitFunctionObjectParameter(), libc_func_matchers::hasUnsafePrintfStringArg(), libc_func_matchers::hasUnsafeSnprintfBuffer(), clang::Sema::inferLifetimeBoundAttribute(), clang::Sema::InitializeExplicitObjectArgument(), clang::Sema::InstantiateDefaultCtorDefaultArgs(), clang::sema::isAssignmentOperatorLifetimeBound(), clang::CXXConstructorDecl::isCopyConstructor(), clang::sema::isCopyLikeConstructor(), clang::CXXConstructorDecl::isCopyOrMoveConstructor(), isGRealloc(), clang::Sema::isInitListConstructor(), clang::CXXConstructorDecl::isMoveConstructor(), isNonPlacementDeallocationFunction(), clang::sema::isNormalAssignmentOperator(), IsPotentiallyDestroyingOperatorDelete(), IsPotentiallyTypeAwareOperatorNewOrDelete(), isRelevantAttr(), clang::CXXConstructorDecl::isSpecializationCopyingObject(), isStandardRealloc(), isUsableAsGlobalAllocationFunctionInConstantEvaluation(), clang::CXXMethodDecl::isUsualDeallocationFunction(), clang::Sema::MergeCompatibleFunctionDecls(), clang::Sema::MergeCXXFunctionDecl(), clang::Sema::MergeFunctionDecl(), mergeParamDeclAttributes(), clang::Sema::PerformImplicitConversion(), ProcessAPINotes(), clang::Sema::RebuildLambdaScopeInfo(), clang::OverloadCandidateSet::OperatorRewriteInfo::shouldAddReversed(), clang::sema::shouldTrackFirstArgument(), clang::Sema::SpecialMemberIsTrivial(), VerifyInitializationSequenceCXX98(), clang::interp::Compiler< Emitter >::visitCallArgs(), and clang::sema::visitFunctionCallArguments().

◆ getParametersSourceRange()

SourceRange FunctionDecl::getParametersSourceRange ( ) const

Attempt to compute an informative source range covering the function parameters, including the ellipsis of a variadic function.

The source range excludes the parentheses, and is invalid if there are no parameters and no ellipsis.

Definition at line 3981 of file Decl.cpp.

References getEllipsisLoc(), getNumParams(), clang::SourceLocation::isInvalid(), and clang::SourceLocation::isValid().

Referenced by clang::Sema::ConvertArgumentsForCall().

◆ getPointOfInstantiation()

SourceLocation FunctionDecl::getPointOfInstantiation ( ) const

Retrieve the (first) point of instantiation of a function template specialization or a member of a class template specialization.

Returns
the first point of instantiation, if this function was instantiated from a template; otherwise, returns an invalid source location.

Definition at line 4455 of file Decl.cpp.

Referenced by clang::Sema::ActOnExplicitInstantiation().

◆ getPreviousDecl() [1/2]

◆ getPreviousDecl() [2/2]

const FunctionDecl * clang::Redeclarable< FunctionDecl >::getPreviousDecl ( ) const
inline

Definition at line 206 of file Redeclarable.h.

◆ getPreviousDeclImpl()

FunctionDecl * clang::FunctionDecl::getPreviousDeclImpl ( )
inlineoverrideprotectedvirtual

Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain.

Reimplemented from clang::Decl.

Definition at line 2165 of file Decl.h.

References FunctionDecl(), and getPreviousDecl().

◆ getPrimaryTemplate()

◆ getReturnType()

QualType clang::FunctionDecl::getReturnType ( ) const
inline

Definition at line 2842 of file Decl.h.

References clang::Type::castAs(), getReturnType(), and clang::ValueDecl::getType().

Referenced by clang::Sema::ActOnCapScopeReturnStmt(), clang::Sema::ActOnFinishFunctionBody(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnStartOfFunctionDef(), clang::sema::analyzePathForGSLPointer(), clang::CodeGen::CodeGenFunction::BuildFunctionArgList(), buildLambdaScopeReturnType(), clang::Sema::BuildLiteralOperatorCall(), clang::Sema::BuildOverloadedCallExpr(), clang::Sema::BuildReturnStmt(), clang::Sema::BuildSynthesizedThreeWayComparison(), clang::hlsl::BuiltinTypeMethodBuilder::callBuiltin(), clang::interp::CallPtr(), clang::interp::CallVirt(), clang::Sema::CheckAddressOfOperand(), CheckConstexprMissingReturn(), CheckConstexprReturnType(), CheckConstPureAttributesUsage(), clang::Sema::CheckCoroutineWrapper(), clang::Sema::CheckFunctionDeclaration(), clang::SemaARM::CheckSMEFunctionDefAttributes(), clang::SemaSYCL::CheckSYCLEntryPointFunctionDecl(), chooseRecoveryType(), completeFunctionType(), create_OSAtomicCompareAndSwap(), clang::Sema::CreateOverloadedArraySubscriptExpr(), clang::Sema::CreateOverloadedBinOp(), clang::Sema::CreateOverloadedUnaryOp(), clang::Sema::DeduceReturnType(), clang::Sema::DefineImplicitLambdaToFunctionPointerConversion(), DiagnoseConstAssignment(), DiagnoseForRangeReferenceVariableCopies(), clang::ODRDiagsEmitter::diagnoseMismatch(), dumpMicrosoftThunkAdjustment(), clang::CodeGen::CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(), evaluateCDTSize(), clang::comments::DeclInfo::fill(), clang::CodeGen::CodeGenFunction::GenerateCode(), getCallableReturnType(), clang::CXXConversionDecl::getConversionType(), getDeclaredReturnType(), clang::Sema::getMoreSpecializedTemplate(), getNDSWDS(), clang::interp::Context::getOrCreateFunction(), getReturnType(), handleGlobalAttr(), handleMSAllocatorAttr(), clang::Sema::inferLifetimeBoundAttribute(), clang::Sema::InstantiateFunctionDefinition(), clang::sema::isNormalAssignmentOperator(), clang::isPtrConversion(), isRelevantAttr(), clang::Sema::MergeFunctionDecl(), clang::InitializationSequence::Perform(), ProcessAPINotes(), clang::Sema::RebuildLambdaScopeInfo(), clang::sema::shouldTrackFirstArgument(), clang::dataflow::transferSmartPointerLikeCachedDeref(), TryReferenceInit(), and clang::interp::Compiler< Emitter >::visitFunc().

◆ getReturnTypeSourceRange()

◆ getSourceRange()

◆ getStorageClass()

◆ getTemplatedKind()

◆ getTemplateInstantiationPattern()

FunctionDecl * FunctionDecl::getTemplateInstantiationPattern ( bool ForDefinition = true) const

◆ getTemplateSpecializationArgs()

const TemplateArgumentList * FunctionDecl::getTemplateSpecializationArgs ( ) const

Retrieve the template arguments used to produce this function template specialization from the primary template.

If this function declaration is not a function template specialization, returns NULL.

Definition at line 4270 of file Decl.cpp.

Referenced by addInstanceOfTransition(), checkAddressOfFunctionIsAvailable(), clang::Sema::CheckIfFunctionSpecializationIsImmediate(), clang::Sema::DeduceReturnType(), clang::Sema::DefineImplicitLambdaToFunctionPointerConversion(), clang::ODRDiagsEmitter::diagnoseMismatch(), clang::CodeGen::CodeGenFunction::EmitLambdaDelegatingInvokeBody(), getNameForDiagnostic(), isTemplate(), and isTemplate().

◆ getTemplateSpecializationArgsAsWritten()

const ASTTemplateArgumentListInfo * FunctionDecl::getTemplateSpecializationArgsAsWritten ( ) const

Retrieve the template argument list as written in the sources, if any.

If this function declaration is not a function template specialization or if it had no explicit template argument list, returns NULL. Note that it an explicit template argument list may be written empty, e.g., template<> void foo<>(char* s);

Definition at line 4280 of file Decl.cpp.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::TemplateDeclInstantiator::VisitCXXMethodDecl(), and clang::TemplateDeclInstantiator::VisitFunctionDecl().

◆ getTemplateSpecializationInfo()

◆ getTemplateSpecializationKind()

◆ getTemplateSpecializationKindForInstantiation()

TemplateSpecializationKind FunctionDecl::getTemplateSpecializationKindForInstantiation ( ) const

Determine the kind of template specialization this function represents for the purpose of template instantiation.

Definition at line 4382 of file Decl.cpp.

References clang::Decl::FOK_None, clang::Decl::getFriendObjectKind(), clang::isa(), clang::TSK_ExplicitSpecialization, and clang::TSK_Undeclared.

Referenced by isImplicitlyInstantiable().

◆ hasBody() [1/2]

bool clang::FunctionDecl::hasBody ( ) const
inlineoverridevirtual

Returns true if this Decl represents a declaration for a body of code, such as a function or method definition.

Note that hasBody can also return true if any redeclaration of this Decl represents a declaration for a body of code.

Reimplemented from clang::Decl.

Definition at line 2252 of file Decl.h.

References clang::Definition, FunctionDecl(), hasBody(), and hasBody().

Referenced by doesDeclarationForceExternallyVisibleDefinition(), getBody(), hasBody(), and isInlineBuiltinDeclaration().

◆ hasBody() [2/2]

◆ hasCXXExplicitFunctionObjectParameter()

◆ hasImplicitReturnZero()

bool clang::FunctionDecl::hasImplicitReturnZero ( ) const
inline

Whether falling off this function implicitly returns null/zero.

If a more specific implicit return value is required, front-ends should synthesize the appropriate return statements.

Definition at line 2427 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::Sema::ActOnFinishFunctionBody(), clang::CodeGen::CodeGenFunction::GenerateCode(), and clang::ASTDeclWriter::VisitFunctionDecl().

◆ hasInheritedPrototype()

bool clang::FunctionDecl::hasInheritedPrototype ( ) const
inline

Whether this function inherited its prototype from a previous declaration.

Definition at line 2458 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by hasPrototype(), clang::Sema::MergeFunctionDecl(), and clang::ASTDeclWriter::VisitFunctionDecl().

◆ hasOneParamOrDefaultArgs()

bool FunctionDecl::hasOneParamOrDefaultArgs ( ) const

Determine whether this function has a single parameter, or multiple parameters where all but the first have default arguments.

This notion is used in the definition of copy/move constructors and initializer list constructors. Note that, unlike getMinRequiredArguments, parameter packs are not treated specially here.

Definition at line 3820 of file Decl.cpp.

References getNumParams(), clang::ParmVarDecl::hasDefaultArg(), and parameters().

Referenced by clang::CXXConstructorDecl::isCopyOrMoveConstructor(), clang::Sema::isInitListConstructor(), and clang::CXXConstructorDecl::isSpecializationCopyingObject().

◆ hasPrototype()

bool clang::FunctionDecl::hasPrototype ( ) const
inline

Whether this function has a prototype, either because one was explicitly written or because it was "inherited" by merging a declaration without a prototype with a declaration that has a prototype.

Definition at line 2442 of file Decl.h.

References hasInheritedPrototype(), and hasWrittenPrototype().

Referenced by clang::Sema::BuildResolvedCallExpr(), clang::SemaSYCL::BuildSYCLKernelCallStmt(), clang::CIRGen::CIRGenModule::createCIRFunction(), clang::Sema::DeclClonePragmaWeak(), and clang::Sema::MergeFunctionDecl().

◆ hasSkippedBody()

bool clang::FunctionDecl::hasSkippedBody ( ) const
inline

◆ hasTrivialBody()

bool FunctionDecl::hasTrivialBody ( ) const

Returns whether the function has a trivial body that does not require any specific codegen.

Definition at line 3202 of file Decl.cpp.

References clang::cast(), getBody(), and clang::isa().

Referenced by CanSkipVTablePointerInitialization(), HasTrivialDestructorBody(), clang::SemaCUDA::isEmptyConstructor(), clang::SemaCUDA::isEmptyDestructor(), and clang::CodeGen::CodeGenModule::TryEmitBaseDestructorAsAlias().

◆ hasWrittenPrototype()

◆ instantiationIsPending()

bool clang::FunctionDecl::instantiationIsPending ( ) const
inline

Whether the instantiation of this function is pending.

This bit is set when the decision to instantiate this function is made and unset if and when the function body is created. That leaves out cases where instantiation did not happen because the template definition was not seen in this TU. This bit remains set in those cases, under the assumption that the instantiation will happen in some other TU.

Definition at line 2506 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

◆ isAnalyzerNoReturn()

bool FunctionDecl::isAnalyzerNoReturn ( ) const

Determines whether this function is known to be 'noreturn' for analyzer, through an analyzer_noreturn attribute on its declaration.

Definition at line 3603 of file Decl.cpp.

References clang::Decl::hasAttr().

◆ isConsteval()

◆ isConstexpr()

◆ isConstexprSpecified()

bool clang::FunctionDecl::isConstexprSpecified ( ) const
inline

Definition at line 2478 of file Decl.h.

References clang::Constexpr, and getConstexprKind().

Referenced by handleMSConstexprAttr(), and isImmediateEscalating().

◆ isCPUDispatchMultiVersion()

bool FunctionDecl::isCPUDispatchMultiVersion ( ) const

True if this function is a multiversioned dispatch function as a part of the cpu_specific/cpu_dispatch functionality.

Definition at line 3643 of file Decl.cpp.

References clang::Decl::hasAttr(), and isMultiVersion().

Referenced by clang::Sema::ActOnFunctionDeclarator(), CheckFallThroughForBody(), and IsCPUDispatchCPUSpecificMultiVersion().

◆ isCPUSpecificMultiVersion()

bool FunctionDecl::isCPUSpecificMultiVersion ( ) const

True if this function is a multiversioned processor specific function as a part of the cpu_specific/cpu_dispatch functionality.

Definition at line 3647 of file Decl.cpp.

References clang::Decl::hasAttr(), and isMultiVersion().

Referenced by clang::Sema::ActOnFunctionDeclarator(), and IsCPUDispatchCPUSpecificMultiVersion().

◆ isDefaulted()

bool clang::FunctionDecl::isDefaulted ( ) const
inline

Whether this function is defaulted.

Valid for e.g. special member functions, defaulted comparisions (not methods!).

Definition at line 2384 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::Sema::ActOnFinishFunctionBody(), clang::Sema::AddImplicitMSFunctionNoBuiltinAttr(), clang::Sema::areMultiversionVariantFunctionsCompatible(), clang::Sema::CheckCompletedCXXClass(), checkMoveAssignmentForRepeatedMove(), clang::SemaSYCL::CheckSYCLEntryPointFunctionDecl(), clang::Sema::DefineDefaultedComparison(), clang::Sema::DefineImplicitCopyAssignment(), clang::Sema::DefineImplicitMoveAssignment(), clang::Sema::DiagnoseDeletedDefaultedFunction(), clang::Sema::diagnoseZeroToNullptrConversion(), clang::CodeGen::CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(), clang::CIRGen::CIRGenFunction::emitCXXMemberOrOperatorMemberCallExpr(), emitMemberInitializer(), clang::CodeGen::CodeGenFunction::GenerateCode(), HandleFunctionCall(), initNeedsOverridenLoc(), clang::Sema::InstantiateFunctionDefinition(), IsDefaultMovable(), isDeletedAsWritten(), isImmediateEscalating(), clang::Sema::isImplicitlyDeleted(), isMemcpyEquivalentSpecialMember(), IsStructurallyEquivalent(), isThisDeclarationADefinition(), clang::Sema::SetDeclDefaulted(), TryValueInitialization(), clang::interp::Compiler< Emitter >::VisitCXXConstructExpr(), clang::ASTDeclReader::VisitFunctionDecl(), clang::ASTDeclWriter::VisitFunctionDecl(), clang::ASTNodeImporter::VisitFunctionDecl(), clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitFunctionDecl(), clang::JSONNodeDumper::VisitFunctionDecl(), and clang::TextNodeDumper::VisitFunctionDecl().

◆ isDefined() [1/2]

bool clang::FunctionDecl::isDefined ( ) const
inline

Definition at line 2275 of file Decl.h.

References clang::Definition, FunctionDecl(), and isDefined().

Referenced by getDefinition(), getTemplateInstantiationPattern(), and isDefined().

◆ isDefined() [2/2]

bool FunctionDecl::isDefined ( const FunctionDecl *& Definition,
bool CheckForPendingFriendDefinition = false ) const

Returns true if the function has a definition that does not need to be instantiated.

The variant that accepts a FunctionDecl pointer will set that function declaration to the declaration that is a definition (if there is one).

Parameters
CheckForPendingFriendDefinitionIf true, also check for friend declarations that were instantiated from function definitions. Such a declaration behaves as if it is a definition for the purpose of redefinition checking, but isn't actually a "real" definition until its body is instantiated.

Definition at line 3238 of file Decl.cpp.

References clang::Definition, FunctionDecl(), and redecls().

Referenced by clang::Sema::ActOnFinishFunctionBody(), clang::interp::CheckCallable(), clang::Sema::CheckForFunctionRedefinition(), clang::CodeGen::CodeGenFunction::GenerateVarArgsThunk(), getMethodBody(), clang::CXXMethodDecl::hasInlineBody(), clang::TemplateDeclInstantiator::InitFunctionInstantiation(), clang::SemaCUDA::isEmptyConstructor(), clang::SemaCUDA::isEmptyDestructor(), clang::Sema::isUnavailableAlignedAllocationFunction(), clang::Sema::MarkVTableUsed(), clang::Sema::MergeCXXFunctionDecl(), clang::Sema::MergeFunctionDecl(), and clang::Sema::PerformPendingInstantiations().

◆ isDeleted()

bool clang::FunctionDecl::isDeleted ( ) const
inline

Whether this function has been deleted.

A function that is "deleted" (via the C++0x "= delete" syntax) acts like a normal function, except that it cannot actually be called or have its address taken. Deleted functions are typically used in C++ overload resolution to attract arguments whose type or lvalue/rvalue-ness would permit the use of a different overload that would behave incorrectly. For example, one might use deleted functions to ban implicit conversion from a floating-point number to an Integer type:

struct Integer {
Integer(long); // construct from a long
Integer(double) = delete; // no construction from float or double
Integer(long double) = delete; // no construction from long double
};

Definition at line 2539 of file Decl.h.

References clang::DeclContext::FunctionDeclBits, and getCanonicalDecl().

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::Sema::ActOnFinishFunctionBody(), clang::Sema::AddImplicitMSFunctionNoBuiltinAttr(), clang::Sema::areMultiversionVariantFunctionsCompatible(), clang::Sema::checkClassLevelDLLAttribute(), clang::Sema::CheckCompletedCXXClass(), clang::Sema::CheckCXXThrowOperand(), CheckDeleteOperator(), clang::Sema::CheckMemberSpecialization(), clang::SemaSYCL::CheckSYCLEntryPointFunctionDecl(), clang::Sema::DefineDefaultedComparison(), clang::Sema::DefineImplicitCopyAssignment(), clang::Sema::DefineImplicitMoveAssignment(), clang::Sema::DiagnoseDeletedDefaultedFunction(), EvaluateUnaryTypeTrait(), clang::Sema::findInheritingConstructor(), clang::CXXRecordDecl::finishedDefaultedOrDeletedMember(), IsDefaultMovable(), clang::Sema::isImplicitlyDeleted(), IsStructurallyEquivalent(), clang::Sema::LookupSpecialMember(), clang::Sema::MarkVTableUsed(), ShouldWarnAboutMissingPrototype(), TryValueInitialization(), clang::JSONNodeDumper::VisitFunctionDecl(), clang::TemplateDeclInstantiator::VisitFunctionDecl(), and clang::TextNodeDumper::VisitFunctionDecl().

◆ isDeletedAsWritten()

◆ isDestroyingOperatorDelete()

◆ isExplicitlyDefaulted()

◆ isExternC()

◆ isFirstDecl()

bool clang::Redeclarable< FunctionDecl >::isFirstDecl ( ) const
inline

True if this is the first declaration in its redeclaration chain.

Definition at line 220 of file Redeclarable.h.

Referenced by clang::Sema::ActOnFunctionDeclarator().

◆ isFunctionTemplateSpecialization()

◆ isGlobal()

◆ isImmediateEscalating()

◆ isImmediateFunction()

◆ isImplicitlyInstantiable()

bool FunctionDecl::isImplicitlyInstantiable ( ) const

Determines whether this function is a function template specialization or a member of a class template specialization that can be implicitly instantiated.

Definition at line 4163 of file Decl.cpp.

References FunctionDecl(), getTemplateInstantiationPattern(), getTemplateSpecializationKindForInstantiation(), hasBody(), isInlined(), clang::Decl::isInvalidDecl(), clang::TSK_ExplicitInstantiationDeclaration, clang::TSK_ExplicitInstantiationDefinition, clang::TSK_ExplicitSpecialization, clang::TSK_ImplicitInstantiation, and clang::TSK_Undeclared.

◆ isIneligibleOrNotSelected()

bool clang::FunctionDecl::isIneligibleOrNotSelected ( ) const
inline

◆ isInExternCContext()

bool FunctionDecl::isInExternCContext ( ) const

Determines whether this function's context is, or is nested within, a C++ extern "C" linkage spec.

Definition at line 3563 of file Decl.cpp.

References clang::Decl::getAttr(), clang::Decl::getLexicalDeclContext(), and clang::DeclContext::isExternCContext().

◆ isInExternCXXContext()

bool FunctionDecl::isInExternCXXContext ( ) const

Determines whether this function's context is, or is nested within, a C++ extern "C++" linkage spec.

Definition at line 3569 of file Decl.cpp.

References clang::Decl::getLexicalDeclContext(), and clang::DeclContext::isExternCXXContext().

◆ isInlineBuiltinDeclaration()

bool FunctionDecl::isInlineBuiltinDeclaration ( ) const

◆ isInlined()

◆ isInlineDefinitionExternallyVisible()

bool FunctionDecl::isInlineDefinitionExternallyVisible ( ) const

For an inline function definition in C, or for a gnu_inline function in C++, determine whether the definition will be externally visible.

Inline function definitions are always available for inlining optimizations. However, depending on the language dialect, declaration specifiers, and attributes, the definition of an inline function may or may not be "externally" visible to other translation units in the program.

In C99, inline definitions are not externally visible by default. However, if even one of the global-scope declarations is marked "extern inline", the inline definition becomes externally visible (C99 6.7.4p6).

In GNU89 mode, or if the gnu_inline attribute is attached to the function definition, we use the GNU semantics for inline, which are nearly the opposite of C99 semantics. In particular, "inline" by itself will create an externally visible symbol, but "extern inline" will not create an externally visible symbol.

Definition at line 4019 of file Decl.cpp.

References doesThisDeclarationHaveABody(), clang::Decl::getASTContext(), getStorageClass(), clang::Decl::hasAttr(), isInlined(), isInlineSpecified(), RedeclForcesDefC99(), redecls(), clang::SC_Extern, and willHaveBody().

Referenced by basicGVALinkageForFunction().

◆ isInlineSpecified()

◆ isInstantiatedFromMemberTemplate()

bool clang::FunctionDecl::isInstantiatedFromMemberTemplate ( ) const
inline

◆ isLateTemplateParsed()

bool clang::FunctionDecl::isLateTemplateParsed ( ) const
inline

◆ isMain()

◆ isMemberLikeConstrainedFriend()

bool FunctionDecl::isMemberLikeConstrainedFriend ( ) const

Determine whether a function is a friend function that cannot be redeclared outside of its class, per C++ [temp.friend]p9.

Definition at line 3607 of file Decl.cpp.

References FriendConstraintRefersToEnclosingTemplate(), getDescribedFunctionTemplate(), clang::Decl::getFriendObjectKind(), clang::DeclaratorDecl::getTrailingRequiresClause(), and clang::AssociatedConstraint::isNull().

Referenced by IsOverloadOrOverrideImpl().

◆ isMSExternInline()

bool FunctionDecl::isMSExternInline ( ) const

The combination of the extern and inline keywords under MSVC forces the function to be required.

Note: This function assumes that we will only get called when isInlined() would return true for this FunctionDecl.

Definition at line 3832 of file Decl.cpp.

References FunctionDecl(), clang::Decl::getASTContext(), getMostRecentDecl(), getPreviousDecl(), clang::Decl::hasAttr(), isInlined(), and clang::SC_Extern.

Referenced by basicGVALinkageForFunction().

◆ isMSVCRTEntryPoint()

◆ isMultiVersion()

◆ isNoReturn()

bool FunctionDecl::isNoReturn ( ) const

Determines whether this function is known to be 'noreturn', through an attribute on its declaration or its type.

Definition at line 3592 of file Decl.cpp.

References clang::ValueDecl::getType(), and clang::Decl::hasAttr().

Referenced by clang::Sema::BuildReturnStmt(), clang::Sema::CheckCompletedCoroutineBody(), clang::SemaSYCL::CheckSYCLEntryPointFunctionDecl(), and clang::inferNoReturnAttr().

◆ isOutOfLine()

bool FunctionDecl::isOutOfLine ( ) const
overridevirtual

◆ isOverloadedOperator()

bool clang::FunctionDecl::isOverloadedOperator ( ) const
inline

◆ isPureVirtual()

◆ isReferenceableKernel()

bool FunctionDecl::isReferenceableKernel ( ) const

◆ isReplaceableGlobalAllocationFunction()

bool clang::FunctionDecl::isReplaceableGlobalAllocationFunction ( UnsignedOrNone * AlignmentParam = nullptr,
bool * IsNothrow = nullptr ) const
inline

Determines whether this function is one of the replaceable global allocation functions: void *operator new(size_t); void *operator new(size_t, const std::nothrow_t &) noexcept; void *operator new[](size_t); void *operator new[](size_t, const std::nothrow_t &) noexcept; void operator delete(void *) noexcept; void operator delete(void *, std::size_t) noexcept; [C++1y] void operator delete(void *, const std::nothrow_t &) noexcept; void operator delete[](void *) noexcept; void operator delete[](void *, std::size_t) noexcept; [C++1y] void operator delete[](void *, const std::nothrow_t &) noexcept; These functions have special behavior under C++1y [expr.new]: An implementation is allowed to omit a call to a replaceable global allocation function.

[...]

If this function is an aligned allocation/deallocation function, return the parameter number of the requested alignment through AlignmentParam.

If this function is an allocation/deallocation function that takes the std::nothrow_t tag, return true through IsNothrow,

Definition at line 2593 of file Decl.h.

References isTypeAwareOperatorNewOrDelete(), and isUsableAsGlobalAllocationFunctionInConstantEvaluation().

Referenced by clang::Sema::ActOnFunctionDeclarator(), clang::Sema::AddKnownFunctionAttributesForReplaceableGlobalAllocationFunction(), EmitNewDeleteCall(), clang::Sema::isUnavailableAlignedAllocationFunction(), resolveBuiltinNewDeleteOverload(), and clang::ento::ExprEngine::VisitCXXNewExpr().

◆ isReservedGlobalPlacementOperator()

bool FunctionDecl::isReservedGlobalPlacementOperator ( ) const

Determines whether this operator new or delete is one of the reserved global placement operators: void *operator new(size_t, void *); void *operator new[](size_t, void *); void operator delete(void *, void *); void operator delete[](void *, void *); These functions have special behavior under [new.delete.placement]: These functions are reserved, a C++ program may not define functions that displace the versions in the Standard C++ library.

The provisions of [basic.stc.dynamic] do not apply to these reserved placement forms of operator new and operator delete.

This function must be an allocation or deallocation function.

Definition at line 3391 of file Decl.cpp.

References clang::cast(), clang::Type::castAs(), clang::Decl::getDeclContext(), clang::NamedDecl::getDeclName(), clang::DeclContext::getRedeclContext(), clang::ValueDecl::getType(), clang::DeclContext::isTranslationUnit(), and isTypeAwareOperatorNewOrDelete().

Referenced by CalculateCookiePadding(), clang::CodeGen::CodeGenFunction::EmitCXXNewExpr(), clang::CIRGen::CIRGenFunction::emitCXXNewExpr(), clang::CXXNewExpr::shouldNullCheckAllocation(), and clang::ento::ExprEngine::VisitCXXNewExpr().

◆ isStatic()

◆ isTargetClonesMultiVersion()

bool FunctionDecl::isTargetClonesMultiVersion ( ) const

True if this function is a multiversioned dispatch function as a part of the target-clones functionality.

Definition at line 3665 of file Decl.cpp.

References clang::Decl::hasAttr(), and isMultiVersion().

◆ isTargetMultiVersion()

bool FunctionDecl::isTargetMultiVersion ( ) const

True if this function is a multiversioned dispatch function as a part of the target functionality.

Definition at line 3651 of file Decl.cpp.

References clang::Decl::hasAttr(), and isMultiVersion().

Referenced by isNonViableMultiVersionOverload().

◆ isTargetMultiVersionDefault()

bool FunctionDecl::isTargetMultiVersionDefault ( ) const

True if this function is the default version of a multiversioned dispatch function as a part of the target functionality.

Definition at line 3656 of file Decl.cpp.

References clang::Decl::getAttr(), clang::Decl::hasAttr(), and isMultiVersion().

Referenced by isNonViableMultiVersionOverload().

◆ isTargetVersionMultiVersion()

bool FunctionDecl::isTargetVersionMultiVersion ( ) const

True if this function is a multiversioned dispatch function as a part of the target-version functionality.

Definition at line 3669 of file Decl.cpp.

References clang::Decl::hasAttr(), and isMultiVersion().

◆ isTemplateInstantiation()

◆ isThisDeclarationADefinition()

bool clang::FunctionDecl::isThisDeclarationADefinition ( ) const
inline

Returns whether this specific declaration of the function is also a definition that does not contain uninstantiated body.

This does not determine whether the function has been defined (e.g., in a previous definition); for that information, use isDefined.

Note: the function declaration does not become a definition until the parser reaches the definition, if called before, this function will return false.

Definition at line 2313 of file Decl.h.

References doesThisDeclarationHaveABody(), clang::Decl::hasDefiningAttr(), hasSkippedBody(), isDefaulted(), isDeletedAsWritten(), and willHaveBody().

Referenced by clang::Sema::ActOnStartOfFunctionDef(), clang::Sema::CheckImplicitSpecialMemberDeclaration(), clang::interp::ByteCodeEmitter::compileFunc(), handleAliasAttr(), handleIFuncAttr(), clang::Sema::InstantiateFunctionDefinition(), clang::FunctionTemplateDecl::isThisDeclarationADefinition(), clang::CallGraph::VisitFunctionDecl(), and clang::TemplateDeclInstantiator::VisitFunctionDecl().

◆ isThisDeclarationInstantiatedFromAFriendDefinition()

bool FunctionDecl::isThisDeclarationInstantiatedFromAFriendDefinition ( ) const

Determine whether this specific declaration of the function is a friend declaration that was instantiated from a function definition.

Such declarations behave like definitions in some contexts.

Definition at line 3215 of file Decl.cpp.

References FunctionDecl(), getDescribedFunctionTemplate(), clang::Decl::getFriendObjectKind(), getInstantiatedFromMemberFunction(), and clang::Template.

Referenced by clang::Sema::ActOnStartOfFunctionDef(), and clang::Sema::InstantiateFunctionDefinition().

◆ isTrivial()

bool clang::FunctionDecl::isTrivial ( ) const
inline

Whether this function is "trivial" in some specialized C++ senses.

Can only be true for default constructors, copy constructors, copy assignment operators, and destructors. Not meaningful until the class has been fully built by Sema.

Definition at line 2376 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::CXXRecordDecl::addedEligibleSpecialMemberFunction(), clang::Sema::BuildExceptionDeclaration(), buildSingleCopyAssignRecursively(), clang::Sema::checkClassLevelDLLAttribute(), clang::Sema::CheckCXXThrowOperand(), checkMoveAssignmentForRepeatedMove(), CheckTrivialDefaultConstructor(), DiagnoseNonTriviallyCopyableReason(), clang::CodeGen::CodeGenFunction::EmitCXXConstructExpr(), clang::CIRGen::CIRGenFunction::emitCXXConstructExpr(), clang::CodeGen::CodeGenFunction::EmitCXXConstructorCall(), clang::CodeGen::CodeGenFunction::EmitCXXMemberOrOperatorMemberCallExpr(), clang::CIRGen::CIRGenFunction::emitCXXMemberOrOperatorMemberCallExpr(), clang::CodeGen::CodeGenFunction::EmitNewArrayInitializer(), clang::CodeGen::CodeGenFunction::EnterDtorCleanups(), findTrivialSpecialMember(), clang::CXXRecordDecl::finishedDefaultedOrDeletedMember(), GetDiagForGotoScopeDecl(), HandleDestructionImpl(), HandleFunctionCall(), clang::Expr::HasSideEffects(), clang::interp::Record::hasTrivialDtor(), initNeedsOverridenLoc(), clang::Expr::isConstantInitializer(), clang::SemaCUDA::isEmptyConstructor(), clang::SemaCUDA::isEmptyDestructor(), isMemcpyEquivalentSpecialMember(), isTrivialObjectAssignment(), clang::Sema::MergeFunctionDecl(), clang::interp::runRecordDestructor(), ShouldDiagnoseUnusedDecl(), clang::CIRGen::ConstantEmitter::tryEmitPrivateForVarInit(), clang::CodeGen::ConstantEmitter::tryEmitPrivateForVarInit(), clang::interp::Compiler< Emitter >::VisitCXXConstructExpr(), clang::interp::Compiler< Emitter >::VisitCXXInheritedCtorInitExpr(), clang::ASTDeclWriter::VisitFunctionDecl(), clang::ASTNodeImporter::VisitFunctionDecl(), and clang::TextNodeDumper::VisitFunctionDecl().

◆ isTrivialForCall()

◆ isTypeAwareOperatorNewOrDelete()

◆ isUsableAsGlobalAllocationFunctionInConstantEvaluation()

bool FunctionDecl::isUsableAsGlobalAllocationFunctionInConstantEvaluation ( UnsignedOrNone * AlignmentParam = nullptr,
bool * IsNothrow = nullptr ) const

Determines whether this function is one of the replaceable global allocation functions described in isReplaceableGlobalAllocationFunction, or is a function that may be treated as such during constant evaluation.

This adds support for potentially templated type aware global allocation functions of the form: void operator new(type-identity, std::size_t, std::align_val_t) void *operator new(type-identity, std::size_t, std::align_val_t, const std::nothrow_t &) noexcept; void *operator new[](type-identity, std::size_t, std::align_val_t) void *operator new[](type-identity, std::size_t, std::align_val_t, const std::nothrow_t &) noexcept; void operator delete(type-identity, void, std::size_t, std::align_val_t) noexcept; void operator delete(type-identity, void*, std::size_t, std::align_val_t, const std::nothrow_t&) noexcept; void operator delete[](type-identity, void*, std::size_t, std::align_val_t) noexcept; void operator delete[](type-identity, void*, std::size_t, std::align_val_t, const std::nothrow_t&) noexcept; Where type-identity is a specialization of std::type_identity. If the declaration is a templated function, it may not include a parameter pack in the argument list, the type-identity parameter is required to be dependent, and is the only permitted dependent parameter.

Definition at line 3414 of file Decl.cpp.

References clang::Type::castAs(), clang::Qualifiers::Const, clang::Decl::getASTContext(), clang::QualType::getCVRQualifiers(), clang::Decl::getDeclContext(), clang::NamedDecl::getDeclName(), clang::ASTContext::getLangOpts(), getNumParams(), getParamDecl(), clang::Type::getPointeeType(), clang::DeclContext::getRedeclContext(), clang::ASTContext::getSizeType(), clang::ValueDecl::getType(), clang::ASTContext::hasSameType(), clang::isa(), clang::Type::isAlignValT(), clang::DeclarationName::isAnyOperatorDelete(), clang::Type::isEnumeralType(), clang::Type::isNothrowT(), clang::QualType::isNull(), clang::Type::isReferenceType(), clang::IdentifierInfo::isStr(), clang::DeclContext::isTranslationUnit(), isTypeAwareOperatorNewOrDelete(), isVariadic(), RequiredTypeAwareDeleteParameterCount, RequiredTypeAwareNewParameterCount, and clang::T.

Referenced by clang::interp::Free(), isReplaceableGlobalAllocationFunction(), and clang::interp::Compiler< Emitter >::VisitCallExpr().

◆ isUserProvided()

◆ isVariadic()

◆ isVirtualAsWritten()

◆ param_begin() [1/2]

◆ param_begin() [2/2]

param_const_iterator clang::FunctionDecl::param_begin ( ) const
inline

Definition at line 2785 of file Decl.h.

References parameters().

◆ param_empty()

◆ param_end() [1/2]

◆ param_end() [2/2]

param_const_iterator clang::FunctionDecl::param_end ( ) const
inline

Definition at line 2786 of file Decl.h.

References parameters().

◆ param_size()

◆ parameters() [1/2]

MutableArrayRef< ParmVarDecl * > clang::FunctionDecl::parameters ( )
inline

Definition at line 2774 of file Decl.h.

References getNumParams().

◆ parameters() [2/2]

ArrayRef< ParmVarDecl * > clang::FunctionDecl::parameters ( ) const
inline

Definition at line 2771 of file Decl.h.

References getNumParams().

Referenced by clang::Sema::ActOnFinishFunctionBody(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnStartOfFunctionDef(), addFunctionPointerConversion(), clang::CodeGen::CodeGenFunction::BuildFunctionArgList(), clang::SemaSYCL::BuildSYCLKernelCallStmt(), clang::Sema::BuildTypeAwareUsualDelete(), canEmitDelegateCallArgs(), checkAddressOfFunctionIsAvailable(), clang::Sema::CheckAddressOfOperand(), CheckCompleteParameterTypesForMangler(), clang::SemaHLSL::CheckEntryPoint(), clang::Sema::CheckExplicitlyDefaultedComparison(), clang::Sema::CheckFunctionDeclaration(), clang::Sema::CheckLiteralOperatorDeclaration(), CheckNonNullArguments(), CheckOperatorDeleteDeclaration(), clang::Sema::CheckOverloadedOperatorDeclaration(), clang::SemaARM::CheckSMEFunctionDefAttributes(), checkVAStartIsInVariadicFunction(), collectPlacementArgs(), compareOverloads(), clang::interp::ByteCodeEmitter::compileFunc(), clang::Sema::DeclareImplicitDeductionGuides(), clang::Sema::DiagnoseAlwaysNonNullPointer(), clang::CodeGen::CodeGenFunction::EmitCallAndReturnForThunk(), clang::CodeGen::CGOpenMPRuntime::emitDeclareSimdFunction(), clang::CodeGen::CodeGenFunction::EmitLambdaDelegatingInvokeBody(), clang::comments::DeclInfo::fill(), functionDeclHasDefaultArgument(), functionHasPassObjectSizeParams(), clang::CodeGen::CodeGenFunction::GenerateCode(), clang::CXXMethodDecl::getFunctionObjectParameterReferenceType(), getMinRequiredArguments(), clang::Sema::getMoreSpecializedTemplate(), clang::interp::Context::getOrCreateFunction(), handleCallbackAttr(), hasNonTrivialConstructorCall(), hasOneParamOrDefaultArgs(), clang::ASTNodeImporter::ImportDeclParts(), clang::interp::EvalEmitter::interpretCall(), isOSObjectRelated(), clang::Sema::LazyProcessLifetimeCaptureByParams(), param_begin(), param_begin(), param_empty(), param_end(), param_end(), param_size(), clang::ento::AnyFunctionCall::parameters(), ProcessAPINotes(), clang::TreeTransform< AdjustConstraintDepth >::RebuildLambdaExpr(), clang::consumed::ConsumedAnalyzer::run(), setPrototype(), clang::TemplateDeclInstantiator::SubstFunctionType(), SubstituteConstraintExpressionWithoutSatisfaction(), clang::interp::Compiler< Emitter >::VisitCXXInheritedCtorInitExpr(), clang::ASTDeclWriter::VisitFunctionDecl(), clang::ASTNodeImporter::VisitFunctionDecl(), clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitFunctionDecl(), and clang::ASTNodeTraverser< Derived, NodeDelegateType >::VisitLambdaExpr().

◆ redecls()

◆ redecls_begin()

redecl_iterator clang::Redeclarable< FunctionDecl >::redecls_begin ( ) const
inline

Definition at line 299 of file Redeclarable.h.

◆ redecls_end()

redecl_iterator clang::Redeclarable< FunctionDecl >::redecls_end ( ) const
inline

Definition at line 300 of file Redeclarable.h.

Referenced by clang::Sema::MergeFunctionDecl().

◆ setBody()

◆ setBodyContainsImmediateEscalatingExpressions()

void clang::FunctionDecl::setBodyContainsImmediateEscalatingExpressions ( bool Set)
inline

◆ setConstexprKind()

◆ setDeclarationNameLoc()

void clang::FunctionDecl::setDeclarationNameLoc ( DeclarationNameLoc L)
inline

Definition at line 2219 of file Decl.h.

◆ setDefaulted()

◆ setDefaultedOrDeletedInfo()

◆ setDefaultLoc()

void clang::FunctionDecl::setDefaultLoc ( SourceLocation NewLoc)
inline

◆ setDeletedAsWritten()

◆ setDependentTemplateSpecialization()

void FunctionDecl::setDependentTemplateSpecialization ( ASTContext & Context,
const UnresolvedSetImpl & Templates,
const TemplateArgumentListInfo * TemplateArgs )

Specifies that this function declaration is actually a dependent function template specialization.

Definition at line 4319 of file Decl.cpp.

References clang::DependentFunctionTemplateSpecializationInfo::Create().

Referenced by clang::Sema::CheckDependentFunctionTemplateSpecialization(), clang::ASTNodeImporter::ImportTemplateInformation(), and clang::ASTDeclReader::VisitFunctionDecl().

◆ setDescribedFunctionTemplate()

◆ setExplicitlyDefaulted()

void clang::FunctionDecl::setExplicitlyDefaulted ( bool ED = true)
inline

State that this function is explicitly defaulted.

Definition at line 2393 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::ASTDeclReader::VisitFunctionDecl(), and clang::ASTNodeImporter::VisitFunctionDecl().

◆ setFriendConstraintRefersToEnclosingTemplate()

void clang::FunctionDecl::setFriendConstraintRefersToEnclosingTemplate ( bool V = true)
inline

◆ setFunctionTemplateSpecialization()

void clang::FunctionDecl::setFunctionTemplateSpecialization ( FunctionTemplateDecl * Template,
TemplateArgumentList * TemplateArgs,
void * InsertPos,
TemplateSpecializationKind TSK = TSK_ImplicitInstantiation,
TemplateArgumentListInfo * TemplateArgsAsWritten = nullptr,
SourceLocation PointOfInstantiation = SourceLocation() )
inline

Specify that this function declaration is actually a function template specialization.

Parameters
Templatethe function template that this function template specialization specializes.
TemplateArgsthe template arguments that produced this function template specialization from the template.
InsertPosIf non-NULL, the position in the function template specialization set where the function template specialization data will be inserted.
TSKthe kind of template specialization this is.
TemplateArgsAsWrittenlocation info of template arguments.
PointOfInstantiationpoint at which the function template specialization was first instantiated.

Definition at line 3071 of file Decl.h.

References clang::Decl::getASTContext(), clang::Template, and clang::TSK_ImplicitInstantiation.

◆ setHasImplicitReturnZero()

void clang::FunctionDecl::setHasImplicitReturnZero ( bool IRZ)
inline

State that falling off this function implicitly returns null/zero.

If a more specific implicit return value is required, front-ends should synthesize the appropriate return statements.

Definition at line 2434 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::Sema::CheckMain(), clang::Sema::CheckMSVCRTEntryPoint(), and clang::ASTDeclReader::VisitFunctionDecl().

◆ setHasInheritedPrototype()

void clang::FunctionDecl::setHasInheritedPrototype ( bool P = true)
inline

State that this function inherited its prototype from a previous declaration.

Definition at line 2464 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::ASTDeclReader::VisitFunctionDecl().

◆ setHasSkippedBody()

void clang::FunctionDecl::setHasSkippedBody ( bool Skipped = true)
inline

◆ setHasWrittenPrototype()

void clang::FunctionDecl::setHasWrittenPrototype ( bool P = true)
inline

State that this function has a written prototype.

Definition at line 2452 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::ASTDeclReader::VisitFunctionDecl().

◆ setImplicitlyInline()

void clang::FunctionDecl::setImplicitlyInline ( bool I = true)
inline

◆ setIneligibleOrNotSelected()

void clang::FunctionDecl::setIneligibleOrNotSelected ( bool II)
inline

◆ setInlineSpecified()

void clang::FunctionDecl::setInlineSpecified ( bool I)
inline

Set whether the "inline" keyword was specified for this function.

Definition at line 2899 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::ASTDeclReader::VisitFunctionDecl().

◆ setInstantiatedFromDecl()

void FunctionDecl::setInstantiatedFromDecl ( FunctionDecl * FD)

Specify that this function declaration was instantiated from a FunctionDecl FD.

This is only used if this is a function declaration declared locally inside of a function template.

Definition at line 4152 of file Decl.cpp.

References FunctionDecl().

Referenced by clang::ASTNodeImporter::ImportTemplateInformation(), and clang::ASTDeclReader::VisitFunctionDecl().

◆ setInstantiatedFromMemberTemplate()

void clang::FunctionDecl::setInstantiatedFromMemberTemplate ( bool Val = true)
inline

◆ setInstantiationIsPending()

void clang::FunctionDecl::setInstantiationIsPending ( bool IC)
inline

State that the instantiation of this function is pending.

(see instantiationIsPending)

Definition at line 2512 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::Sema::PerformPendingInstantiations().

◆ setInstantiationOfMemberFunction()

void clang::FunctionDecl::setInstantiationOfMemberFunction ( FunctionDecl * FD,
TemplateSpecializationKind TSK )
inline

Specify that this record is an instantiation of the member function FD.

Definition at line 2971 of file Decl.h.

References FunctionDecl(), and clang::Decl::getASTContext().

◆ setIsDestroyingOperatorDelete()

void FunctionDecl::setIsDestroyingOperatorDelete ( bool IsDestroyingDelete)

◆ setIsMultiVersion()

void clang::FunctionDecl::setIsMultiVersion ( bool V = true)
inline

◆ setIsPureVirtual()

◆ setIsTypeAwareOperatorNewOrDelete()

void FunctionDecl::setIsTypeAwareOperatorNewOrDelete ( bool IsTypeAwareOperator = true)

◆ setLateTemplateParsed()

void clang::FunctionDecl::setLateTemplateParsed ( bool ILT = true)
inline

State that this templated function will be late parsed.

Definition at line 2361 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::Sema::MarkAsLateParsedTemplate(), clang::Sema::UnmarkAsLateParsedTemplate(), and clang::ASTDeclReader::VisitFunctionDecl().

◆ setLazyBody()

void clang::FunctionDecl::setLazyBody ( uint64_t Offset)
inline

Definition at line 2331 of file Decl.h.

References Body, and clang::DeclContext::FunctionDeclBits.

◆ setParams()

void clang::FunctionDecl::setParams ( ArrayRef< ParmVarDecl * > NewParamInfo)
inline

◆ setPreviousDeclaration()

void FunctionDecl::setPreviousDeclaration ( FunctionDecl * PrevDecl)

◆ setRangeEnd()

void clang::FunctionDecl::setRangeEnd ( SourceLocation E)
inline

◆ setStorageClass()

void clang::FunctionDecl::setStorageClass ( StorageClass SClass)
inline

Sets the storage class as written in the source.

Definition at line 2890 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::ASTDeclReader::VisitFunctionDecl().

◆ setTemplateSpecializationKind()

void FunctionDecl::setTemplateSpecializationKind ( TemplateSpecializationKind TSK,
SourceLocation PointOfInstantiation = SourceLocation() )

Determine what kind of template instantiation this function represents.

Definition at line 4427 of file Decl.cpp.

References clang::Decl::getASTContext(), clang::Decl::getASTMutationListener(), clang::SourceLocation::isValid(), and clang::TSK_ExplicitSpecialization.

◆ setTrivial()

◆ setTrivialForCall()

void clang::FunctionDecl::setTrivialForCall ( bool IT)
inline

Definition at line 2380 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

Referenced by clang::ASTDeclReader::VisitFunctionDecl().

◆ setUsesFPIntrin()

void clang::FunctionDecl::setUsesFPIntrin ( bool I)
inline

Set whether the function was declared in source context that requires constrained FP intrinsics.

Definition at line 2910 of file Decl.h.

References clang::DeclContext::FunctionDeclBits.

◆ setUsesSEHTry()

void clang::FunctionDecl::setUsesSEHTry ( bool UST)
inline

◆ setVirtualAsWritten()

void clang::FunctionDecl::setVirtualAsWritten ( bool V)
inline

State that this function is marked as virtual explicitly.

Definition at line 2348 of file Decl.h.

References clang::DeclContext::FunctionDeclBits, and V.

Referenced by clang::Sema::ActOnFunctionDeclarator(), clang::ASTDeclReader::VisitFunctionDecl(), and clang::ASTNodeImporter::VisitFunctionDecl().

◆ setWillHaveBody()

void clang::FunctionDecl::setWillHaveBody ( bool V = true)
inline

◆ UsesFPIntrin()

◆ usesSEHTry()

bool clang::FunctionDecl::usesSEHTry ( ) const
inline

◆ willHaveBody()

◆ ASTDeclReader

friend class ASTDeclReader
friend

Definition at line 2174 of file Decl.h.

References ASTDeclReader.

Referenced by ASTDeclReader.

◆ ASTDeclWriter

friend class ASTDeclWriter
friend

Definition at line 2175 of file Decl.h.

References ASTDeclWriter.

Referenced by ASTDeclWriter.

Member Data Documentation

◆ Body

LazyDeclStmtPtr clang::FunctionDecl::Body

The body of the function.

Definition at line 2065 of file Decl.h.

Referenced by doesThisDeclarationHaveABody(), FunctionDecl(), setBody(), setDefaultedOrDeletedInfo(), and setLazyBody().

◆ DefaultedOrDeletedInfo

DefaultedOrDeletedFunctionInfo* clang::FunctionDecl::DefaultedOrDeletedInfo

Information about a future defaulted function definition.

Definition at line 2067 of file Decl.h.

Referenced by getDefalutedOrDeletedInfo(), getDeletedMessage(), setDefaultedOrDeletedInfo(), and setDeletedAsWritten().

◆ RequiredTypeAwareDeleteParameterCount

unsigned clang::FunctionDecl::RequiredTypeAwareDeleteParameterCount
staticconstexpr
Initial value:
=
1 + 1 + 1 +
1

Count of mandatory parameters for type aware operator delete.

Definition at line 2641 of file Decl.h.

Referenced by clang::Sema::BuildTypeAwareUsualDelete(), CheckOperatorNewDeleteTypes(), isNonPlacementDeallocationFunction(), isUsableAsGlobalAllocationFunctionInConstantEvaluation(), and clang::CXXMethodDecl::isUsualDeallocationFunction().

◆ RequiredTypeAwareNewParameterCount

unsigned clang::FunctionDecl::RequiredTypeAwareNewParameterCount
staticconstexpr
Initial value:
=
1 + 1 + 1

Count of mandatory parameters for type aware operator new.

Definition at line 2637 of file Decl.h.

Referenced by CheckOperatorNewDeleteTypes(), and isUsableAsGlobalAllocationFunctionInConstantEvaluation().


The documentation for this class was generated from the following files: