clang 19.0.0git
Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::ForStmt Class Reference

ForStmt - This represents a 'for (init;cond;inc)' stmt. More...

#include "clang/AST/Stmt.h"

Inheritance diagram for clang::ForStmt:
Inheritance graph
[legend]

Public Member Functions

 ForStmt (const ASTContext &C, Stmt *Init, Expr *Cond, VarDecl *condVar, Expr *Inc, Stmt *Body, SourceLocation FL, SourceLocation LP, SourceLocation RP)
 
 ForStmt (EmptyShell Empty)
 Build an empty for statement.
 
Stmt * getInit ()
 
VarDecl * getConditionVariable () const
 Retrieve the variable declared in this "for" statement, if any.
 
void setConditionVariable (const ASTContext &C, VarDecl *V)
 
DeclStmt * getConditionVariableDeclStmt ()
 If this ForStmt has a condition variable, return the faux DeclStmt associated with the creation of that condition variable.
 
const DeclStmt * getConditionVariableDeclStmt () const
 
void setConditionVariableDeclStmt (DeclStmt *CondVar)
 
Expr * getCond ()
 
Expr * getInc ()
 
Stmt * getBody ()
 
const Stmt * getInit () const
 
const Expr * getCond () const
 
const Expr * getInc () const
 
const Stmt * getBody () const
 
void setInit (Stmt *S)
 
void setCond (Expr *E)
 
void setInc (Expr *E)
 
void setBody (Stmt *S)
 
SourceLocation getForLoc () const
 
void setForLoc (SourceLocation L)
 
SourceLocation getLParenLoc () const
 
void setLParenLoc (SourceLocation L)
 
SourceLocation getRParenLoc () const
 
void setRParenLoc (SourceLocation L)
 
SourceLocation getBeginLoc () const
 
SourceLocation getEndLoc () 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 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  { 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 *.
 
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
 
   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

ForStmt - This represents a 'for (init;cond;inc)' stmt.

Note that any of the init/cond/inc parts of the ForStmt will be null if they were not specified in the source.

Definition at line 2781 of file Stmt.h.

Constructor & Destructor Documentation

◆ ForStmt() [1/2]

ForStmt::ForStmt ( const ASTContext &  C,
Stmt *  Init,
Expr *  Cond,
VarDecl *  condVar,
Expr *  Inc,
Stmt *  Body,
SourceLocation  FL,
SourceLocation  LP,
SourceLocation  RP 
)

Definition at line 1021 of file Stmt.cpp.

References clang::C, clang::Stmt::ForStmtBits, clang::Init, and setConditionVariable().

◆ ForStmt() [2/2]

clang::ForStmt::ForStmt ( EmptyShell  Empty)
inlineexplicit

Build an empty for statement.

Definition at line 2794 of file Stmt.h.

Member Function Documentation

◆ children() [1/2]

child_range clang::ForStmt::children ( )
inline

Definition at line 2852 of file Stmt.h.

◆ children() [2/2]

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

Definition at line 2856 of file Stmt.h.

◆ classof()

static bool clang::ForStmt::classof ( const Stmt *  T)
inlinestatic

Definition at line 2847 of file Stmt.h.

References clang::T.

◆ getBeginLoc()

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

Definition at line 2844 of file Stmt.h.

References getForLoc().

Referenced by DiagnoseForRangeVariableCopies().

◆ getBody() [1/2]

Stmt * clang::ForStmt::getBody ( )
inline

Definition at line 2825 of file Stmt.h.

Referenced by getEndLoc(), and isIdenticalStmt().

◆ getBody() [2/2]

const Stmt * clang::ForStmt::getBody ( ) const
inline

Definition at line 2830 of file Stmt.h.

◆ getCond() [1/2]

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

Definition at line 2823 of file Stmt.h.

Referenced by isIdenticalStmt().

◆ getCond() [2/2]

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

Definition at line 2828 of file Stmt.h.

◆ getConditionVariable()

VarDecl * ForStmt::getConditionVariable ( ) const

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

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

for (int x = random(); int y = mangle(x); ++x) {
// ...
}

Definition at line 1034 of file Stmt.cpp.

◆ getConditionVariableDeclStmt() [1/2]

DeclStmt * clang::ForStmt::getConditionVariableDeclStmt ( )
inline

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

Definition at line 2811 of file Stmt.h.

◆ getConditionVariableDeclStmt() [2/2]

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

Definition at line 2815 of file Stmt.h.

◆ getEndLoc()

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

Definition at line 2845 of file Stmt.h.

References getBody(), and clang::Stmt::getEndLoc().

◆ getForLoc()

SourceLocation clang::ForStmt::getForLoc ( ) const
inline

Definition at line 2837 of file Stmt.h.

References clang::Stmt::ForStmtBits.

Referenced by getBeginLoc().

◆ getInc() [1/2]

Expr * clang::ForStmt::getInc ( )
inline

Definition at line 2824 of file Stmt.h.

Referenced by isIdenticalStmt().

◆ getInc() [2/2]

const Expr * clang::ForStmt::getInc ( ) const
inline

Definition at line 2829 of file Stmt.h.

◆ getInit() [1/2]

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

Definition at line 2796 of file Stmt.h.

Referenced by isIdenticalStmt().

◆ getInit() [2/2]

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

Definition at line 2827 of file Stmt.h.

◆ getLParenLoc()

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

Definition at line 2839 of file Stmt.h.

◆ getRParenLoc()

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

Definition at line 2841 of file Stmt.h.

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

◆ setBody()

void clang::ForStmt::setBody ( Stmt *  S)
inline

Definition at line 2835 of file Stmt.h.

Referenced by clang::Sema::FinishCXXForRangeStmt(), and clang::Sema::FinishObjCForCollectionStmt().

◆ setCond()

void clang::ForStmt::setCond ( Expr *  E)
inline

Definition at line 2833 of file Stmt.h.

◆ setConditionVariable()

void ForStmt::setConditionVariable ( const ASTContext &  C,
VarDecl *  V 
)

Definition at line 1042 of file Stmt.cpp.

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

Referenced by ForStmt().

◆ setConditionVariableDeclStmt()

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

Definition at line 2819 of file Stmt.h.

◆ setForLoc()

void clang::ForStmt::setForLoc ( SourceLocation  L)
inline

Definition at line 2838 of file Stmt.h.

References clang::Stmt::ForStmtBits.

◆ setInc()

void clang::ForStmt::setInc ( Expr *  E)
inline

Definition at line 2834 of file Stmt.h.

◆ setInit()

void clang::ForStmt::setInit ( Stmt *  S)
inline

Definition at line 2832 of file Stmt.h.

◆ setLParenLoc()

void clang::ForStmt::setLParenLoc ( SourceLocation  L)
inline

Definition at line 2840 of file Stmt.h.

◆ setRParenLoc()

void clang::ForStmt::setRParenLoc ( SourceLocation  L)
inline

Definition at line 2842 of file Stmt.h.

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 2782 of file Stmt.h.

The documentation for this class was generated from the following files:
Generated on Mon Apr 22 2024 23:35:40 for clang by doxygen 1.9.6