clang API Documentation

Classes | Public Types | Public Member Functions | Static Public Member Functions
clang::InitializedEntity Class Reference

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

#include <Initialization.h>

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

List of all members.

Classes

struct  C
struct  LN

Public Types

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

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Describes an entity that is being initialized.

Definition at line 41 of file Initialization.h.


Member Enumeration Documentation

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_Result 

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

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_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.

Definition at line 44 of file Initialization.h.


Member Function Documentation

Definition at line 434 of file Initialization.h.

Referenced by performReferenceExtension().

Determine whether this initialization allows the named return value optimization, which also applies to thrown objects.

Definition at line 2642 of file SemaInit.cpp.

References EK_ArrayElement, EK_Base, EK_BlockElement, EK_ComplexElement, EK_CompoundLiteralInit, EK_Delegating, EK_Exception, EK_LambdaCapture, EK_Member, EK_New, EK_Parameter, EK_Parameter_CF_Audited, EK_RelatedResult, EK_Result, EK_Temporary, EK_Variable, EK_VectorElement, getKind(), and LocAndNRVO.

Referenced by PerformConstructorInitialization().

void InitializedEntity::dump ( ) const

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

Definition at line 2709 of file SemaInit.cpp.

Retrieve the base specifier.

Definition at line 379 of file Initialization.h.

References EK_Base, and getKind().

Referenced by clang::Sema::CheckConstructorAccess(), clang::InitializationSequence::Diagnose(), and PerformConstructorInitialization().

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

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

Definition at line 419 of file Initialization.h.

References Capture, EK_LambdaCapture, and getKind().

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

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

Definition at line 425 of file Initialization.h.

References Capture, EK_LambdaCapture, clang::SourceLocation::getFromRawEncoding(), and getKind().

Referenced by getInitializationLoc().

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

Definition at line 406 of file Initialization.h.

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

Retrieve the ObjectiveC method being initialized.

Definition at line 361 of file Initialization.h.

References MethodDecl.

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

Definition at line 339 of file Initialization.h.

Referenced by getEntityForTemporaryLifetimeExtension(), InitializedEntityOutlivesFullExpression(), and warnOnLifetimeExtension().

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

Definition at line 392 of file Initialization.h.

References EK_Result, clang::SourceLocation::getFromRawEncoding(), getKind(), and LocAndNRVO.

Referenced by getInitializationLoc().

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

Definition at line 399 of file Initialization.h.

References EK_Exception, clang::SourceLocation::getFromRawEncoding(), getKind(), and LocAndNRVO.

Referenced by getInitializationLoc().

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

Definition at line 346 of file Initialization.h.

References EK_CompoundLiteralInit, EK_Temporary, and TypeInfo.

Referenced by clang::InitializationSequence::Perform(), and PerformConstructorInitialization().

InitializedEntity InitializedEntity::InitializeBase ( ASTContext Context,
const CXXBaseSpecifier Base,
bool  IsInheritedVirtualBase 
) [static]

Create the initialization entity for a base class subobject.

Definition at line 2566 of file SemaInit.cpp.

References Base, EK_Base, and clang::CXXBaseSpecifier::getType().

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

static InitializedEntity clang::InitializedEntity::InitializeBlock ( SourceLocation  BlockVarLoc,
QualType  Type,
bool  NRVO 
) [inline, static]

Create the entity for a compound literal initializer.

Definition at line 325 of file Initialization.h.

References EK_CompoundLiteralInit, clang::TypeSourceInfo::getType(), and TypeInfo.

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

Create the initialization entity for a delegated constructor.

Definition at line 292 of file Initialization.h.

References EK_Delegating.

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

static InitializedEntity clang::InitializedEntity::InitializeElement ( ASTContext Context,
unsigned  Index,
const InitializedEntity Parent 
) [inline, static]

Create the initialization entity for an array element.

Definition at line 311 of file Initialization.h.

Referenced by addAsFieldToClosureType(), and BuildImplicitMemberInitializer().

static InitializedEntity clang::InitializedEntity::InitializeException ( SourceLocation  ThrowLoc,
QualType  Type,
bool  NRVO 
) [inline, static]

Create the initialization entity for an exception object.

Definition at line 252 of file Initialization.h.

References EK_Exception.

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

Create the initialization entity for a lambda capture.

Definition at line 318 of file Initialization.h.

Referenced by addAsFieldToClosureType(), and clang::Sema::performLambdaInitCaptureInitialization().

static InitializedEntity clang::InitializedEntity::InitializeMember ( FieldDecl Member,
const InitializedEntity Parent = nullptr 
) [inline, static]
static InitializedEntity clang::InitializedEntity::InitializeMember ( IndirectFieldDecl Member,
const InitializedEntity Parent = nullptr 
) [inline, static]

Create the initialization entity for a member subobject.

Definition at line 305 of file Initialization.h.

References clang::IndirectFieldDecl::getAnonField().

static InitializedEntity clang::InitializedEntity::InitializeNew ( SourceLocation  NewLoc,
QualType  Type 
) [inline, static]

Create the initialization entity for an object allocated via new.

Definition at line 258 of file Initialization.h.

References EK_New.

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

static InitializedEntity clang::InitializedEntity::InitializeParameter ( ASTContext Context,
ParmVarDecl Parm 
) [inline, static]
static InitializedEntity clang::InitializedEntity::InitializeParameter ( ASTContext Context,
ParmVarDecl Parm,
QualType  Type 
) [inline, static]

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

Definition at line 211 of file Initialization.h.

References EK_Parameter, clang::ASTContext::getLangOpts(), clang::QualType::getUnqualifiedType(), clang::ASTContext::getVariableArrayDecayedType(), clang::Decl::hasAttr(), and Parameter.

static InitializedEntity clang::InitializedEntity::InitializeParameter ( ASTContext Context,
QualType  Type,
bool  Consumed 
) [inline, static]

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

Definition at line 229 of file Initialization.h.

References EK_Parameter, clang::ASTContext::getVariableArrayDecayedType(), and Parameter.

Create the initialization entity for a related result.

Definition at line 278 of file Initialization.h.

References EK_RelatedResult, and MethodDecl.

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

static InitializedEntity clang::InitializedEntity::InitializeResult ( SourceLocation  ReturnLoc,
QualType  Type,
bool  NRVO 
) [inline, static]

Create the initialization entity for the result of a function.

Definition at line 241 of file Initialization.h.

References EK_Result.

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

Create the initialization entity for a temporary.

Definition at line 270 of file Initialization.h.

References EK_Temporary, clang::TypeSourceInfo::getType(), and TypeInfo.

Return whether the base is an inherited virtual base.

Definition at line 385 of file Initialization.h.

References EK_Base, and getKind().

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

Determine whether this initialization consumes the parameter.

Definition at line 373 of file Initialization.h.

References isParameterKind(), and Parameter.

Referenced by MaybeProduceObjCObject().

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

Definition at line 413 of file Initialization.h.

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

Definition at line 430 of file Initialization.h.

References EK_Parameter_CF_Audited.

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


Member Data Documentation

When Kind == EK_Base, the base specifier that provides the base class. The lower bit specifies whether the base is an inherited virtual base.

Definition at line 151 of file Initialization.h.

Referenced by InitializeBase().

Definition at line 158 of file Initialization.h.

Referenced by getCapturedVarName(), getCaptureLoc(), and getName().

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

Definition at line 156 of file Initialization.h.

Referenced by getElementIndex(), and setElementIndex().

Definition at line 146 of file Initialization.h.

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

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

Definition at line 136 of file Initialization.h.

Referenced by getMethodDecl(), and InitializeRelatedResult().

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

Definition at line 140 of file Initialization.h.

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

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

Definition at line 144 of file Initialization.h.

Referenced by getTypeSourceInfo(), InitializeCompoundLiteralInit(), and InitializeTemporary().

When Kind == EK_Variable, or EK_Member, the VarDecl or FieldDecl, respectively.

Definition at line 132 of file Initialization.h.

Referenced by getDecl(), and getName().


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