clang 22.0.0git
clang::IfStmt Class Referencefinal

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

#include "clang/AST/Stmt.h"

Inheritance diagram for clang::IfStmt:
[legend]

Public Member Functions

bool hasInitStorage () const
 True if this IfStmt has the storage for an init statement.
bool hasVarStorage () const
 True if this IfStmt has storage for a variable declaration.
bool hasElseStorage () const
 True if this IfStmt has storage for an else statement.
ExprgetCond ()
const ExprgetCond () const
void setCond (Expr *Cond)
StmtgetThen ()
const StmtgetThen () const
void setThen (Stmt *Then)
StmtgetElse ()
const StmtgetElse () const
void setElse (Stmt *Else)
VarDeclgetConditionVariable ()
 Retrieve the variable declared in this "if" statement, if any.
const VarDeclgetConditionVariable () const
void setConditionVariable (const ASTContext &Ctx, VarDecl *V)
 Set the condition variable for this if statement.
DeclStmtgetConditionVariableDeclStmt ()
 If this IfStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable.
const DeclStmtgetConditionVariableDeclStmt () const
void setConditionVariableDeclStmt (DeclStmt *CondVar)
StmtgetInit ()
const StmtgetInit () const
void setInit (Stmt *Init)
SourceLocation getIfLoc () const
void setIfLoc (SourceLocation IfLoc)
SourceLocation getElseLoc () const
void setElseLoc (SourceLocation ElseLoc)
bool isConsteval () const
bool isNonNegatedConsteval () const
bool isNegatedConsteval () const
bool isConstexpr () const
void setStatementKind (IfStatementKind Kind)
IfStatementKind getStatementKind () const
std::optional< const Stmt * > getNondiscardedCase (const ASTContext &Ctx) const
 If this is an 'if constexpr', determine which substatement will be taken.
std::optional< Stmt * > getNondiscardedCase (const ASTContext &Ctx)
bool isObjCAvailabilityCheck () const
SourceLocation getBeginLoc () const
SourceLocation getEndLoc () const LLVM_READONLY
SourceLocation getLParenLoc () const
void setLParenLoc (SourceLocation Loc)
SourceLocation getRParenLoc () const
void setRParenLoc (SourceLocation Loc)
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
Stmtoperator= (const Stmt &)=delete
Stmtoperator= (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.
StmtIgnoreContainers (bool IgnoreCaptured=false)
 Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true.
const StmtIgnoreContainers (bool IgnoreCaptured=false) const
const StmtstripLabelLikeStatements () const
 Strip off all label-like statements.
StmtstripLabelLikeStatements ()
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 IfStmtCreate (const ASTContext &Ctx, SourceLocation IL, IfStatementKind Kind, Stmt *Init, VarDecl *Var, Expr *Cond, SourceLocation LPL, SourceLocation RPL, Stmt *Then, SourceLocation EL=SourceLocation(), Stmt *Else=nullptr)
 Create an IfStmt.
static IfStmtCreateEmpty (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.
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 AttrgetLikelihoodAttr (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)

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 
   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 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits 
   OpaqueValueExprBitfields   OpaqueValueExprBits 
   ConvertVectorExprBitfields   ConvertVectorExprBits 
}; 

Detailed Description

IfStmt - This represents an if/then/else.

Definition at line 2257 of file Stmt.h.

Member Function Documentation

◆ children() [1/2]

child_range clang::IfStmt::children ( )
inline

Definition at line 2484 of file Stmt.h.

References isConsteval().

◆ children() [2/2]

const_child_range clang::IfStmt::children ( ) const
inline

Definition at line 2493 of file Stmt.h.

References isConsteval().

◆ classof()

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

Definition at line 2502 of file Stmt.h.

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

◆ Create()

◆ 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 1017 of file Stmt.cpp.

References clang::ASTContext::Allocate().

◆ getBeginLoc()

SourceLocation clang::IfStmt::getBeginLoc ( ) const
inline

Definition at line 2471 of file Stmt.h.

References getIfLoc().

◆ getCond() [1/2]

◆ getCond() [2/2]

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

Definition at line 2340 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);
}
CLINKAGE int printf(__constant const char *st,...) __attribute__((format(printf

Definition at line 1026 of file Stmt.cpp.

References clang::cast(), and getConditionVariableDeclStmt().

Referenced by clang::CodeGen::CodeGenFunction::EmitIfStmt(), EvaluateStmt(), getConditionVariable(), clang::ASTNodeImporter::VisitIfStmt(), and clang::interp::Compiler< Emitter >::visitIfStmt().

◆ getConditionVariable() [2/2]

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

Definition at line 2382 of file Stmt.h.

References getConditionVariable().

◆ 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 2392 of file Stmt.h.

References hasVarStorage().

Referenced by getConditionVariable(), clang::interp::Compiler< Emitter >::visitIfStmt(), and WalkUpFromIfStmt().

◆ getConditionVariableDeclStmt() [2/2]

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

Definition at line 2398 of file Stmt.h.

References hasVarStorage().

◆ getElse() [1/2]

◆ getElse() [2/2]

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

Definition at line 2362 of file Stmt.h.

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

◆ getElseLoc()

SourceLocation clang::IfStmt::getElseLoc ( ) const
inline

Definition at line 2428 of file Stmt.h.

References hasElseStorage().

Referenced by clang::ASTNodeImporter::VisitIfStmt(), and WalkUpFromIfStmt().

◆ getEndLoc()

SourceLocation clang::IfStmt::getEndLoc ( ) const
inline

Definition at line 2472 of file Stmt.h.

References getElse(), clang::Stmt::getEndLoc(), and getThen().

◆ getIfLoc()

SourceLocation clang::IfStmt::getIfLoc ( ) const
inline

Definition at line 2425 of file Stmt.h.

References clang::Stmt::IfStmtBits.

Referenced by getBeginLoc(), clang::ASTNodeImporter::VisitIfStmt(), and WalkUpFromIfStmt().

◆ getInit() [1/2]

◆ getInit() [2/2]

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

Definition at line 2414 of file Stmt.h.

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

◆ getLParenLoc()

SourceLocation clang::IfStmt::getLParenLoc ( ) const
inline

Definition at line 2477 of file Stmt.h.

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

◆ getNondiscardedCase() [1/2]

std::optional< Stmt * > IfStmt::getNondiscardedCase ( const ASTContext & Ctx)

◆ getNondiscardedCase() [2/2]

std::optional< const Stmt * > IfStmt::getNondiscardedCase ( const ASTContext & Ctx) const

If this is an 'if constexpr', determine which substatement will be taken.

Otherwise, or if the condition is value-dependent, returns std::nullopt.

Definition at line 1058 of file Stmt.cpp.

References getNondiscardedCase(), and clang::Result.

Referenced by getNondiscardedCase().

◆ getRParenLoc()

SourceLocation clang::IfStmt::getRParenLoc ( ) const
inline

Definition at line 2479 of file Stmt.h.

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

◆ getStatementKind()

IfStatementKind clang::IfStmt::getStatementKind ( ) const
inline

◆ getThen() [1/2]

◆ getThen() [2/2]

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

Definition at line 2349 of file Stmt.h.

References clang::Stmt::Stmt().

◆ hasElseStorage()

bool clang::IfStmt::hasElseStorage ( ) const
inline

True if this IfStmt has storage for an else statement.

Definition at line 2334 of file Stmt.h.

References clang::Stmt::IfStmtBits.

Referenced by getElse(), getElse(), getElseLoc(), setElse(), setElseLoc(), clang::JSONNodeDumper::VisitIfStmt(), and clang::TextNodeDumper::VisitIfStmt().

◆ hasInitStorage()

bool clang::IfStmt::hasInitStorage ( ) const
inline

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

Definition at line 2328 of file Stmt.h.

References clang::Stmt::IfStmtBits.

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

◆ hasVarStorage()

bool clang::IfStmt::hasVarStorage ( ) const
inline

◆ isConsteval()

◆ isConstexpr()

◆ isNegatedConsteval()

◆ isNonNegatedConsteval()

bool clang::IfStmt::isNonNegatedConsteval ( ) const
inline

◆ isObjCAvailabilityCheck()

bool IfStmt::isObjCAvailabilityCheck ( ) const

Definition at line 1047 of file Stmt.cpp.

References getCond(), and clang::isa().

◆ setCond()

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

Definition at line 2344 of file Stmt.h.

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

◆ 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 1033 of file Stmt.cpp.

References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), hasVarStorage(), and V.

◆ setConditionVariableDeclStmt()

void clang::IfStmt::setConditionVariableDeclStmt ( DeclStmt * CondVar)
inline

Definition at line 2404 of file Stmt.h.

References hasVarStorage().

◆ setElse()

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

Definition at line 2367 of file Stmt.h.

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

◆ setElseLoc()

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

Definition at line 2433 of file Stmt.h.

References hasElseStorage().

◆ setIfLoc()

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

Definition at line 2426 of file Stmt.h.

References clang::Stmt::IfStmtBits.

◆ setInit()

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

Definition at line 2419 of file Stmt.h.

References hasInitStorage(), clang::Init, and clang::Stmt::Stmt().

◆ setLParenLoc()

void clang::IfStmt::setLParenLoc ( SourceLocation Loc)
inline

Definition at line 2478 of file Stmt.h.

◆ setRParenLoc()

void clang::IfStmt::setRParenLoc ( SourceLocation Loc)
inline

Definition at line 2480 of file Stmt.h.

◆ setStatementKind()

void clang::IfStmt::setStatementKind ( IfStatementKind Kind)
inline

Definition at line 2456 of file Stmt.h.

References clang::Stmt::IfStmtBits.

◆ setThen()

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

Definition at line 2353 of file Stmt.h.

References clang::Stmt::Stmt().


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