IfStmt - This represents an if/then/else. More...

#include "clang/AST/Stmt.h"

Inheritance diagram for clang::IfStmt:

Collaboration diagram for clang::IfStmt:

[legend]

Public Member Functions
bool	hasInitStorage () const
	True if this IfStmt has the storage for an init statement. More...

bool	hasVarStorage () const
	True if this IfStmt has storage for a variable declaration. More...

bool	hasElseStorage () const
	True if this IfStmt has storage for an else statement. More...

Expr *	getCond ()

const Expr *	getCond () const

void	setCond (Expr *Cond)

Stmt *	getThen ()

const Stmt *	getThen () const

void	setThen (Stmt *Then)

Stmt *	getElse ()

const Stmt *	getElse () const

void	setElse (Stmt *Else)

VarDecl *	getConditionVariable ()
	Retrieve the variable declared in this "if" statement, if any. More...

const VarDecl *	getConditionVariable () const

void	setConditionVariable (const ASTContext &Ctx, VarDecl *V)
	Set the condition variable for this if statement. More...

DeclStmt *	getConditionVariableDeclStmt ()
	If this IfStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable. More...

const DeclStmt *	getConditionVariableDeclStmt () const

Stmt *	getInit ()

const Stmt *	getInit () const

void	setInit (Stmt *Init)

SourceLocation	getIfLoc () const

void	setIfLoc (SourceLocation IfLoc)

SourceLocation	getElseLoc () const

void	setElseLoc (SourceLocation ElseLoc)

bool	isConstexpr () const

void	setConstexpr (bool C)

bool	isObjCAvailabilityCheck () const

SourceLocation	getBeginLoc () const

SourceLocation	getEndLoc () const LLVM_READONLY

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

bool	isOMPStructuredBlock () const

void	setIsOMPStructuredBlock (bool IsOMPStructuredBlock)

SourceRange	getSourceRange () const LLVM_READONLY
	SourceLocation tokens are not useful in isolation - they are low level value objects created/interpreted by SourceManager. More...

SourceLocation	getBeginLoc () const LLVM_READONLY

SourceLocation	getEndLoc () const LLVM_READONLY

void	dump () const
	Dumps the specified AST fragment and all subtrees to `llvm::errs()`. More...

void	dump (SourceManager &SM) const

void	dump (raw_ostream &OS, SourceManager &SM) const

void	dump (raw_ostream &OS) const

int64_t	getID (const ASTContext &Context) const

void	dumpColor () const
	dumpColor - same as dump(), but forces color highlighting. More...

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

void	printPretty (raw_ostream &OS, PrinterHelper Helper, const PrintingPolicy &Policy, unsigned Indentation=0, StringRef NewlineSymbol="\, const ASTContext Context=nullptr) const

void	printJson (raw_ostream &Out, PrinterHelper *Helper, const PrintingPolicy &Policy, bool AddQuotes) const
	Pretty-prints in JSON format. More...

void	viewAST () const
	viewAST - Visualize an AST rooted at this Stmt* using GraphViz. More...

Stmt *	IgnoreContainers (bool IgnoreCaptured=false)
	Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true. More...

const Stmt *	IgnoreContainers (bool IgnoreCaptured=false) const

const Stmt *	stripLabelLikeStatements () const
	Strip off all label-like statements. More...

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) const
	Produce a unique representation of the given statement. More...

void	ProcessODRHash (llvm::FoldingSetNodeID &ID, ODRHash &Hash) const
	Calculate a unique representation for a statement that is stable across compiler invocations. More...

Static Public Member Functions
static IfStmt *	Create (const ASTContext &Ctx, SourceLocation IL, bool IsConstexpr, Stmt Init, VarDecl Var, Expr Cond, Stmt Then, SourceLocation EL=SourceLocation(), Stmt *Else=nullptr)
	Create an IfStmt. More...

static IfStmt *	CreateEmpty (const ASTContext &Ctx, bool HasElse, bool HasVar, bool HasInit)
	Create an empty IfStmt optionally with storage for an else statement, condition variable and init expression. More...

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 ()

Additional Inherited Members
Public Types inherited from clang::Stmt
enum	StmtClass { NoStmtClass = 0 }

using	child_iterator = StmtIterator
	Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpessions of an AST node. More...

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	{ NumStmtBits = 9 }

enum	{ NumExprBits = NumStmtBits + 9 }

enum	{ NumCallExprBits = 32 }

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 *. More...

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

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

ContinueStmtBitfields ContinueStmtBits

BreakStmtBitfields BreakStmtBits

ReturnStmtBitfields ReturnStmtBits

SwitchCaseBitfields SwitchCaseBits

ExprBitfields ExprBits

ConstantExprBitfields ConstantExprBits

PredefinedExprBitfields PredefinedExprBits

DeclRefExprBitfields DeclRefExprBits

FloatingLiteralBitfields FloatingLiteralBits

StringLiteralBitfields StringLiteralBits

CharacterLiteralBitfields CharacterLiteralBits

UnaryOperatorBitfields UnaryOperatorBits

UnaryExprOrTypeTraitExprBitfields UnaryExprOrTypeTraitExprBits

ArraySubscriptExprBitfields ArraySubscriptExprBits

CallExprBitfields CallExprBits

MemberExprBitfields MemberExprBits

CastExprBitfields CastExprBits

BinaryOperatorBitfields BinaryOperatorBits

InitListExprBitfields InitListExprBits

ParenListExprBitfields ParenListExprBits

GenericSelectionExprBitfields GenericSelectionExprBits

PseudoObjectExprBitfields PseudoObjectExprBits

SourceLocExprBitfields SourceLocExprBits

CXXOperatorCallExprBitfields CXXOperatorCallExprBits

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

CoawaitExprBitfields CoawaitBits

ObjCIndirectCopyRestoreExprBitfields ObjCIndirectCopyRestoreExprBits

OpaqueValueExprBitfields OpaqueValueExprBits

};

Detailed Description

IfStmt - This represents an if/then/else.

Definition at line 1812 of file Stmt.h.

Member Function Documentation

◆ children() [1/2]

child_range clang::IfStmt::children ( )

inline

Definition at line 1999 of file Stmt.h.

◆ children() [2/2]

const_child_range clang::IfStmt::children ( ) const

inline

Definition at line 2005 of file Stmt.h.

◆ classof()

static bool clang::IfStmt::classof ( const Stmt * T )

inlinestatic

Definition at line 2011 of file Stmt.h.

References clang::Stmt::getStmtClass().

◆ Create()

IfStmt * IfStmt::Create	(	const ASTContext &	Ctx,
		SourceLocation	IL,
		bool	IsConstexpr,
		Stmt *	Init,
		VarDecl *	Var,
		Expr *	Cond,
		Stmt *	Then,
		SourceLocation	EL = `SourceLocation()`,
		Stmt *	Else = `nullptr`
	)

static

Create an IfStmt.

Definition at line 852 of file Stmt.cpp.

References clang::ASTContext::Allocate().

Referenced by clang::Sema::BuildIfStmt(), create_dispatch_once(), and create_OSAtomicCompareAndSwap().

◆ CreateEmpty()

IfStmt * IfStmt::CreateEmpty	(	const ASTContext &	Ctx,
		bool	HasElse,
		bool	HasVar,
		bool	HasInit
	)

static

Create an empty IfStmt optionally with storage for an else statement, condition variable and init expression.

Definition at line 866 of file Stmt.cpp.

References clang::ASTContext::Allocate().

◆ getBeginLoc()

SourceLocation clang::IfStmt::getBeginLoc ( ) const

inline

Definition at line 1990 of file Stmt.h.

◆ getCond() [1/2]

Expr* clang::IfStmt::getCond ( )

inline

Definition at line 1887 of file Stmt.h.

Referenced by DiagUninitUse(), clang::CFGBlock::FilterEdge(), isIdenticalStmt(), and clang::TreeTransform< Derived >::TransformAttr().

◆ getCond() [2/2]

const Expr* clang::IfStmt::getCond ( ) const

inline

Definition at line 1891 of file Stmt.h.

◆ getConditionVariable() [1/2]

VarDecl * IfStmt::getConditionVariable ( )

Retrieve the variable declared in this "if" statement, if any.

In the following example, "x" is the condition variable.

if (int x = foo()) {
  printf("x is %d", x);
}

Definition at line 875 of file Stmt.cpp.

Referenced by clang::TreeTransform< Derived >::TransformAttr().

◆ getConditionVariable() [2/2]

const VarDecl* clang::IfStmt::getConditionVariable ( ) const

inline

Definition at line 1933 of file Stmt.h.

References V.

◆ getConditionVariableDeclStmt() [1/2]

DeclStmt* clang::IfStmt::getConditionVariableDeclStmt ( )

inline

If this IfStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable.

Definition at line 1943 of file Stmt.h.

◆ getConditionVariableDeclStmt() [2/2]

const DeclStmt* clang::IfStmt::getConditionVariableDeclStmt ( ) const

inline

Definition at line 1949 of file Stmt.h.

◆ getElse() [1/2]

Stmt* clang::IfStmt::getElse ( )

inline

Definition at line 1908 of file Stmt.h.

Referenced by DiagUninitUse(), isIdenticalStmt(), and clang::TreeTransform< Derived >::TransformAttr().

◆ getElse() [2/2]

const Stmt* clang::IfStmt::getElse ( ) const

inline

Definition at line 1913 of file Stmt.h.

◆ getElseLoc()

SourceLocation clang::IfStmt::getElseLoc ( ) const

inline

Definition at line 1974 of file Stmt.h.

Referenced by clang::TreeTransform< Derived >::TransformAttr().

◆ getEndLoc()

SourceLocation clang::IfStmt::getEndLoc ( ) const

inline

Definition at line 1991 of file Stmt.h.

◆ getIfLoc()

SourceLocation clang::IfStmt::getIfLoc ( ) const

inline

Definition at line 1971 of file Stmt.h.

Referenced by clang::TreeTransform< Derived >::TransformAttr().

◆ getInit() [1/2]

Stmt* clang::IfStmt::getInit ( )

inline

Definition at line 1955 of file Stmt.h.

Referenced by clang::TreeTransform< Derived >::TransformAttr().

◆ getInit() [2/2]

const Stmt* clang::IfStmt::getInit ( ) const

inline

Definition at line 1960 of file Stmt.h.

◆ getThen() [1/2]

Stmt* clang::IfStmt::getThen ( )

inline

Definition at line 1899 of file Stmt.h.

Referenced by DiagUninitUse(), isIdenticalStmt(), and clang::TreeTransform< Derived >::TransformAttr().

◆ getThen() [2/2]

const Stmt* clang::IfStmt::getThen ( ) const

inline

Definition at line 1900 of file Stmt.h.

◆ hasElseStorage()

bool clang::IfStmt::hasElseStorage ( ) const

inline

True if this IfStmt has storage for an else statement.

Definition at line 1885 of file Stmt.h.

Referenced by clang::TextNodeDumper::VisitIfStmt(), and clang::JSONNodeDumper::VisitIfStmt().

◆ hasInitStorage()

bool clang::IfStmt::hasInitStorage ( ) const

inline

True if this IfStmt has the storage for an init statement.

Definition at line 1879 of file Stmt.h.

Referenced by clang::TextNodeDumper::VisitIfStmt(), and clang::JSONNodeDumper::VisitIfStmt().

◆ hasVarStorage()

bool clang::IfStmt::hasVarStorage ( ) const

inline

True if this IfStmt has storage for a variable declaration.

Definition at line 1882 of file Stmt.h.

Referenced by clang::TextNodeDumper::VisitIfStmt(), and clang::JSONNodeDumper::VisitIfStmt().

◆ isConstexpr()

bool clang::IfStmt::isConstexpr ( ) const

inline

Definition at line 1985 of file Stmt.h.

Referenced by clang::TreeTransform< Derived >::TransformAttr(), and clang::JSONNodeDumper::VisitIfStmt().

◆ isObjCAvailabilityCheck()

bool IfStmt::isObjCAvailabilityCheck ( ) const

Definition at line 896 of file Stmt.cpp.

◆ setCond()

void clang::IfStmt::setCond ( Expr * Cond )

inline

Definition at line 1895 of file Stmt.h.

◆ setConditionVariable()

void IfStmt::setConditionVariable	(	const ASTContext &	Ctx,
		VarDecl *	V
	)

Set the condition variable for this if statement.

The if statement must have storage for the condition variable.

Definition at line 882 of file Stmt.cpp.

References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), and clang::VarDecl::getSourceRange().

◆ setConstexpr()

void clang::IfStmt::setConstexpr ( bool C )

inline

Definition at line 1986 of file Stmt.h.

◆ setElse()

void clang::IfStmt::setElse ( Stmt * Else )

inline

Definition at line 1918 of file Stmt.h.

◆ setElseLoc()

void clang::IfStmt::setElseLoc ( SourceLocation ElseLoc )

inline

Definition at line 1979 of file Stmt.h.

◆ setIfLoc()

void clang::IfStmt::setIfLoc ( SourceLocation IfLoc )

inline

Definition at line 1972 of file Stmt.h.

◆ setInit()

void clang::IfStmt::setInit ( Stmt * Init )

inline

Definition at line 1965 of file Stmt.h.

◆ setThen()

void clang::IfStmt::setThen ( Stmt * Then )

inline

Definition at line 1904 of file Stmt.h.

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

include/clang/AST/Stmt.h
lib/AST/Stmt.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ children() [1/2]

◆ children() [2/2]

◆ classof()

◆ Create()

◆ CreateEmpty()

◆ getBeginLoc()

◆ getCond() [1/2]

◆ getCond() [2/2]

◆ getConditionVariable() [1/2]

◆ getConditionVariable() [2/2]

◆ getConditionVariableDeclStmt() [1/2]

◆ getConditionVariableDeclStmt() [2/2]

◆ getElse() [1/2]

◆ getElse() [2/2]

◆ getElseLoc()

◆ getEndLoc()

◆ getIfLoc()

◆ getInit() [1/2]

◆ getInit() [2/2]

◆ getThen() [1/2]

◆ getThen() [2/2]

◆ hasElseStorage()

◆ hasInitStorage()

◆ hasVarStorage()

◆ isConstexpr()

◆ isObjCAvailabilityCheck()

◆ setCond()

◆ setConditionVariable()

◆ setConstexpr()

◆ setElse()

◆ setElseLoc()

◆ setIfLoc()

◆ setInit()

◆ setThen()