clang  6.0.0svn
Public Member Functions | Static Public Member Functions | List of all members
clang::ReturnStmt Class Reference

ReturnStmt - This represents a return, optionally of an expression: return; return 4;. More...

#include "clang/AST/Stmt.h"

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

Public Member Functions

 ReturnStmt (SourceLocation RL)
 
 ReturnStmt (SourceLocation RL, Expr *E, const VarDecl *NRVOCandidate)
 
 ReturnStmt (EmptyShell Empty)
 Build an empty return expression. More...
 
const ExprgetRetValue () const
 
ExprgetRetValue ()
 
void setRetValue (Expr *E)
 
SourceLocation getReturnLoc () const
 
void setReturnLoc (SourceLocation L)
 
const VarDeclgetNRVOCandidate () const
 Retrieve the variable that might be used for the named return value optimization. More...
 
void setNRVOCandidate (const VarDecl *Var)
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () 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 getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () 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
 
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, 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 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 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 ()
 

Additional Inherited Members

- Public Types inherited from clang::Stmt
enum  StmtClass { NoStmtClass = 0 }
 
typedef StmtIterator child_iterator
 Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpessions of an AST node. More...
 
typedef ConstStmtIterator const_child_iterator
 
typedef llvm::iterator_range< child_iteratorchild_range
 
typedef llvm::iterator_range< const_child_iteratorconst_child_range
 
- Protected Types inherited from clang::Stmt
enum  { NumStmtBits = 8 }
 
enum  { NumExprBits = 17 }
 
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
 
   CompoundStmtBitfields   CompoundStmtBits
 
   IfStmtBitfields   IfStmtBits
 
   ExprBitfields   ExprBits
 
   CharacterLiteralBitfields   CharacterLiteralBits
 
   FloatingLiteralBitfields   FloatingLiteralBits
 
   UnaryExprOrTypeTraitExprBitfields   UnaryExprOrTypeTraitExprBits
 
   DeclRefExprBitfields   DeclRefExprBits
 
   CastExprBitfields   CastExprBits
 
   CallExprBitfields   CallExprBits
 
   ExprWithCleanupsBitfields   ExprWithCleanupsBits
 
   PseudoObjectExprBitfields   PseudoObjectExprBits
 
   ObjCIndirectCopyRestoreExprBitfields   ObjCIndirectCopyRestoreExprBits
 
   InitListExprBitfields   InitListExprBits
 
   TypeTraitExprBitfields   TypeTraitExprBits
 
   CoawaitExprBitfields   CoawaitBits
 
}; 
 

Detailed Description

ReturnStmt - This represents a return, optionally of an expression: return; return 4;.

Note that GCC allows return with no argument in a function declared to return a value, and it allows returning a value in functions declared to return void. We explicitly model this in the AST, which means you can't depend on the return type of the function and the presence of an argument.

Definition at line 1392 of file Stmt.h.

Constructor & Destructor Documentation

◆ ReturnStmt() [1/3]

clang::ReturnStmt::ReturnStmt ( SourceLocation  RL)
inlineexplicit

Definition at line 1398 of file Stmt.h.

◆ ReturnStmt() [2/3]

clang::ReturnStmt::ReturnStmt ( SourceLocation  RL,
Expr E,
const VarDecl NRVOCandidate 
)
inline

Definition at line 1400 of file Stmt.h.

◆ ReturnStmt() [3/3]

clang::ReturnStmt::ReturnStmt ( EmptyShell  Empty)
inlineexplicit

Build an empty return expression.

Definition at line 1405 of file Stmt.h.

Member Function Documentation

◆ children()

child_range clang::ReturnStmt::children ( )
inline

Definition at line 1432 of file Stmt.h.

◆ classof()

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

Definition at line 1427 of file Stmt.h.

References clang::Stmt::getStmtClass().

◆ getLocEnd()

SourceLocation clang::ReturnStmt::getLocEnd ( ) const
inline

Definition at line 1423 of file Stmt.h.

References clang::Stmt::getLocEnd().

◆ getLocStart()

SourceLocation clang::ReturnStmt::getLocStart ( ) const
inline

Definition at line 1422 of file Stmt.h.

Referenced by clang::consumed::ConsumedStmtVisitor::VisitReturnStmt().

◆ getNRVOCandidate()

const VarDecl* clang::ReturnStmt::getNRVOCandidate ( ) const
inline

Retrieve the variable that might be used for the named return value optimization.

The optimization itself can only be performed if the variable is also marked as an NRVO object.

Definition at line 1419 of file Stmt.h.

◆ getReturnLoc()

SourceLocation clang::ReturnStmt::getReturnLoc ( ) const
inline

Definition at line 1411 of file Stmt.h.

Referenced by clang::consumed::ConsumedStmtVisitor::VisitReturnStmt().

◆ getRetValue() [1/2]

const Expr * ReturnStmt::getRetValue ( ) const

◆ getRetValue() [2/2]

Expr * ReturnStmt::getRetValue ( )

Definition at line 908 of file Stmt.cpp.

References clang::Stmt::Stmt().

◆ setNRVOCandidate()

void clang::ReturnStmt::setNRVOCandidate ( const VarDecl Var)
inline

Definition at line 1420 of file Stmt.h.

◆ setReturnLoc()

void clang::ReturnStmt::setReturnLoc ( SourceLocation  L)
inline

Definition at line 1412 of file Stmt.h.

◆ setRetValue()

void clang::ReturnStmt::setRetValue ( Expr E)
inline

Definition at line 1409 of file Stmt.h.


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