clang 10.0.0git

Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::CoreturnStmt Class Reference

Represents a 'co_return' statement in the C++ Coroutines TS. More...

`#include "clang/AST/StmtCXX.h"`

Inheritance diagram for clang::CoreturnStmt:
[legend]
Collaboration diagram for clang::CoreturnStmt:
[legend]

## Public Member Functions
| CoreturnStmt (SourceLocation CoreturnLoc, Stmt *Operand, Stmt *PromiseCall, bool IsImplicit=false)
| CoreturnStmt (EmptyShell)
SourceLocation | getKeywordLoc () const
Expr * | getOperand () const
| Retrieve the operand of the 'co_return' statement. More...
Expr * | getPromiseCall () const
| Retrieve the promise call that results from this 'co_return' statement. More...
bool | isImplicit () const
void | setIsImplicit (bool value=true)
SourceLocation | getBeginLoc () const LLVM_READONLY
SourceLocation | getEndLoc () const LLVM_READONLY
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
bool | isOMPStructuredBlock () const
void | setIsOMPStructuredBlock (bool IsOMPStructuredBlock)
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 | 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...
Stmt * | IgnoreContainers (bool IgnoreCaptured=false)
| Skip no-op (attributed, compound) container stmts and skip captured stmt at the top, if IgnoreCaptured is true. More...
const Stmt * | IgnoreContainers (bool IgnoreCaptured=false) const
const Stmt * | stripLabelLikeStatements () const
| Strip off all label-like statements. More...
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) 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 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

## 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 = 9 }
enum | { NumExprBits = NumStmtBits + 9 }
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
ArraySubscriptExprBitfields ArraySubscriptExprBits
CallExprBitfields CallExprBits
MemberExprBitfields MemberExprBits
CastExprBitfields CastExprBits
BinaryOperatorBitfields BinaryOperatorBits
InitListExprBitfields InitListExprBits
ParenListExprBitfields ParenListExprBits
GenericSelectionExprBitfields GenericSelectionExprBits
PseudoObjectExprBitfields PseudoObjectExprBits
SourceLocExprBitfields SourceLocExprBits
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
RequiresExprBitfields RequiresExprBits
CoawaitExprBitfields CoawaitBits
ObjCIndirectCopyRestoreExprBitfields ObjCIndirectCopyRestoreExprBits
OpaqueValueExprBitfields OpaqueValueExprBits
}; |

## Detailed Description

Represents a 'co_return' statement in the C++ Coroutines TS.

This statament models the initialization of the coroutine promise (encapsulating the eventual notional return value) from an expression (or braced-init-list), followed by termination of the coroutine.

This initialization is modeled by the evaluation of the operand followed by a call to one of: <promise>.return_value(<operand>) <promise>.return_void() which we name the "promise call".

Definition at line 456 of file StmtCXX.h.

## Constructor & Destructor Documentation

## ◆ CoreturnStmt() [1/2]

clang::CoreturnStmt::CoreturnStmt | ( | SourceLocation | CoreturnLoc,
|  | Stmt * | Operand,
|  | Stmt * | PromiseCall,
|  | bool | IsImplicit = `false`
| ) |  |
| inline

Definition at line 466 of file StmtCXX.h.

## ◆ CoreturnStmt() [2/2]

clang::CoreturnStmt::CoreturnStmt | ( | EmptyShell |  | ) |
| inline

Definition at line 474 of file StmtCXX.h.

## Member Function Documentation

## ◆ children() [1/2]

child_range clang::CoreturnStmt::children | ( |  | ) |
| inline

Definition at line 497 of file StmtCXX.h.

## ◆ children() [2/2]

const_child_range clang::CoreturnStmt::children | ( |  | ) | const
| inline

Definition at line 504 of file StmtCXX.h.

## ◆ classof()

static bool clang::CoreturnStmt::classof | ( | const Stmt * | T | ) |
| inline static

Definition at line 511 of file StmtCXX.h.

References clang::Stmt::getStmtClass().

## ◆ getBeginLoc()

SourceLocation clang::CoreturnStmt::getBeginLoc | ( |  | ) | const
| inline

Definition at line 492 of file StmtCXX.h.

## ◆ getEndLoc()

SourceLocation clang::CoreturnStmt::getEndLoc | ( |  | ) | const
| inline

Definition at line 493 of file StmtCXX.h.

References clang::CXXCatchStmt::getBeginLoc().

## ◆ getKeywordLoc()

SourceLocation clang::CoreturnStmt::getKeywordLoc | ( |  | ) | const
| inline

Definition at line 476 of file StmtCXX.h.

## ◆ getOperand()

Expr* clang::CoreturnStmt::getOperand | ( |  | ) | const
| inline

Retrieve the operand of the 'co_return' statement.

Will be nullptr if none was specified.

Definition at line 480 of file StmtCXX.h.

Referenced by getExpressionTraitName().

## ◆ getPromiseCall()

Expr* clang::CoreturnStmt::getPromiseCall | ( |  | ) | const
| inline

Retrieve the promise call that results from this 'co_return' statement.

Will be nullptr if either the coroutine has not yet been finalized or the coroutine has no eventual return type.

Definition at line 485 of file StmtCXX.h.

## ◆ isImplicit()

bool clang::CoreturnStmt::isImplicit | ( |  | ) | const
| inline

Definition at line 489 of file StmtCXX.h.

## ◆ setIsImplicit()

void clang::CoreturnStmt::setIsImplicit | ( | bool | value = `true` | ) |
| inline

Definition at line 490 of file StmtCXX.h.

## Friends And Related Function Documentation

## ◆ ASTStmtReader

friend class ASTStmtReader
| friend

Definition at line 464 of file StmtCXX.h.

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

- include/clang/AST/StmtCXX.h