clang  6.0.0svn
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::CapturedStmt Class Reference

This captures a statement into a function. More...

#include "clang/AST/Stmt.h"

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

Classes

class  Capture
 Describes the capture of either a variable, or 'this', or variable-length array type. More...
 

Public Types

enum  VariableCaptureKind { VCK_This, VCK_ByRef, VCK_ByCopy, VCK_VLAType }
 The different capture forms: by 'this', by reference, capture for variable-length array type etc. More...
 
typedef Capturecapture_iterator
 An iterator that walks over the captures. More...
 
typedef const Captureconst_capture_iterator
 
typedef llvm::iterator_range< capture_iteratorcapture_range
 
typedef llvm::iterator_range< const_capture_iteratorcapture_const_range
 
typedef Expr ** capture_init_iterator
 Iterator that walks over the capture initialization arguments. More...
 
typedef llvm::iterator_range< capture_init_iteratorcapture_init_range
 
typedef Expr *const * const_capture_init_iterator
 Const iterator that walks over the capture initialization arguments. More...
 
typedef llvm::iterator_range< const_capture_init_iteratorconst_capture_init_range
 
- 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
 

Public Member Functions

StmtgetCapturedStmt ()
 Retrieve the statement being captured. More...
 
const StmtgetCapturedStmt () const
 
CapturedDeclgetCapturedDecl ()
 Retrieve the outlined function declaration. More...
 
const CapturedDeclgetCapturedDecl () const
 
void setCapturedDecl (CapturedDecl *D)
 Set the outlined function declaration. More...
 
CapturedRegionKind getCapturedRegionKind () const
 Retrieve the captured region kind. More...
 
void setCapturedRegionKind (CapturedRegionKind Kind)
 Set the captured region kind. More...
 
const RecordDeclgetCapturedRecordDecl () const
 Retrieve the record declaration for captured variables. More...
 
void setCapturedRecordDecl (RecordDecl *D)
 Set the record declaration for captured variables. More...
 
bool capturesVariable (const VarDecl *Var) const
 True if this variable has been captured. More...
 
capture_range captures ()
 
capture_const_range captures () const
 
capture_iterator capture_begin ()
 Retrieve an iterator pointing to the first capture. More...
 
const_capture_iterator capture_begin () const
 
capture_iterator capture_end () const
 Retrieve an iterator pointing past the end of the sequence of captures. More...
 
unsigned capture_size () const
 Retrieve the number of captures, including 'this'. More...
 
capture_init_range capture_inits ()
 
const_capture_init_range capture_inits () const
 
capture_init_iterator capture_init_begin ()
 Retrieve the first initialization argument. More...
 
const_capture_init_iterator capture_init_begin () const
 
capture_init_iterator capture_init_end ()
 Retrieve the iterator pointing one past the last initialization argument. More...
 
const_capture_init_iterator capture_init_end () const
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
SourceRange getSourceRange () 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 CapturedStmtCreate (const ASTContext &Context, Stmt *S, CapturedRegionKind Kind, ArrayRef< Capture > Captures, ArrayRef< Expr *> CaptureInits, CapturedDecl *CD, RecordDecl *RD)
 
static CapturedStmtCreateDeserialized (const ASTContext &Context, unsigned NumCaptures)
 
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

- 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

This captures a statement into a function.

For example, the following pragma annotated compound statement can be represented as a CapturedStmt, and this compound statement is the body of an anonymous outlined function.

#pragma omp parallel
{
compute();
}

Definition at line 2032 of file Stmt.h.

Member Typedef Documentation

◆ capture_const_range

Definition at line 2164 of file Stmt.h.

◆ capture_init_iterator

Iterator that walks over the capture initialization arguments.

Definition at line 2187 of file Stmt.h.

◆ capture_init_range

Definition at line 2188 of file Stmt.h.

◆ capture_iterator

An iterator that walks over the captures.

Definition at line 2161 of file Stmt.h.

◆ capture_range

Definition at line 2163 of file Stmt.h.

◆ const_capture_init_iterator

Const iterator that walks over the capture initialization arguments.

Definition at line 2192 of file Stmt.h.

◆ const_capture_init_range

Definition at line 2194 of file Stmt.h.

◆ const_capture_iterator

Definition at line 2162 of file Stmt.h.

Member Enumeration Documentation

◆ VariableCaptureKind

The different capture forms: by 'this', by reference, capture for variable-length array type etc.

Enumerator
VCK_This 
VCK_ByRef 
VCK_ByCopy 
VCK_VLAType 

Definition at line 2036 of file Stmt.h.

Member Function Documentation

◆ capture_begin() [1/2]

capture_iterator clang::CapturedStmt::capture_begin ( )
inline

Retrieve an iterator pointing to the first capture.

Definition at line 2174 of file Stmt.h.

Referenced by emitOffloadingArraysArgument().

◆ capture_begin() [2/2]

const_capture_iterator clang::CapturedStmt::capture_begin ( ) const
inline

Definition at line 2175 of file Stmt.h.

◆ capture_end()

capture_iterator clang::CapturedStmt::capture_end ( ) const
inline

Retrieve an iterator pointing past the end of the sequence of captures.

Definition at line 2179 of file Stmt.h.

Referenced by emitOffloadingArraysArgument().

◆ capture_init_begin() [1/2]

capture_init_iterator clang::CapturedStmt::capture_init_begin ( )
inline

Retrieve the first initialization argument.

Definition at line 2205 of file Stmt.h.

◆ capture_init_begin() [2/2]

const_capture_init_iterator clang::CapturedStmt::capture_init_begin ( ) const
inline

Definition at line 2209 of file Stmt.h.

◆ capture_init_end() [1/2]

capture_init_iterator clang::CapturedStmt::capture_init_end ( )
inline

Retrieve the iterator pointing one past the last initialization argument.

Definition at line 2215 of file Stmt.h.

◆ capture_init_end() [2/2]

const_capture_init_iterator clang::CapturedStmt::capture_init_end ( ) const
inline

Definition at line 2219 of file Stmt.h.

◆ capture_inits() [1/2]

capture_init_range clang::CapturedStmt::capture_inits ( )
inline

Definition at line 2196 of file Stmt.h.

◆ capture_inits() [2/2]

const_capture_init_range clang::CapturedStmt::capture_inits ( ) const
inline

Definition at line 2200 of file Stmt.h.

◆ capture_size()

unsigned clang::CapturedStmt::capture_size ( ) const
inline

Retrieve the number of captures, including 'this'.

Definition at line 2184 of file Stmt.h.

◆ captures() [1/2]

capture_range clang::CapturedStmt::captures ( )
inline

◆ captures() [2/2]

capture_const_range clang::CapturedStmt::captures ( ) const
inline

Definition at line 2169 of file Stmt.h.

◆ capturesVariable()

bool CapturedStmt::capturesVariable ( const VarDecl Var) const

True if this variable has been captured.

Definition at line 1113 of file Stmt.cpp.

◆ children()

Stmt::child_range CapturedStmt::children ( )

Definition at line 1085 of file Stmt.cpp.

◆ classof()

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

Definition at line 2233 of file Stmt.h.

References clang::children(), and clang::Stmt::getStmtClass().

◆ Create()

CapturedStmt * CapturedStmt::Create ( const ASTContext Context,
Stmt S,
CapturedRegionKind  Kind,
ArrayRef< Capture Captures,
ArrayRef< Expr *>  CaptureInits,
CapturedDecl CD,
RecordDecl RD 
)
static

Definition at line 1044 of file Stmt.cpp.

◆ CreateDeserialized()

CapturedStmt * CapturedStmt::CreateDeserialized ( const ASTContext Context,
unsigned  NumCaptures 
)
static

Definition at line 1072 of file Stmt.cpp.

◆ getCapturedDecl() [1/2]

CapturedDecl * CapturedStmt::getCapturedDecl ( )

◆ getCapturedDecl() [2/2]

const CapturedDecl * CapturedStmt::getCapturedDecl ( ) const

Definition at line 1093 of file Stmt.cpp.

◆ getCapturedRecordDecl()

const RecordDecl* clang::CapturedStmt::getCapturedRecordDecl ( ) const
inline

◆ getCapturedRegionKind()

CapturedRegionKind CapturedStmt::getCapturedRegionKind ( ) const

Retrieve the captured region kind.

Definition at line 1104 of file Stmt.cpp.

◆ getCapturedStmt() [1/2]

Stmt* clang::CapturedStmt::getCapturedStmt ( )
inline

◆ getCapturedStmt() [2/2]

const Stmt* clang::CapturedStmt::getCapturedStmt ( ) const
inline

Definition at line 2133 of file Stmt.h.

◆ getLocEnd()

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

Definition at line 2226 of file Stmt.h.

◆ getLocStart()

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

Definition at line 2223 of file Stmt.h.

◆ getSourceRange()

SourceRange clang::CapturedStmt::getSourceRange ( ) const
inline

Definition at line 2229 of file Stmt.h.

◆ setCapturedDecl()

void CapturedStmt::setCapturedDecl ( CapturedDecl D)

Set the outlined function declaration.

Definition at line 1098 of file Stmt.cpp.

◆ setCapturedRecordDecl()

void clang::CapturedStmt::setCapturedRecordDecl ( RecordDecl D)
inline

Set the record declaration for captured variables.

Definition at line 2152 of file Stmt.h.

◆ setCapturedRegionKind()

void CapturedStmt::setCapturedRegionKind ( CapturedRegionKind  Kind)

Set the captured region kind.

Definition at line 1109 of file Stmt.cpp.

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 2239 of file Stmt.h.


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