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

This is a basic class for representing single OpenMP executable directive. More...

#include "clang/AST/StmtOpenMP.h"

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

Classes

class  specific_clause_iterator
 Iterates over a filtered subrange of clauses applied to a directive. More...
 

Public Member Functions

template<typename SpecificClause >
llvm::iterator_range< specific_clause_iterator< SpecificClause > > getClausesOfKind () const
 
template<typename SpecificClause >
const SpecificClause * getSingleClause () const
 Gets a single clause of the specified kind associated with the current directive iff there is only one clause of this kind (and assertion is fired if there is more than one clause is associated with the directive). More...
 
template<typename SpecificClause >
bool hasClausesOfKind () const
 Returns true if the current directive has one or more clauses of a specific kind. More...
 
SourceLocation getLocStart () const
 Returns starting location of directive kind. More...
 
SourceLocation getLocEnd () const
 Returns ending location of directive. More...
 
void setLocStart (SourceLocation Loc)
 Set starting location of directive kind. More...
 
void setLocEnd (SourceLocation Loc)
 Set ending location of directive. More...
 
unsigned getNumClauses () const
 Get number of clauses. More...
 
OMPClausegetClause (unsigned i) const
 Returns specified clause. More...
 
bool hasAssociatedStmt () const
 Returns true if directive has associated statement. More...
 
StmtgetAssociatedStmt () const
 Returns statement associated with the directive. More...
 
CapturedStmtgetCapturedStmt (OpenMPDirectiveKind RegionKind) const
 Returns the captured statement associated with the component region within the (combined) directive. More...
 
OpenMPDirectiveKind getDirectiveKind () const
 
child_range children ()
 
ArrayRef< OMPClause * > clauses ()
 
ArrayRef< OMPClause * > clauses () const
 
- 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 StmtIgnoreContainers (bool IgnoreCaptured=false) const
 
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

template<typename SpecificClause >
static llvm::iterator_range< specific_clause_iterator< SpecificClause > > getClausesOfKind (ArrayRef< OMPClause *> Clauses)
 
static bool classof (const Stmt *S)
 
- Static Public Member Functions inherited from clang::Stmt
static void addStmtClass (const StmtClass s)
 
static void EnableStatistics ()
 
static void PrintStats ()
 

Protected Member Functions

template<typename T >
 OMPExecutableDirective (const T *, StmtClass SC, OpenMPDirectiveKind K, SourceLocation StartLoc, SourceLocation EndLoc, unsigned NumClauses, unsigned NumChildren)
 Build instance of directive of class K. More...
 
void setClauses (ArrayRef< OMPClause *> Clauses)
 Sets the list of variables for this clause. More...
 
void setAssociatedStmt (Stmt *S)
 Set the associated statement for the directive. More...
 
- 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...
 

Friends

class ASTStmtReader
 

Additional Inherited Members

- Public Types inherited from clang::Stmt
enum  StmtClass { NoStmtClass = 0 }
 
using child_iterator = StmtIterator
 Child Iterators: All subclasses must implement 'children' to permit easy iteration over the substatements/subexpessions of an AST node. More...
 
using const_child_iterator = ConstStmtIterator
 
using child_range = llvm::iterator_range< child_iterator >
 
using const_child_range = llvm::iterator_range< const_child_iterator >
 
- Protected Types inherited from clang::Stmt
enum  { NumStmtBits = 8 }
 
enum  { NumExprBits = 17 }
 
enum  APFloatSemantics {
  IEEEhalf, IEEEsingle, IEEEdouble, x87DoubleExtended,
  IEEEquad, PPCDoubleDouble
}
 
- 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 is a basic class for representing single OpenMP executable directive.

Definition at line 33 of file StmtOpenMP.h.

Constructor & Destructor Documentation

◆ OMPExecutableDirective()

template<typename T >
clang::OMPExecutableDirective::OMPExecutableDirective ( const T ,
StmtClass  SC,
OpenMPDirectiveKind  K,
SourceLocation  StartLoc,
SourceLocation  EndLoc,
unsigned  NumClauses,
unsigned  NumChildren 
)
inlineprotected

Build instance of directive of class K.

Parameters
SCStatement class.
KKind of OpenMP directive.
StartLocStarting location of the directive (directive keyword).
EndLocEnding location of the directive.

Definition at line 67 of file StmtOpenMP.h.

References setClauses().

Member Function Documentation

◆ children()

child_range clang::OMPExecutableDirective::children ( )
inline

Definition at line 228 of file StmtOpenMP.h.

References hasAssociatedStmt().

◆ classof()

static bool clang::OMPExecutableDirective::classof ( const Stmt S)
inlinestatic

Definition at line 223 of file StmtOpenMP.h.

◆ clauses() [1/2]

ArrayRef<OMPClause *> clang::OMPExecutableDirective::clauses ( )
inline

◆ clauses() [2/2]

ArrayRef<OMPClause *> clang::OMPExecutableDirective::clauses ( ) const
inline

Definition at line 237 of file StmtOpenMP.h.

◆ getAssociatedStmt()

Stmt* clang::OMPExecutableDirective::getAssociatedStmt ( ) const
inline

◆ getCapturedStmt()

CapturedStmt* clang::OMPExecutableDirective::getCapturedStmt ( OpenMPDirectiveKind  RegionKind) const
inline

Returns the captured statement associated with the component region within the (combined) directive.

Definition at line 205 of file StmtOpenMP.h.

References getAssociatedStmt(), getDirectiveKind(), and clang::getOpenMPCaptureRegions().

Referenced by emitCommonOMPParallelDirective(), emitCommonOMPTargetDirective(), emitCommonOMPTeamsDirective(), and emitParallelOrTeamsOutlinedFunction().

◆ getClause()

OMPClause* clang::OMPExecutableDirective::getClause ( unsigned  i) const
inline

Returns specified clause.

Parameters
iNumber of clause.

Definition at line 190 of file StmtOpenMP.h.

References clauses().

Referenced by clang::OMPClauseWriter::VisitOMPClauseWithPostUpdate().

◆ getClausesOfKind() [1/2]

template<typename SpecificClause >
static llvm::iterator_range<specific_clause_iterator<SpecificClause> > clang::OMPExecutableDirective::getClausesOfKind ( ArrayRef< OMPClause *>  Clauses)
inlinestatic

◆ getClausesOfKind() [2/2]

template<typename SpecificClause >
llvm::iterator_range<specific_clause_iterator<SpecificClause> > clang::OMPExecutableDirective::getClausesOfKind ( ) const
inline

Definition at line 138 of file StmtOpenMP.h.

References clauses().

◆ getDirectiveKind()

OpenMPDirectiveKind clang::OMPExecutableDirective::getDirectiveKind ( ) const
inline

Definition at line 221 of file StmtOpenMP.h.

Referenced by emitCommonOMPTargetDirective(), emitEmptyOrdered(), emitNumTeamsForTargetDirective(), emitNumThreadsForTargetDirective(), clang::CodeGen::CodeGenFunction::EmitOMPDistributeLoop(), clang::CodeGen::CodeGenFunction::EmitOMPLastprivateClauseInit(), clang::CodeGen::CodeGenFunction::EmitOMPLinearClause(), clang::CodeGen::CodeGenFunction::EmitOMPReductionClauseFinal(), clang::CodeGen::CodeGenFunction::EmitOMPTaskLoopBasedDirective(), clang::CodeGen::CodeGenFunction::EmitOMPWorksharingLoop(), clang::CodeGen::emitTargetDataStandAloneCall(), getCapturedStmt(), clang::OMPLoopDirective::getCombinedCond(), clang::OMPLoopDirective::getCombinedEnsureUpperBound(), clang::OMPLoopDirective::getCombinedInit(), clang::OMPLoopDirective::getCombinedLowerBoundVariable(), clang::OMPLoopDirective::getCombinedNextLowerBound(), clang::OMPLoopDirective::getCombinedNextUpperBound(), clang::OMPLoopDirective::getCombinedUpperBoundVariable(), clang::OMPLoopDirective::getDistInc(), clang::OMPLoopDirective::getEnsureUpperBound(), getExecutionModeForDirective(), clang::OMPLoopDirective::getIsLastIterVariable(), clang::OMPLoopDirective::getLowerBoundVariable(), clang::OMPLoopDirective::getNextLowerBound(), clang::OMPLoopDirective::getNextUpperBound(), clang::OMPLoopDirective::getNumIterations(), clang::OMPLoopDirective::getPrevEnsureUpperBound(), clang::OMPLoopDirective::getPrevLowerBoundVariable(), clang::OMPLoopDirective::getPrevUpperBoundVariable(), clang::OMPLoopDirective::getStrideVariable(), clang::OMPLoopDirective::getUpperBoundVariable(), clang::OMPLoopDirective::setCombinedCond(), clang::OMPLoopDirective::setCombinedEnsureUpperBound(), clang::OMPLoopDirective::setCombinedInit(), clang::OMPLoopDirective::setCombinedLowerBoundVariable(), clang::OMPLoopDirective::setCombinedNextLowerBound(), clang::OMPLoopDirective::setCombinedNextUpperBound(), clang::OMPLoopDirective::setCombinedUpperBoundVariable(), clang::OMPLoopDirective::setDistInc(), clang::OMPLoopDirective::setEnsureUpperBound(), clang::OMPLoopDirective::setIsLastIterVariable(), clang::OMPLoopDirective::setLowerBoundVariable(), clang::OMPLoopDirective::setNextLowerBound(), clang::OMPLoopDirective::setNextUpperBound(), clang::OMPLoopDirective::setNumIterations(), clang::OMPLoopDirective::setPrevEnsureUpperBound(), clang::OMPLoopDirective::setPrevLowerBoundVariable(), clang::OMPLoopDirective::setPrevUpperBoundVariable(), clang::OMPLoopDirective::setStrideVariable(), clang::OMPLoopDirective::setUpperBoundVariable(), and clang::OMPClauseWriter::VisitOMPClauseWithPostUpdate().

◆ getLocEnd()

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

◆ getLocStart()

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

◆ getNumClauses()

unsigned clang::OMPExecutableDirective::getNumClauses ( ) const
inline

Get number of clauses.

Definition at line 184 of file StmtOpenMP.h.

Referenced by setClauses(), and clang::OMPClauseWriter::VisitOMPClauseWithPostUpdate().

◆ getSingleClause()

template<typename SpecificClause >
const SpecificClause* clang::OMPExecutableDirective::getSingleClause ( ) const
inline

◆ hasAssociatedStmt()

bool clang::OMPExecutableDirective::hasAssociatedStmt ( ) const
inline

Returns true if directive has associated statement.

Definition at line 193 of file StmtOpenMP.h.

Referenced by children(), getAssociatedStmt(), and clang::OMPClauseWriter::VisitOMPClauseWithPostUpdate().

◆ hasClausesOfKind()

template<typename SpecificClause >
bool clang::OMPExecutableDirective::hasClausesOfKind ( ) const
inline

Returns true if the current directive has one or more clauses of a specific kind.

Definition at line 162 of file StmtOpenMP.h.

◆ setAssociatedStmt()

void clang::OMPExecutableDirective::setAssociatedStmt ( Stmt S)
inlineprotected

Set the associated statement for the directive.

/param S Associated statement.

Definition at line 85 of file StmtOpenMP.h.

Referenced by clang::OMPParallelDirective::Create(), clang::OMPSimdDirective::Create(), clang::OMPForDirective::Create(), clang::OMPForSimdDirective::Create(), clang::OMPSectionsDirective::Create(), clang::OMPSectionDirective::Create(), clang::OMPSingleDirective::Create(), clang::OMPMasterDirective::Create(), clang::OMPParallelForDirective::Create(), clang::OMPParallelForSimdDirective::Create(), clang::OMPParallelSectionsDirective::Create(), clang::OMPTaskDirective::Create(), clang::OMPTaskgroupDirective::Create(), clang::OMPOrderedDirective::Create(), clang::OMPTargetDirective::Create(), clang::OMPTargetDataDirective::Create(), clang::OMPTargetEnterDataDirective::Create(), clang::OMPTargetExitDataDirective::Create(), clang::OMPTargetParallelDirective::Create(), clang::OMPTargetParallelForDirective::Create(), clang::OMPTeamsDirective::Create(), clang::OMPTaskLoopDirective::Create(), clang::OMPTaskLoopSimdDirective::Create(), clang::OMPDistributeDirective::Create(), clang::OMPTargetUpdateDirective::Create(), clang::OMPDistributeParallelForDirective::Create(), clang::OMPDistributeParallelForSimdDirective::Create(), clang::OMPDistributeSimdDirective::Create(), clang::OMPTargetParallelForSimdDirective::Create(), clang::OMPTargetSimdDirective::Create(), clang::OMPTeamsDistributeDirective::Create(), clang::OMPTeamsDistributeSimdDirective::Create(), clang::OMPTeamsDistributeParallelForSimdDirective::Create(), clang::OMPTeamsDistributeParallelForDirective::Create(), clang::OMPTargetTeamsDirective::Create(), clang::OMPTargetTeamsDistributeDirective::Create(), clang::OMPTargetTeamsDistributeParallelForDirective::Create(), clang::OMPTargetTeamsDistributeParallelForSimdDirective::Create(), and clang::OMPTargetTeamsDistributeSimdDirective::Create().

◆ setClauses()

void OMPExecutableDirective::setClauses ( ArrayRef< OMPClause *>  Clauses)
protected

Sets the list of variables for this clause.

Parameters
ClausesThe list of clauses for the directive.

Definition at line 20 of file StmtOpenMP.cpp.

References getNumClauses().

Referenced by clang::OMPParallelDirective::Create(), clang::OMPSimdDirective::Create(), clang::OMPForDirective::Create(), clang::OMPForSimdDirective::Create(), clang::OMPSectionsDirective::Create(), clang::OMPSingleDirective::Create(), clang::OMPParallelForDirective::Create(), clang::OMPParallelForSimdDirective::Create(), clang::OMPParallelSectionsDirective::Create(), clang::OMPTaskDirective::Create(), clang::OMPTaskgroupDirective::Create(), clang::OMPFlushDirective::Create(), clang::OMPOrderedDirective::Create(), clang::OMPTargetDirective::Create(), clang::OMPTargetDataDirective::Create(), clang::OMPTargetEnterDataDirective::Create(), clang::OMPTargetExitDataDirective::Create(), clang::OMPTargetParallelDirective::Create(), clang::OMPTargetParallelForDirective::Create(), clang::OMPTeamsDirective::Create(), clang::OMPCancelDirective::Create(), clang::OMPTaskLoopDirective::Create(), clang::OMPTaskLoopSimdDirective::Create(), clang::OMPDistributeDirective::Create(), clang::OMPTargetUpdateDirective::Create(), clang::OMPDistributeParallelForDirective::Create(), clang::OMPDistributeParallelForSimdDirective::Create(), clang::OMPDistributeSimdDirective::Create(), clang::OMPTargetParallelForSimdDirective::Create(), clang::OMPTargetSimdDirective::Create(), clang::OMPTeamsDistributeDirective::Create(), clang::OMPTeamsDistributeSimdDirective::Create(), clang::OMPTeamsDistributeParallelForSimdDirective::Create(), clang::OMPTeamsDistributeParallelForDirective::Create(), clang::OMPTargetTeamsDirective::Create(), clang::OMPTargetTeamsDistributeDirective::Create(), clang::OMPTargetTeamsDistributeParallelForDirective::Create(), clang::OMPTargetTeamsDistributeParallelForSimdDirective::Create(), clang::OMPTargetTeamsDistributeSimdDirective::Create(), and OMPExecutableDirective().

◆ setLocEnd()

void clang::OMPExecutableDirective::setLocEnd ( SourceLocation  Loc)
inline

Set ending location of directive.

Parameters
LocNew ending location of directive.

Definition at line 181 of file StmtOpenMP.h.

◆ setLocStart()

void clang::OMPExecutableDirective::setLocStart ( SourceLocation  Loc)
inline

Set starting location of directive kind.

Parameters
LocNew starting location of directive.

Definition at line 176 of file StmtOpenMP.h.

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 34 of file StmtOpenMP.h.


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