SgTemplateDeclaration¶
This class represents the concept of a template declaration.
Synopsis¶
Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)
class [[visibility("default")]] SgTemplateDeclaration
: public SgDeclarationStatement Description¶
This template declaration is internally marked as being either a
- class (e_template_class),
- member class (e_template_m_class),
- function (e_template_function),
- member function (e_template_m_function), or
- member data (e_template_m_data) The template name, parameter list, optional requires-clause, classification, and semantic scope are represented by typed fields. Source declarations and definitions are represented by the corresponding typed class, function, variable, or typedef declaration nodes; no source-text payload is stored on this semantic template identity node.
- Todo: Template declarations marked as friend don't seem to be marked as friend internally.
- Todo: The scope of a SgTemplateDeclaration should be a SgTemplateInstantiationDefn, since it could be associated which more than one definition. What we need, and don't have yet, is a SgTemplateDefinition to accompany the SgTemplateDeclaration then a SgTemplateDeclaration could have a SgTemplateDefinition for a parent and or scope when it is a member function or namespace or global scope (typically), otherwise.
- Todo: Make the "*PtrList" typed objects non-pointer data members (lists) instead of pointer to lists.
- Note: Template specializations appear in syntax to be a template declaration (with explicit template arguments), but they are really just an explicit template instantiation. Thus Sage III stores such template specializations as template instantiations and references the associated template declaration (SgTemplateDeclaration) internally.
- See also: Example of using a SgTemplateDeclaration object
Data members
SgTemplateDeclaration::p_name¶
This is the name of the template This is the name of the template (e.g. for "template<class T> class X;", the name is "X".
SgTemplateDeclaration::p_template_kind¶
This is the classification of the template declaration This is the classification of the template declaration. This template declaration is internally marked as being either a
- class (e_template_class),
- member class (e_template_m_class),
- function (e_template_function),
- member function (e_template_m_function), or
- member data (e_template_m_data)
SgTemplateDeclaration::p_templateParameters¶
This is the STL list of pointers template parameters (SgTemplateParameter objects) This is the STL list of pointers to template parameters (SgTemplateParameter objects) For example, for "template<class T> class X;", the STL list would contain a SgTemplateParameter representing T.
SgTemplateDeclaration::p_scope¶
This is the scope of the template declaration. This is stored explicitly since name qualification can be used to place some declarations in positions that are different from their scope if it were computed structureally from the parent pointer data.
Member functions
SgTemplateDeclaration::get_name()¶
Returns name of template declaration.
- Return: Returns SgName by value.
SgTemplateDeclaration::set_name(SgName name)¶
Access function for p_name.
- Return: Returns void.
SgTemplateDeclaration::get_template_kind()¶
Returns enum value (function, class, etc.)
- Return: Returns enum value
SgTemplateDeclaration::set_template_kind(SgName name)¶
Access function for p_template_kind.
- Return: Returns void.
Base Classes¶
| Name | Description |
|---|---|
SgDeclarationStatement | This class represents the concept of a declaration statement. |
Type Aliases¶
| Name |
|---|
base_node_type |
Enums¶
| Name | Description |
|---|---|
Unnamed enum | static variant value |
template_type_enum | Type of template declaration |
Member Functions¶
| Name | Description |
|---|---|
SgTemplateDeclarationSgTemplateDeclaration(SgName name); [constructor] | Constructors |
~SgTemplateDeclarationvirtual ~SgTemplateDeclaration(); [destructor] [virtual] | Destructor |
acceptvirtual void accept(ROSE_VisitorPattern& visitor) override; [virtual] | support for the classic visitor pattern done in GoF |
appendDestructorOwnedNodesvirtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual] | |
class_namevirtual std::string class_name() const override; [virtual] | returns a string representing the class name |
copyvirtual SgNode* copy(SgCopyHelp& help) const override; [virtual] | |
fixupCopy_referencesvirtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_scopesvirtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
fixupCopy_symbolsvirtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual] | |
get_childIndexvirtual size_t get_childIndex(SgNode* child) const override; [virtual] | index-based access to traversal successors by child node |
get_mangled_namevirtual SgName get_mangled_name() const override; [virtual] | |
get_nameSgName get_name() const; | |
get_numberOfTraversalSuccessorsvirtual size_t get_numberOfTraversalSuccessors() const override; [virtual] | return number of children in the traversal successor list |
get_qualified_namevirtual SgName get_qualified_name() const; [virtual] | |
get_requiresClauseSgExpression* get_requiresClause() const; | |
get_scopevirtual SgScopeStatement* get_scope() const override; [virtual] | |
get_symbol_from_symbol_tablevirtual SgSymbol* get_symbol_from_symbol_table() const override; [virtual] | |
get_templateParametersSgTemplateParameterPtrList const& get_templateParameters() const; | |
get_template_kindSgTemplateDeclaration::template_type_enum get_template_kind() const; | |
get_traversalSuccessorByIndexvirtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual] | index-based access to traversal successors by index number |
get_traversalSuccessorContainervirtual std::vector<SgNode*> get_traversalSuccessorContainer() const override; [virtual] | container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation |
get_traversalSuccessorIsListElementvirtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual] | |
get_traversalSuccessorNamesContainervirtual std::vector<std::string> get_traversalSuccessorNamesContainer() const override; [virtual] | container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation |
hasExplicitScopevirtual bool hasExplicitScope() const override; [virtual] | Support for where the scope is explicitly required |
operator deletevoid operator delete( void* pointer, size_t size); | deallocated memory for IR node (returns memory to memory pool for reuse) |
operator newvoid* operator new(size_t size); | returns pointer to newly allocated IR node |
post_construction_initializationvirtual void post_construction_initialization() override; [virtual] | |
processDataMemberReferenceToPointersvirtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual] | Pass references to stored node pointers to a handler. |
returnDataMemberPointersvirtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual] | Return the node pointers stored in this node's data members. |
roseRTIvirtual RTIReturnType roseRTI() override; [virtual] | return C++ Runtime-Time-Information |
sage_class_namevirtual char const* sage_class_name() const override; [virtual] | returns a C style string (char*) representing the class name |
set_namevoid set_name(SgName name); | |
set_requiresClausevoid set_requiresClause(SgExpression* requiresClause); | |
set_scopevirtual void set_scope(SgScopeStatement* scope) override; [virtual] | |
set_template_kindvoid set_template_kind(SgTemplateDeclaration::template_type_enum template_kind); | |
variantTvirtual VariantT variantT() const override; [virtual] | returns new style SageIII enum values |
Static Member Functions¶
| Name | Description |
|---|---|
memoryUsagestatic size_t memoryUsage(); | Returns the size in bytes of the total memory allocated for all IR nodes of this type |
numberOfNodesstatic size_t numberOfNodes(); | Returns the total number of IR nodes of this type |
traverseMemoryPoolNodesstatic void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit); | FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node. |
traverseMemoryPoolVisitorPatternstatic void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor); | FOR INTERNAL USE Support for visitor pattern. |
visitRepresentativeNodestatic void visitRepresentativeNode(ROSE_VisitTraversal& visit); | FOR INTERNAL USE Support for type-based traversal. |
Static Data Members¶
| Name | Description |
|---|---|
free_slots | Free slots, each numbered pool_index * pool_size + slot_index. The last entry is allocated next. |
pool_live_flags | |
pool_size | |
pools |
Protected Data Members¶
| Name |
|---|
p_name |
p_requiresClause |
p_scope |
p_templateParameters |
p_template_kind |
Friends¶
| Name | Description |
|---|---|
isSgTemplateDeclaration | Casts pointer from base class to derived class (for const pointers) |
isSgTemplateDeclaration | Casts pointer from base class to derived class |
Created with MrDocs