clang 22.0.0git
clang::CompoundStmt Class Referencefinal

CompoundStmt - This represents a group of statements like { stmt stmt }. More...

#include "clang/AST/Stmt.h"

Inheritance diagram for clang::CompoundStmt:
[legend]

Public Types

using body_iterator = Stmt **
using body_range = llvm::iterator_range<body_iterator>
using const_body_iterator = Stmt *const *
using body_const_range = llvm::iterator_range<const_body_iterator>
using reverse_body_iterator = std::reverse_iterator<body_iterator>
using const_reverse_body_iterator
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>

Public Member Functions

 CompoundStmt (SourceLocation Loc)
 CompoundStmt (SourceLocation Loc, SourceLocation EndLoc)
bool body_empty () const
unsigned size () const
bool hasStoredFPFeatures () const
FPOptionsOverride getStoredFPFeatures () const
 Get FPOptionsOverride from trailing storage.
FPOptionsOverride getStoredFPFeaturesOrDefault () const
 Get the store FPOptionsOverride or default if not stored.
body_range body ()
body_iterator body_begin ()
body_iterator body_end ()
Stmtbody_front ()
Stmtbody_back ()
body_const_range body () const
const_body_iterator body_begin () const
const_body_iterator body_end () const
const Stmtbody_front () const
const Stmtbody_back () const
reverse_body_iterator body_rbegin ()
reverse_body_iterator body_rend ()
const_reverse_body_iterator body_rbegin () const
const_reverse_body_iterator body_rend () const
StmtgetStmtExprResult ()
const StmtgetStmtExprResult () const
SourceLocation getBeginLoc () const
SourceLocation getEndLoc () const
SourceLocation getLBracLoc () const
SourceLocation getRBracLoc () 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
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 CompoundStmtCreate (const ASTContext &C, ArrayRef< Stmt * > Stmts, FPOptionsOverride FPFeatures, SourceLocation LB, SourceLocation RB)
static CompoundStmtCreateEmpty (const ASTContext &C, unsigned NumStmts, bool HasFPFeatures)
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)

Friends

class ASTStmtReader

Additional Inherited Members

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

CompoundStmt - This represents a group of statements like { stmt stmt }.

Definition at line 1718 of file Stmt.h.

Member Typedef Documentation

◆ body_const_range

Definition at line 1793 of file Stmt.h.

◆ body_iterator

Definition at line 1780 of file Stmt.h.

◆ body_range

using clang::CompoundStmt::body_range = llvm::iterator_range<body_iterator>

Definition at line 1781 of file Stmt.h.

◆ const_body_iterator

Definition at line 1792 of file Stmt.h.

◆ const_reverse_body_iterator

Initial value:
std::reverse_iterator<const_body_iterator>

Definition at line 1823 of file Stmt.h.

◆ reverse_body_iterator

Definition at line 1813 of file Stmt.h.

Constructor & Destructor Documentation

◆ CompoundStmt() [1/2]

clang::CompoundStmt::CompoundStmt ( SourceLocation Loc)
inlineexplicit

Definition at line 1752 of file Stmt.h.

◆ CompoundStmt() [2/2]

clang::CompoundStmt::CompoundStmt ( SourceLocation Loc,
SourceLocation EndLoc )
inline

Definition at line 1754 of file Stmt.h.

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

Member Function Documentation

◆ body() [1/2]

◆ body() [2/2]

body_const_range clang::CompoundStmt::body ( ) const
inline

Definition at line 1795 of file Stmt.h.

References body_begin(), and body_end().

◆ body_back() [1/2]

Stmt * clang::CompoundStmt::body_back ( )
inline

◆ body_back() [2/2]

const Stmt * clang::CompoundStmt::body_back ( ) const
inline

Definition at line 1809 of file Stmt.h.

References body_begin(), body_empty(), size(), and clang::Stmt::Stmt().

◆ body_begin() [1/2]

body_iterator clang::CompoundStmt::body_begin ( )
inline

◆ body_begin() [2/2]

const_body_iterator clang::CompoundStmt::body_begin ( ) const
inline

Definition at line 1799 of file Stmt.h.

◆ body_empty()

bool clang::CompoundStmt::body_empty ( ) const
inline

◆ body_end() [1/2]

body_iterator clang::CompoundStmt::body_end ( )
inline

Definition at line 1785 of file Stmt.h.

References body_begin(), and size().

Referenced by body(), body(), body_rbegin(), body_rbegin(), children(), and children().

◆ body_end() [2/2]

const_body_iterator clang::CompoundStmt::body_end ( ) const
inline

Definition at line 1803 of file Stmt.h.

References body_begin(), and size().

◆ body_front() [1/2]

Stmt * clang::CompoundStmt::body_front ( )
inline

Definition at line 1786 of file Stmt.h.

References body_begin(), body_empty(), and clang::Stmt::Stmt().

◆ body_front() [2/2]

const Stmt * clang::CompoundStmt::body_front ( ) const
inline

Definition at line 1805 of file Stmt.h.

References body_begin(), body_empty(), and clang::Stmt::Stmt().

◆ body_rbegin() [1/2]

reverse_body_iterator clang::CompoundStmt::body_rbegin ( )
inline

Definition at line 1815 of file Stmt.h.

References body_end().

Referenced by print_elem().

◆ body_rbegin() [2/2]

const_reverse_body_iterator clang::CompoundStmt::body_rbegin ( ) const
inline

Definition at line 1826 of file Stmt.h.

References body_end().

◆ body_rend() [1/2]

reverse_body_iterator clang::CompoundStmt::body_rend ( )
inline

Definition at line 1819 of file Stmt.h.

References body_begin().

◆ body_rend() [2/2]

const_reverse_body_iterator clang::CompoundStmt::body_rend ( ) const
inline

Definition at line 1830 of file Stmt.h.

References body_begin().

◆ children() [1/2]

child_range clang::CompoundStmt::children ( )
inline

Definition at line 1865 of file Stmt.h.

References body_begin(), and body_end().

◆ children() [2/2]

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

Definition at line 1867 of file Stmt.h.

References body_begin(), and body_end().

◆ classof()

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

Definition at line 1860 of file Stmt.h.

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

◆ Create()

◆ CreateEmpty()

CompoundStmt * CompoundStmt::CreateEmpty ( const ASTContext & C,
unsigned NumStmts,
bool HasFPFeatures )
static

Definition at line 400 of file Stmt.cpp.

References clang::C, clang::CompoundStmt, and New.

◆ getBeginLoc()

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

◆ getEndLoc()

◆ getLBracLoc()

◆ getRBracLoc()

◆ getStmtExprResult() [1/2]

◆ getStmtExprResult() [2/2]

const Stmt * clang::CompoundStmt::getStmtExprResult ( ) const
inline

Definition at line 1850 of file Stmt.h.

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

◆ getStoredFPFeatures()

FPOptionsOverride clang::CompoundStmt::getStoredFPFeatures ( ) const
inline

◆ getStoredFPFeaturesOrDefault()

FPOptionsOverride clang::CompoundStmt::getStoredFPFeaturesOrDefault ( ) const
inline

Get the store FPOptionsOverride or default if not stored.

Definition at line 1776 of file Stmt.h.

References getStoredFPFeatures(), and hasStoredFPFeatures().

◆ hasStoredFPFeatures()

◆ size()

unsigned clang::CompoundStmt::size ( ) const
inline

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 1721 of file Stmt.h.

References ASTStmtReader, clang::Empty, and clang::Stmt::Stmt().

Referenced by ASTStmtReader.


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