clang  8.0.0svn
Public Member Functions | Friends | List of all members
clang::CapturedStmt::Capture Class Reference

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

#include "clang/AST/Stmt.h"

Public Member Functions

 Capture (SourceLocation Loc, VariableCaptureKind Kind, VarDecl *Var=nullptr)
 Create a new capture. More...
 
VariableCaptureKind getCaptureKind () const
 Determine the kind of capture. More...
 
SourceLocation getLocation () const
 Retrieve the source location at which the variable or 'this' was first used. More...
 
bool capturesThis () const
 Determine whether this capture handles the C++ 'this' pointer. More...
 
bool capturesVariable () const
 Determine whether this capture handles a variable (by reference). More...
 
bool capturesVariableByCopy () const
 Determine whether this capture handles a variable by copy. More...
 
bool capturesVariableArrayType () const
 Determine whether this capture handles a variable-length array type. More...
 
VarDeclgetCapturedVar () const
 Retrieve the declaration of the variable being captured. More...
 

Friends

class ASTStmtReader
 

Detailed Description

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

Definition at line 2090 of file Stmt.h.

Constructor & Destructor Documentation

◆ Capture()

CapturedStmt::Capture::Capture ( SourceLocation  Loc,
VariableCaptureKind  Kind,
VarDecl Var = nullptr 
)

Create a new capture.

Parameters
LocThe source location associated with this capture.
KindThe kind of capture (this, ByRef, ...).
VarThe variable being captured, or null if capturing this.

Definition at line 984 of file Stmt.cpp.

References clang::Type::castAs(), clang::ValueDecl::getType(), clang::Type::isReferenceType(), clang::Type::isScalarType(), clang::CapturedStmt::VCK_ByCopy, clang::CapturedStmt::VCK_ByRef, clang::CapturedStmt::VCK_This, and clang::CapturedStmt::VCK_VLAType.

Member Function Documentation

◆ capturesThis()

bool clang::CapturedStmt::Capture::capturesThis ( ) const
inline

Determine whether this capture handles the C++ 'this' pointer.

Definition at line 2115 of file Stmt.h.

◆ capturesVariable()

bool clang::CapturedStmt::Capture::capturesVariable ( ) const
inline

Determine whether this capture handles a variable (by reference).

Definition at line 2118 of file Stmt.h.

Referenced by getCapturedVar().

◆ capturesVariableArrayType()

bool clang::CapturedStmt::Capture::capturesVariableArrayType ( ) const
inline

Determine whether this capture handles a variable-length array type.

Definition at line 2127 of file Stmt.h.

◆ capturesVariableByCopy()

bool clang::CapturedStmt::Capture::capturesVariableByCopy ( ) const
inline

Determine whether this capture handles a variable by copy.

Definition at line 2121 of file Stmt.h.

Referenced by getCapturedVar().

◆ getCapturedVar()

VarDecl * CapturedStmt::Capture::getCapturedVar ( ) const

Retrieve the declaration of the variable being captured.

This operation is only valid if this capture captures a variable.

Definition at line 1016 of file Stmt.cpp.

References capturesVariable(), and capturesVariableByCopy().

◆ getCaptureKind()

CapturedStmt::VariableCaptureKind CapturedStmt::Capture::getCaptureKind ( ) const

Determine the kind of capture.

Definition at line 1012 of file Stmt.cpp.

◆ getLocation()

SourceLocation clang::CapturedStmt::Capture::getLocation ( ) const
inline

Retrieve the source location at which the variable or 'this' was first used.

Definition at line 2112 of file Stmt.h.

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 2095 of file Stmt.h.


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