clang API Documentation

Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Friends
clang::FunctionDecl Class Reference

#include <Decl.h>

Inheritance diagram for clang::FunctionDecl:
Inheritance graph
[legend]
Collaboration diagram for clang::FunctionDecl:
Collaboration graph
[legend]

List of all members.

Public Types

enum  TemplatedKind {
  TK_NonTemplate, TK_FunctionTemplate, TK_MemberSpecialization, TK_FunctionTemplateSpecialization,
  TK_DependentFunctionTemplateSpecialization
}
 The kind of templated function a FunctionDecl can be. More...
typedef clang::StorageClass StorageClass
typedef
redeclarable_base::redecl_range 
redecl_range
typedef
redeclarable_base::redecl_iterator 
redecl_iterator
typedef ParmVarDecl ** param_iterator
typedef ParmVarDecl *const * param_const_iterator
typedef llvm::iterator_range
< param_iterator
param_range
typedef llvm::iterator_range
< param_const_iterator
param_const_range

Public Member Functions

DeclarationNameInfo getNameInfo () const
void getNameForDiagnostic (raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const override
void setRangeEnd (SourceLocation E)
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 (definition). 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).
bool hasBody () const override
 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.
bool hasTrivialBody () const
bool isDefined (const FunctionDecl *&Definition) const
virtual bool isDefined () const
StmtgetBody (const FunctionDecl *&Definition) const
StmtgetBody () const override
bool isThisDeclarationADefinition () const
bool doesThisDeclarationHaveABody () const
void setBody (Stmt *B)
void setLazyBody (uint64_t Offset)
bool isVariadic () const
 Whether this function is variadic.
bool isVirtualAsWritten () const
 Whether this function is marked as virtual explicitly.
void setVirtualAsWritten (bool V)
bool isPure () const
void setPure (bool P=true)
bool isLateTemplateParsed () const
 Whether this templated function will be late parsed.
void setLateTemplateParsed (bool ILT=true)
bool isTrivial () const
void setTrivial (bool IT)
bool isDefaulted () const
void setDefaulted (bool D=true)
bool isExplicitlyDefaulted () const
void setExplicitlyDefaulted (bool ED=true)
bool hasImplicitReturnZero () const
void setHasImplicitReturnZero (bool IRZ)
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
bool hasInheritedPrototype () const
 Whether this function inherited its prototype from a previous declaration.
void setHasInheritedPrototype (bool P=true)
bool isConstexpr () const
 Whether this is a (C++11) constexpr function or constexpr constructor.
void setConstexpr (bool IC)
bool isDeleted () const
 Whether this function has been deleted.
bool isDeletedAsWritten () const
void setDeletedAsWritten (bool D=true)
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. The provisions of [basic.stc.dynamic] do not apply to these reserved placement forms of operator new and operator delete.
bool isReplaceableGlobalAllocationFunction () 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. [...].
FunctionDeclgetCorrespondingUnsizedGlobalDeallocationFunction () const
 Determine whether this function is a sized global deallocation function in C++1y. If so, find and return the corresponding unsized deallocation function.
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 hasSkippedBody () const
 True if the function was a definition but its body was skipped.
void setHasSkippedBody (bool Skipped=true)
void setPreviousDeclaration (FunctionDecl *PrevDecl)
virtual const FunctionDeclgetCanonicalDecl () const
FunctionDeclgetCanonicalDecl () override
 Retrieves the "canonical" declaration of the given declaration.
unsigned getBuiltinID () const
 Returns a value indicating whether this function corresponds to a builtin function.
unsigned param_size () const
param_iterator param_begin ()
param_iterator param_end ()
param_range params ()
param_const_iterator param_begin () const
param_const_iterator param_end () const
param_const_range params () const
unsigned getNumParams () const
const ParmVarDeclgetParamDecl (unsigned i) const
ParmVarDeclgetParamDecl (unsigned i)
void setParams (ArrayRef< ParmVarDecl * > NewParamInfo)
ArrayRef< ParmVarDecl * > parameters () const
const ArrayRef< NamedDecl * > & getDeclsInPrototypeScope () const
void setDeclsInPrototypeScope (ArrayRef< NamedDecl * > NewDecls)
unsigned getMinRequiredArguments () const
QualType getReturnType () const
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. For the computed linkage of symbol, see getLinkage.
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.
void setImplicitlyInline ()
 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 isOverloadedOperator () const
OverloadedOperatorKind getOverloadedOperator () const
const IdentifierInfogetLiteralIdentifier () const
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.
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.
FunctionDeclgetClassScopeSpecializationPattern () const
 Retrieve the class scope template pattern that this function template specialization is instantiated from.
FunctionTemplateSpecializationInfogetTemplateSpecializationInfo () const
 If this function is actually a function template specialization, retrieve information about this function template specialization. Otherwise, returns NULL.
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 () 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, const TemplateArgumentList *TemplateArgs, void *InsertPos, TemplateSpecializationKind TSK=TSK_ImplicitInstantiation, const TemplateArgumentListInfo *TemplateArgsAsWritten=0, 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.
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. 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.

Static Public Member Functions

static FunctionDeclCreate (ASTContext &C, DeclContext *DC, SourceLocation StartLoc, SourceLocation NLoc, DeclarationName N, QualType T, TypeSourceInfo *TInfo, StorageClass SC, bool isInlineSpecified=false, bool hasWrittenPrototype=true, bool isConstexprSpecified=false)
static FunctionDeclCreate (ASTContext &C, DeclContext *DC, SourceLocation StartLoc, const DeclarationNameInfo &NameInfo, QualType T, TypeSourceInfo *TInfo, StorageClass SC, bool isInlineSpecified, bool hasWrittenPrototype, bool isConstexprSpecified=false)
static FunctionDeclCreateDeserialized (ASTContext &C, unsigned ID)
static bool classof (const Decl *D)
static bool classofKind (Kind K)
static DeclContextcastToDeclContext (const FunctionDecl *D)
static FunctionDeclcastFromDeclContext (const DeclContext *DC)

Protected Types

typedef Redeclarable
< FunctionDecl
redeclarable_base

Protected Member Functions

 FunctionDecl (Kind DK, DeclContext *DC, SourceLocation StartLoc, const DeclarationNameInfo &NameInfo, QualType T, TypeSourceInfo *TInfo, StorageClass S, bool isInlineSpecified, bool isConstexprSpecified)
FunctionDeclgetNextRedeclaration () 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.

Friends

class ASTDeclReader
class ASTDeclWriter

Detailed Description

FunctionDecl - An instance of this class is created to represent 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 1430 of file Decl.h.


Member Typedef Documentation

Definition at line 1844 of file Decl.h.

Definition at line 1846 of file Decl.h.

Definition at line 1843 of file Decl.h.

typedef llvm::iterator_range<param_iterator> clang::FunctionDecl::param_range

Definition at line 1845 of file Decl.h.

typedef redeclarable_base::redecl_iterator clang::FunctionDecl::redecl_iterator

Definition at line 1577 of file Decl.h.

Reimplemented from clang::Redeclarable< FunctionDecl >.

Definition at line 1576 of file Decl.h.

Definition at line 1566 of file Decl.h.

Definition at line 1433 of file Decl.h.


Member Enumeration Documentation

The kind of templated function a FunctionDecl can be.

Enumerator:
TK_NonTemplate 
TK_FunctionTemplate 
TK_MemberSpecialization 
TK_FunctionTemplateSpecialization 
TK_DependentFunctionTemplateSpecialization 

Definition at line 1436 of file Decl.h.


Constructor & Destructor Documentation

clang::FunctionDecl::FunctionDecl ( Kind  DK,
DeclContext DC,
SourceLocation  StartLoc,
const DeclarationNameInfo NameInfo,
QualType  T,
TypeSourceInfo TInfo,
StorageClass  S,
bool  isInlineSpecified,
bool  isConstexprSpecified 
) [inline, protected]

Definition at line 1546 of file Decl.h.

Referenced by Create(), and CreateDeserialized().


Member Function Documentation

static FunctionDecl* clang::FunctionDecl::castFromDeclContext ( const DeclContext DC) [inline, static]

Reimplemented from clang::Decl.

Definition at line 2140 of file Decl.h.

static DeclContext* clang::FunctionDecl::castToDeclContext ( const FunctionDecl D) [inline, static]

Definition at line 2137 of file Decl.h.

static bool clang::FunctionDecl::classof ( const Decl D) [inline, static]
static bool clang::FunctionDecl::classofKind ( Kind  K) [inline, static]
static FunctionDecl* clang::FunctionDecl::Create ( ASTContext C,
DeclContext DC,
SourceLocation  StartLoc,
SourceLocation  NLoc,
DeclarationName  N,
QualType  T,
TypeSourceInfo TInfo,
StorageClass  SC,
bool  isInlineSpecified = false,
bool  hasWrittenPrototype = true,
bool  isConstexprSpecified = false 
) [inline, static]
FunctionDecl * FunctionDecl::Create ( ASTContext C,
DeclContext DC,
SourceLocation  StartLoc,
const DeclarationNameInfo NameInfo,
QualType  T,
TypeSourceInfo TInfo,
StorageClass  SC,
bool  isInlineSpecified,
bool  hasWrittenPrototype,
bool  isConstexprSpecified = false 
) [static]

Definition at line 3562 of file Decl.cpp.

References AttributeLangSupport::C, FunctionDecl(), and hasWrittenPrototype().

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 2599 of file Decl.cpp.

References Context, doesThisDeclarationHaveABody(), clang::Decl::getASTContext(), clang::ASTContext::getLangOpts(), clang::Redeclarable< decl_type >::getPreviousDecl(), getStorageClass(), hasBody(), isInlined(), isInlineSpecified(), clang::LazyOffsetPtr< T, OffsT, Get >::isValid(), RedeclForcesDefC99(), redeclForcesDefMSVC(), and clang::SC_Extern.

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

Stmt * FunctionDecl::getBody ( const FunctionDecl *&  Definition) const
Stmt* clang::FunctionDecl::getBody ( ) const [inline, override, virtual]

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 1657 of file Decl.h.

Referenced by getTemplateInstantiationPattern(), and hasTrivialBody().

Determine the type of an expression that calls this function.

Definition at line 1903 of file Decl.h.

References clang::Type::getAs().

Referenced by clang::consumed::ConsumedAnalyzer::run(), and TryUserDefinedConversion().

const FunctionDecl * FunctionDecl::getCanonicalDecl ( ) const [virtual]
FunctionDecl * FunctionDecl::getCanonicalDecl ( ) [override, virtual]

Retrieves the "canonical" declaration of the given declaration.

Reimplemented from clang::Decl.

Reimplemented in clang::CXXConstructorDecl, and clang::CXXMethodDecl.

Definition at line 2450 of file Decl.cpp.

References clang::Redeclarable< FunctionDecl >::getFirstDecl().

Retrieve the class scope template pattern that this function template specialization is instantiated from.

Definition at line 2876 of file Decl.cpp.

References clang::Decl::getASTContext(), and clang::ASTContext::getClassScopeSpecializationPattern().

Referenced by getTemplateInstantiationPattern(), clang::Sema::InstantiateFunctionDefinition(), and isImplicitlyInstantiable().

const ArrayRef<NamedDecl *>& clang::FunctionDecl::getDeclsInPrototypeScope ( ) const [inline]

Definition at line 1887 of file Decl.h.

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

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 1999 of file Decl.h.

Referenced by clang::Sema::ActOnConversionDeclarator(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnLambdaExpr(), clang::Sema::AddConversionCandidate(), addFunctionPointerConversion(), clang::Sema::AddOverloadCandidate(), clang::Sema::CheckFunctionDeclaration(), clang::Sema::CheckLiteralOperatorDeclaration(), clang::Sema::CheckMain(), clang::Sema::CheckMSVCRTEntryPoint(), CheckOperatorNewDeleteTypes(), clang::Sema::DefineImplicitLambdaToFunctionPointerConversion(), clang::CodeGen::CodeGenFunction::EmitLambdaDelegatingInvokeBody(), clang::CXXRecordDecl::getGenericLambdaTemplateParameterList(), clang::CXXMethodDecl::isCopyAssignmentOperator(), clang::CXXConstructorDecl::isCopyOrMoveConstructor(), clang::CXXMethodDecl::isMoveAssignmentOperator(), clang::Sema::IsOverload(), clang::CXXConstructorDecl::isSpecializationCopyingObject(), clang::Sema::MergeCXXFunctionDecl(), setPreviousDeclaration(), ShouldWarnAboutMissingPrototype(), clang::TemplateDeclInstantiator::VisitCXXMethodDecl(), clang::ASTDeclWriter::VisitFunctionDecl(), and clang::TemplateDeclInstantiator::VisitFunctionDecl().

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);
 };

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 2756 of file Decl.cpp.

References getMemberSpecializationInfo().

Referenced by clang::Sema::ActOnExplicitInstantiation(), clang::Sema::DiagnoseEmptyLookup(), getExplicitVisibilityAux(), getTemplateInstantiationPattern(), clang::Sema::InstantiateClassMembers(), isInstantiationOf(), and isOutOfLine().

Compute the language linkage.

Definition at line 2389 of file Decl.cpp.

References getLanguageLinkageTemplate().

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

Definition at line 2733 of file Decl.cpp.

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

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

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

Definition at line 1976 of file Decl.h.

Referenced by getInstantiatedFromMemberFunction(), clang::Sema::MarkFunctionReferenced(), useInlineVisibilityHidden(), clang::ASTDeclWriter::VisitFunctionDecl(), clang::ASTDeclReader::VisitFunctionDecl(), and clang::TemplateDeclInstantiator::VisitFunctionDecl().

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 3032 of file Decl.cpp.

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

Referenced by getStrlenExprArg().

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++).

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++) or are parameter packs (C++11).

Definition at line 2535 of file Decl.cpp.

References clang::frontend::CPlusPlus, clang::Decl::getASTContext(), getNumParams(), Param, and params().

Referenced by clang::Sema::AddMethodCandidate(), clang::Sema::AddOverloadCandidate(), clang::Sema::ConvertArgumentsForCall(), clang::Sema::DeduceTemplateArguments(), clang::Sema::MergeCXXFunctionDecl(), clang::Sema::SpecialMemberIsTrivial(), and clang::FunctionCallFilterCCC::ValidateCandidate().

FunctionDecl* clang::FunctionDecl::getMostRecentDeclImpl ( ) [inline, override, protected, virtual]

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

Reimplemented from clang::Decl.

Definition at line 1571 of file Decl.h.

void FunctionDecl::getNameForDiagnostic ( raw_ostream &  OS,
const PrintingPolicy Policy,
bool  Qualified 
) const [override, virtual]

getNameForDiagnostic - 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 2169 of file Decl.cpp.

References clang::TemplateArgumentList::data(), getTemplateSpecializationArgs(), clang::TemplateSpecializationType::PrintTemplateArgumentList(), and clang::TemplateArgumentList::size().

FunctionDecl* clang::FunctionDecl::getNextRedeclaration ( ) [inline, override, protected, virtual]

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 1567 of file Decl.h.

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 2504 of file Decl.cpp.

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

Referenced by clang::Sema::ActOnCXXDelete(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnReenterFunctionContext(), AddFunctionParameterChunks(), addFunctionPointerConversion(), addInstantiatedParametersToScope(), clang::Sema::AddKnownFunctionAttributes(), clang::Sema::addLambdaParameters(), clang::Sema::BuildBlockForLambdaConversion(), BuildImplicitBaseInitializer(), checkAttrArgsAreCapabilityObjs(), clang::Sema::CheckConstructor(), clang::Sema::CheckCXXDefaultArguments(), clang::Sema::CheckExplicitlyDefaultedSpecialMember(), clang::Sema::CheckMain(), CheckOperatorNewDeleteTypes(), clang::PredefinedExpr::ComputeName(), CopyObject(), clang::CodeCompleteConsumer::OverloadCandidate::CreateSignatureString(), clang::Sema::DeduceTemplateArguments(), doesUsualArrayDeleteWantSize(), emitReplacement(), clang::comments::DeclInfo::fill(), clang::Sema::FindAllocationOverload(), clang::Sema::FinishTemplateArgumentDeduction(), functionDeclHasDefaultArgument(), clang::CodeGen::CodeGenFunction::GenerateCode(), GenOpenCLArgMetadata(), getCorrespondingUnsizedGlobalDeallocationFunction(), getMinRequiredArguments(), clang::consumed::ConsumedStmtVisitor::handleCall(), handleCleanupAttr(), clang::CXXConstructorDecl::isConvertingConstructor(), clang::CXXMethodDecl::isCopyAssignmentOperator(), clang::CXXConstructorDecl::isCopyOrMoveConstructor(), clang::CXXConstructorDecl::isDefaultConstructor(), clang::Sema::isInitListConstructor(), clang::CXXMethodDecl::isMoveAssignmentOperator(), isNonPlacementDeallocationFunction(), clang::CXXConstructorDecl::isSpecializationCopyingObject(), clang::CXXMethodDecl::isUsualDeallocationFunction(), isVariadicFunctionTemplate(), clang::Sema::MarkDeducedTemplateParameters(), clang::Sema::MergeCompatibleFunctionDecls(), clang::Sema::MergeCXXFunctionDecl(), clang::Sema::MergeFunctionDecl(), ShouldWarnAboutMissingPrototype(), clang::Sema::SpecialMemberIsTrivial(), clang::TemplateDeclInstantiator::SubstFunctionType(), clang::Sema::SubstituteExplicitTemplateArguments(), clang::FunctionCallFilterCCC::ValidateCandidate(), and clang::ento::ExprEngine::VisitCXXNewExpr().

Definition at line 1869 of file Decl.h.

Referenced by clang::Sema::ActOnReenterFunctionContext(), AddFunctionParameterChunks(), addFunctionPointerConversion(), addInstantiatedParametersToScope(), clang::Sema::AddKnownFunctionAttributes(), clang::Sema::addLambdaParameters(), clang::Sema::BuildBlockForLambdaConversion(), BuildImplicitBaseInitializer(), BuildImplicitMemberInitializer(), clang::Sema::BuildLiteralOperatorCall(), checkAttrArgsAreCapabilityObjs(), checkBuiltinArgument(), CheckConstexprParameterTypes(), clang::Sema::CheckConstructor(), clang::Sema::CheckCXXDefaultArguments(), clang::Sema::CheckEnableIf(), CheckOperatorNewDeclaration(), CheckOperatorNewDeleteTypes(), clang::PredefinedExpr::ComputeName(), clang::Sema::ConvertArgumentsForCall(), CopyObject(), create_dispatch_once(), create_dispatch_sync(), create_OSAtomicCompareAndSwap(), clang::Sema::CreateOverloadedArraySubscriptExpr(), clang::Sema::CreateOverloadedBinOp(), clang::Sema::CreateOverloadedUnaryOp(), clang::CodeCompleteConsumer::OverloadCandidate::CreateSignatureString(), clang::Sema::DeduceTemplateArguments(), clang::Sema::DefineImplicitCopyAssignment(), clang::Sema::DefineImplicitMoveAssignment(), DiagnoseInvalidRedeclaration(), emitReplacement(), clang::Sema::FindAllocationOverload(), clang::Sema::FinishTemplateArgumentDeduction(), functionDeclHasDefaultArgument(), clang::Sema::GatherArgumentsForCall(), clang::CodeGen::CodeGenFunction::GenerateCode(), GenOpenCLArgMetadata(), clang::consumed::ConsumedStmtVisitor::handleCall(), handleCleanupAttr(), hasSimilarParameters(), clang::CXXConstructorDecl::isConvertingConstructor(), clang::CXXMethodDecl::isCopyAssignmentOperator(), clang::CXXConstructorDecl::isCopyConstructor(), clang::CXXConstructorDecl::isCopyOrMoveConstructor(), clang::CXXConstructorDecl::isDefaultConstructor(), clang::Sema::isInitListConstructor(), clang::CXXMethodDecl::isMoveAssignmentOperator(), clang::CXXConstructorDecl::isMoveConstructor(), isNonPlacementDeallocationFunction(), clang::CXXConstructorDecl::isSpecializationCopyingObject(), clang::CXXMethodDecl::isUsualDeallocationFunction(), isVariadicFunctionTemplate(), clang::Sema::MarkDeducedTemplateParameters(), clang::Sema::MergeCompatibleFunctionDecls(), clang::Sema::MergeCXXFunctionDecl(), clang::Sema::MergeFunctionDecl(), mergeParamDeclAttributes(), clang::Sema::PerformImplicitConversion(), clang::Sema::PerformMoveOrCopyInitialization(), clang::Sema::SpecialMemberIsTrivial(), and clang::ento::ExprEngine::VisitCXXNewExpr().

Definition at line 1873 of file Decl.h.

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 2993 of file Decl.cpp.

Referenced by SpecializeCorrespondingLambdaCallOperatorAndInvoker().

FunctionDecl* clang::FunctionDecl::getPreviousDeclImpl ( ) [inline, override, protected, virtual]

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

Reimplemented from clang::Decl.

Definition at line 1568 of file Decl.h.

SourceRange FunctionDecl::getSourceRange ( ) const [override, virtual]

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 2881 of file Decl.cpp.

Referenced by clang::Sema::DefineImplicitLambdaToFunctionPointerConversion(), clang::CodeGen::CodeGenFunction::EmitLambdaDelegatingInvokeBody(), clang::Sema::FinishTemplateArgumentDeduction(), getNameForDiagnostic(), and isTemplate().

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 2891 of file Decl.cpp.

If this function is actually a function template specialization, retrieve information about this function template specialization. Otherwise, returns NULL.

Definition at line 2020 of file Decl.h.

Referenced by clang::Sema::ActOnFunctionDeclarator(), clang::Sema::CheckFunctionTemplateSpecialization(), clang::Sema::MarkFunctionReferenced(), clang::Sema::MergeFunctionDecl(), useInlineVisibilityHidden(), and clang::ASTDeclWriter::VisitFunctionDecl().

bool FunctionDecl::hasBody ( const FunctionDecl *&  Definition) const

Returns true if the function has a body (definition). 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).

Definition at line 2184 of file Decl.cpp.

References clang::Redeclarable< FunctionDecl >::redecls().

Referenced by clang::Sema::BuildResolvedCallExpr(), clang::Sema::DefineUsedVTables(), DelegatingCycleHelper(), DiagnoseInvalidRedeclaration(), clang::CXXInstanceCall::getRuntimeDefinition(), clang::CXXMethodDecl::hasInlineBody(), isImplicitlyInstantiable(), isOutOfLine(), clang::CodeGen::CodeGenVTables::isVTableExternal(), and useInlineVisibilityHidden().

bool clang::FunctionDecl::hasBody ( ) const [inline, override, virtual]

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 1629 of file Decl.h.

Referenced by doesDeclarationForceExternallyVisibleDefinition(), and getBody().

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 1718 of file Decl.h.

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

Whether this function inherited its prototype from a previous declaration.

Definition at line 1733 of file Decl.h.

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

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 1725 of file Decl.h.

Referenced by clang::Sema::BuildResolvedCallExpr(), EmitFunctionDeclLValue(), clang::CodeGen::CGDebugInfo::EmitFunctionStart(), and clang::Sema::MergeFunctionDecl().

True if the function was a definition but its body was skipped.

Definition at line 1831 of file Decl.h.

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

Definition at line 2195 of file Decl.cpp.

References getBody(), and S.

Referenced by CanSkipVTablePointerInitialization(), and HasTrivialDestructorBody().

bool FunctionDecl::isDefined ( const FunctionDecl *&  Definition) const
virtual bool clang::FunctionDecl::isDefined ( ) const [inline, virtual]

Definition at line 1643 of file Decl.h.

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 1759 of file Decl.h.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::Sema::ActOnOpenMPCopyinClause(), clang::Sema::ActOnOpenMPFirstprivateClause(), clang::Sema::ActOnOpenMPPrivateClause(), clang::Sema::AddMethodCandidate(), clang::Sema::AddOverloadCandidate(), clang::Sema::AddOverriddenMethods(), clang::Sema::DefineImplicitCopyAssignment(), clang::Sema::DefineImplicitCopyConstructor(), clang::Sema::DefineImplicitDefaultConstructor(), clang::Sema::DefineImplicitDestructor(), clang::Sema::DefineImplicitMoveAssignment(), clang::Sema::DefineImplicitMoveConstructor(), clang::Sema::DefineInheritingConstructor(), clang::Sema::FindDeallocationFunction(), clang::CXXRecordDecl::finishedDefaultedOrDeletedMember(), clang::TemplateDeclInstantiator::InitFunctionInstantiation(), clang::Sema::isImplicitlyDeleted(), clang::CXXMethodDecl::isUserProvided(), clang::Sema::LookupSpecialMember(), clang::Sema::MarkVTableUsed(), clang::Sema::NoteDeletedFunction(), clang::Sema::SetDeclDeleted(), and TryValueInitialization().

Whether this function is explicitly defaulted per C++0x. Only valid for special member functions.

Definition at line 1712 of file Decl.h.

Referenced by clang::Sema::CheckExplicitlyDefaultedSpecialMember(), clang::Sema::MergeFunctionDecl(), clang::TemplateDeclInstantiator::VisitCXXMethodDecl(), and clang::ASTDeclWriter::VisitFunctionDecl().

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

Definition at line 2397 of file Decl.cpp.

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

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

Definition at line 2401 of file Decl.cpp.

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

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 2676 of file Decl.cpp.

References Context, doesThisDeclarationHaveABody(), clang::Decl::getASTContext(), clang::ASTContext::getLangOpts(), getStorageClass(), isInlined(), isInlineSpecified(), RedeclForcesDefC99(), clang::Redeclarable< FunctionDecl >::redecls(), and clang::SC_Extern.

Referenced by clang::ASTContext::GetGVALinkageForFunction().

Whether this templated function will be late parsed.

Definition at line 1695 of file Decl.h.

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

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 2551 of file Decl.cpp.

References Context, clang::Decl::getASTContext(), clang::ASTContext::getLangOpts(), clang::Redeclarable< decl_type >::getPreviousDecl(), isInlined(), and clang::SC_Extern.

Referenced by clang::ASTContext::GetGVALinkageForFunction().

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

Definition at line 2425 of file Decl.cpp.

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

Referenced by clang::Sema::ActOnReturnStmt(), and clang::CFGImplicitDtor::isNoReturn().

bool FunctionDecl::isOutOfLine ( ) const [override, virtual]

isOverloadedOperator - Whether this function declaration represents an C++ overloaded operator, e.g., "operator+".

Definition at line 1939 of file Decl.h.

References clang::OO_None.

Referenced by clang::Sema::ActOnFunctionDeclarator(), clang::Sema::CheckFunctionDeclaration(), clang::Sema::DefineImplicitCopyAssignment(), clang::Sema::DefineImplicitMoveAssignment(), DiagnoseShiftCompare(), and clang::TemplateDeclInstantiator::VisitFunctionDecl().

bool clang::FunctionDecl::isPure ( ) 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. [...].

Definition at line 2314 of file Decl.cpp.

References clang::Type::castAs(), clang::Qualifiers::Const, clang::DeclarationName::CXXOperatorName, clang::Type::getAsCXXRecordDecl(), clang::Decl::getASTContext(), clang::QualType::getCVRQualifiers(), clang::Decl::getDeclContext(), clang::NamedDecl::getDeclName(), clang::ASTContext::getLangOpts(), clang::FunctionProtoType::getNumParams(), clang::FunctionProtoType::getParamType(), clang::Type::getPointeeType(), clang::DeclContext::getRedeclContext(), clang::ASTContext::getSizeType(), clang::ValueDecl::getType(), clang::ASTContext::hasSameType(), isNamed(), isNamespaceStd(), clang::Type::isReferenceType(), clang::DeclContext::isTranslationUnit(), and clang::FunctionProtoType::isVariadic().

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

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 2285 of file Decl.cpp.

References clang::Type::castAs(), Context, clang::DeclarationName::CXXOperatorName, clang::Decl::getASTContext(), clang::QualType::getCanonicalType(), clang::Decl::getDeclContext(), clang::NamedDecl::getDeclName(), clang::FunctionProtoType::getNumParams(), clang::FunctionProtoType::getParamType(), clang::DeclContext::getRedeclContext(), clang::ValueDecl::getType(), clang::DeclContext::isTranslationUnit(), clang::FunctionProtoType::isVariadic(), and clang::ASTContext::VoidPtrTy.

Referenced by CalculateCookiePadding(), clang::CodeGen::CodeGenFunction::EmitCXXNewExpr(), and clang::ento::ExprEngine::VisitCXXNewExpr().

isThisDeclarationADefinition - Returns whether this specific declaration of the function is also a definition. This does not determine whether the function has been defined (e.g., in a previous definition); for that information, use isDefined. Note that this returns false for a defaulted function unless that function has been implicitly defined (possibly as deleted).

Definition at line 1668 of file Decl.h.

Referenced by clang::Sema::ActOnExplicitInstantiation(), clang::FunctionTemplateDecl::isThisDeclarationADefinition(), clang::Sema::MergeFunctionDecl(), and clang::TemplateDeclInstantiator::VisitFunctionDecl().

Definition at line 1854 of file Decl.h.

Definition at line 1857 of file Decl.h.

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

Definition at line 1860 of file Decl.h.

void FunctionDecl::setBody ( Stmt B)
void clang::FunctionDecl::setConstexpr ( bool  IC) [inline]
void FunctionDecl::setDeclsInPrototypeScope ( ArrayRef< NamedDecl * >  NewDecls)

Definition at line 2521 of file Decl.cpp.

References clang::Decl::getASTContext().

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

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 2922 of file Decl.cpp.

References clang::ASTContext::Allocate(), clang::UnresolvedSetImpl::size(), and clang::TemplateArgumentListInfo::size().

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

Definition at line 1713 of file Decl.h.

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

void clang::FunctionDecl::setFunctionTemplateSpecialization ( FunctionTemplateDecl Template,
const TemplateArgumentList TemplateArgs,
void *  InsertPos,
TemplateSpecializationKind  TSK = TSK_ImplicitInstantiation,
const TemplateArgumentListInfo TemplateArgsAsWritten = 0,
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 2082 of file Decl.h.

Definition at line 1719 of file Decl.h.

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

Definition at line 1734 of file Decl.h.

References P.

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

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

Definition at line 1832 of file Decl.h.

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

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

Definition at line 1916 of file Decl.h.

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

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

Definition at line 1982 of file Decl.h.

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

Definition at line 1680 of file Decl.h.

Referenced by isFunctionDefinitionDiscarded().

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

Determine what kind of template instantiation this function represents.

Definition at line 2972 of file Decl.cpp.

References clang::SourceLocation::isValid(), and clang::TSK_ExplicitSpecialization.

Referenced by clang::Sema::ActOnExplicitInstantiation(), and clang::Sema::CheckMemberSpecialization().

void clang::FunctionDecl::setTrivial ( bool  IT) [inline]

Friends And Related Function Documentation

friend class ASTDeclReader [friend]

Reimplemented from clang::DeclaratorDecl.

Reimplemented in clang::CXXConversionDecl, clang::CXXDestructorDecl, and clang::CXXConstructorDecl.

Definition at line 2144 of file Decl.h.

friend class ASTDeclWriter [friend]

Reimplemented from clang::DeclaratorDecl.

Reimplemented in clang::CXXConversionDecl, clang::CXXDestructorDecl, and clang::CXXConstructorDecl.

Definition at line 2145 of file Decl.h.


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