clang  8.0.0svn
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::CoroutineBodyStmt Class Referencefinal

Represents the body of a coroutine. More...

#include "clang/AST/StmtCXX.h"

Inheritance diagram for clang::CoroutineBodyStmt:
Inheritance graph
[legend]
Collaboration diagram for clang::CoroutineBodyStmt:
Collaboration graph
[legend]

Classes

struct  CtorArgs
 

Public Member Functions

bool hasDependentPromiseType () const
 
StmtgetBody () const
 Retrieve the body of the coroutine as written. More...
 
StmtgetPromiseDeclStmt () const
 
VarDeclgetPromiseDecl () const
 
StmtgetInitSuspendStmt () const
 
StmtgetFinalSuspendStmt () const
 
StmtgetExceptionHandler () const
 
StmtgetFallthroughHandler () const
 
ExprgetAllocate () const
 
ExprgetDeallocate () const
 
ExprgetReturnValueInit () const
 
StmtgetResultDecl () const
 
StmtgetReturnStmt () const
 
StmtgetReturnStmtOnAllocFailure () const
 
ArrayRef< Stmt const * > getParamMoves () const
 
SourceLocation getBeginLoc () const LLVM_READONLY
 
SourceLocation getEndLoc () const LLVM_READONLY
 
child_range children ()
 
- 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 (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 (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 viewAST () const
 viewAST - Visualize an AST rooted at this Stmt* using GraphViz. More...
 
StmtIgnoreImplicit ()
 Skip past any implicit AST nodes which might surround this statement, such as ExprWithCleanups or ImplicitCastExpr nodes. More...
 
const StmtIgnoreImplicit () const
 
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 CoroutineBodyStmtCreate (const ASTContext &C, CtorArgs const &Args)
 
static CoroutineBodyStmtCreate (const ASTContext &C, EmptyShell, unsigned NumParams)
 
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 ()
 

Friends

class ASTStmtReader
 
class ASTReader
 

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 = 8 }
 
enum  { NumExprBits = NumStmtBits + 9 }
 
enum  APFloatSemantics {
  IEEEhalf, IEEEsingle, IEEEdouble, x87DoubleExtended,
  IEEEquad, PPCDoubleDouble
}
 
- 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
 
   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
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   CXXBoolLiteralExprBitfields   CXXBoolLiteralExprBits
 
   CXXNullPtrLiteralExprBitfields   CXXNullPtrLiteralExprBits
 
   CXXThisExprBitfields   CXXThisExprBits
 
   CXXThrowExprBitfields   CXXThrowExprBits
 
   CXXDefaultArgExprBitfields   CXXDefaultArgExprBits
 
   CXXDefaultInitExprBitfields   CXXDefaultInitExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   CoawaitExprBitfields   CoawaitBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   OpaqueValueExprBitfields   OpaqueValueExprBits
 
}; 
 

Detailed Description

Represents the body of a coroutine.

This wraps the normal function body and holds the additional semantic context required to set up and tear down the coroutine frame.

Definition at line 302 of file StmtCXX.h.

Member Function Documentation

◆ children()

child_range clang::CoroutineBodyStmt::children ( )
inline

Definition at line 414 of file StmtCXX.h.

◆ classof()

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

Definition at line 419 of file StmtCXX.h.

References clang::Stmt::getStmtClass().

◆ Create() [1/2]

CoroutineBodyStmt * CoroutineBodyStmt::Create ( const ASTContext C,
CoroutineBodyStmt::CtorArgs const &  Args 
)
static

◆ Create() [2/2]

CoroutineBodyStmt * CoroutineBodyStmt::Create ( const ASTContext C,
EmptyShell  ,
unsigned  NumParams 
)
static

◆ getAllocate()

Expr* clang::CoroutineBodyStmt::getAllocate ( ) const
inline

Definition at line 388 of file StmtCXX.h.

◆ getBeginLoc()

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

Definition at line 406 of file StmtCXX.h.

◆ getBody()

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

Retrieve the body of the coroutine as written.

This will be either a CompoundStmt or a TryStmt.

Definition at line 363 of file StmtCXX.h.

Referenced by getExpressionTraitName().

◆ getDeallocate()

Expr* clang::CoroutineBodyStmt::getDeallocate ( ) const
inline

Definition at line 391 of file StmtCXX.h.

◆ getEndLoc()

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

Definition at line 410 of file StmtCXX.h.

◆ getExceptionHandler()

Stmt* clang::CoroutineBodyStmt::getExceptionHandler ( ) const
inline

Definition at line 381 of file StmtCXX.h.

◆ getFallthroughHandler()

Stmt* clang::CoroutineBodyStmt::getFallthroughHandler ( ) const
inline

Definition at line 384 of file StmtCXX.h.

◆ getFinalSuspendStmt()

Stmt* clang::CoroutineBodyStmt::getFinalSuspendStmt ( ) const
inline

Definition at line 377 of file StmtCXX.h.

◆ getInitSuspendStmt()

Stmt* clang::CoroutineBodyStmt::getInitSuspendStmt ( ) const
inline

Definition at line 374 of file StmtCXX.h.

◆ getParamMoves()

ArrayRef<Stmt const *> clang::CoroutineBodyStmt::getParamMoves ( ) const
inline

Definition at line 402 of file StmtCXX.h.

◆ getPromiseDecl()

VarDecl* clang::CoroutineBodyStmt::getPromiseDecl ( ) const
inline

Definition at line 370 of file StmtCXX.h.

◆ getPromiseDeclStmt()

Stmt* clang::CoroutineBodyStmt::getPromiseDeclStmt ( ) const
inline

Definition at line 367 of file StmtCXX.h.

◆ getResultDecl()

Stmt* clang::CoroutineBodyStmt::getResultDecl ( ) const
inline

Definition at line 397 of file StmtCXX.h.

◆ getReturnStmt()

Stmt* clang::CoroutineBodyStmt::getReturnStmt ( ) const
inline

Definition at line 398 of file StmtCXX.h.

◆ getReturnStmtOnAllocFailure()

Stmt* clang::CoroutineBodyStmt::getReturnStmtOnAllocFailure ( ) const
inline

Definition at line 399 of file StmtCXX.h.

◆ getReturnValueInit()

Expr* clang::CoroutineBodyStmt::getReturnValueInit ( ) const
inline

Definition at line 394 of file StmtCXX.h.

◆ hasDependentPromiseType()

bool clang::CoroutineBodyStmt::hasDependentPromiseType ( ) const
inline

Definition at line 357 of file StmtCXX.h.

Friends And Related Function Documentation

◆ ASTReader

friend class ASTReader
friend

Definition at line 323 of file StmtCXX.h.

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 322 of file StmtCXX.h.


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