clang  3.7.0
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. 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. More...

#include <Stmt.h>

Inheritance diagram for clang::CapturedStmt:
[legend]
Collaboration diagram for clang::CapturedStmt:
[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_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_iterator
capture_range
 
typedef llvm::iterator_range
< const_capture_iterator
capture_const_range
 
typedef Expr ** capture_init_iterator
 Iterator that walks over the capture initialization arguments. More...
 
typedef llvm::iterator_range
< capture_init_iterator
capture_init_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_iterator capture_init_begin () const
 Retrieve the first initialization argument. More...
 
capture_init_iterator capture_init_end () const
 Retrieve the iterator pointing one past the last initialization argument. More...
 
SourceLocation getLocStart () const LLVM_READONLY
 
SourceLocation getLocEnd () const LLVM_READONLY
 
SourceRange getSourceRange () const LLVM_READONLY
 
child_range children ()
 

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)
 

Friends

class ASTStmtReader
 

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 1989 of file Stmt.h.

Member Typedef Documentation

Definition at line 2141 of file Stmt.h.

Iterator that walks over the capture initialization arguments.

Definition at line 2164 of file Stmt.h.

Definition at line 2165 of file Stmt.h.

An iterator that walks over the captures.

Definition at line 2138 of file Stmt.h.

Definition at line 2140 of file Stmt.h.

Definition at line 2139 of file Stmt.h.

Member Enumeration Documentation

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

Enumerator
VCK_This 
VCK_ByRef 
VCK_VLAType 

Definition at line 1993 of file Stmt.h.

Member Function Documentation

capture_iterator clang::CapturedStmt::capture_begin ( )
inline

Retrieve an iterator pointing to the first capture.

Definition at line 2151 of file Stmt.h.

Referenced by clang::CodeGen::CodeGenFunction::CGCapturedStmtInfo::CGCapturedStmtInfo().

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

Definition at line 2152 of file Stmt.h.

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

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

Definition at line 2156 of file Stmt.h.

Referenced by clang::CodeGen::CodeGenFunction::CGCapturedStmtInfo::CGCapturedStmtInfo().

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

Retrieve the first initialization argument.

Definition at line 2172 of file Stmt.h.

Referenced by clang::CodeGen::CodeGenFunction::InitCapturedStruct().

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

Retrieve the iterator pointing one past the last initialization argument.

Definition at line 2178 of file Stmt.h.

Referenced by clang::CodeGen::CodeGenFunction::InitCapturedStruct().

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

Definition at line 2167 of file Stmt.h.

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

Retrieve the number of captures, including 'this'.

Definition at line 2161 of file Stmt.h.

capture_range clang::CapturedStmt::captures ( )
inline

Definition at line 2143 of file Stmt.h.

Referenced by capturesVariable().

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

Definition at line 2146 of file Stmt.h.

bool CapturedStmt::capturesVariable ( const VarDecl Var) const

True if this variable has been captured.

Definition at line 1161 of file Stmt.cpp.

References captures().

Stmt::child_range CapturedStmt::children ( )

Definition at line 1156 of file Stmt.cpp.

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

Definition at line 2192 of file Stmt.h.

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

Definition at line 1115 of file Stmt.cpp.

References clang::ASTContext::Allocate().

Referenced by clang::Sema::ActOnCapturedRegionEnd().

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

Definition at line 1143 of file Stmt.cpp.

References clang::ASTContext::Allocate().

CapturedDecl* clang::CapturedStmt::getCapturedDecl ( )
inline
const CapturedDecl* clang::CapturedStmt::getCapturedDecl ( ) const
inline

Definition at line 2105 of file Stmt.h.

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

Retrieve the captured region kind.

Definition at line 2116 of file Stmt.h.

Referenced by clang::CodeGen::CodeGenFunction::EmitStmt().

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

Retrieve the statement being captured.

Definition at line 2098 of file Stmt.h.

Referenced by clang::Sema::ActOnCapturedRegionEnd().

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

Definition at line 2099 of file Stmt.h.

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

Definition at line 2185 of file Stmt.h.

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

Definition at line 2188 of file Stmt.h.

void clang::CapturedStmt::setCapturedDecl ( CapturedDecl D)
inline

Set the outlined function declaration.

Definition at line 2110 of file Stmt.h.

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

Set the record declaration for captured variables.

Definition at line 2129 of file Stmt.h.

void clang::CapturedStmt::setCapturedRegionKind ( CapturedRegionKind  Kind)
inline

Set the captured region kind.

Definition at line 2121 of file Stmt.h.

Friends And Related Function Documentation

friend class ASTStmtReader
friend

Definition at line 2198 of file Stmt.h.


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