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

This is a common base class for loop directives ('omp simd', 'omp for', 'omp for simd' etc.). More...

#include "clang/AST/StmtOpenMP.h"

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

Classes

struct  DistCombinedHelperExprs
 The expressions built to support OpenMP loops in combined/composite pragmas (e.g. More...
 
struct  HelperExprs
 The expressions built for the OpenMP loop CodeGen for the whole collapsed loop nest. More...
 

Public Member Functions

unsigned getCollapsedNumber () const
 Get number of collapsed loops. More...
 
ExprgetIterationVariable () const
 
ExprgetLastIteration () const
 
ExprgetCalcLastIteration () const
 
ExprgetPreCond () const
 
ExprgetCond () const
 
ExprgetInit () const
 
ExprgetInc () const
 
const StmtgetPreInits () const
 
StmtgetPreInits ()
 
ExprgetIsLastIterVariable () const
 
ExprgetLowerBoundVariable () const
 
ExprgetUpperBoundVariable () const
 
ExprgetStrideVariable () const
 
ExprgetEnsureUpperBound () const
 
ExprgetNextLowerBound () const
 
ExprgetNextUpperBound () const
 
ExprgetNumIterations () const
 
ExprgetPrevLowerBoundVariable () const
 
ExprgetPrevUpperBoundVariable () const
 
ExprgetDistInc () const
 
ExprgetPrevEnsureUpperBound () const
 
ExprgetCombinedLowerBoundVariable () const
 
ExprgetCombinedUpperBoundVariable () const
 
ExprgetCombinedEnsureUpperBound () const
 
ExprgetCombinedInit () const
 
ExprgetCombinedCond () const
 
ExprgetCombinedNextLowerBound () const
 
ExprgetCombinedNextUpperBound () const
 
const StmtgetBody () const
 
ArrayRef< Expr * > counters ()
 
ArrayRef< Expr * > counters () const
 
ArrayRef< Expr * > private_counters ()
 
ArrayRef< Expr * > private_counters () const
 
ArrayRef< Expr * > inits ()
 
ArrayRef< Expr * > inits () const
 
ArrayRef< Expr * > updates ()
 
ArrayRef< Expr * > updates () const
 
ArrayRef< Expr * > finals ()
 
ArrayRef< Expr * > finals () const
 
- Public Member Functions inherited from clang::OMPExecutableDirective
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

static bool classof (const Stmt *T)
 
- Static Public Member Functions inherited from clang::OMPExecutableDirective
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 >
 OMPLoopDirective (const T *That, StmtClass SC, OpenMPDirectiveKind Kind, SourceLocation StartLoc, SourceLocation EndLoc, unsigned CollapsedNum, unsigned NumClauses, unsigned NumSpecialChildren=0)
 Build instance of loop directive of class Kind. More...
 
void setIterationVariable (Expr *IV)
 
void setLastIteration (Expr *LI)
 
void setCalcLastIteration (Expr *CLI)
 
void setPreCond (Expr *PC)
 
void setCond (Expr *Cond)
 
void setInit (Expr *Init)
 
void setInc (Expr *Inc)
 
void setPreInits (Stmt *PreInits)
 
void setIsLastIterVariable (Expr *IL)
 
void setLowerBoundVariable (Expr *LB)
 
void setUpperBoundVariable (Expr *UB)
 
void setStrideVariable (Expr *ST)
 
void setEnsureUpperBound (Expr *EUB)
 
void setNextLowerBound (Expr *NLB)
 
void setNextUpperBound (Expr *NUB)
 
void setNumIterations (Expr *NI)
 
void setPrevLowerBoundVariable (Expr *PrevLB)
 
void setPrevUpperBoundVariable (Expr *PrevUB)
 
void setDistInc (Expr *DistInc)
 
void setPrevEnsureUpperBound (Expr *PrevEUB)
 
void setCombinedLowerBoundVariable (Expr *CombLB)
 
void setCombinedUpperBoundVariable (Expr *CombUB)
 
void setCombinedEnsureUpperBound (Expr *CombEUB)
 
void setCombinedInit (Expr *CombInit)
 
void setCombinedCond (Expr *CombCond)
 
void setCombinedNextLowerBound (Expr *CombNLB)
 
void setCombinedNextUpperBound (Expr *CombNUB)
 
void setCounters (ArrayRef< Expr *> A)
 
void setPrivateCounters (ArrayRef< Expr *> A)
 
void setInits (ArrayRef< Expr *> A)
 
void setUpdates (ArrayRef< Expr *> A)
 
void setFinals (ArrayRef< Expr *> A)
 
- Protected Member Functions inherited from clang::OMPExecutableDirective
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...
 

Static Protected Member Functions

static unsigned getArraysOffset (OpenMPDirectiveKind Kind)
 Offset to the start of children expression arrays. More...
 
static unsigned numLoopChildren (unsigned CollapsedNum, OpenMPDirectiveKind Kind)
 Children number. 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 common base class for loop directives ('omp simd', 'omp for', 'omp for simd' etc.).

It is responsible for the loop code generation.

Definition at line 313 of file StmtOpenMP.h.

Constructor & Destructor Documentation

◆ OMPLoopDirective()

template<typename T >
clang::OMPLoopDirective::OMPLoopDirective ( const T That,
StmtClass  SC,
OpenMPDirectiveKind  Kind,
SourceLocation  StartLoc,
SourceLocation  EndLoc,
unsigned  CollapsedNum,
unsigned  NumClauses,
unsigned  NumSpecialChildren = 0 
)
inlineprotected

Build instance of loop directive of class Kind.

Parameters
SCStatement class.
KindKind of OpenMP directive.
StartLocStarting location of the directive (directive keyword).
EndLocEnding location of the directive.
CollapsedNumNumber of collapsed loops from 'collapse' clause.
NumClausesNumber of clauses.
NumSpecialChildrenNumber of additional directive-specific stmts.

Definition at line 425 of file StmtOpenMP.h.

Member Function Documentation

◆ classof()

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

Definition at line 943 of file StmtOpenMP.h.

References clang::Stmt::getStmtClass().

◆ counters() [1/2]

ArrayRef<Expr *> clang::OMPLoopDirective::counters ( )
inline

Definition at line 913 of file StmtOpenMP.h.

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

◆ counters() [2/2]

ArrayRef<Expr *> clang::OMPLoopDirective::counters ( ) const
inline

Definition at line 915 of file StmtOpenMP.h.

◆ finals() [1/2]

ArrayRef<Expr *> clang::OMPLoopDirective::finals ( )
inline

Definition at line 937 of file StmtOpenMP.h.

References clang::getFinals().

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

◆ finals() [2/2]

ArrayRef<Expr *> clang::OMPLoopDirective::finals ( ) const
inline

Definition at line 939 of file StmtOpenMP.h.

References clang::getFinals().

◆ getArraysOffset()

static unsigned clang::OMPLoopDirective::getArraysOffset ( OpenMPDirectiveKind  Kind)
inlinestaticprotected

◆ getBody()

const Stmt* clang::OMPLoopDirective::getBody ( ) const
inline

◆ getCalcLastIteration()

Expr* clang::OMPLoopDirective::getCalcLastIteration ( ) const
inline

◆ getCollapsedNumber()

unsigned clang::OMPLoopDirective::getCollapsedNumber ( ) const
inline

Get number of collapsed loops.

Definition at line 736 of file StmtOpenMP.h.

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

◆ getCombinedCond()

Expr* clang::OMPLoopDirective::getCombinedCond ( ) const
inline

◆ getCombinedEnsureUpperBound()

Expr* clang::OMPLoopDirective::getCombinedEnsureUpperBound ( ) const
inline

◆ getCombinedInit()

Expr* clang::OMPLoopDirective::getCombinedInit ( ) const
inline

◆ getCombinedLowerBoundVariable()

Expr* clang::OMPLoopDirective::getCombinedLowerBoundVariable ( ) const
inline

◆ getCombinedNextLowerBound()

Expr* clang::OMPLoopDirective::getCombinedNextLowerBound ( ) const
inline

◆ getCombinedNextUpperBound()

Expr* clang::OMPLoopDirective::getCombinedNextUpperBound ( ) const
inline

◆ getCombinedUpperBoundVariable()

Expr* clang::OMPLoopDirective::getCombinedUpperBoundVariable ( ) const
inline

◆ getCond()

Expr* clang::OMPLoopDirective::getCond ( ) const
inline

◆ getDistInc()

Expr* clang::OMPLoopDirective::getDistInc ( ) const
inline

◆ getEnsureUpperBound()

Expr* clang::OMPLoopDirective::getEnsureUpperBound ( ) const
inline

◆ getInc()

Expr* clang::OMPLoopDirective::getInc ( ) const
inline

◆ getInit()

Expr* clang::OMPLoopDirective::getInit ( ) const
inline

◆ getIsLastIterVariable()

Expr* clang::OMPLoopDirective::getIsLastIterVariable ( ) const
inline

◆ getIterationVariable()

Expr* clang::OMPLoopDirective::getIterationVariable ( ) const
inline

◆ getLastIteration()

Expr* clang::OMPLoopDirective::getLastIteration ( ) const
inline

◆ getLowerBoundVariable()

Expr* clang::OMPLoopDirective::getLowerBoundVariable ( ) const
inline

◆ getNextLowerBound()

Expr* clang::OMPLoopDirective::getNextLowerBound ( ) const
inline

◆ getNextUpperBound()

Expr* clang::OMPLoopDirective::getNextUpperBound ( ) const
inline

◆ getNumIterations()

Expr* clang::OMPLoopDirective::getNumIterations ( ) const
inline

◆ getPreCond()

Expr* clang::OMPLoopDirective::getPreCond ( ) const
inline

◆ getPreInits() [1/2]

const Stmt* clang::OMPLoopDirective::getPreInits ( ) const
inline

◆ getPreInits() [2/2]

Stmt* clang::OMPLoopDirective::getPreInits ( )
inline

Definition at line 769 of file StmtOpenMP.h.

References clang::Stmt::child_begin().

◆ getPrevEnsureUpperBound()

Expr* clang::OMPLoopDirective::getPrevEnsureUpperBound ( ) const
inline

◆ getPrevLowerBoundVariable()

Expr* clang::OMPLoopDirective::getPrevLowerBoundVariable ( ) const
inline

◆ getPrevUpperBoundVariable()

Expr* clang::OMPLoopDirective::getPrevUpperBoundVariable ( ) const
inline

◆ getStrideVariable()

Expr* clang::OMPLoopDirective::getStrideVariable ( ) const
inline

◆ getUpperBoundVariable()

Expr* clang::OMPLoopDirective::getUpperBoundVariable ( ) const
inline

◆ inits() [1/2]

ArrayRef<Expr *> clang::OMPLoopDirective::inits ( )
inline

Definition at line 925 of file StmtOpenMP.h.

References clang::getInits().

◆ inits() [2/2]

ArrayRef<Expr *> clang::OMPLoopDirective::inits ( ) const
inline

Definition at line 927 of file StmtOpenMP.h.

References clang::getInits().

◆ numLoopChildren()

static unsigned clang::OMPLoopDirective::numLoopChildren ( unsigned  CollapsedNum,
OpenMPDirectiveKind  Kind 
)
inlinestaticprotected

Children number.

Definition at line 445 of file StmtOpenMP.h.

◆ private_counters() [1/2]

ArrayRef<Expr *> clang::OMPLoopDirective::private_counters ( )
inline

Definition at line 919 of file StmtOpenMP.h.

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

◆ private_counters() [2/2]

ArrayRef<Expr *> clang::OMPLoopDirective::private_counters ( ) const
inline

Definition at line 921 of file StmtOpenMP.h.

◆ setCalcLastIteration()

void clang::OMPLoopDirective::setCalcLastIteration ( Expr CLI)
inlineprotected

◆ setCombinedCond()

void clang::OMPLoopDirective::setCombinedCond ( Expr CombCond)
inlineprotected

◆ setCombinedEnsureUpperBound()

void clang::OMPLoopDirective::setCombinedEnsureUpperBound ( Expr CombEUB)
inlineprotected

◆ setCombinedInit()

void clang::OMPLoopDirective::setCombinedInit ( Expr CombInit)
inlineprotected

◆ setCombinedLowerBoundVariable()

void clang::OMPLoopDirective::setCombinedLowerBoundVariable ( Expr CombLB)
inlineprotected

◆ setCombinedNextLowerBound()

void clang::OMPLoopDirective::setCombinedNextLowerBound ( Expr CombNLB)
inlineprotected

◆ setCombinedNextUpperBound()

void clang::OMPLoopDirective::setCombinedNextUpperBound ( Expr CombNUB)
inlineprotected

◆ setCombinedUpperBoundVariable()

void clang::OMPLoopDirective::setCombinedUpperBoundVariable ( Expr CombUB)
inlineprotected

◆ setCond()

void clang::OMPLoopDirective::setCond ( Expr Cond)
inlineprotected

◆ setCounters()

void OMPLoopDirective::setCounters ( ArrayRef< Expr *>  A)
protected

◆ setDistInc()

void clang::OMPLoopDirective::setDistInc ( Expr DistInc)
inlineprotected

◆ setEnsureUpperBound()

void clang::OMPLoopDirective::setEnsureUpperBound ( Expr EUB)
inlineprotected

◆ setFinals()

void OMPLoopDirective::setFinals ( ArrayRef< Expr *>  A)
protected

◆ setInc()

void clang::OMPLoopDirective::setInc ( Expr Inc)
inlineprotected

◆ setInit()

void clang::OMPLoopDirective::setInit ( Expr Init)
inlineprotected

◆ setInits()

void OMPLoopDirective::setInits ( ArrayRef< Expr *>  A)
protected

◆ setIsLastIterVariable()

void clang::OMPLoopDirective::setIsLastIterVariable ( Expr IL)
inlineprotected

◆ setIterationVariable()

void clang::OMPLoopDirective::setIterationVariable ( Expr IV)
inlineprotected

◆ setLastIteration()

void clang::OMPLoopDirective::setLastIteration ( Expr LI)
inlineprotected

◆ setLowerBoundVariable()

void clang::OMPLoopDirective::setLowerBoundVariable ( Expr LB)
inlineprotected

◆ setNextLowerBound()

void clang::OMPLoopDirective::setNextLowerBound ( Expr NLB)
inlineprotected

◆ setNextUpperBound()

void clang::OMPLoopDirective::setNextUpperBound ( Expr NUB)
inlineprotected

◆ setNumIterations()

void clang::OMPLoopDirective::setNumIterations ( Expr NI)
inlineprotected

◆ setPreCond()

void clang::OMPLoopDirective::setPreCond ( Expr PC)
inlineprotected

◆ setPreInits()

void clang::OMPLoopDirective::setPreInits ( Stmt PreInits)
inlineprotected

◆ setPrevEnsureUpperBound()

void clang::OMPLoopDirective::setPrevEnsureUpperBound ( Expr PrevEUB)
inlineprotected

◆ setPrevLowerBoundVariable()

void clang::OMPLoopDirective::setPrevLowerBoundVariable ( Expr PrevLB)
inlineprotected

◆ setPrevUpperBoundVariable()

void clang::OMPLoopDirective::setPrevUpperBoundVariable ( Expr PrevUB)
inlineprotected

◆ setPrivateCounters()

void OMPLoopDirective::setPrivateCounters ( ArrayRef< Expr *>  A)
protected

◆ setStrideVariable()

void clang::OMPLoopDirective::setStrideVariable ( Expr ST)
inlineprotected

◆ setUpdates()

void OMPLoopDirective::setUpdates ( ArrayRef< Expr *>  A)
protected

◆ setUpperBoundVariable()

void clang::OMPLoopDirective::setUpperBoundVariable ( Expr UB)
inlineprotected

◆ updates() [1/2]

ArrayRef<Expr *> clang::OMPLoopDirective::updates ( )
inline

Definition at line 931 of file StmtOpenMP.h.

References clang::getUpdates().

◆ updates() [2/2]

ArrayRef<Expr *> clang::OMPLoopDirective::updates ( ) const
inline

Definition at line 933 of file StmtOpenMP.h.

References clang::getUpdates().

Friends And Related Function Documentation

◆ ASTStmtReader

friend class ASTStmtReader
friend

Definition at line 314 of file StmtOpenMP.h.


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