clang  14.0.0git
Public Member Functions | Static Public Member Functions | List of all members
clang::IfStmt Class Referencefinal

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

#include "clang/AST/Stmt.h"

Inheritance diagram for clang::IfStmt:
Inheritance graph
[legend]
Collaboration diagram for clang::IfStmt:
Collaboration graph
[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...
 
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. More...
 
const VarDeclgetConditionVariable () const
 
void setConditionVariable (const ASTContext &Ctx, VarDecl *V)
 Set the condition variable for this if statement. More...
 
DeclStmtgetConditionVariableDeclStmt ()
 If this IfStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable. More...
 
const DeclStmtgetConditionVariableDeclStmt () const
 
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
 
Optional< const Stmt * > getNondiscardedCase (const ASTContext &Ctx) const
 If this is an 'if constexpr', determine which substatement will be taken. More...
 
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. 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 (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. 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="\n", 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...
 
StmtIgnoreContainers (bool IgnoreCaptured=false)
 Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true. More...
 
const StmtIgnoreContainers (bool IgnoreCaptured=false) const
 
const StmtstripLabelLikeStatements () const
 Strip off all label-like statements. More...
 
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) 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 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. More...
 
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. 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 ()
 
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/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 = 8 }
 
enum  { NumExprBits = NumStmtBits + 5 + llvm::BitWidth<ExprDependence> }
 
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
 
   ArrayOrMatrixSubscriptExprBitfields   ArrayOrMatrixSubscriptExprBits
 
   CallExprBitfields   CallExprBits
 
   MemberExprBitfields   MemberExprBits
 
   CastExprBitfields   CastExprBits
 
   BinaryOperatorBitfields   BinaryOperatorBits
 
   InitListExprBitfields   InitListExprBits
 
   ParenListExprBitfields   ParenListExprBits
 
   GenericSelectionExprBitfields   GenericSelectionExprBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   SourceLocExprBitfields   SourceLocExprBits
 
   StmtExprBitfields   StmtExprBits
 
   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
 
   CoawaitExprBitfields   CoawaitBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   OpaqueValueExprBitfields   OpaqueValueExprBits
 
}; 
 

Detailed Description

IfStmt - This represents an if/then/else.

Definition at line 1904 of file Stmt.h.

Member Function Documentation

◆ children() [1/2]

child_range clang::IfStmt::children ( )
inline

Definition at line 2126 of file Stmt.h.

References isConsteval().

◆ children() [2/2]

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

Definition at line 2135 of file Stmt.h.

References isConsteval().

◆ classof()

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

Definition at line 2144 of file Stmt.h.

References clang::Stmt::getStmtClass().

◆ Create()

IfStmt * IfStmt::Create ( 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 
)
static

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

References clang::ASTContext::Allocate().

◆ getBeginLoc()

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

Definition at line 2113 of file Stmt.h.

References getIfLoc().

◆ getCond() [1/2]

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

Definition at line 1983 of file Stmt.h.

Referenced by getNondiscardedCase(), isIdenticalStmt(), and isObjCAvailabilityCheck().

◆ getCond() [2/2]

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

Definition at line 1987 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 973 of file Stmt.cpp.

References getConditionVariableDeclStmt().

Referenced by getConditionVariable().

◆ getConditionVariable() [2/2]

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

Definition at line 2029 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 2039 of file Stmt.h.

References hasVarStorage().

Referenced by getConditionVariable().

◆ getConditionVariableDeclStmt() [2/2]

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

Definition at line 2045 of file Stmt.h.

References hasVarStorage().

◆ getElse() [1/2]

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

Definition at line 2004 of file Stmt.h.

References hasElseStorage().

Referenced by getEndLoc(), getNondiscardedCase(), and isIdenticalStmt().

◆ getElse() [2/2]

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

Definition at line 2009 of file Stmt.h.

References hasElseStorage().

◆ getElseLoc()

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

Definition at line 2070 of file Stmt.h.

References hasElseStorage().

◆ getEndLoc()

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

Definition at line 2114 of file Stmt.h.

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

◆ getIfLoc()

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

Definition at line 2067 of file Stmt.h.

References clang::Stmt::IfStmtBits.

Referenced by getBeginLoc().

◆ getInit() [1/2]

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

Definition at line 2051 of file Stmt.h.

References hasInitStorage().

◆ getInit() [2/2]

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

Definition at line 2056 of file Stmt.h.

References hasInitStorage().

◆ getLParenLoc()

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

Definition at line 2119 of file Stmt.h.

◆ getNondiscardedCase() [1/2]

Optional< Stmt * > IfStmt::getNondiscardedCase ( const ASTContext Ctx)

◆ getNondiscardedCase() [2/2]

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

Definition at line 1005 of file Stmt.cpp.

Referenced by clang::EvaluatedExprVisitorBase< std::add_pointer, Derived >::VisitIfStmt().

◆ getRParenLoc()

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

Definition at line 2121 of file Stmt.h.

◆ getStatementKind()

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

Definition at line 2102 of file Stmt.h.

References clang::Stmt::IfStmtBits.

Referenced by isConsteval(), isConstexpr(), isNegatedConsteval(), and isNonNegatedConsteval().

◆ getThen() [1/2]

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

Definition at line 1995 of file Stmt.h.

Referenced by getEndLoc(), getNondiscardedCase(), and isIdenticalStmt().

◆ getThen() [2/2]

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

Definition at line 1996 of file Stmt.h.

◆ hasElseStorage()

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

True if this IfStmt has storage for an else statement.

Definition at line 1981 of file Stmt.h.

References clang::Stmt::IfStmtBits.

Referenced by getElse(), getElseLoc(), setElse(), setElseLoc(), 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 1975 of file Stmt.h.

References clang::Stmt::IfStmtBits.

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

◆ hasVarStorage()

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

True if this IfStmt has storage for a variable declaration.

Definition at line 1978 of file Stmt.h.

References clang::Stmt::IfStmtBits.

Referenced by getConditionVariableDeclStmt(), setConditionVariable(), and clang::JSONNodeDumper::VisitIfStmt().

◆ isConsteval()

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

◆ isConstexpr()

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

Definition at line 2094 of file Stmt.h.

References clang::Constexpr, and getStatementKind().

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

◆ isNegatedConsteval()

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

Definition at line 2090 of file Stmt.h.

References clang::ConstevalNegated, and getStatementKind().

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

◆ isNonNegatedConsteval()

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

Definition at line 2086 of file Stmt.h.

References clang::ConstevalNonNegated, and getStatementKind().

◆ isObjCAvailabilityCheck()

bool IfStmt::isObjCAvailabilityCheck ( ) const

Definition at line 994 of file Stmt.cpp.

References getCond().

◆ setCond()

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

Definition at line 1991 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 980 of file Stmt.cpp.

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

◆ setElse()

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

Definition at line 2014 of file Stmt.h.

References hasElseStorage().

◆ setElseLoc()

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

Definition at line 2075 of file Stmt.h.

References hasElseStorage().

◆ setIfLoc()

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

Definition at line 2068 of file Stmt.h.

References clang::Stmt::IfStmtBits.

◆ setInit()

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

Definition at line 2061 of file Stmt.h.

References hasInitStorage().

◆ setLParenLoc()

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

Definition at line 2120 of file Stmt.h.

◆ setRParenLoc()

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

Definition at line 2122 of file Stmt.h.

◆ setStatementKind()

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

Definition at line 2098 of file Stmt.h.

References clang::Stmt::IfStmtBits.

◆ setThen()

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

Definition at line 2000 of file Stmt.h.


The documentation for this class was generated from the following files:
x
IRgen optimization opportunities The common pattern of short x
Definition: README.txt:7
printf
int printf(__constant const char *st,...) __attribute__((format(printf