clang  14.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
clang::InitializedEntity Class Reference

Describes an entity that is being initialized. More...

#include "clang/Sema/Initialization.h"

Collaboration diagram for clang::InitializedEntity:
Collaboration graph
[legend]

Public Types

enum  EntityKind {
  EK_Variable, EK_Parameter, EK_TemplateParameter, EK_Result,
  EK_StmtExprResult, EK_Exception, EK_Member, EK_ArrayElement,
  EK_New, EK_Temporary, EK_Base, EK_Delegating,
  EK_VectorElement, EK_BlockElement, EK_LambdaToBlockConversionBlockElement, EK_ComplexElement,
  EK_LambdaCapture, EK_CompoundLiteralInit, EK_RelatedResult, EK_Parameter_CF_Audited,
  EK_Binding
}
 Specifies the kind of entity being initialized. More...
 

Public Member Functions

EntityKind getKind () const
 Determine the kind of initialization. More...
 
const InitializedEntitygetParent () const
 Retrieve the parent of the entity being initialized, when the initialization itself is occurring within the context of a larger initialization. More...
 
QualType getType () const
 Retrieve type being initialized. More...
 
TypeSourceInfogetTypeSourceInfo () const
 Retrieve complete type-source information for the object being constructed, if known. More...
 
DeclarationName getName () const
 Retrieve the name of the entity being initialized. More...
 
ValueDeclgetDecl () const
 Retrieve the variable, parameter, or field being initialized. More...
 
ObjCMethodDeclgetMethodDecl () const
 Retrieve the ObjectiveC method being initialized. More...
 
bool allowsNRVO () const
 Determine whether this initialization allows the named return value optimization, which also applies to thrown objects. More...
 
bool isParameterKind () const
 
bool isParamOrTemplateParamKind () const
 
bool isParameterConsumed () const
 Determine whether this initialization consumes the parameter. More...
 
const CXXBaseSpecifiergetBaseSpecifier () const
 Retrieve the base specifier. More...
 
bool isInheritedVirtualBase () const
 Return whether the base is an inherited virtual base. More...
 
bool isVariableLengthArrayNew () const
 Determine whether this is an array new with an unknown bound. More...
 
bool isImplicitMemberInitializer () const
 Is this the implicit initialization of a member of a class from a defaulted constructor? More...
 
bool isDefaultMemberInitializer () const
 Is this the default member initializer of a member (specified inside the class definition)? More...
 
SourceLocation getReturnLoc () const
 Determine the location of the 'return' keyword when initializing the result of a function call. More...
 
SourceLocation getThrowLoc () const
 Determine the location of the 'throw' keyword when initializing an exception object. More...
 
unsigned getElementIndex () const
 If this is an array, vector, or complex number element, get the element's index. More...
 
void setElementIndex (unsigned Index)
 If this is already the initializer for an array or vector element, sets the element index. More...
 
StringRef getCapturedVarName () const
 For a lambda capture, return the capture's name. More...
 
SourceLocation getCaptureLoc () const
 Determine the location of the capture when initializing field from a captured variable in a lambda. More...
 
void setParameterCFAudited ()
 
unsigned allocateManglingNumber () const
 
void dump () const
 Dump a representation of the initialized entity to standard error, for debugging purposes. More...
 

Static Public Member Functions

static InitializedEntity InitializeVariable (VarDecl *Var)
 Create the initialization entity for a variable. More...
 
static InitializedEntity InitializeParameter (ASTContext &Context, ParmVarDecl *Parm)
 Create the initialization entity for a parameter. More...
 
static InitializedEntity InitializeParameter (ASTContext &Context, ParmVarDecl *Parm, QualType Type)
 Create the initialization entity for a parameter, but use another type. More...
 
static InitializedEntity InitializeParameter (ASTContext &Context, QualType Type, bool Consumed)
 Create the initialization entity for a parameter that is only known by its type. More...
 
static InitializedEntity InitializeTemplateParameter (QualType T, NonTypeTemplateParmDecl *Param)
 Create the initialization entity for a template parameter. More...
 
static InitializedEntity InitializeResult (SourceLocation ReturnLoc, QualType Type)
 Create the initialization entity for the result of a function. More...
 
static InitializedEntity InitializeStmtExprResult (SourceLocation ReturnLoc, QualType Type)
 
static InitializedEntity InitializeBlock (SourceLocation BlockVarLoc, QualType Type)
 
static InitializedEntity InitializeLambdaToBlock (SourceLocation BlockVarLoc, QualType Type)
 
static InitializedEntity InitializeException (SourceLocation ThrowLoc, QualType Type)
 Create the initialization entity for an exception object. More...
 
static InitializedEntity InitializeNew (SourceLocation NewLoc, QualType Type)
 Create the initialization entity for an object allocated via new. More...
 
static InitializedEntity InitializeTemporary (QualType Type)
 Create the initialization entity for a temporary. More...
 
static InitializedEntity InitializeTemporary (ASTContext &Context, TypeSourceInfo *TypeInfo)
 Create the initialization entity for a temporary. More...
 
static InitializedEntity InitializeTemporary (TypeSourceInfo *TypeInfo, QualType Type)
 Create the initialization entity for a temporary. More...
 
static InitializedEntity InitializeRelatedResult (ObjCMethodDecl *MD, QualType Type)
 Create the initialization entity for a related result. More...
 
static InitializedEntity InitializeBase (ASTContext &Context, const CXXBaseSpecifier *Base, bool IsInheritedVirtualBase, const InitializedEntity *Parent=nullptr)
 Create the initialization entity for a base class subobject. More...
 
static InitializedEntity InitializeDelegation (QualType Type)
 Create the initialization entity for a delegated constructor. More...
 
static InitializedEntity InitializeMember (FieldDecl *Member, const InitializedEntity *Parent=nullptr, bool Implicit=false)
 Create the initialization entity for a member subobject. More...
 
static InitializedEntity InitializeMember (IndirectFieldDecl *Member, const InitializedEntity *Parent=nullptr, bool Implicit=false)
 Create the initialization entity for a member subobject. More...
 
static InitializedEntity InitializeMemberFromDefaultMemberInitializer (FieldDecl *Member)
 Create the initialization entity for a default member initializer. More...
 
static InitializedEntity InitializeElement (ASTContext &Context, unsigned Index, const InitializedEntity &Parent)
 Create the initialization entity for an array element. More...
 
static InitializedEntity InitializeBinding (VarDecl *Binding)
 Create the initialization entity for a structured binding. More...
 
static InitializedEntity InitializeLambdaCapture (IdentifierInfo *VarID, QualType FieldType, SourceLocation Loc)
 Create the initialization entity for a lambda capture. More...
 
static InitializedEntity InitializeCompoundLiteralInit (TypeSourceInfo *TSI)
 Create the entity for a compound literal initializer. More...
 

Detailed Description

Describes an entity that is being initialized.

Definition at line 48 of file Initialization.h.

Member Enumeration Documentation

◆ EntityKind

Specifies the kind of entity being initialized.

Enumerator
EK_Variable 

The entity being initialized is a variable.

EK_Parameter 

The entity being initialized is a function parameter.

EK_TemplateParameter 

The entity being initialized is a non-type template parameter.

EK_Result 

The entity being initialized is the result of a function call.

EK_StmtExprResult 

The entity being initialized is the result of a statement expression.

EK_Exception 

The entity being initialized is an exception object that is being thrown.

EK_Member 

The entity being initialized is a non-static data member subobject.

EK_ArrayElement 

The entity being initialized is an element of an array.

EK_New 

The entity being initialized is an object (or array of objects) allocated via new.

EK_Temporary 

The entity being initialized is a temporary object.

EK_Base 

The entity being initialized is a base member subobject.

EK_Delegating 

The initialization is being done by a delegating constructor.

EK_VectorElement 

The entity being initialized is an element of a vector.

or vector.

EK_BlockElement 

The entity being initialized is a field of block descriptor for the copied-in c++ object.

EK_LambdaToBlockConversionBlockElement 

The entity being initialized is a field of block descriptor for the copied-in lambda object that's used in the lambda to block conversion.

EK_ComplexElement 

The entity being initialized is the real or imaginary part of a complex number.

EK_LambdaCapture 

The entity being initialized is the field that captures a variable in a lambda.

EK_CompoundLiteralInit 

The entity being initialized is the initializer for a compound literal.

EK_RelatedResult 

The entity being implicitly initialized back to the formal result type.

EK_Parameter_CF_Audited 

The entity being initialized is a function parameter; function is member of group of audited CF APIs.

EK_Binding 

The entity being initialized is a structured binding of a decomposition declaration.

Definition at line 51 of file Initialization.h.

Member Function Documentation

◆ allocateManglingNumber()

unsigned clang::InitializedEntity::allocateManglingNumber ( ) const
inline

Definition at line 554 of file Initialization.h.

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

◆ allowsNRVO()

bool InitializedEntity::allowsNRVO ( ) const

◆ dump()

LLVM_DUMP_METHOD void InitializedEntity::dump ( ) const

Dump a representation of the initialized entity to standard error, for debugging purposes.

Definition at line 3449 of file SemaInit.cpp.

◆ getBaseSpecifier()

const CXXBaseSpecifier* clang::InitializedEntity::getBaseSpecifier ( ) const
inline

Retrieve the base specifier.

Definition at line 478 of file Initialization.h.

References EK_Base, and getKind().

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

◆ getCapturedVarName()

StringRef clang::InitializedEntity::getCapturedVarName ( ) const
inline

For a lambda capture, return the capture's name.

Definition at line 538 of file Initialization.h.

References EK_LambdaCapture, and getKind().

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

◆ getCaptureLoc()

SourceLocation clang::InitializedEntity::getCaptureLoc ( ) const
inline

Determine the location of the capture when initializing field from a captured variable in a lambda.

Definition at line 545 of file Initialization.h.

References EK_LambdaCapture, and getKind().

Referenced by getInitializationLoc().

◆ getDecl()

ValueDecl * InitializedEntity::getDecl ( ) const

◆ getElementIndex()

unsigned clang::InitializedEntity::getElementIndex ( ) const
inline

If this is an array, vector, or complex number element, get the element's index.

Definition at line 523 of file Initialization.h.

References EK_ArrayElement, EK_ComplexElement, EK_VectorElement, getKind(), and Index.

◆ getKind()

EntityKind clang::InitializedEntity::getKind ( ) const
inline

◆ getMethodDecl()

ObjCMethodDecl* clang::InitializedEntity::getMethodDecl ( ) const
inline

Retrieve the ObjectiveC method being initialized.

Definition at line 455 of file Initialization.h.

References MethodDecl.

◆ getName()

DeclarationName InitializedEntity::getName ( ) const

◆ getParent()

const InitializedEntity* clang::InitializedEntity::getParent ( ) const
inline

Retrieve the parent of the entity being initialized, when the initialization itself is occurring within the context of a larger initialization.

Definition at line 433 of file Initialization.h.

References Parent.

Referenced by canPerformArrayCopy(), clang::Sema::CheckConstructorAccess(), clang::Sema::checkInitializerLifetime(), getEntityLifetime(), and isIdiomaticBraceElisionEntity().

◆ getReturnLoc()

SourceLocation clang::InitializedEntity::getReturnLoc ( ) const
inline

Determine the location of the 'return' keyword when initializing the result of a function call.

Definition at line 509 of file Initialization.h.

References EK_Result, getKind(), and LocAndNRVO.

Referenced by getInitializationLoc().

◆ getThrowLoc()

SourceLocation clang::InitializedEntity::getThrowLoc ( ) const
inline

Determine the location of the 'throw' keyword when initializing an exception object.

Definition at line 516 of file Initialization.h.

References EK_Exception, getKind(), and LocAndNRVO.

Referenced by getInitializationLoc().

◆ getType()

QualType clang::InitializedEntity::getType ( ) const
inline

◆ getTypeSourceInfo()

TypeSourceInfo* clang::InitializedEntity::getTypeSourceInfo ( ) const
inline

Retrieve complete type-source information for the object being constructed, if known.

Definition at line 440 of file Initialization.h.

References EK_CompoundLiteralInit, EK_Temporary, and TypeInfo.

◆ InitializeBase()

InitializedEntity InitializedEntity::InitializeBase ( ASTContext Context,
const CXXBaseSpecifier Base,
bool  IsInheritedVirtualBase,
const InitializedEntity Parent = nullptr 
)
static

Create the initialization entity for a base class subobject.

Definition at line 3290 of file SemaInit.cpp.

References Base, EK_Base, and Parent.

Referenced by clang::Sema::BuildBaseInitializer(), and BuildImplicitBaseInitializer().

◆ InitializeBinding()

static InitializedEntity clang::InitializedEntity::InitializeBinding ( VarDecl Binding)
inlinestatic

Create the initialization entity for a structured binding.

Definition at line 406 of file Initialization.h.

References EK_Binding.

◆ InitializeBlock()

static InitializedEntity clang::InitializedEntity::InitializeBlock ( SourceLocation  BlockVarLoc,
QualType  Type 
)
inlinestatic

Definition at line 310 of file Initialization.h.

References EK_BlockElement.

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

◆ InitializeCompoundLiteralInit()

static InitializedEntity clang::InitializedEntity::InitializeCompoundLiteralInit ( TypeSourceInfo TSI)
inlinestatic

Create the entity for a compound literal initializer.

Definition at line 420 of file Initialization.h.

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

◆ InitializeDelegation()

static InitializedEntity clang::InitializedEntity::InitializeDelegation ( QualType  Type)
inlinestatic

Create the initialization entity for a delegated constructor.

Definition at line 372 of file Initialization.h.

References EK_Delegating.

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

◆ InitializeElement()

static InitializedEntity clang::InitializedEntity::InitializeElement ( ASTContext Context,
unsigned  Index,
const InitializedEntity Parent 
)
inlinestatic

Create the initialization entity for an array element.

Definition at line 399 of file Initialization.h.

◆ InitializeException()

static InitializedEntity clang::InitializedEntity::InitializeException ( SourceLocation  ThrowLoc,
QualType  Type 
)
inlinestatic

Create the initialization entity for an exception object.

Definition at line 322 of file Initialization.h.

References EK_Exception.

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

◆ InitializeLambdaCapture()

static InitializedEntity clang::InitializedEntity::InitializeLambdaCapture ( IdentifierInfo VarID,
QualType  FieldType,
SourceLocation  Loc 
)
inlinestatic

Create the initialization entity for a lambda capture.

VarID The name of the entity being captured, or nullptr for 'this'.

Definition at line 413 of file Initialization.h.

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

◆ InitializeLambdaToBlock()

static InitializedEntity clang::InitializedEntity::InitializeLambdaToBlock ( SourceLocation  BlockVarLoc,
QualType  Type 
)
inlinestatic

◆ InitializeMember() [1/2]

static InitializedEntity clang::InitializedEntity::InitializeMember ( FieldDecl Member,
const InitializedEntity Parent = nullptr,
bool  Implicit = false 
)
inlinestatic

Create the initialization entity for a member subobject.

Definition at line 378 of file Initialization.h.

References clang::Member, and Parent.

Referenced by BuildImplicitMemberInitializer(), clang::Sema::BuildMemberInitializer(), CollectFieldInitializer(), and clang::Sema::SetIvarInitializers().

◆ InitializeMember() [2/2]

static InitializedEntity clang::InitializedEntity::InitializeMember ( IndirectFieldDecl Member,
const InitializedEntity Parent = nullptr,
bool  Implicit = false 
)
inlinestatic

Create the initialization entity for a member subobject.

Definition at line 386 of file Initialization.h.

References clang::Member, and Parent.

◆ InitializeMemberFromDefaultMemberInitializer()

static InitializedEntity clang::InitializedEntity::InitializeMemberFromDefaultMemberInitializer ( FieldDecl Member)
inlinestatic

Create the initialization entity for a default member initializer.

Definition at line 394 of file Initialization.h.

References clang::Member.

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

◆ InitializeNew()

static InitializedEntity clang::InitializedEntity::InitializeNew ( SourceLocation  NewLoc,
QualType  Type 
)
inlinestatic

Create the initialization entity for an object allocated via new.

Definition at line 328 of file Initialization.h.

References EK_New.

◆ InitializeParameter() [1/3]

static InitializedEntity clang::InitializedEntity::InitializeParameter ( ASTContext Context,
ParmVarDecl Parm 
)
inlinestatic

◆ InitializeParameter() [2/3]

static InitializedEntity clang::InitializedEntity::InitializeParameter ( ASTContext Context,
ParmVarDecl Parm,
QualType  Type 
)
inlinestatic

Create the initialization entity for a parameter, but use another type.

Definition at line 262 of file Initialization.h.

◆ InitializeParameter() [3/3]

static InitializedEntity clang::InitializedEntity::InitializeParameter ( ASTContext Context,
QualType  Type,
bool  Consumed 
)
inlinestatic

Create the initialization entity for a parameter that is only known by its type.

Definition at line 277 of file Initialization.h.

◆ InitializeRelatedResult()

static InitializedEntity clang::InitializedEntity::InitializeRelatedResult ( ObjCMethodDecl MD,
QualType  Type 
)
inlinestatic

Create the initialization entity for a related result.

Definition at line 358 of file Initialization.h.

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

◆ InitializeResult()

static InitializedEntity clang::InitializedEntity::InitializeResult ( SourceLocation  ReturnLoc,
QualType  Type 
)
inlinestatic

Create the initialization entity for the result of a function.

Definition at line 300 of file Initialization.h.

References EK_Result.

Referenced by clang::Sema::ActOnCapScopeReturnStmt(), and clang::Sema::BuildReturnStmt().

◆ InitializeStmtExprResult()

static InitializedEntity clang::InitializedEntity::InitializeStmtExprResult ( SourceLocation  ReturnLoc,
QualType  Type 
)
inlinestatic

Definition at line 305 of file Initialization.h.

References EK_StmtExprResult.

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

◆ InitializeTemplateParameter()

static InitializedEntity clang::InitializedEntity::InitializeTemplateParameter ( QualType  T,
NonTypeTemplateParmDecl Param 
)
inlinestatic

Create the initialization entity for a template parameter.

Definition at line 290 of file Initialization.h.

References EK_TemplateParameter, and Variable.

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

◆ InitializeTemporary() [1/3]

static InitializedEntity clang::InitializedEntity::InitializeTemporary ( ASTContext Context,
TypeSourceInfo TypeInfo 
)
inlinestatic

Create the initialization entity for a temporary.

Definition at line 338 of file Initialization.h.

◆ InitializeTemporary() [2/3]

static InitializedEntity clang::InitializedEntity::InitializeTemporary ( QualType  Type)
inlinestatic

◆ InitializeTemporary() [3/3]

static InitializedEntity clang::InitializedEntity::InitializeTemporary ( TypeSourceInfo TypeInfo,
QualType  Type 
)
inlinestatic

Create the initialization entity for a temporary.

Definition at line 350 of file Initialization.h.

◆ InitializeVariable()

static InitializedEntity clang::InitializedEntity::InitializeVariable ( VarDecl Var)
inlinestatic

◆ isDefaultMemberInitializer()

bool clang::InitializedEntity::isDefaultMemberInitializer ( ) const
inline

Is this the default member initializer of a member (specified inside the class definition)?

Definition at line 503 of file Initialization.h.

References EK_Member, getKind(), and Variable.

Referenced by getEntityLifetime().

◆ isImplicitMemberInitializer()

bool clang::InitializedEntity::isImplicitMemberInitializer ( ) const
inline

Is this the implicit initialization of a member of a class from a defaulted constructor?

Definition at line 497 of file Initialization.h.

References EK_Member, getKind(), and Variable.

Referenced by canPerformArrayCopy().

◆ isInheritedVirtualBase()

bool clang::InitializedEntity::isInheritedVirtualBase ( ) const
inline

Return whether the base is an inherited virtual base.

Definition at line 484 of file Initialization.h.

References EK_Base, and getKind().

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

◆ isParameterConsumed()

bool clang::InitializedEntity::isParameterConsumed ( ) const
inline

Determine whether this initialization consumes the parameter.

Definition at line 472 of file Initialization.h.

References isParameterKind(), and Parameter.

◆ isParameterKind()

bool clang::InitializedEntity::isParameterKind ( ) const
inline

◆ isParamOrTemplateParamKind()

bool clang::InitializedEntity::isParamOrTemplateParamKind ( ) const
inline

Definition at line 466 of file Initialization.h.

References EK_TemplateParameter, getKind(), and isParameterKind().

◆ isVariableLengthArrayNew()

bool clang::InitializedEntity::isVariableLengthArrayNew ( ) const
inline

Determine whether this is an array new with an unknown bound.

Definition at line 490 of file Initialization.h.

References EK_New, getKind(), and getType().

◆ setElementIndex()

void clang::InitializedEntity::setElementIndex ( unsigned  Index)
inline

If this is already the initializer for an array or vector element, sets the element index.

Definition at line 531 of file Initialization.h.

References EK_ArrayElement, EK_ComplexElement, EK_VectorElement, getKind(), and Index.

◆ setParameterCFAudited()

void clang::InitializedEntity::setParameterCFAudited ( )
inline

Definition at line 550 of file Initialization.h.

References EK_Parameter_CF_Audited.

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

Member Data Documentation

◆ Base

llvm::PointerIntPair<const CXXBaseSpecifier *, 1> clang::InitializedEntity::Base

When Kind == EK_Base, the base specifier that provides the base class.

The integer specifies whether the base is an inherited virtual base.

Definition at line 202 of file Initialization.h.

Referenced by InitializeBase().

◆ Capture

struct C clang::InitializedEntity::Capture

Definition at line 209 of file Initialization.h.

◆ Index

unsigned clang::InitializedEntity::Index

When Kind == EK_ArrayElement, EK_VectorElement, or EK_ComplexElement, the index of the array or vector element being initialized.

Definition at line 207 of file Initialization.h.

Referenced by getElementIndex(), and setElementIndex().

◆ LocAndNRVO

struct LN clang::InitializedEntity::LocAndNRVO

Definition at line 197 of file Initialization.h.

Referenced by allowsNRVO(), getReturnLoc(), and getThrowLoc().

◆ MethodDecl

ObjCMethodDecl* clang::InitializedEntity::MethodDecl

When Kind == EK_RelatedResult, the ObjectiveC method where result type was implicitly changed to accommodate ARC semantics.

Definition at line 187 of file Initialization.h.

Referenced by getMethodDecl().

◆ Parameter

llvm::PointerIntPair<ParmVarDecl *, 1> clang::InitializedEntity::Parameter

When Kind == EK_Parameter, the ParmVarDecl, with the integer indicating whether the parameter is "consumed".

Definition at line 191 of file Initialization.h.

Referenced by getDecl(), getName(), and isParameterConsumed().

◆ TypeInfo

TypeSourceInfo* clang::InitializedEntity::TypeInfo

When Kind == EK_Temporary or EK_CompoundLiteralInit, the type source information for the temporary.

Definition at line 195 of file Initialization.h.

Referenced by getTypeSourceInfo().

◆ Variable

VD clang::InitializedEntity::Variable

When Kind == EK_Variable, EK_Member, EK_Binding, or EK_TemplateParameter, the variable, binding, or template parameter.

Definition at line 183 of file Initialization.h.

Referenced by getDecl(), getName(), InitializeTemplateParameter(), isDefaultMemberInitializer(), and isImplicitMemberInitializer().


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