clang  12.0.0git
Classes | Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
OMPMappableExprListClause< T > Class Template Reference

This represents clauses with a list of expressions that are mappable. More...

#include "clang/AST/OpenMPClause.h"

Inheritance diagram for OMPMappableExprListClause< T >:
Inheritance graph
[legend]
Collaboration diagram for OMPMappableExprListClause< T >:
Collaboration graph
[legend]

Classes

class  const_component_lists_iterator
 Iterator that browse the components by lists. More...
 

Public Types

using const_component_lists_range = llvm::iterator_range< const_component_lists_iterator >
 
using const_all_decls_iterator = ArrayRef< ValueDecl * >::iterator
 Iterators to access all the declarations, number of lists, list sizes, and components. More...
 
using const_all_decls_range = llvm::iterator_range< const_all_decls_iterator >
 
using const_all_num_lists_iterator = ArrayRef< unsigned >::iterator
 
using const_all_num_lists_range = llvm::iterator_range< const_all_num_lists_iterator >
 
using const_all_lists_sizes_iterator = ArrayRef< unsigned >::iterator
 
using const_all_lists_sizes_range = llvm::iterator_range< const_all_lists_sizes_iterator >
 
using const_all_components_iterator = ArrayRef< MappableComponent >::iterator
 
using const_all_components_range = llvm::iterator_range< const_all_components_iterator >
 
using mapperlist_iterator = MutableArrayRef< Expr * >::iterator
 
using mapperlist_const_iterator = ArrayRef< const Expr * >::iterator
 
using mapperlist_range = llvm::iterator_range< mapperlist_iterator >
 
using mapperlist_const_range = llvm::iterator_range< mapperlist_const_iterator >
 
- Public Types inherited from OMPClauseMappableExprCommon
using MappableExprComponentList = SmallVector< MappableComponent, 8 >
 
using MappableExprComponentListRef = ArrayRef< MappableComponent >
 
using MappableExprComponentLists = SmallVector< MappableExprComponentList, 8 >
 
using MappableExprComponentListsRef = ArrayRef< MappableExprComponentList >
 

Public Member Functions

unsigned getUniqueDeclarationsNum () const
 Return the number of unique base declarations in this clause. More...
 
unsigned getTotalComponentListNum () const
 Return the number of lists derived from the clause expressions. More...
 
unsigned getTotalComponentsNum () const
 Return the total number of components in all lists derived from the clause. More...
 
NestedNameSpecifierLoc getMapperQualifierLoc () const
 Gets the nested name specifier for associated user-defined mapper. More...
 
const DeclarationNameInfo & getMapperIdInfo () const
 Gets the name info for associated user-defined mapper. More...
 
const_component_lists_iterator component_lists_begin () const
 Iterators for all component lists. More...
 
const_component_lists_iterator component_lists_end () const
 
const_component_lists_range component_lists () const
 
const_component_lists_iterator decl_component_lists_begin (const ValueDecl *VD) const
 Iterators for component lists associated with the provided declaration. More...
 
const_component_lists_iterator decl_component_lists_end () const
 
const_component_lists_range decl_component_lists (const ValueDecl *VD) const
 
const_all_decls_range all_decls () const
 
const_all_num_lists_range all_num_lists () const
 
const_all_lists_sizes_range all_lists_sizes () const
 
const_all_components_range all_components () const
 
mapperlist_iterator mapperlist_begin ()
 
mapperlist_iterator mapperlist_end ()
 
mapperlist_const_iterator mapperlist_begin () const
 
mapperlist_const_iterator mapperlist_end () const
 
mapperlist_range mapperlists ()
 
mapperlist_const_range mapperlists () const
 

Protected Member Functions

 OMPMappableExprListClause (OpenMPClauseKind K, const OMPVarListLocTy &Locs, const OMPMappableExprListSizeTy &Sizes, bool SupportsMapper=false, NestedNameSpecifierLoc *MapperQualifierLocPtr=nullptr, DeclarationNameInfo *MapperIdInfoPtr=nullptr)
 Build a clause for NumUniqueDeclarations declarations, NumComponentLists total component lists, and NumComponents total components. More...
 
MutableArrayRef< ValueDecl * > getUniqueDeclsRef ()
 Get the unique declarations that are in the trailing objects of the class. More...
 
ArrayRef< ValueDecl * > getUniqueDeclsRef () const
 Get the unique declarations that are in the trailing objects of the class. More...
 
void setUniqueDecls (ArrayRef< ValueDecl *> UDs)
 Set the unique declarations that are in the trailing objects of the class. More...
 
MutableArrayRef< unsigned > getDeclNumListsRef ()
 Get the number of lists per declaration that are in the trailing objects of the class. More...
 
ArrayRef< unsigned > getDeclNumListsRef () const
 Get the number of lists per declaration that are in the trailing objects of the class. More...
 
void setDeclNumLists (ArrayRef< unsigned > DNLs)
 Set the number of lists per declaration that are in the trailing objects of the class. More...
 
MutableArrayRef< unsigned > getComponentListSizesRef ()
 Get the cumulative component lists sizes that are in the trailing objects of the class. More...
 
ArrayRef< unsigned > getComponentListSizesRef () const
 Get the cumulative component lists sizes that are in the trailing objects of the class. More...
 
void setComponentListSizes (ArrayRef< unsigned > CLSs)
 Set the cumulative component lists sizes that are in the trailing objects of the class. More...
 
MutableArrayRef< MappableComponentgetComponentsRef ()
 Get the components that are in the trailing objects of the class. More...
 
ArrayRef< MappableComponentgetComponentsRef () const
 Get the components that are in the trailing objects of the class. More...
 
void setComponents (ArrayRef< MappableComponent > Components, ArrayRef< unsigned > CLSs)
 Set the components that are in the trailing objects of the class. More...
 
void setClauseInfo (ArrayRef< ValueDecl *> Declarations, MappableExprComponentListsRef ComponentLists)
 Fill the clause information from the list of declarations and associated component lists. More...
 
void setMapperQualifierLoc (NestedNameSpecifierLoc NNSL)
 Set the nested name specifier of associated user-defined mapper. More...
 
void setMapperIdInfo (DeclarationNameInfo MapperId)
 Set the name of associated user-defined mapper. More...
 
MutableArrayRef< Expr * > getUDMapperRefs ()
 Get the user-defined mapper references that are in the trailing objects of the class. More...
 
ArrayRef< Expr * > getUDMapperRefs () const
 Get the user-defined mappers references that are in the trailing objects of the class. More...
 
void setUDMapperRefs (ArrayRef< Expr *> DMDs)
 Set the user-defined mappers that are in the trailing objects of the class. More...
 

Friends

class OMPClauseReader
 

Additional Inherited Members

- Static Protected Member Functions inherited from OMPClauseMappableExprCommon
static unsigned getComponentsTotalNumber (MappableExprComponentListsRef ComponentLists)
 
static unsigned getUniqueDeclarationsTotalNumber (ArrayRef< const ValueDecl *> Declarations)
 

Detailed Description

template<class T>
class OMPMappableExprListClause< T >

This represents clauses with a list of expressions that are mappable.

Examples of these clauses are 'map' in '#pragma omp target [enter|exit] [data]...' directives, and 'to' and 'from in '#pragma omp target update...' directives.

Definition at line 4810 of file OpenMPClause.h.

Member Typedef Documentation

◆ const_all_components_iterator

template<class T>
using OMPMappableExprListClause< T >::const_all_components_iterator = ArrayRef<MappableComponent>::iterator

Definition at line 5330 of file OpenMPClause.h.

◆ const_all_components_range

template<class T>
using OMPMappableExprListClause< T >::const_all_components_range = llvm::iterator_range<const_all_components_iterator>

Definition at line 5332 of file OpenMPClause.h.

◆ const_all_decls_iterator

template<class T>
using OMPMappableExprListClause< T >::const_all_decls_iterator = ArrayRef<ValueDecl *>::iterator

Iterators to access all the declarations, number of lists, list sizes, and components.

Definition at line 5304 of file OpenMPClause.h.

◆ const_all_decls_range

template<class T>
using OMPMappableExprListClause< T >::const_all_decls_range = llvm::iterator_range<const_all_decls_iterator>

Definition at line 5305 of file OpenMPClause.h.

◆ const_all_lists_sizes_iterator

template<class T>
using OMPMappableExprListClause< T >::const_all_lists_sizes_iterator = ArrayRef<unsigned>::iterator

Definition at line 5321 of file OpenMPClause.h.

◆ const_all_lists_sizes_range

template<class T>
using OMPMappableExprListClause< T >::const_all_lists_sizes_range = llvm::iterator_range<const_all_lists_sizes_iterator>

Definition at line 5323 of file OpenMPClause.h.

◆ const_all_num_lists_iterator

template<class T>
using OMPMappableExprListClause< T >::const_all_num_lists_iterator = ArrayRef<unsigned>::iterator

Definition at line 5312 of file OpenMPClause.h.

◆ const_all_num_lists_range

template<class T>
using OMPMappableExprListClause< T >::const_all_num_lists_range = llvm::iterator_range<const_all_num_lists_iterator>

Definition at line 5314 of file OpenMPClause.h.

◆ const_component_lists_range

template<class T>
using OMPMappableExprListClause< T >::const_component_lists_range = llvm::iterator_range<const_component_lists_iterator>

Definition at line 5266 of file OpenMPClause.h.

◆ mapperlist_const_iterator

template<class T>
using OMPMappableExprListClause< T >::mapperlist_const_iterator = ArrayRef<const Expr *>::iterator

Definition at line 5340 of file OpenMPClause.h.

◆ mapperlist_const_range

template<class T>
using OMPMappableExprListClause< T >::mapperlist_const_range = llvm::iterator_range<mapperlist_const_iterator>

Definition at line 5343 of file OpenMPClause.h.

◆ mapperlist_iterator

template<class T>
using OMPMappableExprListClause< T >::mapperlist_iterator = MutableArrayRef<Expr *>::iterator

Definition at line 5339 of file OpenMPClause.h.

◆ mapperlist_range

template<class T>
using OMPMappableExprListClause< T >::mapperlist_range = llvm::iterator_range<mapperlist_iterator>

Definition at line 5341 of file OpenMPClause.h.

Constructor & Destructor Documentation

◆ OMPMappableExprListClause()

template<class T>
OMPMappableExprListClause< T >::OMPMappableExprListClause ( OpenMPClauseKind  K,
const OMPVarListLocTy &  Locs,
const OMPMappableExprListSizeTy Sizes,
bool  SupportsMapper = false,
NestedNameSpecifierLoc *  MapperQualifierLocPtr = nullptr,
DeclarationNameInfo *  MapperIdInfoPtr = nullptr 
)
inlineprotected

Build a clause for NumUniqueDeclarations declarations, NumComponentLists total component lists, and NumComponents total components.

Parameters
KKind of the clause.
LocsLocations needed to build a mappable clause. It includes 1) StartLoc: starting location of the clause (the clause keyword); 2) LParenLoc: location of '('; 3) EndLoc: ending location of the clause.
SizesAll required sizes to build a mappable clause. It includes 1) NumVars: number of expressions listed in this clause; 2) NumUniqueDeclarations: number of unique base declarations in this clause; 3) NumComponentLists: number of component lists in this clause; and 4) NumComponents: total number of expression components in the clause.
SupportsMapperIndicates whether this clause is possible to have user-defined mappers associated.
MapperQualifierLocPtrC++ nested name specifier for the associated user-defined mapper.
MapperIdInfoPtrThe identifier of associated user-defined mapper.

Definition at line 4853 of file OpenMPClause.h.

Member Function Documentation

◆ all_components()

template<class T>
const_all_components_range OMPMappableExprListClause< T >::all_components ( ) const
inline

Definition at line 5334 of file OpenMPClause.h.

Referenced by clang::ASTRecordWriter::writeOMPClause().

◆ all_decls()

template<class T>
const_all_decls_range OMPMappableExprListClause< T >::all_decls ( ) const
inline

Definition at line 5307 of file OpenMPClause.h.

Referenced by clang::ASTRecordWriter::writeOMPClause().

◆ all_lists_sizes()

template<class T>
const_all_lists_sizes_range OMPMappableExprListClause< T >::all_lists_sizes ( ) const
inline

Definition at line 5325 of file OpenMPClause.h.

Referenced by clang::ASTRecordWriter::writeOMPClause().

◆ all_num_lists()

template<class T>
const_all_num_lists_range OMPMappableExprListClause< T >::all_num_lists ( ) const
inline

Definition at line 5316 of file OpenMPClause.h.

Referenced by clang::ASTRecordWriter::writeOMPClause().

◆ component_lists()

template<class T>
const_component_lists_range OMPMappableExprListClause< T >::component_lists ( ) const
inline

Definition at line 5282 of file OpenMPClause.h.

◆ component_lists_begin()

template<class T>
const_component_lists_iterator OMPMappableExprListClause< T >::component_lists_begin ( ) const
inline

Iterators for all component lists.

Definition at line 5269 of file OpenMPClause.h.

◆ component_lists_end()

template<class T>
const_component_lists_iterator OMPMappableExprListClause< T >::component_lists_end ( ) const
inline

Definition at line 5275 of file OpenMPClause.h.

◆ decl_component_lists()

template<class T>
const_component_lists_range OMPMappableExprListClause< T >::decl_component_lists ( const ValueDecl *  VD) const
inline

Definition at line 5298 of file OpenMPClause.h.

◆ decl_component_lists_begin()

template<class T>
const_component_lists_iterator OMPMappableExprListClause< T >::decl_component_lists_begin ( const ValueDecl *  VD) const
inline

Iterators for component lists associated with the provided declaration.

Definition at line 5289 of file OpenMPClause.h.

◆ decl_component_lists_end()

template<class T>
const_component_lists_iterator OMPMappableExprListClause< T >::decl_component_lists_end ( ) const
inline

Definition at line 5295 of file OpenMPClause.h.

◆ getComponentListSizesRef() [1/2]

template<class T>
MutableArrayRef<unsigned> OMPMappableExprListClause< T >::getComponentListSizesRef ( )
inlineprotected

Get the cumulative component lists sizes that are in the trailing objects of the class.

They are appended after the number of lists.

Definition at line 4920 of file OpenMPClause.h.

◆ getComponentListSizesRef() [2/2]

template<class T>
ArrayRef<unsigned> OMPMappableExprListClause< T >::getComponentListSizesRef ( ) const
inlineprotected

Get the cumulative component lists sizes that are in the trailing objects of the class.

They are appended after the number of lists.

Definition at line 4929 of file OpenMPClause.h.

◆ getComponentsRef() [1/2]

template<class T>
MutableArrayRef<MappableComponent> OMPMappableExprListClause< T >::getComponentsRef ( )
inlineprotected

Get the components that are in the trailing objects of the class.

Definition at line 4945 of file OpenMPClause.h.

◆ getComponentsRef() [2/2]

template<class T>
ArrayRef<MappableComponent> OMPMappableExprListClause< T >::getComponentsRef ( ) const
inlineprotected

Get the components that are in the trailing objects of the class.

Definition at line 4953 of file OpenMPClause.h.

◆ getDeclNumListsRef() [1/2]

template<class T>
MutableArrayRef<unsigned> OMPMappableExprListClause< T >::getDeclNumListsRef ( )
inlineprotected

Get the number of lists per declaration that are in the trailing objects of the class.

Definition at line 4896 of file OpenMPClause.h.

◆ getDeclNumListsRef() [2/2]

template<class T>
ArrayRef<unsigned> OMPMappableExprListClause< T >::getDeclNumListsRef ( ) const
inlineprotected

Get the number of lists per declaration that are in the trailing objects of the class.

Definition at line 4904 of file OpenMPClause.h.

◆ getMapperIdInfo()

template<class T>
const DeclarationNameInfo& OMPMappableExprListClause< T >::getMapperIdInfo ( ) const
inline

Gets the name info for associated user-defined mapper.

Definition at line 5107 of file OpenMPClause.h.

Referenced by clang::transformOMPMappableExprListClause(), and clang::ASTRecordWriter::writeOMPClause().

◆ getMapperQualifierLoc()

template<class T>
NestedNameSpecifierLoc OMPMappableExprListClause< T >::getMapperQualifierLoc ( ) const
inline

Gets the nested name specifier for associated user-defined mapper.

Definition at line 5102 of file OpenMPClause.h.

Referenced by clang::transformOMPMappableExprListClause(), and clang::ASTRecordWriter::writeOMPClause().

◆ getTotalComponentListNum()

template<class T>
unsigned OMPMappableExprListClause< T >::getTotalComponentListNum ( ) const
inline

Return the number of lists derived from the clause expressions.

Definition at line 5095 of file OpenMPClause.h.

Referenced by clang::OMPClauseReader::VisitOMPClauseWithPostUpdate(), and clang::ASTRecordWriter::writeOMPClause().

◆ getTotalComponentsNum()

template<class T>
unsigned OMPMappableExprListClause< T >::getTotalComponentsNum ( ) const
inline

Return the total number of components in all lists derived from the clause.

Definition at line 5099 of file OpenMPClause.h.

Referenced by clang::OMPClauseReader::VisitOMPClauseWithPostUpdate(), and clang::ASTRecordWriter::writeOMPClause().

◆ getUDMapperRefs() [1/2]

template<class T>
MutableArrayRef<Expr *> OMPMappableExprListClause< T >::getUDMapperRefs ( )
inlineprotected

Get the user-defined mapper references that are in the trailing objects of the class.

Definition at line 5060 of file OpenMPClause.h.

◆ getUDMapperRefs() [2/2]

template<class T>
ArrayRef<Expr *> OMPMappableExprListClause< T >::getUDMapperRefs ( ) const
inlineprotected

Get the user-defined mappers references that are in the trailing objects of the class.

Definition at line 5071 of file OpenMPClause.h.

◆ getUniqueDeclarationsNum()

template<class T>
unsigned OMPMappableExprListClause< T >::getUniqueDeclarationsNum ( ) const
inline

Return the number of unique base declarations in this clause.

Definition at line 5092 of file OpenMPClause.h.

Referenced by clang::OMPClauseReader::VisitOMPClauseWithPostUpdate(), and clang::ASTRecordWriter::writeOMPClause().

◆ getUniqueDeclsRef() [1/2]

template<class T>
MutableArrayRef<ValueDecl *> OMPMappableExprListClause< T >::getUniqueDeclsRef ( )
inlineprotected

Get the unique declarations that are in the trailing objects of the class.

Definition at line 4871 of file OpenMPClause.h.

◆ getUniqueDeclsRef() [2/2]

template<class T>
ArrayRef<ValueDecl *> OMPMappableExprListClause< T >::getUniqueDeclsRef ( ) const
inlineprotected

Get the unique declarations that are in the trailing objects of the class.

Definition at line 4879 of file OpenMPClause.h.

◆ mapperlist_begin() [1/2]

template<class T>
mapperlist_iterator OMPMappableExprListClause< T >::mapperlist_begin ( )
inline

Definition at line 5345 of file OpenMPClause.h.

◆ mapperlist_begin() [2/2]

template<class T>
mapperlist_const_iterator OMPMappableExprListClause< T >::mapperlist_begin ( ) const
inline

Definition at line 5347 of file OpenMPClause.h.

◆ mapperlist_end() [1/2]

template<class T>
mapperlist_iterator OMPMappableExprListClause< T >::mapperlist_end ( )
inline

Definition at line 5346 of file OpenMPClause.h.

◆ mapperlist_end() [2/2]

template<class T>
mapperlist_const_iterator OMPMappableExprListClause< T >::mapperlist_end ( ) const
inline

Definition at line 5350 of file OpenMPClause.h.

◆ mapperlists() [1/2]

template<class T>
mapperlist_range OMPMappableExprListClause< T >::mapperlists ( )
inline

◆ mapperlists() [2/2]

template<class T>
mapperlist_const_range OMPMappableExprListClause< T >::mapperlists ( ) const
inline

Definition at line 5356 of file OpenMPClause.h.

◆ setClauseInfo()

template<class T>
void OMPMappableExprListClause< T >::setClauseInfo ( ArrayRef< ValueDecl *>  Declarations,
MappableExprComponentListsRef  ComponentLists 
)
inlineprotected

Fill the clause information from the list of declarations and associated component lists.

Definition at line 4974 of file OpenMPClause.h.

Referenced by OMPMapClause::Create(), OMPUseDevicePtrClause::Create(), OMPUseDeviceAddrClause::Create(), and OMPIsDevicePtrClause::Create().

◆ setComponentListSizes()

template<class T>
void OMPMappableExprListClause< T >::setComponentListSizes ( ArrayRef< unsigned >  CLSs)
inlineprotected

Set the cumulative component lists sizes that are in the trailing objects of the class.

Definition at line 4938 of file OpenMPClause.h.

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

◆ setComponents()

template<class T>
void OMPMappableExprListClause< T >::setComponents ( ArrayRef< MappableComponent Components,
ArrayRef< unsigned >  CLSs 
)
inlineprotected

Set the components that are in the trailing objects of the class.

This requires the list sizes so that it can also fill the original expressions, which are the first component of each list.

Definition at line 4963 of file OpenMPClause.h.

◆ setDeclNumLists()

template<class T>
void OMPMappableExprListClause< T >::setDeclNumLists ( ArrayRef< unsigned >  DNLs)
inlineprotected

Set the number of lists per declaration that are in the trailing objects of the class.

Definition at line 4912 of file OpenMPClause.h.

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

◆ setMapperIdInfo()

template<class T>
void OMPMappableExprListClause< T >::setMapperIdInfo ( DeclarationNameInfo  MapperId)
inlineprotected

Set the name of associated user-defined mapper.

Definition at line 5054 of file OpenMPClause.h.

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

◆ setMapperQualifierLoc()

template<class T>
void OMPMappableExprListClause< T >::setMapperQualifierLoc ( NestedNameSpecifierLoc  NNSL)
inlineprotected

Set the nested name specifier of associated user-defined mapper.

Definition at line 5049 of file OpenMPClause.h.

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

◆ setUDMapperRefs()

template<class T>
void OMPMappableExprListClause< T >::setUDMapperRefs ( ArrayRef< Expr *>  DMDs)
inlineprotected

Set the user-defined mappers that are in the trailing objects of the class.

Definition at line 5082 of file OpenMPClause.h.

Referenced by OMPMapClause::Create(), OMPToClause::Create(), OMPFromClause::Create(), and clang::OMPClauseReader::VisitOMPClauseWithPostUpdate().

◆ setUniqueDecls()

template<class T>
void OMPMappableExprListClause< T >::setUniqueDecls ( ArrayRef< ValueDecl *>  UDs)
inlineprotected

Set the unique declarations that are in the trailing objects of the class.

Definition at line 4888 of file OpenMPClause.h.

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

Friends And Related Function Documentation

◆ OMPClauseReader

template<class T>
friend class OMPClauseReader
friend

Definition at line 4812 of file OpenMPClause.h.


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