clang 19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::OMPFirstprivateClause Class Referencefinal

This represents clause 'firstprivate' in the '#pragma omp ...' directives. More...

#include "clang/AST/OpenMPClause.h"

Inheritance diagram for clang::OMPFirstprivateClause:
Inheritance graph
[legend]

Public Types

using private_copies_iterator = MutableArrayRef< Expr * >::iterator
 
using private_copies_const_iterator = ArrayRef< const Expr * >::iterator
 
using private_copies_range = llvm::iterator_range< private_copies_iterator >
 
using private_copies_const_range = llvm::iterator_range< private_copies_const_iterator >
 
using inits_iterator = MutableArrayRef< Expr * >::iterator
 
using inits_const_iterator = ArrayRef< const Expr * >::iterator
 
using inits_range = llvm::iterator_range< inits_iterator >
 
using inits_const_range = llvm::iterator_range< inits_const_iterator >
 
- Public Types inherited from clang::OMPVarListClause< OMPFirstprivateClause >
using varlist_iterator = MutableArrayRef< Expr * >::iterator
 
using varlist_const_iterator = ArrayRef< const Expr * >::iterator
 
using varlist_range = llvm::iterator_range< varlist_iterator >
 
using varlist_const_range = llvm::iterator_range< varlist_const_iterator >
 
- Public Types inherited from clang::OMPClause
using child_iterator = StmtIterator
 
using const_child_iterator = ConstStmtIterator
 
using child_range = llvm::iterator_range< child_iterator >
 
using const_child_range = llvm::iterator_range< const_child_iterator >
 

Public Member Functions

private_copies_range private_copies ()
 
private_copies_const_range private_copies () const
 
inits_range inits ()
 
inits_const_range inits () const
 
child_range children ()
 
const_child_range children () const
 
child_range used_children ()
 
const_child_range used_children () const
 
- Public Member Functions inherited from clang::OMPVarListClause< OMPFirstprivateClause >
ArrayRef< const Expr * > getVarRefs () const
 Fetches list of all variables in the clause.
 
unsigned varlist_size () const
 
bool varlist_empty () const
 
varlist_range varlists ()
 
varlist_const_range varlists () const
 
varlist_iterator varlist_begin ()
 
varlist_const_iterator varlist_begin () const
 
varlist_iterator varlist_end ()
 
varlist_const_iterator varlist_end () const
 
void setLParenLoc (SourceLocation Loc)
 Sets the location of '('.
 
SourceLocation getLParenLoc () const
 Returns the location of '('.
 
- Public Member Functions inherited from clang::OMPClause
SourceLocation getBeginLoc () const
 Returns the starting location of the clause.
 
SourceLocation getEndLoc () const
 Returns the ending location of the clause.
 
void setLocStart (SourceLocation Loc)
 Sets the starting location of the clause.
 
void setLocEnd (SourceLocation Loc)
 Sets the ending location of the clause.
 
OpenMPClauseKind getClauseKind () const
 Returns kind of OpenMP clause (private, shared, reduction, etc.).
 
bool isImplicit () const
 
child_range children ()
 
const_child_range children () const
 
child_range used_children ()
 Get the iterator range for the expressions used in the clauses.
 
const_child_range used_children () const
 
- Public Member Functions inherited from clang::OMPClauseWithPreInit
const StmtgetPreInitStmt () const
 Get pre-initialization statement for the clause.
 
StmtgetPreInitStmt ()
 Get pre-initialization statement for the clause.
 
OpenMPDirectiveKind getCaptureRegion () const
 Get capture region for the stmt in the clause.
 

Static Public Member Functions

static OMPFirstprivateClauseCreate (const ASTContext &C, SourceLocation StartLoc, SourceLocation LParenLoc, SourceLocation EndLoc, ArrayRef< Expr * > VL, ArrayRef< Expr * > PrivateVL, ArrayRef< Expr * > InitVL, Stmt *PreInit)
 Creates clause with a list of variables VL.
 
static OMPFirstprivateClauseCreateEmpty (const ASTContext &C, unsigned N)
 Creates an empty clause with the place for N variables.
 
static bool classof (const OMPClause *T)
 
- Static Public Member Functions inherited from clang::OMPClause
static bool classof (const OMPClause *)
 
- Static Public Member Functions inherited from clang::OMPClauseWithPreInit
static OMPClauseWithPreInitget (OMPClause *C)
 
static const OMPClauseWithPreInitget (const OMPClause *C)
 

Friends

class OMPClauseReader
 

Additional Inherited Members

- Protected Member Functions inherited from clang::OMPVarListClause< OMPFirstprivateClause >
 OMPVarListClause (OpenMPClauseKind K, SourceLocation StartLoc, SourceLocation LParenLoc, SourceLocation EndLoc, unsigned N)
 Build a clause with N variables.
 
MutableArrayRef< Expr * > getVarRefs ()
 Fetches list of variables associated with this clause.
 
void setVarRefs (ArrayRef< Expr * > VL)
 Sets the list of variables for this clause.
 
- Protected Member Functions inherited from clang::OMPClause
 OMPClause (OpenMPClauseKind K, SourceLocation StartLoc, SourceLocation EndLoc)
 
- Protected Member Functions inherited from clang::OMPClauseWithPreInit
 OMPClauseWithPreInit (const OMPClause *This)
 
void setPreInitStmt (Stmt *S, OpenMPDirectiveKind ThisRegion=llvm::omp::OMPD_unknown)
 Set pre-initialization statement for the clause.
 

Detailed Description

This represents clause 'firstprivate' in the '#pragma omp ...' directives.

#pragma omp parallel firstprivate(a,b)

In this example directive '#pragma omp parallel' has clause 'firstprivate' with the variables 'a' and 'b'.

Definition at line 2752 of file OpenMPClause.h.

Member Typedef Documentation

◆ inits_const_iterator

Definition at line 2850 of file OpenMPClause.h.

◆ inits_const_range

Definition at line 2852 of file OpenMPClause.h.

◆ inits_iterator

Definition at line 2849 of file OpenMPClause.h.

◆ inits_range

Definition at line 2851 of file OpenMPClause.h.

◆ private_copies_const_iterator

Definition at line 2835 of file OpenMPClause.h.

◆ private_copies_const_range

Definition at line 2837 of file OpenMPClause.h.

◆ private_copies_iterator

Definition at line 2834 of file OpenMPClause.h.

◆ private_copies_range

Definition at line 2836 of file OpenMPClause.h.

Member Function Documentation

◆ children() [1/2]

child_range clang::OMPFirstprivateClause::children ( )
inline

◆ children() [2/2]

const_child_range clang::OMPFirstprivateClause::children ( ) const
inline

Definition at line 2866 of file OpenMPClause.h.

References children().

◆ classof()

static bool clang::OMPFirstprivateClause::classof ( const OMPClause T)
inlinestatic

Definition at line 2880 of file OpenMPClause.h.

References clang::T.

◆ Create()

OMPFirstprivateClause * OMPFirstprivateClause::Create ( const ASTContext C,
SourceLocation  StartLoc,
SourceLocation  LParenLoc,
SourceLocation  EndLoc,
ArrayRef< Expr * >  VL,
ArrayRef< Expr * >  PrivateVL,
ArrayRef< Expr * >  InitVL,
Stmt PreInit 
)
static

Creates clause with a list of variables VL.

Parameters
CAST context.
StartLocStarting location of the clause.
LParenLocLocation of '('.
EndLocEnding location of the clause.
VLList of references to the original variables.
PrivateVLList of references to private copies with initializers.
InitVLList of references to auto generated variables used for initialization of a single array element. Used if firstprivate variable is of array type.
PreInitStatement that must be executed before entering the OpenMP region with this clause.

Definition at line 465 of file OpenMPClause.cpp.

References clang::C, clang::OMPClauseWithPreInit::setPreInitStmt(), and clang::OMPVarListClause< T >::setVarRefs().

Referenced by clang::SemaOpenMP::ActOnOpenMPFirstprivateClause().

◆ CreateEmpty()

OMPFirstprivateClause * OMPFirstprivateClause::CreateEmpty ( const ASTContext C,
unsigned  N 
)
static

Creates an empty clause with the place for N variables.

Parameters
CAST context.
NThe number of variables.

Definition at line 479 of file OpenMPClause.cpp.

References clang::C.

Referenced by clang::OMPClauseReader::readClause().

◆ inits() [1/2]

inits_range clang::OMPFirstprivateClause::inits ( )
inline

Definition at line 2854 of file OpenMPClause.h.

◆ inits() [2/2]

inits_const_range clang::OMPFirstprivateClause::inits ( ) const
inline

Definition at line 2857 of file OpenMPClause.h.

◆ private_copies() [1/2]

private_copies_range clang::OMPFirstprivateClause::private_copies ( )
inline

Definition at line 2840 of file OpenMPClause.h.

◆ private_copies() [2/2]

private_copies_const_range clang::OMPFirstprivateClause::private_copies ( ) const
inline

Definition at line 2844 of file OpenMPClause.h.

◆ used_children() [1/2]

child_range clang::OMPFirstprivateClause::used_children ( )
inline

◆ used_children() [2/2]

const_child_range clang::OMPFirstprivateClause::used_children ( ) const
inline

Definition at line 2875 of file OpenMPClause.h.

References used_children().

Friends And Related Function Documentation

◆ OMPClauseReader

friend class OMPClauseReader
friend

Definition at line 2756 of file OpenMPClause.h.


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