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_iterator 
redecl_iterator
typedef ParmVarDecl ** param_iterator
typedef ParmVarDecl *const * param_const_iterator

Public Member Functions

DeclarationNameInfo getNameInfo () const
virtual void getNameForDiagnostic (raw_ostream &OS, const PrintingPolicy &Policy, bool Qualified) const
void setRangeEnd (SourceLocation E)
virtual SourceRange getSourceRange () const 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).
virtual bool hasBody () const
 Returns true if this Decl represents a declaration for a body of code, such as a function or method definition.
bool hasTrivialBody () const
bool isDefined (const FunctionDecl *&Definition) const
virtual bool isDefined () const
StmtgetBody (const FunctionDecl *&Definition) const
virtual StmtgetBody () const
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 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.
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)
 Set the previous declaration. If PrevDecl is NULL, set this as the first and only declaration.
virtual const FunctionDeclgetCanonicalDecl () const
virtual FunctionDeclgetCanonicalDecl ()
 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_const_iterator param_begin () const
param_const_iterator param_end () const
unsigned getNumParams () const
const ParmVarDeclgetParamDecl (unsigned i) const
ParmVarDeclgetParamDecl (unsigned i)
void setParams (ArrayRef< ParmVarDecl * > NewParamInfo)
const ArrayRef< NamedDecl * > & getDeclsInPrototypeScope () const
void setDeclsInPrototypeScope (ArrayRef< NamedDecl * > NewDecls)
unsigned getMinRequiredArguments () const
QualType getResultType () 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 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.
virtual bool isOutOfLine () const
 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)
virtual FunctionDeclgetNextRedeclaration ()
 Returns the next redeclaration or itself if this is the only decl.
virtual FunctionDeclgetPreviousDeclImpl ()
 Implementation of getPreviousDecl(), to be overridden by any subclass that has a redeclaration chain.
virtual FunctionDeclgetMostRecentDeclImpl ()
 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 1389 of file Decl.h.


Member Typedef Documentation

Definition at line 1775 of file Decl.h.

Definition at line 1774 of file Decl.h.

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

Definition at line 1535 of file Decl.h.

Definition at line 1525 of file Decl.h.

Definition at line 1392 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 1395 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 1505 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 2051 of file Decl.h.

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

Definition at line 2048 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 3290 of file Decl.cpp.

References FunctionDecl(), and hasWrittenPrototype().

FunctionDecl * FunctionDecl::CreateDeserialized ( ASTContext C,
unsigned  ID 
) [static]
bool FunctionDecl::doesDeclarationForceExternallyVisibleDefinition ( ) const

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

Specifically, 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 2340 of file Decl.cpp.

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

bool clang::FunctionDecl::doesThisDeclarationHaveABody ( ) const [inline]
Stmt * FunctionDecl::getBody ( const FunctionDecl *&  Definition) const
virtual Stmt* clang::FunctionDecl::getBody ( ) const [inline, 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 1614 of file Decl.h.

Referenced by hasTrivialBody().

unsigned FunctionDecl::getBuiltinID ( ) 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.

Definition at line 2211 of file Decl.cpp.

References clang::ASTContext::BuiltinInfo, Context, clang::Decl::getASTContext(), clang::IdentifierInfo::getBuiltinID(), clang::Decl::getDeclContext(), clang::NamedDecl::getIdentifier(), clang::ASTContext::getLangOpts(), getStorageClass(), clang::Builtin::Context::isPredefinedLibFunction(), clang::DeclContext::isTranslationUnit(), clang::LinkageSpecDecl::lang_c, and clang::SC_Static.

Referenced by clang::Sema::ActOnStartOfFunctionDef(), clang::Sema::AddKnownFunctionAttributes(), clang::Sema::BuildResolvedCallExpr(), clang::Sema::CheckFunctionDeclaration(), clang::Sema::ConvertArgumentsForCall(), getLanguageLinkage(), getMemoryFunctionKind(), clang::CallExpr::isBuiltinCall(), clang::ento::CheckerContext::isCLibraryFunction(), clang::Sema::MergeFunctionDecl(), and clang::Sema::UseArgumentDependentLookup().

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

Determine the type of an expression that calls this function.

Definition at line 1816 of file Decl.h.

Referenced by TryUserDefinedConversion().

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

Retrieves the "canonical" declaration of the given declaration.

Reimplemented from clang::Decl.

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

Definition at line 2198 of file Decl.cpp.

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

FunctionDecl * FunctionDecl::getClassScopeSpecializationPattern ( ) const

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

Definition at line 2594 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 1800 of file Decl.h.

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

DependentFunctionTemplateSpecializationInfo* clang::FunctionDecl::getDependentSpecializationInfo ( ) const [inline]
FunctionTemplateDecl* clang::FunctionDecl::getDescribedFunctionTemplate ( ) const [inline]
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);
 };

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

References getMemberSpecializationInfo().

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

LanguageLinkage FunctionDecl::getLanguageLinkage ( ) const

Compute the language linkage.

Definition at line 2131 of file Decl.cpp.

References clang::CLanguageLinkage, getBuiltinID(), and getLanguageLinkageTemplate().

const IdentifierInfo * FunctionDecl::getLiteralIdentifier ( ) const

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

Definition at line 2471 of file Decl.cpp.

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

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

MemberSpecializationInfo* clang::FunctionDecl::getMemberSpecializationInfo ( ) const [inline]

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

Definition at line 1887 of file Decl.h.

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

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

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

Referenced by getStrlenExprArg().

unsigned FunctionDecl::getMinRequiredArguments ( ) const

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 the last parameter is a parameter pack.

Definition at line 2287 of file Decl.cpp.

References clang::frontend::CPlusPlus, clang::Decl::getASTContext(), getNumParams(), getParamDecl(), and clang::Decl::isParameterPack().

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

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

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

Reimplemented from clang::Decl.

Definition at line 1530 of file Decl.h.

void FunctionDecl::getNameForDiagnostic ( raw_ostream &  OS,
const PrintingPolicy Policy,
bool  Qualified 
) const [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 2022 of file Decl.cpp.

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

DeclarationNameInfo clang::FunctionDecl::getNameInfo ( ) const [inline]
virtual FunctionDecl* clang::FunctionDecl::getNextRedeclaration ( ) [inline, 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 1526 of file Decl.h.

unsigned FunctionDecl::getNumParams ( ) const

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

References clang::ValueDecl::getType().

Referenced by clang::Sema::ActOnCXXDelete(), clang::Sema::ActOnFunctionDeclarator(), clang::Sema::ActOnReenterFunctionContext(), clang::Sema::ActOnStartOfFunctionDef(), AddFunctionParameterChunks(), addFunctionPointerConversion(), addInstantiatedParametersToScope(), clang::Sema::AddKnownFunctionAttributes(), clang::Sema::addLambdaParameters(), clang::Sema::BuildBlockForLambdaConversion(), BuildImplicitBaseInitializer(), checkAttrArgsAreLockableObjs(), clang::Sema::CheckConstructor(), clang::Sema::CheckCXXDefaultArguments(), clang::Sema::CheckExplicitlyDefaultedSpecialMember(), clang::Sema::CheckMain(), CheckOperatorNewDeleteTypes(), clang::PredefinedExpr::ComputeName(), CopyObject(), clang::CodeCompleteConsumer::OverloadCandidate::CreateSignatureString(), doesUsualArrayDeleteWantSize(), clang::comments::DeclInfo::fill(), clang::Sema::FindAllocationOverload(), clang::Sema::FinishTemplateArgumentDeduction(), clang::CodeGen::CodeGenFunction::GenerateCode(), GenOpenCLArgMetadata(), getMinRequiredArguments(), handleCleanupAttr(), clang::CXXConstructorDecl::isConvertingConstructor(), clang::CXXConstructorDecl::isCopyOrMoveConstructor(), clang::CXXConstructorDecl::isDefaultConstructor(), clang::Sema::isInitListConstructor(), 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::Sema::SubstituteExplicitTemplateArguments(), clang::TemplateDeclInstantiator::VisitCXXMethodDecl(), and clang::ento::ExprEngine::VisitCXXNewExpr().

OverloadedOperatorKind FunctionDecl::getOverloadedOperator ( ) const
const ParmVarDecl* clang::FunctionDecl::getParamDecl ( unsigned  i) const [inline]

Definition at line 1788 of file Decl.h.

Referenced by clang::Sema::ActOnReenterFunctionContext(), clang::Sema::ActOnStartOfFunctionDef(), AddFunctionParameterChunks(), addFunctionPointerConversion(), addInstantiatedParametersToScope(), clang::Sema::AddKnownFunctionAttributes(), clang::Sema::addLambdaParameters(), clang::Sema::BuildBlockForLambdaConversion(), BuildImplicitBaseInitializer(), BuildImplicitMemberInitializer(), clang::Sema::BuildLiteralOperatorCall(), checkAttrArgsAreLockableObjs(), checkBuiltinArgument(), CheckConstexprParameterTypes(), clang::Sema::CheckConstructor(), clang::Sema::CheckCXXDefaultArguments(), 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::DefineImplicitCopyAssignment(), clang::Sema::DefineImplicitMoveAssignment(), DiagnoseInvalidRedeclaration(), clang::Sema::FindAllocationOverload(), clang::Sema::FinishTemplateArgumentDeduction(), clang::Sema::GatherArgumentsForCall(), clang::CodeGen::CodeGenFunction::GenerateCode(), GenOpenCLArgMetadata(), getMinRequiredArguments(), 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(), 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().

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

Definition at line 1792 of file Decl.h.

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

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

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

Reimplemented from clang::Decl.

Definition at line 1527 of file Decl.h.

References getPreviousDecl().

FunctionTemplateDecl * FunctionDecl::getPrimaryTemplate ( ) const
QualType clang::FunctionDecl::getResultType ( ) const [inline]
SourceRange FunctionDecl::getSourceRange ( ) const [virtual]
StorageClass clang::FunctionDecl::getStorageClass ( ) const [inline]
FunctionDecl::TemplatedKind FunctionDecl::getTemplatedKind ( ) const
FunctionDecl * FunctionDecl::getTemplateInstantiationPattern ( ) const
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 2599 of file Decl.cpp.

Referenced by clang::Sema::FinishTemplateArgumentDeduction(), getNameForDiagnostic(), and isTemplate().

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

FunctionTemplateSpecializationInfo* clang::FunctionDecl::getTemplateSpecializationInfo ( ) const [inline]

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

Definition at line 1931 of file Decl.h.

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

TemplateSpecializationKind FunctionDecl::getTemplateSpecializationKind ( ) const
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 2037 of file Decl.cpp.

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

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

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

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

Reimplemented from clang::Decl.

Definition at line 1586 of file Decl.h.

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

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

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

Whether this function inherited its prototype from a previous declaration.

Definition at line 1690 of file Decl.h.

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

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

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

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

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

Definition at line 1762 of file Decl.h.

bool FunctionDecl::hasTrivialBody ( ) const

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

Definition at line 2048 of file Decl.cpp.

References getBody(), and S.

Referenced by CanSkipVTablePointerInitialization(), and HasTrivialDestructorBody().

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

Definition at line 1600 of file Decl.h.

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

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), 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::TemplateDeclInstantiator::InitFunctionInstantiation(), clang::Sema::isImplicitlyDeleted(), clang::CXXMethodDecl::isUserProvided(), clang::Sema::LookupSpecialMember(), clang::Sema::NoteDeletedFunction(), clang::Sema::SetDeclDeleted(), and TryValueInitialization().

bool clang::FunctionDecl::isDeletedAsWritten ( ) const [inline]
bool clang::FunctionDecl::isExplicitlyDefaulted ( ) const [inline]

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

Definition at line 1669 of file Decl.h.

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

bool FunctionDecl::isExternC ( ) const
bool clang::FunctionDecl::isFunctionTemplateSpecialization ( ) const [inline]

Determine whether this function is a function template specialization.

Definition at line 1920 of file Decl.h.

Referenced by clang::Sema::MergeFunctionDecl(), and ShouldWarnAboutMissingPrototype().

bool FunctionDecl::isGlobal ( ) const
bool FunctionDecl::isImplicitlyInstantiable ( ) const
bool FunctionDecl::isInExternCContext ( ) const

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

Definition at line 2145 of file Decl.cpp.

References isInLanguageSpecContext(), and clang::LinkageSpecDecl::lang_c.

bool FunctionDecl::isInExternCXXContext ( ) const

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

Definition at line 2149 of file Decl.cpp.

References isInLanguageSpecContext(), and clang::LinkageSpecDecl::lang_cxx.

bool clang::FunctionDecl::isInlined ( ) const [inline]
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 2410 of file Decl.cpp.

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

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

bool clang::FunctionDecl::isInlineSpecified ( ) const [inline]
bool clang::FunctionDecl::isLateTemplateParsed ( ) const [inline]

Whether this templated function will be late parsed.

Definition at line 1652 of file Decl.h.

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

bool FunctionDecl::isMain ( ) const
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 2173 of file Decl.cpp.

References clang::ValueDecl::getType().

Referenced by clang::CFGImplicitDtor::isNoReturn().

bool FunctionDecl::isOutOfLine ( ) const [virtual]
bool clang::FunctionDecl::isOverloadedOperator ( ) const [inline]

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

Definition at line 1850 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]
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 2109 of file Decl.cpp.

References Context, clang::DeclarationName::CXXOperatorName, clang::FunctionProtoType::getArgType(), clang::Decl::getASTContext(), clang::QualType::getCanonicalType(), clang::Decl::getDeclContext(), clang::NamedDecl::getDeclName(), clang::FunctionProtoType::getNumArgs(), 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().

bool FunctionDecl::isTemplateInstantiation ( ) const
bool clang::FunctionDecl::isThisDeclarationADefinition ( ) const [inline]

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

Referenced by clang::Sema::ActOnExplicitInstantiation(), clang::CXXConstructorDecl::isImplicitlyDefined(), clang::CXXDestructorDecl::isImplicitlyDefined(), clang::FunctionTemplateDecl::isThisDeclarationADefinition(), clang::Sema::MergeFunctionDecl(), clang::CXXConstructorDecl::setImplicitlyDefined(), clang::CXXDestructorDecl::setImplicitlyDefined(), clang::TemplateDeclInstantiator::VisitFunctionDecl(), and clang::TemplateDeclInstantiator::VisitFunctionTemplateDecl().

bool clang::FunctionDecl::isTrivial ( ) const [inline]
bool FunctionDecl::isVariadic ( ) const
bool clang::FunctionDecl::isVirtualAsWritten ( ) const [inline]
param_iterator clang::FunctionDecl::param_begin ( ) [inline]
param_const_iterator clang::FunctionDecl::param_begin ( ) const [inline]

Definition at line 1780 of file Decl.h.

param_iterator clang::FunctionDecl::param_end ( ) [inline]
param_const_iterator clang::FunctionDecl::param_end ( ) const [inline]

Definition at line 1781 of file Decl.h.

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

Definition at line 2273 of file Decl.cpp.

References clang::Decl::getASTContext().

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

void clang::FunctionDecl::setDefaulted ( bool  D = true) [inline]
void clang::FunctionDecl::setDeletedAsWritten ( bool  D = true) [inline]
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 2640 of file Decl.cpp.

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

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

void clang::FunctionDecl::setDescribedFunctionTemplate ( FunctionTemplateDecl Template) [inline]
void clang::FunctionDecl::setExplicitlyDefaulted ( bool  ED = true) [inline]

Definition at line 1670 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 1993 of file Decl.h.

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

Definition at line 1676 of file Decl.h.

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

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

Definition at line 1691 of file Decl.h.

References P.

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

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

Definition at line 1763 of file Decl.h.

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

void clang::FunctionDecl::setImplicitlyInline ( ) [inline]
void clang::FunctionDecl::setInlineSpecified ( bool  I) [inline]

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

Definition at line 1829 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 1893 of file Decl.h.

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

Definition at line 1653 of file Decl.h.

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

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

Definition at line 1637 of file Decl.h.

Referenced by isFunctionDefinitionDiscarded().

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

Set the previous declaration. If PrevDecl is NULL, set this as the first and only declaration.

Reimplemented from clang::Redeclarable< FunctionDecl >.

Definition at line 2180 of file Decl.cpp.

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

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

void FunctionDecl::setPure ( bool  P = true)
void clang::FunctionDecl::setRangeEnd ( SourceLocation  E) [inline]
void FunctionDecl::setTemplateSpecializationKind ( TemplateSpecializationKind  TSK,
SourceLocation  PointOfInstantiation = SourceLocation() 
)

Determine what kind of template instantiation this function represents.

Definition at line 2690 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]
void clang::FunctionDecl::setVirtualAsWritten ( bool  V) [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 2055 of file Decl.h.

friend class ASTDeclWriter [friend]

Reimplemented from clang::DeclaratorDecl.

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

Definition at line 2056 of file Decl.h.


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