clang::CXXExpansionStmtInstantiation Class Reference

Represents the code generated for an expanded expansion statement. More...

#include "clang/AST/StmtCXX.h"

Inheritance diagram for clang::CXXExpansionStmtInstantiation:

Public Member Functions
ArrayRef< Stmt * >	getAllSubStmts () const
MutableArrayRef< Stmt * >	getAllSubStmts ()
unsigned	getNumSubStmts () const
ArrayRef< Stmt * >	getInstantiations () const
ArrayRef< Stmt * >	getPreambleStmts () const
bool	shouldApplyLifetimeExtensionToPreamble () const
void	setShouldApplyLifetimeExtensionToPreamble (bool Apply)
SourceLocation	getBeginLoc () const
SourceLocation	getEndLoc () const
CXXExpansionStmtDecl *	getParent ()
const CXXExpansionStmtDecl *	getParent () const
child_range	children ()
const_child_range	children () const
Public Member Functions inherited from clang::Stmt
void *	operator new (size_t bytes, const ASTContext &C, unsigned alignment=8)
void *	operator new (size_t bytes, const ASTContext *C, unsigned alignment=8)
void *	operator new (size_t bytes, void *mem) noexcept
void	operator delete (void *, const ASTContext &, unsigned) noexcept
void	operator delete (void *, const ASTContext *, unsigned) noexcept
void	operator delete (void *, size_t) noexcept
void	operator delete (void *, void *) noexcept
	Stmt ()=delete
	Stmt (const Stmt &)=delete
	Stmt (Stmt &&)=delete
Stmt &	operator= (const Stmt &)=delete
Stmt &	operator= (Stmt &&)=delete
	Stmt (StmtClass SC)
StmtClass	getStmtClass () const
const char *	getStmtClassName () const
SourceRange	getSourceRange () const LLVM_READONLY
	SourceLocation tokens are not useful in isolation - they are low level value objects created/interpreted by SourceManager.
SourceLocation	getBeginLoc () const LLVM_READONLY
SourceLocation	getEndLoc () const LLVM_READONLY
void	dump () const
	Dumps the specified AST fragment and all subtrees to llvm::errs().
void	dump (raw_ostream &OS, const ASTContext &Context) const
int64_t	getID (const ASTContext &Context) const
void	dumpColor () const
	dumpColor - same as dump(), but forces color highlighting.
void	dumpPretty (const ASTContext &Context) const
	dumpPretty/printPretty - These two methods do a "pretty print" of the AST back to its original source language syntax.
void	printPretty (raw_ostream &OS, PrinterHelper *Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\n", const ASTContext *Context=nullptr) const
void	printPrettyControlled (raw_ostream &OS, PrinterHelper *Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\n", const ASTContext *Context=nullptr) const
void	printJson (raw_ostream &Out, PrinterHelper *Helper, const PrintingPolicy &Policy, bool AddQuotes) const
	Pretty-prints in JSON format.
void	viewAST () const
	viewAST - Visualize an AST rooted at this Stmt* using GraphViz.
Stmt *	IgnoreContainers (bool IgnoreCaptured=false)
	Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true.
const Stmt *	IgnoreContainers (bool IgnoreCaptured=false) const
const Stmt *	stripLabelLikeStatements () const
	Strip off all label-like statements.
Stmt *	stripLabelLikeStatements ()
child_range	children ()
const_child_range	children () const
child_iterator	child_begin ()
child_iterator	child_end ()
const_child_iterator	child_begin () const
const_child_iterator	child_end () const
void	Profile (llvm::FoldingSetNodeID &ID, const ASTContext &Context, bool Canonical, bool ProfileLambdaExpr=false) const
	Produce a unique representation of the given statement.
void	ProcessODRHash (llvm::FoldingSetNodeID &ID, ODRHash &Hash) const
	Calculate a unique representation for a statement that is stable across compiler invocations.

Static Public Member Functions
static CXXExpansionStmtInstantiation *	Create (ASTContext &C, CXXExpansionStmtDecl *Parent, ArrayRef< Stmt * > Instantiations, ArrayRef< Stmt * > PreambleStmts, bool ShouldApplyLifetimeExtensionToPreamble)
static CXXExpansionStmtInstantiation *	CreateEmpty (ASTContext &C, EmptyShell Empty, unsigned NumInstantiations, unsigned NumPreambleStmts)
static bool	classof (const Stmt *T)
Static Public Member Functions inherited from clang::Stmt
static void	addStmtClass (const StmtClass s)
static void	EnableStatistics ()
static void	PrintStats ()
static Likelihood	getLikelihood (ArrayRef< const Attr * > Attrs)
static Likelihood	getLikelihood (const Stmt *S)
static const Attr *	getLikelihoodAttr (const Stmt *S)
static Likelihood	getLikelihood (const Stmt *Then, const Stmt *Else)
static std::tuple< bool, const Attr *, const Attr * >	determineLikelihoodConflict (const Stmt *Then, const Stmt *Else)

Friends
class	ASTStmtReader

Additional Inherited Members
Public Types inherited from clang::Stmt
enum	StmtClass { NoStmtClass = 0 }
enum	Likelihood { LH_Unlikely = -1 , LH_None , LH_Likely }
	The likelihood of a branch being taken. More...
using	child_iterator = StmtIterator
	Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpressions of an AST node.
using	const_child_iterator = ConstStmtIterator
using	child_range = llvm::iterator_range<child_iterator>
using	const_child_range = llvm::iterator_range<const_child_iterator>
Protected Types inherited from clang::Stmt
enum	{ NumExprBits = NumStmtBits + 5 + llvm::BitWidth<ExprDependence> }
enum	{ NumCallExprBits = 25 }
enum	{ NumOverloadExprBits = NumExprBits + 1 }
template<typename T>
using	ConstCastIterator = CastIterator<T, const T *const, const Stmt *const>
	Const iterator for iterating over Stmt * arrays that contain only T *.
using	ExprIterator = CastIterator<Expr>
using	ConstExprIterator = ConstCastIterator<Expr>
Protected Member Functions inherited from clang::Stmt
void *	operator new (size_t bytes) noexcept
void	operator delete (void *data) noexcept
	Stmt (StmtClass SC, EmptyShell)
	Construct an empty statement.
Protected Attributes inherited from clang::Stmt
union {
StmtBitfields   StmtBits
NullStmtBitfields   NullStmtBits
CompoundStmtBitfields   CompoundStmtBits
LabelStmtBitfields   LabelStmtBits
AttributedStmtBitfields   AttributedStmtBits
IfStmtBitfields   IfStmtBits
SwitchStmtBitfields   SwitchStmtBits
WhileStmtBitfields   WhileStmtBits
DoStmtBitfields   DoStmtBits
ForStmtBitfields   ForStmtBits
GotoStmtBitfields   GotoStmtBits
LoopControlStmtBitfields   LoopControlStmtBits
ReturnStmtBitfields   ReturnStmtBits
SwitchCaseBitfields   SwitchCaseBits
DeferStmtBitfields   DeferStmtBits
ExprBitfields   ExprBits
ConstantExprBitfields   ConstantExprBits
PredefinedExprBitfields   PredefinedExprBits
DeclRefExprBitfields   DeclRefExprBits
FloatingLiteralBitfields   FloatingLiteralBits
StringLiteralBitfields   StringLiteralBits
CharacterLiteralBitfields   CharacterLiteralBits
UnaryOperatorBitfields   UnaryOperatorBits
UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
ArrayOrMatrixSubscriptExprBitfields   ArrayOrMatrixSubscriptExprBits
CallExprBitfields   CallExprBits
MemberExprBitfields   MemberExprBits
CastExprBitfields   CastExprBits
BinaryOperatorBitfields   BinaryOperatorBits
InitListExprBitfields   InitListExprBits
ParenListExprBitfields   ParenListExprBits
GenericSelectionExprBitfields   GenericSelectionExprBits
PseudoObjectExprBitfields   PseudoObjectExprBits
SourceLocExprBitfields   SourceLocExprBits
ParenExprBitfields   ParenExprBits
ShuffleVectorExprBitfields   ShuffleVectorExprBits
StmtExprBitfields   StmtExprBits
ChooseExprBitfields   ChooseExprBits
CXXOperatorCallExprBitfields   CXXOperatorCallExprBits
CXXRewrittenBinaryOperatorBitfields   CXXRewrittenBinaryOperatorBits
CXXBoolLiteralExprBitfields   CXXBoolLiteralExprBits
CXXNullPtrLiteralExprBitfields   CXXNullPtrLiteralExprBits
CXXThisExprBitfields   CXXThisExprBits
CXXThrowExprBitfields   CXXThrowExprBits
CXXDefaultArgExprBitfields   CXXDefaultArgExprBits
CXXDefaultInitExprBitfields   CXXDefaultInitExprBits
CXXScalarValueInitExprBitfields   CXXScalarValueInitExprBits
CXXNewExprBitfields   CXXNewExprBits
CXXDeleteExprBitfields   CXXDeleteExprBits
TypeTraitExprBitfields   TypeTraitExprBits
DependentScopeDeclRefExprBitfields   DependentScopeDeclRefExprBits
CXXConstructExprBitfields   CXXConstructExprBits
ExprWithCleanupsBitfields   ExprWithCleanupsBits
CXXUnresolvedConstructExprBitfields   CXXUnresolvedConstructExprBits
CXXDependentScopeMemberExprBitfields   CXXDependentScopeMemberExprBits
OverloadExprBitfields   OverloadExprBits
UnresolvedLookupExprBitfields   UnresolvedLookupExprBits
UnresolvedMemberExprBitfields   UnresolvedMemberExprBits
CXXNoexceptExprBitfields   CXXNoexceptExprBits
SubstNonTypeTemplateParmExprBitfields   SubstNonTypeTemplateParmExprBits
LambdaExprBitfields   LambdaExprBits
RequiresExprBitfields   RequiresExprBits
ArrayTypeTraitExprBitfields   ArrayTypeTraitExprBits
ExpressionTraitExprBitfields   ExpressionTraitExprBits
CXXFoldExprBitfields   CXXFoldExprBits
PackIndexingExprBitfields   PackIndexingExprBits
CoawaitExprBitfields   CoawaitBits
ObjCObjectLiteralBitfields   ObjCObjectLiteralBits
ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
OpaqueValueExprBitfields   OpaqueValueExprBits
ConvertVectorExprBitfields   ConvertVectorExprBits
};

Detailed Description

Represents the code generated for an expanded expansion statement.

This holds 'preamble statements' and 'instantiations'; these encode the general underlying pattern that all expansion statements desugar to. Note that only the inner '{}' (i.e. those marked as 'Actual "CompoundStmt"' below) are actually present as 'CompoundStmt's in the AST; the outer braces that wrap everything do not correspond to an actual 'CompoundStmt' and are implicit in the sense that we simply push a scope when evaluating or emitting IR for a 'CXXExpansionStmtInstantiation'.

The 'instantiations' are precisely these inner compound statements.

/// { // Not actually present in the AST.
///   <preamble statements>
///   { // Actual 'CompoundStmt'.
///     <1st instantiation>
///   }
///   ...
///   { // Actual 'CompoundStmt'.
///     <n-th instantiation>
///   }
/// }
/// 

For example, the CXXExpansionStmtInstantiation that corresponds to the following expansion statement

///   std::tuple<int, int, int> a{1, 2, 3};
///   template for (auto x : a) {
///     // ...
///   }
/// 

would be

/// {
///   auto [__u0, __u1, __u2] = a;
///   {
///     auto x = __u0;
///     // ...
///   }
///   {
///     auto x = __u1;
///     // ...
///   }
///   {
///     auto x = __u2;
///     // ...
///   }
/// }
/// 

There are two reasons why this needs to exist and why we don't just store a list of instantiations in some other node:

1. We need custom codegen to handle break/continue in expansion statements properly, so it can't just be a compound statement.
2. The expansions are created after both the pattern and the 'CXXExpansionStmtDecl', so we can't just store them as trailing data in either of those nodes (because we don't know how many expansions there will be when those notes are allocated).

See also

CXXExpansionStmtDecl

Definition at line 1026 of file StmtCXX.h.

Member Function Documentation

children() [1/2]

child_range clang::CXXExpansionStmtInstantiation::children ( )

inline

Definition at line 1091 of file StmtCXX.h.

References getNumSubStmts(), and clang::Stmt::Stmt().

children() [2/2]

const_child_range clang::CXXExpansionStmtInstantiation::children ( ) const

inline

Definition at line 1096 of file StmtCXX.h.

References getNumSubStmts(), and clang::Stmt::Stmt().

classof()

bool clang::CXXExpansionStmtInstantiation::classof ( const Stmt * T )

inlinestatic

Definition at line 1101 of file StmtCXX.h.

References clang::Stmt::Stmt().

Create()

CXXExpansionStmtInstantiation * CXXExpansionStmtInstantiation::Create ( ASTContext & C, CXXExpansionStmtDecl * Parent, ArrayRef< Stmt * > Instantiations, ArrayRef< Stmt * > PreambleStmts, bool ShouldApplyLifetimeExtensionToPreamble )

static

Definition at line 261 of file StmtCXX.cpp.

References clang::C.

Referenced by clang::Sema::FinishCXXExpansionStmt(), and clang::ASTNodeImporter::VisitCXXExpansionStmtInstantiation().

CreateEmpty()

CXXExpansionStmtInstantiation * CXXExpansionStmtInstantiation::CreateEmpty ( ASTContext & C, EmptyShell Empty, unsigned NumInstantiations, unsigned NumPreambleStmts )

static

Definition at line 274 of file StmtCXX.cpp.

References clang::C, and clang::Empty.

getAllSubStmts() [1/2]

MutableArrayRef< Stmt * > clang::CXXExpansionStmtInstantiation::getAllSubStmts ( )

inline

Definition at line 1061 of file StmtCXX.h.

References getNumSubStmts().

getAllSubStmts() [2/2]

ArrayRef< Stmt * > clang::CXXExpansionStmtInstantiation::getAllSubStmts ( ) const

inline

Definition at line 1057 of file StmtCXX.h.

References getNumSubStmts().

Referenced by getPreambleStmts().

getBeginLoc()

SourceLocation CXXExpansionStmtInstantiation::getBeginLoc

(

)

const

Definition at line 284 of file StmtCXX.cpp.

getEndLoc()

SourceLocation CXXExpansionStmtInstantiation::getEndLoc

(

)

const

Definition at line 288 of file StmtCXX.cpp.

getInstantiations()

ArrayRef< Stmt * > clang::CXXExpansionStmtInstantiation::getInstantiations ( ) const

inline

Definition at line 1069 of file StmtCXX.h.

Referenced by clang::CodeGen::CodeGenFunction::EmitCXXExpansionStmtInstantiation(), clang::ASTNodeImporter::VisitCXXExpansionStmtInstantiation(), and clang::interp::Compiler< Emitter >::visitCXXExpansionStmtInstantiation().

getNumSubStmts()

unsigned clang::CXXExpansionStmtInstantiation::getNumSubStmts ( ) const

inline

Definition at line 1065 of file StmtCXX.h.

Referenced by children(), children(), getAllSubStmts(), and getAllSubStmts().

getParent() [1/2]

CXXExpansionStmtDecl * clang::CXXExpansionStmtInstantiation::getParent ( )

inline

Definition at line 1088 of file StmtCXX.h.

Referenced by clang::ASTNodeImporter::VisitCXXExpansionStmtInstantiation().

getParent() [2/2]

const CXXExpansionStmtDecl * clang::CXXExpansionStmtInstantiation::getParent ( ) const

inline

Definition at line 1089 of file StmtCXX.h.

getPreambleStmts()

ArrayRef< Stmt * > clang::CXXExpansionStmtInstantiation::getPreambleStmts ( ) const

inline

Definition at line 1073 of file StmtCXX.h.

References getAllSubStmts().

Referenced by clang::CodeGen::CodeGenFunction::EmitCXXExpansionStmtInstantiation(), clang::ASTNodeImporter::VisitCXXExpansionStmtInstantiation(), and clang::interp::Compiler< Emitter >::visitCXXExpansionStmtInstantiation().

setShouldApplyLifetimeExtensionToPreamble()

void clang::CXXExpansionStmtInstantiation::setShouldApplyLifetimeExtensionToPreamble ( bool Apply )

inline

Definition at line 1081 of file StmtCXX.h.

shouldApplyLifetimeExtensionToPreamble()

bool clang::CXXExpansionStmtInstantiation::shouldApplyLifetimeExtensionToPreamble ( ) const

inline

Definition at line 1077 of file StmtCXX.h.

Referenced by clang::ASTNodeImporter::VisitCXXExpansionStmtInstantiation(), and clang::TextNodeDumper::VisitCXXExpansionStmtInstantiation().

Friends And Related Symbol Documentation

ASTStmtReader

friend class ASTStmtReader

friend

Definition at line 1029 of file StmtCXX.h.

References ASTStmtReader, clang::C, and clang::Empty.

Referenced by ASTStmtReader.

---

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

• include/clang/AST/StmtCXX.h
• lib/AST/StmtCXX.cpp